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 that enables you to 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

Modifier and Type	Field and Description
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

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

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
BatchPutPropertyValuesResult	batchPutPropertyValues(BatchPutPropertyValuesRequest request) Sets values for multiple time series properties.
static AWSIoTTwinMakerClientBuilder	builder()
CreateComponentTypeResult	createComponentType(CreateComponentTypeRequest request) Creates a component type.
CreateEntityResult	createEntity(CreateEntityRequest request) Creates an entity.
CreateSceneResult	createScene(CreateSceneRequest request) Creates a scene.
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.
DeleteWorkspaceResult	deleteWorkspace(DeleteWorkspaceRequest request) Deletes a workspace.
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.
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.
GetWorkspaceResult	getWorkspace(GetWorkspaceRequest request) Retrieves information about a workspace.
ListComponentTypesResult	listComponentTypes(ListComponentTypesRequest request) Lists all component types in a workspace.
ListEntitiesResult	listEntities(ListEntitiesRequest request) Lists all entities in a workspace.
ListScenesResult	listScenes(ListScenesRequest request) Lists all scenes in a workspace.
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.
UpdateSceneResult	updateScene(UpdateSceneRequest request) Updates a scene.
UpdateWorkspaceResult	updateWorkspace(UpdateWorkspaceRequest request) Updates a workspace.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

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

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

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

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

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

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.

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

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

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

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

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

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

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 interface: AWSIoTTwinMaker

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. 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