AWSIoTTwinMakerClient (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.iottwinmaker

Class AWSIoTTwinMakerClient

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.iottwinmaker.AWSIoTTwinMakerClient

All Implemented Interfaces:

AWSIoTTwinMaker

Direct Known Subclasses:

AWSIoTTwinMakerAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSIoTTwinMakerClient
extends AmazonWebServiceClient
implements AWSIoTTwinMaker 
```
Client for accessing AWS IoT TwinMaker. All service calls made using this client are blocking, and will not return until the service call completes.

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.

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  LOGGING_AWS_REQUEST_METRIC
- Fields inherited from interface com.amazonaws.services.iottwinmaker.AWSIoTTwinMaker
  ENDPOINT_PREFIX

Method Summary

All Methods
Modifier and Type	Method and Description
`BatchPutPropertyValuesResult`	`batchPutPropertyValues (BatchPutPropertyValuesRequest request)` Sets values for multiple time series properties.
`static AWSIoTTwinMakerClientBuilder`	`builder ()`
`CancelMetadataTransferJobResult`	`cancelMetadataTransferJob (CancelMetadataTransferJobRequest request)` Cancels the metadata transfer job.
`CreateComponentTypeResult`	`createComponentType (CreateComponentTypeRequest request)` Creates a component type.
`CreateEntityResult`	`createEntity (CreateEntityRequest request)` Creates an entity.
`CreateMetadataTransferJobResult`	`createMetadataTransferJob (CreateMetadataTransferJobRequest request)` Creates a new metadata transfer job.
`CreateSceneResult`	`createScene (CreateSceneRequest request)` Creates a scene.
`CreateSyncJobResult`	`createSyncJob (CreateSyncJobRequest request)` This action creates a SyncJob.
`CreateWorkspaceResult`	`createWorkspace (CreateWorkspaceRequest request)` Creates a workplace.
`DeleteComponentTypeResult`	`deleteComponentType (DeleteComponentTypeRequest request)` Deletes a component type.
`DeleteEntityResult`	`deleteEntity (DeleteEntityRequest request)` Deletes an entity.
`DeleteSceneResult`	`deleteScene (DeleteSceneRequest request)` Deletes a scene.
`DeleteSyncJobResult`	`deleteSyncJob (DeleteSyncJobRequest request)` Delete the SyncJob.
`DeleteWorkspaceResult`	`deleteWorkspace (DeleteWorkspaceRequest request)` Deletes a workspace.
`ExecuteQueryResult`	`executeQuery (ExecuteQueryRequest request)` Run queries to access information from your knowledge graph of entities within individual workspaces.
`ResponseMetadata`	`getCachedResponseMetadata (AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
`GetComponentTypeResult`	`getComponentType (GetComponentTypeRequest request)` Retrieves information about a component type.
`GetEntityResult`	`getEntity (GetEntityRequest request)` Retrieves information about an entity.
`GetMetadataTransferJobResult`	`getMetadataTransferJob (GetMetadataTransferJobRequest request)` Gets a nmetadata transfer job.
`GetPricingPlanResult`	`getPricingPlan (GetPricingPlanRequest request)` Gets the pricing plan.
`GetPropertyValueResult`	`getPropertyValue (GetPropertyValueRequest request)` Gets the property values for a component, component type, entity, or workspace.
`GetPropertyValueHistoryResult`	`getPropertyValueHistory (GetPropertyValueHistoryRequest request)` Retrieves information about the history of a time series property value for a component, component type, entity, or workspace.
`GetSceneResult`	`getScene (GetSceneRequest request)` Retrieves information about a scene.
`GetSyncJobResult`	`getSyncJob (GetSyncJobRequest request)` Gets the SyncJob.
`GetWorkspaceResult`	`getWorkspace (GetWorkspaceRequest request)` Retrieves information about a workspace.
`ListComponentsResult`	`listComponents (ListComponentsRequest request)` This API lists the components of an entity.
`ListComponentTypesResult`	`listComponentTypes (ListComponentTypesRequest request)` Lists all component types in a workspace.
`ListEntitiesResult`	`listEntities (ListEntitiesRequest request)` Lists all entities in a workspace.
`ListMetadataTransferJobsResult`	`listMetadataTransferJobs (ListMetadataTransferJobsRequest request)` Lists the metadata transfer jobs.
`ListPropertiesResult`	`listProperties (ListPropertiesRequest request)` This API lists the properties of a component.
`ListScenesResult`	`listScenes (ListScenesRequest request)` Lists all scenes in a workspace.
`ListSyncJobsResult`	`listSyncJobs (ListSyncJobsRequest request)` List all SyncJobs.
`ListSyncResourcesResult`	`listSyncResources (ListSyncResourcesRequest request)` Lists the sync resources.
`ListTagsForResourceResult`	`listTagsForResource (ListTagsForResourceRequest request)` Lists all tags associated with a resource.
`ListWorkspacesResult`	`listWorkspaces (ListWorkspacesRequest request)` Retrieves information about workspaces in the current account.
`void`	`shutdown ()` Shuts down this client object, releasing any resources that might be held open.
`TagResourceResult`	`tagResource (TagResourceRequest request)` Adds tags to a resource.
`UntagResourceResult`	`untagResource (UntagResourceRequest request)` Removes tags from a resource.
`UpdateComponentTypeResult`	`updateComponentType (UpdateComponentTypeRequest request)` Updates information in a component type.
`UpdateEntityResult`	`updateEntity (UpdateEntityRequest request)` Updates an entity.
`UpdatePricingPlanResult`	`updatePricingPlan (UpdatePricingPlanRequest request)` Update the pricing plan.
`UpdateSceneResult`	`updateScene (UpdateSceneRequest request)` Updates a scene.
`UpdateWorkspaceResult`	`updateWorkspace (UpdateWorkspaceRequest request)` Updates a workspace.

Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - builder
```
public static AWSIoTTwinMakerClientBuilder builder()
```
  - batchPutPropertyValues
```
public BatchPutPropertyValuesResult batchPutPropertyValues(BatchPutPropertyValuesRequest request)
```
    Sets values for multiple time series properties.
    
    Specified by:
    
    batchPutPropertyValues in interface AWSIoTTwinMaker
    
    Parameters:
    
    batchPutPropertyValuesRequest -
    
    Returns:
    
    Result of the BatchPutPropertyValues operation returned by the service.
    
    Throws:
    
    InternalServerException - An unexpected error has occurred.
    
    ResourceNotFoundException - The resource wasn't found.
    
    ThrottlingException - The rate exceeds the limit.
    
    ValidationException - Failed
    
    See Also:
    
    AWS API Documentation
  - cancelMetadataTransferJob
```
public CancelMetadataTransferJobResult cancelMetadataTransferJob(CancelMetadataTransferJobRequest request)
```
    Cancels the metadata transfer job.
    
    Specified by:
    
    cancelMetadataTransferJob in interface AWSIoTTwinMaker
    
    Parameters:
    
    cancelMetadataTransferJobRequest -
    
    Returns:
    
    Result of the CancelMetadataTransferJob operation returned by the service.
    
    Throws:
    
    InternalServerException - An unexpected error has occurred.
    
    AccessDeniedException - Access is denied.
    
    ResourceNotFoundException - The resource wasn't found.
    
    ThrottlingException - The rate exceeds the limit.
    
    ValidationException - Failed
    
    ConflictException - A conflict occurred.
    
    See Also:
    
    AWS API Documentation
  - createComponentType
```
public CreateComponentTypeResult createComponentType(CreateComponentTypeRequest request)
```
    Creates a component type.
    
    Specified by:
    
    createComponentType in interface AWSIoTTwinMaker
    
    Parameters:
    
    createComponentTypeRequest -
    
    Returns:
    
    Result of the CreateComponentType operation returned by the service.
    
    Throws:
    
    InternalServerException - An unexpected error has occurred.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - The rate exceeds the limit.
    
    ValidationException - Failed
    
    ConflictException - A conflict occurred.
    
    ServiceQuotaExceededException - The service quota was exceeded.
    
    See Also:
    
    AWS API Documentation
  - createEntity
```
public CreateEntityResult createEntity(CreateEntityRequest request)
```
    Creates an entity.
    
    Specified by:
    
    createEntity in interface AWSIoTTwinMaker
    
    Parameters:
    
    createEntityRequest -
    
    Returns:
    
    Result of the CreateEntity operation returned by the service.
    
    Throws:
    
    InternalServerException - An unexpected error has occurred.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - The rate exceeds the limit.
    
    ValidationException - Failed
    
    ConflictException - A conflict occurred.
    
    ServiceQuotaExceededException - The service quota was exceeded.
    
    See Also:
    
    AWS API Documentation
  - createMetadataTransferJob
```
public CreateMetadataTransferJobResult createMetadataTransferJob(CreateMetadataTransferJobRequest request)
```
    Creates a new metadata transfer job.
    
    Specified by:
    
    createMetadataTransferJob in interface AWSIoTTwinMaker
    
    Parameters:
    
    createMetadataTransferJobRequest -
    
    Returns:
    
    Result of the CreateMetadataTransferJob operation returned by the service.
    
    Throws:
    
    InternalServerException - An unexpected error has occurred.
    
    AccessDeniedException - Access is denied.
    
    ResourceNotFoundException - The resource wasn't found.
    
    ThrottlingException - The rate exceeds the limit.
    
    ValidationException - Failed
    
    ConflictException - A conflict occurred.
    
    ServiceQuotaExceededException - The service quota was exceeded.
    
    See Also:
    
    AWS API Documentation
  - createScene
```
public CreateSceneResult createScene(CreateSceneRequest request)
```
    Creates a scene.
    
    Specified by:
    
    createScene in interface AWSIoTTwinMaker
    
    Parameters:
    
    createSceneRequest -
    
    Returns:
    
    Result of the CreateScene operation returned by the service.
    
    Throws:
    
    InternalServerException - An unexpected error has occurred.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - The rate exceeds the limit.
    
    ValidationException - Failed
    
    ConflictException - A conflict occurred.
    
    ServiceQuotaExceededException - The service quota was exceeded.
    
    See Also:
    
    AWS API Documentation
  - createSyncJob
```
public CreateSyncJobResult createSyncJob(CreateSyncJobRequest request)
```
    This action creates a SyncJob.
    
    Specified by:
    
    createSyncJob in interface AWSIoTTwinMaker
    
    Parameters:
    
    createSyncJobRequest -
    
    Returns:
    
    Result of the CreateSyncJob operation returned by the service.
    
    Throws:
    
    InternalServerException - An unexpected error has occurred.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - The rate exceeds the limit.
    
    ValidationException - Failed
    
    ConflictException - A conflict occurred.
    
    ServiceQuotaExceededException - The service quota was exceeded.
    
    See Also:
    
    AWS API Documentation
  - createWorkspace
```
public CreateWorkspaceResult createWorkspace(CreateWorkspaceRequest request)
```
    Creates a workplace.
    
    Specified by:
    
    createWorkspace in interface AWSIoTTwinMaker
    
    Parameters:
    
    createWorkspaceRequest -
    
    Returns:
    
    Result of the CreateWorkspace operation returned by the service.
    
    Throws:
    
    InternalServerException - An unexpected error has occurred.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - The rate exceeds the limit.
    
    ValidationException - Failed
    
    ConflictException - A conflict occurred.
    
    ServiceQuotaExceededException - The service quota was exceeded.
    
    See Also:
    
    AWS API Documentation
  - deleteComponentType
```
public DeleteComponentTypeResult deleteComponentType(DeleteComponentTypeRequest request)
```
    Deletes a component type.
    
    Specified by:
    
    deleteComponentType in interface AWSIoTTwinMaker
    
    Parameters:
    
    deleteComponentTypeRequest -
    
    Returns:
    
    Result of the DeleteComponentType operation returned by the service.
    
    Throws:
    
    InternalServerException - An unexpected error has occurred.
    
    AccessDeniedException - Access is denied.
    
    ResourceNotFoundException - The resource wasn't found.
    
    ThrottlingException - The rate exceeds the limit.
    
    ValidationException - Failed
    
    See Also:
    
    AWS API Documentation
  - deleteEntity
```
public DeleteEntityResult deleteEntity(DeleteEntityRequest request)
```
    Deletes an entity.
    
    Specified by:
    
    deleteEntity in interface AWSIoTTwinMaker
    
    Parameters:
    
    deleteEntityRequest -
    
    Returns:
    
    Result of the DeleteEntity operation returned by the service.
    
    Throws:
    
    InternalServerException - An unexpected error has occurred.
    
    ResourceNotFoundException - The resource wasn't found.
    
    ThrottlingException - The rate exceeds the limit.
    
    ValidationException - Failed
    
    ServiceQuotaExceededException - The service quota was exceeded.
    
    See Also:
    
    AWS API Documentation
  - deleteScene
```
public DeleteSceneResult deleteScene(DeleteSceneRequest request)
```
    Deletes a scene.
    
    Specified by:
    
    deleteScene in interface AWSIoTTwinMaker
    
    Parameters:
    
    deleteSceneRequest -
    
    Returns:
    
    Result of the DeleteScene operation returned by the service.
    
    Throws:
    
    InternalServerException - An unexpected error has occurred.
    
    AccessDeniedException - Access is denied.
    
    ResourceNotFoundException - The resource wasn't found.
    
    ThrottlingException - The rate exceeds the limit.
    
    ValidationException - Failed
    
    See Also:
    
    AWS API Documentation
  - deleteSyncJob
```
public DeleteSyncJobResult deleteSyncJob(DeleteSyncJobRequest request)
```
    Delete the SyncJob.
    
    Specified by:
    
    deleteSyncJob in interface AWSIoTTwinMaker
    
    Parameters:
    
    deleteSyncJobRequest -
    
    Returns:
    
    Result of the DeleteSyncJob operation returned by the service.
    
    Throws:
    
    InternalServerException - An unexpected error has occurred.
    
    AccessDeniedException - Access is denied.
    
    ResourceNotFoundException - The resource wasn't found.
    
    ThrottlingException - The rate exceeds the limit.
    
    ValidationException - Failed
    
    ServiceQuotaExceededException - The service quota was exceeded.
    
    See Also:
    
    AWS API Documentation
  - deleteWorkspace
```
public DeleteWorkspaceResult deleteWorkspace(DeleteWorkspaceRequest request)
```
    Deletes a workspace.
    
    Specified by:
    
    deleteWorkspace in interface AWSIoTTwinMaker
    
    Parameters:
    
    deleteWorkspaceRequest -
    
    Returns:
    
    Result of the DeleteWorkspace operation returned by the service.
    
    Throws:
    
    InternalServerException - An unexpected error has occurred.
    
    AccessDeniedException - Access is denied.
    
    ResourceNotFoundException - The resource wasn't found.
    
    ThrottlingException - The rate exceeds the limit.
    
    ValidationException - Failed
    
    See Also:
    
    AWS API Documentation
  - executeQuery
```
public ExecuteQueryResult executeQuery(ExecuteQueryRequest request)
```
    Run queries to access information from your knowledge graph of entities within individual workspaces.
    
    The ExecuteQuery action only works with Amazon Web Services Java SDK2. ExecuteQuery will not work with any Amazon Web Services Java SDK version < 2.x.
    
    Specified by:
    
    executeQuery in interface AWSIoTTwinMaker
    
    Parameters:
    
    executeQueryRequest -
    
    Returns:
    
    Result of the ExecuteQuery operation returned by the service.
    
    Throws:
    
    InternalServerException - An unexpected error has occurred.
    
    AccessDeniedException - Access is denied.
    
    QueryTimeoutException - The query timeout exception.
    
    ThrottlingException - The rate exceeds the limit.
    
    ValidationException - Failed
    
    ServiceQuotaExceededException - The service quota was exceeded.
    
    See Also:
    
    AWS API Documentation
  - getComponentType
```
public GetComponentTypeResult getComponentType(GetComponentTypeRequest request)
```
    Retrieves information about a component type.
    
    Specified by:
    
    getComponentType in interface AWSIoTTwinMaker
    
    Parameters:
    
    getComponentTypeRequest -
    
    Returns:
    
    Result of the GetComponentType operation returned by the service.
    
    Throws:
    
    InternalServerException - An unexpected error has occurred.
    
    AccessDeniedException - Access is denied.
    
    ResourceNotFoundException - The resource wasn't found.
    
    ThrottlingException - The rate exceeds the limit.
    
    ValidationException - Failed
    
    See Also:
    
    AWS API Documentation
  - getEntity
```
public GetEntityResult getEntity(GetEntityRequest request)
```
    Retrieves information about an entity.
    
    Specified by:
    
    getEntity in interface AWSIoTTwinMaker
    
    Parameters:
    
    getEntityRequest -
    
    Returns:
    
    Result of the GetEntity operation returned by the service.
    
    Throws:
    
    InternalServerException - An unexpected error has occurred.
    
    ResourceNotFoundException - The resource wasn't found.
    
    ThrottlingException - The rate exceeds the limit.
    
    ValidationException - Failed
    
    ServiceQuotaExceededException - The service quota was exceeded.
    
    See Also:
    
    AWS API Documentation
  - getMetadataTransferJob
```
public GetMetadataTransferJobResult getMetadataTransferJob(GetMetadataTransferJobRequest request)
```
    Gets a nmetadata transfer job.
    
    Specified by:
    
    getMetadataTransferJob in interface AWSIoTTwinMaker
    
    Parameters:
    
    getMetadataTransferJobRequest -
    
    Returns:
    
    Result of the GetMetadataTransferJob operation returned by the service.
    
    Throws:
    
    InternalServerException - An unexpected error has occurred.
    
    AccessDeniedException - Access is denied.
    
    ResourceNotFoundException - The resource wasn't found.
    
    ThrottlingException - The rate exceeds the limit.
    
    ValidationException - Failed
    
    See Also:
    
    AWS API Documentation
  - getPricingPlan
```
public GetPricingPlanResult getPricingPlan(GetPricingPlanRequest request)
```
    Gets the pricing plan.
    
    Specified by:
    
    getPricingPlan in interface AWSIoTTwinMaker
    
    Parameters:
    
    getPricingPlanRequest -
    
    Returns:
    
    Result of the GetPricingPlan operation returned by the service.
    
    Throws:
    
    InternalServerException - An unexpected error has occurred.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - The rate exceeds the limit.
    
    ValidationException - Failed
    
    See Also:
    
    AWS API Documentation
  - getPropertyValue
```
public GetPropertyValueResult getPropertyValue(GetPropertyValueRequest request)
```
    Gets the property values for a component, component type, entity, or workspace.
    
    You must specify a value for either componentName, componentTypeId, entityId, or workspaceId.
    
    Specified by:
    
    getPropertyValue in interface AWSIoTTwinMaker
    
    Parameters:
    
    getPropertyValueRequest -
    
    Returns:
    
    Result of the GetPropertyValue operation returned by the service.
    
    Throws:
    
    InternalServerException - An unexpected error has occurred.
    
    ConnectorFailureException - The connector failed.
    
    AccessDeniedException - Access is denied.
    
    ResourceNotFoundException - The resource wasn't found.
    
    ThrottlingException - The rate exceeds the limit.
    
    ValidationException - Failed
    
    ConnectorTimeoutException - The connector timed out.
    
    See Also:
    
    AWS API Documentation
  - getPropertyValueHistory
```
public GetPropertyValueHistoryResult getPropertyValueHistory(GetPropertyValueHistoryRequest request)
```
    Retrieves information about the history of a time series property value for a component, component type, entity, or workspace.
    
    You must specify a value for workspaceId. For entity-specific queries, specify values for componentName and entityId. For cross-entity quries, specify a value for componentTypeId.
    
    Specified by:
    
    getPropertyValueHistory in interface AWSIoTTwinMaker
    
    Parameters:
    
    getPropertyValueHistoryRequest -
    
    Returns:
    
    Result of the GetPropertyValueHistory operation returned by the service.
    
    Throws:
    
    InternalServerException - An unexpected error has occurred.
    
    ConnectorFailureException - The connector failed.
    
    AccessDeniedException - Access is denied.
    
    ResourceNotFoundException - The resource wasn't found.
    
    ThrottlingException - The rate exceeds the limit.
    
    ValidationException - Failed
    
    ConnectorTimeoutException - The connector timed out.
    
    See Also:
    
    AWS API Documentation
  - getScene
```
public GetSceneResult getScene(GetSceneRequest request)
```
    Retrieves information about a scene.
    
    Specified by:
    
    getScene in interface AWSIoTTwinMaker
    
    Parameters:
    
    getSceneRequest -
    
    Returns:
    
    Result of the GetScene operation returned by the service.
    
    Throws:
    
    InternalServerException - An unexpected error has occurred.
    
    AccessDeniedException - Access is denied.
    
    ResourceNotFoundException - The resource wasn't found.
    
    ThrottlingException - The rate exceeds the limit.
    
    ValidationException - Failed
    
    See Also:
    
    AWS API Documentation
  - getSyncJob
```
public GetSyncJobResult getSyncJob(GetSyncJobRequest request)
```
    Gets the SyncJob.
    
    Specified by:
    
    getSyncJob in interface AWSIoTTwinMaker
    
    Parameters:
    
    getSyncJobRequest -
    
    Returns:
    
    Result of the GetSyncJob operation returned by the service.
    
    Throws:
    
    InternalServerException - An unexpected error has occurred.
    
    AccessDeniedException - Access is denied.
    
    ResourceNotFoundException - The resource wasn't found.
    
    ThrottlingException - The rate exceeds the limit.
    
    ValidationException - Failed
    
    ServiceQuotaExceededException - The service quota was exceeded.
    
    See Also:
    
    AWS API Documentation
  - getWorkspace
```
public GetWorkspaceResult getWorkspace(GetWorkspaceRequest request)
```
    Retrieves information about a workspace.
    
    Specified by:
    
    getWorkspace in interface AWSIoTTwinMaker
    
    Parameters:
    
    getWorkspaceRequest -
    
    Returns:
    
    Result of the GetWorkspace operation returned by the service.
    
    Throws:
    
    InternalServerException - An unexpected error has occurred.
    
    ResourceNotFoundException - The resource wasn't found.
    
    ThrottlingException - The rate exceeds the limit.
    
    ValidationException - Failed
    
    ServiceQuotaExceededException - The service quota was exceeded.
    
    See Also:
    
    AWS API Documentation
  - listComponentTypes
```
public ListComponentTypesResult listComponentTypes(ListComponentTypesRequest request)
```
    Lists all component types in a workspace.
    
    Specified by:
    
    listComponentTypes in interface AWSIoTTwinMaker
    
    Parameters:
    
    listComponentTypesRequest -
    
    Returns:
    
    Result of the ListComponentTypes operation returned by the service.
    
    Throws:
    
    InternalServerException - An unexpected error has occurred.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - The rate exceeds the limit.
    
    ValidationException - Failed
    
    See Also:
    
    AWS API Documentation
  - listComponents
```
public ListComponentsResult listComponents(ListComponentsRequest request)
```
    This API lists the components of an entity.
    
    Specified by:
    
    listComponents in interface AWSIoTTwinMaker
    
    Parameters:
    
    listComponentsRequest -
    
    Returns:
    
    Result of the ListComponents operation returned by the service.
    
    Throws:
    
    InternalServerException - An unexpected error has occurred.
    
    AccessDeniedException - Access is denied.
    
    ResourceNotFoundException - The resource wasn't found.
    
    ThrottlingException - The rate exceeds the limit.
    
    ValidationException - Failed
    
    See Also:
    
    AWS API Documentation
  - listEntities
```
public ListEntitiesResult listEntities(ListEntitiesRequest request)
```
    Lists all entities in a workspace.
    
    Specified by:
    
    listEntities in interface AWSIoTTwinMaker
    
    Parameters:
    
    listEntitiesRequest -
    
    Returns:
    
    Result of the ListEntities operation returned by the service.
    
    Throws:
    
    InternalServerException - An unexpected error has occurred.
    
    ThrottlingException - The rate exceeds the limit.
    
    ValidationException - Failed
    
    ServiceQuotaExceededException - The service quota was exceeded.
    
    See Also:
    
    AWS API Documentation
  - listMetadataTransferJobs
```
public ListMetadataTransferJobsResult listMetadataTransferJobs(ListMetadataTransferJobsRequest request)
```
    Lists the metadata transfer jobs.
    
    Specified by:
    
    listMetadataTransferJobs in interface AWSIoTTwinMaker
    
    Parameters:
    
    listMetadataTransferJobsRequest -
    
    Returns:
    
    Result of the ListMetadataTransferJobs operation returned by the service.
    
    Throws:
    
    InternalServerException - An unexpected error has occurred.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - The rate exceeds the limit.
    
    ValidationException - Failed
    
    See Also:
    
    AWS API Documentation
  - listProperties
```
public ListPropertiesResult listProperties(ListPropertiesRequest request)
```
    This API lists the properties of a component.
    
    Specified by:
    
    listProperties in interface AWSIoTTwinMaker
    
    Parameters:
    
    listPropertiesRequest -
    
    Returns:
    
    Result of the ListProperties operation returned by the service.
    
    Throws:
    
    InternalServerException - An unexpected error has occurred.
    
    AccessDeniedException - Access is denied.
    
    ResourceNotFoundException - The resource wasn't found.
    
    ThrottlingException - The rate exceeds the limit.
    
    ValidationException - Failed
    
    See Also:
    
    AWS API Documentation
  - listScenes
```
public ListScenesResult listScenes(ListScenesRequest request)
```
    Lists all scenes in a workspace.
    
    Specified by:
    
    listScenes in interface AWSIoTTwinMaker
    
    Parameters:
    
    listScenesRequest -
    
    Returns:
    
    Result of the ListScenes operation returned by the service.
    
    Throws:
    
    InternalServerException - An unexpected error has occurred.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - The rate exceeds the limit.
    
    ValidationException - Failed
    
    See Also:
    
    AWS API Documentation
  - listSyncJobs
```
public ListSyncJobsResult listSyncJobs(ListSyncJobsRequest request)
```
    List all SyncJobs.
    
    Specified by:
    
    listSyncJobs in interface AWSIoTTwinMaker
    
    Parameters:
    
    listSyncJobsRequest -
    
    Returns:
    
    Result of the ListSyncJobs operation returned by the service.
    
    Throws:
    
    InternalServerException - An unexpected error has occurred.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - The rate exceeds the limit.
    
    ValidationException - Failed
    
    ServiceQuotaExceededException - The service quota was exceeded.
    
    See Also:
    
    AWS API Documentation
  - listSyncResources
```
public ListSyncResourcesResult listSyncResources(ListSyncResourcesRequest request)
```
    Lists the sync resources.
    
    Specified by:
    
    listSyncResources in interface AWSIoTTwinMaker
    
    Parameters:
    
    listSyncResourcesRequest -
    
    Returns:
    
    Result of the ListSyncResources operation returned by the service.
    
    Throws:
    
    InternalServerException - An unexpected error has occurred.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - The rate exceeds the limit.
    
    ValidationException - Failed
    
    ServiceQuotaExceededException - The service quota was exceeded.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Lists all tags associated with a resource.
    
    Specified by:
    
    listTagsForResource in interface AWSIoTTwinMaker
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    AccessDeniedException - Access is denied.
    
    ResourceNotFoundException - The resource wasn't found.
    
    See Also:
    
    AWS API Documentation
  - listWorkspaces
```
public ListWorkspacesResult listWorkspaces(ListWorkspacesRequest request)
```
    Retrieves information about workspaces in the current account.
    
    Specified by:
    
    listWorkspaces in interface AWSIoTTwinMaker
    
    Parameters:
    
    listWorkspacesRequest -
    
    Returns:
    
    Result of the ListWorkspaces operation returned by the service.
    
    Throws:
    
    InternalServerException - An unexpected error has occurred.
    
    ThrottlingException - The rate exceeds the limit.
    
    ValidationException - Failed
    
    ServiceQuotaExceededException - The service quota was exceeded.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Adds tags to a resource.
    
    Specified by:
    
    tagResource in interface AWSIoTTwinMaker
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    TooManyTagsException - The number of tags exceeds the limit.
    
    AccessDeniedException - Access is denied.
    
    ResourceNotFoundException - The resource wasn't found.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Removes tags from a resource.
    
    Specified by:
    
    untagResource in interface AWSIoTTwinMaker
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    AccessDeniedException - Access is denied.
    
    ResourceNotFoundException - The resource wasn't found.
    
    See Also:
    
    AWS API Documentation
  - updateComponentType
```
public UpdateComponentTypeResult updateComponentType(UpdateComponentTypeRequest request)
```
    Updates information in a component type.
    
    Specified by:
    
    updateComponentType in interface AWSIoTTwinMaker
    
    Parameters:
    
    updateComponentTypeRequest -
    
    Returns:
    
    Result of the UpdateComponentType operation returned by the service.
    
    Throws:
    
    InternalServerException - An unexpected error has occurred.
    
    AccessDeniedException - Access is denied.
    
    ResourceNotFoundException - The resource wasn't found.
    
    ThrottlingException - The rate exceeds the limit.
    
    ValidationException - Failed
    
    ServiceQuotaExceededException - The service quota was exceeded.
    
    See Also:
    
    AWS API Documentation
  - updateEntity
```
public UpdateEntityResult updateEntity(UpdateEntityRequest request)
```
    Updates an entity.
    
    Specified by:
    
    updateEntity in interface AWSIoTTwinMaker
    
    Parameters:
    
    updateEntityRequest -
    
    Returns:
    
    Result of the UpdateEntity operation returned by the service.
    
    Throws:
    
    InternalServerException - An unexpected error has occurred.
    
    AccessDeniedException - Access is denied.
    
    ResourceNotFoundException - The resource wasn't found.
    
    ThrottlingException - The rate exceeds the limit.
    
    ValidationException - Failed
    
    ConflictException - A conflict occurred.
    
    ServiceQuotaExceededException - The service quota was exceeded.
    
    See Also:
    
    AWS API Documentation
  - updatePricingPlan
```
public UpdatePricingPlanResult updatePricingPlan(UpdatePricingPlanRequest request)
```
    Update the pricing plan.
    
    Specified by:
    
    updatePricingPlan in interface AWSIoTTwinMaker
    
    Parameters:
    
    updatePricingPlanRequest -
    
    Returns:
    
    Result of the UpdatePricingPlan operation returned by the service.
    
    Throws:
    
    InternalServerException - An unexpected error has occurred.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - The rate exceeds the limit.
    
    ValidationException - Failed
    
    See Also:
    
    AWS API Documentation
  - updateScene
```
public UpdateSceneResult updateScene(UpdateSceneRequest request)
```
    Updates a scene.
    
    Specified by:
    
    updateScene in interface AWSIoTTwinMaker
    
    Parameters:
    
    updateSceneRequest -
    
    Returns:
    
    Result of the UpdateScene operation returned by the service.
    
    Throws:
    
    InternalServerException - An unexpected error has occurred.
    
    AccessDeniedException - Access is denied.
    
    ResourceNotFoundException - The resource wasn't found.
    
    ThrottlingException - The rate exceeds the limit.
    
    ValidationException - Failed
    
    See Also:
    
    AWS API Documentation
  - updateWorkspace
```
public UpdateWorkspaceResult updateWorkspace(UpdateWorkspaceRequest request)
```
    Updates a workspace.
    
    Specified by:
    
    updateWorkspace in interface AWSIoTTwinMaker
    
    Parameters:
    
    updateWorkspaceRequest -
    
    Returns:
    
    Result of the UpdateWorkspace operation returned by the service.
    
    Throws:
    
    InternalServerException - An unexpected error has occurred.
    
    AccessDeniedException - Access is denied.
    
    ResourceNotFoundException - The resource wasn't found.
    
    ThrottlingException - The rate exceeds the limit.
    
    ValidationException - Failed
    
    ServiceQuotaExceededException - The service quota was exceeded.
    
    See Also:
    
    AWS API Documentation
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSIoTTwinMaker
    
    Parameters:
    
    request - The originally executed request
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - shutdown
```
public void shutdown()
```
    Description copied from class: AmazonWebServiceClient
    
    Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AWSIoTTwinMaker
    
    Overrides:
    
    shutdown in class AmazonWebServiceClient

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.793

Class AWSIoTTwinMakerClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.iottwinmaker.AWSIoTTwinMaker

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Method Detail

builder

batchPutPropertyValues

cancelMetadataTransferJob

createComponentType

createEntity

createMetadataTransferJob

createScene

createSyncJob

createWorkspace

deleteComponentType

deleteEntity

deleteScene

deleteSyncJob

deleteWorkspace

executeQuery

getComponentType

getEntity

getMetadataTransferJob

getPricingPlan

getPropertyValue

getPropertyValueHistory

getScene

getSyncJob

getWorkspace

listComponentTypes

listComponents

listEntities

listMetadataTransferJobs

listProperties

listScenes

listSyncJobs

listSyncResources

listTagsForResource

listWorkspaces

tagResource

untagResource

updateComponentType

updateEntity

updatePricingPlan

updateScene

updateWorkspace

getCachedResponseMetadata

shutdown