Interface IoTSiteWiseAsyncClient

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

Welcome to the IoT SiteWise API Reference. IoT SiteWise is an Amazon Web Services service that connects Industrial Internet of Things (IIoT) devices to the power of the Amazon Web Services Cloud. For more information, see the IoT SiteWise User Guide. For information about IoT SiteWise quotas, see Quotas in the IoT SiteWise User Guide.

  • Field Details

  • Method Details

    • associateAssets

      default CompletableFuture<AssociateAssetsResponse> associateAssets(AssociateAssetsRequest associateAssetsRequest)

      Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's model. For more information, see Associating assets in the IoT SiteWise User Guide.

      Parameters:
      associateAssetsRequest -
      Returns:
      A Java Future containing the result of the AssociateAssets 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceAlreadyExistsException The resource already exists.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • LimitExceededException You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateAssets

      default CompletableFuture<AssociateAssetsResponse> associateAssets(Consumer<AssociateAssetsRequest.Builder> associateAssetsRequest)

      Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's model. For more information, see Associating assets in the IoT SiteWise User Guide.


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

      Parameters:
      associateAssetsRequest - A Consumer that will call methods on AssociateAssetsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssociateAssets 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceAlreadyExistsException The resource already exists.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • LimitExceededException You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateTimeSeriesToAssetProperty

      default CompletableFuture<AssociateTimeSeriesToAssetPropertyResponse> associateTimeSeriesToAssetProperty(AssociateTimeSeriesToAssetPropertyRequest associateTimeSeriesToAssetPropertyRequest)

      Associates a time series (data stream) with an asset property.

      Parameters:
      associateTimeSeriesToAssetPropertyRequest -
      Returns:
      A Java Future containing the result of the AssociateTimeSeriesToAssetProperty 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateTimeSeriesToAssetProperty

      default CompletableFuture<AssociateTimeSeriesToAssetPropertyResponse> associateTimeSeriesToAssetProperty(Consumer<AssociateTimeSeriesToAssetPropertyRequest.Builder> associateTimeSeriesToAssetPropertyRequest)

      Associates a time series (data stream) with an asset property.


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

      Parameters:
      associateTimeSeriesToAssetPropertyRequest - A Consumer that will call methods on AssociateTimeSeriesToAssetPropertyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssociateTimeSeriesToAssetProperty 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchAssociateProjectAssets

      default CompletableFuture<BatchAssociateProjectAssetsResponse> batchAssociateProjectAssets(BatchAssociateProjectAssetsRequest batchAssociateProjectAssetsRequest)

      Associates a group (batch) of assets with an IoT SiteWise Monitor project.

      Parameters:
      batchAssociateProjectAssetsRequest -
      Returns:
      A Java Future containing the result of the BatchAssociateProjectAssets 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • LimitExceededException You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchAssociateProjectAssets

      default CompletableFuture<BatchAssociateProjectAssetsResponse> batchAssociateProjectAssets(Consumer<BatchAssociateProjectAssetsRequest.Builder> batchAssociateProjectAssetsRequest)

      Associates a group (batch) of assets with an IoT SiteWise Monitor project.


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

      Parameters:
      batchAssociateProjectAssetsRequest - A Consumer that will call methods on BatchAssociateProjectAssetsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the BatchAssociateProjectAssets 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • LimitExceededException You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchDisassociateProjectAssets

      default CompletableFuture<BatchDisassociateProjectAssetsResponse> batchDisassociateProjectAssets(BatchDisassociateProjectAssetsRequest batchDisassociateProjectAssetsRequest)

      Disassociates a group (batch) of assets from an IoT SiteWise Monitor project.

      Parameters:
      batchDisassociateProjectAssetsRequest -
      Returns:
      A Java Future containing the result of the BatchDisassociateProjectAssets 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchDisassociateProjectAssets

      default CompletableFuture<BatchDisassociateProjectAssetsResponse> batchDisassociateProjectAssets(Consumer<BatchDisassociateProjectAssetsRequest.Builder> batchDisassociateProjectAssetsRequest)

      Disassociates a group (batch) of assets from an IoT SiteWise Monitor project.


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

      Parameters:
      batchDisassociateProjectAssetsRequest - A Consumer that will call methods on BatchDisassociateProjectAssetsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the BatchDisassociateProjectAssets 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchGetAssetPropertyAggregates

      default CompletableFuture<BatchGetAssetPropertyAggregatesResponse> batchGetAssetPropertyAggregates(BatchGetAssetPropertyAggregatesRequest batchGetAssetPropertyAggregatesRequest)

      Gets aggregated values (for example, average, minimum, and maximum) for one or more asset properties. For more information, see Querying aggregates in the IoT SiteWise User Guide.

      Parameters:
      batchGetAssetPropertyAggregatesRequest -
      Returns:
      A Java Future containing the result of the BatchGetAssetPropertyAggregates 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ServiceUnavailableException The requested service is unavailable.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchGetAssetPropertyAggregates

      default CompletableFuture<BatchGetAssetPropertyAggregatesResponse> batchGetAssetPropertyAggregates(Consumer<BatchGetAssetPropertyAggregatesRequest.Builder> batchGetAssetPropertyAggregatesRequest)

      Gets aggregated values (for example, average, minimum, and maximum) for one or more asset properties. For more information, see Querying aggregates in the IoT SiteWise User Guide.


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

      Parameters:
      batchGetAssetPropertyAggregatesRequest - A Consumer that will call methods on BatchGetAssetPropertyAggregatesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the BatchGetAssetPropertyAggregates 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ServiceUnavailableException The requested service is unavailable.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchGetAssetPropertyAggregatesPaginator

      default BatchGetAssetPropertyAggregatesPublisher batchGetAssetPropertyAggregatesPaginator(BatchGetAssetPropertyAggregatesRequest batchGetAssetPropertyAggregatesRequest)

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

      Parameters:
      batchGetAssetPropertyAggregatesRequest -
      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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ServiceUnavailableException The requested service is unavailable.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchGetAssetPropertyAggregatesPaginator

      default BatchGetAssetPropertyAggregatesPublisher batchGetAssetPropertyAggregatesPaginator(Consumer<BatchGetAssetPropertyAggregatesRequest.Builder> batchGetAssetPropertyAggregatesRequest)

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


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

      Parameters:
      batchGetAssetPropertyAggregatesRequest - A Consumer that will call methods on BatchGetAssetPropertyAggregatesRequest.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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ServiceUnavailableException The requested service is unavailable.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchGetAssetPropertyValue

      default CompletableFuture<BatchGetAssetPropertyValueResponse> batchGetAssetPropertyValue(BatchGetAssetPropertyValueRequest batchGetAssetPropertyValueRequest)

      Gets the current value for one or more asset properties. For more information, see Querying current values in the IoT SiteWise User Guide.

      Parameters:
      batchGetAssetPropertyValueRequest -
      Returns:
      A Java Future containing the result of the BatchGetAssetPropertyValue 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ServiceUnavailableException The requested service is unavailable.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchGetAssetPropertyValue

      default CompletableFuture<BatchGetAssetPropertyValueResponse> batchGetAssetPropertyValue(Consumer<BatchGetAssetPropertyValueRequest.Builder> batchGetAssetPropertyValueRequest)

      Gets the current value for one or more asset properties. For more information, see Querying current values in the IoT SiteWise User Guide.


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

      Parameters:
      batchGetAssetPropertyValueRequest - A Consumer that will call methods on BatchGetAssetPropertyValueRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the BatchGetAssetPropertyValue 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ServiceUnavailableException The requested service is unavailable.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchGetAssetPropertyValueHistory

      default CompletableFuture<BatchGetAssetPropertyValueHistoryResponse> batchGetAssetPropertyValueHistory(BatchGetAssetPropertyValueHistoryRequest batchGetAssetPropertyValueHistoryRequest)

      Gets the historical values for one or more asset properties. For more information, see Querying historical values in the IoT SiteWise User Guide.

      Parameters:
      batchGetAssetPropertyValueHistoryRequest -
      Returns:
      A Java Future containing the result of the BatchGetAssetPropertyValueHistory 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ServiceUnavailableException The requested service is unavailable.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchGetAssetPropertyValueHistory

      default CompletableFuture<BatchGetAssetPropertyValueHistoryResponse> batchGetAssetPropertyValueHistory(Consumer<BatchGetAssetPropertyValueHistoryRequest.Builder> batchGetAssetPropertyValueHistoryRequest)

      Gets the historical values for one or more asset properties. For more information, see Querying historical values in the IoT SiteWise User Guide.


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

      Parameters:
      batchGetAssetPropertyValueHistoryRequest - A Consumer that will call methods on BatchGetAssetPropertyValueHistoryRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the BatchGetAssetPropertyValueHistory 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ServiceUnavailableException The requested service is unavailable.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchGetAssetPropertyValueHistoryPaginator

      default BatchGetAssetPropertyValueHistoryPublisher batchGetAssetPropertyValueHistoryPaginator(BatchGetAssetPropertyValueHistoryRequest batchGetAssetPropertyValueHistoryRequest)

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

      Parameters:
      batchGetAssetPropertyValueHistoryRequest -
      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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ServiceUnavailableException The requested service is unavailable.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchGetAssetPropertyValueHistoryPaginator

      default BatchGetAssetPropertyValueHistoryPublisher batchGetAssetPropertyValueHistoryPaginator(Consumer<BatchGetAssetPropertyValueHistoryRequest.Builder> batchGetAssetPropertyValueHistoryRequest)

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


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

      Parameters:
      batchGetAssetPropertyValueHistoryRequest - A Consumer that will call methods on BatchGetAssetPropertyValueHistoryRequest.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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ServiceUnavailableException The requested service is unavailable.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchGetAssetPropertyValuePaginator

      default BatchGetAssetPropertyValuePublisher batchGetAssetPropertyValuePaginator(BatchGetAssetPropertyValueRequest batchGetAssetPropertyValueRequest)

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

      Parameters:
      batchGetAssetPropertyValueRequest -
      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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ServiceUnavailableException The requested service is unavailable.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchGetAssetPropertyValuePaginator

      default BatchGetAssetPropertyValuePublisher batchGetAssetPropertyValuePaginator(Consumer<BatchGetAssetPropertyValueRequest.Builder> batchGetAssetPropertyValueRequest)

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


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

      Parameters:
      batchGetAssetPropertyValueRequest - A Consumer that will call methods on BatchGetAssetPropertyValueRequest.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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ServiceUnavailableException The requested service is unavailable.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchPutAssetPropertyValue

      default CompletableFuture<BatchPutAssetPropertyValueResponse> batchPutAssetPropertyValue(BatchPutAssetPropertyValueRequest batchPutAssetPropertyValueRequest)

      Sends a list of asset property values to IoT SiteWise. Each value is a timestamp-quality-value (TQV) data point. For more information, see Ingesting data using the API in the IoT SiteWise User Guide.

      To identify an asset property, you must specify one of the following:

      • The assetId and propertyId of an asset property.

      • A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.

      With respect to Unix epoch time, IoT SiteWise accepts only TQVs that have a timestamp of no more than 7 days in the past and no more than 10 minutes in the future. IoT SiteWise rejects timestamps outside of the inclusive range of [-7 days, +10 minutes] and returns a TimestampOutOfRangeException error.

      For each asset property, IoT SiteWise overwrites TQVs with duplicate timestamps unless the newer TQV has a different quality. For example, if you store a TQV {T1, GOOD, V1}, then storing {T1, GOOD, V2} replaces the existing TQV.

      IoT SiteWise authorizes access to each BatchPutAssetPropertyValue entry individually. For more information, see BatchPutAssetPropertyValue authorization in the IoT SiteWise User Guide.

      Parameters:
      batchPutAssetPropertyValueRequest -
      Returns:
      A Java Future containing the result of the BatchPutAssetPropertyValue 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • LimitExceededException You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ServiceUnavailableException The requested service is unavailable.
      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchPutAssetPropertyValue

      default CompletableFuture<BatchPutAssetPropertyValueResponse> batchPutAssetPropertyValue(Consumer<BatchPutAssetPropertyValueRequest.Builder> batchPutAssetPropertyValueRequest)

      Sends a list of asset property values to IoT SiteWise. Each value is a timestamp-quality-value (TQV) data point. For more information, see Ingesting data using the API in the IoT SiteWise User Guide.

      To identify an asset property, you must specify one of the following:

      • The assetId and propertyId of an asset property.

      • A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.

      With respect to Unix epoch time, IoT SiteWise accepts only TQVs that have a timestamp of no more than 7 days in the past and no more than 10 minutes in the future. IoT SiteWise rejects timestamps outside of the inclusive range of [-7 days, +10 minutes] and returns a TimestampOutOfRangeException error.

      For each asset property, IoT SiteWise overwrites TQVs with duplicate timestamps unless the newer TQV has a different quality. For example, if you store a TQV {T1, GOOD, V1}, then storing {T1, GOOD, V2} replaces the existing TQV.

      IoT SiteWise authorizes access to each BatchPutAssetPropertyValue entry individually. For more information, see BatchPutAssetPropertyValue authorization in the IoT SiteWise User Guide.


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

      Parameters:
      batchPutAssetPropertyValueRequest - A Consumer that will call methods on BatchPutAssetPropertyValueRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the BatchPutAssetPropertyValue 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • LimitExceededException You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ServiceUnavailableException The requested service is unavailable.
      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAccessPolicy

      default CompletableFuture<CreateAccessPolicyResponse> createAccessPolicy(CreateAccessPolicyRequest createAccessPolicyRequest)

      Creates an access policy that grants the specified identity (IAM Identity Center user, IAM Identity Center group, or IAM user) access to the specified IoT SiteWise Monitor portal or project resource.

      Parameters:
      createAccessPolicyRequest -
      Returns:
      A Java Future containing the result of the CreateAccessPolicy 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • LimitExceededException You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAccessPolicy

      default CompletableFuture<CreateAccessPolicyResponse> createAccessPolicy(Consumer<CreateAccessPolicyRequest.Builder> createAccessPolicyRequest)

      Creates an access policy that grants the specified identity (IAM Identity Center user, IAM Identity Center group, or IAM user) access to the specified IoT SiteWise Monitor portal or project resource.


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

      Parameters:
      createAccessPolicyRequest - A Consumer that will call methods on CreateAccessPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateAccessPolicy 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • LimitExceededException You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAsset

      default CompletableFuture<CreateAssetResponse> createAsset(CreateAssetRequest createAssetRequest)

      Creates an asset from an existing asset model. For more information, see Creating assets in the IoT SiteWise User Guide.

      Parameters:
      createAssetRequest -
      Returns:
      A Java Future containing the result of the CreateAsset 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceAlreadyExistsException The resource already exists.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • LimitExceededException You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAsset

      default CompletableFuture<CreateAssetResponse> createAsset(Consumer<CreateAssetRequest.Builder> createAssetRequest)

      Creates an asset from an existing asset model. For more information, see Creating assets in the IoT SiteWise User Guide.


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

      Parameters:
      createAssetRequest - A Consumer that will call methods on CreateAssetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateAsset 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceAlreadyExistsException The resource already exists.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • LimitExceededException You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAssetModel

      default CompletableFuture<CreateAssetModelResponse> createAssetModel(CreateAssetModelRequest createAssetModelRequest)

      Creates an asset model from specified property and hierarchy definitions. You create assets from asset models. With asset models, you can easily create assets of the same type that have standardized definitions. Each asset created from a model inherits the asset model's property and hierarchy definitions. For more information, see Defining asset models in the IoT SiteWise User Guide.

      You can create two types of asset models, ASSET_MODEL or COMPONENT_MODEL.

      • ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.

      • COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.

      Parameters:
      createAssetModelRequest -
      Returns:
      A Java Future containing the result of the CreateAssetModel 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceAlreadyExistsException The resource already exists.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • LimitExceededException You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAssetModel

      default CompletableFuture<CreateAssetModelResponse> createAssetModel(Consumer<CreateAssetModelRequest.Builder> createAssetModelRequest)

      Creates an asset model from specified property and hierarchy definitions. You create assets from asset models. With asset models, you can easily create assets of the same type that have standardized definitions. Each asset created from a model inherits the asset model's property and hierarchy definitions. For more information, see Defining asset models in the IoT SiteWise User Guide.

      You can create two types of asset models, ASSET_MODEL or COMPONENT_MODEL.

      • ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.

      • COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.


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

      Parameters:
      createAssetModelRequest - A Consumer that will call methods on CreateAssetModelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateAssetModel 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceAlreadyExistsException The resource already exists.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • LimitExceededException You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAssetModelCompositeModel

      default CompletableFuture<CreateAssetModelCompositeModelResponse> createAssetModelCompositeModel(CreateAssetModelCompositeModelRequest createAssetModelCompositeModelRequest)

      Creates a custom composite model from specified property and hierarchy definitions. There are two types of custom composite models, inline and component-model-based.

      Use component-model-based custom composite models to define standard, reusable components. A component-model-based custom composite model consists of a name, a description, and the ID of the component model it references. A component-model-based custom composite model has no properties of its own; its referenced component model provides its associated properties to any created assets. For more information, see Custom composite models (Components) in the IoT SiteWise User Guide.

      Use inline custom composite models to organize the properties of an asset model. The properties of inline custom composite models are local to the asset model where they are included and can't be used to create multiple assets.

      To create a component-model-based model, specify the composedAssetModelId of an existing asset model with assetModelType of COMPONENT_MODEL.

      To create an inline model, specify the assetModelCompositeModelProperties and don't include an composedAssetModelId.

      Parameters:
      createAssetModelCompositeModelRequest -
      Returns:
      A Java Future containing the result of the CreateAssetModelCompositeModel 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.
      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • PreconditionFailedException The precondition in one or more of the request-header fields evaluated to FALSE.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceAlreadyExistsException The resource already exists.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • LimitExceededException You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAssetModelCompositeModel

      default CompletableFuture<CreateAssetModelCompositeModelResponse> createAssetModelCompositeModel(Consumer<CreateAssetModelCompositeModelRequest.Builder> createAssetModelCompositeModelRequest)

      Creates a custom composite model from specified property and hierarchy definitions. There are two types of custom composite models, inline and component-model-based.

      Use component-model-based custom composite models to define standard, reusable components. A component-model-based custom composite model consists of a name, a description, and the ID of the component model it references. A component-model-based custom composite model has no properties of its own; its referenced component model provides its associated properties to any created assets. For more information, see Custom composite models (Components) in the IoT SiteWise User Guide.

      Use inline custom composite models to organize the properties of an asset model. The properties of inline custom composite models are local to the asset model where they are included and can't be used to create multiple assets.

      To create a component-model-based model, specify the composedAssetModelId of an existing asset model with assetModelType of COMPONENT_MODEL.

      To create an inline model, specify the assetModelCompositeModelProperties and don't include an composedAssetModelId.


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

      Parameters:
      createAssetModelCompositeModelRequest - A Consumer that will call methods on CreateAssetModelCompositeModelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateAssetModelCompositeModel 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.
      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • PreconditionFailedException The precondition in one or more of the request-header fields evaluated to FALSE.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceAlreadyExistsException The resource already exists.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • LimitExceededException You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createBulkImportJob

      default CompletableFuture<CreateBulkImportJobResponse> createBulkImportJob(CreateBulkImportJobRequest createBulkImportJobRequest)

      Defines a job to ingest data to IoT SiteWise from Amazon S3. For more information, see Create a bulk import job (CLI) in the Amazon Simple Storage Service User Guide.

      Before you create a bulk import job, you must enable IoT SiteWise warm tier or IoT SiteWise cold tier. For more information about how to configure storage settings, see PutStorageConfiguration.

      Bulk import is designed to store historical data to IoT SiteWise. It does not trigger computations or notifications on IoT SiteWise warm or cold tier storage.

      Parameters:
      createBulkImportJobRequest -
      Returns:
      A Java Future containing the result of the CreateBulkImportJob 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceAlreadyExistsException The resource already exists.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • LimitExceededException You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createBulkImportJob

      default CompletableFuture<CreateBulkImportJobResponse> createBulkImportJob(Consumer<CreateBulkImportJobRequest.Builder> createBulkImportJobRequest)

      Defines a job to ingest data to IoT SiteWise from Amazon S3. For more information, see Create a bulk import job (CLI) in the Amazon Simple Storage Service User Guide.

      Before you create a bulk import job, you must enable IoT SiteWise warm tier or IoT SiteWise cold tier. For more information about how to configure storage settings, see PutStorageConfiguration.

      Bulk import is designed to store historical data to IoT SiteWise. It does not trigger computations or notifications on IoT SiteWise warm or cold tier storage.


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

      Parameters:
      createBulkImportJobRequest - A Consumer that will call methods on CreateBulkImportJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateBulkImportJob 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceAlreadyExistsException The resource already exists.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • LimitExceededException You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createDashboard

      default CompletableFuture<CreateDashboardResponse> createDashboard(CreateDashboardRequest createDashboardRequest)

      Creates a dashboard in an IoT SiteWise Monitor project.

      Parameters:
      createDashboardRequest -
      Returns:
      A Java Future containing the result of the CreateDashboard 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • LimitExceededException You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createDashboard

      default CompletableFuture<CreateDashboardResponse> createDashboard(Consumer<CreateDashboardRequest.Builder> createDashboardRequest)

      Creates a dashboard in an IoT SiteWise Monitor project.


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

      Parameters:
      createDashboardRequest - A Consumer that will call methods on CreateDashboardRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateDashboard 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • LimitExceededException You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createGateway

      default CompletableFuture<CreateGatewayResponse> createGateway(CreateGatewayRequest createGatewayRequest)

      Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to IoT SiteWise. For more information, see Ingesting data using a gateway in the IoT SiteWise User Guide.

      Parameters:
      createGatewayRequest -
      Returns:
      A Java Future containing the result of the CreateGateway 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceAlreadyExistsException The resource already exists.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • LimitExceededException You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createGateway

      default CompletableFuture<CreateGatewayResponse> createGateway(Consumer<CreateGatewayRequest.Builder> createGatewayRequest)

      Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to IoT SiteWise. For more information, see Ingesting data using a gateway in the IoT SiteWise User Guide.


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

      Parameters:
      createGatewayRequest - A Consumer that will call methods on CreateGatewayRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateGateway 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceAlreadyExistsException The resource already exists.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • LimitExceededException You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createPortal

      default CompletableFuture<CreatePortalResponse> createPortal(CreatePortalRequest createPortalRequest)

      Creates a portal, which can contain projects and dashboards. IoT SiteWise Monitor uses IAM Identity Center or IAM to authenticate portal users and manage user permissions.

      Before you can sign in to a new portal, you must add at least one identity to that portal. For more information, see Adding or removing portal administrators in the IoT SiteWise User Guide.

      Parameters:
      createPortalRequest -
      Returns:
      A Java Future containing the result of the CreatePortal 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • LimitExceededException You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createPortal

      default CompletableFuture<CreatePortalResponse> createPortal(Consumer<CreatePortalRequest.Builder> createPortalRequest)

      Creates a portal, which can contain projects and dashboards. IoT SiteWise Monitor uses IAM Identity Center or IAM to authenticate portal users and manage user permissions.

      Before you can sign in to a new portal, you must add at least one identity to that portal. For more information, see Adding or removing portal administrators in the IoT SiteWise User Guide.


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

      Parameters:
      createPortalRequest - A Consumer that will call methods on CreatePortalRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreatePortal 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • LimitExceededException You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createProject

      default CompletableFuture<CreateProjectResponse> createProject(CreateProjectRequest createProjectRequest)

      Creates a project in the specified portal.

      Make sure that the project name and description don't contain confidential information.

      Parameters:
      createProjectRequest -
      Returns:
      A Java Future containing the result of the CreateProject 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • LimitExceededException You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createProject

      default CompletableFuture<CreateProjectResponse> createProject(Consumer<CreateProjectRequest.Builder> createProjectRequest)

      Creates a project in the specified portal.

      Make sure that the project name and description don't contain confidential information.


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

      Parameters:
      createProjectRequest - A Consumer that will call methods on CreateProjectRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateProject 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • LimitExceededException You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAccessPolicy

      default CompletableFuture<DeleteAccessPolicyResponse> deleteAccessPolicy(DeleteAccessPolicyRequest deleteAccessPolicyRequest)

      Deletes an access policy that grants the specified identity access to the specified IoT SiteWise Monitor resource. You can use this operation to revoke access to an IoT SiteWise Monitor resource.

      Parameters:
      deleteAccessPolicyRequest -
      Returns:
      A Java Future containing the result of the DeleteAccessPolicy 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAccessPolicy

      default CompletableFuture<DeleteAccessPolicyResponse> deleteAccessPolicy(Consumer<DeleteAccessPolicyRequest.Builder> deleteAccessPolicyRequest)

      Deletes an access policy that grants the specified identity access to the specified IoT SiteWise Monitor resource. You can use this operation to revoke access to an IoT SiteWise Monitor resource.


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

      Parameters:
      deleteAccessPolicyRequest - A Consumer that will call methods on DeleteAccessPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteAccessPolicy 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAsset

      default CompletableFuture<DeleteAssetResponse> deleteAsset(DeleteAssetRequest deleteAssetRequest)

      Deletes an asset. This action can't be undone. For more information, see Deleting assets and models in the IoT SiteWise User Guide.

      You can't delete an asset that's associated to another asset. For more information, see DisassociateAssets.

      Parameters:
      deleteAssetRequest -
      Returns:
      A Java Future containing the result of the DeleteAsset 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAsset

      default CompletableFuture<DeleteAssetResponse> deleteAsset(Consumer<DeleteAssetRequest.Builder> deleteAssetRequest)

      Deletes an asset. This action can't be undone. For more information, see Deleting assets and models in the IoT SiteWise User Guide.

      You can't delete an asset that's associated to another asset. For more information, see DisassociateAssets.


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

      Parameters:
      deleteAssetRequest - A Consumer that will call methods on DeleteAssetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteAsset 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAssetModel

      default CompletableFuture<DeleteAssetModelResponse> deleteAssetModel(DeleteAssetModelRequest deleteAssetModelRequest)

      Deletes an asset model. This action can't be undone. You must delete all assets created from an asset model before you can delete the model. Also, you can't delete an asset model if a parent asset model exists that contains a property formula expression that depends on the asset model that you want to delete. For more information, see Deleting assets and models in the IoT SiteWise User Guide.

      Parameters:
      deleteAssetModelRequest -
      Returns:
      A Java Future containing the result of the DeleteAssetModel 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • PreconditionFailedException The precondition in one or more of the request-header fields evaluated to FALSE.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAssetModel

      default CompletableFuture<DeleteAssetModelResponse> deleteAssetModel(Consumer<DeleteAssetModelRequest.Builder> deleteAssetModelRequest)

      Deletes an asset model. This action can't be undone. You must delete all assets created from an asset model before you can delete the model. Also, you can't delete an asset model if a parent asset model exists that contains a property formula expression that depends on the asset model that you want to delete. For more information, see Deleting assets and models in the IoT SiteWise User Guide.


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

      Parameters:
      deleteAssetModelRequest - A Consumer that will call methods on DeleteAssetModelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteAssetModel 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • PreconditionFailedException The precondition in one or more of the request-header fields evaluated to FALSE.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAssetModelCompositeModel

      default CompletableFuture<DeleteAssetModelCompositeModelResponse> deleteAssetModelCompositeModel(DeleteAssetModelCompositeModelRequest deleteAssetModelCompositeModelRequest)

      Deletes a composite model. This action can't be undone. You must delete all assets created from a composite model before you can delete the model. Also, you can't delete a composite model if a parent asset model exists that contains a property formula expression that depends on the asset model that you want to delete. For more information, see Deleting assets and models in the IoT SiteWise User Guide.

      Parameters:
      deleteAssetModelCompositeModelRequest -
      Returns:
      A Java Future containing the result of the DeleteAssetModelCompositeModel 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • PreconditionFailedException The precondition in one or more of the request-header fields evaluated to FALSE.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAssetModelCompositeModel

      default CompletableFuture<DeleteAssetModelCompositeModelResponse> deleteAssetModelCompositeModel(Consumer<DeleteAssetModelCompositeModelRequest.Builder> deleteAssetModelCompositeModelRequest)

      Deletes a composite model. This action can't be undone. You must delete all assets created from a composite model before you can delete the model. Also, you can't delete a composite model if a parent asset model exists that contains a property formula expression that depends on the asset model that you want to delete. For more information, see Deleting assets and models in the IoT SiteWise User Guide.


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

      Parameters:
      deleteAssetModelCompositeModelRequest - A Consumer that will call methods on DeleteAssetModelCompositeModelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteAssetModelCompositeModel 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • PreconditionFailedException The precondition in one or more of the request-header fields evaluated to FALSE.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteDashboard

      default CompletableFuture<DeleteDashboardResponse> deleteDashboard(DeleteDashboardRequest deleteDashboardRequest)

      Deletes a dashboard from IoT SiteWise Monitor.

      Parameters:
      deleteDashboardRequest -
      Returns:
      A Java Future containing the result of the DeleteDashboard 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteDashboard

      default CompletableFuture<DeleteDashboardResponse> deleteDashboard(Consumer<DeleteDashboardRequest.Builder> deleteDashboardRequest)

      Deletes a dashboard from IoT SiteWise Monitor.


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

      Parameters:
      deleteDashboardRequest - A Consumer that will call methods on DeleteDashboardRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteDashboard 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteGateway

      default CompletableFuture<DeleteGatewayResponse> deleteGateway(DeleteGatewayRequest deleteGatewayRequest)

      Deletes a gateway from IoT SiteWise. When you delete a gateway, some of the gateway's files remain in your gateway's file system.

      Parameters:
      deleteGatewayRequest -
      Returns:
      A Java Future containing the result of the DeleteGateway 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteGateway

      default CompletableFuture<DeleteGatewayResponse> deleteGateway(Consumer<DeleteGatewayRequest.Builder> deleteGatewayRequest)

      Deletes a gateway from IoT SiteWise. When you delete a gateway, some of the gateway's files remain in your gateway's file system.


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

      Parameters:
      deleteGatewayRequest - A Consumer that will call methods on DeleteGatewayRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteGateway 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deletePortal

      default CompletableFuture<DeletePortalResponse> deletePortal(DeletePortalRequest deletePortalRequest)

      Deletes a portal from IoT SiteWise Monitor.

      Parameters:
      deletePortalRequest -
      Returns:
      A Java Future containing the result of the DeletePortal 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deletePortal

      default CompletableFuture<DeletePortalResponse> deletePortal(Consumer<DeletePortalRequest.Builder> deletePortalRequest)

      Deletes a portal from IoT SiteWise Monitor.


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

      Parameters:
      deletePortalRequest - A Consumer that will call methods on DeletePortalRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeletePortal 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteProject

      default CompletableFuture<DeleteProjectResponse> deleteProject(DeleteProjectRequest deleteProjectRequest)

      Deletes a project from IoT SiteWise Monitor.

      Parameters:
      deleteProjectRequest -
      Returns:
      A Java Future containing the result of the DeleteProject 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteProject

      default CompletableFuture<DeleteProjectResponse> deleteProject(Consumer<DeleteProjectRequest.Builder> deleteProjectRequest)

      Deletes a project from IoT SiteWise Monitor.


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

      Parameters:
      deleteProjectRequest - A Consumer that will call methods on DeleteProjectRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteProject 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteTimeSeries

      default CompletableFuture<DeleteTimeSeriesResponse> deleteTimeSeries(DeleteTimeSeriesRequest deleteTimeSeriesRequest)

      Deletes a time series (data stream). If you delete a time series that's associated with an asset property, the asset property still exists, but the time series will no longer be associated with this asset property.

      To identify a time series, do one of the following:

      • If the time series isn't associated with an asset property, specify the alias of the time series.

      • If the time series is associated with an asset property, specify one of the following:

        • The alias of the time series.

        • The assetId and propertyId that identifies the asset property.

      Parameters:
      deleteTimeSeriesRequest -
      Returns:
      A Java Future containing the result of the DeleteTimeSeries 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteTimeSeries

      default CompletableFuture<DeleteTimeSeriesResponse> deleteTimeSeries(Consumer<DeleteTimeSeriesRequest.Builder> deleteTimeSeriesRequest)

      Deletes a time series (data stream). If you delete a time series that's associated with an asset property, the asset property still exists, but the time series will no longer be associated with this asset property.

      To identify a time series, do one of the following:

      • If the time series isn't associated with an asset property, specify the alias of the time series.

      • If the time series is associated with an asset property, specify one of the following:

        • The alias of the time series.

        • The assetId and propertyId that identifies the asset property.


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

      Parameters:
      deleteTimeSeriesRequest - A Consumer that will call methods on DeleteTimeSeriesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteTimeSeries 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAccessPolicy

      default CompletableFuture<DescribeAccessPolicyResponse> describeAccessPolicy(DescribeAccessPolicyRequest describeAccessPolicyRequest)

      Describes an access policy, which specifies an identity's access to an IoT SiteWise Monitor portal or project.

      Parameters:
      describeAccessPolicyRequest -
      Returns:
      A Java Future containing the result of the DescribeAccessPolicy 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAccessPolicy

      default CompletableFuture<DescribeAccessPolicyResponse> describeAccessPolicy(Consumer<DescribeAccessPolicyRequest.Builder> describeAccessPolicyRequest)

      Describes an access policy, which specifies an identity's access to an IoT SiteWise Monitor portal or project.


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

      Parameters:
      describeAccessPolicyRequest - A Consumer that will call methods on DescribeAccessPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeAccessPolicy 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAction

      default CompletableFuture<DescribeActionResponse> describeAction(DescribeActionRequest describeActionRequest)

      Retrieves information about an action.

      Parameters:
      describeActionRequest -
      Returns:
      A Java Future containing the result of the DescribeAction 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAction

      default CompletableFuture<DescribeActionResponse> describeAction(Consumer<DescribeActionRequest.Builder> describeActionRequest)

      Retrieves information about an action.


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

      Parameters:
      describeActionRequest - A Consumer that will call methods on DescribeActionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeAction 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAsset

      default CompletableFuture<DescribeAssetResponse> describeAsset(DescribeAssetRequest describeAssetRequest)

      Retrieves information about an asset.

      Parameters:
      describeAssetRequest -
      Returns:
      A Java Future containing the result of the DescribeAsset 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAsset

      default CompletableFuture<DescribeAssetResponse> describeAsset(Consumer<DescribeAssetRequest.Builder> describeAssetRequest)

      Retrieves information about an asset.


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

      Parameters:
      describeAssetRequest - A Consumer that will call methods on DescribeAssetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeAsset 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAssetCompositeModel

      default CompletableFuture<DescribeAssetCompositeModelResponse> describeAssetCompositeModel(DescribeAssetCompositeModelRequest describeAssetCompositeModelRequest)

      Retrieves information about an asset composite model (also known as an asset component). An AssetCompositeModel is an instance of an AssetModelCompositeModel. If you want to see information about the model this is based on, call DescribeAssetModelCompositeModel.

      Parameters:
      describeAssetCompositeModelRequest -
      Returns:
      A Java Future containing the result of the DescribeAssetCompositeModel 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAssetCompositeModel

      default CompletableFuture<DescribeAssetCompositeModelResponse> describeAssetCompositeModel(Consumer<DescribeAssetCompositeModelRequest.Builder> describeAssetCompositeModelRequest)

      Retrieves information about an asset composite model (also known as an asset component). An AssetCompositeModel is an instance of an AssetModelCompositeModel. If you want to see information about the model this is based on, call DescribeAssetModelCompositeModel.


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

      Parameters:
      describeAssetCompositeModelRequest - A Consumer that will call methods on DescribeAssetCompositeModelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeAssetCompositeModel 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAssetModel

      default CompletableFuture<DescribeAssetModelResponse> describeAssetModel(DescribeAssetModelRequest describeAssetModelRequest)

      Retrieves information about an asset model.

      Parameters:
      describeAssetModelRequest -
      Returns:
      A Java Future containing the result of the DescribeAssetModel 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAssetModel

      default CompletableFuture<DescribeAssetModelResponse> describeAssetModel(Consumer<DescribeAssetModelRequest.Builder> describeAssetModelRequest)

      Retrieves information about an asset model.


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

      Parameters:
      describeAssetModelRequest - A Consumer that will call methods on DescribeAssetModelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeAssetModel 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAssetModelCompositeModel

      default CompletableFuture<DescribeAssetModelCompositeModelResponse> describeAssetModelCompositeModel(DescribeAssetModelCompositeModelRequest describeAssetModelCompositeModelRequest)

      Retrieves information about an asset model composite model (also known as an asset model component). For more information, see Custom composite models (Components) in the IoT SiteWise User Guide.

      Parameters:
      describeAssetModelCompositeModelRequest -
      Returns:
      A Java Future containing the result of the DescribeAssetModelCompositeModel 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAssetModelCompositeModel

      default CompletableFuture<DescribeAssetModelCompositeModelResponse> describeAssetModelCompositeModel(Consumer<DescribeAssetModelCompositeModelRequest.Builder> describeAssetModelCompositeModelRequest)

      Retrieves information about an asset model composite model (also known as an asset model component). For more information, see Custom composite models (Components) in the IoT SiteWise User Guide.


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

      Parameters:
      describeAssetModelCompositeModelRequest - A Consumer that will call methods on DescribeAssetModelCompositeModelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeAssetModelCompositeModel 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAssetProperty

      default CompletableFuture<DescribeAssetPropertyResponse> describeAssetProperty(DescribeAssetPropertyRequest describeAssetPropertyRequest)

      Retrieves information about an asset property.

      When you call this operation for an attribute property, this response includes the default attribute value that you define in the asset model. If you update the default value in the model, this operation's response includes the new default value.

      This operation doesn't return the value of the asset property. To get the value of an asset property, use GetAssetPropertyValue.

      Parameters:
      describeAssetPropertyRequest -
      Returns:
      A Java Future containing the result of the DescribeAssetProperty 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAssetProperty

      default CompletableFuture<DescribeAssetPropertyResponse> describeAssetProperty(Consumer<DescribeAssetPropertyRequest.Builder> describeAssetPropertyRequest)

      Retrieves information about an asset property.

      When you call this operation for an attribute property, this response includes the default attribute value that you define in the asset model. If you update the default value in the model, this operation's response includes the new default value.

      This operation doesn't return the value of the asset property. To get the value of an asset property, use GetAssetPropertyValue.


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

      Parameters:
      describeAssetPropertyRequest - A Consumer that will call methods on DescribeAssetPropertyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeAssetProperty 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeBulkImportJob

      default CompletableFuture<DescribeBulkImportJobResponse> describeBulkImportJob(DescribeBulkImportJobRequest describeBulkImportJobRequest)

      Retrieves information about a bulk import job request. For more information, see Describe a bulk import job (CLI) in the Amazon Simple Storage Service User Guide.

      Parameters:
      describeBulkImportJobRequest -
      Returns:
      A Java Future containing the result of the DescribeBulkImportJob 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeBulkImportJob

      default CompletableFuture<DescribeBulkImportJobResponse> describeBulkImportJob(Consumer<DescribeBulkImportJobRequest.Builder> describeBulkImportJobRequest)

      Retrieves information about a bulk import job request. For more information, see Describe a bulk import job (CLI) in the Amazon Simple Storage Service User Guide.


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

      Parameters:
      describeBulkImportJobRequest - A Consumer that will call methods on DescribeBulkImportJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeBulkImportJob 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeDashboard

      default CompletableFuture<DescribeDashboardResponse> describeDashboard(DescribeDashboardRequest describeDashboardRequest)

      Retrieves information about a dashboard.

      Parameters:
      describeDashboardRequest -
      Returns:
      A Java Future containing the result of the DescribeDashboard 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeDashboard

      default CompletableFuture<DescribeDashboardResponse> describeDashboard(Consumer<DescribeDashboardRequest.Builder> describeDashboardRequest)

      Retrieves information about a dashboard.


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

      Parameters:
      describeDashboardRequest - A Consumer that will call methods on DescribeDashboardRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeDashboard 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeDefaultEncryptionConfiguration

      default CompletableFuture<DescribeDefaultEncryptionConfigurationResponse> describeDefaultEncryptionConfiguration(DescribeDefaultEncryptionConfigurationRequest describeDefaultEncryptionConfigurationRequest)

      Retrieves information about the default encryption configuration for the Amazon Web Services account in the default or specified Region. For more information, see Key management in the IoT SiteWise User Guide.

      Parameters:
      describeDefaultEncryptionConfigurationRequest -
      Returns:
      A Java Future containing the result of the DescribeDefaultEncryptionConfiguration 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeDefaultEncryptionConfiguration

      default CompletableFuture<DescribeDefaultEncryptionConfigurationResponse> describeDefaultEncryptionConfiguration(Consumer<DescribeDefaultEncryptionConfigurationRequest.Builder> describeDefaultEncryptionConfigurationRequest)

      Retrieves information about the default encryption configuration for the Amazon Web Services account in the default or specified Region. For more information, see Key management in the IoT SiteWise User Guide.


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

      Parameters:
      describeDefaultEncryptionConfigurationRequest - A Consumer that will call methods on DescribeDefaultEncryptionConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeDefaultEncryptionConfiguration 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeGateway

      default CompletableFuture<DescribeGatewayResponse> describeGateway(DescribeGatewayRequest describeGatewayRequest)

      Retrieves information about a gateway.

      Parameters:
      describeGatewayRequest -
      Returns:
      A Java Future containing the result of the DescribeGateway 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeGateway

      default CompletableFuture<DescribeGatewayResponse> describeGateway(Consumer<DescribeGatewayRequest.Builder> describeGatewayRequest)

      Retrieves information about a gateway.


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

      Parameters:
      describeGatewayRequest - A Consumer that will call methods on DescribeGatewayRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeGateway 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeGatewayCapabilityConfiguration

      default CompletableFuture<DescribeGatewayCapabilityConfigurationResponse> describeGatewayCapabilityConfiguration(DescribeGatewayCapabilityConfigurationRequest describeGatewayCapabilityConfigurationRequest)

      Retrieves information about a gateway capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway.

      Parameters:
      describeGatewayCapabilityConfigurationRequest -
      Returns:
      A Java Future containing the result of the DescribeGatewayCapabilityConfiguration 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeGatewayCapabilityConfiguration

      default CompletableFuture<DescribeGatewayCapabilityConfigurationResponse> describeGatewayCapabilityConfiguration(Consumer<DescribeGatewayCapabilityConfigurationRequest.Builder> describeGatewayCapabilityConfigurationRequest)

      Retrieves information about a gateway capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway.


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

      Parameters:
      describeGatewayCapabilityConfigurationRequest - A Consumer that will call methods on DescribeGatewayCapabilityConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeGatewayCapabilityConfiguration 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeLoggingOptions

      default CompletableFuture<DescribeLoggingOptionsResponse> describeLoggingOptions(DescribeLoggingOptionsRequest describeLoggingOptionsRequest)

      Retrieves the current IoT SiteWise logging options.

      Parameters:
      describeLoggingOptionsRequest -
      Returns:
      A Java Future containing the result of the DescribeLoggingOptions 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeLoggingOptions

      default CompletableFuture<DescribeLoggingOptionsResponse> describeLoggingOptions(Consumer<DescribeLoggingOptionsRequest.Builder> describeLoggingOptionsRequest)

      Retrieves the current IoT SiteWise logging options.


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

      Parameters:
      describeLoggingOptionsRequest - A Consumer that will call methods on DescribeLoggingOptionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeLoggingOptions 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describePortal

      default CompletableFuture<DescribePortalResponse> describePortal(DescribePortalRequest describePortalRequest)

      Retrieves information about a portal.

      Parameters:
      describePortalRequest -
      Returns:
      A Java Future containing the result of the DescribePortal 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describePortal

      default CompletableFuture<DescribePortalResponse> describePortal(Consumer<DescribePortalRequest.Builder> describePortalRequest)

      Retrieves information about a portal.


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

      Parameters:
      describePortalRequest - A Consumer that will call methods on DescribePortalRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribePortal 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeProject

      default CompletableFuture<DescribeProjectResponse> describeProject(DescribeProjectRequest describeProjectRequest)

      Retrieves information about a project.

      Parameters:
      describeProjectRequest -
      Returns:
      A Java Future containing the result of the DescribeProject 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeProject

      default CompletableFuture<DescribeProjectResponse> describeProject(Consumer<DescribeProjectRequest.Builder> describeProjectRequest)

      Retrieves information about a project.


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

      Parameters:
      describeProjectRequest - A Consumer that will call methods on DescribeProjectRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeProject 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeStorageConfiguration

      default CompletableFuture<DescribeStorageConfigurationResponse> describeStorageConfiguration(DescribeStorageConfigurationRequest describeStorageConfigurationRequest)

      Retrieves information about the storage configuration for IoT SiteWise.

      Parameters:
      describeStorageConfigurationRequest -
      Returns:
      A Java Future containing the result of the DescribeStorageConfiguration 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • LimitExceededException You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeStorageConfiguration

      default CompletableFuture<DescribeStorageConfigurationResponse> describeStorageConfiguration(Consumer<DescribeStorageConfigurationRequest.Builder> describeStorageConfigurationRequest)

      Retrieves information about the storage configuration for IoT SiteWise.


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

      Parameters:
      describeStorageConfigurationRequest - A Consumer that will call methods on DescribeStorageConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeStorageConfiguration 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • LimitExceededException You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeTimeSeries

      default CompletableFuture<DescribeTimeSeriesResponse> describeTimeSeries(DescribeTimeSeriesRequest describeTimeSeriesRequest)

      Retrieves information about a time series (data stream).

      To identify a time series, do one of the following:

      • If the time series isn't associated with an asset property, specify the alias of the time series.

      • If the time series is associated with an asset property, specify one of the following:

        • The alias of the time series.

        • The assetId and propertyId that identifies the asset property.

      Parameters:
      describeTimeSeriesRequest -
      Returns:
      A Java Future containing the result of the DescribeTimeSeries 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeTimeSeries

      default CompletableFuture<DescribeTimeSeriesResponse> describeTimeSeries(Consumer<DescribeTimeSeriesRequest.Builder> describeTimeSeriesRequest)

      Retrieves information about a time series (data stream).

      To identify a time series, do one of the following:

      • If the time series isn't associated with an asset property, specify the alias of the time series.

      • If the time series is associated with an asset property, specify one of the following:

        • The alias of the time series.

        • The assetId and propertyId that identifies the asset property.


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

      Parameters:
      describeTimeSeriesRequest - A Consumer that will call methods on DescribeTimeSeriesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeTimeSeries 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateAssets

      default CompletableFuture<DisassociateAssetsResponse> disassociateAssets(DisassociateAssetsRequest disassociateAssetsRequest)

      Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model.

      Parameters:
      disassociateAssetsRequest -
      Returns:
      A Java Future containing the result of the DisassociateAssets 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateAssets

      default CompletableFuture<DisassociateAssetsResponse> disassociateAssets(Consumer<DisassociateAssetsRequest.Builder> disassociateAssetsRequest)

      Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model.


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

      Parameters:
      disassociateAssetsRequest - A Consumer that will call methods on DisassociateAssetsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisassociateAssets 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateTimeSeriesFromAssetProperty

      default CompletableFuture<DisassociateTimeSeriesFromAssetPropertyResponse> disassociateTimeSeriesFromAssetProperty(DisassociateTimeSeriesFromAssetPropertyRequest disassociateTimeSeriesFromAssetPropertyRequest)

      Disassociates a time series (data stream) from an asset property.

      Parameters:
      disassociateTimeSeriesFromAssetPropertyRequest -
      Returns:
      A Java Future containing the result of the DisassociateTimeSeriesFromAssetProperty 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateTimeSeriesFromAssetProperty

      default CompletableFuture<DisassociateTimeSeriesFromAssetPropertyResponse> disassociateTimeSeriesFromAssetProperty(Consumer<DisassociateTimeSeriesFromAssetPropertyRequest.Builder> disassociateTimeSeriesFromAssetPropertyRequest)

      Disassociates a time series (data stream) from an asset property.


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

      Parameters:
      disassociateTimeSeriesFromAssetPropertyRequest - A Consumer that will call methods on DisassociateTimeSeriesFromAssetPropertyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisassociateTimeSeriesFromAssetProperty 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • executeAction

      default CompletableFuture<ExecuteActionResponse> executeAction(ExecuteActionRequest executeActionRequest)

      Executes an action on a target resource.

      Parameters:
      executeActionRequest -
      Returns:
      A Java Future containing the result of the ExecuteAction 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • LimitExceededException You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • executeAction

      default CompletableFuture<ExecuteActionResponse> executeAction(Consumer<ExecuteActionRequest.Builder> executeActionRequest)

      Executes an action on a target resource.


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

      Parameters:
      executeActionRequest - A Consumer that will call methods on ExecuteActionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ExecuteAction 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • LimitExceededException You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • executeQuery

      default CompletableFuture<ExecuteQueryResponse> executeQuery(ExecuteQueryRequest executeQueryRequest)

      Run SQL queries to retrieve metadata and time-series data from asset models, assets, measurements, metrics, transforms, and aggregates.

      Parameters:
      executeQueryRequest -
      Returns:
      A Java Future containing the result of the ExecuteQuery operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • AccessDeniedException Access is denied.
      • ValidationException The validation failed for this query.
      • QueryTimeoutException The query timed out.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ServiceUnavailableException The requested service is unavailable.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • executeQuery

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

      Run SQL queries to retrieve metadata and time-series data from asset models, assets, measurements, metrics, transforms, and aggregates.


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

      Parameters:
      executeQueryRequest - A Consumer that will call methods on ExecuteQueryRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ExecuteQuery operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • AccessDeniedException Access is denied.
      • ValidationException The validation failed for this query.
      • QueryTimeoutException The query timed out.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ServiceUnavailableException The requested service is unavailable.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • executeQueryPaginator

      default ExecuteQueryPublisher executeQueryPaginator(ExecuteQueryRequest executeQueryRequest)

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

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

      The following are few ways to use the response class:

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

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

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

      Parameters:
      executeQueryRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • AccessDeniedException Access is denied.
      • ValidationException The validation failed for this query.
      • QueryTimeoutException The query timed out.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ServiceUnavailableException The requested service is unavailable.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • executeQueryPaginator

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

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

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

      The following are few ways to use the response class:

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

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

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


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

      Parameters:
      executeQueryRequest - A Consumer that will call methods on ExecuteQueryRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • AccessDeniedException Access is denied.
      • ValidationException The validation failed for this query.
      • QueryTimeoutException The query timed out.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ServiceUnavailableException The requested service is unavailable.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAssetPropertyAggregates

      default CompletableFuture<GetAssetPropertyAggregatesResponse> getAssetPropertyAggregates(GetAssetPropertyAggregatesRequest getAssetPropertyAggregatesRequest)

      Gets aggregated values for an asset property. For more information, see Querying aggregates in the IoT SiteWise User Guide.

      To identify an asset property, you must specify one of the following:

      • The assetId and propertyId of an asset property.

      • A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.

      Parameters:
      getAssetPropertyAggregatesRequest -
      Returns:
      A Java Future containing the result of the GetAssetPropertyAggregates 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ServiceUnavailableException The requested service is unavailable.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAssetPropertyAggregates

      default CompletableFuture<GetAssetPropertyAggregatesResponse> getAssetPropertyAggregates(Consumer<GetAssetPropertyAggregatesRequest.Builder> getAssetPropertyAggregatesRequest)

      Gets aggregated values for an asset property. For more information, see Querying aggregates in the IoT SiteWise User Guide.

      To identify an asset property, you must specify one of the following:

      • The assetId and propertyId of an asset property.

      • A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.


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

      Parameters:
      getAssetPropertyAggregatesRequest - A Consumer that will call methods on GetAssetPropertyAggregatesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetAssetPropertyAggregates 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ServiceUnavailableException The requested service is unavailable.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAssetPropertyAggregatesPaginator

      default GetAssetPropertyAggregatesPublisher getAssetPropertyAggregatesPaginator(GetAssetPropertyAggregatesRequest getAssetPropertyAggregatesRequest)

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

      Parameters:
      getAssetPropertyAggregatesRequest -
      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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ServiceUnavailableException The requested service is unavailable.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAssetPropertyAggregatesPaginator

      default GetAssetPropertyAggregatesPublisher getAssetPropertyAggregatesPaginator(Consumer<GetAssetPropertyAggregatesRequest.Builder> getAssetPropertyAggregatesRequest)

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


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

      Parameters:
      getAssetPropertyAggregatesRequest - A Consumer that will call methods on GetAssetPropertyAggregatesRequest.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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ServiceUnavailableException The requested service is unavailable.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAssetPropertyValue

      default CompletableFuture<GetAssetPropertyValueResponse> getAssetPropertyValue(GetAssetPropertyValueRequest getAssetPropertyValueRequest)

      Gets an asset property's current value. For more information, see Querying current values in the IoT SiteWise User Guide.

      To identify an asset property, you must specify one of the following:

      • The assetId and propertyId of an asset property.

      • A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.

      Parameters:
      getAssetPropertyValueRequest -
      Returns:
      A Java Future containing the result of the GetAssetPropertyValue 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ServiceUnavailableException The requested service is unavailable.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAssetPropertyValue

      default CompletableFuture<GetAssetPropertyValueResponse> getAssetPropertyValue(Consumer<GetAssetPropertyValueRequest.Builder> getAssetPropertyValueRequest)

      Gets an asset property's current value. For more information, see Querying current values in the IoT SiteWise User Guide.

      To identify an asset property, you must specify one of the following:

      • The assetId and propertyId of an asset property.

      • A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.


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

      Parameters:
      getAssetPropertyValueRequest - A Consumer that will call methods on GetAssetPropertyValueRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetAssetPropertyValue 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ServiceUnavailableException The requested service is unavailable.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAssetPropertyValueHistory

      default CompletableFuture<GetAssetPropertyValueHistoryResponse> getAssetPropertyValueHistory(GetAssetPropertyValueHistoryRequest getAssetPropertyValueHistoryRequest)

      Gets the history of an asset property's values. For more information, see Querying historical values in the IoT SiteWise User Guide.

      To identify an asset property, you must specify one of the following:

      • The assetId and propertyId of an asset property.

      • A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.

      Parameters:
      getAssetPropertyValueHistoryRequest -
      Returns:
      A Java Future containing the result of the GetAssetPropertyValueHistory 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ServiceUnavailableException The requested service is unavailable.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAssetPropertyValueHistory

      default CompletableFuture<GetAssetPropertyValueHistoryResponse> getAssetPropertyValueHistory(Consumer<GetAssetPropertyValueHistoryRequest.Builder> getAssetPropertyValueHistoryRequest)

      Gets the history of an asset property's values. For more information, see Querying historical values in the IoT SiteWise User Guide.

      To identify an asset property, you must specify one of the following:

      • The assetId and propertyId of an asset property.

      • A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.


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

      Parameters:
      getAssetPropertyValueHistoryRequest - A Consumer that will call methods on GetAssetPropertyValueHistoryRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetAssetPropertyValueHistory 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ServiceUnavailableException The requested service is unavailable.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAssetPropertyValueHistoryPaginator

      default GetAssetPropertyValueHistoryPublisher getAssetPropertyValueHistoryPaginator(GetAssetPropertyValueHistoryRequest getAssetPropertyValueHistoryRequest)

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

      Parameters:
      getAssetPropertyValueHistoryRequest -
      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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ServiceUnavailableException The requested service is unavailable.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAssetPropertyValueHistoryPaginator

      default GetAssetPropertyValueHistoryPublisher getAssetPropertyValueHistoryPaginator(Consumer<GetAssetPropertyValueHistoryRequest.Builder> getAssetPropertyValueHistoryRequest)

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


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

      Parameters:
      getAssetPropertyValueHistoryRequest - A Consumer that will call methods on GetAssetPropertyValueHistoryRequest.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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ServiceUnavailableException The requested service is unavailable.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInterpolatedAssetPropertyValues

      default CompletableFuture<GetInterpolatedAssetPropertyValuesResponse> getInterpolatedAssetPropertyValues(GetInterpolatedAssetPropertyValuesRequest getInterpolatedAssetPropertyValuesRequest)

      Get interpolated values for an asset property for a specified time interval, during a period of time. If your time series is missing data points during the specified time interval, you can use interpolation to estimate the missing data.

      For example, you can use this operation to return the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days.

      To identify an asset property, you must specify one of the following:

      • The assetId and propertyId of an asset property.

      • A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.

      Parameters:
      getInterpolatedAssetPropertyValuesRequest -
      Returns:
      A Java Future containing the result of the GetInterpolatedAssetPropertyValues 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ServiceUnavailableException The requested service is unavailable.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInterpolatedAssetPropertyValues

      default CompletableFuture<GetInterpolatedAssetPropertyValuesResponse> getInterpolatedAssetPropertyValues(Consumer<GetInterpolatedAssetPropertyValuesRequest.Builder> getInterpolatedAssetPropertyValuesRequest)

      Get interpolated values for an asset property for a specified time interval, during a period of time. If your time series is missing data points during the specified time interval, you can use interpolation to estimate the missing data.

      For example, you can use this operation to return the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days.

      To identify an asset property, you must specify one of the following:

      • The assetId and propertyId of an asset property.

      • A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.


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

      Parameters:
      getInterpolatedAssetPropertyValuesRequest - A Consumer that will call methods on GetInterpolatedAssetPropertyValuesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetInterpolatedAssetPropertyValues 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ServiceUnavailableException The requested service is unavailable.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInterpolatedAssetPropertyValuesPaginator

      default GetInterpolatedAssetPropertyValuesPublisher getInterpolatedAssetPropertyValuesPaginator(GetInterpolatedAssetPropertyValuesRequest getInterpolatedAssetPropertyValuesRequest)

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

      Parameters:
      getInterpolatedAssetPropertyValuesRequest -
      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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ServiceUnavailableException The requested service is unavailable.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInterpolatedAssetPropertyValuesPaginator

      default GetInterpolatedAssetPropertyValuesPublisher getInterpolatedAssetPropertyValuesPaginator(Consumer<GetInterpolatedAssetPropertyValuesRequest.Builder> getInterpolatedAssetPropertyValuesRequest)

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


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

      Parameters:
      getInterpolatedAssetPropertyValuesRequest - A Consumer that will call methods on GetInterpolatedAssetPropertyValuesRequest.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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ServiceUnavailableException The requested service is unavailable.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAccessPolicies

      default CompletableFuture<ListAccessPoliciesResponse> listAccessPolicies(ListAccessPoliciesRequest listAccessPoliciesRequest)

      Retrieves a paginated list of access policies for an identity (an IAM Identity Center user, an IAM Identity Center group, or an IAM user) or an IoT SiteWise Monitor resource (a portal or project).

      Parameters:
      listAccessPoliciesRequest -
      Returns:
      A Java Future containing the result of the ListAccessPolicies 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAccessPolicies

      default CompletableFuture<ListAccessPoliciesResponse> listAccessPolicies(Consumer<ListAccessPoliciesRequest.Builder> listAccessPoliciesRequest)

      Retrieves a paginated list of access policies for an identity (an IAM Identity Center user, an IAM Identity Center group, or an IAM user) or an IoT SiteWise Monitor resource (a portal or project).


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

      Parameters:
      listAccessPoliciesRequest - A Consumer that will call methods on ListAccessPoliciesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAccessPolicies 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAccessPoliciesPaginator

      default ListAccessPoliciesPublisher listAccessPoliciesPaginator(ListAccessPoliciesRequest listAccessPoliciesRequest)

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

      Parameters:
      listAccessPoliciesRequest -
      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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAccessPoliciesPaginator

      default ListAccessPoliciesPublisher listAccessPoliciesPaginator(Consumer<ListAccessPoliciesRequest.Builder> listAccessPoliciesRequest)

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


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

      Parameters:
      listAccessPoliciesRequest - A Consumer that will call methods on ListAccessPoliciesRequest.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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listActions

      default CompletableFuture<ListActionsResponse> listActions(ListActionsRequest listActionsRequest)

      Retrieves a paginated list of actions for a specific target resource.

      Parameters:
      listActionsRequest -
      Returns:
      A Java Future containing the result of the ListActions 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listActions

      default CompletableFuture<ListActionsResponse> listActions(Consumer<ListActionsRequest.Builder> listActionsRequest)

      Retrieves a paginated list of actions for a specific target resource.


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

      Parameters:
      listActionsRequest - A Consumer that will call methods on ListActionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListActions 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listActionsPaginator

      default ListActionsPublisher listActionsPaginator(ListActionsRequest listActionsRequest)

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

      Parameters:
      listActionsRequest -
      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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listActionsPaginator

      default ListActionsPublisher listActionsPaginator(Consumer<ListActionsRequest.Builder> listActionsRequest)

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


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

      Parameters:
      listActionsRequest - A Consumer that will call methods on ListActionsRequest.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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAssetModelCompositeModels

      default CompletableFuture<ListAssetModelCompositeModelsResponse> listAssetModelCompositeModels(ListAssetModelCompositeModelsRequest listAssetModelCompositeModelsRequest)

      Retrieves a paginated list of composite models associated with the asset model

      Parameters:
      listAssetModelCompositeModelsRequest -
      Returns:
      A Java Future containing the result of the ListAssetModelCompositeModels 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ResourceNotFoundException The requested resource can't be found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAssetModelCompositeModels

      default CompletableFuture<ListAssetModelCompositeModelsResponse> listAssetModelCompositeModels(Consumer<ListAssetModelCompositeModelsRequest.Builder> listAssetModelCompositeModelsRequest)

      Retrieves a paginated list of composite models associated with the asset model


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

      Parameters:
      listAssetModelCompositeModelsRequest - A Consumer that will call methods on ListAssetModelCompositeModelsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAssetModelCompositeModels 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ResourceNotFoundException The requested resource can't be found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAssetModelCompositeModelsPaginator

      default ListAssetModelCompositeModelsPublisher listAssetModelCompositeModelsPaginator(ListAssetModelCompositeModelsRequest listAssetModelCompositeModelsRequest)

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

      Parameters:
      listAssetModelCompositeModelsRequest -
      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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ResourceNotFoundException The requested resource can't be found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAssetModelCompositeModelsPaginator

      default ListAssetModelCompositeModelsPublisher listAssetModelCompositeModelsPaginator(Consumer<ListAssetModelCompositeModelsRequest.Builder> listAssetModelCompositeModelsRequest)

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


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

      Parameters:
      listAssetModelCompositeModelsRequest - A Consumer that will call methods on ListAssetModelCompositeModelsRequest.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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ResourceNotFoundException The requested resource can't be found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAssetModelProperties

      default CompletableFuture<ListAssetModelPropertiesResponse> listAssetModelProperties(ListAssetModelPropertiesRequest listAssetModelPropertiesRequest)

      Retrieves a paginated list of properties associated with an asset model. If you update properties associated with the model before you finish listing all the properties, you need to start all over again.

      Parameters:
      listAssetModelPropertiesRequest -
      Returns:
      A Java Future containing the result of the ListAssetModelProperties 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAssetModelProperties

      default CompletableFuture<ListAssetModelPropertiesResponse> listAssetModelProperties(Consumer<ListAssetModelPropertiesRequest.Builder> listAssetModelPropertiesRequest)

      Retrieves a paginated list of properties associated with an asset model. If you update properties associated with the model before you finish listing all the properties, you need to start all over again.


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

      Parameters:
      listAssetModelPropertiesRequest - A Consumer that will call methods on ListAssetModelPropertiesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAssetModelProperties 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAssetModelPropertiesPaginator

      default ListAssetModelPropertiesPublisher listAssetModelPropertiesPaginator(ListAssetModelPropertiesRequest listAssetModelPropertiesRequest)

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

      Parameters:
      listAssetModelPropertiesRequest -
      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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAssetModelPropertiesPaginator

      default ListAssetModelPropertiesPublisher listAssetModelPropertiesPaginator(Consumer<ListAssetModelPropertiesRequest.Builder> listAssetModelPropertiesRequest)

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


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

      Parameters:
      listAssetModelPropertiesRequest - A Consumer that will call methods on ListAssetModelPropertiesRequest.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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAssetModels

      default CompletableFuture<ListAssetModelsResponse> listAssetModels(ListAssetModelsRequest listAssetModelsRequest)

      Retrieves a paginated list of summaries of all asset models.

      Parameters:
      listAssetModelsRequest -
      Returns:
      A Java Future containing the result of the ListAssetModels 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAssetModels

      default CompletableFuture<ListAssetModelsResponse> listAssetModels(Consumer<ListAssetModelsRequest.Builder> listAssetModelsRequest)

      Retrieves a paginated list of summaries of all asset models.


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

      Parameters:
      listAssetModelsRequest - A Consumer that will call methods on ListAssetModelsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAssetModels 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAssetModelsPaginator

      default ListAssetModelsPublisher listAssetModelsPaginator(ListAssetModelsRequest listAssetModelsRequest)

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

      Parameters:
      listAssetModelsRequest -
      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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAssetModelsPaginator

      default ListAssetModelsPublisher listAssetModelsPaginator(Consumer<ListAssetModelsRequest.Builder> listAssetModelsRequest)

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


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

      Parameters:
      listAssetModelsRequest - A Consumer that will call methods on ListAssetModelsRequest.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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAssetProperties

      default CompletableFuture<ListAssetPropertiesResponse> listAssetProperties(ListAssetPropertiesRequest listAssetPropertiesRequest)

      Retrieves a paginated list of properties associated with an asset. If you update properties associated with the model before you finish listing all the properties, you need to start all over again.

      Parameters:
      listAssetPropertiesRequest -
      Returns:
      A Java Future containing the result of the ListAssetProperties 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAssetProperties

      default CompletableFuture<ListAssetPropertiesResponse> listAssetProperties(Consumer<ListAssetPropertiesRequest.Builder> listAssetPropertiesRequest)

      Retrieves a paginated list of properties associated with an asset. If you update properties associated with the model before you finish listing all the properties, you need to start all over again.


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

      Parameters:
      listAssetPropertiesRequest - A Consumer that will call methods on ListAssetPropertiesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAssetProperties 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAssetPropertiesPaginator

      default ListAssetPropertiesPublisher listAssetPropertiesPaginator(ListAssetPropertiesRequest listAssetPropertiesRequest)

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

      Parameters:
      listAssetPropertiesRequest -
      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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAssetPropertiesPaginator

      default ListAssetPropertiesPublisher listAssetPropertiesPaginator(Consumer<ListAssetPropertiesRequest.Builder> listAssetPropertiesRequest)

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


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

      Parameters:
      listAssetPropertiesRequest - A Consumer that will call methods on ListAssetPropertiesRequest.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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAssetRelationships

      default CompletableFuture<ListAssetRelationshipsResponse> listAssetRelationships(ListAssetRelationshipsRequest listAssetRelationshipsRequest)

      Retrieves a paginated list of asset relationships for an asset. You can use this operation to identify an asset's root asset and all associated assets between that asset and its root.

      Parameters:
      listAssetRelationshipsRequest -
      Returns:
      A Java Future containing the result of the ListAssetRelationships 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAssetRelationships

      default CompletableFuture<ListAssetRelationshipsResponse> listAssetRelationships(Consumer<ListAssetRelationshipsRequest.Builder> listAssetRelationshipsRequest)

      Retrieves a paginated list of asset relationships for an asset. You can use this operation to identify an asset's root asset and all associated assets between that asset and its root.


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

      Parameters:
      listAssetRelationshipsRequest - A Consumer that will call methods on ListAssetRelationshipsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAssetRelationships 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAssetRelationshipsPaginator

      default ListAssetRelationshipsPublisher listAssetRelationshipsPaginator(ListAssetRelationshipsRequest listAssetRelationshipsRequest)

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

      Parameters:
      listAssetRelationshipsRequest -
      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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAssetRelationshipsPaginator

      default ListAssetRelationshipsPublisher listAssetRelationshipsPaginator(Consumer<ListAssetRelationshipsRequest.Builder> listAssetRelationshipsRequest)

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


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

      Parameters:
      listAssetRelationshipsRequest - A Consumer that will call methods on ListAssetRelationshipsRequest.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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAssets

      default CompletableFuture<ListAssetsResponse> listAssets(ListAssetsRequest listAssetsRequest)

      Retrieves a paginated list of asset summaries.

      You can use this operation to do the following:

      • List assets based on a specific asset model.

      • List top-level assets.

      You can't use this operation to list all assets. To retrieve summaries for all of your assets, use ListAssetModels to get all of your asset model IDs. Then, use ListAssets to get all assets for each asset model.

      Parameters:
      listAssetsRequest -
      Returns:
      A Java Future containing the result of the ListAssets 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAssets

      default CompletableFuture<ListAssetsResponse> listAssets(Consumer<ListAssetsRequest.Builder> listAssetsRequest)

      Retrieves a paginated list of asset summaries.

      You can use this operation to do the following:

      • List assets based on a specific asset model.

      • List top-level assets.

      You can't use this operation to list all assets. To retrieve summaries for all of your assets, use ListAssetModels to get all of your asset model IDs. Then, use ListAssets to get all assets for each asset model.


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

      Parameters:
      listAssetsRequest - A Consumer that will call methods on ListAssetsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAssets 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAssetsPaginator

      default ListAssetsPublisher listAssetsPaginator(ListAssetsRequest listAssetsRequest)

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

      Parameters:
      listAssetsRequest -
      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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAssetsPaginator

      default ListAssetsPublisher listAssetsPaginator(Consumer<ListAssetsRequest.Builder> listAssetsRequest)

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


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

      Parameters:
      listAssetsRequest - A Consumer that will call methods on ListAssetsRequest.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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAssociatedAssets

      default CompletableFuture<ListAssociatedAssetsResponse> listAssociatedAssets(ListAssociatedAssetsRequest listAssociatedAssetsRequest)

      Retrieves a paginated list of associated assets.

      You can use this operation to do the following:

      • CHILD - List all child assets associated to the asset.

      • PARENT - List the asset's parent asset.

      Parameters:
      listAssociatedAssetsRequest -
      Returns:
      A Java Future containing the result of the ListAssociatedAssets 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAssociatedAssets

      default CompletableFuture<ListAssociatedAssetsResponse> listAssociatedAssets(Consumer<ListAssociatedAssetsRequest.Builder> listAssociatedAssetsRequest)

      Retrieves a paginated list of associated assets.

      You can use this operation to do the following:

      • CHILD - List all child assets associated to the asset.

      • PARENT - List the asset's parent asset.


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

      Parameters:
      listAssociatedAssetsRequest - A Consumer that will call methods on ListAssociatedAssetsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAssociatedAssets 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAssociatedAssetsPaginator

      default ListAssociatedAssetsPublisher listAssociatedAssetsPaginator(ListAssociatedAssetsRequest listAssociatedAssetsRequest)

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

      Parameters:
      listAssociatedAssetsRequest -
      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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAssociatedAssetsPaginator

      default ListAssociatedAssetsPublisher listAssociatedAssetsPaginator(Consumer<ListAssociatedAssetsRequest.Builder> listAssociatedAssetsRequest)

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


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

      Parameters:
      listAssociatedAssetsRequest - A Consumer that will call methods on ListAssociatedAssetsRequest.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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBulkImportJobs

      default CompletableFuture<ListBulkImportJobsResponse> listBulkImportJobs(ListBulkImportJobsRequest listBulkImportJobsRequest)

      Retrieves a paginated list of bulk import job requests. For more information, see List bulk import jobs (CLI) in the IoT SiteWise User Guide.

      Parameters:
      listBulkImportJobsRequest -
      Returns:
      A Java Future containing the result of the ListBulkImportJobs 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBulkImportJobs

      default CompletableFuture<ListBulkImportJobsResponse> listBulkImportJobs(Consumer<ListBulkImportJobsRequest.Builder> listBulkImportJobsRequest)

      Retrieves a paginated list of bulk import job requests. For more information, see List bulk import jobs (CLI) in the IoT SiteWise User Guide.


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

      Parameters:
      listBulkImportJobsRequest - A Consumer that will call methods on ListBulkImportJobsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListBulkImportJobs 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBulkImportJobsPaginator

      default ListBulkImportJobsPublisher listBulkImportJobsPaginator(ListBulkImportJobsRequest listBulkImportJobsRequest)

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

      Parameters:
      listBulkImportJobsRequest -
      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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBulkImportJobsPaginator

      default ListBulkImportJobsPublisher listBulkImportJobsPaginator(Consumer<ListBulkImportJobsRequest.Builder> listBulkImportJobsRequest)

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


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

      Parameters:
      listBulkImportJobsRequest - A Consumer that will call methods on ListBulkImportJobsRequest.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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCompositionRelationships

      default CompletableFuture<ListCompositionRelationshipsResponse> listCompositionRelationships(ListCompositionRelationshipsRequest listCompositionRelationshipsRequest)

      Retrieves a paginated list of composition relationships for an asset model of type COMPONENT_MODEL.

      Parameters:
      listCompositionRelationshipsRequest -
      Returns:
      A Java Future containing the result of the ListCompositionRelationships 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCompositionRelationships

      default CompletableFuture<ListCompositionRelationshipsResponse> listCompositionRelationships(Consumer<ListCompositionRelationshipsRequest.Builder> listCompositionRelationshipsRequest)

      Retrieves a paginated list of composition relationships for an asset model of type COMPONENT_MODEL.


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

      Parameters:
      listCompositionRelationshipsRequest - A Consumer that will call methods on ListCompositionRelationshipsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListCompositionRelationships 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCompositionRelationshipsPaginator

      default ListCompositionRelationshipsPublisher listCompositionRelationshipsPaginator(ListCompositionRelationshipsRequest listCompositionRelationshipsRequest)

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

      Parameters:
      listCompositionRelationshipsRequest -
      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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCompositionRelationshipsPaginator

      default ListCompositionRelationshipsPublisher listCompositionRelationshipsPaginator(Consumer<ListCompositionRelationshipsRequest.Builder> listCompositionRelationshipsRequest)

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


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

      Parameters:
      listCompositionRelationshipsRequest - A Consumer that will call methods on ListCompositionRelationshipsRequest.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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDashboards

      default CompletableFuture<ListDashboardsResponse> listDashboards(ListDashboardsRequest listDashboardsRequest)

      Retrieves a paginated list of dashboards for an IoT SiteWise Monitor project.

      Parameters:
      listDashboardsRequest -
      Returns:
      A Java Future containing the result of the ListDashboards 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDashboards

      default CompletableFuture<ListDashboardsResponse> listDashboards(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest)

      Retrieves a paginated list of dashboards for an IoT SiteWise Monitor project.


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

      Parameters:
      listDashboardsRequest - A Consumer that will call methods on ListDashboardsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListDashboards 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDashboardsPaginator

      default ListDashboardsPublisher listDashboardsPaginator(ListDashboardsRequest listDashboardsRequest)

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

      Parameters:
      listDashboardsRequest -
      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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDashboardsPaginator

      default ListDashboardsPublisher listDashboardsPaginator(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest)

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


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

      Parameters:
      listDashboardsRequest - A Consumer that will call methods on ListDashboardsRequest.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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listGateways

      default CompletableFuture<ListGatewaysResponse> listGateways(ListGatewaysRequest listGatewaysRequest)

      Retrieves a paginated list of gateways.

      Parameters:
      listGatewaysRequest -
      Returns:
      A Java Future containing the result of the ListGateways 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listGateways

      default CompletableFuture<ListGatewaysResponse> listGateways(Consumer<ListGatewaysRequest.Builder> listGatewaysRequest)

      Retrieves a paginated list of gateways.


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

      Parameters:
      listGatewaysRequest - A Consumer that will call methods on ListGatewaysRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListGateways 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listGatewaysPaginator

      default ListGatewaysPublisher listGatewaysPaginator(ListGatewaysRequest listGatewaysRequest)

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

      Parameters:
      listGatewaysRequest -
      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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listGatewaysPaginator

      default ListGatewaysPublisher listGatewaysPaginator(Consumer<ListGatewaysRequest.Builder> listGatewaysRequest)

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


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

      Parameters:
      listGatewaysRequest - A Consumer that will call methods on ListGatewaysRequest.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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPortals

      default CompletableFuture<ListPortalsResponse> listPortals(ListPortalsRequest listPortalsRequest)

      Retrieves a paginated list of IoT SiteWise Monitor portals.

      Parameters:
      listPortalsRequest -
      Returns:
      A Java Future containing the result of the ListPortals 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPortals

      default CompletableFuture<ListPortalsResponse> listPortals(Consumer<ListPortalsRequest.Builder> listPortalsRequest)

      Retrieves a paginated list of IoT SiteWise Monitor portals.


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

      Parameters:
      listPortalsRequest - A Consumer that will call methods on ListPortalsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListPortals 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPortalsPaginator

      default ListPortalsPublisher listPortalsPaginator(ListPortalsRequest listPortalsRequest)

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

      Parameters:
      listPortalsRequest -
      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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPortalsPaginator

      default ListPortalsPublisher listPortalsPaginator(Consumer<ListPortalsRequest.Builder> listPortalsRequest)

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


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

      Parameters:
      listPortalsRequest - A Consumer that will call methods on ListPortalsRequest.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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listProjectAssets

      default CompletableFuture<ListProjectAssetsResponse> listProjectAssets(ListProjectAssetsRequest listProjectAssetsRequest)

      Retrieves a paginated list of assets associated with an IoT SiteWise Monitor project.

      Parameters:
      listProjectAssetsRequest -
      Returns:
      A Java Future containing the result of the ListProjectAssets 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listProjectAssets

      default CompletableFuture<ListProjectAssetsResponse> listProjectAssets(Consumer<ListProjectAssetsRequest.Builder> listProjectAssetsRequest)

      Retrieves a paginated list of assets associated with an IoT SiteWise Monitor project.


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

      Parameters:
      listProjectAssetsRequest - A Consumer that will call methods on ListProjectAssetsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListProjectAssets 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listProjectAssetsPaginator

      default ListProjectAssetsPublisher listProjectAssetsPaginator(ListProjectAssetsRequest listProjectAssetsRequest)

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

      Parameters:
      listProjectAssetsRequest -
      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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listProjectAssetsPaginator

      default ListProjectAssetsPublisher listProjectAssetsPaginator(Consumer<ListProjectAssetsRequest.Builder> listProjectAssetsRequest)

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


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

      Parameters:
      listProjectAssetsRequest - A Consumer that will call methods on ListProjectAssetsRequest.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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listProjects

      default CompletableFuture<ListProjectsResponse> listProjects(ListProjectsRequest listProjectsRequest)

      Retrieves a paginated list of projects for an IoT SiteWise Monitor portal.

      Parameters:
      listProjectsRequest -
      Returns:
      A Java Future containing the result of the ListProjects 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listProjects

      default CompletableFuture<ListProjectsResponse> listProjects(Consumer<ListProjectsRequest.Builder> listProjectsRequest)

      Retrieves a paginated list of projects for an IoT SiteWise Monitor portal.


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

      Parameters:
      listProjectsRequest - A Consumer that will call methods on ListProjectsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListProjects 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listProjectsPaginator

      default ListProjectsPublisher listProjectsPaginator(ListProjectsRequest listProjectsRequest)

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

      Parameters:
      listProjectsRequest -
      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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listProjectsPaginator

      default ListProjectsPublisher listProjectsPaginator(Consumer<ListProjectsRequest.Builder> listProjectsRequest)

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


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

      Parameters:
      listProjectsRequest - A Consumer that will call methods on ListProjectsRequest.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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

      Retrieves the list of tags for an IoT SiteWise 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ResourceNotFoundException The requested resource can't be found.
      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • LimitExceededException You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • UnauthorizedException You are not authorized.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

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

      Retrieves the list of tags for an IoT SiteWise 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ResourceNotFoundException The requested resource can't be found.
      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • LimitExceededException You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • UnauthorizedException You are not authorized.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTimeSeries

      default CompletableFuture<ListTimeSeriesResponse> listTimeSeries(ListTimeSeriesRequest listTimeSeriesRequest)

      Retrieves a paginated list of time series (data streams).

      Parameters:
      listTimeSeriesRequest -
      Returns:
      A Java Future containing the result of the ListTimeSeries 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTimeSeries

      default CompletableFuture<ListTimeSeriesResponse> listTimeSeries(Consumer<ListTimeSeriesRequest.Builder> listTimeSeriesRequest)

      Retrieves a paginated list of time series (data streams).


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

      Parameters:
      listTimeSeriesRequest - A Consumer that will call methods on ListTimeSeriesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTimeSeries 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTimeSeriesPaginator

      default ListTimeSeriesPublisher listTimeSeriesPaginator(ListTimeSeriesRequest listTimeSeriesRequest)

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

      Parameters:
      listTimeSeriesRequest -
      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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTimeSeriesPaginator

      default ListTimeSeriesPublisher listTimeSeriesPaginator(Consumer<ListTimeSeriesRequest.Builder> listTimeSeriesRequest)

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


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

      Parameters:
      listTimeSeriesRequest - A Consumer that will call methods on ListTimeSeriesRequest.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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putDefaultEncryptionConfiguration

      default CompletableFuture<PutDefaultEncryptionConfigurationResponse> putDefaultEncryptionConfiguration(PutDefaultEncryptionConfigurationRequest putDefaultEncryptionConfigurationRequest)

      Sets the default encryption configuration for the Amazon Web Services account. For more information, see Key management in the IoT SiteWise User Guide.

      Parameters:
      putDefaultEncryptionConfigurationRequest -
      Returns:
      A Java Future containing the result of the PutDefaultEncryptionConfiguration 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • LimitExceededException You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putDefaultEncryptionConfiguration

      default CompletableFuture<PutDefaultEncryptionConfigurationResponse> putDefaultEncryptionConfiguration(Consumer<PutDefaultEncryptionConfigurationRequest.Builder> putDefaultEncryptionConfigurationRequest)

      Sets the default encryption configuration for the Amazon Web Services account. For more information, see Key management in the IoT SiteWise User Guide.


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

      Parameters:
      putDefaultEncryptionConfigurationRequest - A Consumer that will call methods on PutDefaultEncryptionConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutDefaultEncryptionConfiguration 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • LimitExceededException You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putLoggingOptions

      default CompletableFuture<PutLoggingOptionsResponse> putLoggingOptions(PutLoggingOptionsRequest putLoggingOptionsRequest)

      Sets logging options for IoT SiteWise.

      Parameters:
      putLoggingOptionsRequest -
      Returns:
      A Java Future containing the result of the PutLoggingOptions 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • ResourceNotFoundException The requested resource can't be found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putLoggingOptions

      default CompletableFuture<PutLoggingOptionsResponse> putLoggingOptions(Consumer<PutLoggingOptionsRequest.Builder> putLoggingOptionsRequest)

      Sets logging options for IoT SiteWise.


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

      Parameters:
      putLoggingOptionsRequest - A Consumer that will call methods on PutLoggingOptionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutLoggingOptions 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • ResourceNotFoundException The requested resource can't be found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putStorageConfiguration

      default CompletableFuture<PutStorageConfigurationResponse> putStorageConfiguration(PutStorageConfigurationRequest putStorageConfigurationRequest)

      Configures storage settings for IoT SiteWise.

      Parameters:
      putStorageConfigurationRequest -
      Returns:
      A Java Future containing the result of the PutStorageConfiguration 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceAlreadyExistsException The resource already exists.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • LimitExceededException You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putStorageConfiguration

      default CompletableFuture<PutStorageConfigurationResponse> putStorageConfiguration(Consumer<PutStorageConfigurationRequest.Builder> putStorageConfigurationRequest)

      Configures storage settings for IoT SiteWise.


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

      Parameters:
      putStorageConfigurationRequest - A Consumer that will call methods on PutStorageConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutStorageConfiguration 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceAlreadyExistsException The resource already exists.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • LimitExceededException You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

      Adds tags to an IoT SiteWise resource. If a tag already exists for the resource, this operation updates the tag's value.

      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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ResourceNotFoundException The requested resource can't be found.
      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • LimitExceededException You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • UnauthorizedException You are not authorized.
      • TooManyTagsException You've reached the limit for the number of tags allowed for a resource. For more information, see Tag naming limits and requirements in the Amazon Web Services General Reference.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

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

      Adds tags to an IoT SiteWise resource. If a tag already exists for the resource, this operation updates the tag's value.


      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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ResourceNotFoundException The requested resource can't be found.
      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • LimitExceededException You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • UnauthorizedException You are not authorized.
      • TooManyTagsException You've reached the limit for the number of tags allowed for a resource. For more information, see Tag naming limits and requirements in the Amazon Web Services General Reference.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

      Removes a tag from an IoT SiteWise 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ResourceNotFoundException The requested resource can't be found.
      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • LimitExceededException You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • UnauthorizedException You are not authorized.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

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

      Removes a tag from an IoT SiteWise 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ResourceNotFoundException The requested resource can't be found.
      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • LimitExceededException You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • UnauthorizedException You are not authorized.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAccessPolicy

      default CompletableFuture<UpdateAccessPolicyResponse> updateAccessPolicy(UpdateAccessPolicyRequest updateAccessPolicyRequest)

      Updates an existing access policy that specifies an identity's access to an IoT SiteWise Monitor portal or project resource.

      Parameters:
      updateAccessPolicyRequest -
      Returns:
      A Java Future containing the result of the UpdateAccessPolicy 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAccessPolicy

      default CompletableFuture<UpdateAccessPolicyResponse> updateAccessPolicy(Consumer<UpdateAccessPolicyRequest.Builder> updateAccessPolicyRequest)

      Updates an existing access policy that specifies an identity's access to an IoT SiteWise Monitor portal or project resource.


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

      Parameters:
      updateAccessPolicyRequest - A Consumer that will call methods on UpdateAccessPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateAccessPolicy 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAsset

      default CompletableFuture<UpdateAssetResponse> updateAsset(UpdateAssetRequest updateAssetRequest)

      Updates an asset's name. For more information, see Updating assets and models in the IoT SiteWise User Guide.

      Parameters:
      updateAssetRequest -
      Returns:
      A Java Future containing the result of the UpdateAsset 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceAlreadyExistsException The resource already exists.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAsset

      default CompletableFuture<UpdateAssetResponse> updateAsset(Consumer<UpdateAssetRequest.Builder> updateAssetRequest)

      Updates an asset's name. For more information, see Updating assets and models in the IoT SiteWise User Guide.


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

      Parameters:
      updateAssetRequest - A Consumer that will call methods on UpdateAssetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateAsset 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceAlreadyExistsException The resource already exists.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAssetModel

      default CompletableFuture<UpdateAssetModelResponse> updateAssetModel(UpdateAssetModelRequest updateAssetModelRequest)

      Updates an asset model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models in the IoT SiteWise User Guide.

      If you remove a property from an asset model, IoT SiteWise deletes all previous data for that property. You can’t change the type or data type of an existing property.

      To replace an existing asset model property with a new one with the same name, do the following:

      1. Submit an UpdateAssetModel request with the entire existing property removed.

      2. Submit a second UpdateAssetModel request that includes the new property. The new asset property will have the same name as the previous one and IoT SiteWise will generate a new unique id.

      Parameters:
      updateAssetModelRequest -
      Returns:
      A Java Future containing the result of the UpdateAssetModel 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceAlreadyExistsException The resource already exists.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • LimitExceededException You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • PreconditionFailedException The precondition in one or more of the request-header fields evaluated to FALSE.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAssetModel

      default CompletableFuture<UpdateAssetModelResponse> updateAssetModel(Consumer<UpdateAssetModelRequest.Builder> updateAssetModelRequest)

      Updates an asset model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models in the IoT SiteWise User Guide.

      If you remove a property from an asset model, IoT SiteWise deletes all previous data for that property. You can’t change the type or data type of an existing property.

      To replace an existing asset model property with a new one with the same name, do the following:

      1. Submit an UpdateAssetModel request with the entire existing property removed.

      2. Submit a second UpdateAssetModel request that includes the new property. The new asset property will have the same name as the previous one and IoT SiteWise will generate a new unique id.


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

      Parameters:
      updateAssetModelRequest - A Consumer that will call methods on UpdateAssetModelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateAssetModel 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceAlreadyExistsException The resource already exists.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • LimitExceededException You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • PreconditionFailedException The precondition in one or more of the request-header fields evaluated to FALSE.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAssetModelCompositeModel

      default CompletableFuture<UpdateAssetModelCompositeModelResponse> updateAssetModelCompositeModel(UpdateAssetModelCompositeModelRequest updateAssetModelCompositeModelRequest)

      Updates a composite model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models in the IoT SiteWise User Guide.

      If you remove a property from a composite asset model, IoT SiteWise deletes all previous data for that property. You can’t change the type or data type of an existing property.

      To replace an existing composite asset model property with a new one with the same name, do the following:

      1. Submit an UpdateAssetModelCompositeModel request with the entire existing property removed.

      2. Submit a second UpdateAssetModelCompositeModel request that includes the new property. The new asset property will have the same name as the previous one and IoT SiteWise will generate a new unique id.

      Parameters:
      updateAssetModelCompositeModelRequest -
      Returns:
      A Java Future containing the result of the UpdateAssetModelCompositeModel 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.
      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • PreconditionFailedException The precondition in one or more of the request-header fields evaluated to FALSE.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceAlreadyExistsException The resource already exists.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • LimitExceededException You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAssetModelCompositeModel

      default CompletableFuture<UpdateAssetModelCompositeModelResponse> updateAssetModelCompositeModel(Consumer<UpdateAssetModelCompositeModelRequest.Builder> updateAssetModelCompositeModelRequest)

      Updates a composite model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models in the IoT SiteWise User Guide.

      If you remove a property from a composite asset model, IoT SiteWise deletes all previous data for that property. You can’t change the type or data type of an existing property.

      To replace an existing composite asset model property with a new one with the same name, do the following:

      1. Submit an UpdateAssetModelCompositeModel request with the entire existing property removed.

      2. Submit a second UpdateAssetModelCompositeModel request that includes the new property. The new asset property will have the same name as the previous one and IoT SiteWise will generate a new unique id.


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

      Parameters:
      updateAssetModelCompositeModelRequest - A Consumer that will call methods on UpdateAssetModelCompositeModelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateAssetModelCompositeModel 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.
      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • PreconditionFailedException The precondition in one or more of the request-header fields evaluated to FALSE.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceAlreadyExistsException The resource already exists.
      • ResourceNotFoundException The requested resource can't be found.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • LimitExceededException You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAssetProperty

      default CompletableFuture<UpdateAssetPropertyResponse> updateAssetProperty(UpdateAssetPropertyRequest updateAssetPropertyRequest)

      Updates an asset property's alias and notification state.

      This operation overwrites the property's existing alias and notification state. To keep your existing property's alias or notification state, you must include the existing values in the UpdateAssetProperty request. For more information, see DescribeAssetProperty.

      Parameters:
      updateAssetPropertyRequest -
      Returns:
      A Java Future containing the result of the UpdateAssetProperty 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAssetProperty

      default CompletableFuture<UpdateAssetPropertyResponse> updateAssetProperty(Consumer<UpdateAssetPropertyRequest.Builder> updateAssetPropertyRequest)

      Updates an asset property's alias and notification state.

      This operation overwrites the property's existing alias and notification state. To keep your existing property's alias or notification state, you must include the existing values in the UpdateAssetProperty request. For more information, see DescribeAssetProperty.


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

      Parameters:
      updateAssetPropertyRequest - A Consumer that will call methods on UpdateAssetPropertyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateAssetProperty 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateDashboard

      default CompletableFuture<UpdateDashboardResponse> updateDashboard(UpdateDashboardRequest updateDashboardRequest)

      Updates an IoT SiteWise Monitor dashboard.

      Parameters:
      updateDashboardRequest -
      Returns:
      A Java Future containing the result of the UpdateDashboard 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateDashboard

      default CompletableFuture<UpdateDashboardResponse> updateDashboard(Consumer<UpdateDashboardRequest.Builder> updateDashboardRequest)

      Updates an IoT SiteWise Monitor dashboard.


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

      Parameters:
      updateDashboardRequest - A Consumer that will call methods on UpdateDashboardRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateDashboard 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateGateway

      default CompletableFuture<UpdateGatewayResponse> updateGateway(UpdateGatewayRequest updateGatewayRequest)

      Updates a gateway's name.

      Parameters:
      updateGatewayRequest -
      Returns:
      A Java Future containing the result of the UpdateGateway 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateGateway

      default CompletableFuture<UpdateGatewayResponse> updateGateway(Consumer<UpdateGatewayRequest.Builder> updateGatewayRequest)

      Updates a gateway's name.


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

      Parameters:
      updateGatewayRequest - A Consumer that will call methods on UpdateGatewayRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateGateway 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateGatewayCapabilityConfiguration

      default CompletableFuture<UpdateGatewayCapabilityConfigurationResponse> updateGatewayCapabilityConfiguration(UpdateGatewayCapabilityConfigurationRequest updateGatewayCapabilityConfigurationRequest)

      Updates a gateway capability configuration or defines a new capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway.

      Parameters:
      updateGatewayCapabilityConfigurationRequest -
      Returns:
      A Java Future containing the result of the UpdateGatewayCapabilityConfiguration 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • LimitExceededException You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateGatewayCapabilityConfiguration

      default CompletableFuture<UpdateGatewayCapabilityConfigurationResponse> updateGatewayCapabilityConfiguration(Consumer<UpdateGatewayCapabilityConfigurationRequest.Builder> updateGatewayCapabilityConfigurationRequest)

      Updates a gateway capability configuration or defines a new capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway.


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

      Parameters:
      updateGatewayCapabilityConfigurationRequest - A Consumer that will call methods on UpdateGatewayCapabilityConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateGatewayCapabilityConfiguration 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • LimitExceededException You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updatePortal

      default CompletableFuture<UpdatePortalResponse> updatePortal(UpdatePortalRequest updatePortalRequest)

      Updates an IoT SiteWise Monitor portal.

      Parameters:
      updatePortalRequest -
      Returns:
      A Java Future containing the result of the UpdatePortal 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updatePortal

      default CompletableFuture<UpdatePortalResponse> updatePortal(Consumer<UpdatePortalRequest.Builder> updatePortalRequest)

      Updates an IoT SiteWise Monitor portal.


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

      Parameters:
      updatePortalRequest - A Consumer that will call methods on UpdatePortalRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdatePortal 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateProject

      default CompletableFuture<UpdateProjectResponse> updateProject(UpdateProjectRequest updateProjectRequest)

      Updates an IoT SiteWise Monitor project.

      Parameters:
      updateProjectRequest -
      Returns:
      A Java Future containing the result of the UpdateProject 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateProject

      default CompletableFuture<UpdateProjectResponse> updateProject(Consumer<UpdateProjectRequest.Builder> updateProjectRequest)

      Updates an IoT SiteWise Monitor project.


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

      Parameters:
      updateProjectRequest - A Consumer that will call methods on UpdateProjectRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateProject 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 The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • ResourceNotFoundException The requested resource can't be found.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

        For more information, see Quotas in the IoT SiteWise User Guide.

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • IoTSiteWiseException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • waiter

      default IoTSiteWiseAsyncWaiter waiter()
      Create an instance of IoTSiteWiseAsyncWaiter using this client.

      Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.

      Returns:
      an instance of IoTSiteWiseAsyncWaiter

    • serviceClientConfiguration

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

    • builder

      static IoTSiteWiseAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a IoTSiteWiseAsyncClient.