com.amazonaws.services.iottwinmaker

Interface AWSIoTTwinMaker

All Known Subinterfaces:

AWSIoTTwinMakerAsync

All Known Implementing Classes:

AbstractAWSIoTTwinMaker, AbstractAWSIoTTwinMakerAsync, AWSIoTTwinMakerAsyncClient, AWSIoTTwinMakerClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSIoTTwinMaker

Interface for accessing AWS IoT TwinMaker.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSIoTTwinMaker instead.

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
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
BatchPutPropertyValuesResult	batchPutPropertyValues(BatchPutPropertyValuesRequest batchPutPropertyValuesRequest) Sets values for multiple time series properties.
CreateComponentTypeResult	createComponentType(CreateComponentTypeRequest createComponentTypeRequest) Creates a component type.
CreateEntityResult	createEntity(CreateEntityRequest createEntityRequest) Creates an entity.
CreateSceneResult	createScene(CreateSceneRequest createSceneRequest) Creates a scene.
CreateWorkspaceResult	createWorkspace(CreateWorkspaceRequest createWorkspaceRequest) Creates a workplace.
DeleteComponentTypeResult	deleteComponentType(DeleteComponentTypeRequest deleteComponentTypeRequest) Deletes a component type.
DeleteEntityResult	deleteEntity(DeleteEntityRequest deleteEntityRequest) Deletes an entity.
DeleteSceneResult	deleteScene(DeleteSceneRequest deleteSceneRequest) Deletes a scene.
DeleteWorkspaceResult	deleteWorkspace(DeleteWorkspaceRequest deleteWorkspaceRequest) 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 getComponentTypeRequest) Retrieves information about a component type.
GetEntityResult	getEntity(GetEntityRequest getEntityRequest) Retrieves information about an entity.
GetPropertyValueResult	getPropertyValue(GetPropertyValueRequest getPropertyValueRequest) Gets the property values for a component, component type, entity, or workspace.
GetPropertyValueHistoryResult	getPropertyValueHistory(GetPropertyValueHistoryRequest getPropertyValueHistoryRequest) Retrieves information about the history of a time series property value for a component, component type, entity, or workspace.
GetSceneResult	getScene(GetSceneRequest getSceneRequest) Retrieves information about a scene.
GetWorkspaceResult	getWorkspace(GetWorkspaceRequest getWorkspaceRequest) Retrieves information about a workspace.
ListComponentTypesResult	listComponentTypes(ListComponentTypesRequest listComponentTypesRequest) Lists all component types in a workspace.
ListEntitiesResult	listEntities(ListEntitiesRequest listEntitiesRequest) Lists all entities in a workspace.
ListScenesResult	listScenes(ListScenesRequest listScenesRequest) Lists all scenes in a workspace.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists all tags associated with a resource.
ListWorkspacesResult	listWorkspaces(ListWorkspacesRequest listWorkspacesRequest) 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 tagResourceRequest) Adds tags to a resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes tags from a resource.
UpdateComponentTypeResult	updateComponentType(UpdateComponentTypeRequest updateComponentTypeRequest) Updates information in a component type.
UpdateEntityResult	updateEntity(UpdateEntityRequest updateEntityRequest) Updates an entity.
UpdateSceneResult	updateScene(UpdateSceneRequest updateSceneRequest) Updates a scene.
UpdateWorkspaceResult	updateWorkspace(UpdateWorkspaceRequest updateWorkspaceRequest) Updates a workspace.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

batchPutPropertyValues

BatchPutPropertyValuesResult batchPutPropertyValues(BatchPutPropertyValuesRequest batchPutPropertyValuesRequest)

Sets values for multiple time series properties.

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

CreateComponentTypeResult createComponentType(CreateComponentTypeRequest createComponentTypeRequest)

Creates a component type.

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

CreateEntityResult createEntity(CreateEntityRequest createEntityRequest)

Creates an entity.

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

CreateSceneResult createScene(CreateSceneRequest createSceneRequest)

Creates a scene.

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

CreateWorkspaceResult createWorkspace(CreateWorkspaceRequest createWorkspaceRequest)

Creates a workplace.

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

DeleteComponentTypeResult deleteComponentType(DeleteComponentTypeRequest deleteComponentTypeRequest)

Deletes a component type.

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

DeleteEntityResult deleteEntity(DeleteEntityRequest deleteEntityRequest)

Deletes an entity.

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

DeleteSceneResult deleteScene(DeleteSceneRequest deleteSceneRequest)

Deletes a scene.

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

DeleteWorkspaceResult deleteWorkspace(DeleteWorkspaceRequest deleteWorkspaceRequest)

Deletes a workspace.

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

GetComponentTypeResult getComponentType(GetComponentTypeRequest getComponentTypeRequest)

Retrieves information about a component type.

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

GetEntityResult getEntity(GetEntityRequest getEntityRequest)

Retrieves information about an entity.

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

GetPropertyValueResult getPropertyValue(GetPropertyValueRequest getPropertyValueRequest)

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

You must specify a value for either componentName, componentTypeId, entityId, or workspaceId.

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

GetPropertyValueHistoryResult getPropertyValueHistory(GetPropertyValueHistoryRequest getPropertyValueHistoryRequest)

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.

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

GetSceneResult getScene(GetSceneRequest getSceneRequest)

Retrieves information about a scene.

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

GetWorkspaceResult getWorkspace(GetWorkspaceRequest getWorkspaceRequest)

Retrieves information about a workspace.

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

ListComponentTypesResult listComponentTypes(ListComponentTypesRequest listComponentTypesRequest)

Lists all component types in a workspace.

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

ListEntitiesResult listEntities(ListEntitiesRequest listEntitiesRequest)

Lists all entities in a workspace.

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

ListScenesResult listScenes(ListScenesRequest listScenesRequest)

Lists all scenes in a workspace.

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

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Lists all tags associated with a resource.

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

ListWorkspacesResult listWorkspaces(ListWorkspacesRequest listWorkspacesRequest)

Retrieves information about workspaces in the current account.

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

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Adds tags to a resource.

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

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes tags from a resource.

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

UpdateComponentTypeResult updateComponentType(UpdateComponentTypeRequest updateComponentTypeRequest)

Updates information in a component type.

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

UpdateEntityResult updateEntity(UpdateEntityRequest updateEntityRequest)

Updates an entity.

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

UpdateSceneResult updateScene(UpdateSceneRequest updateSceneRequest)

Updates a scene.

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

UpdateWorkspaceResult updateWorkspace(UpdateWorkspaceRequest updateWorkspaceRequest)

Updates a workspace.

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

shutdown

void shutdown()

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.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.