Interface IoTTwinMakerClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface IoTTwinMakerClient
extends AwsClient

Service client for accessing AWS IoT TwinMaker. This can be created using the static builder() method.

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

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
default BatchPutPropertyValuesResponse	batchPutPropertyValues(Consumer<BatchPutPropertyValuesRequest.Builder> batchPutPropertyValuesRequest)	Sets values for multiple time series properties.
default BatchPutPropertyValuesResponse	batchPutPropertyValues(BatchPutPropertyValuesRequest batchPutPropertyValuesRequest)	Sets values for multiple time series properties.
static IoTTwinMakerClientBuilder	builder()	Create a builder that can be used to configure and create a IoTTwinMakerClient.
default CancelMetadataTransferJobResponse	cancelMetadataTransferJob(Consumer<CancelMetadataTransferJobRequest.Builder> cancelMetadataTransferJobRequest)	Cancels the metadata transfer job.
default CancelMetadataTransferJobResponse	cancelMetadataTransferJob(CancelMetadataTransferJobRequest cancelMetadataTransferJobRequest)	Cancels the metadata transfer job.
static IoTTwinMakerClient	create()	Create a IoTTwinMakerClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateComponentTypeResponse	createComponentType(Consumer<CreateComponentTypeRequest.Builder> createComponentTypeRequest)	Creates a component type.
default CreateComponentTypeResponse	createComponentType(CreateComponentTypeRequest createComponentTypeRequest)	Creates a component type.
default CreateEntityResponse	createEntity(Consumer<CreateEntityRequest.Builder> createEntityRequest)	Creates an entity.
default CreateEntityResponse	createEntity(CreateEntityRequest createEntityRequest)	Creates an entity.
default CreateMetadataTransferJobResponse	createMetadataTransferJob(Consumer<CreateMetadataTransferJobRequest.Builder> createMetadataTransferJobRequest)	Creates a new metadata transfer job.
default CreateMetadataTransferJobResponse	createMetadataTransferJob(CreateMetadataTransferJobRequest createMetadataTransferJobRequest)	Creates a new metadata transfer job.
default CreateSceneResponse	createScene(Consumer<CreateSceneRequest.Builder> createSceneRequest)	Creates a scene.
default CreateSceneResponse	createScene(CreateSceneRequest createSceneRequest)	Creates a scene.
default CreateSyncJobResponse	createSyncJob(Consumer<CreateSyncJobRequest.Builder> createSyncJobRequest)	This action creates a SyncJob.
default CreateSyncJobResponse	createSyncJob(CreateSyncJobRequest createSyncJobRequest)	This action creates a SyncJob.
default CreateWorkspaceResponse	createWorkspace(Consumer<CreateWorkspaceRequest.Builder> createWorkspaceRequest)	Creates a workplace.
default CreateWorkspaceResponse	createWorkspace(CreateWorkspaceRequest createWorkspaceRequest)	Creates a workplace.
default DeleteComponentTypeResponse	deleteComponentType(Consumer<DeleteComponentTypeRequest.Builder> deleteComponentTypeRequest)	Deletes a component type.
default DeleteComponentTypeResponse	deleteComponentType(DeleteComponentTypeRequest deleteComponentTypeRequest)	Deletes a component type.
default DeleteEntityResponse	deleteEntity(Consumer<DeleteEntityRequest.Builder> deleteEntityRequest)	Deletes an entity.
default DeleteEntityResponse	deleteEntity(DeleteEntityRequest deleteEntityRequest)	Deletes an entity.
default DeleteSceneResponse	deleteScene(Consumer<DeleteSceneRequest.Builder> deleteSceneRequest)	Deletes a scene.
default DeleteSceneResponse	deleteScene(DeleteSceneRequest deleteSceneRequest)	Deletes a scene.
default DeleteSyncJobResponse	deleteSyncJob(Consumer<DeleteSyncJobRequest.Builder> deleteSyncJobRequest)	Delete the SyncJob.
default DeleteSyncJobResponse	deleteSyncJob(DeleteSyncJobRequest deleteSyncJobRequest)	Delete the SyncJob.
default DeleteWorkspaceResponse	deleteWorkspace(Consumer<DeleteWorkspaceRequest.Builder> deleteWorkspaceRequest)	Deletes a workspace.
default DeleteWorkspaceResponse	deleteWorkspace(DeleteWorkspaceRequest deleteWorkspaceRequest)	Deletes a workspace.
default ExecuteQueryResponse	executeQuery(Consumer<ExecuteQueryRequest.Builder> executeQueryRequest)	Run queries to access information from your knowledge graph of entities within individual workspaces.
default ExecuteQueryResponse	executeQuery(ExecuteQueryRequest executeQueryRequest)	Run queries to access information from your knowledge graph of entities within individual workspaces.
default ExecuteQueryIterable	executeQueryPaginator(Consumer<ExecuteQueryRequest.Builder> executeQueryRequest)	This is a variant of executeQuery(software.amazon.awssdk.services.iottwinmaker.model.ExecuteQueryRequest) operation.
default ExecuteQueryIterable	executeQueryPaginator(ExecuteQueryRequest executeQueryRequest)	This is a variant of executeQuery(software.amazon.awssdk.services.iottwinmaker.model.ExecuteQueryRequest) operation.
default GetComponentTypeResponse	getComponentType(Consumer<GetComponentTypeRequest.Builder> getComponentTypeRequest)	Retrieves information about a component type.
default GetComponentTypeResponse	getComponentType(GetComponentTypeRequest getComponentTypeRequest)	Retrieves information about a component type.
default GetEntityResponse	getEntity(Consumer<GetEntityRequest.Builder> getEntityRequest)	Retrieves information about an entity.
default GetEntityResponse	getEntity(GetEntityRequest getEntityRequest)	Retrieves information about an entity.
default GetMetadataTransferJobResponse	getMetadataTransferJob(Consumer<GetMetadataTransferJobRequest.Builder> getMetadataTransferJobRequest)	Gets a nmetadata transfer job.
default GetMetadataTransferJobResponse	getMetadataTransferJob(GetMetadataTransferJobRequest getMetadataTransferJobRequest)	Gets a nmetadata transfer job.
default GetPricingPlanResponse	getPricingPlan(Consumer<GetPricingPlanRequest.Builder> getPricingPlanRequest)	Gets the pricing plan.
default GetPricingPlanResponse	getPricingPlan(GetPricingPlanRequest getPricingPlanRequest)	Gets the pricing plan.
default GetPropertyValueResponse	getPropertyValue(Consumer<GetPropertyValueRequest.Builder> getPropertyValueRequest)	Gets the property values for a component, component type, entity, or workspace.
default GetPropertyValueResponse	getPropertyValue(GetPropertyValueRequest getPropertyValueRequest)	Gets the property values for a component, component type, entity, or workspace.
default GetPropertyValueHistoryResponse	getPropertyValueHistory(Consumer<GetPropertyValueHistoryRequest.Builder> getPropertyValueHistoryRequest)	Retrieves information about the history of a time series property value for a component, component type, entity, or workspace.
default GetPropertyValueHistoryResponse	getPropertyValueHistory(GetPropertyValueHistoryRequest getPropertyValueHistoryRequest)	Retrieves information about the history of a time series property value for a component, component type, entity, or workspace.
default GetPropertyValueHistoryIterable	getPropertyValueHistoryPaginator(Consumer<GetPropertyValueHistoryRequest.Builder> getPropertyValueHistoryRequest)	This is a variant of getPropertyValueHistory(software.amazon.awssdk.services.iottwinmaker.model.GetPropertyValueHistoryRequest) operation.
default GetPropertyValueHistoryIterable	getPropertyValueHistoryPaginator(GetPropertyValueHistoryRequest getPropertyValueHistoryRequest)	This is a variant of getPropertyValueHistory(software.amazon.awssdk.services.iottwinmaker.model.GetPropertyValueHistoryRequest) operation.
default GetPropertyValueIterable	getPropertyValuePaginator(Consumer<GetPropertyValueRequest.Builder> getPropertyValueRequest)	This is a variant of getPropertyValue(software.amazon.awssdk.services.iottwinmaker.model.GetPropertyValueRequest) operation.
default GetPropertyValueIterable	getPropertyValuePaginator(GetPropertyValueRequest getPropertyValueRequest)	This is a variant of getPropertyValue(software.amazon.awssdk.services.iottwinmaker.model.GetPropertyValueRequest) operation.
default GetSceneResponse	getScene(Consumer<GetSceneRequest.Builder> getSceneRequest)	Retrieves information about a scene.
default GetSceneResponse	getScene(GetSceneRequest getSceneRequest)	Retrieves information about a scene.
default GetSyncJobResponse	getSyncJob(Consumer<GetSyncJobRequest.Builder> getSyncJobRequest)	Gets the SyncJob.
default GetSyncJobResponse	getSyncJob(GetSyncJobRequest getSyncJobRequest)	Gets the SyncJob.
default GetWorkspaceResponse	getWorkspace(Consumer<GetWorkspaceRequest.Builder> getWorkspaceRequest)	Retrieves information about a workspace.
default GetWorkspaceResponse	getWorkspace(GetWorkspaceRequest getWorkspaceRequest)	Retrieves information about a workspace.
default ListComponentsResponse	listComponents(Consumer<ListComponentsRequest.Builder> listComponentsRequest)	This API lists the components of an entity.
default ListComponentsResponse	listComponents(ListComponentsRequest listComponentsRequest)	This API lists the components of an entity.
default ListComponentsIterable	listComponentsPaginator(Consumer<ListComponentsRequest.Builder> listComponentsRequest)	This is a variant of listComponents(software.amazon.awssdk.services.iottwinmaker.model.ListComponentsRequest) operation.
default ListComponentsIterable	listComponentsPaginator(ListComponentsRequest listComponentsRequest)	This is a variant of listComponents(software.amazon.awssdk.services.iottwinmaker.model.ListComponentsRequest) operation.
default ListComponentTypesResponse	listComponentTypes(Consumer<ListComponentTypesRequest.Builder> listComponentTypesRequest)	Lists all component types in a workspace.
default ListComponentTypesResponse	listComponentTypes(ListComponentTypesRequest listComponentTypesRequest)	Lists all component types in a workspace.
default ListComponentTypesIterable	listComponentTypesPaginator(Consumer<ListComponentTypesRequest.Builder> listComponentTypesRequest)	This is a variant of listComponentTypes(software.amazon.awssdk.services.iottwinmaker.model.ListComponentTypesRequest) operation.
default ListComponentTypesIterable	listComponentTypesPaginator(ListComponentTypesRequest listComponentTypesRequest)	This is a variant of listComponentTypes(software.amazon.awssdk.services.iottwinmaker.model.ListComponentTypesRequest) operation.
default ListEntitiesResponse	listEntities(Consumer<ListEntitiesRequest.Builder> listEntitiesRequest)	Lists all entities in a workspace.
default ListEntitiesResponse	listEntities(ListEntitiesRequest listEntitiesRequest)	Lists all entities in a workspace.
default ListEntitiesIterable	listEntitiesPaginator(Consumer<ListEntitiesRequest.Builder> listEntitiesRequest)	This is a variant of listEntities(software.amazon.awssdk.services.iottwinmaker.model.ListEntitiesRequest) operation.
default ListEntitiesIterable	listEntitiesPaginator(ListEntitiesRequest listEntitiesRequest)	This is a variant of listEntities(software.amazon.awssdk.services.iottwinmaker.model.ListEntitiesRequest) operation.
default ListMetadataTransferJobsResponse	listMetadataTransferJobs(Consumer<ListMetadataTransferJobsRequest.Builder> listMetadataTransferJobsRequest)	Lists the metadata transfer jobs.
default ListMetadataTransferJobsResponse	listMetadataTransferJobs(ListMetadataTransferJobsRequest listMetadataTransferJobsRequest)	Lists the metadata transfer jobs.
default ListMetadataTransferJobsIterable	listMetadataTransferJobsPaginator(Consumer<ListMetadataTransferJobsRequest.Builder> listMetadataTransferJobsRequest)	This is a variant of listMetadataTransferJobs(software.amazon.awssdk.services.iottwinmaker.model.ListMetadataTransferJobsRequest) operation.
default ListMetadataTransferJobsIterable	listMetadataTransferJobsPaginator(ListMetadataTransferJobsRequest listMetadataTransferJobsRequest)	This is a variant of listMetadataTransferJobs(software.amazon.awssdk.services.iottwinmaker.model.ListMetadataTransferJobsRequest) operation.
default ListPropertiesResponse	listProperties(Consumer<ListPropertiesRequest.Builder> listPropertiesRequest)	This API lists the properties of a component.
default ListPropertiesResponse	listProperties(ListPropertiesRequest listPropertiesRequest)	This API lists the properties of a component.
default ListPropertiesIterable	listPropertiesPaginator(Consumer<ListPropertiesRequest.Builder> listPropertiesRequest)	This is a variant of listProperties(software.amazon.awssdk.services.iottwinmaker.model.ListPropertiesRequest) operation.
default ListPropertiesIterable	listPropertiesPaginator(ListPropertiesRequest listPropertiesRequest)	This is a variant of listProperties(software.amazon.awssdk.services.iottwinmaker.model.ListPropertiesRequest) operation.
default ListScenesResponse	listScenes(Consumer<ListScenesRequest.Builder> listScenesRequest)	Lists all scenes in a workspace.
default ListScenesResponse	listScenes(ListScenesRequest listScenesRequest)	Lists all scenes in a workspace.
default ListScenesIterable	listScenesPaginator(Consumer<ListScenesRequest.Builder> listScenesRequest)	This is a variant of listScenes(software.amazon.awssdk.services.iottwinmaker.model.ListScenesRequest) operation.
default ListScenesIterable	listScenesPaginator(ListScenesRequest listScenesRequest)	This is a variant of listScenes(software.amazon.awssdk.services.iottwinmaker.model.ListScenesRequest) operation.
default ListSyncJobsResponse	listSyncJobs(Consumer<ListSyncJobsRequest.Builder> listSyncJobsRequest)	List all SyncJobs.
default ListSyncJobsResponse	listSyncJobs(ListSyncJobsRequest listSyncJobsRequest)	List all SyncJobs.
default ListSyncJobsIterable	listSyncJobsPaginator(Consumer<ListSyncJobsRequest.Builder> listSyncJobsRequest)	This is a variant of listSyncJobs(software.amazon.awssdk.services.iottwinmaker.model.ListSyncJobsRequest) operation.
default ListSyncJobsIterable	listSyncJobsPaginator(ListSyncJobsRequest listSyncJobsRequest)	This is a variant of listSyncJobs(software.amazon.awssdk.services.iottwinmaker.model.ListSyncJobsRequest) operation.
default ListSyncResourcesResponse	listSyncResources(Consumer<ListSyncResourcesRequest.Builder> listSyncResourcesRequest)	Lists the sync resources.
default ListSyncResourcesResponse	listSyncResources(ListSyncResourcesRequest listSyncResourcesRequest)	Lists the sync resources.
default ListSyncResourcesIterable	listSyncResourcesPaginator(Consumer<ListSyncResourcesRequest.Builder> listSyncResourcesRequest)	This is a variant of listSyncResources(software.amazon.awssdk.services.iottwinmaker.model.ListSyncResourcesRequest) operation.
default ListSyncResourcesIterable	listSyncResourcesPaginator(ListSyncResourcesRequest listSyncResourcesRequest)	This is a variant of listSyncResources(software.amazon.awssdk.services.iottwinmaker.model.ListSyncResourcesRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Lists all tags associated with a resource.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Lists all tags associated with a resource.
default ListWorkspacesResponse	listWorkspaces(Consumer<ListWorkspacesRequest.Builder> listWorkspacesRequest)	Retrieves information about workspaces in the current account.
default ListWorkspacesResponse	listWorkspaces(ListWorkspacesRequest listWorkspacesRequest)	Retrieves information about workspaces in the current account.
default ListWorkspacesIterable	listWorkspacesPaginator(Consumer<ListWorkspacesRequest.Builder> listWorkspacesRequest)	This is a variant of listWorkspaces(software.amazon.awssdk.services.iottwinmaker.model.ListWorkspacesRequest) operation.
default ListWorkspacesIterable	listWorkspacesPaginator(ListWorkspacesRequest listWorkspacesRequest)	This is a variant of listWorkspaces(software.amazon.awssdk.services.iottwinmaker.model.ListWorkspacesRequest) operation.
default IoTTwinMakerServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Adds tags to a resource.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Adds tags to a resource.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes tags from a resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes tags from a resource.
default UpdateComponentTypeResponse	updateComponentType(Consumer<UpdateComponentTypeRequest.Builder> updateComponentTypeRequest)	Updates information in a component type.
default UpdateComponentTypeResponse	updateComponentType(UpdateComponentTypeRequest updateComponentTypeRequest)	Updates information in a component type.
default UpdateEntityResponse	updateEntity(Consumer<UpdateEntityRequest.Builder> updateEntityRequest)	Updates an entity.
default UpdateEntityResponse	updateEntity(UpdateEntityRequest updateEntityRequest)	Updates an entity.
default UpdatePricingPlanResponse	updatePricingPlan(Consumer<UpdatePricingPlanRequest.Builder> updatePricingPlanRequest)	Update the pricing plan.
default UpdatePricingPlanResponse	updatePricingPlan(UpdatePricingPlanRequest updatePricingPlanRequest)	Update the pricing plan.
default UpdateSceneResponse	updateScene(Consumer<UpdateSceneRequest.Builder> updateSceneRequest)	Updates a scene.
default UpdateSceneResponse	updateScene(UpdateSceneRequest updateSceneRequest)	Updates a scene.
default UpdateWorkspaceResponse	updateWorkspace(Consumer<UpdateWorkspaceRequest.Builder> updateWorkspaceRequest)	Updates a workspace.
default UpdateWorkspaceResponse	updateWorkspace(UpdateWorkspaceRequest updateWorkspaceRequest)	Updates a workspace.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

batchPutPropertyValues

default BatchPutPropertyValuesResponse batchPutPropertyValues(BatchPutPropertyValuesRequest batchPutPropertyValuesRequest)
                                                       throws InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Sets values for multiple time series properties.

Parameters:

batchPutPropertyValuesRequest -

Returns:

Result of the BatchPutPropertyValues operation returned by the service.

See Also:

• AWS API Documentation

batchPutPropertyValues

default BatchPutPropertyValuesResponse batchPutPropertyValues(Consumer<BatchPutPropertyValuesRequest.Builder> batchPutPropertyValuesRequest)
                                                       throws InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Sets values for multiple time series properties.

This is a convenience which creates an instance of the BatchPutPropertyValuesRequest.Builder avoiding the need to create one manually via BatchPutPropertyValuesRequest.builder()

Parameters:

batchPutPropertyValuesRequest - A Consumer that will call methods on BatchPutPropertyValuesRequest.Builder to create a request.

Returns:

Result of the BatchPutPropertyValues operation returned by the service.

See Also:

• AWS API Documentation

cancelMetadataTransferJob

default CancelMetadataTransferJobResponse cancelMetadataTransferJob(CancelMetadataTransferJobRequest cancelMetadataTransferJobRequest)
                                                             throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Cancels the metadata transfer job.

Parameters:

cancelMetadataTransferJobRequest -

Returns:

Result of the CancelMetadataTransferJob operation returned by the service.

See Also:

• AWS API Documentation

cancelMetadataTransferJob

default CancelMetadataTransferJobResponse cancelMetadataTransferJob(Consumer<CancelMetadataTransferJobRequest.Builder> cancelMetadataTransferJobRequest)
                                                             throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Cancels the metadata transfer job.

This is a convenience which creates an instance of the CancelMetadataTransferJobRequest.Builder avoiding the need to create one manually via CancelMetadataTransferJobRequest.builder()

Parameters:

cancelMetadataTransferJobRequest - A Consumer that will call methods on CancelMetadataTransferJobRequest.Builder to create a request.

Returns:

Result of the CancelMetadataTransferJob operation returned by the service.

See Also:

• AWS API Documentation

createComponentType

default CreateComponentTypeResponse createComponentType(CreateComponentTypeRequest createComponentTypeRequest)
                                                 throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Creates a component type.

Parameters:

createComponentTypeRequest -

Returns:

Result of the CreateComponentType operation returned by the service.

See Also:

• AWS API Documentation

createComponentType

default CreateComponentTypeResponse createComponentType(Consumer<CreateComponentTypeRequest.Builder> createComponentTypeRequest)
                                                 throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Creates a component type.

This is a convenience which creates an instance of the CreateComponentTypeRequest.Builder avoiding the need to create one manually via CreateComponentTypeRequest.builder()

Parameters:

createComponentTypeRequest - A Consumer that will call methods on CreateComponentTypeRequest.Builder to create a request.

Returns:

Result of the CreateComponentType operation returned by the service.

See Also:

• AWS API Documentation

createEntity

default CreateEntityResponse createEntity(CreateEntityRequest createEntityRequest)
                                   throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Creates an entity.

Parameters:

createEntityRequest -

Returns:

Result of the CreateEntity operation returned by the service.

See Also:

• AWS API Documentation

createEntity

default CreateEntityResponse createEntity(Consumer<CreateEntityRequest.Builder> createEntityRequest)
                                   throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Creates an entity.

This is a convenience which creates an instance of the CreateEntityRequest.Builder avoiding the need to create one manually via CreateEntityRequest.builder()

Parameters:

createEntityRequest - A Consumer that will call methods on CreateEntityRequest.Builder to create a request.

Returns:

Result of the CreateEntity operation returned by the service.

See Also:

• AWS API Documentation

createMetadataTransferJob

default CreateMetadataTransferJobResponse createMetadataTransferJob(CreateMetadataTransferJobRequest createMetadataTransferJobRequest)
                                                             throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Creates a new metadata transfer job.

Parameters:

createMetadataTransferJobRequest -

Returns:

Result of the CreateMetadataTransferJob operation returned by the service.

See Also:

• AWS API Documentation

createMetadataTransferJob

default CreateMetadataTransferJobResponse createMetadataTransferJob(Consumer<CreateMetadataTransferJobRequest.Builder> createMetadataTransferJobRequest)
                                                             throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Creates a new metadata transfer job.

This is a convenience which creates an instance of the CreateMetadataTransferJobRequest.Builder avoiding the need to create one manually via CreateMetadataTransferJobRequest.builder()

Parameters:

createMetadataTransferJobRequest - A Consumer that will call methods on CreateMetadataTransferJobRequest.Builder to create a request.

Returns:

Result of the CreateMetadataTransferJob operation returned by the service.

See Also:

• AWS API Documentation

createScene

default CreateSceneResponse createScene(CreateSceneRequest createSceneRequest)
                                 throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Creates a scene.

Parameters:

createSceneRequest -

Returns:

Result of the CreateScene operation returned by the service.

See Also:

• AWS API Documentation

createScene

default CreateSceneResponse createScene(Consumer<CreateSceneRequest.Builder> createSceneRequest)
                                 throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Creates a scene.

This is a convenience which creates an instance of the CreateSceneRequest.Builder avoiding the need to create one manually via CreateSceneRequest.builder()

Parameters:

createSceneRequest - A Consumer that will call methods on CreateSceneRequest.Builder to create a request.

Returns:

Result of the CreateScene operation returned by the service.

See Also:

• AWS API Documentation

createSyncJob

default CreateSyncJobResponse createSyncJob(CreateSyncJobRequest createSyncJobRequest)
                                     throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

This action creates a SyncJob.

Parameters:

createSyncJobRequest -

Returns:

Result of the CreateSyncJob operation returned by the service.

See Also:

• AWS API Documentation

createSyncJob

default CreateSyncJobResponse createSyncJob(Consumer<CreateSyncJobRequest.Builder> createSyncJobRequest)
                                     throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

This action creates a SyncJob.

This is a convenience which creates an instance of the CreateSyncJobRequest.Builder avoiding the need to create one manually via CreateSyncJobRequest.builder()

Parameters:

createSyncJobRequest - A Consumer that will call methods on CreateSyncJobRequest.Builder to create a request.

Returns:

Result of the CreateSyncJob operation returned by the service.

See Also:

• AWS API Documentation

createWorkspace

default CreateWorkspaceResponse createWorkspace(CreateWorkspaceRequest createWorkspaceRequest)
                                         throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Creates a workplace.

Parameters:

createWorkspaceRequest -

Returns:

Result of the CreateWorkspace operation returned by the service.

See Also:

• AWS API Documentation

createWorkspace

default CreateWorkspaceResponse createWorkspace(Consumer<CreateWorkspaceRequest.Builder> createWorkspaceRequest)
                                         throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Creates a workplace.

This is a convenience which creates an instance of the CreateWorkspaceRequest.Builder avoiding the need to create one manually via CreateWorkspaceRequest.builder()

Parameters:

createWorkspaceRequest - A Consumer that will call methods on CreateWorkspaceRequest.Builder to create a request.

Returns:

Result of the CreateWorkspace operation returned by the service.

See Also:

• AWS API Documentation

deleteComponentType

default DeleteComponentTypeResponse deleteComponentType(DeleteComponentTypeRequest deleteComponentTypeRequest)
                                                 throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Deletes a component type.

Parameters:

deleteComponentTypeRequest -

Returns:

Result of the DeleteComponentType operation returned by the service.

See Also:

• AWS API Documentation

deleteComponentType

default DeleteComponentTypeResponse deleteComponentType(Consumer<DeleteComponentTypeRequest.Builder> deleteComponentTypeRequest)
                                                 throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Deletes a component type.

This is a convenience which creates an instance of the DeleteComponentTypeRequest.Builder avoiding the need to create one manually via DeleteComponentTypeRequest.builder()

Parameters:

deleteComponentTypeRequest - A Consumer that will call methods on DeleteComponentTypeRequest.Builder to create a request.

Returns:

Result of the DeleteComponentType operation returned by the service.

See Also:

• AWS API Documentation

deleteEntity

default DeleteEntityResponse deleteEntity(DeleteEntityRequest deleteEntityRequest)
                                   throws InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Deletes an entity.

Parameters:

deleteEntityRequest -

Returns:

Result of the DeleteEntity operation returned by the service.

See Also:

• AWS API Documentation

deleteEntity

default DeleteEntityResponse deleteEntity(Consumer<DeleteEntityRequest.Builder> deleteEntityRequest)
                                   throws InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Deletes an entity.

This is a convenience which creates an instance of the DeleteEntityRequest.Builder avoiding the need to create one manually via DeleteEntityRequest.builder()

Parameters:

deleteEntityRequest - A Consumer that will call methods on DeleteEntityRequest.Builder to create a request.

Returns:

Result of the DeleteEntity operation returned by the service.

See Also:

• AWS API Documentation

deleteScene

default DeleteSceneResponse deleteScene(DeleteSceneRequest deleteSceneRequest)
                                 throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Deletes a scene.

Parameters:

deleteSceneRequest -

Returns:

Result of the DeleteScene operation returned by the service.

See Also:

• AWS API Documentation

deleteScene

default DeleteSceneResponse deleteScene(Consumer<DeleteSceneRequest.Builder> deleteSceneRequest)
                                 throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Deletes a scene.

This is a convenience which creates an instance of the DeleteSceneRequest.Builder avoiding the need to create one manually via DeleteSceneRequest.builder()

Parameters:

deleteSceneRequest - A Consumer that will call methods on DeleteSceneRequest.Builder to create a request.

Returns:

Result of the DeleteScene operation returned by the service.

See Also:

• AWS API Documentation

deleteSyncJob

default DeleteSyncJobResponse deleteSyncJob(DeleteSyncJobRequest deleteSyncJobRequest)
                                     throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Delete the SyncJob.

Parameters:

deleteSyncJobRequest -

Returns:

Result of the DeleteSyncJob operation returned by the service.

See Also:

• AWS API Documentation

deleteSyncJob

default DeleteSyncJobResponse deleteSyncJob(Consumer<DeleteSyncJobRequest.Builder> deleteSyncJobRequest)
                                     throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Delete the SyncJob.

This is a convenience which creates an instance of the DeleteSyncJobRequest.Builder avoiding the need to create one manually via DeleteSyncJobRequest.builder()

Parameters:

deleteSyncJobRequest - A Consumer that will call methods on DeleteSyncJobRequest.Builder to create a request.

Returns:

Result of the DeleteSyncJob operation returned by the service.

See Also:

• AWS API Documentation

deleteWorkspace

default DeleteWorkspaceResponse deleteWorkspace(DeleteWorkspaceRequest deleteWorkspaceRequest)
                                         throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Deletes a workspace.

Parameters:

deleteWorkspaceRequest -

Returns:

Result of the DeleteWorkspace operation returned by the service.

See Also:

• AWS API Documentation

deleteWorkspace

default DeleteWorkspaceResponse deleteWorkspace(Consumer<DeleteWorkspaceRequest.Builder> deleteWorkspaceRequest)
                                         throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Deletes a workspace.

This is a convenience which creates an instance of the DeleteWorkspaceRequest.Builder avoiding the need to create one manually via DeleteWorkspaceRequest.builder()

Parameters:

deleteWorkspaceRequest - A Consumer that will call methods on DeleteWorkspaceRequest.Builder to create a request.

Returns:

Result of the DeleteWorkspace operation returned by the service.

See Also:

• AWS API Documentation

executeQuery

default ExecuteQueryResponse executeQuery(ExecuteQueryRequest executeQueryRequest)
                                   throws InternalServerException,
AccessDeniedException,
QueryTimeoutException,
ThrottlingException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

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.

Parameters:

executeQueryRequest -

Returns:

Result of the ExecuteQuery operation returned by the service.

See Also:

• AWS API Documentation

executeQuery

default ExecuteQueryResponse executeQuery(Consumer<ExecuteQueryRequest.Builder> executeQueryRequest)
                                   throws InternalServerException,
AccessDeniedException,
QueryTimeoutException,
ThrottlingException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

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.

This is a convenience which creates an instance of the ExecuteQueryRequest.Builder avoiding the need to create one manually via ExecuteQueryRequest.builder()

Parameters:

executeQueryRequest - A Consumer that will call methods on ExecuteQueryRequest.Builder to create a request.

Returns:

Result of the ExecuteQuery operation returned by the service.

See Also:

• AWS API Documentation

executeQueryPaginator

default ExecuteQueryIterable executeQueryPaginator(ExecuteQueryRequest executeQueryRequest)
                                            throws InternalServerException,
AccessDeniedException,
QueryTimeoutException,
ThrottlingException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

This is a variant of executeQuery(software.amazon.awssdk.services.iottwinmaker.model.ExecuteQueryRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iottwinmaker.paginators.ExecuteQueryIterable responses = client.executeQueryPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iottwinmaker.paginators.ExecuteQueryIterable responses = client
             .executeQueryPaginator(request);
     for (software.amazon.awssdk.services.iottwinmaker.model.ExecuteQueryResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iottwinmaker.paginators.ExecuteQueryIterable responses = client.executeQueryPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the executeQuery(software.amazon.awssdk.services.iottwinmaker.model.ExecuteQueryRequest) operation.

Parameters:

executeQueryRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

executeQueryPaginator

default ExecuteQueryIterable executeQueryPaginator(Consumer<ExecuteQueryRequest.Builder> executeQueryRequest)
                                            throws InternalServerException,
AccessDeniedException,
QueryTimeoutException,
ThrottlingException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

This is a variant of executeQuery(software.amazon.awssdk.services.iottwinmaker.model.ExecuteQueryRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iottwinmaker.paginators.ExecuteQueryIterable responses = client.executeQueryPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iottwinmaker.paginators.ExecuteQueryIterable responses = client
             .executeQueryPaginator(request);
     for (software.amazon.awssdk.services.iottwinmaker.model.ExecuteQueryResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iottwinmaker.paginators.ExecuteQueryIterable responses = client.executeQueryPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the executeQuery(software.amazon.awssdk.services.iottwinmaker.model.ExecuteQueryRequest) operation.

This is a convenience which creates an instance of the ExecuteQueryRequest.Builder avoiding the need to create one manually via ExecuteQueryRequest.builder()

Parameters:

executeQueryRequest - A Consumer that will call methods on ExecuteQueryRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

getComponentType

default GetComponentTypeResponse getComponentType(GetComponentTypeRequest getComponentTypeRequest)
                                           throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Retrieves information about a component type.

Parameters:

getComponentTypeRequest -

Returns:

Result of the GetComponentType operation returned by the service.

See Also:

• AWS API Documentation

getComponentType

default GetComponentTypeResponse getComponentType(Consumer<GetComponentTypeRequest.Builder> getComponentTypeRequest)
                                           throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Retrieves information about a component type.

This is a convenience which creates an instance of the GetComponentTypeRequest.Builder avoiding the need to create one manually via GetComponentTypeRequest.builder()

Parameters:

getComponentTypeRequest - A Consumer that will call methods on GetComponentTypeRequest.Builder to create a request.

Returns:

Result of the GetComponentType operation returned by the service.

See Also:

• AWS API Documentation

getEntity

default GetEntityResponse getEntity(GetEntityRequest getEntityRequest)
                             throws InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Retrieves information about an entity.

Parameters:

getEntityRequest -

Returns:

Result of the GetEntity operation returned by the service.

See Also:

• AWS API Documentation

getEntity

default GetEntityResponse getEntity(Consumer<GetEntityRequest.Builder> getEntityRequest)
                             throws InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Retrieves information about an entity.

This is a convenience which creates an instance of the GetEntityRequest.Builder avoiding the need to create one manually via GetEntityRequest.builder()

Parameters:

getEntityRequest - A Consumer that will call methods on GetEntityRequest.Builder to create a request.

Returns:

Result of the GetEntity operation returned by the service.

See Also:

• AWS API Documentation

getMetadataTransferJob

default GetMetadataTransferJobResponse getMetadataTransferJob(GetMetadataTransferJobRequest getMetadataTransferJobRequest)
                                                       throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Gets a nmetadata transfer job.

Parameters:

getMetadataTransferJobRequest -

Returns:

Result of the GetMetadataTransferJob operation returned by the service.

See Also:

• AWS API Documentation

getMetadataTransferJob

default GetMetadataTransferJobResponse getMetadataTransferJob(Consumer<GetMetadataTransferJobRequest.Builder> getMetadataTransferJobRequest)
                                                       throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Gets a nmetadata transfer job.

This is a convenience which creates an instance of the GetMetadataTransferJobRequest.Builder avoiding the need to create one manually via GetMetadataTransferJobRequest.builder()

Parameters:

getMetadataTransferJobRequest - A Consumer that will call methods on GetMetadataTransferJobRequest.Builder to create a request.

Returns:

Result of the GetMetadataTransferJob operation returned by the service.

See Also:

• AWS API Documentation

getPricingPlan

default GetPricingPlanResponse getPricingPlan(GetPricingPlanRequest getPricingPlanRequest)
                                       throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Gets the pricing plan.

Parameters:

getPricingPlanRequest -

Returns:

Result of the GetPricingPlan operation returned by the service.

See Also:

• AWS API Documentation

getPricingPlan

default GetPricingPlanResponse getPricingPlan(Consumer<GetPricingPlanRequest.Builder> getPricingPlanRequest)
                                       throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Gets the pricing plan.

This is a convenience which creates an instance of the GetPricingPlanRequest.Builder avoiding the need to create one manually via GetPricingPlanRequest.builder()

Parameters:

getPricingPlanRequest - A Consumer that will call methods on GetPricingPlanRequest.Builder to create a request.

Returns:

Result of the GetPricingPlan operation returned by the service.

See Also:

• AWS API Documentation

getPropertyValue

default GetPropertyValueResponse getPropertyValue(GetPropertyValueRequest getPropertyValueRequest)
                                           throws InternalServerException,
ConnectorFailureException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
ConnectorTimeoutException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

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.

See Also:

• AWS API Documentation

getPropertyValue

default GetPropertyValueResponse getPropertyValue(Consumer<GetPropertyValueRequest.Builder> getPropertyValueRequest)
                                           throws InternalServerException,
ConnectorFailureException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
ConnectorTimeoutException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

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

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

This is a convenience which creates an instance of the GetPropertyValueRequest.Builder avoiding the need to create one manually via GetPropertyValueRequest.builder()

Parameters:

getPropertyValueRequest - A Consumer that will call methods on GetPropertyValueRequest.Builder to create a request.

Returns:

Result of the GetPropertyValue operation returned by the service.

See Also:

• AWS API Documentation

getPropertyValuePaginator

default GetPropertyValueIterable getPropertyValuePaginator(GetPropertyValueRequest getPropertyValueRequest)
                                                    throws InternalServerException,
ConnectorFailureException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
ConnectorTimeoutException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

This is a variant of getPropertyValue(software.amazon.awssdk.services.iottwinmaker.model.GetPropertyValueRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iottwinmaker.paginators.GetPropertyValueIterable responses = client.getPropertyValuePaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iottwinmaker.paginators.GetPropertyValueIterable responses = client
             .getPropertyValuePaginator(request);
     for (software.amazon.awssdk.services.iottwinmaker.model.GetPropertyValueResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iottwinmaker.paginators.GetPropertyValueIterable responses = client.getPropertyValuePaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getPropertyValue(software.amazon.awssdk.services.iottwinmaker.model.GetPropertyValueRequest) operation.

Parameters:

getPropertyValueRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

getPropertyValuePaginator

default GetPropertyValueIterable getPropertyValuePaginator(Consumer<GetPropertyValueRequest.Builder> getPropertyValueRequest)
                                                    throws InternalServerException,
ConnectorFailureException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
ConnectorTimeoutException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

This is a variant of getPropertyValue(software.amazon.awssdk.services.iottwinmaker.model.GetPropertyValueRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iottwinmaker.paginators.GetPropertyValueIterable responses = client.getPropertyValuePaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iottwinmaker.paginators.GetPropertyValueIterable responses = client
             .getPropertyValuePaginator(request);
     for (software.amazon.awssdk.services.iottwinmaker.model.GetPropertyValueResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iottwinmaker.paginators.GetPropertyValueIterable responses = client.getPropertyValuePaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getPropertyValue(software.amazon.awssdk.services.iottwinmaker.model.GetPropertyValueRequest) operation.

This is a convenience which creates an instance of the GetPropertyValueRequest.Builder avoiding the need to create one manually via GetPropertyValueRequest.builder()

Parameters:

getPropertyValueRequest - A Consumer that will call methods on GetPropertyValueRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

getPropertyValueHistory

default GetPropertyValueHistoryResponse getPropertyValueHistory(GetPropertyValueHistoryRequest getPropertyValueHistoryRequest)
                                                         throws InternalServerException,
ConnectorFailureException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
ConnectorTimeoutException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

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.

See Also:

• AWS API Documentation

getPropertyValueHistory

default GetPropertyValueHistoryResponse getPropertyValueHistory(Consumer<GetPropertyValueHistoryRequest.Builder> getPropertyValueHistoryRequest)
                                                         throws InternalServerException,
ConnectorFailureException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
ConnectorTimeoutException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

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.

This is a convenience which creates an instance of the GetPropertyValueHistoryRequest.Builder avoiding the need to create one manually via GetPropertyValueHistoryRequest.builder()

Parameters:

getPropertyValueHistoryRequest - A Consumer that will call methods on GetPropertyValueHistoryRequest.Builder to create a request.

Returns:

Result of the GetPropertyValueHistory operation returned by the service.

See Also:

• AWS API Documentation

getPropertyValueHistoryPaginator

default GetPropertyValueHistoryIterable getPropertyValueHistoryPaginator(GetPropertyValueHistoryRequest getPropertyValueHistoryRequest)
                                                                  throws InternalServerException,
ConnectorFailureException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
ConnectorTimeoutException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

This is a variant of getPropertyValueHistory(software.amazon.awssdk.services.iottwinmaker.model.GetPropertyValueHistoryRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iottwinmaker.paginators.GetPropertyValueHistoryIterable responses = client.getPropertyValueHistoryPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iottwinmaker.paginators.GetPropertyValueHistoryIterable responses = client
             .getPropertyValueHistoryPaginator(request);
     for (software.amazon.awssdk.services.iottwinmaker.model.GetPropertyValueHistoryResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iottwinmaker.paginators.GetPropertyValueHistoryIterable responses = client.getPropertyValueHistoryPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getPropertyValueHistory(software.amazon.awssdk.services.iottwinmaker.model.GetPropertyValueHistoryRequest) operation.

Parameters:

getPropertyValueHistoryRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

getPropertyValueHistoryPaginator

default GetPropertyValueHistoryIterable getPropertyValueHistoryPaginator(Consumer<GetPropertyValueHistoryRequest.Builder> getPropertyValueHistoryRequest)
                                                                  throws InternalServerException,
ConnectorFailureException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
ConnectorTimeoutException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

This is a variant of getPropertyValueHistory(software.amazon.awssdk.services.iottwinmaker.model.GetPropertyValueHistoryRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iottwinmaker.paginators.GetPropertyValueHistoryIterable responses = client.getPropertyValueHistoryPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iottwinmaker.paginators.GetPropertyValueHistoryIterable responses = client
             .getPropertyValueHistoryPaginator(request);
     for (software.amazon.awssdk.services.iottwinmaker.model.GetPropertyValueHistoryResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iottwinmaker.paginators.GetPropertyValueHistoryIterable responses = client.getPropertyValueHistoryPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getPropertyValueHistory(software.amazon.awssdk.services.iottwinmaker.model.GetPropertyValueHistoryRequest) operation.

This is a convenience which creates an instance of the GetPropertyValueHistoryRequest.Builder avoiding the need to create one manually via GetPropertyValueHistoryRequest.builder()

Parameters:

getPropertyValueHistoryRequest - A Consumer that will call methods on GetPropertyValueHistoryRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

getScene

default GetSceneResponse getScene(GetSceneRequest getSceneRequest)
                           throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Retrieves information about a scene.

Parameters:

getSceneRequest -

Returns:

Result of the GetScene operation returned by the service.

See Also:

• AWS API Documentation

getScene

default GetSceneResponse getScene(Consumer<GetSceneRequest.Builder> getSceneRequest)
                           throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Retrieves information about a scene.

This is a convenience which creates an instance of the GetSceneRequest.Builder avoiding the need to create one manually via GetSceneRequest.builder()

Parameters:

getSceneRequest - A Consumer that will call methods on GetSceneRequest.Builder to create a request.

Returns:

Result of the GetScene operation returned by the service.

See Also:

• AWS API Documentation

getSyncJob

default GetSyncJobResponse getSyncJob(GetSyncJobRequest getSyncJobRequest)
                               throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Gets the SyncJob.

Parameters:

getSyncJobRequest -

Returns:

Result of the GetSyncJob operation returned by the service.

See Also:

• AWS API Documentation

getSyncJob

default GetSyncJobResponse getSyncJob(Consumer<GetSyncJobRequest.Builder> getSyncJobRequest)
                               throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Gets the SyncJob.

This is a convenience which creates an instance of the GetSyncJobRequest.Builder avoiding the need to create one manually via GetSyncJobRequest.builder()

Parameters:

getSyncJobRequest - A Consumer that will call methods on GetSyncJobRequest.Builder to create a request.

Returns:

Result of the GetSyncJob operation returned by the service.

See Also:

• AWS API Documentation

getWorkspace

default GetWorkspaceResponse getWorkspace(GetWorkspaceRequest getWorkspaceRequest)
                                   throws InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Retrieves information about a workspace.

Parameters:

getWorkspaceRequest -

Returns:

Result of the GetWorkspace operation returned by the service.

See Also:

• AWS API Documentation

getWorkspace

default GetWorkspaceResponse getWorkspace(Consumer<GetWorkspaceRequest.Builder> getWorkspaceRequest)
                                   throws InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Retrieves information about a workspace.

This is a convenience which creates an instance of the GetWorkspaceRequest.Builder avoiding the need to create one manually via GetWorkspaceRequest.builder()

Parameters:

getWorkspaceRequest - A Consumer that will call methods on GetWorkspaceRequest.Builder to create a request.

Returns:

Result of the GetWorkspace operation returned by the service.

See Also:

• AWS API Documentation

listComponentTypes

default ListComponentTypesResponse listComponentTypes(ListComponentTypesRequest listComponentTypesRequest)
                                               throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Lists all component types in a workspace.

Parameters:

listComponentTypesRequest -

Returns:

Result of the ListComponentTypes operation returned by the service.

See Also:

• AWS API Documentation

listComponentTypes

default ListComponentTypesResponse listComponentTypes(Consumer<ListComponentTypesRequest.Builder> listComponentTypesRequest)
                                               throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Lists all component types in a workspace.

This is a convenience which creates an instance of the ListComponentTypesRequest.Builder avoiding the need to create one manually via ListComponentTypesRequest.builder()

Parameters:

listComponentTypesRequest - A Consumer that will call methods on ListComponentTypesRequest.Builder to create a request.

Returns:

Result of the ListComponentTypes operation returned by the service.

See Also:

• AWS API Documentation

listComponentTypesPaginator

default ListComponentTypesIterable listComponentTypesPaginator(ListComponentTypesRequest listComponentTypesRequest)
                                                        throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

This is a variant of listComponentTypes(software.amazon.awssdk.services.iottwinmaker.model.ListComponentTypesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iottwinmaker.paginators.ListComponentTypesIterable responses = client.listComponentTypesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iottwinmaker.paginators.ListComponentTypesIterable responses = client
             .listComponentTypesPaginator(request);
     for (software.amazon.awssdk.services.iottwinmaker.model.ListComponentTypesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iottwinmaker.paginators.ListComponentTypesIterable responses = client.listComponentTypesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listComponentTypes(software.amazon.awssdk.services.iottwinmaker.model.ListComponentTypesRequest) operation.

Parameters:

listComponentTypesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listComponentTypesPaginator

default ListComponentTypesIterable listComponentTypesPaginator(Consumer<ListComponentTypesRequest.Builder> listComponentTypesRequest)
                                                        throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

This is a variant of listComponentTypes(software.amazon.awssdk.services.iottwinmaker.model.ListComponentTypesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iottwinmaker.paginators.ListComponentTypesIterable responses = client.listComponentTypesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iottwinmaker.paginators.ListComponentTypesIterable responses = client
             .listComponentTypesPaginator(request);
     for (software.amazon.awssdk.services.iottwinmaker.model.ListComponentTypesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iottwinmaker.paginators.ListComponentTypesIterable responses = client.listComponentTypesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listComponentTypes(software.amazon.awssdk.services.iottwinmaker.model.ListComponentTypesRequest) operation.

This is a convenience which creates an instance of the ListComponentTypesRequest.Builder avoiding the need to create one manually via ListComponentTypesRequest.builder()

Parameters:

listComponentTypesRequest - A Consumer that will call methods on ListComponentTypesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listComponents

default ListComponentsResponse listComponents(ListComponentsRequest listComponentsRequest)
                                       throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

This API lists the components of an entity.

Parameters:

listComponentsRequest -

Returns:

Result of the ListComponents operation returned by the service.

See Also:

• AWS API Documentation

listComponents

default ListComponentsResponse listComponents(Consumer<ListComponentsRequest.Builder> listComponentsRequest)
                                       throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

This API lists the components of an entity.

This is a convenience which creates an instance of the ListComponentsRequest.Builder avoiding the need to create one manually via ListComponentsRequest.builder()

Parameters:

listComponentsRequest - A Consumer that will call methods on ListComponentsRequest.Builder to create a request.

Returns:

Result of the ListComponents operation returned by the service.

See Also:

• AWS API Documentation

listComponentsPaginator

default ListComponentsIterable listComponentsPaginator(ListComponentsRequest listComponentsRequest)
                                                throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

This is a variant of listComponents(software.amazon.awssdk.services.iottwinmaker.model.ListComponentsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iottwinmaker.paginators.ListComponentsIterable responses = client.listComponentsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iottwinmaker.paginators.ListComponentsIterable responses = client
             .listComponentsPaginator(request);
     for (software.amazon.awssdk.services.iottwinmaker.model.ListComponentsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iottwinmaker.paginators.ListComponentsIterable responses = client.listComponentsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listComponents(software.amazon.awssdk.services.iottwinmaker.model.ListComponentsRequest) operation.

Parameters:

listComponentsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listComponentsPaginator

default ListComponentsIterable listComponentsPaginator(Consumer<ListComponentsRequest.Builder> listComponentsRequest)
                                                throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

This is a variant of listComponents(software.amazon.awssdk.services.iottwinmaker.model.ListComponentsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iottwinmaker.paginators.ListComponentsIterable responses = client.listComponentsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iottwinmaker.paginators.ListComponentsIterable responses = client
             .listComponentsPaginator(request);
     for (software.amazon.awssdk.services.iottwinmaker.model.ListComponentsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iottwinmaker.paginators.ListComponentsIterable responses = client.listComponentsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listComponents(software.amazon.awssdk.services.iottwinmaker.model.ListComponentsRequest) operation.

This is a convenience which creates an instance of the ListComponentsRequest.Builder avoiding the need to create one manually via ListComponentsRequest.builder()

Parameters:

listComponentsRequest - A Consumer that will call methods on ListComponentsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listEntities

default ListEntitiesResponse listEntities(ListEntitiesRequest listEntitiesRequest)
                                   throws InternalServerException,
ThrottlingException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Lists all entities in a workspace.

Parameters:

listEntitiesRequest -

Returns:

Result of the ListEntities operation returned by the service.

See Also:

• AWS API Documentation

listEntities

default ListEntitiesResponse listEntities(Consumer<ListEntitiesRequest.Builder> listEntitiesRequest)
                                   throws InternalServerException,
ThrottlingException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Lists all entities in a workspace.

This is a convenience which creates an instance of the ListEntitiesRequest.Builder avoiding the need to create one manually via ListEntitiesRequest.builder()

Parameters:

listEntitiesRequest - A Consumer that will call methods on ListEntitiesRequest.Builder to create a request.

Returns:

Result of the ListEntities operation returned by the service.

See Also:

• AWS API Documentation

listEntitiesPaginator

default ListEntitiesIterable listEntitiesPaginator(ListEntitiesRequest listEntitiesRequest)
                                            throws InternalServerException,
ThrottlingException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

This is a variant of listEntities(software.amazon.awssdk.services.iottwinmaker.model.ListEntitiesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iottwinmaker.paginators.ListEntitiesIterable responses = client.listEntitiesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iottwinmaker.paginators.ListEntitiesIterable responses = client
             .listEntitiesPaginator(request);
     for (software.amazon.awssdk.services.iottwinmaker.model.ListEntitiesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iottwinmaker.paginators.ListEntitiesIterable responses = client.listEntitiesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listEntities(software.amazon.awssdk.services.iottwinmaker.model.ListEntitiesRequest) operation.

Parameters:

listEntitiesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listEntitiesPaginator

default ListEntitiesIterable listEntitiesPaginator(Consumer<ListEntitiesRequest.Builder> listEntitiesRequest)
                                            throws InternalServerException,
ThrottlingException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

This is a variant of listEntities(software.amazon.awssdk.services.iottwinmaker.model.ListEntitiesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iottwinmaker.paginators.ListEntitiesIterable responses = client.listEntitiesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iottwinmaker.paginators.ListEntitiesIterable responses = client
             .listEntitiesPaginator(request);
     for (software.amazon.awssdk.services.iottwinmaker.model.ListEntitiesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iottwinmaker.paginators.ListEntitiesIterable responses = client.listEntitiesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listEntities(software.amazon.awssdk.services.iottwinmaker.model.ListEntitiesRequest) operation.

This is a convenience which creates an instance of the ListEntitiesRequest.Builder avoiding the need to create one manually via ListEntitiesRequest.builder()

Parameters:

listEntitiesRequest - A Consumer that will call methods on ListEntitiesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listMetadataTransferJobs

default ListMetadataTransferJobsResponse listMetadataTransferJobs(ListMetadataTransferJobsRequest listMetadataTransferJobsRequest)
                                                           throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Lists the metadata transfer jobs.

Parameters:

listMetadataTransferJobsRequest -

Returns:

Result of the ListMetadataTransferJobs operation returned by the service.

See Also:

• AWS API Documentation

listMetadataTransferJobs

default ListMetadataTransferJobsResponse listMetadataTransferJobs(Consumer<ListMetadataTransferJobsRequest.Builder> listMetadataTransferJobsRequest)
                                                           throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Lists the metadata transfer jobs.

This is a convenience which creates an instance of the ListMetadataTransferJobsRequest.Builder avoiding the need to create one manually via ListMetadataTransferJobsRequest.builder()

Parameters:

listMetadataTransferJobsRequest - A Consumer that will call methods on ListMetadataTransferJobsRequest.Builder to create a request.

Returns:

Result of the ListMetadataTransferJobs operation returned by the service.

See Also:

• AWS API Documentation

listMetadataTransferJobsPaginator

default ListMetadataTransferJobsIterable listMetadataTransferJobsPaginator(ListMetadataTransferJobsRequest listMetadataTransferJobsRequest)
                                                                    throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

This is a variant of listMetadataTransferJobs(software.amazon.awssdk.services.iottwinmaker.model.ListMetadataTransferJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iottwinmaker.paginators.ListMetadataTransferJobsIterable responses = client.listMetadataTransferJobsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iottwinmaker.paginators.ListMetadataTransferJobsIterable responses = client
             .listMetadataTransferJobsPaginator(request);
     for (software.amazon.awssdk.services.iottwinmaker.model.ListMetadataTransferJobsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iottwinmaker.paginators.ListMetadataTransferJobsIterable responses = client.listMetadataTransferJobsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listMetadataTransferJobs(software.amazon.awssdk.services.iottwinmaker.model.ListMetadataTransferJobsRequest) operation.

Parameters:

listMetadataTransferJobsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listMetadataTransferJobsPaginator

default ListMetadataTransferJobsIterable listMetadataTransferJobsPaginator(Consumer<ListMetadataTransferJobsRequest.Builder> listMetadataTransferJobsRequest)
                                                                    throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

This is a variant of listMetadataTransferJobs(software.amazon.awssdk.services.iottwinmaker.model.ListMetadataTransferJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iottwinmaker.paginators.ListMetadataTransferJobsIterable responses = client.listMetadataTransferJobsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iottwinmaker.paginators.ListMetadataTransferJobsIterable responses = client
             .listMetadataTransferJobsPaginator(request);
     for (software.amazon.awssdk.services.iottwinmaker.model.ListMetadataTransferJobsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iottwinmaker.paginators.ListMetadataTransferJobsIterable responses = client.listMetadataTransferJobsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listMetadataTransferJobs(software.amazon.awssdk.services.iottwinmaker.model.ListMetadataTransferJobsRequest) operation.

This is a convenience which creates an instance of the ListMetadataTransferJobsRequest.Builder avoiding the need to create one manually via ListMetadataTransferJobsRequest.builder()

Parameters:

listMetadataTransferJobsRequest - A Consumer that will call methods on ListMetadataTransferJobsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listProperties

default ListPropertiesResponse listProperties(ListPropertiesRequest listPropertiesRequest)
                                       throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

This API lists the properties of a component.

Parameters:

listPropertiesRequest -

Returns:

Result of the ListProperties operation returned by the service.

See Also:

• AWS API Documentation

listProperties

default ListPropertiesResponse listProperties(Consumer<ListPropertiesRequest.Builder> listPropertiesRequest)
                                       throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

This API lists the properties of a component.

This is a convenience which creates an instance of the ListPropertiesRequest.Builder avoiding the need to create one manually via ListPropertiesRequest.builder()

Parameters:

listPropertiesRequest - A Consumer that will call methods on ListPropertiesRequest.Builder to create a request.

Returns:

Result of the ListProperties operation returned by the service.

See Also:

• AWS API Documentation

listPropertiesPaginator

default ListPropertiesIterable listPropertiesPaginator(ListPropertiesRequest listPropertiesRequest)
                                                throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

This is a variant of listProperties(software.amazon.awssdk.services.iottwinmaker.model.ListPropertiesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iottwinmaker.paginators.ListPropertiesIterable responses = client.listPropertiesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iottwinmaker.paginators.ListPropertiesIterable responses = client
             .listPropertiesPaginator(request);
     for (software.amazon.awssdk.services.iottwinmaker.model.ListPropertiesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iottwinmaker.paginators.ListPropertiesIterable responses = client.listPropertiesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listProperties(software.amazon.awssdk.services.iottwinmaker.model.ListPropertiesRequest) operation.

Parameters:

listPropertiesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listPropertiesPaginator

default ListPropertiesIterable listPropertiesPaginator(Consumer<ListPropertiesRequest.Builder> listPropertiesRequest)
                                                throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

This is a variant of listProperties(software.amazon.awssdk.services.iottwinmaker.model.ListPropertiesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iottwinmaker.paginators.ListPropertiesIterable responses = client.listPropertiesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iottwinmaker.paginators.ListPropertiesIterable responses = client
             .listPropertiesPaginator(request);
     for (software.amazon.awssdk.services.iottwinmaker.model.ListPropertiesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iottwinmaker.paginators.ListPropertiesIterable responses = client.listPropertiesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listProperties(software.amazon.awssdk.services.iottwinmaker.model.ListPropertiesRequest) operation.

This is a convenience which creates an instance of the ListPropertiesRequest.Builder avoiding the need to create one manually via ListPropertiesRequest.builder()

Parameters:

listPropertiesRequest - A Consumer that will call methods on ListPropertiesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listScenes

default ListScenesResponse listScenes(ListScenesRequest listScenesRequest)
                               throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Lists all scenes in a workspace.

Parameters:

listScenesRequest -

Returns:

Result of the ListScenes operation returned by the service.

See Also:

• AWS API Documentation

listScenes

default ListScenesResponse listScenes(Consumer<ListScenesRequest.Builder> listScenesRequest)
                               throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Lists all scenes in a workspace.

This is a convenience which creates an instance of the ListScenesRequest.Builder avoiding the need to create one manually via ListScenesRequest.builder()

Parameters:

listScenesRequest - A Consumer that will call methods on ListScenesRequest.Builder to create a request.

Returns:

Result of the ListScenes operation returned by the service.

See Also:

• AWS API Documentation

listScenesPaginator

default ListScenesIterable listScenesPaginator(ListScenesRequest listScenesRequest)
                                        throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

This is a variant of listScenes(software.amazon.awssdk.services.iottwinmaker.model.ListScenesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iottwinmaker.paginators.ListScenesIterable responses = client.listScenesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iottwinmaker.paginators.ListScenesIterable responses = client.listScenesPaginator(request);
     for (software.amazon.awssdk.services.iottwinmaker.model.ListScenesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iottwinmaker.paginators.ListScenesIterable responses = client.listScenesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listScenes(software.amazon.awssdk.services.iottwinmaker.model.ListScenesRequest) operation.

Parameters:

listScenesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listScenesPaginator

default ListScenesIterable listScenesPaginator(Consumer<ListScenesRequest.Builder> listScenesRequest)
                                        throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

This is a variant of listScenes(software.amazon.awssdk.services.iottwinmaker.model.ListScenesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iottwinmaker.paginators.ListScenesIterable responses = client.listScenesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iottwinmaker.paginators.ListScenesIterable responses = client.listScenesPaginator(request);
     for (software.amazon.awssdk.services.iottwinmaker.model.ListScenesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iottwinmaker.paginators.ListScenesIterable responses = client.listScenesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listScenes(software.amazon.awssdk.services.iottwinmaker.model.ListScenesRequest) operation.

This is a convenience which creates an instance of the ListScenesRequest.Builder avoiding the need to create one manually via ListScenesRequest.builder()

Parameters:

listScenesRequest - A Consumer that will call methods on ListScenesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listSyncJobs

default ListSyncJobsResponse listSyncJobs(ListSyncJobsRequest listSyncJobsRequest)
                                   throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

List all SyncJobs.

Parameters:

listSyncJobsRequest -

Returns:

Result of the ListSyncJobs operation returned by the service.

See Also:

• AWS API Documentation

listSyncJobs

default ListSyncJobsResponse listSyncJobs(Consumer<ListSyncJobsRequest.Builder> listSyncJobsRequest)
                                   throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

List all SyncJobs.

This is a convenience which creates an instance of the ListSyncJobsRequest.Builder avoiding the need to create one manually via ListSyncJobsRequest.builder()

Parameters:

listSyncJobsRequest - A Consumer that will call methods on ListSyncJobsRequest.Builder to create a request.

Returns:

Result of the ListSyncJobs operation returned by the service.

See Also:

• AWS API Documentation

listSyncJobsPaginator

default ListSyncJobsIterable listSyncJobsPaginator(ListSyncJobsRequest listSyncJobsRequest)
                                            throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

This is a variant of listSyncJobs(software.amazon.awssdk.services.iottwinmaker.model.ListSyncJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iottwinmaker.paginators.ListSyncJobsIterable responses = client.listSyncJobsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iottwinmaker.paginators.ListSyncJobsIterable responses = client
             .listSyncJobsPaginator(request);
     for (software.amazon.awssdk.services.iottwinmaker.model.ListSyncJobsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iottwinmaker.paginators.ListSyncJobsIterable responses = client.listSyncJobsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listSyncJobs(software.amazon.awssdk.services.iottwinmaker.model.ListSyncJobsRequest) operation.

Parameters:

listSyncJobsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listSyncJobsPaginator

default ListSyncJobsIterable listSyncJobsPaginator(Consumer<ListSyncJobsRequest.Builder> listSyncJobsRequest)
                                            throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

This is a variant of listSyncJobs(software.amazon.awssdk.services.iottwinmaker.model.ListSyncJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iottwinmaker.paginators.ListSyncJobsIterable responses = client.listSyncJobsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iottwinmaker.paginators.ListSyncJobsIterable responses = client
             .listSyncJobsPaginator(request);
     for (software.amazon.awssdk.services.iottwinmaker.model.ListSyncJobsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iottwinmaker.paginators.ListSyncJobsIterable responses = client.listSyncJobsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listSyncJobs(software.amazon.awssdk.services.iottwinmaker.model.ListSyncJobsRequest) operation.

This is a convenience which creates an instance of the ListSyncJobsRequest.Builder avoiding the need to create one manually via ListSyncJobsRequest.builder()

Parameters:

listSyncJobsRequest - A Consumer that will call methods on ListSyncJobsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listSyncResources

default ListSyncResourcesResponse listSyncResources(ListSyncResourcesRequest listSyncResourcesRequest)
                                             throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Lists the sync resources.

Parameters:

listSyncResourcesRequest -

Returns:

Result of the ListSyncResources operation returned by the service.

See Also:

• AWS API Documentation

listSyncResources

default ListSyncResourcesResponse listSyncResources(Consumer<ListSyncResourcesRequest.Builder> listSyncResourcesRequest)
                                             throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Lists the sync resources.

This is a convenience which creates an instance of the ListSyncResourcesRequest.Builder avoiding the need to create one manually via ListSyncResourcesRequest.builder()

Parameters:

listSyncResourcesRequest - A Consumer that will call methods on ListSyncResourcesRequest.Builder to create a request.

Returns:

Result of the ListSyncResources operation returned by the service.

See Also:

• AWS API Documentation

listSyncResourcesPaginator

default ListSyncResourcesIterable listSyncResourcesPaginator(ListSyncResourcesRequest listSyncResourcesRequest)
                                                      throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

This is a variant of listSyncResources(software.amazon.awssdk.services.iottwinmaker.model.ListSyncResourcesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iottwinmaker.paginators.ListSyncResourcesIterable responses = client.listSyncResourcesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iottwinmaker.paginators.ListSyncResourcesIterable responses = client
             .listSyncResourcesPaginator(request);
     for (software.amazon.awssdk.services.iottwinmaker.model.ListSyncResourcesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iottwinmaker.paginators.ListSyncResourcesIterable responses = client.listSyncResourcesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listSyncResources(software.amazon.awssdk.services.iottwinmaker.model.ListSyncResourcesRequest) operation.

Parameters:

listSyncResourcesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listSyncResourcesPaginator

default ListSyncResourcesIterable listSyncResourcesPaginator(Consumer<ListSyncResourcesRequest.Builder> listSyncResourcesRequest)
                                                      throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

This is a variant of listSyncResources(software.amazon.awssdk.services.iottwinmaker.model.ListSyncResourcesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iottwinmaker.paginators.ListSyncResourcesIterable responses = client.listSyncResourcesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iottwinmaker.paginators.ListSyncResourcesIterable responses = client
             .listSyncResourcesPaginator(request);
     for (software.amazon.awssdk.services.iottwinmaker.model.ListSyncResourcesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iottwinmaker.paginators.ListSyncResourcesIterable responses = client.listSyncResourcesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listSyncResources(software.amazon.awssdk.services.iottwinmaker.model.ListSyncResourcesRequest) operation.

This is a convenience which creates an instance of the ListSyncResourcesRequest.Builder avoiding the need to create one manually via ListSyncResourcesRequest.builder()

Parameters:

listSyncResourcesRequest - A Consumer that will call methods on ListSyncResourcesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Lists all tags associated with a resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Lists all tags associated with a resource.

This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listWorkspaces

default ListWorkspacesResponse listWorkspaces(ListWorkspacesRequest listWorkspacesRequest)
                                       throws InternalServerException,
ThrottlingException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Retrieves information about workspaces in the current account.

Parameters:

listWorkspacesRequest -

Returns:

Result of the ListWorkspaces operation returned by the service.

See Also:

• AWS API Documentation

listWorkspaces

default ListWorkspacesResponse listWorkspaces(Consumer<ListWorkspacesRequest.Builder> listWorkspacesRequest)
                                       throws InternalServerException,
ThrottlingException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Retrieves information about workspaces in the current account.

This is a convenience which creates an instance of the ListWorkspacesRequest.Builder avoiding the need to create one manually via ListWorkspacesRequest.builder()

Parameters:

listWorkspacesRequest - A Consumer that will call methods on ListWorkspacesRequest.Builder to create a request.

Returns:

Result of the ListWorkspaces operation returned by the service.

See Also:

• AWS API Documentation

listWorkspacesPaginator

default ListWorkspacesIterable listWorkspacesPaginator(ListWorkspacesRequest listWorkspacesRequest)
                                                throws InternalServerException,
ThrottlingException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

This is a variant of listWorkspaces(software.amazon.awssdk.services.iottwinmaker.model.ListWorkspacesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iottwinmaker.paginators.ListWorkspacesIterable responses = client.listWorkspacesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iottwinmaker.paginators.ListWorkspacesIterable responses = client
             .listWorkspacesPaginator(request);
     for (software.amazon.awssdk.services.iottwinmaker.model.ListWorkspacesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iottwinmaker.paginators.ListWorkspacesIterable responses = client.listWorkspacesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listWorkspaces(software.amazon.awssdk.services.iottwinmaker.model.ListWorkspacesRequest) operation.

Parameters:

listWorkspacesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listWorkspacesPaginator

default ListWorkspacesIterable listWorkspacesPaginator(Consumer<ListWorkspacesRequest.Builder> listWorkspacesRequest)
                                                throws InternalServerException,
ThrottlingException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

This is a variant of listWorkspaces(software.amazon.awssdk.services.iottwinmaker.model.ListWorkspacesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iottwinmaker.paginators.ListWorkspacesIterable responses = client.listWorkspacesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iottwinmaker.paginators.ListWorkspacesIterable responses = client
             .listWorkspacesPaginator(request);
     for (software.amazon.awssdk.services.iottwinmaker.model.ListWorkspacesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iottwinmaker.paginators.ListWorkspacesIterable responses = client.listWorkspacesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listWorkspaces(software.amazon.awssdk.services.iottwinmaker.model.ListWorkspacesRequest) operation.

This is a convenience which creates an instance of the ListWorkspacesRequest.Builder avoiding the need to create one manually via ListWorkspacesRequest.builder()

Parameters:

listWorkspacesRequest - A Consumer that will call methods on ListWorkspacesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws TooManyTagsException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Adds tags to a resource.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws TooManyTagsException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Adds tags to a resource.

This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Removes tags from a resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Removes tags from a resource.

This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

updateComponentType

default UpdateComponentTypeResponse updateComponentType(UpdateComponentTypeRequest updateComponentTypeRequest)
                                                 throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Updates information in a component type.

Parameters:

updateComponentTypeRequest -

Returns:

Result of the UpdateComponentType operation returned by the service.

See Also:

• AWS API Documentation

updateComponentType

default UpdateComponentTypeResponse updateComponentType(Consumer<UpdateComponentTypeRequest.Builder> updateComponentTypeRequest)
                                                 throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Updates information in a component type.

This is a convenience which creates an instance of the UpdateComponentTypeRequest.Builder avoiding the need to create one manually via UpdateComponentTypeRequest.builder()

Parameters:

updateComponentTypeRequest - A Consumer that will call methods on UpdateComponentTypeRequest.Builder to create a request.

Returns:

Result of the UpdateComponentType operation returned by the service.

See Also:

• AWS API Documentation

updateEntity

default UpdateEntityResponse updateEntity(UpdateEntityRequest updateEntityRequest)
                                   throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Updates an entity.

Parameters:

updateEntityRequest -

Returns:

Result of the UpdateEntity operation returned by the service.

See Also:

• AWS API Documentation

updateEntity

default UpdateEntityResponse updateEntity(Consumer<UpdateEntityRequest.Builder> updateEntityRequest)
                                   throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Updates an entity.

This is a convenience which creates an instance of the UpdateEntityRequest.Builder avoiding the need to create one manually via UpdateEntityRequest.builder()

Parameters:

updateEntityRequest - A Consumer that will call methods on UpdateEntityRequest.Builder to create a request.

Returns:

Result of the UpdateEntity operation returned by the service.

See Also:

• AWS API Documentation

updatePricingPlan

default UpdatePricingPlanResponse updatePricingPlan(UpdatePricingPlanRequest updatePricingPlanRequest)
                                             throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Update the pricing plan.

Parameters:

updatePricingPlanRequest -

Returns:

Result of the UpdatePricingPlan operation returned by the service.

See Also:

• AWS API Documentation

updatePricingPlan

default UpdatePricingPlanResponse updatePricingPlan(Consumer<UpdatePricingPlanRequest.Builder> updatePricingPlanRequest)
                                             throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Update the pricing plan.

This is a convenience which creates an instance of the UpdatePricingPlanRequest.Builder avoiding the need to create one manually via UpdatePricingPlanRequest.builder()

Parameters:

updatePricingPlanRequest - A Consumer that will call methods on UpdatePricingPlanRequest.Builder to create a request.

Returns:

Result of the UpdatePricingPlan operation returned by the service.

See Also:

• AWS API Documentation

updateScene

default UpdateSceneResponse updateScene(UpdateSceneRequest updateSceneRequest)
                                 throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Updates a scene.

Parameters:

updateSceneRequest -

Returns:

Result of the UpdateScene operation returned by the service.

See Also:

• AWS API Documentation

updateScene

default UpdateSceneResponse updateScene(Consumer<UpdateSceneRequest.Builder> updateSceneRequest)
                                 throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Updates a scene.

This is a convenience which creates an instance of the UpdateSceneRequest.Builder avoiding the need to create one manually via UpdateSceneRequest.builder()

Parameters:

updateSceneRequest - A Consumer that will call methods on UpdateSceneRequest.Builder to create a request.

Returns:

Result of the UpdateScene operation returned by the service.

See Also:

• AWS API Documentation

updateWorkspace

default UpdateWorkspaceResponse updateWorkspace(UpdateWorkspaceRequest updateWorkspaceRequest)
                                         throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Updates a workspace.

Parameters:

updateWorkspaceRequest -

Returns:

Result of the UpdateWorkspace operation returned by the service.

See Also:

• AWS API Documentation

updateWorkspace

default UpdateWorkspaceResponse updateWorkspace(Consumer<UpdateWorkspaceRequest.Builder> updateWorkspaceRequest)
                                         throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
IoTTwinMakerException

Updates a workspace.

This is a convenience which creates an instance of the UpdateWorkspaceRequest.Builder avoiding the need to create one manually via UpdateWorkspaceRequest.builder()

Parameters:

updateWorkspaceRequest - A Consumer that will call methods on UpdateWorkspaceRequest.Builder to create a request.

Returns:

Result of the UpdateWorkspace operation returned by the service.

See Also:

• AWS API Documentation

create

static IoTTwinMakerClient create()

Create a IoTTwinMakerClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static IoTTwinMakerClientBuilder builder()

Create a builder that can be used to configure and create a IoTTwinMakerClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default IoTTwinMakerServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration