Interface IoTTwinMakerAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface IoTTwinMakerAsyncClient extends AwsClient
Service client for accessing AWS IoT TwinMaker asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

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 Details

  • Method Details

    • batchPutPropertyValues

      default CompletableFuture<BatchPutPropertyValuesResponse> batchPutPropertyValues(BatchPutPropertyValuesRequest batchPutPropertyValuesRequest)

      Sets values for multiple time series properties.

      Parameters:
      batchPutPropertyValuesRequest -
      Returns:
      A Java Future containing the result of the BatchPutPropertyValues operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • batchPutPropertyValues

      default CompletableFuture<BatchPutPropertyValuesResponse> batchPutPropertyValues(Consumer<BatchPutPropertyValuesRequest.Builder> batchPutPropertyValuesRequest)

      Sets values for multiple time series properties.


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

      Parameters:
      batchPutPropertyValuesRequest - A Consumer that will call methods on BatchPutPropertyValuesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the BatchPutPropertyValues operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • cancelMetadataTransferJob

      default CompletableFuture<CancelMetadataTransferJobResponse> cancelMetadataTransferJob(CancelMetadataTransferJobRequest cancelMetadataTransferJobRequest)

      Cancels the metadata transfer job.

      Parameters:
      cancelMetadataTransferJobRequest -
      Returns:
      A Java Future containing the result of the CancelMetadataTransferJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • ConflictException A conflict occurred.
      • 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.
      See Also:

    • cancelMetadataTransferJob

      default CompletableFuture<CancelMetadataTransferJobResponse> cancelMetadataTransferJob(Consumer<CancelMetadataTransferJobRequest.Builder> cancelMetadataTransferJobRequest)

      Cancels the metadata transfer job.


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

      Parameters:
      cancelMetadataTransferJobRequest - A Consumer that will call methods on CancelMetadataTransferJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CancelMetadataTransferJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • ConflictException A conflict occurred.
      • 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.
      See Also:

    • createComponentType

      default CompletableFuture<CreateComponentTypeResponse> createComponentType(CreateComponentTypeRequest createComponentTypeRequest)

      Creates a component type.

      Parameters:
      createComponentTypeRequest -
      Returns:
      A Java Future containing the result of the CreateComponentType operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • ConflictException A conflict occurred.
      • ServiceQuotaExceededException The service quota was exceeded.
      • 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.
      See Also:

    • createComponentType

      default CompletableFuture<CreateComponentTypeResponse> createComponentType(Consumer<CreateComponentTypeRequest.Builder> createComponentTypeRequest)

      Creates a component type.


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

      Parameters:
      createComponentTypeRequest - A Consumer that will call methods on CreateComponentTypeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateComponentType operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • ConflictException A conflict occurred.
      • ServiceQuotaExceededException The service quota was exceeded.
      • 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.
      See Also:

    • createEntity

      default CompletableFuture<CreateEntityResponse> createEntity(CreateEntityRequest createEntityRequest)

      Creates an entity.

      Parameters:
      createEntityRequest -
      Returns:
      A Java Future containing the result of the CreateEntity operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • ConflictException A conflict occurred.
      • ServiceQuotaExceededException The service quota was exceeded.
      • 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.
      See Also:

    • createEntity

      default CompletableFuture<CreateEntityResponse> createEntity(Consumer<CreateEntityRequest.Builder> createEntityRequest)

      Creates an entity.


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

      Parameters:
      createEntityRequest - A Consumer that will call methods on CreateEntityRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateEntity operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • ConflictException A conflict occurred.
      • ServiceQuotaExceededException The service quota was exceeded.
      • 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.
      See Also:

    • createMetadataTransferJob

      default CompletableFuture<CreateMetadataTransferJobResponse> createMetadataTransferJob(CreateMetadataTransferJobRequest createMetadataTransferJobRequest)

      Creates a new metadata transfer job.

      Parameters:
      createMetadataTransferJobRequest -
      Returns:
      A Java Future containing the result of the CreateMetadataTransferJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • ConflictException A conflict occurred.
      • ServiceQuotaExceededException The service quota was exceeded.
      • 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.
      See Also:

    • createMetadataTransferJob

      default CompletableFuture<CreateMetadataTransferJobResponse> createMetadataTransferJob(Consumer<CreateMetadataTransferJobRequest.Builder> createMetadataTransferJobRequest)

      Creates a new metadata transfer job.


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

      Parameters:
      createMetadataTransferJobRequest - A Consumer that will call methods on CreateMetadataTransferJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateMetadataTransferJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • ConflictException A conflict occurred.
      • ServiceQuotaExceededException The service quota was exceeded.
      • 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.
      See Also:

    • createScene

      default CompletableFuture<CreateSceneResponse> createScene(CreateSceneRequest createSceneRequest)

      Creates a scene.

      Parameters:
      createSceneRequest -
      Returns:
      A Java Future containing the result of the CreateScene operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • ConflictException A conflict occurred.
      • ServiceQuotaExceededException The service quota was exceeded.
      • 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.
      See Also:

    • createScene

      default CompletableFuture<CreateSceneResponse> createScene(Consumer<CreateSceneRequest.Builder> createSceneRequest)

      Creates a scene.


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

      Parameters:
      createSceneRequest - A Consumer that will call methods on CreateSceneRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateScene operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • ConflictException A conflict occurred.
      • ServiceQuotaExceededException The service quota was exceeded.
      • 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.
      See Also:

    • createSyncJob

      default CompletableFuture<CreateSyncJobResponse> createSyncJob(CreateSyncJobRequest createSyncJobRequest)

      This action creates a SyncJob.

      Parameters:
      createSyncJobRequest -
      Returns:
      A Java Future containing the result of the CreateSyncJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • ConflictException A conflict occurred.
      • ServiceQuotaExceededException The service quota was exceeded.
      • 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.
      See Also:

    • createSyncJob

      default CompletableFuture<CreateSyncJobResponse> createSyncJob(Consumer<CreateSyncJobRequest.Builder> createSyncJobRequest)

      This action creates a SyncJob.


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

      Parameters:
      createSyncJobRequest - A Consumer that will call methods on CreateSyncJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateSyncJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • ConflictException A conflict occurred.
      • ServiceQuotaExceededException The service quota was exceeded.
      • 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.
      See Also:

    • createWorkspace

      default CompletableFuture<CreateWorkspaceResponse> createWorkspace(CreateWorkspaceRequest createWorkspaceRequest)

      Creates a workplace.

      Parameters:
      createWorkspaceRequest -
      Returns:
      A Java Future containing the result of the CreateWorkspace operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • ConflictException A conflict occurred.
      • ServiceQuotaExceededException The service quota was exceeded.
      • 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.
      See Also:

    • createWorkspace

      default CompletableFuture<CreateWorkspaceResponse> createWorkspace(Consumer<CreateWorkspaceRequest.Builder> createWorkspaceRequest)

      Creates a workplace.


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

      Parameters:
      createWorkspaceRequest - A Consumer that will call methods on CreateWorkspaceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateWorkspace operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • ConflictException A conflict occurred.
      • ServiceQuotaExceededException The service quota was exceeded.
      • 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.
      See Also:

    • deleteComponentType

      default CompletableFuture<DeleteComponentTypeResponse> deleteComponentType(DeleteComponentTypeRequest deleteComponentTypeRequest)

      Deletes a component type.

      Parameters:
      deleteComponentTypeRequest -
      Returns:
      A Java Future containing the result of the DeleteComponentType operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • deleteComponentType

      default CompletableFuture<DeleteComponentTypeResponse> deleteComponentType(Consumer<DeleteComponentTypeRequest.Builder> deleteComponentTypeRequest)

      Deletes a component type.


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

      Parameters:
      deleteComponentTypeRequest - A Consumer that will call methods on DeleteComponentTypeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteComponentType operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • deleteEntity

      default CompletableFuture<DeleteEntityResponse> deleteEntity(DeleteEntityRequest deleteEntityRequest)

      Deletes an entity.

      Parameters:
      deleteEntityRequest -
      Returns:
      A Java Future containing the result of the DeleteEntity operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • ServiceQuotaExceededException The service quota was exceeded.
      • 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.
      See Also:

    • deleteEntity

      default CompletableFuture<DeleteEntityResponse> deleteEntity(Consumer<DeleteEntityRequest.Builder> deleteEntityRequest)

      Deletes an entity.


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

      Parameters:
      deleteEntityRequest - A Consumer that will call methods on DeleteEntityRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteEntity operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • ServiceQuotaExceededException The service quota was exceeded.
      • 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.
      See Also:

    • deleteScene

      default CompletableFuture<DeleteSceneResponse> deleteScene(DeleteSceneRequest deleteSceneRequest)

      Deletes a scene.

      Parameters:
      deleteSceneRequest -
      Returns:
      A Java Future containing the result of the DeleteScene operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • deleteScene

      default CompletableFuture<DeleteSceneResponse> deleteScene(Consumer<DeleteSceneRequest.Builder> deleteSceneRequest)

      Deletes a scene.


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

      Parameters:
      deleteSceneRequest - A Consumer that will call methods on DeleteSceneRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteScene operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • deleteSyncJob

      default CompletableFuture<DeleteSyncJobResponse> deleteSyncJob(DeleteSyncJobRequest deleteSyncJobRequest)

      Delete the SyncJob.

      Parameters:
      deleteSyncJobRequest -
      Returns:
      A Java Future containing the result of the DeleteSyncJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • ServiceQuotaExceededException The service quota was exceeded.
      • 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.
      See Also:

    • deleteSyncJob

      default CompletableFuture<DeleteSyncJobResponse> deleteSyncJob(Consumer<DeleteSyncJobRequest.Builder> deleteSyncJobRequest)

      Delete the SyncJob.


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

      Parameters:
      deleteSyncJobRequest - A Consumer that will call methods on DeleteSyncJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteSyncJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • ServiceQuotaExceededException The service quota was exceeded.
      • 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.
      See Also:

    • deleteWorkspace

      default CompletableFuture<DeleteWorkspaceResponse> deleteWorkspace(DeleteWorkspaceRequest deleteWorkspaceRequest)

      Deletes a workspace.

      Parameters:
      deleteWorkspaceRequest -
      Returns:
      A Java Future containing the result of the DeleteWorkspace operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • deleteWorkspace

      default CompletableFuture<DeleteWorkspaceResponse> deleteWorkspace(Consumer<DeleteWorkspaceRequest.Builder> deleteWorkspaceRequest)

      Deletes a workspace.


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

      Parameters:
      deleteWorkspaceRequest - A Consumer that will call methods on DeleteWorkspaceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteWorkspace operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • executeQuery

      default CompletableFuture<ExecuteQueryResponse> executeQuery(ExecuteQueryRequest executeQueryRequest)

      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:
      A Java Future containing the result of the ExecuteQuery operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • QueryTimeoutException The query timeout exception.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • ServiceQuotaExceededException The service quota was exceeded.
      • 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.
      See Also:

    • executeQuery

      default CompletableFuture<ExecuteQueryResponse> executeQuery(Consumer<ExecuteQueryRequest.Builder> executeQueryRequest)

      Run queries to access information from your knowledge graph of entities within individual workspaces.

      The ExecuteQuery action only works with Amazon Web Services Java SDK2. ExecuteQuery will not work with any Amazon Web Services Java SDK version < 2.x.


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

      Parameters:
      executeQueryRequest - A Consumer that will call methods on ExecuteQueryRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ExecuteQuery operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • QueryTimeoutException The query timeout exception.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • ServiceQuotaExceededException The service quota was exceeded.
      • 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.
      See Also:

    • executeQueryPaginator

      default ExecuteQueryPublisher executeQueryPaginator(ExecuteQueryRequest executeQueryRequest)

      This is a variant of executeQuery(software.amazon.awssdk.services.iottwinmaker.model.ExecuteQueryRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.iottwinmaker.paginators.ExecuteQueryPublisher publisher = client.executeQueryPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.iottwinmaker.paginators.ExecuteQueryPublisher publisher = client.executeQueryPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iottwinmaker.model.ExecuteQueryResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iottwinmaker.model.ExecuteQueryResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • QueryTimeoutException The query timeout exception.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • ServiceQuotaExceededException The service quota was exceeded.
      • 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.
      See Also:

    • executeQueryPaginator

      default ExecuteQueryPublisher executeQueryPaginator(Consumer<ExecuteQueryRequest.Builder> executeQueryRequest)

      This is a variant of executeQuery(software.amazon.awssdk.services.iottwinmaker.model.ExecuteQueryRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.iottwinmaker.paginators.ExecuteQueryPublisher publisher = client.executeQueryPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.iottwinmaker.paginators.ExecuteQueryPublisher publisher = client.executeQueryPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iottwinmaker.model.ExecuteQueryResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iottwinmaker.model.ExecuteQueryResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

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


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

      Parameters:
      executeQueryRequest - A Consumer that will call methods on ExecuteQueryRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • QueryTimeoutException The query timeout exception.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • ServiceQuotaExceededException The service quota was exceeded.
      • 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.
      See Also:

    • getComponentType

      default CompletableFuture<GetComponentTypeResponse> getComponentType(GetComponentTypeRequest getComponentTypeRequest)

      Retrieves information about a component type.

      Parameters:
      getComponentTypeRequest -
      Returns:
      A Java Future containing the result of the GetComponentType operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • getComponentType

      default CompletableFuture<GetComponentTypeResponse> getComponentType(Consumer<GetComponentTypeRequest.Builder> getComponentTypeRequest)

      Retrieves information about a component type.


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

      Parameters:
      getComponentTypeRequest - A Consumer that will call methods on GetComponentTypeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetComponentType operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • getEntity

      default CompletableFuture<GetEntityResponse> getEntity(GetEntityRequest getEntityRequest)

      Retrieves information about an entity.

      Parameters:
      getEntityRequest -
      Returns:
      A Java Future containing the result of the GetEntity operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • ServiceQuotaExceededException The service quota was exceeded.
      • 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.
      See Also:

    • getEntity

      default CompletableFuture<GetEntityResponse> getEntity(Consumer<GetEntityRequest.Builder> getEntityRequest)

      Retrieves information about an entity.


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

      Parameters:
      getEntityRequest - A Consumer that will call methods on GetEntityRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetEntity operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • ServiceQuotaExceededException The service quota was exceeded.
      • 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.
      See Also:

    • getMetadataTransferJob

      default CompletableFuture<GetMetadataTransferJobResponse> getMetadataTransferJob(GetMetadataTransferJobRequest getMetadataTransferJobRequest)

      Gets a nmetadata transfer job.

      Parameters:
      getMetadataTransferJobRequest -
      Returns:
      A Java Future containing the result of the GetMetadataTransferJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • getMetadataTransferJob

      default CompletableFuture<GetMetadataTransferJobResponse> getMetadataTransferJob(Consumer<GetMetadataTransferJobRequest.Builder> getMetadataTransferJobRequest)

      Gets a nmetadata transfer job.


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

      Parameters:
      getMetadataTransferJobRequest - A Consumer that will call methods on GetMetadataTransferJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetMetadataTransferJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • getPricingPlan

      default CompletableFuture<GetPricingPlanResponse> getPricingPlan(GetPricingPlanRequest getPricingPlanRequest)

      Gets the pricing plan.

      Parameters:
      getPricingPlanRequest -
      Returns:
      A Java Future containing the result of the GetPricingPlan operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • getPricingPlan

      default CompletableFuture<GetPricingPlanResponse> getPricingPlan(Consumer<GetPricingPlanRequest.Builder> getPricingPlanRequest)

      Gets the pricing plan.


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

      Parameters:
      getPricingPlanRequest - A Consumer that will call methods on GetPricingPlanRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetPricingPlan operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • getPropertyValue

      default CompletableFuture<GetPropertyValueResponse> getPropertyValue(GetPropertyValueRequest getPropertyValueRequest)

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

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

      Parameters:
      getPropertyValueRequest -
      Returns:
      A Java Future containing the result of the GetPropertyValue operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • ConnectorFailureException The connector failed.
      • AccessDeniedException Access is denied.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • ConnectorTimeoutException The connector timed out.
      • 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.
      See Also:

    • getPropertyValue

      default CompletableFuture<GetPropertyValueResponse> getPropertyValue(Consumer<GetPropertyValueRequest.Builder> getPropertyValueRequest)

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

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


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

      Parameters:
      getPropertyValueRequest - A Consumer that will call methods on GetPropertyValueRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetPropertyValue operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • ConnectorFailureException The connector failed.
      • AccessDeniedException Access is denied.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • ConnectorTimeoutException The connector timed out.
      • 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.
      See Also:

    • getPropertyValueHistory

      default CompletableFuture<GetPropertyValueHistoryResponse> getPropertyValueHistory(GetPropertyValueHistoryRequest getPropertyValueHistoryRequest)

      Retrieves information about the history of a time series property value for a component, component type, entity, or workspace.

      You must specify a value for workspaceId. For entity-specific queries, specify values for componentName and entityId. For cross-entity quries, specify a value for componentTypeId.

      Parameters:
      getPropertyValueHistoryRequest -
      Returns:
      A Java Future containing the result of the GetPropertyValueHistory operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • ConnectorFailureException The connector failed.
      • AccessDeniedException Access is denied.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • ConnectorTimeoutException The connector timed out.
      • 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.
      See Also:

    • getPropertyValueHistory

      default CompletableFuture<GetPropertyValueHistoryResponse> getPropertyValueHistory(Consumer<GetPropertyValueHistoryRequest.Builder> getPropertyValueHistoryRequest)

      Retrieves information about the history of a time series property value for a component, component type, entity, or workspace.

      You must specify a value for workspaceId. For entity-specific queries, specify values for componentName and entityId. For cross-entity quries, specify a value for componentTypeId.


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

      Parameters:
      getPropertyValueHistoryRequest - A Consumer that will call methods on GetPropertyValueHistoryRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetPropertyValueHistory operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • ConnectorFailureException The connector failed.
      • AccessDeniedException Access is denied.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • ConnectorTimeoutException The connector timed out.
      • 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.
      See Also:

    • getPropertyValueHistoryPaginator

      default GetPropertyValueHistoryPublisher getPropertyValueHistoryPaginator(GetPropertyValueHistoryRequest getPropertyValueHistoryRequest)

      This is a variant of getPropertyValueHistory(software.amazon.awssdk.services.iottwinmaker.model.GetPropertyValueHistoryRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.iottwinmaker.paginators.GetPropertyValueHistoryPublisher publisher = client.getPropertyValueHistoryPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.iottwinmaker.paginators.GetPropertyValueHistoryPublisher publisher = client.getPropertyValueHistoryPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iottwinmaker.model.GetPropertyValueHistoryResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iottwinmaker.model.GetPropertyValueHistoryResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • ConnectorFailureException The connector failed.
      • AccessDeniedException Access is denied.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • ConnectorTimeoutException The connector timed out.
      • 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.
      See Also:

    • getPropertyValueHistoryPaginator

      default GetPropertyValueHistoryPublisher getPropertyValueHistoryPaginator(Consumer<GetPropertyValueHistoryRequest.Builder> getPropertyValueHistoryRequest)

      This is a variant of getPropertyValueHistory(software.amazon.awssdk.services.iottwinmaker.model.GetPropertyValueHistoryRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.iottwinmaker.paginators.GetPropertyValueHistoryPublisher publisher = client.getPropertyValueHistoryPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.iottwinmaker.paginators.GetPropertyValueHistoryPublisher publisher = client.getPropertyValueHistoryPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iottwinmaker.model.GetPropertyValueHistoryResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iottwinmaker.model.GetPropertyValueHistoryResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

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


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

      Parameters:
      getPropertyValueHistoryRequest - A Consumer that will call methods on GetPropertyValueHistoryRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • ConnectorFailureException The connector failed.
      • AccessDeniedException Access is denied.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • ConnectorTimeoutException The connector timed out.
      • 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.
      See Also:

    • getPropertyValuePaginator

      default GetPropertyValuePublisher getPropertyValuePaginator(GetPropertyValueRequest getPropertyValueRequest)

      This is a variant of getPropertyValue(software.amazon.awssdk.services.iottwinmaker.model.GetPropertyValueRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.iottwinmaker.paginators.GetPropertyValuePublisher publisher = client.getPropertyValuePaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.iottwinmaker.paginators.GetPropertyValuePublisher publisher = client.getPropertyValuePaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iottwinmaker.model.GetPropertyValueResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iottwinmaker.model.GetPropertyValueResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • ConnectorFailureException The connector failed.
      • AccessDeniedException Access is denied.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • ConnectorTimeoutException The connector timed out.
      • 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.
      See Also:

    • getPropertyValuePaginator

      default GetPropertyValuePublisher getPropertyValuePaginator(Consumer<GetPropertyValueRequest.Builder> getPropertyValueRequest)

      This is a variant of getPropertyValue(software.amazon.awssdk.services.iottwinmaker.model.GetPropertyValueRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.iottwinmaker.paginators.GetPropertyValuePublisher publisher = client.getPropertyValuePaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.iottwinmaker.paginators.GetPropertyValuePublisher publisher = client.getPropertyValuePaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iottwinmaker.model.GetPropertyValueResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iottwinmaker.model.GetPropertyValueResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

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


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

      Parameters:
      getPropertyValueRequest - A Consumer that will call methods on GetPropertyValueRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • ConnectorFailureException The connector failed.
      • AccessDeniedException Access is denied.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • ConnectorTimeoutException The connector timed out.
      • 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.
      See Also:

    • getScene

      default CompletableFuture<GetSceneResponse> getScene(GetSceneRequest getSceneRequest)

      Retrieves information about a scene.

      Parameters:
      getSceneRequest -
      Returns:
      A Java Future containing the result of the GetScene operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • getScene

      default CompletableFuture<GetSceneResponse> getScene(Consumer<GetSceneRequest.Builder> getSceneRequest)

      Retrieves information about a scene.


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

      Parameters:
      getSceneRequest - A Consumer that will call methods on GetSceneRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetScene operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • getSyncJob

      default CompletableFuture<GetSyncJobResponse> getSyncJob(GetSyncJobRequest getSyncJobRequest)

      Gets the SyncJob.

      Parameters:
      getSyncJobRequest -
      Returns:
      A Java Future containing the result of the GetSyncJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • ServiceQuotaExceededException The service quota was exceeded.
      • 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.
      See Also:

    • getSyncJob

      default CompletableFuture<GetSyncJobResponse> getSyncJob(Consumer<GetSyncJobRequest.Builder> getSyncJobRequest)

      Gets the SyncJob.


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

      Parameters:
      getSyncJobRequest - A Consumer that will call methods on GetSyncJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetSyncJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • ServiceQuotaExceededException The service quota was exceeded.
      • 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.
      See Also:

    • getWorkspace

      default CompletableFuture<GetWorkspaceResponse> getWorkspace(GetWorkspaceRequest getWorkspaceRequest)

      Retrieves information about a workspace.

      Parameters:
      getWorkspaceRequest -
      Returns:
      A Java Future containing the result of the GetWorkspace operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • ServiceQuotaExceededException The service quota was exceeded.
      • 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.
      See Also:

    • getWorkspace

      default CompletableFuture<GetWorkspaceResponse> getWorkspace(Consumer<GetWorkspaceRequest.Builder> getWorkspaceRequest)

      Retrieves information about a workspace.


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

      Parameters:
      getWorkspaceRequest - A Consumer that will call methods on GetWorkspaceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetWorkspace operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • ServiceQuotaExceededException The service quota was exceeded.
      • 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.
      See Also:

    • listComponentTypes

      default CompletableFuture<ListComponentTypesResponse> listComponentTypes(ListComponentTypesRequest listComponentTypesRequest)

      Lists all component types in a workspace.

      Parameters:
      listComponentTypesRequest -
      Returns:
      A Java Future containing the result of the ListComponentTypes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • listComponentTypes

      default CompletableFuture<ListComponentTypesResponse> listComponentTypes(Consumer<ListComponentTypesRequest.Builder> listComponentTypesRequest)

      Lists all component types in a workspace.


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

      Parameters:
      listComponentTypesRequest - A Consumer that will call methods on ListComponentTypesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListComponentTypes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • listComponentTypesPaginator

      default ListComponentTypesPublisher listComponentTypesPaginator(ListComponentTypesRequest listComponentTypesRequest)

      This is a variant of listComponentTypes(software.amazon.awssdk.services.iottwinmaker.model.ListComponentTypesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.iottwinmaker.paginators.ListComponentTypesPublisher publisher = client.listComponentTypesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.iottwinmaker.paginators.ListComponentTypesPublisher publisher = client.listComponentTypesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iottwinmaker.model.ListComponentTypesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iottwinmaker.model.ListComponentTypesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • listComponentTypesPaginator

      default ListComponentTypesPublisher listComponentTypesPaginator(Consumer<ListComponentTypesRequest.Builder> listComponentTypesRequest)

      This is a variant of listComponentTypes(software.amazon.awssdk.services.iottwinmaker.model.ListComponentTypesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.iottwinmaker.paginators.ListComponentTypesPublisher publisher = client.listComponentTypesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.iottwinmaker.paginators.ListComponentTypesPublisher publisher = client.listComponentTypesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iottwinmaker.model.ListComponentTypesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iottwinmaker.model.ListComponentTypesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

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


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

      Parameters:
      listComponentTypesRequest - A Consumer that will call methods on ListComponentTypesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • listComponents

      default CompletableFuture<ListComponentsResponse> listComponents(ListComponentsRequest listComponentsRequest)

      This API lists the components of an entity.

      Parameters:
      listComponentsRequest -
      Returns:
      A Java Future containing the result of the ListComponents operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • listComponents

      default CompletableFuture<ListComponentsResponse> listComponents(Consumer<ListComponentsRequest.Builder> listComponentsRequest)

      This API lists the components of an entity.


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

      Parameters:
      listComponentsRequest - A Consumer that will call methods on ListComponentsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListComponents operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • listComponentsPaginator

      default ListComponentsPublisher listComponentsPaginator(ListComponentsRequest listComponentsRequest)

      This is a variant of listComponents(software.amazon.awssdk.services.iottwinmaker.model.ListComponentsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.iottwinmaker.paginators.ListComponentsPublisher publisher = client.listComponentsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.iottwinmaker.paginators.ListComponentsPublisher publisher = client.listComponentsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iottwinmaker.model.ListComponentsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iottwinmaker.model.ListComponentsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • listComponentsPaginator

      default ListComponentsPublisher listComponentsPaginator(Consumer<ListComponentsRequest.Builder> listComponentsRequest)

      This is a variant of listComponents(software.amazon.awssdk.services.iottwinmaker.model.ListComponentsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.iottwinmaker.paginators.ListComponentsPublisher publisher = client.listComponentsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.iottwinmaker.paginators.ListComponentsPublisher publisher = client.listComponentsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iottwinmaker.model.ListComponentsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iottwinmaker.model.ListComponentsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

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


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

      Parameters:
      listComponentsRequest - A Consumer that will call methods on ListComponentsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • listEntities

      default CompletableFuture<ListEntitiesResponse> listEntities(ListEntitiesRequest listEntitiesRequest)

      Lists all entities in a workspace.

      Parameters:
      listEntitiesRequest -
      Returns:
      A Java Future containing the result of the ListEntities operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • listEntities

      default CompletableFuture<ListEntitiesResponse> listEntities(Consumer<ListEntitiesRequest.Builder> listEntitiesRequest)

      Lists all entities in a workspace.


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

      Parameters:
      listEntitiesRequest - A Consumer that will call methods on ListEntitiesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListEntities operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • listEntitiesPaginator

      default ListEntitiesPublisher listEntitiesPaginator(ListEntitiesRequest listEntitiesRequest)

      This is a variant of listEntities(software.amazon.awssdk.services.iottwinmaker.model.ListEntitiesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.iottwinmaker.paginators.ListEntitiesPublisher publisher = client.listEntitiesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.iottwinmaker.paginators.ListEntitiesPublisher publisher = client.listEntitiesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iottwinmaker.model.ListEntitiesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iottwinmaker.model.ListEntitiesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • listEntitiesPaginator

      default ListEntitiesPublisher listEntitiesPaginator(Consumer<ListEntitiesRequest.Builder> listEntitiesRequest)

      This is a variant of listEntities(software.amazon.awssdk.services.iottwinmaker.model.ListEntitiesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.iottwinmaker.paginators.ListEntitiesPublisher publisher = client.listEntitiesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.iottwinmaker.paginators.ListEntitiesPublisher publisher = client.listEntitiesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iottwinmaker.model.ListEntitiesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iottwinmaker.model.ListEntitiesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

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


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

      Parameters:
      listEntitiesRequest - A Consumer that will call methods on ListEntitiesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • listMetadataTransferJobs

      default CompletableFuture<ListMetadataTransferJobsResponse> listMetadataTransferJobs(ListMetadataTransferJobsRequest listMetadataTransferJobsRequest)

      Lists the metadata transfer jobs.

      Parameters:
      listMetadataTransferJobsRequest -
      Returns:
      A Java Future containing the result of the ListMetadataTransferJobs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • listMetadataTransferJobs

      default CompletableFuture<ListMetadataTransferJobsResponse> listMetadataTransferJobs(Consumer<ListMetadataTransferJobsRequest.Builder> listMetadataTransferJobsRequest)

      Lists the metadata transfer jobs.


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

      Parameters:
      listMetadataTransferJobsRequest - A Consumer that will call methods on ListMetadataTransferJobsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListMetadataTransferJobs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • listMetadataTransferJobsPaginator

      default ListMetadataTransferJobsPublisher listMetadataTransferJobsPaginator(ListMetadataTransferJobsRequest listMetadataTransferJobsRequest)

      This is a variant of listMetadataTransferJobs(software.amazon.awssdk.services.iottwinmaker.model.ListMetadataTransferJobsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.iottwinmaker.paginators.ListMetadataTransferJobsPublisher publisher = client.listMetadataTransferJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.iottwinmaker.paginators.ListMetadataTransferJobsPublisher publisher = client.listMetadataTransferJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iottwinmaker.model.ListMetadataTransferJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iottwinmaker.model.ListMetadataTransferJobsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • listMetadataTransferJobsPaginator

      default ListMetadataTransferJobsPublisher listMetadataTransferJobsPaginator(Consumer<ListMetadataTransferJobsRequest.Builder> listMetadataTransferJobsRequest)

      This is a variant of listMetadataTransferJobs(software.amazon.awssdk.services.iottwinmaker.model.ListMetadataTransferJobsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.iottwinmaker.paginators.ListMetadataTransferJobsPublisher publisher = client.listMetadataTransferJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.iottwinmaker.paginators.ListMetadataTransferJobsPublisher publisher = client.listMetadataTransferJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iottwinmaker.model.ListMetadataTransferJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iottwinmaker.model.ListMetadataTransferJobsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

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


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

      Parameters:
      listMetadataTransferJobsRequest - A Consumer that will call methods on ListMetadataTransferJobsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • listProperties

      default CompletableFuture<ListPropertiesResponse> listProperties(ListPropertiesRequest listPropertiesRequest)

      This API lists the properties of a component.

      Parameters:
      listPropertiesRequest -
      Returns:
      A Java Future containing the result of the ListProperties operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • listProperties

      default CompletableFuture<ListPropertiesResponse> listProperties(Consumer<ListPropertiesRequest.Builder> listPropertiesRequest)

      This API lists the properties of a component.


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

      Parameters:
      listPropertiesRequest - A Consumer that will call methods on ListPropertiesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListProperties operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • listPropertiesPaginator

      default ListPropertiesPublisher listPropertiesPaginator(ListPropertiesRequest listPropertiesRequest)

      This is a variant of listProperties(software.amazon.awssdk.services.iottwinmaker.model.ListPropertiesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.iottwinmaker.paginators.ListPropertiesPublisher publisher = client.listPropertiesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.iottwinmaker.paginators.ListPropertiesPublisher publisher = client.listPropertiesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iottwinmaker.model.ListPropertiesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iottwinmaker.model.ListPropertiesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • listPropertiesPaginator

      default ListPropertiesPublisher listPropertiesPaginator(Consumer<ListPropertiesRequest.Builder> listPropertiesRequest)

      This is a variant of listProperties(software.amazon.awssdk.services.iottwinmaker.model.ListPropertiesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.iottwinmaker.paginators.ListPropertiesPublisher publisher = client.listPropertiesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.iottwinmaker.paginators.ListPropertiesPublisher publisher = client.listPropertiesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iottwinmaker.model.ListPropertiesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iottwinmaker.model.ListPropertiesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

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


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

      Parameters:
      listPropertiesRequest - A Consumer that will call methods on ListPropertiesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • listScenes

      default CompletableFuture<ListScenesResponse> listScenes(ListScenesRequest listScenesRequest)

      Lists all scenes in a workspace.

      Parameters:
      listScenesRequest -
      Returns:
      A Java Future containing the result of the ListScenes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • listScenes

      default CompletableFuture<ListScenesResponse> listScenes(Consumer<ListScenesRequest.Builder> listScenesRequest)

      Lists all scenes in a workspace.


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

      Parameters:
      listScenesRequest - A Consumer that will call methods on ListScenesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListScenes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • listScenesPaginator

      default ListScenesPublisher listScenesPaginator(ListScenesRequest listScenesRequest)

      This is a variant of listScenes(software.amazon.awssdk.services.iottwinmaker.model.ListScenesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.iottwinmaker.paginators.ListScenesPublisher publisher = client.listScenesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.iottwinmaker.paginators.ListScenesPublisher publisher = client.listScenesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iottwinmaker.model.ListScenesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iottwinmaker.model.ListScenesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • listScenesPaginator

      default ListScenesPublisher listScenesPaginator(Consumer<ListScenesRequest.Builder> listScenesRequest)

      This is a variant of listScenes(software.amazon.awssdk.services.iottwinmaker.model.ListScenesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.iottwinmaker.paginators.ListScenesPublisher publisher = client.listScenesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.iottwinmaker.paginators.ListScenesPublisher publisher = client.listScenesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iottwinmaker.model.ListScenesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iottwinmaker.model.ListScenesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

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


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

      Parameters:
      listScenesRequest - A Consumer that will call methods on ListScenesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • listSyncJobs

      default CompletableFuture<ListSyncJobsResponse> listSyncJobs(ListSyncJobsRequest listSyncJobsRequest)

      List all SyncJobs.

      Parameters:
      listSyncJobsRequest -
      Returns:
      A Java Future containing the result of the ListSyncJobs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • listSyncJobs

      default CompletableFuture<ListSyncJobsResponse> listSyncJobs(Consumer<ListSyncJobsRequest.Builder> listSyncJobsRequest)

      List all SyncJobs.


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

      Parameters:
      listSyncJobsRequest - A Consumer that will call methods on ListSyncJobsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListSyncJobs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • listSyncJobsPaginator

      default ListSyncJobsPublisher listSyncJobsPaginator(ListSyncJobsRequest listSyncJobsRequest)

      This is a variant of listSyncJobs(software.amazon.awssdk.services.iottwinmaker.model.ListSyncJobsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.iottwinmaker.paginators.ListSyncJobsPublisher publisher = client.listSyncJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.iottwinmaker.paginators.ListSyncJobsPublisher publisher = client.listSyncJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iottwinmaker.model.ListSyncJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iottwinmaker.model.ListSyncJobsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • listSyncJobsPaginator

      default ListSyncJobsPublisher listSyncJobsPaginator(Consumer<ListSyncJobsRequest.Builder> listSyncJobsRequest)

      This is a variant of listSyncJobs(software.amazon.awssdk.services.iottwinmaker.model.ListSyncJobsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.iottwinmaker.paginators.ListSyncJobsPublisher publisher = client.listSyncJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.iottwinmaker.paginators.ListSyncJobsPublisher publisher = client.listSyncJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iottwinmaker.model.ListSyncJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iottwinmaker.model.ListSyncJobsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

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


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

      Parameters:
      listSyncJobsRequest - A Consumer that will call methods on ListSyncJobsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • listSyncResources

      default CompletableFuture<ListSyncResourcesResponse> listSyncResources(ListSyncResourcesRequest listSyncResourcesRequest)

      Lists the sync resources.

      Parameters:
      listSyncResourcesRequest -
      Returns:
      A Java Future containing the result of the ListSyncResources operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • listSyncResources

      default CompletableFuture<ListSyncResourcesResponse> listSyncResources(Consumer<ListSyncResourcesRequest.Builder> listSyncResourcesRequest)

      Lists the sync resources.


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

      Parameters:
      listSyncResourcesRequest - A Consumer that will call methods on ListSyncResourcesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListSyncResources operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • listSyncResourcesPaginator

      default ListSyncResourcesPublisher listSyncResourcesPaginator(ListSyncResourcesRequest listSyncResourcesRequest)

      This is a variant of listSyncResources(software.amazon.awssdk.services.iottwinmaker.model.ListSyncResourcesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.iottwinmaker.paginators.ListSyncResourcesPublisher publisher = client.listSyncResourcesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.iottwinmaker.paginators.ListSyncResourcesPublisher publisher = client.listSyncResourcesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iottwinmaker.model.ListSyncResourcesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iottwinmaker.model.ListSyncResourcesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • listSyncResourcesPaginator

      default ListSyncResourcesPublisher listSyncResourcesPaginator(Consumer<ListSyncResourcesRequest.Builder> listSyncResourcesRequest)

      This is a variant of listSyncResources(software.amazon.awssdk.services.iottwinmaker.model.ListSyncResourcesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.iottwinmaker.paginators.ListSyncResourcesPublisher publisher = client.listSyncResourcesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.iottwinmaker.paginators.ListSyncResourcesPublisher publisher = client.listSyncResourcesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iottwinmaker.model.ListSyncResourcesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iottwinmaker.model.ListSyncResourcesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

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


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

      Parameters:
      listSyncResourcesRequest - A Consumer that will call methods on ListSyncResourcesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

      Lists all tags associated with a resource.

      Parameters:
      listTagsForResourceRequest -
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      Lists all tags associated with a resource.


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

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listWorkspaces

      default CompletableFuture<ListWorkspacesResponse> listWorkspaces(ListWorkspacesRequest listWorkspacesRequest)

      Retrieves information about workspaces in the current account.

      Parameters:
      listWorkspacesRequest -
      Returns:
      A Java Future containing the result of the ListWorkspaces operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • listWorkspaces

      default CompletableFuture<ListWorkspacesResponse> listWorkspaces(Consumer<ListWorkspacesRequest.Builder> listWorkspacesRequest)

      Retrieves information about workspaces in the current account.


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

      Parameters:
      listWorkspacesRequest - A Consumer that will call methods on ListWorkspacesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListWorkspaces operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • listWorkspacesPaginator

      default ListWorkspacesPublisher listWorkspacesPaginator(ListWorkspacesRequest listWorkspacesRequest)

      This is a variant of listWorkspaces(software.amazon.awssdk.services.iottwinmaker.model.ListWorkspacesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.iottwinmaker.paginators.ListWorkspacesPublisher publisher = client.listWorkspacesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.iottwinmaker.paginators.ListWorkspacesPublisher publisher = client.listWorkspacesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iottwinmaker.model.ListWorkspacesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iottwinmaker.model.ListWorkspacesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • listWorkspacesPaginator

      default ListWorkspacesPublisher listWorkspacesPaginator(Consumer<ListWorkspacesRequest.Builder> listWorkspacesRequest)

      This is a variant of listWorkspaces(software.amazon.awssdk.services.iottwinmaker.model.ListWorkspacesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.iottwinmaker.paginators.ListWorkspacesPublisher publisher = client.listWorkspacesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.iottwinmaker.paginators.ListWorkspacesPublisher publisher = client.listWorkspacesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iottwinmaker.model.ListWorkspacesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iottwinmaker.model.ListWorkspacesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

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


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

      Parameters:
      listWorkspacesRequest - A Consumer that will call methods on ListWorkspacesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

      Adds tags to a resource.

      Parameters:
      tagResourceRequest -
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)

      Adds tags to a resource.


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

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

      Removes tags from a resource.

      Parameters:
      untagResourceRequest -
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

      Removes tags from a resource.


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

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • updateComponentType

      default CompletableFuture<UpdateComponentTypeResponse> updateComponentType(UpdateComponentTypeRequest updateComponentTypeRequest)

      Updates information in a component type.

      Parameters:
      updateComponentTypeRequest -
      Returns:
      A Java Future containing the result of the UpdateComponentType operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • ServiceQuotaExceededException The service quota was exceeded.
      • 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.
      See Also:

    • updateComponentType

      default CompletableFuture<UpdateComponentTypeResponse> updateComponentType(Consumer<UpdateComponentTypeRequest.Builder> updateComponentTypeRequest)

      Updates information in a component type.


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

      Parameters:
      updateComponentTypeRequest - A Consumer that will call methods on UpdateComponentTypeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateComponentType operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • ServiceQuotaExceededException The service quota was exceeded.
      • 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.
      See Also:

    • updateEntity

      default CompletableFuture<UpdateEntityResponse> updateEntity(UpdateEntityRequest updateEntityRequest)

      Updates an entity.

      Parameters:
      updateEntityRequest -
      Returns:
      A Java Future containing the result of the UpdateEntity operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • ConflictException A conflict occurred.
      • ServiceQuotaExceededException The service quota was exceeded.
      • 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.
      See Also:

    • updateEntity

      default CompletableFuture<UpdateEntityResponse> updateEntity(Consumer<UpdateEntityRequest.Builder> updateEntityRequest)

      Updates an entity.


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

      Parameters:
      updateEntityRequest - A Consumer that will call methods on UpdateEntityRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateEntity operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • ConflictException A conflict occurred.
      • ServiceQuotaExceededException The service quota was exceeded.
      • 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.
      See Also:

    • updatePricingPlan

      default CompletableFuture<UpdatePricingPlanResponse> updatePricingPlan(UpdatePricingPlanRequest updatePricingPlanRequest)

      Update the pricing plan.

      Parameters:
      updatePricingPlanRequest -
      Returns:
      A Java Future containing the result of the UpdatePricingPlan operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • updatePricingPlan

      default CompletableFuture<UpdatePricingPlanResponse> updatePricingPlan(Consumer<UpdatePricingPlanRequest.Builder> updatePricingPlanRequest)

      Update the pricing plan.


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

      Parameters:
      updatePricingPlanRequest - A Consumer that will call methods on UpdatePricingPlanRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdatePricingPlan operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • updateScene

      default CompletableFuture<UpdateSceneResponse> updateScene(UpdateSceneRequest updateSceneRequest)

      Updates a scene.

      Parameters:
      updateSceneRequest -
      Returns:
      A Java Future containing the result of the UpdateScene operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • updateScene

      default CompletableFuture<UpdateSceneResponse> updateScene(Consumer<UpdateSceneRequest.Builder> updateSceneRequest)

      Updates a scene.


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

      Parameters:
      updateSceneRequest - A Consumer that will call methods on UpdateSceneRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateScene operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • 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.
      See Also:

    • updateWorkspace

      default CompletableFuture<UpdateWorkspaceResponse> updateWorkspace(UpdateWorkspaceRequest updateWorkspaceRequest)

      Updates a workspace.

      Parameters:
      updateWorkspaceRequest -
      Returns:
      A Java Future containing the result of the UpdateWorkspace operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • ServiceQuotaExceededException The service quota was exceeded.
      • 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.
      See Also:

    • updateWorkspace

      default CompletableFuture<UpdateWorkspaceResponse> updateWorkspace(Consumer<UpdateWorkspaceRequest.Builder> updateWorkspaceRequest)

      Updates a workspace.


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

      Parameters:
      updateWorkspaceRequest - A Consumer that will call methods on UpdateWorkspaceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateWorkspace operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An unexpected error has occurred.
      • AccessDeniedException Access is denied.
      • ResourceNotFoundException The resource wasn't found.
      • ThrottlingException The rate exceeds the limit.
      • ValidationException Failed
      • ServiceQuotaExceededException The service quota was exceeded.
      • 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.
      See Also:

    • serviceClientConfiguration

      default IoTTwinMakerServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static IoTTwinMakerAsyncClient create()
      Create a IoTTwinMakerAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static IoTTwinMakerAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a IoTTwinMakerAsyncClient.