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 staticbuilder()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 StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
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 theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
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.
- Throws:
InternalServerException- An unexpected error has occurred.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedSdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaBatchPutPropertyValuesRequest.builder()- Parameters:
batchPutPropertyValuesRequest- AConsumerthat will call methods onBatchPutPropertyValuesRequest.Builderto create a request.- Returns:
- Result of the BatchPutPropertyValues operation returned by the service.
- Throws:
InternalServerException- An unexpected error has occurred.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedSdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedConflictException- A conflict occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaCancelMetadataTransferJobRequest.builder()- Parameters:
cancelMetadataTransferJobRequest- AConsumerthat will call methods onCancelMetadataTransferJobRequest.Builderto create a request.- Returns:
- Result of the CancelMetadataTransferJob operation returned by the service.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedConflictException- A conflict occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ThrottlingException- The rate exceeds the limit.ValidationException- FailedConflictException- A conflict occurred.ServiceQuotaExceededException- The service quota was exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaCreateComponentTypeRequest.builder()- Parameters:
createComponentTypeRequest- AConsumerthat will call methods onCreateComponentTypeRequest.Builderto create a request.- Returns:
- Result of the CreateComponentType operation returned by the service.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ThrottlingException- The rate exceeds the limit.ValidationException- FailedConflictException- A conflict occurred.ServiceQuotaExceededException- The service quota was exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ThrottlingException- The rate exceeds the limit.ValidationException- FailedConflictException- A conflict occurred.ServiceQuotaExceededException- The service quota was exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaCreateEntityRequest.builder()- Parameters:
createEntityRequest- AConsumerthat will call methods onCreateEntityRequest.Builderto create a request.- Returns:
- Result of the CreateEntity operation returned by the service.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ThrottlingException- The rate exceeds the limit.ValidationException- FailedConflictException- A conflict occurred.ServiceQuotaExceededException- The service quota was exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedConflictException- A conflict occurred.ServiceQuotaExceededException- The service quota was exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaCreateMetadataTransferJobRequest.builder()- Parameters:
createMetadataTransferJobRequest- AConsumerthat will call methods onCreateMetadataTransferJobRequest.Builderto create a request.- Returns:
- Result of the CreateMetadataTransferJob operation returned by the service.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedConflictException- A conflict occurred.ServiceQuotaExceededException- The service quota was exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ThrottlingException- The rate exceeds the limit.ValidationException- FailedConflictException- A conflict occurred.ServiceQuotaExceededException- The service quota was exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaCreateSceneRequest.builder()- Parameters:
createSceneRequest- AConsumerthat will call methods onCreateSceneRequest.Builderto create a request.- Returns:
- Result of the CreateScene operation returned by the service.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ThrottlingException- The rate exceeds the limit.ValidationException- FailedConflictException- A conflict occurred.ServiceQuotaExceededException- The service quota was exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ThrottlingException- The rate exceeds the limit.ValidationException- FailedConflictException- A conflict occurred.ServiceQuotaExceededException- The service quota was exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaCreateSyncJobRequest.builder()- Parameters:
createSyncJobRequest- AConsumerthat will call methods onCreateSyncJobRequest.Builderto create a request.- Returns:
- Result of the CreateSyncJob operation returned by the service.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ThrottlingException- The rate exceeds the limit.ValidationException- FailedConflictException- A conflict occurred.ServiceQuotaExceededException- The service quota was exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ThrottlingException- The rate exceeds the limit.ValidationException- FailedConflictException- A conflict occurred.ServiceQuotaExceededException- The service quota was exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaCreateWorkspaceRequest.builder()- Parameters:
createWorkspaceRequest- AConsumerthat will call methods onCreateWorkspaceRequest.Builderto create a request.- Returns:
- Result of the CreateWorkspace operation returned by the service.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ThrottlingException- The rate exceeds the limit.ValidationException- FailedConflictException- A conflict occurred.ServiceQuotaExceededException- The service quota was exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedSdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaDeleteComponentTypeRequest.builder()- Parameters:
deleteComponentTypeRequest- AConsumerthat will call methods onDeleteComponentTypeRequest.Builderto create a request.- Returns:
- Result of the DeleteComponentType operation returned by the service.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedSdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
InternalServerException- An unexpected error has occurred.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedServiceQuotaExceededException- The service quota was exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaDeleteEntityRequest.builder()- Parameters:
deleteEntityRequest- AConsumerthat will call methods onDeleteEntityRequest.Builderto create a request.- Returns:
- Result of the DeleteEntity operation returned by the service.
- Throws:
InternalServerException- An unexpected error has occurred.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedServiceQuotaExceededException- The service quota was exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedSdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaDeleteSceneRequest.builder()- Parameters:
deleteSceneRequest- AConsumerthat will call methods onDeleteSceneRequest.Builderto create a request.- Returns:
- Result of the DeleteScene operation returned by the service.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedSdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedServiceQuotaExceededException- The service quota was exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaDeleteSyncJobRequest.builder()- Parameters:
deleteSyncJobRequest- AConsumerthat will call methods onDeleteSyncJobRequest.Builderto create a request.- Returns:
- Result of the DeleteSyncJob operation returned by the service.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedServiceQuotaExceededException- The service quota was exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedSdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaDeleteWorkspaceRequest.builder()- Parameters:
deleteWorkspaceRequest- AConsumerthat will call methods onDeleteWorkspaceRequest.Builderto create a request.- Returns:
- Result of the DeleteWorkspace operation returned by the service.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedSdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.QueryTimeoutException- The query timeout exception.ThrottlingException- The rate exceeds the limit.ValidationException- FailedServiceQuotaExceededException- The service quota was exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaExecuteQueryRequest.builder()- Parameters:
executeQueryRequest- AConsumerthat will call methods onExecuteQueryRequest.Builderto create a request.- Returns:
- Result of the ExecuteQuery operation returned by the service.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.QueryTimeoutException- The query timeout exception.ThrottlingException- The rate exceeds the limit.ValidationException- FailedServiceQuotaExceededException- The service quota was exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.iottwinmaker.paginators.ExecuteQueryIterable responses = client.executeQueryPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.QueryTimeoutException- The query timeout exception.ThrottlingException- The rate exceeds the limit.ValidationException- FailedServiceQuotaExceededException- The service quota was exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.iottwinmaker.paginators.ExecuteQueryIterable responses = client.executeQueryPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaExecuteQueryRequest.builder()- Parameters:
executeQueryRequest- AConsumerthat will call methods onExecuteQueryRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.QueryTimeoutException- The query timeout exception.ThrottlingException- The rate exceeds the limit.ValidationException- FailedServiceQuotaExceededException- The service quota was exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedSdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaGetComponentTypeRequest.builder()- Parameters:
getComponentTypeRequest- AConsumerthat will call methods onGetComponentTypeRequest.Builderto create a request.- Returns:
- Result of the GetComponentType operation returned by the service.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedSdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
InternalServerException- An unexpected error has occurred.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedServiceQuotaExceededException- The service quota was exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaGetEntityRequest.builder()- Parameters:
getEntityRequest- AConsumerthat will call methods onGetEntityRequest.Builderto create a request.- Returns:
- Result of the GetEntity operation returned by the service.
- Throws:
InternalServerException- An unexpected error has occurred.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedServiceQuotaExceededException- The service quota was exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedSdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaGetMetadataTransferJobRequest.builder()- Parameters:
getMetadataTransferJobRequest- AConsumerthat will call methods onGetMetadataTransferJobRequest.Builderto create a request.- Returns:
- Result of the GetMetadataTransferJob operation returned by the service.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedSdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ThrottlingException- The rate exceeds the limit.ValidationException- FailedSdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaGetPricingPlanRequest.builder()- Parameters:
getPricingPlanRequest- AConsumerthat will call methods onGetPricingPlanRequest.Builderto create a request.- Returns:
- Result of the GetPricingPlan operation returned by the service.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ThrottlingException- The rate exceeds the limit.ValidationException- FailedSdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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, orworkspaceId.- Parameters:
getPropertyValueRequest-- Returns:
- Result of the GetPropertyValue operation returned by the service.
- Throws:
InternalServerException- An unexpected error has occurred.ConnectorFailureException- The connector failed.AccessDeniedException- Access is denied.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedConnectorTimeoutException- The connector timed out.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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, orworkspaceId.
This is a convenience which creates an instance of the
GetPropertyValueRequest.Builderavoiding the need to create one manually viaGetPropertyValueRequest.builder()- Parameters:
getPropertyValueRequest- AConsumerthat will call methods onGetPropertyValueRequest.Builderto create a request.- Returns:
- Result of the GetPropertyValue operation returned by the service.
- Throws:
InternalServerException- An unexpected error has occurred.ConnectorFailureException- The connector failed.AccessDeniedException- Access is denied.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedConnectorTimeoutException- The connector timed out.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.iottwinmaker.paginators.GetPropertyValueIterable responses = client.getPropertyValuePaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.
- Throws:
InternalServerException- An unexpected error has occurred.ConnectorFailureException- The connector failed.AccessDeniedException- Access is denied.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedConnectorTimeoutException- The connector timed out.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.iottwinmaker.paginators.GetPropertyValueIterable responses = client.getPropertyValuePaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaGetPropertyValueRequest.builder()- Parameters:
getPropertyValueRequest- AConsumerthat will call methods onGetPropertyValueRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerException- An unexpected error has occurred.ConnectorFailureException- The connector failed.AccessDeniedException- Access is denied.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedConnectorTimeoutException- The connector timed out.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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 forcomponentNameandentityId. For cross-entity quries, specify a value forcomponentTypeId.- Parameters:
getPropertyValueHistoryRequest-- Returns:
- Result of the GetPropertyValueHistory operation returned by the service.
- Throws:
InternalServerException- An unexpected error has occurred.ConnectorFailureException- The connector failed.AccessDeniedException- Access is denied.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedConnectorTimeoutException- The connector timed out.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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 forcomponentNameandentityId. For cross-entity quries, specify a value forcomponentTypeId.
This is a convenience which creates an instance of the
GetPropertyValueHistoryRequest.Builderavoiding the need to create one manually viaGetPropertyValueHistoryRequest.builder()- Parameters:
getPropertyValueHistoryRequest- AConsumerthat will call methods onGetPropertyValueHistoryRequest.Builderto create a request.- Returns:
- Result of the GetPropertyValueHistory operation returned by the service.
- Throws:
InternalServerException- An unexpected error has occurred.ConnectorFailureException- The connector failed.AccessDeniedException- Access is denied.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedConnectorTimeoutException- The connector timed out.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.iottwinmaker.paginators.GetPropertyValueHistoryIterable responses = client.getPropertyValueHistoryPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.
- Throws:
InternalServerException- An unexpected error has occurred.ConnectorFailureException- The connector failed.AccessDeniedException- Access is denied.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedConnectorTimeoutException- The connector timed out.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.iottwinmaker.paginators.GetPropertyValueHistoryIterable responses = client.getPropertyValueHistoryPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaGetPropertyValueHistoryRequest.builder()- Parameters:
getPropertyValueHistoryRequest- AConsumerthat will call methods onGetPropertyValueHistoryRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerException- An unexpected error has occurred.ConnectorFailureException- The connector failed.AccessDeniedException- Access is denied.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedConnectorTimeoutException- The connector timed out.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedSdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaGetSceneRequest.builder()- Parameters:
getSceneRequest- AConsumerthat will call methods onGetSceneRequest.Builderto create a request.- Returns:
- Result of the GetScene operation returned by the service.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedSdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedServiceQuotaExceededException- The service quota was exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaGetSyncJobRequest.builder()- Parameters:
getSyncJobRequest- AConsumerthat will call methods onGetSyncJobRequest.Builderto create a request.- Returns:
- Result of the GetSyncJob operation returned by the service.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedServiceQuotaExceededException- The service quota was exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
InternalServerException- An unexpected error has occurred.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedServiceQuotaExceededException- The service quota was exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaGetWorkspaceRequest.builder()- Parameters:
getWorkspaceRequest- AConsumerthat will call methods onGetWorkspaceRequest.Builderto create a request.- Returns:
- Result of the GetWorkspace operation returned by the service.
- Throws:
InternalServerException- An unexpected error has occurred.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedServiceQuotaExceededException- The service quota was exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ThrottlingException- The rate exceeds the limit.ValidationException- FailedSdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaListComponentTypesRequest.builder()- Parameters:
listComponentTypesRequest- AConsumerthat will call methods onListComponentTypesRequest.Builderto create a request.- Returns:
- Result of the ListComponentTypes operation returned by the service.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ThrottlingException- The rate exceeds the limit.ValidationException- FailedSdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.iottwinmaker.paginators.ListComponentTypesIterable responses = client.listComponentTypesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ThrottlingException- The rate exceeds the limit.ValidationException- FailedSdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.iottwinmaker.paginators.ListComponentTypesIterable responses = client.listComponentTypesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListComponentTypesRequest.builder()- Parameters:
listComponentTypesRequest- AConsumerthat will call methods onListComponentTypesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ThrottlingException- The rate exceeds the limit.ValidationException- FailedSdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedSdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaListComponentsRequest.builder()- Parameters:
listComponentsRequest- AConsumerthat will call methods onListComponentsRequest.Builderto create a request.- Returns:
- Result of the ListComponents operation returned by the service.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedSdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.iottwinmaker.paginators.ListComponentsIterable responses = client.listComponentsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedSdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.iottwinmaker.paginators.ListComponentsIterable responses = client.listComponentsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListComponentsRequest.builder()- Parameters:
listComponentsRequest- AConsumerthat will call methods onListComponentsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedSdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
InternalServerException- An unexpected error has occurred.ThrottlingException- The rate exceeds the limit.ValidationException- FailedServiceQuotaExceededException- The service quota was exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaListEntitiesRequest.builder()- Parameters:
listEntitiesRequest- AConsumerthat will call methods onListEntitiesRequest.Builderto create a request.- Returns:
- Result of the ListEntities operation returned by the service.
- Throws:
InternalServerException- An unexpected error has occurred.ThrottlingException- The rate exceeds the limit.ValidationException- FailedServiceQuotaExceededException- The service quota was exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.iottwinmaker.paginators.ListEntitiesIterable responses = client.listEntitiesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.
- Throws:
InternalServerException- An unexpected error has occurred.ThrottlingException- The rate exceeds the limit.ValidationException- FailedServiceQuotaExceededException- The service quota was exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.iottwinmaker.paginators.ListEntitiesIterable responses = client.listEntitiesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListEntitiesRequest.builder()- Parameters:
listEntitiesRequest- AConsumerthat will call methods onListEntitiesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerException- An unexpected error has occurred.ThrottlingException- The rate exceeds the limit.ValidationException- FailedServiceQuotaExceededException- The service quota was exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ThrottlingException- The rate exceeds the limit.ValidationException- FailedSdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaListMetadataTransferJobsRequest.builder()- Parameters:
listMetadataTransferJobsRequest- AConsumerthat will call methods onListMetadataTransferJobsRequest.Builderto create a request.- Returns:
- Result of the ListMetadataTransferJobs operation returned by the service.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ThrottlingException- The rate exceeds the limit.ValidationException- FailedSdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.iottwinmaker.paginators.ListMetadataTransferJobsIterable responses = client.listMetadataTransferJobsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ThrottlingException- The rate exceeds the limit.ValidationException- FailedSdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.iottwinmaker.paginators.ListMetadataTransferJobsIterable responses = client.listMetadataTransferJobsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListMetadataTransferJobsRequest.builder()- Parameters:
listMetadataTransferJobsRequest- AConsumerthat will call methods onListMetadataTransferJobsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ThrottlingException- The rate exceeds the limit.ValidationException- FailedSdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedSdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaListPropertiesRequest.builder()- Parameters:
listPropertiesRequest- AConsumerthat will call methods onListPropertiesRequest.Builderto create a request.- Returns:
- Result of the ListProperties operation returned by the service.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedSdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.iottwinmaker.paginators.ListPropertiesIterable responses = client.listPropertiesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedSdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.iottwinmaker.paginators.ListPropertiesIterable responses = client.listPropertiesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListPropertiesRequest.builder()- Parameters:
listPropertiesRequest- AConsumerthat will call methods onListPropertiesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedSdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ThrottlingException- The rate exceeds the limit.ValidationException- FailedSdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaListScenesRequest.builder()- Parameters:
listScenesRequest- AConsumerthat will call methods onListScenesRequest.Builderto create a request.- Returns:
- Result of the ListScenes operation returned by the service.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ThrottlingException- The rate exceeds the limit.ValidationException- FailedSdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.iottwinmaker.paginators.ListScenesIterable responses = client.listScenesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ThrottlingException- The rate exceeds the limit.ValidationException- FailedSdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.iottwinmaker.paginators.ListScenesIterable responses = client.listScenesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListScenesRequest.builder()- Parameters:
listScenesRequest- AConsumerthat will call methods onListScenesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ThrottlingException- The rate exceeds the limit.ValidationException- FailedSdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ThrottlingException- The rate exceeds the limit.ValidationException- FailedServiceQuotaExceededException- The service quota was exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaListSyncJobsRequest.builder()- Parameters:
listSyncJobsRequest- AConsumerthat will call methods onListSyncJobsRequest.Builderto create a request.- Returns:
- Result of the ListSyncJobs operation returned by the service.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ThrottlingException- The rate exceeds the limit.ValidationException- FailedServiceQuotaExceededException- The service quota was exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.iottwinmaker.paginators.ListSyncJobsIterable responses = client.listSyncJobsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ThrottlingException- The rate exceeds the limit.ValidationException- FailedServiceQuotaExceededException- The service quota was exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.iottwinmaker.paginators.ListSyncJobsIterable responses = client.listSyncJobsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListSyncJobsRequest.builder()- Parameters:
listSyncJobsRequest- AConsumerthat will call methods onListSyncJobsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ThrottlingException- The rate exceeds the limit.ValidationException- FailedServiceQuotaExceededException- The service quota was exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ThrottlingException- The rate exceeds the limit.ValidationException- FailedServiceQuotaExceededException- The service quota was exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaListSyncResourcesRequest.builder()- Parameters:
listSyncResourcesRequest- AConsumerthat will call methods onListSyncResourcesRequest.Builderto create a request.- Returns:
- Result of the ListSyncResources operation returned by the service.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ThrottlingException- The rate exceeds the limit.ValidationException- FailedServiceQuotaExceededException- The service quota was exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.iottwinmaker.paginators.ListSyncResourcesIterable responses = client.listSyncResourcesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ThrottlingException- The rate exceeds the limit.ValidationException- FailedServiceQuotaExceededException- The service quota was exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.iottwinmaker.paginators.ListSyncResourcesIterable responses = client.listSyncResourcesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListSyncResourcesRequest.builder()- Parameters:
listSyncResourcesRequest- AConsumerthat will call methods onListSyncResourcesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ThrottlingException- The rate exceeds the limit.ValidationException- FailedServiceQuotaExceededException- The service quota was exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
AccessDeniedException- Access is denied.ResourceNotFoundException- The resource wasn't found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
AccessDeniedException- Access is denied.ResourceNotFoundException- The resource wasn't found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
InternalServerException- An unexpected error has occurred.ThrottlingException- The rate exceeds the limit.ValidationException- FailedServiceQuotaExceededException- The service quota was exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaListWorkspacesRequest.builder()- Parameters:
listWorkspacesRequest- AConsumerthat will call methods onListWorkspacesRequest.Builderto create a request.- Returns:
- Result of the ListWorkspaces operation returned by the service.
- Throws:
InternalServerException- An unexpected error has occurred.ThrottlingException- The rate exceeds the limit.ValidationException- FailedServiceQuotaExceededException- The service quota was exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.iottwinmaker.paginators.ListWorkspacesIterable responses = client.listWorkspacesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.
- Throws:
InternalServerException- An unexpected error has occurred.ThrottlingException- The rate exceeds the limit.ValidationException- FailedServiceQuotaExceededException- The service quota was exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.iottwinmaker.paginators.ListWorkspacesIterable responses = client.listWorkspacesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListWorkspacesRequest.builder()- Parameters:
listWorkspacesRequest- AConsumerthat will call methods onListWorkspacesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerException- An unexpected error has occurred.ThrottlingException- The rate exceeds the limit.ValidationException- FailedServiceQuotaExceededException- The service quota was exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
TooManyTagsException- The number of tags exceeds the limit.AccessDeniedException- Access is denied.ResourceNotFoundException- The resource wasn't found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
TooManyTagsException- The number of tags exceeds the limit.AccessDeniedException- Access is denied.ResourceNotFoundException- The resource wasn't found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
AccessDeniedException- Access is denied.ResourceNotFoundException- The resource wasn't found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
AccessDeniedException- Access is denied.ResourceNotFoundException- The resource wasn't found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedServiceQuotaExceededException- The service quota was exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaUpdateComponentTypeRequest.builder()- Parameters:
updateComponentTypeRequest- AConsumerthat will call methods onUpdateComponentTypeRequest.Builderto create a request.- Returns:
- Result of the UpdateComponentType operation returned by the service.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedServiceQuotaExceededException- The service quota was exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedConflictException- A conflict occurred.ServiceQuotaExceededException- The service quota was exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaUpdateEntityRequest.builder()- Parameters:
updateEntityRequest- AConsumerthat will call methods onUpdateEntityRequest.Builderto create a request.- Returns:
- Result of the UpdateEntity operation returned by the service.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedConflictException- A conflict occurred.ServiceQuotaExceededException- The service quota was exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ThrottlingException- The rate exceeds the limit.ValidationException- FailedSdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaUpdatePricingPlanRequest.builder()- Parameters:
updatePricingPlanRequest- AConsumerthat will call methods onUpdatePricingPlanRequest.Builderto create a request.- Returns:
- Result of the UpdatePricingPlan operation returned by the service.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ThrottlingException- The rate exceeds the limit.ValidationException- FailedSdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedSdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaUpdateSceneRequest.builder()- Parameters:
updateSceneRequest- AConsumerthat will call methods onUpdateSceneRequest.Builderto create a request.- Returns:
- Result of the UpdateScene operation returned by the service.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedSdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedServiceQuotaExceededException- The service quota was exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaUpdateWorkspaceRequest.builder()- Parameters:
updateWorkspaceRequest- AConsumerthat will call methods onUpdateWorkspaceRequest.Builderto create a request.- Returns:
- Result of the UpdateWorkspace operation returned by the service.
- Throws:
InternalServerException- An unexpected error has occurred.AccessDeniedException- Access is denied.ResourceNotFoundException- The resource wasn't found.ThrottlingException- The rate exceeds the limit.ValidationException- FailedServiceQuotaExceededException- The service quota was exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTTwinMakerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
create
static IoTTwinMakerClient create()
Create aIoTTwinMakerClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static IoTTwinMakerClientBuilder builder()
Create a builder that can be used to configure and create aIoTTwinMakerClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default IoTTwinMakerServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-