iottwinmaker/aws.sdk.kotlin.services.iottwinmaker/IotTwinMakerClient

IotTwinMakerClient

interface IotTwinMakerClient : SdkClient

IoT TwinMaker is a service with which you can build operational digital twins of physical systems. IoT TwinMaker overlays measurements and analysis from real-world sensors, cameras, and enterprise applications so you can create data visualizations to monitor your physical factory, building, or industrial plant. You can use this real-world data to monitor operations and diagnose and repair errors.

Types

Builder

class Builder : AbstractSdkClientBuilder<IotTwinMakerClient.Config, IotTwinMakerClient.Config.Builder, IotTwinMakerClient>

Companion

object Companion : AbstractAwsSdkClientFactory<IotTwinMakerClient.Config, IotTwinMakerClient.Config.Builder, IotTwinMakerClient, IotTwinMakerClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

config

abstract override val config: IotTwinMakerClient.Config

IotTwinMakerClient's configuration

Functions

batchPutPropertyValues

abstract suspend fun batchPutPropertyValues(input: BatchPutPropertyValuesRequest): BatchPutPropertyValuesResponse

Sets values for multiple time series properties.

cancelMetadataTransferJob

abstract suspend fun cancelMetadataTransferJob(input: CancelMetadataTransferJobRequest): CancelMetadataTransferJobResponse

Cancels the metadata transfer job.

createComponentType

abstract suspend fun createComponentType(input: CreateComponentTypeRequest): CreateComponentTypeResponse

Creates a component type.

createEntity

abstract suspend fun createEntity(input: CreateEntityRequest): CreateEntityResponse

Creates an entity.

createMetadataTransferJob

abstract suspend fun createMetadataTransferJob(input: CreateMetadataTransferJobRequest): CreateMetadataTransferJobResponse

Creates a new metadata transfer job.

createScene

abstract suspend fun createScene(input: CreateSceneRequest): CreateSceneResponse

Creates a scene.

createSyncJob

abstract suspend fun createSyncJob(input: CreateSyncJobRequest): CreateSyncJobResponse

This action creates a SyncJob.

createWorkspace

abstract suspend fun createWorkspace(input: CreateWorkspaceRequest): CreateWorkspaceResponse

Creates a workplace.

deleteComponentType

abstract suspend fun deleteComponentType(input: DeleteComponentTypeRequest): DeleteComponentTypeResponse

Deletes a component type.

deleteEntity

abstract suspend fun deleteEntity(input: DeleteEntityRequest): DeleteEntityResponse

Deletes an entity.

deleteScene

abstract suspend fun deleteScene(input: DeleteSceneRequest): DeleteSceneResponse

Deletes a scene.

deleteSyncJob

abstract suspend fun deleteSyncJob(input: DeleteSyncJobRequest): DeleteSyncJobResponse

Delete the SyncJob.

deleteWorkspace

abstract suspend fun deleteWorkspace(input: DeleteWorkspaceRequest): DeleteWorkspaceResponse

Deletes a workspace.

executeQuery

abstract suspend fun executeQuery(input: ExecuteQueryRequest): ExecuteQueryResponse

Run queries to access information from your knowledge graph of entities within individual workspaces.

getComponentType

abstract suspend fun getComponentType(input: GetComponentTypeRequest): GetComponentTypeResponse

Retrieves information about a component type.

getEntity

abstract suspend fun getEntity(input: GetEntityRequest): GetEntityResponse

Retrieves information about an entity.

getMetadataTransferJob

abstract suspend fun getMetadataTransferJob(input: GetMetadataTransferJobRequest): GetMetadataTransferJobResponse

Gets a nmetadata transfer job.

getPricingPlan

abstract suspend fun getPricingPlan(input: GetPricingPlanRequest = GetPricingPlanRequest { }): GetPricingPlanResponse

Gets the pricing plan.

getPropertyValue

abstract suspend fun getPropertyValue(input: GetPropertyValueRequest): GetPropertyValueResponse

Gets the property values for a component, component type, entity, or workspace.

getPropertyValueHistory

