iottwinmaker/aws.sdk.kotlin.services.iottwinmaker

Package-level declarations

Types

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.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

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.

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.

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.

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.

listComponentTypes

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

Lists all component types in a workspace.

listEntities

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

Lists all entities in a workspace.

listMetadataTransferJobs

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

Lists the metadata transfer jobs.

listProperties

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

This API lists the properties of a component.

listScenes

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

Lists all scenes in a workspace.

listSyncJobs

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

List all SyncJobs.

listSyncResources

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

Lists the sync resources.

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.

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.