Interface IoTSiteWiseAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @SdkPublicApi @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 quota 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 quota 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:

    • batchAssociateDataSegmentsToDataset

      default CompletableFuture<BatchAssociateDataSegmentsToDatasetResponse> batchAssociateDataSegmentsToDataset(BatchAssociateDataSegmentsToDatasetRequest batchAssociateDataSegmentsToDatasetRequest)

      Associates a batch of data segments with a curated dataset. Data segments are time-bounded slices of time series data selected from source session datasets. Data segments that belong to the same time series can't overlap in time, regardless of which dataset they belong to.

      Parameters:
      batchAssociateDataSegmentsToDatasetRequest -
      Returns:
      A Java Future containing the result of the BatchAssociateDataSegmentsToDataset operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally 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 quota 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:

    • batchAssociateDataSegmentsToDataset

      default CompletableFuture<BatchAssociateDataSegmentsToDatasetResponse> batchAssociateDataSegmentsToDataset(Consumer<BatchAssociateDataSegmentsToDatasetRequest.Builder> batchAssociateDataSegmentsToDatasetRequest)

      Associates a batch of data segments with a curated dataset. Data segments are time-bounded slices of time series data selected from source session datasets. Data segments that belong to the same time series can't overlap in time, regardless of which dataset they belong to.


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

      Parameters:
      batchAssociateDataSegmentsToDatasetRequest - A Consumer that will call methods on BatchAssociateDataSegmentsToDatasetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the BatchAssociateDataSegmentsToDataset operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally 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 quota 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:

    • batchAssociateProjectAssets

      default CompletableFuture<BatchAssociateProjectAssetsResponse> batchAssociateProjectAssets(BatchAssociateProjectAssetsRequest batchAssociateProjectAssetsRequest)

      The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.

      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 quota 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)

      The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.

      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 quota 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:

    • batchDeleteDatasetDataSegments

      default CompletableFuture<BatchDeleteDatasetDataSegmentsResponse> batchDeleteDatasetDataSegments(BatchDeleteDatasetDataSegmentsRequest batchDeleteDatasetDataSegmentsRequest)

      Deletes a batch of data segments from a session dataset. Deleting a data segment deletes the underlying time series data for the segment's time range.

      Parameters:
      batchDeleteDatasetDataSegmentsRequest -
      Returns:
      A Java Future containing the result of the BatchDeleteDatasetDataSegments operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally 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:

    • batchDeleteDatasetDataSegments

      default CompletableFuture<BatchDeleteDatasetDataSegmentsResponse> batchDeleteDatasetDataSegments(Consumer<BatchDeleteDatasetDataSegmentsRequest.Builder> batchDeleteDatasetDataSegmentsRequest)

      Deletes a batch of data segments from a session dataset. Deleting a data segment deletes the underlying time series data for the segment's time range.


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

      Parameters:
      batchDeleteDatasetDataSegmentsRequest - A Consumer that will call methods on BatchDeleteDatasetDataSegmentsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the BatchDeleteDatasetDataSegments operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally 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:

    • batchDisassociateDataSegmentsFromDataset

      default CompletableFuture<BatchDisassociateDataSegmentsFromDatasetResponse> batchDisassociateDataSegmentsFromDataset(BatchDisassociateDataSegmentsFromDatasetRequest batchDisassociateDataSegmentsFromDatasetRequest)

      Disassociates a batch of data segments from a curated dataset. Disassociating a data segment doesn't delete the underlying data in the source session dataset.

      Parameters:
      batchDisassociateDataSegmentsFromDatasetRequest -
      Returns:
      A Java Future containing the result of the BatchDisassociateDataSegmentsFromDataset operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally 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:

    • batchDisassociateDataSegmentsFromDataset

      default CompletableFuture<BatchDisassociateDataSegmentsFromDatasetResponse> batchDisassociateDataSegmentsFromDataset(Consumer<BatchDisassociateDataSegmentsFromDatasetRequest.Builder> batchDisassociateDataSegmentsFromDatasetRequest)

      Disassociates a batch of data segments from a curated dataset. Disassociating a data segment doesn't delete the underlying data in the source session dataset.


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

      Parameters:
      batchDisassociateDataSegmentsFromDatasetRequest - A Consumer that will call methods on BatchDisassociateDataSegmentsFromDatasetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the BatchDisassociateDataSegmentsFromDataset operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally 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:

    • 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 quota 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 quota 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:

    • cancelEnrichmentJob

      default CompletableFuture<CancelEnrichmentJobResponse> cancelEnrichmentJob(CancelEnrichmentJobRequest cancelEnrichmentJobRequest)

      Cancels a running or pending enrichment job. This is an idempotent operation—calling it multiple times with the same jobId is safe and returns the current status.

      Behavior

      • Jobs in PENDING or RUNNING status transition to CANCELLED
      • Jobs in RUNNING state may not be cancellable once they have progressed to certain processing stages
      • Jobs already in terminal states (COMPLETED, FAILED, TIMED_OUT) cannot be cancelled; the operation returns a ConflictingOperationException
      • Cancelling an already-CANCELLED job is a no-op and returns the current status (idempotent behavior)
      • The API responds immediately after recording the cancellation
      • Cleanup of job resources happens asynchronously in the background

      When to Cancel

      Cancel a job when:

      • The job is taking longer than expected
      • The job was created with incorrect parameters
      • You no longer need the results

      Idempotency

      You can safely retry cancellation requests. Calling CancelEnrichmentJob multiple times for the same job returns the current status without error as long as the job is not in a terminal state other than CANCELLED.

      Parameters:
      cancelEnrichmentJobRequest -
      Returns:
      A Java Future containing the result of the CancelEnrichmentJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.

      • ResourceNotFoundException The requested resource can't be found.
      • LimitExceededException You've reached the quota 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:

    • cancelEnrichmentJob

      default CompletableFuture<CancelEnrichmentJobResponse> cancelEnrichmentJob(Consumer<CancelEnrichmentJobRequest.Builder> cancelEnrichmentJobRequest)

      Cancels a running or pending enrichment job. This is an idempotent operation—calling it multiple times with the same jobId is safe and returns the current status.

      Behavior

      • Jobs in PENDING or RUNNING status transition to CANCELLED
      • Jobs in RUNNING state may not be cancellable once they have progressed to certain processing stages
      • Jobs already in terminal states (COMPLETED, FAILED, TIMED_OUT) cannot be cancelled; the operation returns a ConflictingOperationException
      • Cancelling an already-CANCELLED job is a no-op and returns the current status (idempotent behavior)
      • The API responds immediately after recording the cancellation
      • Cleanup of job resources happens asynchronously in the background

      When to Cancel

      Cancel a job when:

      • The job is taking longer than expected
      • The job was created with incorrect parameters
      • You no longer need the results

      Idempotency

      You can safely retry cancellation requests. Calling CancelEnrichmentJob multiple times for the same job returns the current status without error as long as the job is not in a terminal state other than CANCELLED.


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

      Parameters:
      cancelEnrichmentJobRequest - A Consumer that will call methods on CancelEnrichmentJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CancelEnrichmentJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.

      • ResourceNotFoundException The requested resource can't be found.
      • LimitExceededException You've reached the quota 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:

    • cancelPipelineExecution

      default CompletableFuture<CancelPipelineExecutionResponse> cancelPipelineExecution(CancelPipelineExecutionRequest cancelPipelineExecutionRequest)

      Cancels a pipeline execution in the specified workspace. If the execution is not in a terminal state (such as NOT_STARTED or RUNNING), it transitions to CANCELLING and asynchronously to CANCELLED. This operation is idempotent: calling it on an execution that is already CANCELLING or CANCELLED returns success with the current state. Calling it on a terminal execution (SUCCEEDED or FAILED) returns a conflict error. You can optionally provide a reason; it is returned in the stateDetails field when you describe the execution.

      Parameters:
      cancelPipelineExecutionRequest - Request structure for CancelPipelineExecution operation.
      Returns:
      A Java Future containing the result of the CancelPipelineExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • cancelPipelineExecution

      default CompletableFuture<CancelPipelineExecutionResponse> cancelPipelineExecution(Consumer<CancelPipelineExecutionRequest.Builder> cancelPipelineExecutionRequest)

      Cancels a pipeline execution in the specified workspace. If the execution is not in a terminal state (such as NOT_STARTED or RUNNING), it transitions to CANCELLING and asynchronously to CANCELLED. This operation is idempotent: calling it on an execution that is already CANCELLING or CANCELLED returns success with the current state. Calling it on a terminal execution (SUCCEEDED or FAILED) returns a conflict error. You can optionally provide a reason; it is returned in the stateDetails field when you describe the execution.


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

      Parameters:
      cancelPipelineExecutionRequest - A Consumer that will call methods on CancelPipelineExecutionRequest.Builder to create a request. Request structure for CancelPipelineExecution operation.
      Returns:
      A Java Future containing the result of the CancelPipelineExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • cancelQuery

      default CompletableFuture<CancelQueryResponse> cancelQuery(CancelQueryRequest cancelQueryRequest)

      Cancels a running query.

      Parameters:
      cancelQueryRequest -
      Returns:
      A Java Future containing the result of the CancelQuery operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • cancelQuery

      default CompletableFuture<CancelQueryResponse> cancelQuery(Consumer<CancelQueryRequest.Builder> cancelQueryRequest)

      Cancels a running query.


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

      Parameters:
      cancelQueryRequest - A Consumer that will call methods on CancelQueryRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CancelQuery operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • createAccessPolicy

      default CompletableFuture<CreateAccessPolicyResponse> createAccessPolicy(CreateAccessPolicyRequest createAccessPolicyRequest)

      The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.

      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.

      Support for access policies that use an SSO Group as the identity is not supported at this time.

      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 quota 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)

      The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.

      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.

      Support for access policies that use an SSO Group as the identity is not supported at this time.


      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 quota 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:

    • createApplication

      default CompletableFuture<CreateApplicationResponse> createApplication(CreateApplicationRequest createApplicationRequest)

      Creates a new application for the workspace and IdC application provided

      Parameters:
      createApplicationRequest -
      Returns:
      A Java Future containing the result of the CreateApplication operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.

      • 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.
      • LimitExceededException You've reached the quota 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:

    • createApplication

      default CompletableFuture<CreateApplicationResponse> createApplication(Consumer<CreateApplicationRequest.Builder> createApplicationRequest)

      Creates a new application for the workspace and IdC application provided


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

      Parameters:
      createApplicationRequest - A Consumer that will call methods on CreateApplicationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateApplication operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.

      • 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.
      • LimitExceededException You've reached the quota 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(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 quota 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 quota 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 three types of asset models, ASSET_MODEL, COMPONENT_MODEL, or an INTERFACE.

      • 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.

      • INTERFACE – An interface is a type of model that defines a standard structure that can be applied to different asset models.

      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 quota 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 three types of asset models, ASSET_MODEL, COMPONENT_MODEL, or an INTERFACE.

      • 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.

      • INTERFACE – An interface is a type of model that defines a standard structure that can be applied to different asset models.


      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 quota 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 quota 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 quota 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 that ingests data into time series outside of a workspace, you must enable IoT SiteWise warm tier or IoT SiteWise cold tier. For more information about how to configure storage settings, see PutStorageConfiguration. This requirement doesn't apply to bulk import jobs that ingest data into a session dataset in a workspace (jobs that specify a workspaceName and datasetId). Those jobs don't use IoT SiteWise warm or cold tier storage.

      Bulk import is designed to store historical data to IoT SiteWise.

      • Newly ingested data in the hot tier triggers notifications and computations.

      • After data moves from the hot tier to the warm or cold tier based on retention settings, it does not trigger computations or notifications.

      • Data older than 7 days does not trigger computations or notifications.

      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 quota 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 that ingests data into time series outside of a workspace, you must enable IoT SiteWise warm tier or IoT SiteWise cold tier. For more information about how to configure storage settings, see PutStorageConfiguration. This requirement doesn't apply to bulk import jobs that ingest data into a session dataset in a workspace (jobs that specify a workspaceName and datasetId). Those jobs don't use IoT SiteWise warm or cold tier storage.

      Bulk import is designed to store historical data to IoT SiteWise.

      • Newly ingested data in the hot tier triggers notifications and computations.

      • After data moves from the hot tier to the warm or cold tier based on retention settings, it does not trigger computations or notifications.

      • Data older than 7 days does not trigger computations or notifications.


      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 quota 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:

    • createComputationModel

      default CompletableFuture<CreateComputationModelResponse> createComputationModel(CreateComputationModelRequest createComputationModelRequest)

      Create a computation model with a configuration and data binding.

      Parameters:
      createComputationModelRequest -
      Returns:
      A Java Future containing the result of the CreateComputationModel operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally 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 quota 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:

    • createComputationModel

      default CompletableFuture<CreateComputationModelResponse> createComputationModel(Consumer<CreateComputationModelRequest.Builder> createComputationModelRequest)

      Create a computation model with a configuration and data binding.


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

      Parameters:
      createComputationModelRequest - A Consumer that will call methods on CreateComputationModelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateComputationModel operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally 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 quota 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)

      The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.

      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 quota 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)

      The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.

      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 quota 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:

    • createDataset

      default CompletableFuture<CreateDatasetResponse> createDataset(CreateDatasetRequest createDatasetRequest)

      Creates a dataset. Session and curated datasets are created in a workspace. A session dataset contains data segments of time series data, and a curated dataset curates data segments selected from source session datasets. A dataset that connects to an external datasource is created outside of a workspace.

      Parameters:
      createDatasetRequest -
      Returns:
      A Java Future containing the result of the CreateDataset operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally 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 quota 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:

    • createDataset

      default CompletableFuture<CreateDatasetResponse> createDataset(Consumer<CreateDatasetRequest.Builder> createDatasetRequest)

      Creates a dataset. Session and curated datasets are created in a workspace. A session dataset contains data segments of time series data, and a curated dataset curates data segments selected from source session datasets. A dataset that connects to an external datasource is created outside of a workspace.


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

      Parameters:
      createDatasetRequest - A Consumer that will call methods on CreateDatasetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateDataset operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally 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 quota 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:

    • createDatasetExportJob

      default CompletableFuture<CreateDatasetExportJobResponse> createDatasetExportJob(CreateDatasetExportJobRequest createDatasetExportJobRequest)

      Starts an asynchronous job that exports dataset and time-series data from a workspace to Amazon S3. The operation returns a jobId immediately; poll DescribeDatasetExportJob to track progress and ListDatasetExportJobs to enumerate a workspace's jobs.

      Parameters:
      createDatasetExportJobRequest - Request to create a dataset export job.
      Returns:
      A Java Future containing the result of the CreateDatasetExportJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • createDatasetExportJob

      default CompletableFuture<CreateDatasetExportJobResponse> createDatasetExportJob(Consumer<CreateDatasetExportJobRequest.Builder> createDatasetExportJobRequest)

      Starts an asynchronous job that exports dataset and time-series data from a workspace to Amazon S3. The operation returns a jobId immediately; poll DescribeDatasetExportJob to track progress and ListDatasetExportJobs to enumerate a workspace's jobs.


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

      Parameters:
      createDatasetExportJobRequest - A Consumer that will call methods on CreateDatasetExportJobRequest.Builder to create a request. Request to create a dataset export job.
      Returns:
      A Java Future containing the result of the CreateDatasetExportJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • createEnrichmentJob

      default CompletableFuture<CreateEnrichmentJobResponse> createEnrichmentJob(CreateEnrichmentJobRequest createEnrichmentJobRequest)

      Creates an asynchronous enrichment job to analyze time-series sensor data. The operation returns immediately with job details while processing continues in the background.

      Idempotency

      Include a clientToken to make the operation idempotent. If you submit the same request with the same token within the idempotency window, you receive the original job details without creating a duplicate.

      Prerequisites

      Before creating a job, ensure:

      • The workspace is in ACTIVE state (not being deleted)
      • You have IAM permissions for the workspace, dataset, and time-series resources
      • You have KMS Decrypt permission on the workspace's customer-managed encryption key
      • No duplicate job (same workspace, dataset, property, and job type) is currently running

      Workflow

      1. Submit the job with configuration specifying which video data to analyze and the time range
      2. Capture the jobId from the response
      3. Use DescribeEnrichmentJob to monitor progress and check job status
      4. When status reaches a terminal state (COMPLETED, FAILED, TIMED_OUT, CANCELLED), check results
      5. For COMPLETED jobs, query IoT SiteWise for semantic search on video events

      Error Handling

      • ConflictingOperationException: A duplicate job is already running for the same configuration
      • InvalidRequestException: Invalid parameters (e.g., both timeSeriesId and propertyAlias specified)
      • AccessDeniedException: Insufficient IAM or KMS permissions
      • LimitExceededException: Too many concurrent jobs or requests
      Parameters:
      createEnrichmentJobRequest -
      Returns:
      A Java Future containing the result of the CreateEnrichmentJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.

      • LimitExceededException You've reached the quota 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.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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:

    • createEnrichmentJob

      default CompletableFuture<CreateEnrichmentJobResponse> createEnrichmentJob(Consumer<CreateEnrichmentJobRequest.Builder> createEnrichmentJobRequest)

      Creates an asynchronous enrichment job to analyze time-series sensor data. The operation returns immediately with job details while processing continues in the background.

      Idempotency

      Include a clientToken to make the operation idempotent. If you submit the same request with the same token within the idempotency window, you receive the original job details without creating a duplicate.

      Prerequisites

      Before creating a job, ensure:

      • The workspace is in ACTIVE state (not being deleted)
      • You have IAM permissions for the workspace, dataset, and time-series resources
      • You have KMS Decrypt permission on the workspace's customer-managed encryption key
      • No duplicate job (same workspace, dataset, property, and job type) is currently running

      Workflow

      1. Submit the job with configuration specifying which video data to analyze and the time range
      2. Capture the jobId from the response
      3. Use DescribeEnrichmentJob to monitor progress and check job status
      4. When status reaches a terminal state (COMPLETED, FAILED, TIMED_OUT, CANCELLED), check results
      5. For COMPLETED jobs, query IoT SiteWise for semantic search on video events

      Error Handling

      • ConflictingOperationException: A duplicate job is already running for the same configuration
      • InvalidRequestException: Invalid parameters (e.g., both timeSeriesId and propertyAlias specified)
      • AccessDeniedException: Insufficient IAM or KMS permissions
      • LimitExceededException: Too many concurrent jobs or requests

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

      Parameters:
      createEnrichmentJobRequest - A Consumer that will call methods on CreateEnrichmentJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateEnrichmentJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.

      • LimitExceededException You've reached the quota 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.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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 quota 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 quota 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:

    • createPipeline

      default CompletableFuture<CreatePipelineResponse> createPipeline(CreatePipelineRequest createPipelineRequest)

      Creates a new pipeline in the specified workspace. A pipeline defines a directed acyclic graph (DAG) of compute nodes, where each node references a task and can declare dependencies on other nodes. Cyclic dependencies are not allowed. Nodes without dependencies run in parallel, while nodes with dependencies wait for all upstream nodes to complete successfully before starting.

      You can set environment variables at the pipeline level that are shared across all compute nodes, and override them at the individual compute node level.

      Parameters:
      createPipelineRequest - Request structure for CreatePipeline operation.
      Returns:
      A Java Future containing the result of the CreatePipeline operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • LimitExceededException You've reached the quota 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.

      • 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.
      • 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:

    • createPipeline

      default CompletableFuture<CreatePipelineResponse> createPipeline(Consumer<CreatePipelineRequest.Builder> createPipelineRequest)

      Creates a new pipeline in the specified workspace. A pipeline defines a directed acyclic graph (DAG) of compute nodes, where each node references a task and can declare dependencies on other nodes. Cyclic dependencies are not allowed. Nodes without dependencies run in parallel, while nodes with dependencies wait for all upstream nodes to complete successfully before starting.

      You can set environment variables at the pipeline level that are shared across all compute nodes, and override them at the individual compute node level.


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

      Parameters:
      createPipelineRequest - A Consumer that will call methods on CreatePipelineRequest.Builder to create a request. Request structure for CreatePipeline operation.
      Returns:
      A Java Future containing the result of the CreatePipeline operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • LimitExceededException You've reached the quota 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.

      • 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.
      • 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:

    • createPortal

      default CompletableFuture<CreatePortalResponse> createPortal(CreatePortalRequest createPortalRequest)

      The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.

      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 quota 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)

      The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.

      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 quota 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)

      The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.

      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 quota 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)

      The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.

      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 quota 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:

    • createTask

      default CompletableFuture<CreateTaskResponse> createTask(CreateTaskRequest createTaskRequest)

      Creates a new task in the specified workspace. A task defines a reusable containerized compute workload that can be referenced by one or more pipeline compute nodes.

      Specify a containerTaskConfiguration for custom container workloads with configurable ECR image, processing type, processing unit, and environment variables.

      Parameters:
      createTaskRequest - Request structure for CreateTask operation.
      Returns:
      A Java Future containing the result of the CreateTask operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • LimitExceededException You've reached the quota 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.

      • 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.
      • 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:

    • createTask

      default CompletableFuture<CreateTaskResponse> createTask(Consumer<CreateTaskRequest.Builder> createTaskRequest)

      Creates a new task in the specified workspace. A task defines a reusable containerized compute workload that can be referenced by one or more pipeline compute nodes.

      Specify a containerTaskConfiguration for custom container workloads with configurable ECR image, processing type, processing unit, and environment variables.


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

      Parameters:
      createTaskRequest - A Consumer that will call methods on CreateTaskRequest.Builder to create a request. Request structure for CreateTask operation.
      Returns:
      A Java Future containing the result of the CreateTask operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • LimitExceededException You've reached the quota 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.

      • 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.
      • 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:

    • createWorkspace

      default CompletableFuture<CreateWorkspaceResponse> createWorkspace(CreateWorkspaceRequest createWorkspaceRequest)

      Creates a workspace in IoT SiteWise. A workspace isolates its resources, such as datasets, time series, pipelines, and tasks, and their data from other workspaces, and has its own quotas and throttling limits. You must specify an encryption configuration when you create a workspace. The operation returns immediately with the workspace in the CREATING state. Provisioning completes asynchronously, after which the workspace state is ACTIVE, or FAILED if provisioning doesn't complete.

      Parameters:
      createWorkspaceRequest -
      Returns:
      A Java Future containing the result of the CreateWorkspace operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException Access is denied.
      • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • 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 quota 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.

      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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:

    • createWorkspace

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

      Creates a workspace in IoT SiteWise. A workspace isolates its resources, such as datasets, time series, pipelines, and tasks, and their data from other workspaces, and has its own quotas and throttling limits. You must specify an encryption configuration when you create a workspace. The operation returns immediately with the workspace in the CREATING state. Provisioning completes asynchronously, after which the workspace state is ACTIVE, or FAILED if provisioning doesn't complete.


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

      Parameters:
      createWorkspaceRequest - A Consumer that will call methods on CreateWorkspaceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateWorkspace operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException Access is denied.
      • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • 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 quota 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.

      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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:

    • deleteApplication

      default CompletableFuture<DeleteApplicationResponse> deleteApplication(DeleteApplicationRequest deleteApplicationRequest)

      Deletes an application by ID

      Parameters:
      deleteApplicationRequest -
      Returns:
      A Java Future containing the result of the DeleteApplication operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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:

    • deleteApplication

      default CompletableFuture<DeleteApplicationResponse> deleteApplication(Consumer<DeleteApplicationRequest.Builder> deleteApplicationRequest)

      Deletes an application by ID


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

      Parameters:
      deleteApplicationRequest - A Consumer that will call methods on DeleteApplicationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteApplication operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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:

    • deleteAssetModelInterfaceRelationship

      default CompletableFuture<DeleteAssetModelInterfaceRelationshipResponse> deleteAssetModelInterfaceRelationship(DeleteAssetModelInterfaceRelationshipRequest deleteAssetModelInterfaceRelationshipRequest)

      Deletes an interface relationship between an asset model and an interface asset model.

      Parameters:
      deleteAssetModelInterfaceRelationshipRequest -
      Returns:
      A Java Future containing the result of the DeleteAssetModelInterfaceRelationship operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally 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:

    • deleteAssetModelInterfaceRelationship

      default CompletableFuture<DeleteAssetModelInterfaceRelationshipResponse> deleteAssetModelInterfaceRelationship(Consumer<DeleteAssetModelInterfaceRelationshipRequest.Builder> deleteAssetModelInterfaceRelationshipRequest)

      Deletes an interface relationship between an asset model and an interface asset model.


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

      Parameters:
      deleteAssetModelInterfaceRelationshipRequest - A Consumer that will call methods on DeleteAssetModelInterfaceRelationshipRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteAssetModelInterfaceRelationship operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally 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:

    • deleteComputationModel

      default CompletableFuture<DeleteComputationModelResponse> deleteComputationModel(DeleteComputationModelRequest deleteComputationModelRequest)

      Deletes a computation model. This action can't be undone.

      Parameters:
      deleteComputationModelRequest -
      Returns:
      A Java Future containing the result of the DeleteComputationModel operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally 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:

    • deleteComputationModel

      default CompletableFuture<DeleteComputationModelResponse> deleteComputationModel(Consumer<DeleteComputationModelRequest.Builder> deleteComputationModelRequest)

      Deletes a computation model. This action can't be undone.


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

      Parameters:
      deleteComputationModelRequest - A Consumer that will call methods on DeleteComputationModelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteComputationModel operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally 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:

    • 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:

    • deleteDataset

      default CompletableFuture<DeleteDatasetResponse> deleteDataset(DeleteDatasetRequest deleteDatasetRequest)

      Deletes a dataset. This can't be undone. Deleting a session dataset also deletes the underlying time series data in the session. You can't delete a session dataset while a curated dataset references its data segments. First delete the curated dataset or disassociate the data segments. Deleting a curated dataset doesn't delete the underlying data in the source session datasets.

      Parameters:
      deleteDatasetRequest -
      Returns:
      A Java Future containing the result of the DeleteDataset operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally 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:

    • deleteDataset

      default CompletableFuture<DeleteDatasetResponse> deleteDataset(Consumer<DeleteDatasetRequest.Builder> deleteDatasetRequest)

      Deletes a dataset. This can't be undone. Deleting a session dataset also deletes the underlying time series data in the session. You can't delete a session dataset while a curated dataset references its data segments. First delete the curated dataset or disassociate the data segments. Deleting a curated dataset doesn't delete the underlying data in the source session datasets.


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

      Parameters:
      deleteDatasetRequest - A Consumer that will call methods on DeleteDatasetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteDataset operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally 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:

    • 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:

    • deletePipeline

      default CompletableFuture<DeletePipelineResponse> deletePipeline(DeletePipelineRequest deletePipelineRequest)

      Deletes a pipeline from the specified workspace. A pipeline cannot be deleted if it has any active executions. Wait for all executions to complete before attempting to delete the pipeline, or use CancelPipelineExecution to stop a running execution.

      Parameters:
      deletePipelineRequest - Request structure for DeletePipeline operation.
      Returns:
      A Java Future containing the result of the DeletePipeline operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • deletePipeline

      default CompletableFuture<DeletePipelineResponse> deletePipeline(Consumer<DeletePipelineRequest.Builder> deletePipelineRequest)

      Deletes a pipeline from the specified workspace. A pipeline cannot be deleted if it has any active executions. Wait for all executions to complete before attempting to delete the pipeline, or use CancelPipelineExecution to stop a running execution.


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

      Parameters:
      deletePipelineRequest - A Consumer that will call methods on DeletePipelineRequest.Builder to create a request. Request structure for DeletePipeline operation.
      Returns:
      A Java Future containing the result of the DeletePipeline operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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(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:

    • deleteTask

      default CompletableFuture<DeleteTaskResponse> deleteTask(DeleteTaskRequest deleteTaskRequest)

      Deletes a task from the specified workspace. A task cannot be deleted if it is currently referenced by any existing pipeline. Remove the task from all pipelines before attempting to delete it.

      Parameters:
      deleteTaskRequest - Request structure for DeleteTask operation.
      Returns:
      A Java Future containing the result of the DeleteTask operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • deleteTask

      default CompletableFuture<DeleteTaskResponse> deleteTask(Consumer<DeleteTaskRequest.Builder> deleteTaskRequest)

      Deletes a task from the specified workspace. A task cannot be deleted if it is currently referenced by any existing pipeline. Remove the task from all pipelines before attempting to delete it.


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

      Parameters:
      deleteTaskRequest - A Consumer that will call methods on DeleteTaskRequest.Builder to create a request. Request structure for DeleteTask operation.
      Returns:
      A Java Future containing the result of the DeleteTask operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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(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. You can't delete a time series until all of its data segments have been deleted from session datasets.

      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. You can't delete a time series until all of its data segments have been deleted from session datasets.

      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:

    • deleteWorkspace

      default CompletableFuture<DeleteWorkspaceResponse> deleteWorkspace(DeleteWorkspaceRequest deleteWorkspaceRequest)

      Deletes a workspace. Before you delete a workspace, you must delete all resources contained in or associated with the workspace, such as datasets, time series, pipelines, and tasks.

      Parameters:
      deleteWorkspaceRequest -
      Returns:
      A Java Future containing the result of the DeleteWorkspace operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException Access is denied.
      • ResourceNotFoundException The requested resource can't be found.
      • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • 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.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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:

    • deleteWorkspace

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

      Deletes a workspace. Before you delete a workspace, you must delete all resources contained in or associated with the workspace, such as datasets, time series, pipelines, and tasks.


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

      Parameters:
      deleteWorkspaceRequest - A Consumer that will call methods on DeleteWorkspaceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteWorkspace operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException Access is denied.
      • ResourceNotFoundException The requested resource can't be found.
      • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • 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.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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:

    • describeApplication

      default CompletableFuture<DescribeApplicationResponse> describeApplication(DescribeApplicationRequest describeApplicationRequest)

      Retrieves Application details based on the ID

      Parameters:
      describeApplicationRequest -
      Returns:
      A Java Future containing the result of the DescribeApplication operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.

      • 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:

    • describeApplication

      default CompletableFuture<DescribeApplicationResponse> describeApplication(Consumer<DescribeApplicationRequest.Builder> describeApplicationRequest)

      Retrieves Application details based on the ID


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

      Parameters:
      describeApplicationRequest - A Consumer that will call methods on DescribeApplicationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeApplication operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.

      • 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:

    • 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. This includes details about the asset model's properties, hierarchies, composite models, and any interface relationships if the asset model implements interfaces.

      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 includes details about the asset model's properties, hierarchies, composite models, and any interface relationships if the asset model implements interfaces.


      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:

    • describeAssetModelInterfaceRelationship

      default CompletableFuture<DescribeAssetModelInterfaceRelationshipResponse> describeAssetModelInterfaceRelationship(DescribeAssetModelInterfaceRelationshipRequest describeAssetModelInterfaceRelationshipRequest)

      Retrieves information about an interface relationship between an asset model and an interface asset model.

      Parameters:
      describeAssetModelInterfaceRelationshipRequest -
      Returns:
      A Java Future containing the result of the DescribeAssetModelInterfaceRelationship operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally 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:

    • describeAssetModelInterfaceRelationship

      default CompletableFuture<DescribeAssetModelInterfaceRelationshipResponse> describeAssetModelInterfaceRelationship(Consumer<DescribeAssetModelInterfaceRelationshipRequest.Builder> describeAssetModelInterfaceRelationshipRequest)

      Retrieves information about an interface relationship between an asset model and an interface asset model.


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

      Parameters:
      describeAssetModelInterfaceRelationshipRequest - A Consumer that will call methods on DescribeAssetModelInterfaceRelationshipRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeAssetModelInterfaceRelationship operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally 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:

    • describeComputationModel

      default CompletableFuture<DescribeComputationModelResponse> describeComputationModel(DescribeComputationModelRequest describeComputationModelRequest)

      Retrieves information about a computation model.

      Parameters:
      describeComputationModelRequest -
      Returns:
      A Java Future containing the result of the DescribeComputationModel operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally 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:

    • describeComputationModel

      default CompletableFuture<DescribeComputationModelResponse> describeComputationModel(Consumer<DescribeComputationModelRequest.Builder> describeComputationModelRequest)

      Retrieves information about a computation model.


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

      Parameters:
      describeComputationModelRequest - A Consumer that will call methods on DescribeComputationModelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeComputationModel operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally 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:

    • describeComputationModelExecutionSummary

      default CompletableFuture<DescribeComputationModelExecutionSummaryResponse> describeComputationModelExecutionSummary(DescribeComputationModelExecutionSummaryRequest describeComputationModelExecutionSummaryRequest)

      Retrieves information about the execution summary of a computation model.

      Parameters:
      describeComputationModelExecutionSummaryRequest -
      Returns:
      A Java Future containing the result of the DescribeComputationModelExecutionSummary operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally 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:

    • describeComputationModelExecutionSummary

      default CompletableFuture<DescribeComputationModelExecutionSummaryResponse> describeComputationModelExecutionSummary(Consumer<DescribeComputationModelExecutionSummaryRequest.Builder> describeComputationModelExecutionSummaryRequest)

      Retrieves information about the execution summary of a computation model.


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

      Parameters:
      describeComputationModelExecutionSummaryRequest - A Consumer that will call methods on DescribeComputationModelExecutionSummaryRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeComputationModelExecutionSummary operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally 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:

    • describeDataset

      default CompletableFuture<DescribeDatasetResponse> describeDataset(DescribeDatasetRequest describeDatasetRequest)

      Retrieves information about a dataset.

      Parameters:
      describeDatasetRequest -
      Returns:
      A Java Future containing the result of the DescribeDataset operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally 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:

    • describeDataset

      default CompletableFuture<DescribeDatasetResponse> describeDataset(Consumer<DescribeDatasetRequest.Builder> describeDatasetRequest)

      Retrieves information about a dataset.


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

      Parameters:
      describeDatasetRequest - A Consumer that will call methods on DescribeDatasetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeDataset operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally 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:

    • describeDatasetExportJob

      default CompletableFuture<DescribeDatasetExportJobResponse> describeDatasetExportJob(DescribeDatasetExportJobRequest describeDatasetExportJobRequest)

      Retrieves information about a dataset export job.

      Parameters:
      describeDatasetExportJobRequest - Request to describe a dataset export job.
      Returns:
      A Java Future containing the result of the DescribeDatasetExportJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • describeDatasetExportJob

      default CompletableFuture<DescribeDatasetExportJobResponse> describeDatasetExportJob(Consumer<DescribeDatasetExportJobRequest.Builder> describeDatasetExportJobRequest)

      Retrieves information about a dataset export job.


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

      Parameters:
      describeDatasetExportJobRequest - A Consumer that will call methods on DescribeDatasetExportJobRequest.Builder to create a request. Request to describe a dataset export job.
      Returns:
      A Java Future containing the result of the DescribeDatasetExportJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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.
      • 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(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.
      • 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:

    • describeEnrichmentJob

      default CompletableFuture<DescribeEnrichmentJobResponse> describeEnrichmentJob(DescribeEnrichmentJobRequest describeEnrichmentJobRequest)

      Retrieves detailed information about a specific enrichment job, including its current status, configuration, and timestamps.

      Use Cases

      • Monitor job progress by checking status updates with DescribeEnrichmentJob
      • Retrieve the complete job configuration submitted during creation
      • Debug failed jobs by examining the failureMessage field
      • Track job lifecycle with creation, update, completion, and cancellation timestamps

      Status Monitoring

      Jobs progress through statuses: PENDING → RUNNING → terminal state

      Terminal states:

      • COMPLETED: Job finished successfully; query IoT SiteWise for semantic search results
      • FAILED: Job encountered an error; check failureMessage for details
      • TIMED_OUT: Job exceeded maximum processing time
      • CANCELLED: Job was cancelled via CancelEnrichmentJob

      Response Fields

      The response includes:

      • Current job status and type
      • Full job configuration as originally submitted
      • Lifecycle timestamps (created, updated, completed, cancelled)
      • Failure details if status is FAILED
      Parameters:
      describeEnrichmentJobRequest -
      Returns:
      A Java Future containing the result of the DescribeEnrichmentJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.

      • ResourceNotFoundException The requested resource can't be found.
      • LimitExceededException You've reached the quota 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:

    • describeEnrichmentJob

      default CompletableFuture<DescribeEnrichmentJobResponse> describeEnrichmentJob(Consumer<DescribeEnrichmentJobRequest.Builder> describeEnrichmentJobRequest)

      Retrieves detailed information about a specific enrichment job, including its current status, configuration, and timestamps.

      Use Cases

      • Monitor job progress by checking status updates with DescribeEnrichmentJob
      • Retrieve the complete job configuration submitted during creation
      • Debug failed jobs by examining the failureMessage field
      • Track job lifecycle with creation, update, completion, and cancellation timestamps

      Status Monitoring

      Jobs progress through statuses: PENDING → RUNNING → terminal state

      Terminal states:

      • COMPLETED: Job finished successfully; query IoT SiteWise for semantic search results
      • FAILED: Job encountered an error; check failureMessage for details
      • TIMED_OUT: Job exceeded maximum processing time
      • CANCELLED: Job was cancelled via CancelEnrichmentJob

      Response Fields

      The response includes:

      • Current job status and type
      • Full job configuration as originally submitted
      • Lifecycle timestamps (created, updated, completed, cancelled)
      • Failure details if status is FAILED

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

      Parameters:
      describeEnrichmentJobRequest - A Consumer that will call methods on DescribeEnrichmentJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeEnrichmentJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.

      • ResourceNotFoundException The requested resource can't be found.
      • LimitExceededException You've reached the quota 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:

    • describeExecution

      default CompletableFuture<DescribeExecutionResponse> describeExecution(DescribeExecutionRequest describeExecutionRequest)

      Retrieves information about the execution.

      Parameters:
      describeExecutionRequest -
      Returns:
      A Java Future containing the result of the DescribeExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally 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:

    • describeExecution

      default CompletableFuture<DescribeExecutionResponse> describeExecution(Consumer<DescribeExecutionRequest.Builder> describeExecutionRequest)

      Retrieves information about the execution.


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

      Parameters:
      describeExecutionRequest - A Consumer that will call methods on DescribeExecutionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally 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(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)

      Each gateway capability defines data sources for a gateway. This is the namespace of the gateway capability.

      . The namespace follows the format service:capability:version, where:

      • service - The service providing the capability, or iotsitewise.

      • capability - The specific capability type. Options include: opcuacollector for the OPC UA data source collector, or publisher for data publisher capability.

      • version - The version number of the capability. Option include 2 for Classic streams, V2 gateways, and 3 for MQTT-enabled, V3 gateways.

      After updating a capability configuration, the sync status becomes OUT_OF_SYNC until the gateway processes the configuration.Use DescribeGatewayCapabilityConfiguration to check the sync status and verify the configuration was applied.

      A gateway can have multiple capability configurations with different namespaces.

      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)

      Each gateway capability defines data sources for a gateway. This is the namespace of the gateway capability.

      . The namespace follows the format service:capability:version, where:

      • service - The service providing the capability, or iotsitewise.

      • capability - The specific capability type. Options include: opcuacollector for the OPC UA data source collector, or publisher for data publisher capability.

      • version - The version number of the capability. Option include 2 for Classic streams, V2 gateways, and 3 for MQTT-enabled, V3 gateways.

      After updating a capability configuration, the sync status becomes OUT_OF_SYNC until the gateway processes the configuration.Use DescribeGatewayCapabilityConfiguration to check the sync status and verify the configuration was applied.

      A gateway can have multiple capability configurations with different namespaces.


      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:

    • describePipeline

      default CompletableFuture<DescribePipelineResponse> describePipeline(DescribePipelineRequest describePipelineRequest)

      Retrieves detailed information about a specific pipeline in a workspace.

      Parameters:
      describePipelineRequest - Request structure for DescribePipeline operation.
      Returns:
      A Java Future containing the result of the DescribePipeline operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • describePipeline

      default CompletableFuture<DescribePipelineResponse> describePipeline(Consumer<DescribePipelineRequest.Builder> describePipelineRequest)

      Retrieves detailed information about a specific pipeline in a workspace.


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

      Parameters:
      describePipelineRequest - A Consumer that will call methods on DescribePipelineRequest.Builder to create a request. Request structure for DescribePipeline operation.
      Returns:
      A Java Future containing the result of the DescribePipeline operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • describePipelineExecution

      default CompletableFuture<DescribePipelineExecutionResponse> describePipelineExecution(DescribePipelineExecutionRequest describePipelineExecutionRequest)

      Retrieves detailed information about a specific pipeline execution, including the overall execution status and the status of each individual compute node. Use this operation to monitor execution progress and inspect per-node results, environment variables, and error details.

      Parameters:
      describePipelineExecutionRequest - Request structure for DescribePipelineExecution operation.
      Returns:
      A Java Future containing the result of the DescribePipelineExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • describePipelineExecution

      default CompletableFuture<DescribePipelineExecutionResponse> describePipelineExecution(Consumer<DescribePipelineExecutionRequest.Builder> describePipelineExecutionRequest)

      Retrieves detailed information about a specific pipeline execution, including the overall execution status and the status of each individual compute node. Use this operation to monitor execution progress and inspect per-node results, environment variables, and error details.


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

      Parameters:
      describePipelineExecutionRequest - A Consumer that will call methods on DescribePipelineExecutionRequest.Builder to create a request. Request structure for DescribePipelineExecution operation.
      Returns:
      A Java Future containing the result of the DescribePipelineExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • describePipelineExecutionPaginator

      default DescribePipelineExecutionPublisher describePipelineExecutionPaginator(DescribePipelineExecutionRequest describePipelineExecutionRequest)

      This is a variant of describePipelineExecution(software.amazon.awssdk.services.iotsitewise.model.DescribePipelineExecutionRequest) 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.DescribePipelineExecutionPublisher publisher = client.describePipelineExecutionPaginator(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.DescribePipelineExecutionPublisher publisher = client.describePipelineExecutionPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.DescribePipelineExecutionResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotsitewise.model.DescribePipelineExecutionResponse 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 describePipelineExecution(software.amazon.awssdk.services.iotsitewise.model.DescribePipelineExecutionRequest) operation.

      Parameters:
      describePipelineExecutionRequest - Request structure for DescribePipelineExecution operation.
      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.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • describePipelineExecutionPaginator

      default DescribePipelineExecutionPublisher describePipelineExecutionPaginator(Consumer<DescribePipelineExecutionRequest.Builder> describePipelineExecutionRequest)

      This is a variant of describePipelineExecution(software.amazon.awssdk.services.iotsitewise.model.DescribePipelineExecutionRequest) 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.DescribePipelineExecutionPublisher publisher = client.describePipelineExecutionPaginator(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.DescribePipelineExecutionPublisher publisher = client.describePipelineExecutionPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.DescribePipelineExecutionResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotsitewise.model.DescribePipelineExecutionResponse 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 describePipelineExecution(software.amazon.awssdk.services.iotsitewise.model.DescribePipelineExecutionRequest) operation.


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

      Parameters:
      describePipelineExecutionRequest - A Consumer that will call methods on DescribePipelineExecutionRequest.Builder to create a request. Request structure for DescribePipelineExecution operation.
      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.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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(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:

    • describeQuery

      default CompletableFuture<DescribeQueryResponse> describeQuery(DescribeQueryRequest describeQueryRequest)

      Retrieves information about a query, including its status.

      Parameters:
      describeQueryRequest -
      Returns:
      A Java Future containing the result of the DescribeQuery operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • describeQuery

      default CompletableFuture<DescribeQueryResponse> describeQuery(Consumer<DescribeQueryRequest.Builder> describeQueryRequest)

      Retrieves information about a query, including its status.


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

      Parameters:
      describeQueryRequest - A Consumer that will call methods on DescribeQueryRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeQuery operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • describeSearch

      default CompletableFuture<DescribeSearchResponse> describeSearch(DescribeSearchRequest describeSearchRequest)

      Returns the current status and metadata of a single search, including the query that was submitted, the search type, and — when the search has failed — the reason. Use this to poll a search started with StartSearch until it reaches a terminal status (SUCCEEDED or FAILED).

      Parameters:
      describeSearchRequest - Input for the DescribeSearch operation.
      Returns:
      A Java Future containing the result of the DescribeSearch operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • describeSearch

      default CompletableFuture<DescribeSearchResponse> describeSearch(Consumer<DescribeSearchRequest.Builder> describeSearchRequest)

      Returns the current status and metadata of a single search, including the query that was submitted, the search type, and — when the search has failed — the reason. Use this to poll a search started with StartSearch until it reaches a terminal status (SUCCEEDED or FAILED).


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

      Parameters:
      describeSearchRequest - A Consumer that will call methods on DescribeSearchRequest.Builder to create a request. Input for the DescribeSearch operation.
      Returns:
      A Java Future containing the result of the DescribeSearch operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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 quota 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 quota 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:

    • describeTask

      default CompletableFuture<DescribeTaskResponse> describeTask(DescribeTaskRequest describeTaskRequest)

      Retrieves detailed information about a specific task in a workspace.

      Parameters:
      describeTaskRequest - Request structure for DescribeTask operation.
      Returns:
      A Java Future containing the result of the DescribeTask operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • describeTask

      default CompletableFuture<DescribeTaskResponse> describeTask(Consumer<DescribeTaskRequest.Builder> describeTaskRequest)

      Retrieves detailed information about a specific task in a workspace.


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

      Parameters:
      describeTaskRequest - A Consumer that will call methods on DescribeTaskRequest.Builder to create a request. Request structure for DescribeTask operation.
      Returns:
      A Java Future containing the result of the DescribeTask operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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(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:

    • describeWorkspace

      default CompletableFuture<DescribeWorkspaceResponse> describeWorkspace(DescribeWorkspaceRequest describeWorkspaceRequest)

      Retrieves information about a workspace.

      Parameters:
      describeWorkspaceRequest -
      Returns:
      A Java Future containing the result of the DescribeWorkspace operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException Access is denied.
      • ResourceNotFoundException The requested resource can't be found.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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:

    • describeWorkspace

      default CompletableFuture<DescribeWorkspaceResponse> describeWorkspace(Consumer<DescribeWorkspaceRequest.Builder> describeWorkspaceRequest)

      Retrieves information about a workspace.


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

      Parameters:
      describeWorkspaceRequest - A Consumer that will call methods on DescribeWorkspaceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeWorkspace operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException Access is denied.
      • ResourceNotFoundException The requested resource can't be found.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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 quota 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 quota 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:

    • getCaptureData

      default CompletableFuture<GetCaptureDataResponse> getCaptureData(GetCaptureDataRequest getCaptureDataRequest)

      Retrieves video data for a specific time range.

      Parameters:
      getCaptureDataRequest - Request to retrieve video data for a specific time range. Exactly one of timeSeriesId or propertyAlias must be provided.
      Returns:
      A Java Future containing the result of the GetCaptureData operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • getCaptureData

      default CompletableFuture<GetCaptureDataResponse> getCaptureData(Consumer<GetCaptureDataRequest.Builder> getCaptureDataRequest)

      Retrieves video data for a specific time range.


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

      Parameters:
      getCaptureDataRequest - A Consumer that will call methods on GetCaptureDataRequest.Builder to create a request. Request to retrieve video data for a specific time range. Exactly one of timeSeriesId or propertyAlias must be provided.
      Returns:
      A Java Future containing the result of the GetCaptureData operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • 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:

    • getQueryResults

      default CompletableFuture<GetQueryResultsResponse> getQueryResults(GetQueryResultsRequest getQueryResultsRequest)

      Retrieves the paginated results of a query. Returns empty rows if the query is not yet complete.

      Parameters:
      getQueryResultsRequest -
      Returns:
      A Java Future containing the result of the GetQueryResults operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • getQueryResults

      default CompletableFuture<GetQueryResultsResponse> getQueryResults(Consumer<GetQueryResultsRequest.Builder> getQueryResultsRequest)

      Retrieves the paginated results of a query. Returns empty rows if the query is not yet complete.


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

      Parameters:
      getQueryResultsRequest - A Consumer that will call methods on GetQueryResultsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetQueryResults operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • getQueryResultsPaginator

      default GetQueryResultsPublisher getQueryResultsPaginator(GetQueryResultsRequest getQueryResultsRequest)

      This is a variant of getQueryResults(software.amazon.awssdk.services.iotsitewise.model.GetQueryResultsRequest) 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.GetQueryResultsPublisher publisher = client.getQueryResultsPaginator(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.GetQueryResultsPublisher publisher = client.getQueryResultsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.GetQueryResultsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotsitewise.model.GetQueryResultsResponse 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 getQueryResults(software.amazon.awssdk.services.iotsitewise.model.GetQueryResultsRequest) operation.

      Parameters:
      getQueryResultsRequest -
      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.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • getQueryResultsPaginator

      default GetQueryResultsPublisher getQueryResultsPaginator(Consumer<GetQueryResultsRequest.Builder> getQueryResultsRequest)

      This is a variant of getQueryResults(software.amazon.awssdk.services.iotsitewise.model.GetQueryResultsRequest) 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.GetQueryResultsPublisher publisher = client.getQueryResultsPaginator(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.GetQueryResultsPublisher publisher = client.getQueryResultsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.GetQueryResultsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotsitewise.model.GetQueryResultsResponse 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 getQueryResults(software.amazon.awssdk.services.iotsitewise.model.GetQueryResultsRequest) operation.


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

      Parameters:
      getQueryResultsRequest - A Consumer that will call methods on GetQueryResultsRequest.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.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • getSearchResults

      default CompletableFuture<GetSearchResultsResponse> getSearchResults(GetSearchResultsRequest getSearchResultsRequest)

      Retrieves the ranked results of a search, ordered by descending relevance score. Results are available only after the search has reached the SUCCEEDED status. Calling this on a search that exists but has not yet completed returns InvalidRequestException, while calling it on a search that does not exist returns ResourceNotFoundException. The response is paginated: when nextToken is present, pass it on a subsequent call to retrieve the next page.

      Parameters:
      getSearchResultsRequest - Input for the GetSearchResults operation.
      Returns:
      A Java Future containing the result of the GetSearchResults operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • getSearchResults

      default CompletableFuture<GetSearchResultsResponse> getSearchResults(Consumer<GetSearchResultsRequest.Builder> getSearchResultsRequest)

      Retrieves the ranked results of a search, ordered by descending relevance score. Results are available only after the search has reached the SUCCEEDED status. Calling this on a search that exists but has not yet completed returns InvalidRequestException, while calling it on a search that does not exist returns ResourceNotFoundException. The response is paginated: when nextToken is present, pass it on a subsequent call to retrieve the next page.


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

      Parameters:
      getSearchResultsRequest - A Consumer that will call methods on GetSearchResultsRequest.Builder to create a request. Input for the GetSearchResults operation.
      Returns:
      A Java Future containing the result of the GetSearchResults operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • getSearchResultsPaginator

      default GetSearchResultsPublisher getSearchResultsPaginator(GetSearchResultsRequest getSearchResultsRequest)

      This is a variant of getSearchResults(software.amazon.awssdk.services.iotsitewise.model.GetSearchResultsRequest) 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.GetSearchResultsPublisher publisher = client.getSearchResultsPaginator(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.GetSearchResultsPublisher publisher = client.getSearchResultsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.GetSearchResultsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotsitewise.model.GetSearchResultsResponse 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 getSearchResults(software.amazon.awssdk.services.iotsitewise.model.GetSearchResultsRequest) operation.

      Parameters:
      getSearchResultsRequest - Input for the GetSearchResults operation.
      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.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • getSearchResultsPaginator

      default GetSearchResultsPublisher getSearchResultsPaginator(Consumer<GetSearchResultsRequest.Builder> getSearchResultsRequest)

      This is a variant of getSearchResults(software.amazon.awssdk.services.iotsitewise.model.GetSearchResultsRequest) 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.GetSearchResultsPublisher publisher = client.getSearchResultsPaginator(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.GetSearchResultsPublisher publisher = client.getSearchResultsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.GetSearchResultsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotsitewise.model.GetSearchResultsResponse 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 getSearchResults(software.amazon.awssdk.services.iotsitewise.model.GetSearchResultsRequest) operation.


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

      Parameters:
      getSearchResultsRequest - A Consumer that will call methods on GetSearchResultsRequest.Builder to create a request. Input for the GetSearchResults operation.
      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.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • invokeAssistant

      default CompletableFuture<Void> invokeAssistant(InvokeAssistantRequest invokeAssistantRequest, InvokeAssistantResponseHandler asyncResponseHandler)

      Invokes SiteWise Assistant to start or continue a conversation.

      Parameters:
      invokeAssistantRequest -
      Returns:
      A Java Future containing the result of the InvokeAssistant operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • LimitExceededException You've reached the quota 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.

      • 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.

      • 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:

    • invokeAssistant

      default CompletableFuture<Void> invokeAssistant(Consumer<InvokeAssistantRequest.Builder> invokeAssistantRequest, InvokeAssistantResponseHandler asyncResponseHandler)

      Invokes SiteWise Assistant to start or continue a conversation.


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

      Parameters:
      invokeAssistantRequest - A Consumer that will call methods on InvokeAssistantRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the InvokeAssistant operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • LimitExceededException You've reached the quota 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.

      • 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.

      • 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:

    • 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:

    • listApplications

      default CompletableFuture<ListApplicationsResponse> listApplications(ListApplicationsRequest listApplicationsRequest)

      Retrieves a paginated list of existing applications

      Parameters:
      listApplicationsRequest -
      Returns:
      A Java Future containing the result of the ListApplications operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • listApplications

      default CompletableFuture<ListApplicationsResponse> listApplications(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest)

      Retrieves a paginated list of existing applications


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

      Parameters:
      listApplicationsRequest - A Consumer that will call methods on ListApplicationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListApplications operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • listApplicationsPaginator

      default ListApplicationsPublisher listApplicationsPaginator(ListApplicationsRequest listApplicationsRequest)

      This is a variant of listApplications(software.amazon.awssdk.services.iotsitewise.model.ListApplicationsRequest) 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.ListApplicationsPublisher publisher = client.listApplicationsPaginator(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.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListApplicationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListApplicationsResponse 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 listApplications(software.amazon.awssdk.services.iotsitewise.model.ListApplicationsRequest) operation.

      Parameters:
      listApplicationsRequest -
      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.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • listApplicationsPaginator

      default ListApplicationsPublisher listApplicationsPaginator(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest)

      This is a variant of listApplications(software.amazon.awssdk.services.iotsitewise.model.ListApplicationsRequest) 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.ListApplicationsPublisher publisher = client.listApplicationsPaginator(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.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListApplicationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListApplicationsResponse 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 listApplications(software.amazon.awssdk.services.iotsitewise.model.ListApplicationsRequest) operation.


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

      Parameters:
      listApplicationsRequest - A Consumer that will call methods on ListApplicationsRequest.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.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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.
      • 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:

    • 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.
      • 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:

    • 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.
      • 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:

    • 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.
      • 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:

    • 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:

    • listComputationModelDataBindingUsages

      default CompletableFuture<ListComputationModelDataBindingUsagesResponse> listComputationModelDataBindingUsages(ListComputationModelDataBindingUsagesRequest listComputationModelDataBindingUsagesRequest)

      Lists all data binding usages for computation models. This allows to identify where specific data bindings are being utilized across the computation models. This track dependencies between data sources and computation models.

      Parameters:
      listComputationModelDataBindingUsagesRequest -
      Returns:
      A Java Future containing the result of the ListComputationModelDataBindingUsages operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally 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:

    • listComputationModelDataBindingUsages

      default CompletableFuture<ListComputationModelDataBindingUsagesResponse> listComputationModelDataBindingUsages(Consumer<ListComputationModelDataBindingUsagesRequest.Builder> listComputationModelDataBindingUsagesRequest)

      Lists all data binding usages for computation models. This allows to identify where specific data bindings are being utilized across the computation models. This track dependencies between data sources and computation models.


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

      Parameters:
      listComputationModelDataBindingUsagesRequest - A Consumer that will call methods on ListComputationModelDataBindingUsagesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListComputationModelDataBindingUsages operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally 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:

    • listComputationModelDataBindingUsagesPaginator

      default ListComputationModelDataBindingUsagesPublisher listComputationModelDataBindingUsagesPaginator(ListComputationModelDataBindingUsagesRequest listComputationModelDataBindingUsagesRequest)

      This is a variant of listComputationModelDataBindingUsages(software.amazon.awssdk.services.iotsitewise.model.ListComputationModelDataBindingUsagesRequest) 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.ListComputationModelDataBindingUsagesPublisher publisher = client.listComputationModelDataBindingUsagesPaginator(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.ListComputationModelDataBindingUsagesPublisher publisher = client.listComputationModelDataBindingUsagesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListComputationModelDataBindingUsagesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListComputationModelDataBindingUsagesResponse 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 listComputationModelDataBindingUsages(software.amazon.awssdk.services.iotsitewise.model.ListComputationModelDataBindingUsagesRequest) operation.

      Parameters:
      listComputationModelDataBindingUsagesRequest -
      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:

    • listComputationModelDataBindingUsagesPaginator

      default ListComputationModelDataBindingUsagesPublisher listComputationModelDataBindingUsagesPaginator(Consumer<ListComputationModelDataBindingUsagesRequest.Builder> listComputationModelDataBindingUsagesRequest)

      This is a variant of listComputationModelDataBindingUsages(software.amazon.awssdk.services.iotsitewise.model.ListComputationModelDataBindingUsagesRequest) 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.ListComputationModelDataBindingUsagesPublisher publisher = client.listComputationModelDataBindingUsagesPaginator(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.ListComputationModelDataBindingUsagesPublisher publisher = client.listComputationModelDataBindingUsagesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListComputationModelDataBindingUsagesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListComputationModelDataBindingUsagesResponse 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 listComputationModelDataBindingUsages(software.amazon.awssdk.services.iotsitewise.model.ListComputationModelDataBindingUsagesRequest) operation.


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

      Parameters:
      listComputationModelDataBindingUsagesRequest - A Consumer that will call methods on ListComputationModelDataBindingUsagesRequest.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:

    • listComputationModelResolveToResources

      default CompletableFuture<ListComputationModelResolveToResourcesResponse> listComputationModelResolveToResources(ListComputationModelResolveToResourcesRequest listComputationModelResolveToResourcesRequest)

      Lists all distinct resources that are resolved from the executed actions of the computation model.

      Parameters:
      listComputationModelResolveToResourcesRequest -
      Returns:
      A Java Future containing the result of the ListComputationModelResolveToResources operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally 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:

    • listComputationModelResolveToResources

      default CompletableFuture<ListComputationModelResolveToResourcesResponse> listComputationModelResolveToResources(Consumer<ListComputationModelResolveToResourcesRequest.Builder> listComputationModelResolveToResourcesRequest)

      Lists all distinct resources that are resolved from the executed actions of the computation model.


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

      Parameters:
      listComputationModelResolveToResourcesRequest - A Consumer that will call methods on ListComputationModelResolveToResourcesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListComputationModelResolveToResources operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally 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:

    • listComputationModelResolveToResourcesPaginator

      default ListComputationModelResolveToResourcesPublisher listComputationModelResolveToResourcesPaginator(ListComputationModelResolveToResourcesRequest listComputationModelResolveToResourcesRequest)

      This is a variant of listComputationModelResolveToResources(software.amazon.awssdk.services.iotsitewise.model.ListComputationModelResolveToResourcesRequest) 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.ListComputationModelResolveToResourcesPublisher publisher = client.listComputationModelResolveToResourcesPaginator(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.ListComputationModelResolveToResourcesPublisher publisher = client.listComputationModelResolveToResourcesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListComputationModelResolveToResourcesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListComputationModelResolveToResourcesResponse 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 listComputationModelResolveToResources(software.amazon.awssdk.services.iotsitewise.model.ListComputationModelResolveToResourcesRequest) operation.

      Parameters:
      listComputationModelResolveToResourcesRequest -
      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:

    • listComputationModelResolveToResourcesPaginator

      default ListComputationModelResolveToResourcesPublisher listComputationModelResolveToResourcesPaginator(Consumer<ListComputationModelResolveToResourcesRequest.Builder> listComputationModelResolveToResourcesRequest)

      This is a variant of listComputationModelResolveToResources(software.amazon.awssdk.services.iotsitewise.model.ListComputationModelResolveToResourcesRequest) 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.ListComputationModelResolveToResourcesPublisher publisher = client.listComputationModelResolveToResourcesPaginator(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.ListComputationModelResolveToResourcesPublisher publisher = client.listComputationModelResolveToResourcesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListComputationModelResolveToResourcesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListComputationModelResolveToResourcesResponse 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 listComputationModelResolveToResources(software.amazon.awssdk.services.iotsitewise.model.ListComputationModelResolveToResourcesRequest) operation.


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

      Parameters:
      listComputationModelResolveToResourcesRequest - A Consumer that will call methods on ListComputationModelResolveToResourcesRequest.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:

    • listComputationModels

      default CompletableFuture<ListComputationModelsResponse> listComputationModels(ListComputationModelsRequest listComputationModelsRequest)

      Retrieves a paginated list of summaries of all computation models.

      Parameters:
      listComputationModelsRequest -
      Returns:
      A Java Future containing the result of the ListComputationModels operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally 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:

    • listComputationModels

      default CompletableFuture<ListComputationModelsResponse> listComputationModels(Consumer<ListComputationModelsRequest.Builder> listComputationModelsRequest)

      Retrieves a paginated list of summaries of all computation models.


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

      Parameters:
      listComputationModelsRequest - A Consumer that will call methods on ListComputationModelsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListComputationModels operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally 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:

    • listComputationModelsPaginator

      default ListComputationModelsPublisher listComputationModelsPaginator(ListComputationModelsRequest listComputationModelsRequest)

      This is a variant of listComputationModels(software.amazon.awssdk.services.iotsitewise.model.ListComputationModelsRequest) 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.ListComputationModelsPublisher publisher = client.listComputationModelsPaginator(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.ListComputationModelsPublisher publisher = client.listComputationModelsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListComputationModelsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListComputationModelsResponse 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 listComputationModels(software.amazon.awssdk.services.iotsitewise.model.ListComputationModelsRequest) operation.

      Parameters:
      listComputationModelsRequest -
      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:

    • listComputationModelsPaginator

      default ListComputationModelsPublisher listComputationModelsPaginator(Consumer<ListComputationModelsRequest.Builder> listComputationModelsRequest)

      This is a variant of listComputationModels(software.amazon.awssdk.services.iotsitewise.model.ListComputationModelsRequest) 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.ListComputationModelsPublisher publisher = client.listComputationModelsPaginator(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.ListComputationModelsPublisher publisher = client.listComputationModelsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListComputationModelsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListComputationModelsResponse 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 listComputationModels(software.amazon.awssdk.services.iotsitewise.model.ListComputationModelsRequest) operation.


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

      Parameters:
      listComputationModelsRequest - A Consumer that will call methods on ListComputationModelsRequest.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:

    • 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:

    • listDatasetDataSegmentRelationships

      default CompletableFuture<ListDatasetDataSegmentRelationshipsResponse> listDatasetDataSegmentRelationships(ListDatasetDataSegmentRelationshipsRequest listDatasetDataSegmentRelationshipsRequest)

      Retrieves a paginated list of data segment relationships for a session dataset. Use this operation to find the curated datasets that reference data segments of the specified session dataset. Use the nextToken parameter to retrieve additional results.

      Parameters:
      listDatasetDataSegmentRelationshipsRequest -
      Returns:
      A Java Future containing the result of the ListDatasetDataSegmentRelationships operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally 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:

    • listDatasetDataSegmentRelationships

      default CompletableFuture<ListDatasetDataSegmentRelationshipsResponse> listDatasetDataSegmentRelationships(Consumer<ListDatasetDataSegmentRelationshipsRequest.Builder> listDatasetDataSegmentRelationshipsRequest)

      Retrieves a paginated list of data segment relationships for a session dataset. Use this operation to find the curated datasets that reference data segments of the specified session dataset. Use the nextToken parameter to retrieve additional results.


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

      Parameters:
      listDatasetDataSegmentRelationshipsRequest - A Consumer that will call methods on ListDatasetDataSegmentRelationshipsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListDatasetDataSegmentRelationships operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally 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:

    • listDatasetDataSegmentRelationshipsPaginator

      default ListDatasetDataSegmentRelationshipsPublisher listDatasetDataSegmentRelationshipsPaginator(ListDatasetDataSegmentRelationshipsRequest listDatasetDataSegmentRelationshipsRequest)

      This is a variant of listDatasetDataSegmentRelationships(software.amazon.awssdk.services.iotsitewise.model.ListDatasetDataSegmentRelationshipsRequest) 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.ListDatasetDataSegmentRelationshipsPublisher publisher = client.listDatasetDataSegmentRelationshipsPaginator(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.ListDatasetDataSegmentRelationshipsPublisher publisher = client.listDatasetDataSegmentRelationshipsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListDatasetDataSegmentRelationshipsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListDatasetDataSegmentRelationshipsResponse 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 listDatasetDataSegmentRelationships(software.amazon.awssdk.services.iotsitewise.model.ListDatasetDataSegmentRelationshipsRequest) operation.

      Parameters:
      listDatasetDataSegmentRelationshipsRequest -
      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:

    • listDatasetDataSegmentRelationshipsPaginator

      default ListDatasetDataSegmentRelationshipsPublisher listDatasetDataSegmentRelationshipsPaginator(Consumer<ListDatasetDataSegmentRelationshipsRequest.Builder> listDatasetDataSegmentRelationshipsRequest)

      This is a variant of listDatasetDataSegmentRelationships(software.amazon.awssdk.services.iotsitewise.model.ListDatasetDataSegmentRelationshipsRequest) 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.ListDatasetDataSegmentRelationshipsPublisher publisher = client.listDatasetDataSegmentRelationshipsPaginator(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.ListDatasetDataSegmentRelationshipsPublisher publisher = client.listDatasetDataSegmentRelationshipsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListDatasetDataSegmentRelationshipsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListDatasetDataSegmentRelationshipsResponse 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 listDatasetDataSegmentRelationships(software.amazon.awssdk.services.iotsitewise.model.ListDatasetDataSegmentRelationshipsRequest) operation.


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

      Parameters:
      listDatasetDataSegmentRelationshipsRequest - A Consumer that will call methods on ListDatasetDataSegmentRelationshipsRequest.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:

    • listDatasetDataSegments

      default CompletableFuture<ListDatasetDataSegmentsResponse> listDatasetDataSegments(ListDatasetDataSegmentsRequest listDatasetDataSegmentsRequest)

      Retrieves a paginated list of data segments associated with a dataset. Use the nextToken parameter to retrieve additional results.

      Parameters:
      listDatasetDataSegmentsRequest -
      Returns:
      A Java Future containing the result of the ListDatasetDataSegments operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally 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:

    • listDatasetDataSegments

      default CompletableFuture<ListDatasetDataSegmentsResponse> listDatasetDataSegments(Consumer<ListDatasetDataSegmentsRequest.Builder> listDatasetDataSegmentsRequest)

      Retrieves a paginated list of data segments associated with a dataset. Use the nextToken parameter to retrieve additional results.


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

      Parameters:
      listDatasetDataSegmentsRequest - A Consumer that will call methods on ListDatasetDataSegmentsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListDatasetDataSegments operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally 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:

    • listDatasetDataSegmentsPaginator

      default ListDatasetDataSegmentsPublisher listDatasetDataSegmentsPaginator(ListDatasetDataSegmentsRequest listDatasetDataSegmentsRequest)

      This is a variant of listDatasetDataSegments(software.amazon.awssdk.services.iotsitewise.model.ListDatasetDataSegmentsRequest) 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.ListDatasetDataSegmentsPublisher publisher = client.listDatasetDataSegmentsPaginator(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.ListDatasetDataSegmentsPublisher publisher = client.listDatasetDataSegmentsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListDatasetDataSegmentsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListDatasetDataSegmentsResponse 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 listDatasetDataSegments(software.amazon.awssdk.services.iotsitewise.model.ListDatasetDataSegmentsRequest) operation.

      Parameters:
      listDatasetDataSegmentsRequest -
      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:

    • listDatasetDataSegmentsPaginator

      default ListDatasetDataSegmentsPublisher listDatasetDataSegmentsPaginator(Consumer<ListDatasetDataSegmentsRequest.Builder> listDatasetDataSegmentsRequest)

      This is a variant of listDatasetDataSegments(software.amazon.awssdk.services.iotsitewise.model.ListDatasetDataSegmentsRequest) 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.ListDatasetDataSegmentsPublisher publisher = client.listDatasetDataSegmentsPaginator(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.ListDatasetDataSegmentsPublisher publisher = client.listDatasetDataSegmentsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListDatasetDataSegmentsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListDatasetDataSegmentsResponse 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 listDatasetDataSegments(software.amazon.awssdk.services.iotsitewise.model.ListDatasetDataSegmentsRequest) operation.


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

      Parameters:
      listDatasetDataSegmentsRequest - A Consumer that will call methods on ListDatasetDataSegmentsRequest.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:

    • listDatasetExportJobs

      default CompletableFuture<ListDatasetExportJobsResponse> listDatasetExportJobs(ListDatasetExportJobsRequest listDatasetExportJobsRequest)

      Retrieves a paginated list of dataset export jobs for a workspace.

      Parameters:
      listDatasetExportJobsRequest - Request to list dataset export jobs for a workspace.
      Returns:
      A Java Future containing the result of the ListDatasetExportJobs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • listDatasetExportJobs

      default CompletableFuture<ListDatasetExportJobsResponse> listDatasetExportJobs(Consumer<ListDatasetExportJobsRequest.Builder> listDatasetExportJobsRequest)

      Retrieves a paginated list of dataset export jobs for a workspace.


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

      Parameters:
      listDatasetExportJobsRequest - A Consumer that will call methods on ListDatasetExportJobsRequest.Builder to create a request. Request to list dataset export jobs for a workspace.
      Returns:
      A Java Future containing the result of the ListDatasetExportJobs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • listDatasetExportJobsPaginator

      default ListDatasetExportJobsPublisher listDatasetExportJobsPaginator(ListDatasetExportJobsRequest listDatasetExportJobsRequest)

      This is a variant of listDatasetExportJobs(software.amazon.awssdk.services.iotsitewise.model.ListDatasetExportJobsRequest) 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.ListDatasetExportJobsPublisher publisher = client.listDatasetExportJobsPaginator(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.ListDatasetExportJobsPublisher publisher = client.listDatasetExportJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListDatasetExportJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListDatasetExportJobsResponse 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 listDatasetExportJobs(software.amazon.awssdk.services.iotsitewise.model.ListDatasetExportJobsRequest) operation.

      Parameters:
      listDatasetExportJobsRequest - Request to list dataset export jobs for a workspace.
      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.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • listDatasetExportJobsPaginator

      default ListDatasetExportJobsPublisher listDatasetExportJobsPaginator(Consumer<ListDatasetExportJobsRequest.Builder> listDatasetExportJobsRequest)

      This is a variant of listDatasetExportJobs(software.amazon.awssdk.services.iotsitewise.model.ListDatasetExportJobsRequest) 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.ListDatasetExportJobsPublisher publisher = client.listDatasetExportJobsPaginator(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.ListDatasetExportJobsPublisher publisher = client.listDatasetExportJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListDatasetExportJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListDatasetExportJobsResponse 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 listDatasetExportJobs(software.amazon.awssdk.services.iotsitewise.model.ListDatasetExportJobsRequest) operation.


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

      Parameters:
      listDatasetExportJobsRequest - A Consumer that will call methods on ListDatasetExportJobsRequest.Builder to create a request. Request to list dataset export jobs for a workspace.
      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.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • listDatasets

      default CompletableFuture<ListDatasetsResponse> listDatasets(ListDatasetsRequest listDatasetsRequest)

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

      Parameters:
      listDatasetsRequest -
      Returns:
      A Java Future containing the result of the ListDatasets operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally 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:

    • listDatasets

      default CompletableFuture<ListDatasetsResponse> listDatasets(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest)

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


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

      Parameters:
      listDatasetsRequest - A Consumer that will call methods on ListDatasetsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListDatasets operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally 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:

    • listDatasetsPaginator

      default ListDatasetsPublisher listDatasetsPaginator(ListDatasetsRequest listDatasetsRequest)

      This is a variant of listDatasets(software.amazon.awssdk.services.iotsitewise.model.ListDatasetsRequest) 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.ListDatasetsPublisher publisher = client.listDatasetsPaginator(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.ListDatasetsPublisher publisher = client.listDatasetsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListDatasetsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListDatasetsResponse 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 listDatasets(software.amazon.awssdk.services.iotsitewise.model.ListDatasetsRequest) operation.

      Parameters:
      listDatasetsRequest -
      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:

    • listDatasetsPaginator

      default ListDatasetsPublisher listDatasetsPaginator(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest)

      This is a variant of listDatasets(software.amazon.awssdk.services.iotsitewise.model.ListDatasetsRequest) 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.ListDatasetsPublisher publisher = client.listDatasetsPaginator(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.ListDatasetsPublisher publisher = client.listDatasetsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListDatasetsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListDatasetsResponse 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 listDatasets(software.amazon.awssdk.services.iotsitewise.model.ListDatasetsRequest) operation.


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

      Parameters:
      listDatasetsRequest - A Consumer that will call methods on ListDatasetsRequest.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:

    • listEnrichmentJobs

      default CompletableFuture<ListEnrichmentJobsResponse> listEnrichmentJobs(ListEnrichmentJobsRequest listEnrichmentJobsRequest)

      Lists enrichment jobs within a workspace with optional filtering and pagination. Results are ordered by createdAt timestamp descending (newest first).

      Filtering

      Combine filters to narrow results:

      • datasetId: Filter by dataset
      • propertyAlias OR timeSeriesId: Filter by time series (specify one, not both)
      • status: Filter by job status (e.g., RUNNING to find active jobs)
      • jobType: Filter by enrichment type (currently only EVENT_DETECTION)
      • startDate and endDate: Filter by job creation time range

      Important Constraints

      • You must specify either propertyAlias OR timeSeriesId, but not both
      • Attempting to specify both results in an InvalidRequestException
      • Date filters use ISO 8601 format
      • startDate is exclusive, endDate is inclusive

      Pagination

      The operation returns up to maxResults jobs per page (default 50). If more results exist, the response includes a nextToken. Submit this token in a subsequent request to retrieve the next page.

      Common Use Cases

      • Find all running jobs: Filter by status=RUNNING
      • List recent jobs for a dataset: Filter by datasetId with optional date range
      • Monitor jobs for a specific sensor: Filter by propertyAlias or timeSeriesId
      • Track all event detection jobs: Filter by jobType=EVENT_DETECTION

      Performance

      Performance is optimal when filtering by supported fields (datasetId, propertyAlias, timeSeriesId, status, jobType).

      Parameters:
      listEnrichmentJobsRequest -
      Returns:
      A Java Future containing the result of the ListEnrichmentJobs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.

      • ResourceNotFoundException The requested resource can't be found.
      • LimitExceededException You've reached the quota 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:

    • listEnrichmentJobs

      default CompletableFuture<ListEnrichmentJobsResponse> listEnrichmentJobs(Consumer<ListEnrichmentJobsRequest.Builder> listEnrichmentJobsRequest)

      Lists enrichment jobs within a workspace with optional filtering and pagination. Results are ordered by createdAt timestamp descending (newest first).

      Filtering

      Combine filters to narrow results:

      • datasetId: Filter by dataset
      • propertyAlias OR timeSeriesId: Filter by time series (specify one, not both)
      • status: Filter by job status (e.g., RUNNING to find active jobs)
      • jobType: Filter by enrichment type (currently only EVENT_DETECTION)
      • startDate and endDate: Filter by job creation time range

      Important Constraints

      • You must specify either propertyAlias OR timeSeriesId, but not both
      • Attempting to specify both results in an InvalidRequestException
      • Date filters use ISO 8601 format
      • startDate is exclusive, endDate is inclusive

      Pagination

      The operation returns up to maxResults jobs per page (default 50). If more results exist, the response includes a nextToken. Submit this token in a subsequent request to retrieve the next page.

      Common Use Cases

      • Find all running jobs: Filter by status=RUNNING
      • List recent jobs for a dataset: Filter by datasetId with optional date range
      • Monitor jobs for a specific sensor: Filter by propertyAlias or timeSeriesId
      • Track all event detection jobs: Filter by jobType=EVENT_DETECTION

      Performance

      Performance is optimal when filtering by supported fields (datasetId, propertyAlias, timeSeriesId, status, jobType).


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

      Parameters:
      listEnrichmentJobsRequest - A Consumer that will call methods on ListEnrichmentJobsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListEnrichmentJobs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.

      • ResourceNotFoundException The requested resource can't be found.
      • LimitExceededException You've reached the quota 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:

    • listEnrichmentJobsPaginator

      default ListEnrichmentJobsPublisher listEnrichmentJobsPaginator(ListEnrichmentJobsRequest listEnrichmentJobsRequest)

      This is a variant of listEnrichmentJobs(software.amazon.awssdk.services.iotsitewise.model.ListEnrichmentJobsRequest) 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.ListEnrichmentJobsPublisher publisher = client.listEnrichmentJobsPaginator(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.ListEnrichmentJobsPublisher publisher = client.listEnrichmentJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListEnrichmentJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListEnrichmentJobsResponse 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 listEnrichmentJobs(software.amazon.awssdk.services.iotsitewise.model.ListEnrichmentJobsRequest) operation.

      Parameters:
      listEnrichmentJobsRequest -
      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.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.

      • ResourceNotFoundException The requested resource can't be found.
      • LimitExceededException You've reached the quota 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:

    • listEnrichmentJobsPaginator

      default ListEnrichmentJobsPublisher listEnrichmentJobsPaginator(Consumer<ListEnrichmentJobsRequest.Builder> listEnrichmentJobsRequest)

      This is a variant of listEnrichmentJobs(software.amazon.awssdk.services.iotsitewise.model.ListEnrichmentJobsRequest) 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.ListEnrichmentJobsPublisher publisher = client.listEnrichmentJobsPaginator(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.ListEnrichmentJobsPublisher publisher = client.listEnrichmentJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListEnrichmentJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListEnrichmentJobsResponse 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 listEnrichmentJobs(software.amazon.awssdk.services.iotsitewise.model.ListEnrichmentJobsRequest) operation.


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

      Parameters:
      listEnrichmentJobsRequest - A Consumer that will call methods on ListEnrichmentJobsRequest.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.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.

      • ResourceNotFoundException The requested resource can't be found.
      • LimitExceededException You've reached the quota 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:

    • listExecutions

      default CompletableFuture<ListExecutionsResponse> listExecutions(ListExecutionsRequest listExecutionsRequest)

      Retrieves a paginated list of summaries of all executions.

      Parameters:
      listExecutionsRequest -
      Returns:
      A Java Future containing the result of the ListExecutions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally 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:

    • listExecutions

      default CompletableFuture<ListExecutionsResponse> listExecutions(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest)

      Retrieves a paginated list of summaries of all executions.


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

      Parameters:
      listExecutionsRequest - A Consumer that will call methods on ListExecutionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListExecutions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally 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:

    • listExecutionsPaginator

      default ListExecutionsPublisher listExecutionsPaginator(ListExecutionsRequest listExecutionsRequest)

      This is a variant of listExecutions(software.amazon.awssdk.services.iotsitewise.model.ListExecutionsRequest) 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.ListExecutionsPublisher publisher = client.listExecutionsPaginator(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.ListExecutionsPublisher publisher = client.listExecutionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListExecutionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListExecutionsResponse 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 listExecutions(software.amazon.awssdk.services.iotsitewise.model.ListExecutionsRequest) operation.

      Parameters:
      listExecutionsRequest -
      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:

    • listExecutionsPaginator

      default ListExecutionsPublisher listExecutionsPaginator(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest)

      This is a variant of listExecutions(software.amazon.awssdk.services.iotsitewise.model.ListExecutionsRequest) 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.ListExecutionsPublisher publisher = client.listExecutionsPaginator(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.ListExecutionsPublisher publisher = client.listExecutionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListExecutionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListExecutionsResponse 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 listExecutions(software.amazon.awssdk.services.iotsitewise.model.ListExecutionsRequest) operation.


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

      Parameters:
      listExecutionsRequest - A Consumer that will call methods on ListExecutionsRequest.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:

    • 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:

    • listInterfaceRelationships

      default CompletableFuture<ListInterfaceRelationshipsResponse> listInterfaceRelationships(ListInterfaceRelationshipsRequest listInterfaceRelationshipsRequest)

      Retrieves a paginated list of asset models that have a specific interface asset model applied to them.

      Parameters:
      listInterfaceRelationshipsRequest -
      Returns:
      A Java Future containing the result of the ListInterfaceRelationships operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally 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:

    • listInterfaceRelationships

      default CompletableFuture<ListInterfaceRelationshipsResponse> listInterfaceRelationships(Consumer<ListInterfaceRelationshipsRequest.Builder> listInterfaceRelationshipsRequest)

      Retrieves a paginated list of asset models that have a specific interface asset model applied to them.


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

      Parameters:
      listInterfaceRelationshipsRequest - A Consumer that will call methods on ListInterfaceRelationshipsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListInterfaceRelationships operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally 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:

    • listInterfaceRelationshipsPaginator

      default ListInterfaceRelationshipsPublisher listInterfaceRelationshipsPaginator(ListInterfaceRelationshipsRequest listInterfaceRelationshipsRequest)

      This is a variant of listInterfaceRelationships(software.amazon.awssdk.services.iotsitewise.model.ListInterfaceRelationshipsRequest) 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.ListInterfaceRelationshipsPublisher publisher = client.listInterfaceRelationshipsPaginator(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.ListInterfaceRelationshipsPublisher publisher = client.listInterfaceRelationshipsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListInterfaceRelationshipsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListInterfaceRelationshipsResponse 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 listInterfaceRelationships(software.amazon.awssdk.services.iotsitewise.model.ListInterfaceRelationshipsRequest) operation.

      Parameters:
      listInterfaceRelationshipsRequest -
      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:

    • listInterfaceRelationshipsPaginator

      default ListInterfaceRelationshipsPublisher listInterfaceRelationshipsPaginator(Consumer<ListInterfaceRelationshipsRequest.Builder> listInterfaceRelationshipsRequest)

      This is a variant of listInterfaceRelationships(software.amazon.awssdk.services.iotsitewise.model.ListInterfaceRelationshipsRequest) 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.ListInterfaceRelationshipsPublisher publisher = client.listInterfaceRelationshipsPaginator(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.ListInterfaceRelationshipsPublisher publisher = client.listInterfaceRelationshipsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListInterfaceRelationshipsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListInterfaceRelationshipsResponse 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 listInterfaceRelationships(software.amazon.awssdk.services.iotsitewise.model.ListInterfaceRelationshipsRequest) operation.


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

      Parameters:
      listInterfaceRelationshipsRequest - A Consumer that will call methods on ListInterfaceRelationshipsRequest.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:

    • listPipelineExecutions

      default CompletableFuture<ListPipelineExecutionsResponse> listPipelineExecutions(ListPipelineExecutionsRequest listPipelineExecutionsRequest)

      Lists pipeline executions for a specific pipeline in a workspace. Supports filtering by state and time range. State can be combined with either startTime or endTime filters. Time range filters are grouped: use startTime filters (startTimeAfter, startTimeBefore) or endTime filters (endTimeAfter, endTimeBefore), but not both. Combining startTime and endTime filters returns an InvalidRequestException. Note: endTime filters only return executions in terminal states, as in-progress executions have no endTime.

      Parameters:
      listPipelineExecutionsRequest - Request structure for ListPipelineExecutions operation.
      Returns:
      A Java Future containing the result of the ListPipelineExecutions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • listPipelineExecutions

      default CompletableFuture<ListPipelineExecutionsResponse> listPipelineExecutions(Consumer<ListPipelineExecutionsRequest.Builder> listPipelineExecutionsRequest)

      Lists pipeline executions for a specific pipeline in a workspace. Supports filtering by state and time range. State can be combined with either startTime or endTime filters. Time range filters are grouped: use startTime filters (startTimeAfter, startTimeBefore) or endTime filters (endTimeAfter, endTimeBefore), but not both. Combining startTime and endTime filters returns an InvalidRequestException. Note: endTime filters only return executions in terminal states, as in-progress executions have no endTime.


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

      Parameters:
      listPipelineExecutionsRequest - A Consumer that will call methods on ListPipelineExecutionsRequest.Builder to create a request. Request structure for ListPipelineExecutions operation.
      Returns:
      A Java Future containing the result of the ListPipelineExecutions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • listPipelineExecutionsPaginator

      default ListPipelineExecutionsPublisher listPipelineExecutionsPaginator(ListPipelineExecutionsRequest listPipelineExecutionsRequest)

      This is a variant of listPipelineExecutions(software.amazon.awssdk.services.iotsitewise.model.ListPipelineExecutionsRequest) 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.ListPipelineExecutionsPublisher publisher = client.listPipelineExecutionsPaginator(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.ListPipelineExecutionsPublisher publisher = client.listPipelineExecutionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListPipelineExecutionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListPipelineExecutionsResponse 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 listPipelineExecutions(software.amazon.awssdk.services.iotsitewise.model.ListPipelineExecutionsRequest) operation.

      Parameters:
      listPipelineExecutionsRequest - Request structure for ListPipelineExecutions operation.
      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.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • listPipelineExecutionsPaginator

      default ListPipelineExecutionsPublisher listPipelineExecutionsPaginator(Consumer<ListPipelineExecutionsRequest.Builder> listPipelineExecutionsRequest)

      This is a variant of listPipelineExecutions(software.amazon.awssdk.services.iotsitewise.model.ListPipelineExecutionsRequest) 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.ListPipelineExecutionsPublisher publisher = client.listPipelineExecutionsPaginator(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.ListPipelineExecutionsPublisher publisher = client.listPipelineExecutionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListPipelineExecutionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListPipelineExecutionsResponse 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 listPipelineExecutions(software.amazon.awssdk.services.iotsitewise.model.ListPipelineExecutionsRequest) operation.


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

      Parameters:
      listPipelineExecutionsRequest - A Consumer that will call methods on ListPipelineExecutionsRequest.Builder to create a request. Request structure for ListPipelineExecutions operation.
      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.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • listPipelines

      default CompletableFuture<ListPipelinesResponse> listPipelines(ListPipelinesRequest listPipelinesRequest)

      Lists pipelines in a workspace. To get complete details about a pipeline, use DescribePipeline.

      Parameters:
      listPipelinesRequest - Request structure for ListPipelines operation.
      Returns:
      A Java Future containing the result of the ListPipelines operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • listPipelines

      default CompletableFuture<ListPipelinesResponse> listPipelines(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest)

      Lists pipelines in a workspace. To get complete details about a pipeline, use DescribePipeline.


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

      Parameters:
      listPipelinesRequest - A Consumer that will call methods on ListPipelinesRequest.Builder to create a request. Request structure for ListPipelines operation.
      Returns:
      A Java Future containing the result of the ListPipelines operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • listPipelinesPaginator

      default ListPipelinesPublisher listPipelinesPaginator(ListPipelinesRequest listPipelinesRequest)

      This is a variant of listPipelines(software.amazon.awssdk.services.iotsitewise.model.ListPipelinesRequest) 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.ListPipelinesPublisher publisher = client.listPipelinesPaginator(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.ListPipelinesPublisher publisher = client.listPipelinesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListPipelinesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListPipelinesResponse 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 listPipelines(software.amazon.awssdk.services.iotsitewise.model.ListPipelinesRequest) operation.

      Parameters:
      listPipelinesRequest - Request structure for ListPipelines operation.
      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.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • listPipelinesPaginator

      default ListPipelinesPublisher listPipelinesPaginator(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest)

      This is a variant of listPipelines(software.amazon.awssdk.services.iotsitewise.model.ListPipelinesRequest) 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.ListPipelinesPublisher publisher = client.listPipelinesPaginator(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.ListPipelinesPublisher publisher = client.listPipelinesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListPipelinesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListPipelinesResponse 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 listPipelines(software.amazon.awssdk.services.iotsitewise.model.ListPipelinesRequest) operation.


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

      Parameters:
      listPipelinesRequest - A Consumer that will call methods on ListPipelinesRequest.Builder to create a request. Request structure for ListPipelines operation.
      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.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • listQueries

      default CompletableFuture<ListQueriesResponse> listQueries(ListQueriesRequest listQueriesRequest)

      Retrieves a paginated list of queries for a workspace.

      Parameters:
      listQueriesRequest -
      Returns:
      A Java Future containing the result of the ListQueries operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • listQueries

      default CompletableFuture<ListQueriesResponse> listQueries(Consumer<ListQueriesRequest.Builder> listQueriesRequest)

      Retrieves a paginated list of queries for a workspace.


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

      Parameters:
      listQueriesRequest - A Consumer that will call methods on ListQueriesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListQueries operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • listQueriesPaginator

      default ListQueriesPublisher listQueriesPaginator(ListQueriesRequest listQueriesRequest)

      This is a variant of listQueries(software.amazon.awssdk.services.iotsitewise.model.ListQueriesRequest) 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.ListQueriesPublisher publisher = client.listQueriesPaginator(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.ListQueriesPublisher publisher = client.listQueriesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListQueriesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListQueriesResponse 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 listQueries(software.amazon.awssdk.services.iotsitewise.model.ListQueriesRequest) operation.

      Parameters:
      listQueriesRequest -
      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.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • listQueriesPaginator

      default ListQueriesPublisher listQueriesPaginator(Consumer<ListQueriesRequest.Builder> listQueriesRequest)

      This is a variant of listQueries(software.amazon.awssdk.services.iotsitewise.model.ListQueriesRequest) 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.ListQueriesPublisher publisher = client.listQueriesPaginator(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.ListQueriesPublisher publisher = client.listQueriesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListQueriesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListQueriesResponse 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 listQueries(software.amazon.awssdk.services.iotsitewise.model.ListQueriesRequest) operation.


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

      Parameters:
      listQueriesRequest - A Consumer that will call methods on ListQueriesRequest.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.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • listSearches

      default CompletableFuture<ListSearchesResponse> listSearches(ListSearchesRequest listSearchesRequest)

      Lists the searches in a workspace, most recently started first. Results can be narrowed with optional filters (status, search type, group, and started-at time range) and are paginated: when nextToken is present, pass it on a subsequent call to retrieve the next page.

      Parameters:
      listSearchesRequest - Input for the ListSearches operation.
      Returns:
      A Java Future containing the result of the ListSearches operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • listSearches

      default CompletableFuture<ListSearchesResponse> listSearches(Consumer<ListSearchesRequest.Builder> listSearchesRequest)

      Lists the searches in a workspace, most recently started first. Results can be narrowed with optional filters (status, search type, group, and started-at time range) and are paginated: when nextToken is present, pass it on a subsequent call to retrieve the next page.


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

      Parameters:
      listSearchesRequest - A Consumer that will call methods on ListSearchesRequest.Builder to create a request. Input for the ListSearches operation.
      Returns:
      A Java Future containing the result of the ListSearches operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • listSearchesPaginator

      default ListSearchesPublisher listSearchesPaginator(ListSearchesRequest listSearchesRequest)

      This is a variant of listSearches(software.amazon.awssdk.services.iotsitewise.model.ListSearchesRequest) 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.ListSearchesPublisher publisher = client.listSearchesPaginator(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.ListSearchesPublisher publisher = client.listSearchesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListSearchesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListSearchesResponse 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 listSearches(software.amazon.awssdk.services.iotsitewise.model.ListSearchesRequest) operation.

      Parameters:
      listSearchesRequest - Input for the ListSearches operation.
      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.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • listSearchesPaginator

      default ListSearchesPublisher listSearchesPaginator(Consumer<ListSearchesRequest.Builder> listSearchesRequest)

      This is a variant of listSearches(software.amazon.awssdk.services.iotsitewise.model.ListSearchesRequest) 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.ListSearchesPublisher publisher = client.listSearchesPaginator(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.ListSearchesPublisher publisher = client.listSearchesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListSearchesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListSearchesResponse 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 listSearches(software.amazon.awssdk.services.iotsitewise.model.ListSearchesRequest) operation.


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

      Parameters:
      listSearchesRequest - A Consumer that will call methods on ListSearchesRequest.Builder to create a request. Input for the ListSearches operation.
      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.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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 quota 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 quota 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:

    • listTasks

      default CompletableFuture<ListTasksResponse> listTasks(ListTasksRequest listTasksRequest)

      Lists tasks in a workspace. To get complete details about a task, use DescribeTask.

      Parameters:
      listTasksRequest - Request structure for ListTasks operation.
      Returns:
      A Java Future containing the result of the ListTasks operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • listTasks

      default CompletableFuture<ListTasksResponse> listTasks(Consumer<ListTasksRequest.Builder> listTasksRequest)

      Lists tasks in a workspace. To get complete details about a task, use DescribeTask.


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

      Parameters:
      listTasksRequest - A Consumer that will call methods on ListTasksRequest.Builder to create a request. Request structure for ListTasks operation.
      Returns:
      A Java Future containing the result of the ListTasks operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • listTasksPaginator

      default ListTasksPublisher listTasksPaginator(ListTasksRequest listTasksRequest)

      This is a variant of listTasks(software.amazon.awssdk.services.iotsitewise.model.ListTasksRequest) 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.ListTasksPublisher publisher = client.listTasksPaginator(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.ListTasksPublisher publisher = client.listTasksPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListTasksResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListTasksResponse 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 listTasks(software.amazon.awssdk.services.iotsitewise.model.ListTasksRequest) operation.

      Parameters:
      listTasksRequest - Request structure for ListTasks operation.
      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.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • listTasksPaginator

      default ListTasksPublisher listTasksPaginator(Consumer<ListTasksRequest.Builder> listTasksRequest)

      This is a variant of listTasks(software.amazon.awssdk.services.iotsitewise.model.ListTasksRequest) 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.ListTasksPublisher publisher = client.listTasksPaginator(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.ListTasksPublisher publisher = client.listTasksPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListTasksResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListTasksResponse 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 listTasks(software.amazon.awssdk.services.iotsitewise.model.ListTasksRequest) operation.


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

      Parameters:
      listTasksRequest - A Consumer that will call methods on ListTasksRequest.Builder to create a request. Request structure for ListTasks operation.
      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.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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(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:

    • listWorkspaces

      default CompletableFuture<ListWorkspacesResponse> listWorkspaces(ListWorkspacesRequest listWorkspacesRequest)

      Retrieves a paginated list of workspaces. Use the nextToken parameter to retrieve additional results.

      Parameters:
      listWorkspacesRequest -
      Returns:
      A Java Future containing the result of the ListWorkspaces operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException Access is denied.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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:

    • listWorkspaces

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

      Retrieves a paginated list of workspaces. Use the nextToken parameter to retrieve additional results.


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

      Parameters:
      listWorkspacesRequest - A Consumer that will call methods on ListWorkspacesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListWorkspaces operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException Access is denied.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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:

    • listWorkspacesPaginator

      default ListWorkspacesPublisher listWorkspacesPaginator(ListWorkspacesRequest listWorkspacesRequest)

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

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

      The following are few ways to use the response class:

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

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

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

      Parameters:
      listWorkspacesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException Access is denied.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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:

    • listWorkspacesPaginator

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

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

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

      The following are few ways to use the response class:

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

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

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


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

      Parameters:
      listWorkspacesRequest - A Consumer that will call methods on ListWorkspacesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException Access is denied.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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:

    • putAssetModelInterfaceRelationship

      default CompletableFuture<PutAssetModelInterfaceRelationshipResponse> putAssetModelInterfaceRelationship(PutAssetModelInterfaceRelationshipRequest putAssetModelInterfaceRelationshipRequest)

      Creates or updates an interface relationship between an asset model and an interface asset model. This operation applies an interface to an asset model.

      Parameters:
      putAssetModelInterfaceRelationshipRequest -
      Returns:
      A Java Future containing the result of the PutAssetModelInterfaceRelationship operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally 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 quota 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:

    • putAssetModelInterfaceRelationship

      default CompletableFuture<PutAssetModelInterfaceRelationshipResponse> putAssetModelInterfaceRelationship(Consumer<PutAssetModelInterfaceRelationshipRequest.Builder> putAssetModelInterfaceRelationshipRequest)

      Creates or updates an interface relationship between an asset model and an interface asset model. This operation applies an interface to an asset model.


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

      Parameters:
      putAssetModelInterfaceRelationshipRequest - A Consumer that will call methods on PutAssetModelInterfaceRelationshipRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutAssetModelInterfaceRelationship operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally 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 quota 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(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.
      • 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 quota 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.
      • 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 quota 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 quota 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 quota 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:

    • startPipelineExecution

      default CompletableFuture<StartPipelineExecutionResponse> startPipelineExecution(StartPipelineExecutionRequest startPipelineExecutionRequest)

      Starts execution of a pipeline in the specified workspace. Each compute node runs according to the DAG dependency order defined in the pipeline. Nodes without dependencies start immediately, while dependent nodes wait for all upstream nodes to complete successfully.

      You can provide runtime environment variable overrides that take the highest priority in the environment variable hierarchy, without modifying the pipeline definition.

      Parameters:
      startPipelineExecutionRequest - Request structure for StartPipelineExecution operation.
      Returns:
      A Java Future containing the result of the StartPipelineExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • LimitExceededException You've reached the quota 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.

      • 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.
      • 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:

    • startPipelineExecution

      default CompletableFuture<StartPipelineExecutionResponse> startPipelineExecution(Consumer<StartPipelineExecutionRequest.Builder> startPipelineExecutionRequest)

      Starts execution of a pipeline in the specified workspace. Each compute node runs according to the DAG dependency order defined in the pipeline. Nodes without dependencies start immediately, while dependent nodes wait for all upstream nodes to complete successfully.

      You can provide runtime environment variable overrides that take the highest priority in the environment variable hierarchy, without modifying the pipeline definition.


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

      Parameters:
      startPipelineExecutionRequest - A Consumer that will call methods on StartPipelineExecutionRequest.Builder to create a request. Request structure for StartPipelineExecution operation.
      Returns:
      A Java Future containing the result of the StartPipelineExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • LimitExceededException You've reached the quota 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.

      • 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.
      • 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:

    • startQuery

      default CompletableFuture<StartQueryResponse> startQuery(StartQueryRequest startQueryRequest)

      Starts an asynchronous SQL query against workspace telemetry, annotations, data segment, and dataset data.

      Parameters:
      startQueryRequest -
      Returns:
      A Java Future containing the result of the StartQuery operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • startQuery

      default CompletableFuture<StartQueryResponse> startQuery(Consumer<StartQueryRequest.Builder> startQueryRequest)

      Starts an asynchronous SQL query against workspace telemetry, annotations, data segment, and dataset data.


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

      Parameters:
      startQueryRequest - A Consumer that will call methods on StartQueryRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartQuery operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • startSearch

      default CompletableFuture<StartSearchResponse> startSearch(StartSearchRequest startSearchRequest)

      Starts an asynchronous search over the data in a workspace. The search runs in the background; the response returns immediately with a searchId and an initial status of QUEUED. Use DescribeSearch to poll for completion and GetSearchResults to retrieve the results once the search reaches SUCCEEDED. The request is idempotent on clientToken: repeating a call with the same token returns the original search instead of starting a new one.

      Parameters:
      startSearchRequest - Input for the StartSearch operation.
      Returns:
      A Java Future containing the result of the StartSearch operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • LimitExceededException You've reached the quota 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.

      • 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.

      • 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:

    • startSearch

      default CompletableFuture<StartSearchResponse> startSearch(Consumer<StartSearchRequest.Builder> startSearchRequest)

      Starts an asynchronous search over the data in a workspace. The search runs in the background; the response returns immediately with a searchId and an initial status of QUEUED. Use DescribeSearch to poll for completion and GetSearchResults to retrieve the results once the search reaches SUCCEEDED. The request is idempotent on clientToken: repeating a call with the same token returns the original search instead of starting a new one.


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

      Parameters:
      startSearchRequest - A Consumer that will call methods on StartSearchRequest.Builder to create a request. Input for the StartSearch operation.
      Returns:
      A Java Future containing the result of the StartSearch operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • LimitExceededException You've reached the quota 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.

      • 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.

      • 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 quota 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 quota 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 quota 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 quota 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 quota 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 quota 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)

      The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.

      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)

      The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.

      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 quota 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 quota 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 quota 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 quota 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:

    • updateComputationModel

      default CompletableFuture<UpdateComputationModelResponse> updateComputationModel(UpdateComputationModelRequest updateComputationModelRequest)

      Updates the computation model.

      Parameters:
      updateComputationModelRequest -
      Returns:
      A Java Future containing the result of the UpdateComputationModel operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally 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 quota 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:

    • updateComputationModel

      default CompletableFuture<UpdateComputationModelResponse> updateComputationModel(Consumer<UpdateComputationModelRequest.Builder> updateComputationModelRequest)

      Updates the computation model.


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

      Parameters:
      updateComputationModelRequest - A Consumer that will call methods on UpdateComputationModelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateComputationModel operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally 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 quota 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:

    • updateDashboard

      default CompletableFuture<UpdateDashboardResponse> updateDashboard(UpdateDashboardRequest updateDashboardRequest)

      The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.

      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)

      The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.

      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:

    • updateDataset

      default CompletableFuture<UpdateDatasetResponse> updateDataset(UpdateDatasetRequest updateDatasetRequest)

      Updates a dataset.

      Parameters:
      updateDatasetRequest -
      Returns:
      A Java Future containing the result of the UpdateDataset operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally 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 quota 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:

    • updateDataset

      default CompletableFuture<UpdateDatasetResponse> updateDataset(Consumer<UpdateDatasetRequest.Builder> updateDatasetRequest)

      Updates a dataset.


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

      Parameters:
      updateDatasetRequest - A Consumer that will call methods on UpdateDatasetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateDataset operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally 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 quota 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:

    • 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.

      Important workflow notes:

      Each gateway capability defines data sources for a gateway. This is the namespace of the gateway capability.

      . The namespace follows the format service:capability:version, where:

      • service - The service providing the capability, or iotsitewise.

      • capability - The specific capability type. Options include: opcuacollector for the OPC UA data source collector, or publisher for data publisher capability.

      • version - The version number of the capability. Option include 2 for Classic streams, V2 gateways, and 3 for MQTT-enabled, V3 gateways.

      After updating a capability configuration, the sync status becomes OUT_OF_SYNC until the gateway processes the configuration.Use DescribeGatewayCapabilityConfiguration to check the sync status and verify the configuration was applied.

      A gateway can have multiple capability configurations with different namespaces.

      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 quota 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.

      Important workflow notes:

      Each gateway capability defines data sources for a gateway. This is the namespace of the gateway capability.

      . The namespace follows the format service:capability:version, where:

      • service - The service providing the capability, or iotsitewise.

      • capability - The specific capability type. Options include: opcuacollector for the OPC UA data source collector, or publisher for data publisher capability.

      • version - The version number of the capability. Option include 2 for Classic streams, V2 gateways, and 3 for MQTT-enabled, V3 gateways.

      After updating a capability configuration, the sync status becomes OUT_OF_SYNC until the gateway processes the configuration.Use DescribeGatewayCapabilityConfiguration to check the sync status and verify the configuration was applied.

      A gateway can have multiple capability configurations with different namespaces.


      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 quota 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:

    • updatePipeline

      default CompletableFuture<UpdatePipelineResponse> updatePipeline(UpdatePipelineRequest updatePipelineRequest)

      Updates an existing pipeline in the specified workspace. Only the fields provided in the request are updated; fields not included in the request are preserved unchanged. You can update the pipeline description, environment variables, and the list of compute nodes independently.

      Parameters:
      updatePipelineRequest - Request structure for UpdatePipeline operation.
      Returns:
      A Java Future containing the result of the UpdatePipeline operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • LimitExceededException You've reached the quota 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.

      • 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.
      • 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:

    • updatePipeline

      default CompletableFuture<UpdatePipelineResponse> updatePipeline(Consumer<UpdatePipelineRequest.Builder> updatePipelineRequest)

      Updates an existing pipeline in the specified workspace. Only the fields provided in the request are updated; fields not included in the request are preserved unchanged. You can update the pipeline description, environment variables, and the list of compute nodes independently.


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

      Parameters:
      updatePipelineRequest - A Consumer that will call methods on UpdatePipelineRequest.Builder to create a request. Request structure for UpdatePipeline operation.
      Returns:
      A Java Future containing the result of the UpdatePipeline operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • LimitExceededException You've reached the quota 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.

      • 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.
      • 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(UpdatePortalRequest updatePortalRequest)

      The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.

      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)

      The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.

      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)

      The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.

      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)

      The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.

      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:

    • updateTask

      default CompletableFuture<UpdateTaskResponse> updateTask(UpdateTaskRequest updateTaskRequest)

      Updates an existing task in the specified workspace. Only the fields provided in the request are updated; fields not included in the request are preserved unchanged.

      Parameters:
      updateTaskRequest - Request structure for UpdateTask operation.
      Returns:
      A Java Future containing the result of the UpdateTask operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • updateTask

      default CompletableFuture<UpdateTaskResponse> updateTask(Consumer<UpdateTaskRequest.Builder> updateTaskRequest)

      Updates an existing task in the specified workspace. Only the fields provided in the request are updated; fields not included in the request are preserved unchanged.


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

      Parameters:
      updateTaskRequest - A Consumer that will call methods on UpdateTaskRequest.Builder to create a request. Request structure for UpdateTask operation.
      Returns:
      A Java Future containing the result of the UpdateTask operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalFailureException IoT SiteWise can't process your request right now. Try again later.
      • AccessDeniedException Access is denied.
      • 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.
      • 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:

    • updateWorkspace

      default CompletableFuture<UpdateWorkspaceResponse> updateWorkspace(UpdateWorkspaceRequest updateWorkspaceRequest)

      Updates a workspace. You can update only workspaces in the ACTIVE or FAILED state. Fields that you omit from the request are left unchanged. To recover a workspace in the FAILED state, call this operation and supply its encryption configuration again.

      Parameters:
      updateWorkspaceRequest -
      Returns:
      A Java Future containing the result of the UpdateWorkspace operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException Access is denied.
      • ResourceNotFoundException The requested resource can't be found.
      • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • 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.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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:

    • updateWorkspace

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

      Updates a workspace. You can update only workspaces in the ACTIVE or FAILED state. Fields that you omit from the request are left unchanged. To recover a workspace in the FAILED state, call this operation and supply its encryption configuration again.


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

      Parameters:
      updateWorkspaceRequest - A Consumer that will call methods on UpdateWorkspaceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateWorkspace operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException Access is denied.
      • ResourceNotFoundException The requested resource can't be found.
      • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
      • 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.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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.