abstract suspend fun getPropertyValueHistory(input: GetPropertyValueHistoryRequest): GetPropertyValueHistoryResponse

Retrieves information about the history of a time series property value for a component, component type, entity, or workspace.

getScene

abstract suspend fun getScene(input: GetSceneRequest): GetSceneResponse

Retrieves information about a scene.

getSyncJob

abstract suspend fun getSyncJob(input: GetSyncJobRequest): GetSyncJobResponse

Gets the SyncJob.

getWorkspace

abstract suspend fun getWorkspace(input: GetWorkspaceRequest): GetWorkspaceResponse

Retrieves information about a workspace.

listComponents

abstract suspend fun listComponents(input: ListComponentsRequest): ListComponentsResponse

This API lists the components of an entity.

listComponentTypes

abstract suspend fun listComponentTypes(input: ListComponentTypesRequest): ListComponentTypesResponse

Lists all component types in a workspace.

listEntities

abstract suspend fun listEntities(input: ListEntitiesRequest): ListEntitiesResponse

Lists all entities in a workspace.

listMetadataTransferJobs

abstract suspend fun listMetadataTransferJobs(input: ListMetadataTransferJobsRequest): ListMetadataTransferJobsResponse

Lists the metadata transfer jobs.

listProperties

abstract suspend fun listProperties(input: ListPropertiesRequest): ListPropertiesResponse

This API lists the properties of a component.

listScenes

abstract suspend fun listScenes(input: ListScenesRequest): ListScenesResponse

Lists all scenes in a workspace.

listSyncJobs

abstract suspend fun listSyncJobs(input: ListSyncJobsRequest): ListSyncJobsResponse

List all SyncJobs.

listSyncResources

abstract suspend fun listSyncResources(input: ListSyncResourcesRequest): ListSyncResourcesResponse

Lists the sync resources.

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

Lists all tags associated with a resource.

listWorkspaces

abstract suspend fun listWorkspaces(input: ListWorkspacesRequest = ListWorkspacesRequest { }): ListWorkspacesResponse

Retrieves information about workspaces in the current account.

tagResource

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Adds tags to a resource.

untagResource

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Removes tags from a resource.

updateComponentType

abstract suspend fun updateComponentType(input: UpdateComponentTypeRequest): UpdateComponentTypeResponse

Updates information in a component type.

updateEntity

abstract suspend fun updateEntity(input: UpdateEntityRequest): UpdateEntityResponse

Updates an entity.

updatePricingPlan

abstract suspend fun updatePricingPlan(input: UpdatePricingPlanRequest): UpdatePricingPlanResponse

Update the pricing plan.

updateScene

abstract suspend fun updateScene(input: UpdateSceneRequest): UpdateSceneResponse

Updates a scene.

updateWorkspace

abstract suspend fun updateWorkspace(input: UpdateWorkspaceRequest): UpdateWorkspaceResponse

Updates a workspace.

Inherited functions

batchPutPropertyValues

inline suspend fun IotTwinMakerClient.batchPutPropertyValues(crossinline block: BatchPutPropertyValuesRequest.Builder.() -> Unit): BatchPutPropertyValuesResponse

Sets values for multiple time series properties.

cancelMetadataTransferJob

inline suspend fun IotTwinMakerClient.cancelMetadataTransferJob(crossinline block: CancelMetadataTransferJobRequest.Builder.() -> Unit): CancelMetadataTransferJobResponse

Cancels the metadata transfer job.

expect abstract fun close()

createComponentType

inline suspend fun IotTwinMakerClient.createComponentType(crossinline block: CreateComponentTypeRequest.Builder.() -> Unit): CreateComponentTypeResponse

Creates a component type.

createEntity

inline suspend fun IotTwinMakerClient.createEntity(crossinline block: CreateEntityRequest.Builder.() -> Unit): CreateEntityResponse

Creates an entity.

createMetadataTransferJob

inline suspend fun IotTwinMakerClient.createMetadataTransferJob(crossinline block: CreateMetadataTransferJobRequest.Builder.() -> Unit): CreateMetadataTransferJobResponse

