Package software.amazon.awssdk.services.iotthingsgraph

Interface IoTThingsGraphAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface IoTThingsGraphAsyncClient extends AwsClient
Service client for accessing AWS IoT Things Graph 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. AWS IoT Things Graph

AWS IoT Things Graph provides an integrated set of tools that enable developers to connect devices and services that use different standards, such as units of measure and communication protocols. AWS IoT Things Graph makes it possible to build IoT applications with little to no code by connecting devices and services and defining how they interact at an abstract level.

For more information about how AWS IoT Things Graph works, see the User Guide.

The AWS IoT Things Graph service is discontinued.

  • Field Details

  • Method Details

    • associateEntityToThing

      @Deprecated default CompletableFuture<AssociateEntityToThingResponse> associateEntityToThing(AssociateEntityToThingRequest associateEntityToThingRequest)
      Deprecated.
      since: 2022-08-30

      Associates a device with a concrete thing that is in the user's registry.

      A thing can be associated with only one device at a time. If you associate a thing with a new device id, its previous association will be removed.

      Parameters:
      associateEntityToThingRequest -
      Returns:
      A Java Future containing the result of the AssociateEntityToThing 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.
      • InvalidRequestException
      • ResourceNotFoundException
      • InternalFailureException
      • ThrottlingException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateEntityToThing

      @Deprecated default CompletableFuture<AssociateEntityToThingResponse> associateEntityToThing(Consumer<AssociateEntityToThingRequest.Builder> associateEntityToThingRequest)
      Deprecated.
      since: 2022-08-30

      Associates a device with a concrete thing that is in the user's registry.

      A thing can be associated with only one device at a time. If you associate a thing with a new device id, its previous association will be removed.


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

      Parameters:
      associateEntityToThingRequest - A Consumer that will call methods on AssociateEntityToThingRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssociateEntityToThing 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.
      • InvalidRequestException
      • ResourceNotFoundException
      • InternalFailureException
      • ThrottlingException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createFlowTemplate

      @Deprecated default CompletableFuture<CreateFlowTemplateResponse> createFlowTemplate(CreateFlowTemplateRequest createFlowTemplateRequest)
      Deprecated.
      since: 2022-08-30

      Creates a workflow template. Workflows can be created only in the user's namespace. (The public namespace contains only entities.) The workflow can contain only entities in the specified namespace. The workflow is validated against the entities in the latest version of the user's namespace unless another namespace version is specified in the request.

      Parameters:
      createFlowTemplateRequest -
      Returns:
      A Java Future containing the result of the CreateFlowTemplate 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.
      • InvalidRequestException
      • ResourceAlreadyExistsException
      • ThrottlingException
      • LimitExceededException
      • InternalFailureException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createFlowTemplate

      @Deprecated default CompletableFuture<CreateFlowTemplateResponse> createFlowTemplate(Consumer<CreateFlowTemplateRequest.Builder> createFlowTemplateRequest)
      Deprecated.
      since: 2022-08-30

      Creates a workflow template. Workflows can be created only in the user's namespace. (The public namespace contains only entities.) The workflow can contain only entities in the specified namespace. The workflow is validated against the entities in the latest version of the user's namespace unless another namespace version is specified in the request.


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

      Parameters:
      createFlowTemplateRequest - A Consumer that will call methods on CreateFlowTemplateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateFlowTemplate 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.
      • InvalidRequestException
      • ResourceAlreadyExistsException
      • ThrottlingException
      • LimitExceededException
      • InternalFailureException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createSystemInstance

      @Deprecated default CompletableFuture<CreateSystemInstanceResponse> createSystemInstance(CreateSystemInstanceRequest createSystemInstanceRequest)
      Deprecated.
      since: 2022-08-30

      Creates a system instance.

      This action validates the system instance, prepares the deployment-related resources. For Greengrass deployments, it updates the Greengrass group that is specified by the greengrassGroupName parameter. It also adds a file to the S3 bucket specified by the s3BucketName parameter. You need to call DeploySystemInstance after running this action.

      For Greengrass deployments, since this action modifies and adds resources to a Greengrass group and an S3 bucket on the caller's behalf, the calling identity must have write permissions to both the specified Greengrass group and S3 bucket. Otherwise, the call will fail with an authorization error.

      For cloud deployments, this action requires a flowActionsRoleArn value. This is an IAM role that has permissions to access AWS services, such as AWS Lambda and AWS IoT, that the flow uses when it executes.

      If the definition document doesn't specify a version of the user's namespace, the latest version will be used by default.

      Parameters:
      createSystemInstanceRequest -
      Returns:
      A Java Future containing the result of the CreateSystemInstance 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.
      • InvalidRequestException
      • ResourceAlreadyExistsException
      • ThrottlingException
      • InternalFailureException
      • LimitExceededException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createSystemInstance

      @Deprecated default CompletableFuture<CreateSystemInstanceResponse> createSystemInstance(Consumer<CreateSystemInstanceRequest.Builder> createSystemInstanceRequest)
      Deprecated.
      since: 2022-08-30

      Creates a system instance.

      This action validates the system instance, prepares the deployment-related resources. For Greengrass deployments, it updates the Greengrass group that is specified by the greengrassGroupName parameter. It also adds a file to the S3 bucket specified by the s3BucketName parameter. You need to call DeploySystemInstance after running this action.

      For Greengrass deployments, since this action modifies and adds resources to a Greengrass group and an S3 bucket on the caller's behalf, the calling identity must have write permissions to both the specified Greengrass group and S3 bucket. Otherwise, the call will fail with an authorization error.

      For cloud deployments, this action requires a flowActionsRoleArn value. This is an IAM role that has permissions to access AWS services, such as AWS Lambda and AWS IoT, that the flow uses when it executes.

      If the definition document doesn't specify a version of the user's namespace, the latest version will be used by default.


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

      Parameters:
      createSystemInstanceRequest - A Consumer that will call methods on CreateSystemInstanceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateSystemInstance 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.
      • InvalidRequestException
      • ResourceAlreadyExistsException
      • ThrottlingException
      • InternalFailureException
      • LimitExceededException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createSystemTemplate

      @Deprecated default CompletableFuture<CreateSystemTemplateResponse> createSystemTemplate(CreateSystemTemplateRequest createSystemTemplateRequest)
      Deprecated.
      since: 2022-08-30

      Creates a system. The system is validated against the entities in the latest version of the user's namespace unless another namespace version is specified in the request.

      Parameters:
      createSystemTemplateRequest -
      Returns:
      A Java Future containing the result of the CreateSystemTemplate 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.
      • InvalidRequestException
      • ResourceAlreadyExistsException
      • ThrottlingException
      • InternalFailureException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createSystemTemplate

      @Deprecated default CompletableFuture<CreateSystemTemplateResponse> createSystemTemplate(Consumer<CreateSystemTemplateRequest.Builder> createSystemTemplateRequest)
      Deprecated.
      since: 2022-08-30

      Creates a system. The system is validated against the entities in the latest version of the user's namespace unless another namespace version is specified in the request.


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

      Parameters:
      createSystemTemplateRequest - A Consumer that will call methods on CreateSystemTemplateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateSystemTemplate 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.
      • InvalidRequestException
      • ResourceAlreadyExistsException
      • ThrottlingException
      • InternalFailureException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteFlowTemplate

      @Deprecated default CompletableFuture<DeleteFlowTemplateResponse> deleteFlowTemplate(DeleteFlowTemplateRequest deleteFlowTemplateRequest)
      Deprecated.
      since: 2022-08-30

      Deletes a workflow. Any new system or deployment that contains this workflow will fail to update or deploy. Existing deployments that contain the workflow will continue to run (since they use a snapshot of the workflow taken at the time of deployment).

      Parameters:
      deleteFlowTemplateRequest -
      Returns:
      A Java Future containing the result of the DeleteFlowTemplate 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.
      • InvalidRequestException
      • ThrottlingException
      • InternalFailureException
      • ResourceInUseException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteFlowTemplate

      @Deprecated default CompletableFuture<DeleteFlowTemplateResponse> deleteFlowTemplate(Consumer<DeleteFlowTemplateRequest.Builder> deleteFlowTemplateRequest)
      Deprecated.
      since: 2022-08-30

      Deletes a workflow. Any new system or deployment that contains this workflow will fail to update or deploy. Existing deployments that contain the workflow will continue to run (since they use a snapshot of the workflow taken at the time of deployment).


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

      Parameters:
      deleteFlowTemplateRequest - A Consumer that will call methods on DeleteFlowTemplateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteFlowTemplate 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.
      • InvalidRequestException
      • ThrottlingException
      • InternalFailureException
      • ResourceInUseException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteNamespace

      @Deprecated default CompletableFuture<DeleteNamespaceResponse> deleteNamespace(DeleteNamespaceRequest deleteNamespaceRequest)
      Deprecated.
      since: 2022-08-30

      Deletes the specified namespace. This action deletes all of the entities in the namespace. Delete the systems and flows that use entities in the namespace before performing this action. This action takes no request parameters.

      Parameters:
      deleteNamespaceRequest -
      Returns:
      A Java Future containing the result of the DeleteNamespace 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.
      • InternalFailureException
      • ThrottlingException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteNamespace

      @Deprecated default CompletableFuture<DeleteNamespaceResponse> deleteNamespace(Consumer<DeleteNamespaceRequest.Builder> deleteNamespaceRequest)
      Deprecated.
      since: 2022-08-30

      Deletes the specified namespace. This action deletes all of the entities in the namespace. Delete the systems and flows that use entities in the namespace before performing this action. This action takes no request parameters.


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

      Parameters:
      deleteNamespaceRequest - A Consumer that will call methods on DeleteNamespaceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteNamespace 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.
      • InternalFailureException
      • ThrottlingException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteSystemInstance

      @Deprecated default CompletableFuture<DeleteSystemInstanceResponse> deleteSystemInstance(DeleteSystemInstanceRequest deleteSystemInstanceRequest)
      Deprecated.
      since: 2022-08-30

      Deletes a system instance. Only system instances that have never been deployed, or that have been undeployed can be deleted.

      Users can create a new system instance that has the same ID as a deleted system instance.

      Parameters:
      deleteSystemInstanceRequest -
      Returns:
      A Java Future containing the result of the DeleteSystemInstance 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.
      • InvalidRequestException
      • ThrottlingException
      • InternalFailureException
      • ResourceInUseException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteSystemInstance

      @Deprecated default CompletableFuture<DeleteSystemInstanceResponse> deleteSystemInstance(Consumer<DeleteSystemInstanceRequest.Builder> deleteSystemInstanceRequest)
      Deprecated.
      since: 2022-08-30

      Deletes a system instance. Only system instances that have never been deployed, or that have been undeployed can be deleted.

      Users can create a new system instance that has the same ID as a deleted system instance.


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

      Parameters:
      deleteSystemInstanceRequest - A Consumer that will call methods on DeleteSystemInstanceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteSystemInstance 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.
      • InvalidRequestException
      • ThrottlingException
      • InternalFailureException
      • ResourceInUseException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteSystemTemplate

      @Deprecated default CompletableFuture<DeleteSystemTemplateResponse> deleteSystemTemplate(DeleteSystemTemplateRequest deleteSystemTemplateRequest)
      Deprecated.
      since: 2022-08-30

      Deletes a system. New deployments can't contain the system after its deletion. Existing deployments that contain the system will continue to work because they use a snapshot of the system that is taken when it is deployed.

      Parameters:
      deleteSystemTemplateRequest -
      Returns:
      A Java Future containing the result of the DeleteSystemTemplate 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.
      • InvalidRequestException
      • ThrottlingException
      • InternalFailureException
      • ResourceInUseException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteSystemTemplate

      @Deprecated default CompletableFuture<DeleteSystemTemplateResponse> deleteSystemTemplate(Consumer<DeleteSystemTemplateRequest.Builder> deleteSystemTemplateRequest)
      Deprecated.
      since: 2022-08-30

      Deletes a system. New deployments can't contain the system after its deletion. Existing deployments that contain the system will continue to work because they use a snapshot of the system that is taken when it is deployed.


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

      Parameters:
      deleteSystemTemplateRequest - A Consumer that will call methods on DeleteSystemTemplateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteSystemTemplate 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.
      • InvalidRequestException
      • ThrottlingException
      • InternalFailureException
      • ResourceInUseException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deploySystemInstance

      @Deprecated default CompletableFuture<DeploySystemInstanceResponse> deploySystemInstance(DeploySystemInstanceRequest deploySystemInstanceRequest)
      Deprecated.
      since: 2022-08-30

      Greengrass and Cloud Deployments

      Deploys the system instance to the target specified in CreateSystemInstance.

      Greengrass Deployments

      If the system or any workflows and entities have been updated before this action is called, then the deployment will create a new Amazon Simple Storage Service resource file and then deploy it.

      Since this action creates a Greengrass deployment on the caller's behalf, the calling identity must have write permissions to the specified Greengrass group. Otherwise, the call will fail with an authorization error.

      For information about the artifacts that get added to your Greengrass core device when you use this API, see AWS IoT Things Graph and AWS IoT Greengrass.

      Parameters:
      deploySystemInstanceRequest -
      Returns:
      A Java Future containing the result of the DeploySystemInstance 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.
      • ResourceNotFoundException
      • InvalidRequestException
      • ThrottlingException
      • InternalFailureException
      • ResourceInUseException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deploySystemInstance

      @Deprecated default CompletableFuture<DeploySystemInstanceResponse> deploySystemInstance(Consumer<DeploySystemInstanceRequest.Builder> deploySystemInstanceRequest)
      Deprecated.
      since: 2022-08-30

      Greengrass and Cloud Deployments

      Deploys the system instance to the target specified in CreateSystemInstance.

      Greengrass Deployments

      If the system or any workflows and entities have been updated before this action is called, then the deployment will create a new Amazon Simple Storage Service resource file and then deploy it.

      Since this action creates a Greengrass deployment on the caller's behalf, the calling identity must have write permissions to the specified Greengrass group. Otherwise, the call will fail with an authorization error.

      For information about the artifacts that get added to your Greengrass core device when you use this API, see AWS IoT Things Graph and AWS IoT Greengrass.


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

      Parameters:
      deploySystemInstanceRequest - A Consumer that will call methods on DeploySystemInstanceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeploySystemInstance 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.
      • ResourceNotFoundException
      • InvalidRequestException
      • ThrottlingException
      • InternalFailureException
      • ResourceInUseException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deprecateFlowTemplate

      @Deprecated default CompletableFuture<DeprecateFlowTemplateResponse> deprecateFlowTemplate(DeprecateFlowTemplateRequest deprecateFlowTemplateRequest)
      Deprecated.
      since: 2022-08-30

      Deprecates the specified workflow. This action marks the workflow for deletion. Deprecated flows can't be deployed, but existing deployments will continue to run.

      Parameters:
      deprecateFlowTemplateRequest -
      Returns:
      A Java Future containing the result of the DeprecateFlowTemplate 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.
      • InvalidRequestException
      • ThrottlingException
      • InternalFailureException
      • ResourceNotFoundException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deprecateFlowTemplate

      @Deprecated default CompletableFuture<DeprecateFlowTemplateResponse> deprecateFlowTemplate(Consumer<DeprecateFlowTemplateRequest.Builder> deprecateFlowTemplateRequest)
      Deprecated.
      since: 2022-08-30

      Deprecates the specified workflow. This action marks the workflow for deletion. Deprecated flows can't be deployed, but existing deployments will continue to run.


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

      Parameters:
      deprecateFlowTemplateRequest - A Consumer that will call methods on DeprecateFlowTemplateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeprecateFlowTemplate 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.
      • InvalidRequestException
      • ThrottlingException
      • InternalFailureException
      • ResourceNotFoundException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deprecateSystemTemplate

      @Deprecated default CompletableFuture<DeprecateSystemTemplateResponse> deprecateSystemTemplate(DeprecateSystemTemplateRequest deprecateSystemTemplateRequest)
      Deprecated.
      since: 2022-08-30

      Deprecates the specified system.

      Parameters:
      deprecateSystemTemplateRequest -
      Returns:
      A Java Future containing the result of the DeprecateSystemTemplate 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.
      • InvalidRequestException
      • ThrottlingException
      • InternalFailureException
      • ResourceNotFoundException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deprecateSystemTemplate

      @Deprecated default CompletableFuture<DeprecateSystemTemplateResponse> deprecateSystemTemplate(Consumer<DeprecateSystemTemplateRequest.Builder> deprecateSystemTemplateRequest)
      Deprecated.
      since: 2022-08-30

      Deprecates the specified system.


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

      Parameters:
      deprecateSystemTemplateRequest - A Consumer that will call methods on DeprecateSystemTemplateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeprecateSystemTemplate 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.
      • InvalidRequestException
      • ThrottlingException
      • InternalFailureException
      • ResourceNotFoundException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeNamespace

      @Deprecated default CompletableFuture<DescribeNamespaceResponse> describeNamespace(DescribeNamespaceRequest describeNamespaceRequest)
      Deprecated.
      since: 2022-08-30

      Gets the latest version of the user's namespace and the public version that it is tracking.

      Parameters:
      describeNamespaceRequest -
      Returns:
      A Java Future containing the result of the DescribeNamespace 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.
      • ResourceNotFoundException
      • InvalidRequestException
      • InternalFailureException
      • ThrottlingException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeNamespace

      @Deprecated default CompletableFuture<DescribeNamespaceResponse> describeNamespace(Consumer<DescribeNamespaceRequest.Builder> describeNamespaceRequest)
      Deprecated.
      since: 2022-08-30

      Gets the latest version of the user's namespace and the public version that it is tracking.


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

      Parameters:
      describeNamespaceRequest - A Consumer that will call methods on DescribeNamespaceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeNamespace 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.
      • ResourceNotFoundException
      • InvalidRequestException
      • InternalFailureException
      • ThrottlingException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • dissociateEntityFromThing

      @Deprecated default CompletableFuture<DissociateEntityFromThingResponse> dissociateEntityFromThing(DissociateEntityFromThingRequest dissociateEntityFromThingRequest)
      Deprecated.
      since: 2022-08-30

      Dissociates a device entity from a concrete thing. The action takes only the type of the entity that you need to dissociate because only one entity of a particular type can be associated with a thing.

      Parameters:
      dissociateEntityFromThingRequest -
      Returns:
      A Java Future containing the result of the DissociateEntityFromThing 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.
      • InvalidRequestException
      • ResourceNotFoundException
      • InternalFailureException
      • ThrottlingException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • dissociateEntityFromThing

      @Deprecated default CompletableFuture<DissociateEntityFromThingResponse> dissociateEntityFromThing(Consumer<DissociateEntityFromThingRequest.Builder> dissociateEntityFromThingRequest)
      Deprecated.
      since: 2022-08-30

      Dissociates a device entity from a concrete thing. The action takes only the type of the entity that you need to dissociate because only one entity of a particular type can be associated with a thing.


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

      Parameters:
      dissociateEntityFromThingRequest - A Consumer that will call methods on DissociateEntityFromThingRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DissociateEntityFromThing 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.
      • InvalidRequestException
      • ResourceNotFoundException
      • InternalFailureException
      • ThrottlingException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getEntities

      @Deprecated default CompletableFuture<GetEntitiesResponse> getEntities(GetEntitiesRequest getEntitiesRequest)
      Deprecated.
      since: 2022-08-30

      Gets definitions of the specified entities. Uses the latest version of the user's namespace by default. This API returns the following TDM entities.

      • Properties

      • States

      • Events

      • Actions

      • Capabilities

      • Mappings

      • Devices

      • Device Models

      • Services

      This action doesn't return definitions for systems, flows, and deployments.

      Parameters:
      getEntitiesRequest -
      Returns:
      A Java Future containing the result of the GetEntities 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.
      • InvalidRequestException
      • ResourceNotFoundException
      • ThrottlingException
      • InternalFailureException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getEntities

      @Deprecated default CompletableFuture<GetEntitiesResponse> getEntities(Consumer<GetEntitiesRequest.Builder> getEntitiesRequest)
      Deprecated.
      since: 2022-08-30

      Gets definitions of the specified entities. Uses the latest version of the user's namespace by default. This API returns the following TDM entities.

      • Properties

      • States

      • Events

      • Actions

      • Capabilities

      • Mappings

      • Devices

      • Device Models

      • Services

      This action doesn't return definitions for systems, flows, and deployments.


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

      Parameters:
      getEntitiesRequest - A Consumer that will call methods on GetEntitiesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetEntities 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.
      • InvalidRequestException
      • ResourceNotFoundException
      • ThrottlingException
      • InternalFailureException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getFlowTemplate

      @Deprecated default CompletableFuture<GetFlowTemplateResponse> getFlowTemplate(GetFlowTemplateRequest getFlowTemplateRequest)
      Deprecated.
      since: 2022-08-30

      Gets the latest version of the DefinitionDocument and FlowTemplateSummary for the specified workflow.

      Parameters:
      getFlowTemplateRequest -
      Returns:
      A Java Future containing the result of the GetFlowTemplate 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.
      • InvalidRequestException
      • ThrottlingException
      • InternalFailureException
      • ResourceNotFoundException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getFlowTemplate

      @Deprecated default CompletableFuture<GetFlowTemplateResponse> getFlowTemplate(Consumer<GetFlowTemplateRequest.Builder> getFlowTemplateRequest)
      Deprecated.
      since: 2022-08-30

      Gets the latest version of the DefinitionDocument and FlowTemplateSummary for the specified workflow.


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

      Parameters:
      getFlowTemplateRequest - A Consumer that will call methods on GetFlowTemplateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetFlowTemplate 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.
      • InvalidRequestException
      • ThrottlingException
      • InternalFailureException
      • ResourceNotFoundException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getFlowTemplateRevisions

      @Deprecated default CompletableFuture<GetFlowTemplateRevisionsResponse> getFlowTemplateRevisions(GetFlowTemplateRevisionsRequest getFlowTemplateRevisionsRequest)
      Deprecated.
      since: 2022-08-30

      Gets revisions of the specified workflow. Only the last 100 revisions are stored. If the workflow has been deprecated, this action will return revisions that occurred before the deprecation. This action won't work for workflows that have been deleted.

      Parameters:
      getFlowTemplateRevisionsRequest -
      Returns:
      A Java Future containing the result of the GetFlowTemplateRevisions 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.
      • InvalidRequestException
      • ThrottlingException
      • InternalFailureException
      • ResourceNotFoundException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getFlowTemplateRevisions

      @Deprecated default CompletableFuture<GetFlowTemplateRevisionsResponse> getFlowTemplateRevisions(Consumer<GetFlowTemplateRevisionsRequest.Builder> getFlowTemplateRevisionsRequest)
      Deprecated.
      since: 2022-08-30

      Gets revisions of the specified workflow. Only the last 100 revisions are stored. If the workflow has been deprecated, this action will return revisions that occurred before the deprecation. This action won't work for workflows that have been deleted.


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

      Parameters:
      getFlowTemplateRevisionsRequest - A Consumer that will call methods on GetFlowTemplateRevisionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetFlowTemplateRevisions 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.
      • InvalidRequestException
      • ThrottlingException
      • InternalFailureException
      • ResourceNotFoundException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getFlowTemplateRevisionsPaginator

      @Deprecated default GetFlowTemplateRevisionsPublisher getFlowTemplateRevisionsPaginator(GetFlowTemplateRevisionsRequest getFlowTemplateRevisionsRequest)
      Deprecated.
      since: 2022-08-30

      This is a variant of getFlowTemplateRevisions(software.amazon.awssdk.services.iotthingsgraph.model.GetFlowTemplateRevisionsRequest) 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.iotthingsgraph.paginators.GetFlowTemplateRevisionsPublisher publisher = client.getFlowTemplateRevisionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.iotthingsgraph.paginators.GetFlowTemplateRevisionsPublisher publisher = client.getFlowTemplateRevisionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotthingsgraph.model.GetFlowTemplateRevisionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotthingsgraph.model.GetFlowTemplateRevisionsResponse 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 getFlowTemplateRevisions(software.amazon.awssdk.services.iotthingsgraph.model.GetFlowTemplateRevisionsRequest) operation.

      Parameters:
      getFlowTemplateRevisionsRequest -
      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.
      • InvalidRequestException
      • ThrottlingException
      • InternalFailureException
      • ResourceNotFoundException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getFlowTemplateRevisionsPaginator

      @Deprecated default GetFlowTemplateRevisionsPublisher getFlowTemplateRevisionsPaginator(Consumer<GetFlowTemplateRevisionsRequest.Builder> getFlowTemplateRevisionsRequest)
      Deprecated.
      since: 2022-08-30

      This is a variant of getFlowTemplateRevisions(software.amazon.awssdk.services.iotthingsgraph.model.GetFlowTemplateRevisionsRequest) 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.iotthingsgraph.paginators.GetFlowTemplateRevisionsPublisher publisher = client.getFlowTemplateRevisionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.iotthingsgraph.paginators.GetFlowTemplateRevisionsPublisher publisher = client.getFlowTemplateRevisionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotthingsgraph.model.GetFlowTemplateRevisionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotthingsgraph.model.GetFlowTemplateRevisionsResponse 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 getFlowTemplateRevisions(software.amazon.awssdk.services.iotthingsgraph.model.GetFlowTemplateRevisionsRequest) operation.


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

      Parameters:
      getFlowTemplateRevisionsRequest - A Consumer that will call methods on GetFlowTemplateRevisionsRequest.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.
      • InvalidRequestException
      • ThrottlingException
      • InternalFailureException
      • ResourceNotFoundException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getNamespaceDeletionStatus

      @Deprecated default CompletableFuture<GetNamespaceDeletionStatusResponse> getNamespaceDeletionStatus(GetNamespaceDeletionStatusRequest getNamespaceDeletionStatusRequest)
      Deprecated.
      since: 2022-08-30

      Gets the status of a namespace deletion task.

      Parameters:
      getNamespaceDeletionStatusRequest -
      Returns:
      A Java Future containing the result of the GetNamespaceDeletionStatus 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.
      • InvalidRequestException
      • InternalFailureException
      • ThrottlingException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getNamespaceDeletionStatus

      @Deprecated default CompletableFuture<GetNamespaceDeletionStatusResponse> getNamespaceDeletionStatus(Consumer<GetNamespaceDeletionStatusRequest.Builder> getNamespaceDeletionStatusRequest)
      Deprecated.
      since: 2022-08-30

      Gets the status of a namespace deletion task.


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

      Parameters:
      getNamespaceDeletionStatusRequest - A Consumer that will call methods on GetNamespaceDeletionStatusRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetNamespaceDeletionStatus 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.
      • InvalidRequestException
      • InternalFailureException
      • ThrottlingException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSystemInstance

      @Deprecated default CompletableFuture<GetSystemInstanceResponse> getSystemInstance(GetSystemInstanceRequest getSystemInstanceRequest)
      Deprecated.
      since: 2022-08-30

      Gets a system instance.

      Parameters:
      getSystemInstanceRequest -
      Returns:
      A Java Future containing the result of the GetSystemInstance 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.
      • InvalidRequestException
      • ThrottlingException
      • InternalFailureException
      • ResourceNotFoundException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSystemInstance

      @Deprecated default CompletableFuture<GetSystemInstanceResponse> getSystemInstance(Consumer<GetSystemInstanceRequest.Builder> getSystemInstanceRequest)
      Deprecated.
      since: 2022-08-30

      Gets a system instance.


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

      Parameters:
      getSystemInstanceRequest - A Consumer that will call methods on GetSystemInstanceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetSystemInstance 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.
      • InvalidRequestException
      • ThrottlingException
      • InternalFailureException
      • ResourceNotFoundException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSystemTemplate

      @Deprecated default CompletableFuture<GetSystemTemplateResponse> getSystemTemplate(GetSystemTemplateRequest getSystemTemplateRequest)
      Deprecated.
      since: 2022-08-30

      Gets a system.

      Parameters:
      getSystemTemplateRequest -
      Returns:
      A Java Future containing the result of the GetSystemTemplate 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.
      • InvalidRequestException
      • ThrottlingException
      • InternalFailureException
      • ResourceNotFoundException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSystemTemplate

      @Deprecated default CompletableFuture<GetSystemTemplateResponse> getSystemTemplate(Consumer<GetSystemTemplateRequest.Builder> getSystemTemplateRequest)
      Deprecated.
      since: 2022-08-30

      Gets a system.


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

      Parameters:
      getSystemTemplateRequest - A Consumer that will call methods on GetSystemTemplateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetSystemTemplate 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.
      • InvalidRequestException
      • ThrottlingException
      • InternalFailureException
      • ResourceNotFoundException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSystemTemplateRevisions

      @Deprecated default CompletableFuture<GetSystemTemplateRevisionsResponse> getSystemTemplateRevisions(GetSystemTemplateRevisionsRequest getSystemTemplateRevisionsRequest)
      Deprecated.
      since: 2022-08-30

      Gets revisions made to the specified system template. Only the previous 100 revisions are stored. If the system has been deprecated, this action will return the revisions that occurred before its deprecation. This action won't work with systems that have been deleted.

      Parameters:
      getSystemTemplateRevisionsRequest -
      Returns:
      A Java Future containing the result of the GetSystemTemplateRevisions 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.
      • InvalidRequestException
      • ThrottlingException
      • InternalFailureException
      • ResourceNotFoundException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSystemTemplateRevisions

      @Deprecated default CompletableFuture<GetSystemTemplateRevisionsResponse> getSystemTemplateRevisions(Consumer<GetSystemTemplateRevisionsRequest.Builder> getSystemTemplateRevisionsRequest)
      Deprecated.
      since: 2022-08-30

      Gets revisions made to the specified system template. Only the previous 100 revisions are stored. If the system has been deprecated, this action will return the revisions that occurred before its deprecation. This action won't work with systems that have been deleted.


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

      Parameters:
      getSystemTemplateRevisionsRequest - A Consumer that will call methods on GetSystemTemplateRevisionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetSystemTemplateRevisions 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.
      • InvalidRequestException
      • ThrottlingException
      • InternalFailureException
      • ResourceNotFoundException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSystemTemplateRevisionsPaginator

      @Deprecated default GetSystemTemplateRevisionsPublisher getSystemTemplateRevisionsPaginator(GetSystemTemplateRevisionsRequest getSystemTemplateRevisionsRequest)
      Deprecated.
      since: 2022-08-30

      This is a variant of getSystemTemplateRevisions(software.amazon.awssdk.services.iotthingsgraph.model.GetSystemTemplateRevisionsRequest) 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.iotthingsgraph.paginators.GetSystemTemplateRevisionsPublisher publisher = client.getSystemTemplateRevisionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.iotthingsgraph.paginators.GetSystemTemplateRevisionsPublisher publisher = client.getSystemTemplateRevisionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotthingsgraph.model.GetSystemTemplateRevisionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotthingsgraph.model.GetSystemTemplateRevisionsResponse 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 getSystemTemplateRevisions(software.amazon.awssdk.services.iotthingsgraph.model.GetSystemTemplateRevisionsRequest) operation.

      Parameters:
      getSystemTemplateRevisionsRequest -
      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.
      • InvalidRequestException
      • ThrottlingException
      • InternalFailureException
      • ResourceNotFoundException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSystemTemplateRevisionsPaginator

      @Deprecated default GetSystemTemplateRevisionsPublisher getSystemTemplateRevisionsPaginator(Consumer<GetSystemTemplateRevisionsRequest.Builder> getSystemTemplateRevisionsRequest)
      Deprecated.
      since: 2022-08-30

      This is a variant of getSystemTemplateRevisions(software.amazon.awssdk.services.iotthingsgraph.model.GetSystemTemplateRevisionsRequest) 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.iotthingsgraph.paginators.GetSystemTemplateRevisionsPublisher publisher = client.getSystemTemplateRevisionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.iotthingsgraph.paginators.GetSystemTemplateRevisionsPublisher publisher = client.getSystemTemplateRevisionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotthingsgraph.model.GetSystemTemplateRevisionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotthingsgraph.model.GetSystemTemplateRevisionsResponse 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 getSystemTemplateRevisions(software.amazon.awssdk.services.iotthingsgraph.model.GetSystemTemplateRevisionsRequest) operation.


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

      Parameters:
      getSystemTemplateRevisionsRequest - A Consumer that will call methods on GetSystemTemplateRevisionsRequest.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.
      • InvalidRequestException
      • ThrottlingException
      • InternalFailureException
      • ResourceNotFoundException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getUploadStatus

      @Deprecated default CompletableFuture<GetUploadStatusResponse> getUploadStatus(GetUploadStatusRequest getUploadStatusRequest)
      Deprecated.
      since: 2022-08-30

      Gets the status of the specified upload.

      Parameters:
      getUploadStatusRequest -
      Returns:
      A Java Future containing the result of the GetUploadStatus 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.
      • InvalidRequestException
      • ResourceNotFoundException
      • InternalFailureException
      • ThrottlingException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getUploadStatus

      @Deprecated default CompletableFuture<GetUploadStatusResponse> getUploadStatus(Consumer<GetUploadStatusRequest.Builder> getUploadStatusRequest)
      Deprecated.
      since: 2022-08-30

      Gets the status of the specified upload.


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

      Parameters:
      getUploadStatusRequest - A Consumer that will call methods on GetUploadStatusRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetUploadStatus 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.
      • InvalidRequestException
      • ResourceNotFoundException
      • InternalFailureException
      • ThrottlingException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFlowExecutionMessages

      @Deprecated default CompletableFuture<ListFlowExecutionMessagesResponse> listFlowExecutionMessages(ListFlowExecutionMessagesRequest listFlowExecutionMessagesRequest)
      Deprecated.
      since: 2022-08-30

      Returns a list of objects that contain information about events in a flow execution.

      Parameters:
      listFlowExecutionMessagesRequest -
      Returns:
      A Java Future containing the result of the ListFlowExecutionMessages 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.
      • InvalidRequestException
      • ThrottlingException
      • InternalFailureException
      • ResourceNotFoundException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFlowExecutionMessages

      @Deprecated default CompletableFuture<ListFlowExecutionMessagesResponse> listFlowExecutionMessages(Consumer<ListFlowExecutionMessagesRequest.Builder> listFlowExecutionMessagesRequest)
      Deprecated.
      since: 2022-08-30

      Returns a list of objects that contain information about events in a flow execution.


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

      Parameters:
      listFlowExecutionMessagesRequest - A Consumer that will call methods on ListFlowExecutionMessagesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListFlowExecutionMessages 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.
      • InvalidRequestException
      • ThrottlingException
      • InternalFailureException
      • ResourceNotFoundException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFlowExecutionMessagesPaginator

      @Deprecated default ListFlowExecutionMessagesPublisher listFlowExecutionMessagesPaginator(ListFlowExecutionMessagesRequest listFlowExecutionMessagesRequest)
      Deprecated.
      since: 2022-08-30

      This is a variant of listFlowExecutionMessages(software.amazon.awssdk.services.iotthingsgraph.model.ListFlowExecutionMessagesRequest) 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.iotthingsgraph.paginators.ListFlowExecutionMessagesPublisher publisher = client.listFlowExecutionMessagesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.iotthingsgraph.paginators.ListFlowExecutionMessagesPublisher publisher = client.listFlowExecutionMessagesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotthingsgraph.model.ListFlowExecutionMessagesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotthingsgraph.model.ListFlowExecutionMessagesResponse 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 listFlowExecutionMessages(software.amazon.awssdk.services.iotthingsgraph.model.ListFlowExecutionMessagesRequest) operation.

      Parameters:
      listFlowExecutionMessagesRequest -
      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.
      • InvalidRequestException
      • ThrottlingException
      • InternalFailureException
      • ResourceNotFoundException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFlowExecutionMessagesPaginator

      @Deprecated default ListFlowExecutionMessagesPublisher listFlowExecutionMessagesPaginator(Consumer<ListFlowExecutionMessagesRequest.Builder> listFlowExecutionMessagesRequest)
      Deprecated.
      since: 2022-08-30

      This is a variant of listFlowExecutionMessages(software.amazon.awssdk.services.iotthingsgraph.model.ListFlowExecutionMessagesRequest) 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.iotthingsgraph.paginators.ListFlowExecutionMessagesPublisher publisher = client.listFlowExecutionMessagesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.iotthingsgraph.paginators.ListFlowExecutionMessagesPublisher publisher = client.listFlowExecutionMessagesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotthingsgraph.model.ListFlowExecutionMessagesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotthingsgraph.model.ListFlowExecutionMessagesResponse 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 listFlowExecutionMessages(software.amazon.awssdk.services.iotthingsgraph.model.ListFlowExecutionMessagesRequest) operation.


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

      Parameters:
      listFlowExecutionMessagesRequest - A Consumer that will call methods on ListFlowExecutionMessagesRequest.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.
      • InvalidRequestException
      • ThrottlingException
      • InternalFailureException
      • ResourceNotFoundException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      @Deprecated default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
      Deprecated.
      since: 2022-08-30

      Lists all tags on an AWS IoT Things Graph 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.
      • InvalidRequestException
      • ResourceAlreadyExistsException
      • ThrottlingException
      • InternalFailureException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      @Deprecated default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
      Deprecated.
      since: 2022-08-30

      Lists all tags on an AWS IoT Things Graph 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.
      • InvalidRequestException
      • ResourceAlreadyExistsException
      • ThrottlingException
      • InternalFailureException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResourcePaginator

      @Deprecated default ListTagsForResourcePublisher listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest)
      Deprecated.
      since: 2022-08-30

      This is a variant of listTagsForResource(software.amazon.awssdk.services.iotthingsgraph.model.ListTagsForResourceRequest) 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.iotthingsgraph.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.iotthingsgraph.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotthingsgraph.model.ListTagsForResourceResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotthingsgraph.model.ListTagsForResourceResponse 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 listTagsForResource(software.amazon.awssdk.services.iotthingsgraph.model.ListTagsForResourceRequest) operation.

      Parameters:
      listTagsForResourceRequest -
      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.
      • InvalidRequestException
      • ResourceAlreadyExistsException
      • ThrottlingException
      • InternalFailureException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResourcePaginator

      @Deprecated default ListTagsForResourcePublisher listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
      Deprecated.
      since: 2022-08-30

      This is a variant of listTagsForResource(software.amazon.awssdk.services.iotthingsgraph.model.ListTagsForResourceRequest) 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.iotthingsgraph.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.iotthingsgraph.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotthingsgraph.model.ListTagsForResourceResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotthingsgraph.model.ListTagsForResourceResponse 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 listTagsForResource(software.amazon.awssdk.services.iotthingsgraph.model.ListTagsForResourceRequest) operation.


      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 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.
      • InvalidRequestException
      • ResourceAlreadyExistsException
      • ThrottlingException
      • InternalFailureException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchEntities

      @Deprecated default CompletableFuture<SearchEntitiesResponse> searchEntities(SearchEntitiesRequest searchEntitiesRequest)
      Deprecated.
      since: 2022-08-30

      Searches for entities of the specified type. You can search for entities in your namespace and the public namespace that you're tracking.

      Parameters:
      searchEntitiesRequest -
      Returns:
      A Java Future containing the result of the SearchEntities 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.
      • InvalidRequestException
      • InternalFailureException
      • ThrottlingException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchEntities

      @Deprecated default CompletableFuture<SearchEntitiesResponse> searchEntities(Consumer<SearchEntitiesRequest.Builder> searchEntitiesRequest)
      Deprecated.
      since: 2022-08-30

      Searches for entities of the specified type. You can search for entities in your namespace and the public namespace that you're tracking.


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

      Parameters:
      searchEntitiesRequest - A Consumer that will call methods on SearchEntitiesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SearchEntities 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.
      • InvalidRequestException
      • InternalFailureException
      • ThrottlingException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchEntitiesPaginator

      @Deprecated default SearchEntitiesPublisher searchEntitiesPaginator(SearchEntitiesRequest searchEntitiesRequest)
      Deprecated.
      since: 2022-08-30

      This is a variant of searchEntities(software.amazon.awssdk.services.iotthingsgraph.model.SearchEntitiesRequest) 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.iotthingsgraph.paginators.SearchEntitiesPublisher publisher = client.searchEntitiesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.iotthingsgraph.paginators.SearchEntitiesPublisher publisher = client.searchEntitiesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotthingsgraph.model.SearchEntitiesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotthingsgraph.model.SearchEntitiesResponse 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 searchEntities(software.amazon.awssdk.services.iotthingsgraph.model.SearchEntitiesRequest) operation.

      Parameters:
      searchEntitiesRequest -
      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.
      • InvalidRequestException
      • InternalFailureException
      • ThrottlingException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchEntitiesPaginator

      @Deprecated default SearchEntitiesPublisher searchEntitiesPaginator(Consumer<SearchEntitiesRequest.Builder> searchEntitiesRequest)
      Deprecated.
      since: 2022-08-30

      This is a variant of searchEntities(software.amazon.awssdk.services.iotthingsgraph.model.SearchEntitiesRequest) 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.iotthingsgraph.paginators.SearchEntitiesPublisher publisher = client.searchEntitiesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.iotthingsgraph.paginators.SearchEntitiesPublisher publisher = client.searchEntitiesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotthingsgraph.model.SearchEntitiesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotthingsgraph.model.SearchEntitiesResponse 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 searchEntities(software.amazon.awssdk.services.iotthingsgraph.model.SearchEntitiesRequest) operation.


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

      Parameters:
      searchEntitiesRequest - A Consumer that will call methods on SearchEntitiesRequest.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.
      • InvalidRequestException
      • InternalFailureException
      • ThrottlingException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchFlowExecutions

      @Deprecated default CompletableFuture<SearchFlowExecutionsResponse> searchFlowExecutions(SearchFlowExecutionsRequest searchFlowExecutionsRequest)
      Deprecated.
      since: 2022-08-30

      Searches for AWS IoT Things Graph workflow execution instances.

      Parameters:
      searchFlowExecutionsRequest -
      Returns:
      A Java Future containing the result of the SearchFlowExecutions 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.
      • InvalidRequestException
      • ThrottlingException
      • InternalFailureException
      • ResourceNotFoundException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchFlowExecutions

      @Deprecated default CompletableFuture<SearchFlowExecutionsResponse> searchFlowExecutions(Consumer<SearchFlowExecutionsRequest.Builder> searchFlowExecutionsRequest)
      Deprecated.
      since: 2022-08-30

      Searches for AWS IoT Things Graph workflow execution instances.


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

      Parameters:
      searchFlowExecutionsRequest - A Consumer that will call methods on SearchFlowExecutionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SearchFlowExecutions 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.
      • InvalidRequestException
      • ThrottlingException
      • InternalFailureException
      • ResourceNotFoundException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchFlowExecutionsPaginator

      @Deprecated default SearchFlowExecutionsPublisher searchFlowExecutionsPaginator(SearchFlowExecutionsRequest searchFlowExecutionsRequest)
      Deprecated.
      since: 2022-08-30

      This is a variant of searchFlowExecutions(software.amazon.awssdk.services.iotthingsgraph.model.SearchFlowExecutionsRequest) 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.iotthingsgraph.paginators.SearchFlowExecutionsPublisher publisher = client.searchFlowExecutionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.iotthingsgraph.paginators.SearchFlowExecutionsPublisher publisher = client.searchFlowExecutionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotthingsgraph.model.SearchFlowExecutionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotthingsgraph.model.SearchFlowExecutionsResponse 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 searchFlowExecutions(software.amazon.awssdk.services.iotthingsgraph.model.SearchFlowExecutionsRequest) operation.

      Parameters:
      searchFlowExecutionsRequest -
      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.
      • InvalidRequestException
      • ThrottlingException
      • InternalFailureException
      • ResourceNotFoundException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchFlowExecutionsPaginator

      @Deprecated default SearchFlowExecutionsPublisher searchFlowExecutionsPaginator(Consumer<SearchFlowExecutionsRequest.Builder> searchFlowExecutionsRequest)
      Deprecated.
      since: 2022-08-30

      This is a variant of searchFlowExecutions(software.amazon.awssdk.services.iotthingsgraph.model.SearchFlowExecutionsRequest) 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.iotthingsgraph.paginators.SearchFlowExecutionsPublisher publisher = client.searchFlowExecutionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.iotthingsgraph.paginators.SearchFlowExecutionsPublisher publisher = client.searchFlowExecutionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotthingsgraph.model.SearchFlowExecutionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotthingsgraph.model.SearchFlowExecutionsResponse 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 searchFlowExecutions(software.amazon.awssdk.services.iotthingsgraph.model.SearchFlowExecutionsRequest) operation.


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

      Parameters:
      searchFlowExecutionsRequest - A Consumer that will call methods on SearchFlowExecutionsRequest.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.
      • InvalidRequestException
      • ThrottlingException
      • InternalFailureException
      • ResourceNotFoundException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchFlowTemplates

      @Deprecated default CompletableFuture<SearchFlowTemplatesResponse> searchFlowTemplates(SearchFlowTemplatesRequest searchFlowTemplatesRequest)
      Deprecated.
      since: 2022-08-30

      Searches for summary information about workflows.

      Parameters:
      searchFlowTemplatesRequest -
      Returns:
      A Java Future containing the result of the SearchFlowTemplates 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.
      • InvalidRequestException
      • ThrottlingException
      • InternalFailureException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchFlowTemplates

      @Deprecated default CompletableFuture<SearchFlowTemplatesResponse> searchFlowTemplates(Consumer<SearchFlowTemplatesRequest.Builder> searchFlowTemplatesRequest)
      Deprecated.
      since: 2022-08-30

      Searches for summary information about workflows.


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

      Parameters:
      searchFlowTemplatesRequest - A Consumer that will call methods on SearchFlowTemplatesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SearchFlowTemplates 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.
      • InvalidRequestException
      • ThrottlingException
      • InternalFailureException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchFlowTemplatesPaginator

      @Deprecated default SearchFlowTemplatesPublisher searchFlowTemplatesPaginator(SearchFlowTemplatesRequest searchFlowTemplatesRequest)
      Deprecated.
      since: 2022-08-30

      This is a variant of searchFlowTemplates(software.amazon.awssdk.services.iotthingsgraph.model.SearchFlowTemplatesRequest) 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.iotthingsgraph.paginators.SearchFlowTemplatesPublisher publisher = client.searchFlowTemplatesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.iotthingsgraph.paginators.SearchFlowTemplatesPublisher publisher = client.searchFlowTemplatesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotthingsgraph.model.SearchFlowTemplatesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotthingsgraph.model.SearchFlowTemplatesResponse 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 searchFlowTemplates(software.amazon.awssdk.services.iotthingsgraph.model.SearchFlowTemplatesRequest) operation.

      Parameters:
      searchFlowTemplatesRequest -
      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.
      • InvalidRequestException
      • ThrottlingException
      • InternalFailureException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchFlowTemplatesPaginator

      @Deprecated default SearchFlowTemplatesPublisher searchFlowTemplatesPaginator(Consumer<SearchFlowTemplatesRequest.Builder> searchFlowTemplatesRequest)
      Deprecated.
      since: 2022-08-30

      This is a variant of searchFlowTemplates(software.amazon.awssdk.services.iotthingsgraph.model.SearchFlowTemplatesRequest) 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.iotthingsgraph.paginators.SearchFlowTemplatesPublisher publisher = client.searchFlowTemplatesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.iotthingsgraph.paginators.SearchFlowTemplatesPublisher publisher = client.searchFlowTemplatesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotthingsgraph.model.SearchFlowTemplatesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotthingsgraph.model.SearchFlowTemplatesResponse 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 searchFlowTemplates(software.amazon.awssdk.services.iotthingsgraph.model.SearchFlowTemplatesRequest) operation.


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

      Parameters:
      searchFlowTemplatesRequest - A Consumer that will call methods on SearchFlowTemplatesRequest.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.
      • InvalidRequestException
      • ThrottlingException
      • InternalFailureException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchSystemInstances

      @Deprecated default CompletableFuture<SearchSystemInstancesResponse> searchSystemInstances(SearchSystemInstancesRequest searchSystemInstancesRequest)
      Deprecated.
      since: 2022-08-30

      Searches for system instances in the user's account.

      Parameters:
      searchSystemInstancesRequest -
      Returns:
      A Java Future containing the result of the SearchSystemInstances 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.
      • InvalidRequestException
      • ThrottlingException
      • InternalFailureException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchSystemInstances

      @Deprecated default CompletableFuture<SearchSystemInstancesResponse> searchSystemInstances(Consumer<SearchSystemInstancesRequest.Builder> searchSystemInstancesRequest)
      Deprecated.
      since: 2022-08-30

      Searches for system instances in the user's account.


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

      Parameters:
      searchSystemInstancesRequest - A Consumer that will call methods on SearchSystemInstancesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SearchSystemInstances 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.
      • InvalidRequestException
      • ThrottlingException
      • InternalFailureException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchSystemInstancesPaginator

      @Deprecated default SearchSystemInstancesPublisher searchSystemInstancesPaginator(SearchSystemInstancesRequest searchSystemInstancesRequest)
      Deprecated.
      since: 2022-08-30

      This is a variant of searchSystemInstances(software.amazon.awssdk.services.iotthingsgraph.model.SearchSystemInstancesRequest) 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.iotthingsgraph.paginators.SearchSystemInstancesPublisher publisher = client.searchSystemInstancesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.iotthingsgraph.paginators.SearchSystemInstancesPublisher publisher = client.searchSystemInstancesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotthingsgraph.model.SearchSystemInstancesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotthingsgraph.model.SearchSystemInstancesResponse 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 searchSystemInstances(software.amazon.awssdk.services.iotthingsgraph.model.SearchSystemInstancesRequest) operation.

      Parameters:
      searchSystemInstancesRequest -
      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.
      • InvalidRequestException
      • ThrottlingException
      • InternalFailureException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchSystemInstancesPaginator

      @Deprecated default SearchSystemInstancesPublisher searchSystemInstancesPaginator(Consumer<SearchSystemInstancesRequest.Builder> searchSystemInstancesRequest)
      Deprecated.
      since: 2022-08-30

      This is a variant of searchSystemInstances(software.amazon.awssdk.services.iotthingsgraph.model.SearchSystemInstancesRequest) 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.iotthingsgraph.paginators.SearchSystemInstancesPublisher publisher = client.searchSystemInstancesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.iotthingsgraph.paginators.SearchSystemInstancesPublisher publisher = client.searchSystemInstancesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotthingsgraph.model.SearchSystemInstancesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotthingsgraph.model.SearchSystemInstancesResponse 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 searchSystemInstances(software.amazon.awssdk.services.iotthingsgraph.model.SearchSystemInstancesRequest) operation.


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

      Parameters:
      searchSystemInstancesRequest - A Consumer that will call methods on SearchSystemInstancesRequest.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.
      • InvalidRequestException
      • ThrottlingException
      • InternalFailureException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchSystemTemplates

      @Deprecated default CompletableFuture<SearchSystemTemplatesResponse> searchSystemTemplates(SearchSystemTemplatesRequest searchSystemTemplatesRequest)
      Deprecated.
      since: 2022-08-30

      Searches for summary information about systems in the user's account. You can filter by the ID of a workflow to return only systems that use the specified workflow.

      Parameters:
      searchSystemTemplatesRequest -
      Returns:
      A Java Future containing the result of the SearchSystemTemplates 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.
      • InvalidRequestException
      • ThrottlingException
      • InternalFailureException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchSystemTemplates

      @Deprecated default CompletableFuture<SearchSystemTemplatesResponse> searchSystemTemplates(Consumer<SearchSystemTemplatesRequest.Builder> searchSystemTemplatesRequest)
      Deprecated.
      since: 2022-08-30

      Searches for summary information about systems in the user's account. You can filter by the ID of a workflow to return only systems that use the specified workflow.


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

      Parameters:
      searchSystemTemplatesRequest - A Consumer that will call methods on SearchSystemTemplatesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SearchSystemTemplates 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.
      • InvalidRequestException
      • ThrottlingException
      • InternalFailureException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchSystemTemplatesPaginator

      @Deprecated default SearchSystemTemplatesPublisher searchSystemTemplatesPaginator(SearchSystemTemplatesRequest searchSystemTemplatesRequest)
      Deprecated.
      since: 2022-08-30

      This is a variant of searchSystemTemplates(software.amazon.awssdk.services.iotthingsgraph.model.SearchSystemTemplatesRequest) 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.iotthingsgraph.paginators.SearchSystemTemplatesPublisher publisher = client.searchSystemTemplatesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.iotthingsgraph.paginators.SearchSystemTemplatesPublisher publisher = client.searchSystemTemplatesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotthingsgraph.model.SearchSystemTemplatesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotthingsgraph.model.SearchSystemTemplatesResponse 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 searchSystemTemplates(software.amazon.awssdk.services.iotthingsgraph.model.SearchSystemTemplatesRequest) operation.

      Parameters:
      searchSystemTemplatesRequest -
      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.
      • InvalidRequestException
      • ThrottlingException
      • InternalFailureException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchSystemTemplatesPaginator

      @Deprecated default SearchSystemTemplatesPublisher searchSystemTemplatesPaginator(Consumer<SearchSystemTemplatesRequest.Builder> searchSystemTemplatesRequest)
      Deprecated.
      since: 2022-08-30

      This is a variant of searchSystemTemplates(software.amazon.awssdk.services.iotthingsgraph.model.SearchSystemTemplatesRequest) 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.iotthingsgraph.paginators.SearchSystemTemplatesPublisher publisher = client.searchSystemTemplatesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.iotthingsgraph.paginators.SearchSystemTemplatesPublisher publisher = client.searchSystemTemplatesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotthingsgraph.model.SearchSystemTemplatesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotthingsgraph.model.SearchSystemTemplatesResponse 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 searchSystemTemplates(software.amazon.awssdk.services.iotthingsgraph.model.SearchSystemTemplatesRequest) operation.


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

      Parameters:
      searchSystemTemplatesRequest - A Consumer that will call methods on SearchSystemTemplatesRequest.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.
      • InvalidRequestException
      • ThrottlingException
      • InternalFailureException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchThings

      @Deprecated default CompletableFuture<SearchThingsResponse> searchThings(SearchThingsRequest searchThingsRequest)
      Deprecated.
      since: 2022-08-30

      Searches for things associated with the specified entity. You can search by both device and device model.

      For example, if two different devices, camera1 and camera2, implement the camera device model, the user can associate thing1 to camera1 and thing2 to camera2. SearchThings(camera2) will return only thing2, but SearchThings(camera) will return both thing1 and thing2.

      This action searches for exact matches and doesn't perform partial text matching.

      Parameters:
      searchThingsRequest -
      Returns:
      A Java Future containing the result of the SearchThings 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.
      • InvalidRequestException
      • ResourceNotFoundException
      • InternalFailureException
      • ThrottlingException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchThings

      @Deprecated default CompletableFuture<SearchThingsResponse> searchThings(Consumer<SearchThingsRequest.Builder> searchThingsRequest)
      Deprecated.
      since: 2022-08-30

      Searches for things associated with the specified entity. You can search by both device and device model.

      For example, if two different devices, camera1 and camera2, implement the camera device model, the user can associate thing1 to camera1 and thing2 to camera2. SearchThings(camera2) will return only thing2, but SearchThings(camera) will return both thing1 and thing2.

      This action searches for exact matches and doesn't perform partial text matching.


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

      Parameters:
      searchThingsRequest - A Consumer that will call methods on SearchThingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SearchThings 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.
      • InvalidRequestException
      • ResourceNotFoundException
      • InternalFailureException
      • ThrottlingException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchThingsPaginator

      @Deprecated default SearchThingsPublisher searchThingsPaginator(SearchThingsRequest searchThingsRequest)
      Deprecated.
      since: 2022-08-30

      This is a variant of searchThings(software.amazon.awssdk.services.iotthingsgraph.model.SearchThingsRequest) 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.iotthingsgraph.paginators.SearchThingsPublisher publisher = client.searchThingsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.iotthingsgraph.paginators.SearchThingsPublisher publisher = client.searchThingsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotthingsgraph.model.SearchThingsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotthingsgraph.model.SearchThingsResponse 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 searchThings(software.amazon.awssdk.services.iotthingsgraph.model.SearchThingsRequest) operation.

      Parameters:
      searchThingsRequest -
      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.
      • InvalidRequestException
      • ResourceNotFoundException
      • InternalFailureException
      • ThrottlingException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchThingsPaginator

      @Deprecated default SearchThingsPublisher searchThingsPaginator(Consumer<SearchThingsRequest.Builder> searchThingsRequest)
      Deprecated.
      since: 2022-08-30

      This is a variant of searchThings(software.amazon.awssdk.services.iotthingsgraph.model.SearchThingsRequest) 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.iotthingsgraph.paginators.SearchThingsPublisher publisher = client.searchThingsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.iotthingsgraph.paginators.SearchThingsPublisher publisher = client.searchThingsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotthingsgraph.model.SearchThingsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotthingsgraph.model.SearchThingsResponse 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 searchThings(software.amazon.awssdk.services.iotthingsgraph.model.SearchThingsRequest) operation.


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

      Parameters:
      searchThingsRequest - A Consumer that will call methods on SearchThingsRequest.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.
      • InvalidRequestException
      • ResourceNotFoundException
      • InternalFailureException
      • ThrottlingException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      @Deprecated default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
      Deprecated.
      since: 2022-08-30

      Creates a tag for the specified 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.
      • InvalidRequestException
      • ResourceAlreadyExistsException
      • ThrottlingException
      • InternalFailureException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      @Deprecated default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
      Deprecated.
      since: 2022-08-30

      Creates a tag for the specified 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.
      • InvalidRequestException
      • ResourceAlreadyExistsException
      • ThrottlingException
      • InternalFailureException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • undeploySystemInstance

      @Deprecated default CompletableFuture<UndeploySystemInstanceResponse> undeploySystemInstance(UndeploySystemInstanceRequest undeploySystemInstanceRequest)
      Deprecated.
      since: 2022-08-30

      Removes a system instance from its target (Cloud or Greengrass).

      Parameters:
      undeploySystemInstanceRequest -
      Returns:
      A Java Future containing the result of the UndeploySystemInstance 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.
      • InvalidRequestException
      • ThrottlingException
      • InternalFailureException
      • ResourceNotFoundException
      • ResourceInUseException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • undeploySystemInstance

      @Deprecated default CompletableFuture<UndeploySystemInstanceResponse> undeploySystemInstance(Consumer<UndeploySystemInstanceRequest.Builder> undeploySystemInstanceRequest)
      Deprecated.
      since: 2022-08-30

      Removes a system instance from its target (Cloud or Greengrass).


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

      Parameters:
      undeploySystemInstanceRequest - A Consumer that will call methods on UndeploySystemInstanceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UndeploySystemInstance 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.
      • InvalidRequestException
      • ThrottlingException
      • InternalFailureException
      • ResourceNotFoundException
      • ResourceInUseException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      @Deprecated default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
      Deprecated.
      since: 2022-08-30

      Removes a tag from the specified 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.
      • InvalidRequestException
      • ResourceAlreadyExistsException
      • ThrottlingException
      • InternalFailureException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      @Deprecated default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
      Deprecated.
      since: 2022-08-30

      Removes a tag from the specified 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.
      • InvalidRequestException
      • ResourceAlreadyExistsException
      • ThrottlingException
      • InternalFailureException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateFlowTemplate

      @Deprecated default CompletableFuture<UpdateFlowTemplateResponse> updateFlowTemplate(UpdateFlowTemplateRequest updateFlowTemplateRequest)
      Deprecated.
      since: 2022-08-30

      Updates the specified workflow. All deployed systems and system instances that use the workflow will see the changes in the flow when it is redeployed. If you don't want this behavior, copy the workflow (creating a new workflow with a different ID), and update the copy. The workflow can contain only entities in the specified namespace.

      Parameters:
      updateFlowTemplateRequest -
      Returns:
      A Java Future containing the result of the UpdateFlowTemplate 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.
      • InvalidRequestException
      • ResourceNotFoundException
      • ThrottlingException
      • InternalFailureException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateFlowTemplate

      @Deprecated default CompletableFuture<UpdateFlowTemplateResponse> updateFlowTemplate(Consumer<UpdateFlowTemplateRequest.Builder> updateFlowTemplateRequest)
      Deprecated.
      since: 2022-08-30

      Updates the specified workflow. All deployed systems and system instances that use the workflow will see the changes in the flow when it is redeployed. If you don't want this behavior, copy the workflow (creating a new workflow with a different ID), and update the copy. The workflow can contain only entities in the specified namespace.


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

      Parameters:
      updateFlowTemplateRequest - A Consumer that will call methods on UpdateFlowTemplateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateFlowTemplate 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.
      • InvalidRequestException
      • ResourceNotFoundException
      • ThrottlingException
      • InternalFailureException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateSystemTemplate

      @Deprecated default CompletableFuture<UpdateSystemTemplateResponse> updateSystemTemplate(UpdateSystemTemplateRequest updateSystemTemplateRequest)
      Deprecated.
      since: 2022-08-30

      Updates the specified system. You don't need to run this action after updating a workflow. Any deployment that uses the system will see the changes in the system when it is redeployed.

      Parameters:
      updateSystemTemplateRequest -
      Returns:
      A Java Future containing the result of the UpdateSystemTemplate 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.
      • InvalidRequestException
      • ResourceNotFoundException
      • ThrottlingException
      • InternalFailureException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateSystemTemplate

      @Deprecated default CompletableFuture<UpdateSystemTemplateResponse> updateSystemTemplate(Consumer<UpdateSystemTemplateRequest.Builder> updateSystemTemplateRequest)
      Deprecated.
      since: 2022-08-30

      Updates the specified system. You don't need to run this action after updating a workflow. Any deployment that uses the system will see the changes in the system when it is redeployed.


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

      Parameters:
      updateSystemTemplateRequest - A Consumer that will call methods on UpdateSystemTemplateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateSystemTemplate 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.
      • InvalidRequestException
      • ResourceNotFoundException
      • ThrottlingException
      • InternalFailureException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • uploadEntityDefinitions

      @Deprecated default CompletableFuture<UploadEntityDefinitionsResponse> uploadEntityDefinitions(UploadEntityDefinitionsRequest uploadEntityDefinitionsRequest)
      Deprecated.
      since: 2022-08-30

      Asynchronously uploads one or more entity definitions to the user's namespace. The document parameter is required if syncWithPublicNamespace and deleteExistingEntites are false. If the syncWithPublicNamespace parameter is set to true, the user's namespace will synchronize with the latest version of the public namespace. If deprecateExistingEntities is set to true, all entities in the latest version will be deleted before the new DefinitionDocument is uploaded.

      When a user uploads entity definitions for the first time, the service creates a new namespace for the user. The new namespace tracks the public namespace. Currently users can have only one namespace. The namespace version increments whenever a user uploads entity definitions that are backwards-incompatible and whenever a user sets the syncWithPublicNamespace parameter or the deprecateExistingEntities parameter to true.

      The IDs for all of the entities should be in URN format. Each entity must be in the user's namespace. Users can't create entities in the public namespace, but entity definitions can refer to entities in the public namespace.

      Valid entities are Device, DeviceModel, Service, Capability, State, Action, Event, Property, Mapping, Enum.

      Parameters:
      uploadEntityDefinitionsRequest -
      Returns:
      A Java Future containing the result of the UploadEntityDefinitions 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.
      • InvalidRequestException
      • InternalFailureException
      • ThrottlingException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • uploadEntityDefinitions

      @Deprecated default CompletableFuture<UploadEntityDefinitionsResponse> uploadEntityDefinitions(Consumer<UploadEntityDefinitionsRequest.Builder> uploadEntityDefinitionsRequest)
      Deprecated.
      since: 2022-08-30

      Asynchronously uploads one or more entity definitions to the user's namespace. The document parameter is required if syncWithPublicNamespace and deleteExistingEntites are false. If the syncWithPublicNamespace parameter is set to true, the user's namespace will synchronize with the latest version of the public namespace. If deprecateExistingEntities is set to true, all entities in the latest version will be deleted before the new DefinitionDocument is uploaded.

      When a user uploads entity definitions for the first time, the service creates a new namespace for the user. The new namespace tracks the public namespace. Currently users can have only one namespace. The namespace version increments whenever a user uploads entity definitions that are backwards-incompatible and whenever a user sets the syncWithPublicNamespace parameter or the deprecateExistingEntities parameter to true.

      The IDs for all of the entities should be in URN format. Each entity must be in the user's namespace. Users can't create entities in the public namespace, but entity definitions can refer to entities in the public namespace.

      Valid entities are Device, DeviceModel, Service, Capability, State, Action, Event, Property, Mapping, Enum.


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

      Parameters:
      uploadEntityDefinitionsRequest - A Consumer that will call methods on UploadEntityDefinitionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UploadEntityDefinitions 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.
      • InvalidRequestException
      • InternalFailureException
      • ThrottlingException
      • 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.
      • IoTThingsGraphException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default IoTThingsGraphServiceClientConfiguration 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 IoTThingsGraphAsyncClient create()
      Create a IoTThingsGraphAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static IoTThingsGraphAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a IoTThingsGraphAsyncClient.