Creates a new metadata transfer job.

createScene

inline suspend fun IotTwinMakerClient.createScene(crossinline block: CreateSceneRequest.Builder.() -> Unit): CreateSceneResponse

Creates a scene.

createSyncJob

inline suspend fun IotTwinMakerClient.createSyncJob(crossinline block: CreateSyncJobRequest.Builder.() -> Unit): CreateSyncJobResponse

This action creates a SyncJob.

createWorkspace

inline suspend fun IotTwinMakerClient.createWorkspace(crossinline block: CreateWorkspaceRequest.Builder.() -> Unit): CreateWorkspaceResponse

Creates a workplace.

deleteComponentType

inline suspend fun IotTwinMakerClient.deleteComponentType(crossinline block: DeleteComponentTypeRequest.Builder.() -> Unit): DeleteComponentTypeResponse

Deletes a component type.

deleteEntity

inline suspend fun IotTwinMakerClient.deleteEntity(crossinline block: DeleteEntityRequest.Builder.() -> Unit): DeleteEntityResponse

Deletes an entity.

deleteScene

inline suspend fun IotTwinMakerClient.deleteScene(crossinline block: DeleteSceneRequest.Builder.() -> Unit): DeleteSceneResponse

Deletes a scene.

deleteSyncJob

inline suspend fun IotTwinMakerClient.deleteSyncJob(crossinline block: DeleteSyncJobRequest.Builder.() -> Unit): DeleteSyncJobResponse

Delete the SyncJob.

deleteWorkspace

inline suspend fun IotTwinMakerClient.deleteWorkspace(crossinline block: DeleteWorkspaceRequest.Builder.() -> Unit): DeleteWorkspaceResponse

Deletes a workspace.

executeQuery

inline suspend fun IotTwinMakerClient.executeQuery(crossinline block: ExecuteQueryRequest.Builder.() -> Unit): ExecuteQueryResponse

Run queries to access information from your knowledge graph of entities within individual workspaces.

executeQueryPaginated

fun IotTwinMakerClient.executeQueryPaginated(initialRequest: ExecuteQueryRequest): Flow<ExecuteQueryResponse>

fun IotTwinMakerClient.executeQueryPaginated(block: ExecuteQueryRequest.Builder.() -> Unit): Flow<ExecuteQueryResponse>

Paginate over ExecuteQueryResponse results.

getComponentType

inline suspend fun IotTwinMakerClient.getComponentType(crossinline block: GetComponentTypeRequest.Builder.() -> Unit): GetComponentTypeResponse

Retrieves information about a component type.

getEntity

inline suspend fun IotTwinMakerClient.getEntity(crossinline block: GetEntityRequest.Builder.() -> Unit): GetEntityResponse

Retrieves information about an entity.

getMetadataTransferJob

inline suspend fun IotTwinMakerClient.getMetadataTransferJob(crossinline block: GetMetadataTransferJobRequest.Builder.() -> Unit): GetMetadataTransferJobResponse

Gets a nmetadata transfer job.

getPricingPlan

inline suspend fun IotTwinMakerClient.getPricingPlan(crossinline block: GetPricingPlanRequest.Builder.() -> Unit): GetPricingPlanResponse

Gets the pricing plan.

getPropertyValue

inline suspend fun IotTwinMakerClient.getPropertyValue(crossinline block: GetPropertyValueRequest.Builder.() -> Unit): GetPropertyValueResponse

Gets the property values for a component, component type, entity, or workspace.

getPropertyValueHistory

inline suspend fun IotTwinMakerClient.getPropertyValueHistory(crossinline block: GetPropertyValueHistoryRequest.Builder.() -> Unit): GetPropertyValueHistoryResponse

Retrieves information about the history of a time series property value for a component, component type, entity, or workspace.

getPropertyValueHistoryPaginated

fun IotTwinMakerClient.getPropertyValueHistoryPaginated(initialRequest: GetPropertyValueHistoryRequest): Flow<GetPropertyValueHistoryResponse>

fun IotTwinMakerClient.getPropertyValueHistoryPaginated(block: GetPropertyValueHistoryRequest.Builder.() -> Unit): Flow<GetPropertyValueHistoryResponse>

Paginate over GetPropertyValueHistoryResponse results.

getPropertyValuePaginated

fun IotTwinMakerClient.getPropertyValuePaginated(initialRequest: GetPropertyValueRequest): Flow<GetPropertyValueResponse>

fun IotTwinMakerClient.getPropertyValuePaginated(block: GetPropertyValueRequest.Builder.() -> Unit): Flow<GetPropertyValueResponse>

Paginate over GetPropertyValueResponse results.

getScene

inline suspend fun IotTwinMakerClient.getScene(crossinline block: GetSceneRequest.Builder.() -> Unit): GetSceneResponse

Retrieves information about a scene.

getSyncJob

inline suspend fun IotTwinMakerClient.getSyncJob(crossinline block: GetSyncJobRequest.Builder.() -> Unit): GetSyncJobResponse

Gets the SyncJob.

getWorkspace

inline suspend fun IotTwinMakerClient.getWorkspace(crossinline block: GetWorkspaceRequest.Builder.() -> Unit): GetWorkspaceResponse

Retrieves information about a workspace.

listComponents

inline suspend fun IotTwinMakerClient.listComponents(crossinline block: ListComponentsRequest.Builder.() -> Unit): ListComponentsResponse

This API lists the components of an entity.

listComponentsPaginated

fun IotTwinMakerClient.listComponentsPaginated(initialRequest: ListComponentsRequest): Flow<ListComponentsResponse>

fun IotTwinMakerClient.listComponentsPaginated(block: ListComponentsRequest.Builder.() -> Unit): Flow<ListComponentsResponse>

Paginate over ListComponentsResponse results.

listComponentTypes

inline suspend fun IotTwinMakerClient.listComponentTypes(crossinline block: ListComponentTypesRequest.Builder.() -> Unit): ListComponentTypesResponse

Lists all component types in a workspace.

listComponentTypesPaginated

fun IotTwinMakerClient.listComponentTypesPaginated(initialRequest: ListComponentTypesRequest): Flow<ListComponentTypesResponse>

fun IotTwinMakerClient.listComponentTypesPaginated(block: ListComponentTypesRequest.Builder.() -> Unit): Flow<ListComponentTypesResponse>

Paginate over ListComponentTypesResponse results.

listEntities

inline suspend fun IotTwinMakerClient.listEntities(crossinline block: ListEntitiesRequest.Builder.() -> Unit): ListEntitiesResponse

Lists all entities in a workspace.

listEntitiesPaginated

fun IotTwinMakerClient.listEntitiesPaginated(initialRequest: ListEntitiesRequest): Flow<ListEntitiesResponse>

fun IotTwinMakerClient.listEntitiesPaginated(block: ListEntitiesRequest.Builder.() -> Unit): Flow<ListEntitiesResponse>

Paginate over ListEntitiesResponse results.

listMetadataTransferJobs

inline suspend fun IotTwinMakerClient.listMetadataTransferJobs(crossinline block: ListMetadataTransferJobsRequest.Builder.() -> Unit): ListMetadataTransferJobsResponse

Lists the metadata transfer jobs.

listMetadataTransferJobsPaginated

fun IotTwinMakerClient.listMetadataTransferJobsPaginated(initialRequest: ListMetadataTransferJobsRequest): Flow<ListMetadataTransferJobsResponse>

fun IotTwinMakerClient.listMetadataTransferJobsPaginated(block: ListMetadataTransferJobsRequest.Builder.() -> Unit): Flow<ListMetadataTransferJobsResponse>

Paginate over ListMetadataTransferJobsResponse results.

listProperties

inline suspend fun IotTwinMakerClient.listProperties(crossinline block: ListPropertiesRequest.Builder.() -> Unit): ListPropertiesResponse

This API lists the properties of a component.

listPropertiesPaginated

fun IotTwinMakerClient.listPropertiesPaginated(initialRequest: ListPropertiesRequest): Flow<ListPropertiesResponse>

fun IotTwinMakerClient.listPropertiesPaginated(block: ListPropertiesRequest.Builder.() -> Unit): Flow<ListPropertiesResponse>

Paginate over ListPropertiesResponse results.

listScenes

inline suspend fun IotTwinMakerClient.listScenes(crossinline block: ListScenesRequest.Builder.() -> Unit): ListScenesResponse

Lists all scenes in a workspace.

listScenesPaginated

fun IotTwinMakerClient.listScenesPaginated(initialRequest: ListScenesRequest): Flow<ListScenesResponse>

fun IotTwinMakerClient.listScenesPaginated(block: ListScenesRequest.Builder.() -> Unit): Flow<ListScenesResponse>

Paginate over ListScenesResponse results.

listSyncJobs

inline suspend fun IotTwinMakerClient.listSyncJobs(crossinline block: ListSyncJobsRequest.Builder.() -> Unit): ListSyncJobsResponse

List all SyncJobs.

listSyncJobsPaginated

fun IotTwinMakerClient.listSyncJobsPaginated(initialRequest: ListSyncJobsRequest): Flow<ListSyncJobsResponse>

fun IotTwinMakerClient.listSyncJobsPaginated(block: ListSyncJobsRequest.Builder.() -> Unit): Flow<ListSyncJobsResponse>

Paginate over ListSyncJobsResponse results.

listSyncResources

inline suspend fun IotTwinMakerClient.listSyncResources(crossinline block: ListSyncResourcesRequest.Builder.() -> Unit): ListSyncResourcesResponse

Lists the sync resources.

listSyncResourcesPaginated

fun IotTwinMakerClient.listSyncResourcesPaginated(initialRequest: ListSyncResourcesRequest): Flow<ListSyncResourcesResponse>

fun IotTwinMakerClient.listSyncResourcesPaginated(block: ListSyncResourcesRequest.Builder.() -> Unit): Flow<ListSyncResourcesResponse>

Paginate over ListSyncResourcesResponse results.

listTagsForResource

inline suspend fun IotTwinMakerClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Lists all tags associated with a resource.

listWorkspaces

inline suspend fun IotTwinMakerClient.listWorkspaces(crossinline block: ListWorkspacesRequest.Builder.() -> Unit): ListWorkspacesResponse

Retrieves information about workspaces in the current account.

listWorkspacesPaginated

fun IotTwinMakerClient.listWorkspacesPaginated(initialRequest: ListWorkspacesRequest = ListWorkspacesRequest { }): Flow<ListWorkspacesResponse>

fun IotTwinMakerClient.listWorkspacesPaginated(block: ListWorkspacesRequest.Builder.() -> Unit): Flow<ListWorkspacesResponse>

Paginate over ListWorkspacesResponse results.

tagResource

inline suspend fun IotTwinMakerClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Adds tags to a resource.

untagResource

inline suspend fun IotTwinMakerClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes tags from a resource.

updateComponentType

inline suspend fun IotTwinMakerClient.updateComponentType(crossinline block: UpdateComponentTypeRequest.Builder.() -> Unit): UpdateComponentTypeResponse

Updates information in a component type.

updateEntity

inline suspend fun IotTwinMakerClient.updateEntity(crossinline block: UpdateEntityRequest.Builder.() -> Unit): UpdateEntityResponse

Updates an entity.

updatePricingPlan

inline suspend fun IotTwinMakerClient.updatePricingPlan(crossinline block: UpdatePricingPlanRequest.Builder.() -> Unit): UpdatePricingPlanResponse

Update the pricing plan.

updateScene

inline suspend fun IotTwinMakerClient.updateScene(crossinline block: UpdateSceneRequest.Builder.() -> Unit): UpdateSceneResponse

Updates a scene.

updateWorkspace

inline suspend fun IotTwinMakerClient.updateWorkspace(crossinline block: UpdateWorkspaceRequest.Builder.() -> Unit): UpdateWorkspaceResponse

Updates a workspace.

withConfig

fun IotTwinMakerClient.withConfig(block: IotTwinMakerClient.Config.Builder.() -> Unit): IotTwinMakerClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.