Interface IoTSiteWiseClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface IoTSiteWiseClient extends AwsClient
Service client for accessing AWS IoT SiteWise. This can be created using the staticbuilder()method.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 Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
associateAssets
default AssociateAssetsResponse associateAssets(AssociateAssetsRequest associateAssetsRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ResourceNotFoundException, InternalFailureException, LimitExceededException, ThrottlingException, ConflictingOperationException, AwsServiceException, SdkClientException, IoTSiteWiseException
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:
- Result of the AssociateAssets operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.ResourceAlreadyExistsException- The resource already exists.ResourceNotFoundException- The requested resource can't be found.InternalFailureException- IoT SiteWise can't process your request right now. Try again later.LimitExceededException- You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.For more information, see Quotas in the IoT SiteWise User Guide.
ThrottlingException- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.For more information, see Quotas in the IoT SiteWise User Guide.
ConflictingOperationException- Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
associateAssets
default AssociateAssetsResponse associateAssets(Consumer<AssociateAssetsRequest.Builder> associateAssetsRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ResourceNotFoundException, InternalFailureException, LimitExceededException, ThrottlingException, ConflictingOperationException, AwsServiceException, SdkClientException, IoTSiteWiseException
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.Builderavoiding the need to create one manually viaAssociateAssetsRequest.builder()- Parameters:
associateAssetsRequest- AConsumerthat will call methods onAssociateAssetsRequest.Builderto create a request.- Returns:
- Result of the AssociateAssets operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.ResourceAlreadyExistsException- The resource already exists.ResourceNotFoundException- The requested resource can't be found.InternalFailureException- IoT SiteWise can't process your request right now. Try again later.LimitExceededException- You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.For more information, see Quotas in the IoT SiteWise User Guide.
ThrottlingException- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.For more information, see Quotas in the IoT SiteWise User Guide.
ConflictingOperationException- Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
associateTimeSeriesToAssetProperty
default AssociateTimeSeriesToAssetPropertyResponse associateTimeSeriesToAssetProperty(AssociateTimeSeriesToAssetPropertyRequest associateTimeSeriesToAssetPropertyRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, ConflictingOperationException, AwsServiceException, SdkClientException, IoTSiteWiseException
Associates a time series (data stream) with an asset property.
- Parameters:
associateTimeSeriesToAssetPropertyRequest-- Returns:
- Result of the AssociateTimeSeriesToAssetProperty operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
associateTimeSeriesToAssetProperty
default AssociateTimeSeriesToAssetPropertyResponse associateTimeSeriesToAssetProperty(Consumer<AssociateTimeSeriesToAssetPropertyRequest.Builder> associateTimeSeriesToAssetPropertyRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, ConflictingOperationException, AwsServiceException, SdkClientException, IoTSiteWiseException
Associates a time series (data stream) with an asset property.
This is a convenience which creates an instance of the
AssociateTimeSeriesToAssetPropertyRequest.Builderavoiding the need to create one manually viaAssociateTimeSeriesToAssetPropertyRequest.builder()- Parameters:
associateTimeSeriesToAssetPropertyRequest- AConsumerthat will call methods onAssociateTimeSeriesToAssetPropertyRequest.Builderto create a request.- Returns:
- Result of the AssociateTimeSeriesToAssetProperty operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
batchAssociateProjectAssets
default BatchAssociateProjectAssetsResponse batchAssociateProjectAssets(BatchAssociateProjectAssetsRequest batchAssociateProjectAssetsRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, LimitExceededException, AwsServiceException, SdkClientException, IoTSiteWiseException
Associates a group (batch) of assets with an IoT SiteWise Monitor project.
- Parameters:
batchAssociateProjectAssetsRequest-- Returns:
- Result of the BatchAssociateProjectAssets operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.ResourceNotFoundException- The requested resource can't be found.InternalFailureException- IoT SiteWise can't process your request right now. Try again later.ThrottlingException- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException- You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.For more information, see Quotas in the IoT SiteWise User Guide.
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
batchAssociateProjectAssets
default BatchAssociateProjectAssetsResponse batchAssociateProjectAssets(Consumer<BatchAssociateProjectAssetsRequest.Builder> batchAssociateProjectAssetsRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, LimitExceededException, AwsServiceException, SdkClientException, IoTSiteWiseException
Associates a group (batch) of assets with an IoT SiteWise Monitor project.
This is a convenience which creates an instance of the
BatchAssociateProjectAssetsRequest.Builderavoiding the need to create one manually viaBatchAssociateProjectAssetsRequest.builder()- Parameters:
batchAssociateProjectAssetsRequest- AConsumerthat will call methods onBatchAssociateProjectAssetsRequest.Builderto create a request.- Returns:
- Result of the BatchAssociateProjectAssets operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.ResourceNotFoundException- The requested resource can't be found.InternalFailureException- IoT SiteWise can't process your request right now. Try again later.ThrottlingException- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException- You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.For more information, see Quotas in the IoT SiteWise User Guide.
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
batchDisassociateProjectAssets
default BatchDisassociateProjectAssetsResponse batchDisassociateProjectAssets(BatchDisassociateProjectAssetsRequest batchDisassociateProjectAssetsRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Disassociates a group (batch) of assets from an IoT SiteWise Monitor project.
- Parameters:
batchDisassociateProjectAssetsRequest-- Returns:
- Result of the BatchDisassociateProjectAssets operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
batchDisassociateProjectAssets
default BatchDisassociateProjectAssetsResponse batchDisassociateProjectAssets(Consumer<BatchDisassociateProjectAssetsRequest.Builder> batchDisassociateProjectAssetsRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Disassociates a group (batch) of assets from an IoT SiteWise Monitor project.
This is a convenience which creates an instance of the
BatchDisassociateProjectAssetsRequest.Builderavoiding the need to create one manually viaBatchDisassociateProjectAssetsRequest.builder()- Parameters:
batchDisassociateProjectAssetsRequest- AConsumerthat will call methods onBatchDisassociateProjectAssetsRequest.Builderto create a request.- Returns:
- Result of the BatchDisassociateProjectAssets operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
batchGetAssetPropertyAggregates
default BatchGetAssetPropertyAggregatesResponse batchGetAssetPropertyAggregates(BatchGetAssetPropertyAggregatesRequest batchGetAssetPropertyAggregatesRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IoTSiteWiseException
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:
- Result of the BatchGetAssetPropertyAggregates operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
batchGetAssetPropertyAggregates
default BatchGetAssetPropertyAggregatesResponse batchGetAssetPropertyAggregates(Consumer<BatchGetAssetPropertyAggregatesRequest.Builder> batchGetAssetPropertyAggregatesRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IoTSiteWiseException
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.Builderavoiding the need to create one manually viaBatchGetAssetPropertyAggregatesRequest.builder()- Parameters:
batchGetAssetPropertyAggregatesRequest- AConsumerthat will call methods onBatchGetAssetPropertyAggregatesRequest.Builderto create a request.- Returns:
- Result of the BatchGetAssetPropertyAggregates operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
batchGetAssetPropertyAggregatesPaginator
default BatchGetAssetPropertyAggregatesIterable batchGetAssetPropertyAggregatesPaginator(BatchGetAssetPropertyAggregatesRequest batchGetAssetPropertyAggregatesRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IoTSiteWiseException
This is a variant of
batchGetAssetPropertyAggregates(software.amazon.awssdk.services.iotsitewise.model.BatchGetAssetPropertyAggregatesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotsitewise.paginators.BatchGetAssetPropertyAggregatesIterable responses = client.batchGetAssetPropertyAggregatesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotsitewise.paginators.BatchGetAssetPropertyAggregatesIterable responses = client .batchGetAssetPropertyAggregatesPaginator(request); for (software.amazon.awssdk.services.iotsitewise.model.BatchGetAssetPropertyAggregatesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotsitewise.paginators.BatchGetAssetPropertyAggregatesIterable responses = client.batchGetAssetPropertyAggregatesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
batchGetAssetPropertyAggregates(software.amazon.awssdk.services.iotsitewise.model.BatchGetAssetPropertyAggregatesRequest)operation.- Parameters:
batchGetAssetPropertyAggregatesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
batchGetAssetPropertyAggregatesPaginator
default BatchGetAssetPropertyAggregatesIterable batchGetAssetPropertyAggregatesPaginator(Consumer<BatchGetAssetPropertyAggregatesRequest.Builder> batchGetAssetPropertyAggregatesRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IoTSiteWiseException
This is a variant of
batchGetAssetPropertyAggregates(software.amazon.awssdk.services.iotsitewise.model.BatchGetAssetPropertyAggregatesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotsitewise.paginators.BatchGetAssetPropertyAggregatesIterable responses = client.batchGetAssetPropertyAggregatesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotsitewise.paginators.BatchGetAssetPropertyAggregatesIterable responses = client .batchGetAssetPropertyAggregatesPaginator(request); for (software.amazon.awssdk.services.iotsitewise.model.BatchGetAssetPropertyAggregatesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotsitewise.paginators.BatchGetAssetPropertyAggregatesIterable responses = client.batchGetAssetPropertyAggregatesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
batchGetAssetPropertyAggregates(software.amazon.awssdk.services.iotsitewise.model.BatchGetAssetPropertyAggregatesRequest)operation.
This is a convenience which creates an instance of the
BatchGetAssetPropertyAggregatesRequest.Builderavoiding the need to create one manually viaBatchGetAssetPropertyAggregatesRequest.builder()- Parameters:
batchGetAssetPropertyAggregatesRequest- AConsumerthat will call methods onBatchGetAssetPropertyAggregatesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
batchGetAssetPropertyValue
default BatchGetAssetPropertyValueResponse batchGetAssetPropertyValue(BatchGetAssetPropertyValueRequest batchGetAssetPropertyValueRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IoTSiteWiseException
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:
- Result of the BatchGetAssetPropertyValue operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
batchGetAssetPropertyValue
default BatchGetAssetPropertyValueResponse batchGetAssetPropertyValue(Consumer<BatchGetAssetPropertyValueRequest.Builder> batchGetAssetPropertyValueRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IoTSiteWiseException
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.Builderavoiding the need to create one manually viaBatchGetAssetPropertyValueRequest.builder()- Parameters:
batchGetAssetPropertyValueRequest- AConsumerthat will call methods onBatchGetAssetPropertyValueRequest.Builderto create a request.- Returns:
- Result of the BatchGetAssetPropertyValue operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
batchGetAssetPropertyValuePaginator
default BatchGetAssetPropertyValueIterable batchGetAssetPropertyValuePaginator(BatchGetAssetPropertyValueRequest batchGetAssetPropertyValueRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IoTSiteWiseException
This is a variant of
batchGetAssetPropertyValue(software.amazon.awssdk.services.iotsitewise.model.BatchGetAssetPropertyValueRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotsitewise.paginators.BatchGetAssetPropertyValueIterable responses = client.batchGetAssetPropertyValuePaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotsitewise.paginators.BatchGetAssetPropertyValueIterable responses = client .batchGetAssetPropertyValuePaginator(request); for (software.amazon.awssdk.services.iotsitewise.model.BatchGetAssetPropertyValueResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotsitewise.paginators.BatchGetAssetPropertyValueIterable responses = client.batchGetAssetPropertyValuePaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
batchGetAssetPropertyValuePaginator
default BatchGetAssetPropertyValueIterable batchGetAssetPropertyValuePaginator(Consumer<BatchGetAssetPropertyValueRequest.Builder> batchGetAssetPropertyValueRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IoTSiteWiseException
This is a variant of
batchGetAssetPropertyValue(software.amazon.awssdk.services.iotsitewise.model.BatchGetAssetPropertyValueRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotsitewise.paginators.BatchGetAssetPropertyValueIterable responses = client.batchGetAssetPropertyValuePaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotsitewise.paginators.BatchGetAssetPropertyValueIterable responses = client .batchGetAssetPropertyValuePaginator(request); for (software.amazon.awssdk.services.iotsitewise.model.BatchGetAssetPropertyValueResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotsitewise.paginators.BatchGetAssetPropertyValueIterable responses = client.batchGetAssetPropertyValuePaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaBatchGetAssetPropertyValueRequest.builder()- Parameters:
batchGetAssetPropertyValueRequest- AConsumerthat will call methods onBatchGetAssetPropertyValueRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
batchGetAssetPropertyValueHistory
default BatchGetAssetPropertyValueHistoryResponse batchGetAssetPropertyValueHistory(BatchGetAssetPropertyValueHistoryRequest batchGetAssetPropertyValueHistoryRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IoTSiteWiseException
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:
- Result of the BatchGetAssetPropertyValueHistory operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
batchGetAssetPropertyValueHistory
default BatchGetAssetPropertyValueHistoryResponse batchGetAssetPropertyValueHistory(Consumer<BatchGetAssetPropertyValueHistoryRequest.Builder> batchGetAssetPropertyValueHistoryRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IoTSiteWiseException
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.Builderavoiding the need to create one manually viaBatchGetAssetPropertyValueHistoryRequest.builder()- Parameters:
batchGetAssetPropertyValueHistoryRequest- AConsumerthat will call methods onBatchGetAssetPropertyValueHistoryRequest.Builderto create a request.- Returns:
- Result of the BatchGetAssetPropertyValueHistory operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
batchGetAssetPropertyValueHistoryPaginator
default BatchGetAssetPropertyValueHistoryIterable batchGetAssetPropertyValueHistoryPaginator(BatchGetAssetPropertyValueHistoryRequest batchGetAssetPropertyValueHistoryRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IoTSiteWiseException
This is a variant of
batchGetAssetPropertyValueHistory(software.amazon.awssdk.services.iotsitewise.model.BatchGetAssetPropertyValueHistoryRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotsitewise.paginators.BatchGetAssetPropertyValueHistoryIterable responses = client.batchGetAssetPropertyValueHistoryPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotsitewise.paginators.BatchGetAssetPropertyValueHistoryIterable responses = client .batchGetAssetPropertyValueHistoryPaginator(request); for (software.amazon.awssdk.services.iotsitewise.model.BatchGetAssetPropertyValueHistoryResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotsitewise.paginators.BatchGetAssetPropertyValueHistoryIterable responses = client.batchGetAssetPropertyValueHistoryPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
batchGetAssetPropertyValueHistory(software.amazon.awssdk.services.iotsitewise.model.BatchGetAssetPropertyValueHistoryRequest)operation.- Parameters:
batchGetAssetPropertyValueHistoryRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
batchGetAssetPropertyValueHistoryPaginator
default BatchGetAssetPropertyValueHistoryIterable batchGetAssetPropertyValueHistoryPaginator(Consumer<BatchGetAssetPropertyValueHistoryRequest.Builder> batchGetAssetPropertyValueHistoryRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IoTSiteWiseException
This is a variant of
batchGetAssetPropertyValueHistory(software.amazon.awssdk.services.iotsitewise.model.BatchGetAssetPropertyValueHistoryRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotsitewise.paginators.BatchGetAssetPropertyValueHistoryIterable responses = client.batchGetAssetPropertyValueHistoryPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotsitewise.paginators.BatchGetAssetPropertyValueHistoryIterable responses = client .batchGetAssetPropertyValueHistoryPaginator(request); for (software.amazon.awssdk.services.iotsitewise.model.BatchGetAssetPropertyValueHistoryResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotsitewise.paginators.BatchGetAssetPropertyValueHistoryIterable responses = client.batchGetAssetPropertyValueHistoryPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
batchGetAssetPropertyValueHistory(software.amazon.awssdk.services.iotsitewise.model.BatchGetAssetPropertyValueHistoryRequest)operation.
This is a convenience which creates an instance of the
BatchGetAssetPropertyValueHistoryRequest.Builderavoiding the need to create one manually viaBatchGetAssetPropertyValueHistoryRequest.builder()- Parameters:
batchGetAssetPropertyValueHistoryRequest- AConsumerthat will call methods onBatchGetAssetPropertyValueHistoryRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
batchPutAssetPropertyValue
default BatchPutAssetPropertyValueResponse batchPutAssetPropertyValue(BatchPutAssetPropertyValueRequest batchPutAssetPropertyValueRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, LimitExceededException, ServiceUnavailableException, ConflictingOperationException, AwsServiceException, SdkClientException, IoTSiteWiseException
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
assetIdandpropertyIdof 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
TimestampOutOfRangeExceptionerror.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
BatchPutAssetPropertyValueentry individually. For more information, see BatchPutAssetPropertyValue authorization in the IoT SiteWise User Guide.- Parameters:
batchPutAssetPropertyValueRequest-- Returns:
- Result of the BatchPutAssetPropertyValue operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.ResourceNotFoundException- The requested resource can't be found.InternalFailureException- IoT SiteWise can't process your request right now. Try again later.ThrottlingException- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException- You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.For more information, see Quotas in the IoT SiteWise User Guide.
ServiceUnavailableException- The requested service is unavailable.ConflictingOperationException- Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
batchPutAssetPropertyValue
default BatchPutAssetPropertyValueResponse batchPutAssetPropertyValue(Consumer<BatchPutAssetPropertyValueRequest.Builder> batchPutAssetPropertyValueRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, LimitExceededException, ServiceUnavailableException, ConflictingOperationException, AwsServiceException, SdkClientException, IoTSiteWiseException
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
assetIdandpropertyIdof 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
TimestampOutOfRangeExceptionerror.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
BatchPutAssetPropertyValueentry individually. For more information, see BatchPutAssetPropertyValue authorization in the IoT SiteWise User Guide.
This is a convenience which creates an instance of the
BatchPutAssetPropertyValueRequest.Builderavoiding the need to create one manually viaBatchPutAssetPropertyValueRequest.builder()- Parameters:
batchPutAssetPropertyValueRequest- AConsumerthat will call methods onBatchPutAssetPropertyValueRequest.Builderto create a request.- Returns:
- Result of the BatchPutAssetPropertyValue operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.ResourceNotFoundException- The requested resource can't be found.InternalFailureException- IoT SiteWise can't process your request right now. Try again later.ThrottlingException- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException- You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.For more information, see Quotas in the IoT SiteWise User Guide.
ServiceUnavailableException- The requested service is unavailable.ConflictingOperationException- Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
createAccessPolicy
default CreateAccessPolicyResponse createAccessPolicy(CreateAccessPolicyRequest createAccessPolicyRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, LimitExceededException, AwsServiceException, SdkClientException, IoTSiteWiseException
Creates an access policy that grants the specified identity (IAM Identity Center user, IAM Identity Center group, or IAM user) access to the specified IoT SiteWise Monitor portal or project resource.
- Parameters:
createAccessPolicyRequest-- Returns:
- Result of the CreateAccessPolicy operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.ResourceNotFoundException- The requested resource can't be found.InternalFailureException- IoT SiteWise can't process your request right now. Try again later.ThrottlingException- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException- You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.For more information, see Quotas in the IoT SiteWise User Guide.
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createAccessPolicy
default CreateAccessPolicyResponse createAccessPolicy(Consumer<CreateAccessPolicyRequest.Builder> createAccessPolicyRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, LimitExceededException, AwsServiceException, SdkClientException, IoTSiteWiseException
Creates an access policy that grants the specified identity (IAM Identity Center user, IAM Identity Center group, or IAM user) access to the specified IoT SiteWise Monitor portal or project resource.
This is a convenience which creates an instance of the
CreateAccessPolicyRequest.Builderavoiding the need to create one manually viaCreateAccessPolicyRequest.builder()- Parameters:
createAccessPolicyRequest- AConsumerthat will call methods onCreateAccessPolicyRequest.Builderto create a request.- Returns:
- Result of the CreateAccessPolicy operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.ResourceNotFoundException- The requested resource can't be found.InternalFailureException- IoT SiteWise can't process your request right now. Try again later.ThrottlingException- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException- You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.For more information, see Quotas in the IoT SiteWise User Guide.
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createAsset
default CreateAssetResponse createAsset(CreateAssetRequest createAssetRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ResourceNotFoundException, InternalFailureException, ThrottlingException, LimitExceededException, ConflictingOperationException, AwsServiceException, SdkClientException, IoTSiteWiseException
Creates an asset from an existing asset model. For more information, see Creating assets in the IoT SiteWise User Guide.
- Parameters:
createAssetRequest-- Returns:
- Result of the CreateAsset operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.ResourceAlreadyExistsException- The resource already exists.ResourceNotFoundException- The requested resource can't be found.InternalFailureException- IoT SiteWise can't process your request right now. Try again later.ThrottlingException- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException- You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.For more information, see Quotas in the IoT SiteWise User Guide.
ConflictingOperationException- Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createAsset
default CreateAssetResponse createAsset(Consumer<CreateAssetRequest.Builder> createAssetRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ResourceNotFoundException, InternalFailureException, ThrottlingException, LimitExceededException, ConflictingOperationException, AwsServiceException, SdkClientException, IoTSiteWiseException
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.Builderavoiding the need to create one manually viaCreateAssetRequest.builder()- Parameters:
createAssetRequest- AConsumerthat will call methods onCreateAssetRequest.Builderto create a request.- Returns:
- Result of the CreateAsset operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.ResourceAlreadyExistsException- The resource already exists.ResourceNotFoundException- The requested resource can't be found.InternalFailureException- IoT SiteWise can't process your request right now. Try again later.ThrottlingException- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException- You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.For more information, see Quotas in the IoT SiteWise User Guide.
ConflictingOperationException- Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createAssetModel
default CreateAssetModelResponse createAssetModel(CreateAssetModelRequest createAssetModelRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ResourceNotFoundException, InternalFailureException, ThrottlingException, LimitExceededException, ConflictingOperationException, AwsServiceException, SdkClientException, IoTSiteWiseException
Creates an asset model from specified property and hierarchy definitions. You create assets from asset models. With asset models, you can easily create assets of the same type that have standardized definitions. Each asset created from a model inherits the asset model's property and hierarchy definitions. For more information, see Defining asset models in the IoT SiteWise User Guide.
You can create two types of asset models,
ASSET_MODELorCOMPONENT_MODEL.-
ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.
-
COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
- Parameters:
createAssetModelRequest-- Returns:
- Result of the CreateAssetModel operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.ResourceAlreadyExistsException- The resource already exists.ResourceNotFoundException- The requested resource can't be found.InternalFailureException- IoT SiteWise can't process your request right now. Try again later.ThrottlingException- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException- You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.For more information, see Quotas in the IoT SiteWise User Guide.
ConflictingOperationException- Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
createAssetModel
default CreateAssetModelResponse createAssetModel(Consumer<CreateAssetModelRequest.Builder> createAssetModelRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ResourceNotFoundException, InternalFailureException, ThrottlingException, LimitExceededException, ConflictingOperationException, AwsServiceException, SdkClientException, IoTSiteWiseException
Creates an asset model from specified property and hierarchy definitions. You create assets from asset models. With asset models, you can easily create assets of the same type that have standardized definitions. Each asset created from a model inherits the asset model's property and hierarchy definitions. For more information, see Defining asset models in the IoT SiteWise User Guide.
You can create two types of asset models,
ASSET_MODELorCOMPONENT_MODEL.-
ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.
-
COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
This is a convenience which creates an instance of the
CreateAssetModelRequest.Builderavoiding the need to create one manually viaCreateAssetModelRequest.builder()- Parameters:
createAssetModelRequest- AConsumerthat will call methods onCreateAssetModelRequest.Builderto create a request.- Returns:
- Result of the CreateAssetModel operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.ResourceAlreadyExistsException- The resource already exists.ResourceNotFoundException- The requested resource can't be found.InternalFailureException- IoT SiteWise can't process your request right now. Try again later.ThrottlingException- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException- You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.For more information, see Quotas in the IoT SiteWise User Guide.
ConflictingOperationException- Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
createAssetModelCompositeModel
default CreateAssetModelCompositeModelResponse createAssetModelCompositeModel(CreateAssetModelCompositeModelRequest createAssetModelCompositeModelRequest) throws ConflictingOperationException, InternalFailureException, InvalidRequestException, ResourceAlreadyExistsException, ResourceNotFoundException, ThrottlingException, LimitExceededException, AwsServiceException, SdkClientException, IoTSiteWiseException
Creates a custom composite model from specified property and hierarchy definitions. There are two types of custom composite models,
inlineandcomponent-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
composedAssetModelIdof an existing asset model withassetModelTypeofCOMPONENT_MODEL.To create an inline model, specify the
assetModelCompositeModelPropertiesand don't include ancomposedAssetModelId.- Parameters:
createAssetModelCompositeModelRequest-- Returns:
- Result of the CreateAssetModelCompositeModel operation returned by the service.
- Throws:
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.InvalidRequestException- The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.ResourceAlreadyExistsException- The resource already exists.ResourceNotFoundException- The requested resource can't be found.ThrottlingException- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException- You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.For more information, see Quotas in the IoT SiteWise User Guide.
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createAssetModelCompositeModel
default CreateAssetModelCompositeModelResponse createAssetModelCompositeModel(Consumer<CreateAssetModelCompositeModelRequest.Builder> createAssetModelCompositeModelRequest) throws ConflictingOperationException, InternalFailureException, InvalidRequestException, ResourceAlreadyExistsException, ResourceNotFoundException, ThrottlingException, LimitExceededException, AwsServiceException, SdkClientException, IoTSiteWiseException
Creates a custom composite model from specified property and hierarchy definitions. There are two types of custom composite models,
inlineandcomponent-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
composedAssetModelIdof an existing asset model withassetModelTypeofCOMPONENT_MODEL.To create an inline model, specify the
assetModelCompositeModelPropertiesand don't include ancomposedAssetModelId.
This is a convenience which creates an instance of the
CreateAssetModelCompositeModelRequest.Builderavoiding the need to create one manually viaCreateAssetModelCompositeModelRequest.builder()- Parameters:
createAssetModelCompositeModelRequest- AConsumerthat will call methods onCreateAssetModelCompositeModelRequest.Builderto create a request.- Returns:
- Result of the CreateAssetModelCompositeModel operation returned by the service.
- Throws:
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.InvalidRequestException- The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.ResourceAlreadyExistsException- The resource already exists.ResourceNotFoundException- The requested resource can't be found.ThrottlingException- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException- You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.For more information, see Quotas in the IoT SiteWise User Guide.
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createBulkImportJob
default CreateBulkImportJobResponse createBulkImportJob(CreateBulkImportJobRequest createBulkImportJobRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ResourceNotFoundException, InternalFailureException, ThrottlingException, LimitExceededException, ConflictingOperationException, AwsServiceException, SdkClientException, IoTSiteWiseException
Defines a job to ingest data to IoT SiteWise from Amazon S3. For more information, see Create a bulk import job (CLI) in the Amazon Simple Storage Service User Guide.
Before you create a bulk import job, you must enable IoT SiteWise warm tier or IoT SiteWise cold tier. For more information about how to configure storage settings, see PutStorageConfiguration.
Bulk import is designed to store historical data to IoT SiteWise. It does not trigger computations or notifications on IoT SiteWise warm or cold tier storage.
- Parameters:
createBulkImportJobRequest-- Returns:
- Result of the CreateBulkImportJob operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.ResourceAlreadyExistsException- The resource already exists.ResourceNotFoundException- The requested resource can't be found.InternalFailureException- IoT SiteWise can't process your request right now. Try again later.ThrottlingException- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException- You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.For more information, see Quotas in the IoT SiteWise User Guide.
ConflictingOperationException- Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createBulkImportJob
default CreateBulkImportJobResponse createBulkImportJob(Consumer<CreateBulkImportJobRequest.Builder> createBulkImportJobRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ResourceNotFoundException, InternalFailureException, ThrottlingException, LimitExceededException, ConflictingOperationException, AwsServiceException, SdkClientException, IoTSiteWiseException
Defines a job to ingest data to IoT SiteWise from Amazon S3. For more information, see Create a bulk import job (CLI) in the Amazon Simple Storage Service User Guide.
Before you create a bulk import job, you must enable IoT SiteWise warm tier or IoT SiteWise cold tier. For more information about how to configure storage settings, see PutStorageConfiguration.
Bulk import is designed to store historical data to IoT SiteWise. It does not trigger computations or notifications on IoT SiteWise warm or cold tier storage.
This is a convenience which creates an instance of the
CreateBulkImportJobRequest.Builderavoiding the need to create one manually viaCreateBulkImportJobRequest.builder()- Parameters:
createBulkImportJobRequest- AConsumerthat will call methods onCreateBulkImportJobRequest.Builderto create a request.- Returns:
- Result of the CreateBulkImportJob operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.ResourceAlreadyExistsException- The resource already exists.ResourceNotFoundException- The requested resource can't be found.InternalFailureException- IoT SiteWise can't process your request right now. Try again later.ThrottlingException- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException- You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.For more information, see Quotas in the IoT SiteWise User Guide.
ConflictingOperationException- Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createDashboard
default CreateDashboardResponse createDashboard(CreateDashboardRequest createDashboardRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, LimitExceededException, AwsServiceException, SdkClientException, IoTSiteWiseException
Creates a dashboard in an IoT SiteWise Monitor project.
- Parameters:
createDashboardRequest-- Returns:
- Result of the CreateDashboard operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.ResourceNotFoundException- The requested resource can't be found.InternalFailureException- IoT SiteWise can't process your request right now. Try again later.ThrottlingException- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException- You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.For more information, see Quotas in the IoT SiteWise User Guide.
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createDashboard
default CreateDashboardResponse createDashboard(Consumer<CreateDashboardRequest.Builder> createDashboardRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, LimitExceededException, AwsServiceException, SdkClientException, IoTSiteWiseException
Creates a dashboard in an IoT SiteWise Monitor project.
This is a convenience which creates an instance of the
CreateDashboardRequest.Builderavoiding the need to create one manually viaCreateDashboardRequest.builder()- Parameters:
createDashboardRequest- AConsumerthat will call methods onCreateDashboardRequest.Builderto create a request.- Returns:
- Result of the CreateDashboard operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.ResourceNotFoundException- The requested resource can't be found.InternalFailureException- IoT SiteWise can't process your request right now. Try again later.ThrottlingException- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException- You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.For more information, see Quotas in the IoT SiteWise User Guide.
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createGateway
default CreateGatewayResponse createGateway(CreateGatewayRequest createGatewayRequest) throws InvalidRequestException, ResourceAlreadyExistsException, InternalFailureException, ThrottlingException, LimitExceededException, AwsServiceException, SdkClientException, IoTSiteWiseException
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:
- Result of the CreateGateway operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.ResourceAlreadyExistsException- The resource already exists.InternalFailureException- IoT SiteWise can't process your request right now. Try again later.ThrottlingException- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException- You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.For more information, see Quotas in the IoT SiteWise User Guide.
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createGateway
default CreateGatewayResponse createGateway(Consumer<CreateGatewayRequest.Builder> createGatewayRequest) throws InvalidRequestException, ResourceAlreadyExistsException, InternalFailureException, ThrottlingException, LimitExceededException, AwsServiceException, SdkClientException, IoTSiteWiseException
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.Builderavoiding the need to create one manually viaCreateGatewayRequest.builder()- Parameters:
createGatewayRequest- AConsumerthat will call methods onCreateGatewayRequest.Builderto create a request.- Returns:
- Result of the CreateGateway operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.ResourceAlreadyExistsException- The resource already exists.InternalFailureException- IoT SiteWise can't process your request right now. Try again later.ThrottlingException- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException- You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.For more information, see Quotas in the IoT SiteWise User Guide.
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createPortal
default CreatePortalResponse createPortal(CreatePortalRequest createPortalRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, LimitExceededException, AwsServiceException, SdkClientException, IoTSiteWiseException
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:
- Result of the CreatePortal operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.ResourceNotFoundException- The requested resource can't be found.InternalFailureException- IoT SiteWise can't process your request right now. Try again later.ThrottlingException- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException- You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.For more information, see Quotas in the IoT SiteWise User Guide.
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createPortal
default CreatePortalResponse createPortal(Consumer<CreatePortalRequest.Builder> createPortalRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, LimitExceededException, AwsServiceException, SdkClientException, IoTSiteWiseException
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.Builderavoiding the need to create one manually viaCreatePortalRequest.builder()- Parameters:
createPortalRequest- AConsumerthat will call methods onCreatePortalRequest.Builderto create a request.- Returns:
- Result of the CreatePortal operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.ResourceNotFoundException- The requested resource can't be found.InternalFailureException- IoT SiteWise can't process your request right now. Try again later.ThrottlingException- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException- You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.For more information, see Quotas in the IoT SiteWise User Guide.
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createProject
default CreateProjectResponse createProject(CreateProjectRequest createProjectRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, LimitExceededException, AwsServiceException, SdkClientException, IoTSiteWiseException
Creates a project in the specified portal.
Make sure that the project name and description don't contain confidential information.
- Parameters:
createProjectRequest-- Returns:
- Result of the CreateProject operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.ResourceNotFoundException- The requested resource can't be found.InternalFailureException- IoT SiteWise can't process your request right now. Try again later.ThrottlingException- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException- You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.For more information, see Quotas in the IoT SiteWise User Guide.
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createProject
default CreateProjectResponse createProject(Consumer<CreateProjectRequest.Builder> createProjectRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, LimitExceededException, AwsServiceException, SdkClientException, IoTSiteWiseException
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.Builderavoiding the need to create one manually viaCreateProjectRequest.builder()- Parameters:
createProjectRequest- AConsumerthat will call methods onCreateProjectRequest.Builderto create a request.- Returns:
- Result of the CreateProject operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.ResourceNotFoundException- The requested resource can't be found.InternalFailureException- IoT SiteWise can't process your request right now. Try again later.ThrottlingException- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException- You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.For more information, see Quotas in the IoT SiteWise User Guide.
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAccessPolicy
default DeleteAccessPolicyResponse deleteAccessPolicy(DeleteAccessPolicyRequest deleteAccessPolicyRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
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:
- Result of the DeleteAccessPolicy operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAccessPolicy
default DeleteAccessPolicyResponse deleteAccessPolicy(Consumer<DeleteAccessPolicyRequest.Builder> deleteAccessPolicyRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
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.Builderavoiding the need to create one manually viaDeleteAccessPolicyRequest.builder()- Parameters:
deleteAccessPolicyRequest- AConsumerthat will call methods onDeleteAccessPolicyRequest.Builderto create a request.- Returns:
- Result of the DeleteAccessPolicy operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAsset
default DeleteAssetResponse deleteAsset(DeleteAssetRequest deleteAssetRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, ConflictingOperationException, AwsServiceException, SdkClientException, IoTSiteWiseException
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:
- Result of the DeleteAsset operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAsset
default DeleteAssetResponse deleteAsset(Consumer<DeleteAssetRequest.Builder> deleteAssetRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, ConflictingOperationException, AwsServiceException, SdkClientException, IoTSiteWiseException
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.Builderavoiding the need to create one manually viaDeleteAssetRequest.builder()- Parameters:
deleteAssetRequest- AConsumerthat will call methods onDeleteAssetRequest.Builderto create a request.- Returns:
- Result of the DeleteAsset operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAssetModel
default DeleteAssetModelResponse deleteAssetModel(DeleteAssetModelRequest deleteAssetModelRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, ConflictingOperationException, AwsServiceException, SdkClientException, IoTSiteWiseException
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:
- Result of the DeleteAssetModel operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAssetModel
default DeleteAssetModelResponse deleteAssetModel(Consumer<DeleteAssetModelRequest.Builder> deleteAssetModelRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, ConflictingOperationException, AwsServiceException, SdkClientException, IoTSiteWiseException
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.Builderavoiding the need to create one manually viaDeleteAssetModelRequest.builder()- Parameters:
deleteAssetModelRequest- AConsumerthat will call methods onDeleteAssetModelRequest.Builderto create a request.- Returns:
- Result of the DeleteAssetModel operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAssetModelCompositeModel
default DeleteAssetModelCompositeModelResponse deleteAssetModelCompositeModel(DeleteAssetModelCompositeModelRequest deleteAssetModelCompositeModelRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, ConflictingOperationException, AwsServiceException, SdkClientException, IoTSiteWiseException
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:
- Result of the DeleteAssetModelCompositeModel operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAssetModelCompositeModel
default DeleteAssetModelCompositeModelResponse deleteAssetModelCompositeModel(Consumer<DeleteAssetModelCompositeModelRequest.Builder> deleteAssetModelCompositeModelRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, ConflictingOperationException, AwsServiceException, SdkClientException, IoTSiteWiseException
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.Builderavoiding the need to create one manually viaDeleteAssetModelCompositeModelRequest.builder()- Parameters:
deleteAssetModelCompositeModelRequest- AConsumerthat will call methods onDeleteAssetModelCompositeModelRequest.Builderto create a request.- Returns:
- Result of the DeleteAssetModelCompositeModel operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDashboard
default DeleteDashboardResponse deleteDashboard(DeleteDashboardRequest deleteDashboardRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Deletes a dashboard from IoT SiteWise Monitor.
- Parameters:
deleteDashboardRequest-- Returns:
- Result of the DeleteDashboard operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDashboard
default DeleteDashboardResponse deleteDashboard(Consumer<DeleteDashboardRequest.Builder> deleteDashboardRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Deletes a dashboard from IoT SiteWise Monitor.
This is a convenience which creates an instance of the
DeleteDashboardRequest.Builderavoiding the need to create one manually viaDeleteDashboardRequest.builder()- Parameters:
deleteDashboardRequest- AConsumerthat will call methods onDeleteDashboardRequest.Builderto create a request.- Returns:
- Result of the DeleteDashboard operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteGateway
default DeleteGatewayResponse deleteGateway(DeleteGatewayRequest deleteGatewayRequest) throws InvalidRequestException, ResourceNotFoundException, ConflictingOperationException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
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:
- Result of the DeleteGateway operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteGateway
default DeleteGatewayResponse deleteGateway(Consumer<DeleteGatewayRequest.Builder> deleteGatewayRequest) throws InvalidRequestException, ResourceNotFoundException, ConflictingOperationException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
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.Builderavoiding the need to create one manually viaDeleteGatewayRequest.builder()- Parameters:
deleteGatewayRequest- AConsumerthat will call methods onDeleteGatewayRequest.Builderto create a request.- Returns:
- Result of the DeleteGateway operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
deletePortal
default DeletePortalResponse deletePortal(DeletePortalRequest deletePortalRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, ConflictingOperationException, AwsServiceException, SdkClientException, IoTSiteWiseException
Deletes a portal from IoT SiteWise Monitor.
- Parameters:
deletePortalRequest-- Returns:
- Result of the DeletePortal operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
deletePortal
default DeletePortalResponse deletePortal(Consumer<DeletePortalRequest.Builder> deletePortalRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, ConflictingOperationException, AwsServiceException, SdkClientException, IoTSiteWiseException
Deletes a portal from IoT SiteWise Monitor.
This is a convenience which creates an instance of the
DeletePortalRequest.Builderavoiding the need to create one manually viaDeletePortalRequest.builder()- Parameters:
deletePortalRequest- AConsumerthat will call methods onDeletePortalRequest.Builderto create a request.- Returns:
- Result of the DeletePortal operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteProject
default DeleteProjectResponse deleteProject(DeleteProjectRequest deleteProjectRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Deletes a project from IoT SiteWise Monitor.
- Parameters:
deleteProjectRequest-- Returns:
- Result of the DeleteProject operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteProject
default DeleteProjectResponse deleteProject(Consumer<DeleteProjectRequest.Builder> deleteProjectRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Deletes a project from IoT SiteWise Monitor.
This is a convenience which creates an instance of the
DeleteProjectRequest.Builderavoiding the need to create one manually viaDeleteProjectRequest.builder()- Parameters:
deleteProjectRequest- AConsumerthat will call methods onDeleteProjectRequest.Builderto create a request.- Returns:
- Result of the DeleteProject operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteTimeSeries
default DeleteTimeSeriesResponse deleteTimeSeries(DeleteTimeSeriesRequest deleteTimeSeriesRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, ConflictingOperationException, AwsServiceException, SdkClientException, IoTSiteWiseException
Deletes a time series (data stream). If you delete a time series that's associated with an asset property, the asset property still exists, but the time series will no longer be associated with this asset property.
To identify a time series, do one of the following:
-
If the time series isn't associated with an asset property, specify the
aliasof the time series. -
If the time series is associated with an asset property, specify one of the following:
-
The
aliasof the time series. -
The
assetIdandpropertyIdthat identifies the asset property.
-
- Parameters:
deleteTimeSeriesRequest-- Returns:
- Result of the DeleteTimeSeries operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
-
deleteTimeSeries
default DeleteTimeSeriesResponse deleteTimeSeries(Consumer<DeleteTimeSeriesRequest.Builder> deleteTimeSeriesRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, ConflictingOperationException, AwsServiceException, SdkClientException, IoTSiteWiseException
Deletes a time series (data stream). If you delete a time series that's associated with an asset property, the asset property still exists, but the time series will no longer be associated with this asset property.
To identify a time series, do one of the following:
-
If the time series isn't associated with an asset property, specify the
aliasof the time series. -
If the time series is associated with an asset property, specify one of the following:
-
The
aliasof the time series. -
The
assetIdandpropertyIdthat identifies the asset property.
-
This is a convenience which creates an instance of the
DeleteTimeSeriesRequest.Builderavoiding the need to create one manually viaDeleteTimeSeriesRequest.builder()- Parameters:
deleteTimeSeriesRequest- AConsumerthat will call methods onDeleteTimeSeriesRequest.Builderto create a request.- Returns:
- Result of the DeleteTimeSeries operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
-
describeAccessPolicy
default DescribeAccessPolicyResponse describeAccessPolicy(DescribeAccessPolicyRequest describeAccessPolicyRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Describes an access policy, which specifies an identity's access to an IoT SiteWise Monitor portal or project.
- Parameters:
describeAccessPolicyRequest-- Returns:
- Result of the DescribeAccessPolicy operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeAccessPolicy
default DescribeAccessPolicyResponse describeAccessPolicy(Consumer<DescribeAccessPolicyRequest.Builder> describeAccessPolicyRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
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.Builderavoiding the need to create one manually viaDescribeAccessPolicyRequest.builder()- Parameters:
describeAccessPolicyRequest- AConsumerthat will call methods onDescribeAccessPolicyRequest.Builderto create a request.- Returns:
- Result of the DescribeAccessPolicy operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeAction
default DescribeActionResponse describeAction(DescribeActionRequest describeActionRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves information about an action.
- Parameters:
describeActionRequest-- Returns:
- Result of the DescribeAction operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeAction
default DescribeActionResponse describeAction(Consumer<DescribeActionRequest.Builder> describeActionRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves information about an action.
This is a convenience which creates an instance of the
DescribeActionRequest.Builderavoiding the need to create one manually viaDescribeActionRequest.builder()- Parameters:
describeActionRequest- AConsumerthat will call methods onDescribeActionRequest.Builderto create a request.- Returns:
- Result of the DescribeAction operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeAsset
default DescribeAssetResponse describeAsset(DescribeAssetRequest describeAssetRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves information about an asset.
- Parameters:
describeAssetRequest-- Returns:
- Result of the DescribeAsset operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeAsset
default DescribeAssetResponse describeAsset(Consumer<DescribeAssetRequest.Builder> describeAssetRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves information about an asset.
This is a convenience which creates an instance of the
DescribeAssetRequest.Builderavoiding the need to create one manually viaDescribeAssetRequest.builder()- Parameters:
describeAssetRequest- AConsumerthat will call methods onDescribeAssetRequest.Builderto create a request.- Returns:
- Result of the DescribeAsset operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeAssetCompositeModel
default DescribeAssetCompositeModelResponse describeAssetCompositeModel(DescribeAssetCompositeModelRequest describeAssetCompositeModelRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves information about an asset composite model (also known as an asset component). An
AssetCompositeModelis an instance of anAssetModelCompositeModel. If you want to see information about the model this is based on, call DescribeAssetModelCompositeModel.- Parameters:
describeAssetCompositeModelRequest-- Returns:
- Result of the DescribeAssetCompositeModel operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeAssetCompositeModel
default DescribeAssetCompositeModelResponse describeAssetCompositeModel(Consumer<DescribeAssetCompositeModelRequest.Builder> describeAssetCompositeModelRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves information about an asset composite model (also known as an asset component). An
AssetCompositeModelis an instance of anAssetModelCompositeModel. 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.Builderavoiding the need to create one manually viaDescribeAssetCompositeModelRequest.builder()- Parameters:
describeAssetCompositeModelRequest- AConsumerthat will call methods onDescribeAssetCompositeModelRequest.Builderto create a request.- Returns:
- Result of the DescribeAssetCompositeModel operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeAssetModel
default DescribeAssetModelResponse describeAssetModel(DescribeAssetModelRequest describeAssetModelRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves information about an asset model.
- Parameters:
describeAssetModelRequest-- Returns:
- Result of the DescribeAssetModel operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeAssetModel
default DescribeAssetModelResponse describeAssetModel(Consumer<DescribeAssetModelRequest.Builder> describeAssetModelRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves information about an asset model.
This is a convenience which creates an instance of the
DescribeAssetModelRequest.Builderavoiding the need to create one manually viaDescribeAssetModelRequest.builder()- Parameters:
describeAssetModelRequest- AConsumerthat will call methods onDescribeAssetModelRequest.Builderto create a request.- Returns:
- Result of the DescribeAssetModel operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeAssetModelCompositeModel
default DescribeAssetModelCompositeModelResponse describeAssetModelCompositeModel(DescribeAssetModelCompositeModelRequest describeAssetModelCompositeModelRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
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:
- Result of the DescribeAssetModelCompositeModel operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeAssetModelCompositeModel
default DescribeAssetModelCompositeModelResponse describeAssetModelCompositeModel(Consumer<DescribeAssetModelCompositeModelRequest.Builder> describeAssetModelCompositeModelRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
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.Builderavoiding the need to create one manually viaDescribeAssetModelCompositeModelRequest.builder()- Parameters:
describeAssetModelCompositeModelRequest- AConsumerthat will call methods onDescribeAssetModelCompositeModelRequest.Builderto create a request.- Returns:
- Result of the DescribeAssetModelCompositeModel operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeAssetProperty
default DescribeAssetPropertyResponse describeAssetProperty(DescribeAssetPropertyRequest describeAssetPropertyRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
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:
- Result of the DescribeAssetProperty operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeAssetProperty
default DescribeAssetPropertyResponse describeAssetProperty(Consumer<DescribeAssetPropertyRequest.Builder> describeAssetPropertyRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
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.Builderavoiding the need to create one manually viaDescribeAssetPropertyRequest.builder()- Parameters:
describeAssetPropertyRequest- AConsumerthat will call methods onDescribeAssetPropertyRequest.Builderto create a request.- Returns:
- Result of the DescribeAssetProperty operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeBulkImportJob
default DescribeBulkImportJobResponse describeBulkImportJob(DescribeBulkImportJobRequest describeBulkImportJobRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
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:
- Result of the DescribeBulkImportJob operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeBulkImportJob
default DescribeBulkImportJobResponse describeBulkImportJob(Consumer<DescribeBulkImportJobRequest.Builder> describeBulkImportJobRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
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.Builderavoiding the need to create one manually viaDescribeBulkImportJobRequest.builder()- Parameters:
describeBulkImportJobRequest- AConsumerthat will call methods onDescribeBulkImportJobRequest.Builderto create a request.- Returns:
- Result of the DescribeBulkImportJob operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeDashboard
default DescribeDashboardResponse describeDashboard(DescribeDashboardRequest describeDashboardRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves information about a dashboard.
- Parameters:
describeDashboardRequest-- Returns:
- Result of the DescribeDashboard operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeDashboard
default DescribeDashboardResponse describeDashboard(Consumer<DescribeDashboardRequest.Builder> describeDashboardRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves information about a dashboard.
This is a convenience which creates an instance of the
DescribeDashboardRequest.Builderavoiding the need to create one manually viaDescribeDashboardRequest.builder()- Parameters:
describeDashboardRequest- AConsumerthat will call methods onDescribeDashboardRequest.Builderto create a request.- Returns:
- Result of the DescribeDashboard operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeDefaultEncryptionConfiguration
default DescribeDefaultEncryptionConfigurationResponse describeDefaultEncryptionConfiguration(DescribeDefaultEncryptionConfigurationRequest describeDefaultEncryptionConfigurationRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
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:
- Result of the DescribeDefaultEncryptionConfiguration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeDefaultEncryptionConfiguration
default DescribeDefaultEncryptionConfigurationResponse describeDefaultEncryptionConfiguration(Consumer<DescribeDefaultEncryptionConfigurationRequest.Builder> describeDefaultEncryptionConfigurationRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
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.Builderavoiding the need to create one manually viaDescribeDefaultEncryptionConfigurationRequest.builder()- Parameters:
describeDefaultEncryptionConfigurationRequest- AConsumerthat will call methods onDescribeDefaultEncryptionConfigurationRequest.Builderto create a request.- Returns:
- Result of the DescribeDefaultEncryptionConfiguration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeGateway
default DescribeGatewayResponse describeGateway(DescribeGatewayRequest describeGatewayRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves information about a gateway.
- Parameters:
describeGatewayRequest-- Returns:
- Result of the DescribeGateway operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeGateway
default DescribeGatewayResponse describeGateway(Consumer<DescribeGatewayRequest.Builder> describeGatewayRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves information about a gateway.
This is a convenience which creates an instance of the
DescribeGatewayRequest.Builderavoiding the need to create one manually viaDescribeGatewayRequest.builder()- Parameters:
describeGatewayRequest- AConsumerthat will call methods onDescribeGatewayRequest.Builderto create a request.- Returns:
- Result of the DescribeGateway operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeGatewayCapabilityConfiguration
default DescribeGatewayCapabilityConfigurationResponse describeGatewayCapabilityConfiguration(DescribeGatewayCapabilityConfigurationRequest describeGatewayCapabilityConfigurationRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves information about a gateway capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway.
- Parameters:
describeGatewayCapabilityConfigurationRequest-- Returns:
- Result of the DescribeGatewayCapabilityConfiguration operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeGatewayCapabilityConfiguration
default DescribeGatewayCapabilityConfigurationResponse describeGatewayCapabilityConfiguration(Consumer<DescribeGatewayCapabilityConfigurationRequest.Builder> describeGatewayCapabilityConfigurationRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves information about a gateway capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway.
This is a convenience which creates an instance of the
DescribeGatewayCapabilityConfigurationRequest.Builderavoiding the need to create one manually viaDescribeGatewayCapabilityConfigurationRequest.builder()- Parameters:
describeGatewayCapabilityConfigurationRequest- AConsumerthat will call methods onDescribeGatewayCapabilityConfigurationRequest.Builderto create a request.- Returns:
- Result of the DescribeGatewayCapabilityConfiguration operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeLoggingOptions
default DescribeLoggingOptionsResponse describeLoggingOptions(DescribeLoggingOptionsRequest describeLoggingOptionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves the current IoT SiteWise logging options.
- Parameters:
describeLoggingOptionsRequest-- Returns:
- Result of the DescribeLoggingOptions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeLoggingOptions
default DescribeLoggingOptionsResponse describeLoggingOptions(Consumer<DescribeLoggingOptionsRequest.Builder> describeLoggingOptionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves the current IoT SiteWise logging options.
This is a convenience which creates an instance of the
DescribeLoggingOptionsRequest.Builderavoiding the need to create one manually viaDescribeLoggingOptionsRequest.builder()- Parameters:
describeLoggingOptionsRequest- AConsumerthat will call methods onDescribeLoggingOptionsRequest.Builderto create a request.- Returns:
- Result of the DescribeLoggingOptions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describePortal
default DescribePortalResponse describePortal(DescribePortalRequest describePortalRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves information about a portal.
- Parameters:
describePortalRequest-- Returns:
- Result of the DescribePortal operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
describePortal
default DescribePortalResponse describePortal(Consumer<DescribePortalRequest.Builder> describePortalRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves information about a portal.
This is a convenience which creates an instance of the
DescribePortalRequest.Builderavoiding the need to create one manually viaDescribePortalRequest.builder()- Parameters:
describePortalRequest- AConsumerthat will call methods onDescribePortalRequest.Builderto create a request.- Returns:
- Result of the DescribePortal operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeProject
default DescribeProjectResponse describeProject(DescribeProjectRequest describeProjectRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves information about a project.
- Parameters:
describeProjectRequest-- Returns:
- Result of the DescribeProject operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeProject
default DescribeProjectResponse describeProject(Consumer<DescribeProjectRequest.Builder> describeProjectRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves information about a project.
This is a convenience which creates an instance of the
DescribeProjectRequest.Builderavoiding the need to create one manually viaDescribeProjectRequest.builder()- Parameters:
describeProjectRequest- AConsumerthat will call methods onDescribeProjectRequest.Builderto create a request.- Returns:
- Result of the DescribeProject operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeStorageConfiguration
default DescribeStorageConfigurationResponse describeStorageConfiguration(DescribeStorageConfigurationRequest describeStorageConfigurationRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, LimitExceededException, ConflictingOperationException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves information about the storage configuration for IoT SiteWise.
- Parameters:
describeStorageConfigurationRequest-- Returns:
- Result of the DescribeStorageConfiguration operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.ResourceNotFoundException- The requested resource can't be found.InternalFailureException- IoT SiteWise can't process your request right now. Try again later.ThrottlingException- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException- You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.For more information, see Quotas in the IoT SiteWise User Guide.
ConflictingOperationException- Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeStorageConfiguration
default DescribeStorageConfigurationResponse describeStorageConfiguration(Consumer<DescribeStorageConfigurationRequest.Builder> describeStorageConfigurationRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, LimitExceededException, ConflictingOperationException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves information about the storage configuration for IoT SiteWise.
This is a convenience which creates an instance of the
DescribeStorageConfigurationRequest.Builderavoiding the need to create one manually viaDescribeStorageConfigurationRequest.builder()- Parameters:
describeStorageConfigurationRequest- AConsumerthat will call methods onDescribeStorageConfigurationRequest.Builderto create a request.- Returns:
- Result of the DescribeStorageConfiguration operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.ResourceNotFoundException- The requested resource can't be found.InternalFailureException- IoT SiteWise can't process your request right now. Try again later.ThrottlingException- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException- You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.For more information, see Quotas in the IoT SiteWise User Guide.
ConflictingOperationException- Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeTimeSeries
default DescribeTimeSeriesResponse describeTimeSeries(DescribeTimeSeriesRequest describeTimeSeriesRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
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
aliasof the time series. -
If the time series is associated with an asset property, specify one of the following:
-
The
aliasof the time series. -
The
assetIdandpropertyIdthat identifies the asset property.
-
- Parameters:
describeTimeSeriesRequest-- Returns:
- Result of the DescribeTimeSeries operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
-
describeTimeSeries
default DescribeTimeSeriesResponse describeTimeSeries(Consumer<DescribeTimeSeriesRequest.Builder> describeTimeSeriesRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
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
aliasof the time series. -
If the time series is associated with an asset property, specify one of the following:
-
The
aliasof the time series. -
The
assetIdandpropertyIdthat identifies the asset property.
-
This is a convenience which creates an instance of the
DescribeTimeSeriesRequest.Builderavoiding the need to create one manually viaDescribeTimeSeriesRequest.builder()- Parameters:
describeTimeSeriesRequest- AConsumerthat will call methods onDescribeTimeSeriesRequest.Builderto create a request.- Returns:
- Result of the DescribeTimeSeries operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
-
disassociateAssets
default DisassociateAssetsResponse disassociateAssets(DisassociateAssetsRequest disassociateAssetsRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, ConflictingOperationException, AwsServiceException, SdkClientException, IoTSiteWiseException
Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model.
- Parameters:
disassociateAssetsRequest-- Returns:
- Result of the DisassociateAssets operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
disassociateAssets
default DisassociateAssetsResponse disassociateAssets(Consumer<DisassociateAssetsRequest.Builder> disassociateAssetsRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, ConflictingOperationException, AwsServiceException, SdkClientException, IoTSiteWiseException
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.Builderavoiding the need to create one manually viaDisassociateAssetsRequest.builder()- Parameters:
disassociateAssetsRequest- AConsumerthat will call methods onDisassociateAssetsRequest.Builderto create a request.- Returns:
- Result of the DisassociateAssets operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
disassociateTimeSeriesFromAssetProperty
default DisassociateTimeSeriesFromAssetPropertyResponse disassociateTimeSeriesFromAssetProperty(DisassociateTimeSeriesFromAssetPropertyRequest disassociateTimeSeriesFromAssetPropertyRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, ConflictingOperationException, AwsServiceException, SdkClientException, IoTSiteWiseException
Disassociates a time series (data stream) from an asset property.
- Parameters:
disassociateTimeSeriesFromAssetPropertyRequest-- Returns:
- Result of the DisassociateTimeSeriesFromAssetProperty operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
disassociateTimeSeriesFromAssetProperty
default DisassociateTimeSeriesFromAssetPropertyResponse disassociateTimeSeriesFromAssetProperty(Consumer<DisassociateTimeSeriesFromAssetPropertyRequest.Builder> disassociateTimeSeriesFromAssetPropertyRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, ConflictingOperationException, AwsServiceException, SdkClientException, IoTSiteWiseException
Disassociates a time series (data stream) from an asset property.
This is a convenience which creates an instance of the
DisassociateTimeSeriesFromAssetPropertyRequest.Builderavoiding the need to create one manually viaDisassociateTimeSeriesFromAssetPropertyRequest.builder()- Parameters:
disassociateTimeSeriesFromAssetPropertyRequest- AConsumerthat will call methods onDisassociateTimeSeriesFromAssetPropertyRequest.Builderto create a request.- Returns:
- Result of the DisassociateTimeSeriesFromAssetProperty operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
executeAction
default ExecuteActionResponse executeAction(ExecuteActionRequest executeActionRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, LimitExceededException, ConflictingOperationException, AwsServiceException, SdkClientException, IoTSiteWiseException
Executes an action on a target resource.
- Parameters:
executeActionRequest-- Returns:
- Result of the ExecuteAction operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.ResourceNotFoundException- The requested resource can't be found.InternalFailureException- IoT SiteWise can't process your request right now. Try again later.ThrottlingException- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException- You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.For more information, see Quotas in the IoT SiteWise User Guide.
ConflictingOperationException- Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
executeAction
default ExecuteActionResponse executeAction(Consumer<ExecuteActionRequest.Builder> executeActionRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, LimitExceededException, ConflictingOperationException, AwsServiceException, SdkClientException, IoTSiteWiseException
Executes an action on a target resource.
This is a convenience which creates an instance of the
ExecuteActionRequest.Builderavoiding the need to create one manually viaExecuteActionRequest.builder()- Parameters:
executeActionRequest- AConsumerthat will call methods onExecuteActionRequest.Builderto create a request.- Returns:
- Result of the ExecuteAction operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.ResourceNotFoundException- The requested resource can't be found.InternalFailureException- IoT SiteWise can't process your request right now. Try again later.ThrottlingException- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException- You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.For more information, see Quotas in the IoT SiteWise User Guide.
ConflictingOperationException- Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
executeQuery
default ExecuteQueryResponse executeQuery(ExecuteQueryRequest executeQueryRequest) throws InvalidRequestException, ThrottlingException, AccessDeniedException, ValidationException, QueryTimeoutException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IoTSiteWiseException
Run SQL queries to retrieve metadata and time-series data from asset models, assets, measurements, metrics, transforms, and aggregates.
- Parameters:
executeQueryRequest-- Returns:
- Result of the ExecuteQuery operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
executeQuery
default ExecuteQueryResponse executeQuery(Consumer<ExecuteQueryRequest.Builder> executeQueryRequest) throws InvalidRequestException, ThrottlingException, AccessDeniedException, ValidationException, QueryTimeoutException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IoTSiteWiseException
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.Builderavoiding the need to create one manually viaExecuteQueryRequest.builder()- Parameters:
executeQueryRequest- AConsumerthat will call methods onExecuteQueryRequest.Builderto create a request.- Returns:
- Result of the ExecuteQuery operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
executeQueryPaginator
default ExecuteQueryIterable executeQueryPaginator(ExecuteQueryRequest executeQueryRequest) throws InvalidRequestException, ThrottlingException, AccessDeniedException, ValidationException, QueryTimeoutException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IoTSiteWiseException
This is a variant of
executeQuery(software.amazon.awssdk.services.iotsitewise.model.ExecuteQueryRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotsitewise.paginators.ExecuteQueryIterable responses = client.executeQueryPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotsitewise.paginators.ExecuteQueryIterable responses = client.executeQueryPaginator(request); for (software.amazon.awssdk.services.iotsitewise.model.ExecuteQueryResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotsitewise.paginators.ExecuteQueryIterable responses = client.executeQueryPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
executeQuery(software.amazon.awssdk.services.iotsitewise.model.ExecuteQueryRequest)operation.- Parameters:
executeQueryRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
executeQueryPaginator
default ExecuteQueryIterable executeQueryPaginator(Consumer<ExecuteQueryRequest.Builder> executeQueryRequest) throws InvalidRequestException, ThrottlingException, AccessDeniedException, ValidationException, QueryTimeoutException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IoTSiteWiseException
This is a variant of
executeQuery(software.amazon.awssdk.services.iotsitewise.model.ExecuteQueryRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotsitewise.paginators.ExecuteQueryIterable responses = client.executeQueryPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotsitewise.paginators.ExecuteQueryIterable responses = client.executeQueryPaginator(request); for (software.amazon.awssdk.services.iotsitewise.model.ExecuteQueryResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotsitewise.paginators.ExecuteQueryIterable responses = client.executeQueryPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
executeQuery(software.amazon.awssdk.services.iotsitewise.model.ExecuteQueryRequest)operation.
This is a convenience which creates an instance of the
ExecuteQueryRequest.Builderavoiding the need to create one manually viaExecuteQueryRequest.builder()- Parameters:
executeQueryRequest- AConsumerthat will call methods onExecuteQueryRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getAssetPropertyAggregates
default GetAssetPropertyAggregatesResponse getAssetPropertyAggregates(GetAssetPropertyAggregatesRequest getAssetPropertyAggregatesRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IoTSiteWiseException
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
assetIdandpropertyIdof 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:
- Result of the GetAssetPropertyAggregates operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
-
getAssetPropertyAggregates
default GetAssetPropertyAggregatesResponse getAssetPropertyAggregates(Consumer<GetAssetPropertyAggregatesRequest.Builder> getAssetPropertyAggregatesRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IoTSiteWiseException
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
assetIdandpropertyIdof 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.Builderavoiding the need to create one manually viaGetAssetPropertyAggregatesRequest.builder()- Parameters:
getAssetPropertyAggregatesRequest- AConsumerthat will call methods onGetAssetPropertyAggregatesRequest.Builderto create a request.- Returns:
- Result of the GetAssetPropertyAggregates operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
-
getAssetPropertyAggregatesPaginator
default GetAssetPropertyAggregatesIterable getAssetPropertyAggregatesPaginator(GetAssetPropertyAggregatesRequest getAssetPropertyAggregatesRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IoTSiteWiseException
This is a variant of
getAssetPropertyAggregates(software.amazon.awssdk.services.iotsitewise.model.GetAssetPropertyAggregatesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotsitewise.paginators.GetAssetPropertyAggregatesIterable responses = client.getAssetPropertyAggregatesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotsitewise.paginators.GetAssetPropertyAggregatesIterable responses = client .getAssetPropertyAggregatesPaginator(request); for (software.amazon.awssdk.services.iotsitewise.model.GetAssetPropertyAggregatesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotsitewise.paginators.GetAssetPropertyAggregatesIterable responses = client.getAssetPropertyAggregatesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getAssetPropertyAggregates(software.amazon.awssdk.services.iotsitewise.model.GetAssetPropertyAggregatesRequest)operation.- Parameters:
getAssetPropertyAggregatesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
getAssetPropertyAggregatesPaginator
default GetAssetPropertyAggregatesIterable getAssetPropertyAggregatesPaginator(Consumer<GetAssetPropertyAggregatesRequest.Builder> getAssetPropertyAggregatesRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IoTSiteWiseException
This is a variant of
getAssetPropertyAggregates(software.amazon.awssdk.services.iotsitewise.model.GetAssetPropertyAggregatesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotsitewise.paginators.GetAssetPropertyAggregatesIterable responses = client.getAssetPropertyAggregatesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotsitewise.paginators.GetAssetPropertyAggregatesIterable responses = client .getAssetPropertyAggregatesPaginator(request); for (software.amazon.awssdk.services.iotsitewise.model.GetAssetPropertyAggregatesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotsitewise.paginators.GetAssetPropertyAggregatesIterable responses = client.getAssetPropertyAggregatesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getAssetPropertyAggregates(software.amazon.awssdk.services.iotsitewise.model.GetAssetPropertyAggregatesRequest)operation.
This is a convenience which creates an instance of the
GetAssetPropertyAggregatesRequest.Builderavoiding the need to create one manually viaGetAssetPropertyAggregatesRequest.builder()- Parameters:
getAssetPropertyAggregatesRequest- AConsumerthat will call methods onGetAssetPropertyAggregatesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
getAssetPropertyValue
default GetAssetPropertyValueResponse getAssetPropertyValue(GetAssetPropertyValueRequest getAssetPropertyValueRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IoTSiteWiseException
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
assetIdandpropertyIdof 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:
- Result of the GetAssetPropertyValue operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
-
getAssetPropertyValue
default GetAssetPropertyValueResponse getAssetPropertyValue(Consumer<GetAssetPropertyValueRequest.Builder> getAssetPropertyValueRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IoTSiteWiseException
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
assetIdandpropertyIdof 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.Builderavoiding the need to create one manually viaGetAssetPropertyValueRequest.builder()- Parameters:
getAssetPropertyValueRequest- AConsumerthat will call methods onGetAssetPropertyValueRequest.Builderto create a request.- Returns:
- Result of the GetAssetPropertyValue operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
-
getAssetPropertyValueHistory
default GetAssetPropertyValueHistoryResponse getAssetPropertyValueHistory(GetAssetPropertyValueHistoryRequest getAssetPropertyValueHistoryRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IoTSiteWiseException
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
assetIdandpropertyIdof 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:
- Result of the GetAssetPropertyValueHistory operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
-
getAssetPropertyValueHistory
default GetAssetPropertyValueHistoryResponse getAssetPropertyValueHistory(Consumer<GetAssetPropertyValueHistoryRequest.Builder> getAssetPropertyValueHistoryRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IoTSiteWiseException
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
assetIdandpropertyIdof 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.Builderavoiding the need to create one manually viaGetAssetPropertyValueHistoryRequest.builder()- Parameters:
getAssetPropertyValueHistoryRequest- AConsumerthat will call methods onGetAssetPropertyValueHistoryRequest.Builderto create a request.- Returns:
- Result of the GetAssetPropertyValueHistory operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
-
getAssetPropertyValueHistoryPaginator
default GetAssetPropertyValueHistoryIterable getAssetPropertyValueHistoryPaginator(GetAssetPropertyValueHistoryRequest getAssetPropertyValueHistoryRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IoTSiteWiseException
This is a variant of
getAssetPropertyValueHistory(software.amazon.awssdk.services.iotsitewise.model.GetAssetPropertyValueHistoryRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotsitewise.paginators.GetAssetPropertyValueHistoryIterable responses = client.getAssetPropertyValueHistoryPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotsitewise.paginators.GetAssetPropertyValueHistoryIterable responses = client .getAssetPropertyValueHistoryPaginator(request); for (software.amazon.awssdk.services.iotsitewise.model.GetAssetPropertyValueHistoryResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotsitewise.paginators.GetAssetPropertyValueHistoryIterable responses = client.getAssetPropertyValueHistoryPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getAssetPropertyValueHistory(software.amazon.awssdk.services.iotsitewise.model.GetAssetPropertyValueHistoryRequest)operation.- Parameters:
getAssetPropertyValueHistoryRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
getAssetPropertyValueHistoryPaginator
default GetAssetPropertyValueHistoryIterable getAssetPropertyValueHistoryPaginator(Consumer<GetAssetPropertyValueHistoryRequest.Builder> getAssetPropertyValueHistoryRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IoTSiteWiseException
This is a variant of
getAssetPropertyValueHistory(software.amazon.awssdk.services.iotsitewise.model.GetAssetPropertyValueHistoryRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotsitewise.paginators.GetAssetPropertyValueHistoryIterable responses = client.getAssetPropertyValueHistoryPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotsitewise.paginators.GetAssetPropertyValueHistoryIterable responses = client .getAssetPropertyValueHistoryPaginator(request); for (software.amazon.awssdk.services.iotsitewise.model.GetAssetPropertyValueHistoryResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotsitewise.paginators.GetAssetPropertyValueHistoryIterable responses = client.getAssetPropertyValueHistoryPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getAssetPropertyValueHistory(software.amazon.awssdk.services.iotsitewise.model.GetAssetPropertyValueHistoryRequest)operation.
This is a convenience which creates an instance of the
GetAssetPropertyValueHistoryRequest.Builderavoiding the need to create one manually viaGetAssetPropertyValueHistoryRequest.builder()- Parameters:
getAssetPropertyValueHistoryRequest- AConsumerthat will call methods onGetAssetPropertyValueHistoryRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
getInterpolatedAssetPropertyValues
default GetInterpolatedAssetPropertyValuesResponse getInterpolatedAssetPropertyValues(GetInterpolatedAssetPropertyValuesRequest getInterpolatedAssetPropertyValuesRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IoTSiteWiseException
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
assetIdandpropertyIdof 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:
- Result of the GetInterpolatedAssetPropertyValues operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
-
getInterpolatedAssetPropertyValues
default GetInterpolatedAssetPropertyValuesResponse getInterpolatedAssetPropertyValues(Consumer<GetInterpolatedAssetPropertyValuesRequest.Builder> getInterpolatedAssetPropertyValuesRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IoTSiteWiseException
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
assetIdandpropertyIdof 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.Builderavoiding the need to create one manually viaGetInterpolatedAssetPropertyValuesRequest.builder()- Parameters:
getInterpolatedAssetPropertyValuesRequest- AConsumerthat will call methods onGetInterpolatedAssetPropertyValuesRequest.Builderto create a request.- Returns:
- Result of the GetInterpolatedAssetPropertyValues operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
-
getInterpolatedAssetPropertyValuesPaginator
default GetInterpolatedAssetPropertyValuesIterable getInterpolatedAssetPropertyValuesPaginator(GetInterpolatedAssetPropertyValuesRequest getInterpolatedAssetPropertyValuesRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IoTSiteWiseException
This is a variant of
getInterpolatedAssetPropertyValues(software.amazon.awssdk.services.iotsitewise.model.GetInterpolatedAssetPropertyValuesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotsitewise.paginators.GetInterpolatedAssetPropertyValuesIterable responses = client.getInterpolatedAssetPropertyValuesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotsitewise.paginators.GetInterpolatedAssetPropertyValuesIterable responses = client .getInterpolatedAssetPropertyValuesPaginator(request); for (software.amazon.awssdk.services.iotsitewise.model.GetInterpolatedAssetPropertyValuesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotsitewise.paginators.GetInterpolatedAssetPropertyValuesIterable responses = client.getInterpolatedAssetPropertyValuesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getInterpolatedAssetPropertyValues(software.amazon.awssdk.services.iotsitewise.model.GetInterpolatedAssetPropertyValuesRequest)operation.- Parameters:
getInterpolatedAssetPropertyValuesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
getInterpolatedAssetPropertyValuesPaginator
default GetInterpolatedAssetPropertyValuesIterable getInterpolatedAssetPropertyValuesPaginator(Consumer<GetInterpolatedAssetPropertyValuesRequest.Builder> getInterpolatedAssetPropertyValuesRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IoTSiteWiseException
This is a variant of
getInterpolatedAssetPropertyValues(software.amazon.awssdk.services.iotsitewise.model.GetInterpolatedAssetPropertyValuesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotsitewise.paginators.GetInterpolatedAssetPropertyValuesIterable responses = client.getInterpolatedAssetPropertyValuesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotsitewise.paginators.GetInterpolatedAssetPropertyValuesIterable responses = client .getInterpolatedAssetPropertyValuesPaginator(request); for (software.amazon.awssdk.services.iotsitewise.model.GetInterpolatedAssetPropertyValuesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotsitewise.paginators.GetInterpolatedAssetPropertyValuesIterable responses = client.getInterpolatedAssetPropertyValuesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getInterpolatedAssetPropertyValues(software.amazon.awssdk.services.iotsitewise.model.GetInterpolatedAssetPropertyValuesRequest)operation.
This is a convenience which creates an instance of the
GetInterpolatedAssetPropertyValuesRequest.Builderavoiding the need to create one manually viaGetInterpolatedAssetPropertyValuesRequest.builder()- Parameters:
getInterpolatedAssetPropertyValuesRequest- AConsumerthat will call methods onGetInterpolatedAssetPropertyValuesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
listAccessPolicies
default ListAccessPoliciesResponse listAccessPolicies(ListAccessPoliciesRequest listAccessPoliciesRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
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:
- Result of the ListAccessPolicies operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAccessPolicies
default ListAccessPoliciesResponse listAccessPolicies(Consumer<ListAccessPoliciesRequest.Builder> listAccessPoliciesRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
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.Builderavoiding the need to create one manually viaListAccessPoliciesRequest.builder()- Parameters:
listAccessPoliciesRequest- AConsumerthat will call methods onListAccessPoliciesRequest.Builderto create a request.- Returns:
- Result of the ListAccessPolicies operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAccessPoliciesPaginator
default ListAccessPoliciesIterable listAccessPoliciesPaginator(ListAccessPoliciesRequest listAccessPoliciesRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
This is a variant of
listAccessPolicies(software.amazon.awssdk.services.iotsitewise.model.ListAccessPoliciesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotsitewise.paginators.ListAccessPoliciesIterable responses = client.listAccessPoliciesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotsitewise.paginators.ListAccessPoliciesIterable responses = client .listAccessPoliciesPaginator(request); for (software.amazon.awssdk.services.iotsitewise.model.ListAccessPoliciesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotsitewise.paginators.ListAccessPoliciesIterable responses = client.listAccessPoliciesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAccessPolicies(software.amazon.awssdk.services.iotsitewise.model.ListAccessPoliciesRequest)operation.- Parameters:
listAccessPoliciesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAccessPoliciesPaginator
default ListAccessPoliciesIterable listAccessPoliciesPaginator(Consumer<ListAccessPoliciesRequest.Builder> listAccessPoliciesRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
This is a variant of
listAccessPolicies(software.amazon.awssdk.services.iotsitewise.model.ListAccessPoliciesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotsitewise.paginators.ListAccessPoliciesIterable responses = client.listAccessPoliciesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotsitewise.paginators.ListAccessPoliciesIterable responses = client .listAccessPoliciesPaginator(request); for (software.amazon.awssdk.services.iotsitewise.model.ListAccessPoliciesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotsitewise.paginators.ListAccessPoliciesIterable responses = client.listAccessPoliciesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAccessPolicies(software.amazon.awssdk.services.iotsitewise.model.ListAccessPoliciesRequest)operation.
This is a convenience which creates an instance of the
ListAccessPoliciesRequest.Builderavoiding the need to create one manually viaListAccessPoliciesRequest.builder()- Parameters:
listAccessPoliciesRequest- AConsumerthat will call methods onListAccessPoliciesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listActions
default ListActionsResponse listActions(ListActionsRequest listActionsRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves a paginated list of actions for a specific target resource.
- Parameters:
listActionsRequest-- Returns:
- Result of the ListActions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listActions
default ListActionsResponse listActions(Consumer<ListActionsRequest.Builder> listActionsRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves a paginated list of actions for a specific target resource.
This is a convenience which creates an instance of the
ListActionsRequest.Builderavoiding the need to create one manually viaListActionsRequest.builder()- Parameters:
listActionsRequest- AConsumerthat will call methods onListActionsRequest.Builderto create a request.- Returns:
- Result of the ListActions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listActionsPaginator
default ListActionsIterable listActionsPaginator(ListActionsRequest listActionsRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
This is a variant of
listActions(software.amazon.awssdk.services.iotsitewise.model.ListActionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotsitewise.paginators.ListActionsIterable responses = client.listActionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotsitewise.paginators.ListActionsIterable responses = client.listActionsPaginator(request); for (software.amazon.awssdk.services.iotsitewise.model.ListActionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotsitewise.paginators.ListActionsIterable responses = client.listActionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listActions(software.amazon.awssdk.services.iotsitewise.model.ListActionsRequest)operation.- Parameters:
listActionsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listActionsPaginator
default ListActionsIterable listActionsPaginator(Consumer<ListActionsRequest.Builder> listActionsRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
This is a variant of
listActions(software.amazon.awssdk.services.iotsitewise.model.ListActionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotsitewise.paginators.ListActionsIterable responses = client.listActionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotsitewise.paginators.ListActionsIterable responses = client.listActionsPaginator(request); for (software.amazon.awssdk.services.iotsitewise.model.ListActionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotsitewise.paginators.ListActionsIterable responses = client.listActionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listActions(software.amazon.awssdk.services.iotsitewise.model.ListActionsRequest)operation.
This is a convenience which creates an instance of the
ListActionsRequest.Builderavoiding the need to create one manually viaListActionsRequest.builder()- Parameters:
listActionsRequest- AConsumerthat will call methods onListActionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAssetModelCompositeModels
default ListAssetModelCompositeModelsResponse listAssetModelCompositeModels(ListAssetModelCompositeModelsRequest listAssetModelCompositeModelsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves a paginated list of composite models associated with the asset model
- Parameters:
listAssetModelCompositeModelsRequest-- Returns:
- Result of the ListAssetModelCompositeModels operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAssetModelCompositeModels
default ListAssetModelCompositeModelsResponse listAssetModelCompositeModels(Consumer<ListAssetModelCompositeModelsRequest.Builder> listAssetModelCompositeModelsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves a paginated list of composite models associated with the asset model
This is a convenience which creates an instance of the
ListAssetModelCompositeModelsRequest.Builderavoiding the need to create one manually viaListAssetModelCompositeModelsRequest.builder()- Parameters:
listAssetModelCompositeModelsRequest- AConsumerthat will call methods onListAssetModelCompositeModelsRequest.Builderto create a request.- Returns:
- Result of the ListAssetModelCompositeModels operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAssetModelCompositeModelsPaginator
default ListAssetModelCompositeModelsIterable listAssetModelCompositeModelsPaginator(ListAssetModelCompositeModelsRequest listAssetModelCompositeModelsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTSiteWiseException
This is a variant of
listAssetModelCompositeModels(software.amazon.awssdk.services.iotsitewise.model.ListAssetModelCompositeModelsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotsitewise.paginators.ListAssetModelCompositeModelsIterable responses = client.listAssetModelCompositeModelsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotsitewise.paginators.ListAssetModelCompositeModelsIterable responses = client .listAssetModelCompositeModelsPaginator(request); for (software.amazon.awssdk.services.iotsitewise.model.ListAssetModelCompositeModelsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotsitewise.paginators.ListAssetModelCompositeModelsIterable responses = client.listAssetModelCompositeModelsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssetModelCompositeModels(software.amazon.awssdk.services.iotsitewise.model.ListAssetModelCompositeModelsRequest)operation.- Parameters:
listAssetModelCompositeModelsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAssetModelCompositeModelsPaginator
default ListAssetModelCompositeModelsIterable listAssetModelCompositeModelsPaginator(Consumer<ListAssetModelCompositeModelsRequest.Builder> listAssetModelCompositeModelsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTSiteWiseException
This is a variant of
listAssetModelCompositeModels(software.amazon.awssdk.services.iotsitewise.model.ListAssetModelCompositeModelsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotsitewise.paginators.ListAssetModelCompositeModelsIterable responses = client.listAssetModelCompositeModelsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotsitewise.paginators.ListAssetModelCompositeModelsIterable responses = client .listAssetModelCompositeModelsPaginator(request); for (software.amazon.awssdk.services.iotsitewise.model.ListAssetModelCompositeModelsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotsitewise.paginators.ListAssetModelCompositeModelsIterable responses = client.listAssetModelCompositeModelsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssetModelCompositeModels(software.amazon.awssdk.services.iotsitewise.model.ListAssetModelCompositeModelsRequest)operation.
This is a convenience which creates an instance of the
ListAssetModelCompositeModelsRequest.Builderavoiding the need to create one manually viaListAssetModelCompositeModelsRequest.builder()- Parameters:
listAssetModelCompositeModelsRequest- AConsumerthat will call methods onListAssetModelCompositeModelsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAssetModelProperties
default ListAssetModelPropertiesResponse listAssetModelProperties(ListAssetModelPropertiesRequest listAssetModelPropertiesRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
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:
- Result of the ListAssetModelProperties operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAssetModelProperties
default ListAssetModelPropertiesResponse listAssetModelProperties(Consumer<ListAssetModelPropertiesRequest.Builder> listAssetModelPropertiesRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
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.Builderavoiding the need to create one manually viaListAssetModelPropertiesRequest.builder()- Parameters:
listAssetModelPropertiesRequest- AConsumerthat will call methods onListAssetModelPropertiesRequest.Builderto create a request.- Returns:
- Result of the ListAssetModelProperties operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAssetModelPropertiesPaginator
default ListAssetModelPropertiesIterable listAssetModelPropertiesPaginator(ListAssetModelPropertiesRequest listAssetModelPropertiesRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
This is a variant of
listAssetModelProperties(software.amazon.awssdk.services.iotsitewise.model.ListAssetModelPropertiesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotsitewise.paginators.ListAssetModelPropertiesIterable responses = client.listAssetModelPropertiesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotsitewise.paginators.ListAssetModelPropertiesIterable responses = client .listAssetModelPropertiesPaginator(request); for (software.amazon.awssdk.services.iotsitewise.model.ListAssetModelPropertiesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotsitewise.paginators.ListAssetModelPropertiesIterable responses = client.listAssetModelPropertiesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssetModelProperties(software.amazon.awssdk.services.iotsitewise.model.ListAssetModelPropertiesRequest)operation.- Parameters:
listAssetModelPropertiesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAssetModelPropertiesPaginator
default ListAssetModelPropertiesIterable listAssetModelPropertiesPaginator(Consumer<ListAssetModelPropertiesRequest.Builder> listAssetModelPropertiesRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
This is a variant of
listAssetModelProperties(software.amazon.awssdk.services.iotsitewise.model.ListAssetModelPropertiesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotsitewise.paginators.ListAssetModelPropertiesIterable responses = client.listAssetModelPropertiesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotsitewise.paginators.ListAssetModelPropertiesIterable responses = client .listAssetModelPropertiesPaginator(request); for (software.amazon.awssdk.services.iotsitewise.model.ListAssetModelPropertiesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotsitewise.paginators.ListAssetModelPropertiesIterable responses = client.listAssetModelPropertiesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssetModelProperties(software.amazon.awssdk.services.iotsitewise.model.ListAssetModelPropertiesRequest)operation.
This is a convenience which creates an instance of the
ListAssetModelPropertiesRequest.Builderavoiding the need to create one manually viaListAssetModelPropertiesRequest.builder()- Parameters:
listAssetModelPropertiesRequest- AConsumerthat will call methods onListAssetModelPropertiesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAssetModels
default ListAssetModelsResponse listAssetModels(ListAssetModelsRequest listAssetModelsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves a paginated list of summaries of all asset models.
- Parameters:
listAssetModelsRequest-- Returns:
- Result of the ListAssetModels operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAssetModels
default ListAssetModelsResponse listAssetModels(Consumer<ListAssetModelsRequest.Builder> listAssetModelsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves a paginated list of summaries of all asset models.
This is a convenience which creates an instance of the
ListAssetModelsRequest.Builderavoiding the need to create one manually viaListAssetModelsRequest.builder()- Parameters:
listAssetModelsRequest- AConsumerthat will call methods onListAssetModelsRequest.Builderto create a request.- Returns:
- Result of the ListAssetModels operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAssetModelsPaginator
default ListAssetModelsIterable listAssetModelsPaginator(ListAssetModelsRequest listAssetModelsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
This is a variant of
listAssetModels(software.amazon.awssdk.services.iotsitewise.model.ListAssetModelsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotsitewise.paginators.ListAssetModelsIterable responses = client.listAssetModelsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotsitewise.paginators.ListAssetModelsIterable responses = client .listAssetModelsPaginator(request); for (software.amazon.awssdk.services.iotsitewise.model.ListAssetModelsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotsitewise.paginators.ListAssetModelsIterable responses = client.listAssetModelsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssetModels(software.amazon.awssdk.services.iotsitewise.model.ListAssetModelsRequest)operation.- Parameters:
listAssetModelsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAssetModelsPaginator
default ListAssetModelsIterable listAssetModelsPaginator(Consumer<ListAssetModelsRequest.Builder> listAssetModelsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
This is a variant of
listAssetModels(software.amazon.awssdk.services.iotsitewise.model.ListAssetModelsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotsitewise.paginators.ListAssetModelsIterable responses = client.listAssetModelsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotsitewise.paginators.ListAssetModelsIterable responses = client .listAssetModelsPaginator(request); for (software.amazon.awssdk.services.iotsitewise.model.ListAssetModelsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotsitewise.paginators.ListAssetModelsIterable responses = client.listAssetModelsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssetModels(software.amazon.awssdk.services.iotsitewise.model.ListAssetModelsRequest)operation.
This is a convenience which creates an instance of the
ListAssetModelsRequest.Builderavoiding the need to create one manually viaListAssetModelsRequest.builder()- Parameters:
listAssetModelsRequest- AConsumerthat will call methods onListAssetModelsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAssetProperties
default ListAssetPropertiesResponse listAssetProperties(ListAssetPropertiesRequest listAssetPropertiesRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
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:
- Result of the ListAssetProperties operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAssetProperties
default ListAssetPropertiesResponse listAssetProperties(Consumer<ListAssetPropertiesRequest.Builder> listAssetPropertiesRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
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.Builderavoiding the need to create one manually viaListAssetPropertiesRequest.builder()- Parameters:
listAssetPropertiesRequest- AConsumerthat will call methods onListAssetPropertiesRequest.Builderto create a request.- Returns:
- Result of the ListAssetProperties operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAssetPropertiesPaginator
default ListAssetPropertiesIterable listAssetPropertiesPaginator(ListAssetPropertiesRequest listAssetPropertiesRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
This is a variant of
listAssetProperties(software.amazon.awssdk.services.iotsitewise.model.ListAssetPropertiesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotsitewise.paginators.ListAssetPropertiesIterable responses = client.listAssetPropertiesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotsitewise.paginators.ListAssetPropertiesIterable responses = client .listAssetPropertiesPaginator(request); for (software.amazon.awssdk.services.iotsitewise.model.ListAssetPropertiesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotsitewise.paginators.ListAssetPropertiesIterable responses = client.listAssetPropertiesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssetProperties(software.amazon.awssdk.services.iotsitewise.model.ListAssetPropertiesRequest)operation.- Parameters:
listAssetPropertiesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAssetPropertiesPaginator
default ListAssetPropertiesIterable listAssetPropertiesPaginator(Consumer<ListAssetPropertiesRequest.Builder> listAssetPropertiesRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
This is a variant of
listAssetProperties(software.amazon.awssdk.services.iotsitewise.model.ListAssetPropertiesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotsitewise.paginators.ListAssetPropertiesIterable responses = client.listAssetPropertiesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotsitewise.paginators.ListAssetPropertiesIterable responses = client .listAssetPropertiesPaginator(request); for (software.amazon.awssdk.services.iotsitewise.model.ListAssetPropertiesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotsitewise.paginators.ListAssetPropertiesIterable responses = client.listAssetPropertiesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssetProperties(software.amazon.awssdk.services.iotsitewise.model.ListAssetPropertiesRequest)operation.
This is a convenience which creates an instance of the
ListAssetPropertiesRequest.Builderavoiding the need to create one manually viaListAssetPropertiesRequest.builder()- Parameters:
listAssetPropertiesRequest- AConsumerthat will call methods onListAssetPropertiesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAssetRelationships
default ListAssetRelationshipsResponse listAssetRelationships(ListAssetRelationshipsRequest listAssetRelationshipsRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
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:
- Result of the ListAssetRelationships operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAssetRelationships
default ListAssetRelationshipsResponse listAssetRelationships(Consumer<ListAssetRelationshipsRequest.Builder> listAssetRelationshipsRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
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.Builderavoiding the need to create one manually viaListAssetRelationshipsRequest.builder()- Parameters:
listAssetRelationshipsRequest- AConsumerthat will call methods onListAssetRelationshipsRequest.Builderto create a request.- Returns:
- Result of the ListAssetRelationships operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAssetRelationshipsPaginator
default ListAssetRelationshipsIterable listAssetRelationshipsPaginator(ListAssetRelationshipsRequest listAssetRelationshipsRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
This is a variant of
listAssetRelationships(software.amazon.awssdk.services.iotsitewise.model.ListAssetRelationshipsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotsitewise.paginators.ListAssetRelationshipsIterable responses = client.listAssetRelationshipsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotsitewise.paginators.ListAssetRelationshipsIterable responses = client .listAssetRelationshipsPaginator(request); for (software.amazon.awssdk.services.iotsitewise.model.ListAssetRelationshipsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotsitewise.paginators.ListAssetRelationshipsIterable responses = client.listAssetRelationshipsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssetRelationships(software.amazon.awssdk.services.iotsitewise.model.ListAssetRelationshipsRequest)operation.- Parameters:
listAssetRelationshipsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAssetRelationshipsPaginator
default ListAssetRelationshipsIterable listAssetRelationshipsPaginator(Consumer<ListAssetRelationshipsRequest.Builder> listAssetRelationshipsRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
This is a variant of
listAssetRelationships(software.amazon.awssdk.services.iotsitewise.model.ListAssetRelationshipsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotsitewise.paginators.ListAssetRelationshipsIterable responses = client.listAssetRelationshipsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotsitewise.paginators.ListAssetRelationshipsIterable responses = client .listAssetRelationshipsPaginator(request); for (software.amazon.awssdk.services.iotsitewise.model.ListAssetRelationshipsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotsitewise.paginators.ListAssetRelationshipsIterable responses = client.listAssetRelationshipsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssetRelationships(software.amazon.awssdk.services.iotsitewise.model.ListAssetRelationshipsRequest)operation.
This is a convenience which creates an instance of the
ListAssetRelationshipsRequest.Builderavoiding the need to create one manually viaListAssetRelationshipsRequest.builder()- Parameters:
listAssetRelationshipsRequest- AConsumerthat will call methods onListAssetRelationshipsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAssets
default ListAssetsResponse listAssets(ListAssetsRequest listAssetsRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
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:
- Result of the ListAssets operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
-
listAssets
default ListAssetsResponse listAssets(Consumer<ListAssetsRequest.Builder> listAssetsRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
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.Builderavoiding the need to create one manually viaListAssetsRequest.builder()- Parameters:
listAssetsRequest- AConsumerthat will call methods onListAssetsRequest.Builderto create a request.- Returns:
- Result of the ListAssets operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
-
listAssetsPaginator
default ListAssetsIterable listAssetsPaginator(ListAssetsRequest listAssetsRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
This is a variant of
listAssets(software.amazon.awssdk.services.iotsitewise.model.ListAssetsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotsitewise.paginators.ListAssetsIterable responses = client.listAssetsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotsitewise.paginators.ListAssetsIterable responses = client.listAssetsPaginator(request); for (software.amazon.awssdk.services.iotsitewise.model.ListAssetsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotsitewise.paginators.ListAssetsIterable responses = client.listAssetsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssets(software.amazon.awssdk.services.iotsitewise.model.ListAssetsRequest)operation.- Parameters:
listAssetsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAssetsPaginator
default ListAssetsIterable listAssetsPaginator(Consumer<ListAssetsRequest.Builder> listAssetsRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
This is a variant of
listAssets(software.amazon.awssdk.services.iotsitewise.model.ListAssetsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotsitewise.paginators.ListAssetsIterable responses = client.listAssetsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotsitewise.paginators.ListAssetsIterable responses = client.listAssetsPaginator(request); for (software.amazon.awssdk.services.iotsitewise.model.ListAssetsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotsitewise.paginators.ListAssetsIterable responses = client.listAssetsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssets(software.amazon.awssdk.services.iotsitewise.model.ListAssetsRequest)operation.
This is a convenience which creates an instance of the
ListAssetsRequest.Builderavoiding the need to create one manually viaListAssetsRequest.builder()- Parameters:
listAssetsRequest- AConsumerthat will call methods onListAssetsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAssociatedAssets
default ListAssociatedAssetsResponse listAssociatedAssets(ListAssociatedAssetsRequest listAssociatedAssetsRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves a paginated list of associated assets.
You can use this operation to do the following:
-
List child assets associated to a parent asset by a hierarchy that you specify.
-
List an asset's parent asset.
- Parameters:
listAssociatedAssetsRequest-- Returns:
- Result of the ListAssociatedAssets operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
-
listAssociatedAssets
default ListAssociatedAssetsResponse listAssociatedAssets(Consumer<ListAssociatedAssetsRequest.Builder> listAssociatedAssetsRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves a paginated list of associated assets.
You can use this operation to do the following:
-
List child assets associated to a parent asset by a hierarchy that you specify.
-
List an asset's parent asset.
This is a convenience which creates an instance of the
ListAssociatedAssetsRequest.Builderavoiding the need to create one manually viaListAssociatedAssetsRequest.builder()- Parameters:
listAssociatedAssetsRequest- AConsumerthat will call methods onListAssociatedAssetsRequest.Builderto create a request.- Returns:
- Result of the ListAssociatedAssets operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
-
listAssociatedAssetsPaginator
default ListAssociatedAssetsIterable listAssociatedAssetsPaginator(ListAssociatedAssetsRequest listAssociatedAssetsRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
This is a variant of
listAssociatedAssets(software.amazon.awssdk.services.iotsitewise.model.ListAssociatedAssetsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotsitewise.paginators.ListAssociatedAssetsIterable responses = client.listAssociatedAssetsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotsitewise.paginators.ListAssociatedAssetsIterable responses = client .listAssociatedAssetsPaginator(request); for (software.amazon.awssdk.services.iotsitewise.model.ListAssociatedAssetsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotsitewise.paginators.ListAssociatedAssetsIterable responses = client.listAssociatedAssetsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssociatedAssets(software.amazon.awssdk.services.iotsitewise.model.ListAssociatedAssetsRequest)operation.- Parameters:
listAssociatedAssetsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAssociatedAssetsPaginator
default ListAssociatedAssetsIterable listAssociatedAssetsPaginator(Consumer<ListAssociatedAssetsRequest.Builder> listAssociatedAssetsRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
This is a variant of
listAssociatedAssets(software.amazon.awssdk.services.iotsitewise.model.ListAssociatedAssetsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotsitewise.paginators.ListAssociatedAssetsIterable responses = client.listAssociatedAssetsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotsitewise.paginators.ListAssociatedAssetsIterable responses = client .listAssociatedAssetsPaginator(request); for (software.amazon.awssdk.services.iotsitewise.model.ListAssociatedAssetsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotsitewise.paginators.ListAssociatedAssetsIterable responses = client.listAssociatedAssetsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssociatedAssets(software.amazon.awssdk.services.iotsitewise.model.ListAssociatedAssetsRequest)operation.
This is a convenience which creates an instance of the
ListAssociatedAssetsRequest.Builderavoiding the need to create one manually viaListAssociatedAssetsRequest.builder()- Parameters:
listAssociatedAssetsRequest- AConsumerthat will call methods onListAssociatedAssetsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listBulkImportJobs
default ListBulkImportJobsResponse listBulkImportJobs(ListBulkImportJobsRequest listBulkImportJobsRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
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:
- Result of the ListBulkImportJobs operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listBulkImportJobs
default ListBulkImportJobsResponse listBulkImportJobs(Consumer<ListBulkImportJobsRequest.Builder> listBulkImportJobsRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
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.Builderavoiding the need to create one manually viaListBulkImportJobsRequest.builder()- Parameters:
listBulkImportJobsRequest- AConsumerthat will call methods onListBulkImportJobsRequest.Builderto create a request.- Returns:
- Result of the ListBulkImportJobs operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listBulkImportJobsPaginator
default ListBulkImportJobsIterable listBulkImportJobsPaginator(ListBulkImportJobsRequest listBulkImportJobsRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
This is a variant of
listBulkImportJobs(software.amazon.awssdk.services.iotsitewise.model.ListBulkImportJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotsitewise.paginators.ListBulkImportJobsIterable responses = client.listBulkImportJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotsitewise.paginators.ListBulkImportJobsIterable responses = client .listBulkImportJobsPaginator(request); for (software.amazon.awssdk.services.iotsitewise.model.ListBulkImportJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotsitewise.paginators.ListBulkImportJobsIterable responses = client.listBulkImportJobsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBulkImportJobs(software.amazon.awssdk.services.iotsitewise.model.ListBulkImportJobsRequest)operation.- Parameters:
listBulkImportJobsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listBulkImportJobsPaginator
default ListBulkImportJobsIterable listBulkImportJobsPaginator(Consumer<ListBulkImportJobsRequest.Builder> listBulkImportJobsRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
This is a variant of
listBulkImportJobs(software.amazon.awssdk.services.iotsitewise.model.ListBulkImportJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotsitewise.paginators.ListBulkImportJobsIterable responses = client.listBulkImportJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotsitewise.paginators.ListBulkImportJobsIterable responses = client .listBulkImportJobsPaginator(request); for (software.amazon.awssdk.services.iotsitewise.model.ListBulkImportJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotsitewise.paginators.ListBulkImportJobsIterable responses = client.listBulkImportJobsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBulkImportJobs(software.amazon.awssdk.services.iotsitewise.model.ListBulkImportJobsRequest)operation.
This is a convenience which creates an instance of the
ListBulkImportJobsRequest.Builderavoiding the need to create one manually viaListBulkImportJobsRequest.builder()- Parameters:
listBulkImportJobsRequest- AConsumerthat will call methods onListBulkImportJobsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listCompositionRelationships
default ListCompositionRelationshipsResponse listCompositionRelationships(ListCompositionRelationshipsRequest listCompositionRelationshipsRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves a paginated list of composition relationships for an asset model of type
COMPONENT_MODEL.- Parameters:
listCompositionRelationshipsRequest-- Returns:
- Result of the ListCompositionRelationships operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listCompositionRelationships
default ListCompositionRelationshipsResponse listCompositionRelationships(Consumer<ListCompositionRelationshipsRequest.Builder> listCompositionRelationshipsRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
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.Builderavoiding the need to create one manually viaListCompositionRelationshipsRequest.builder()- Parameters:
listCompositionRelationshipsRequest- AConsumerthat will call methods onListCompositionRelationshipsRequest.Builderto create a request.- Returns:
- Result of the ListCompositionRelationships operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listCompositionRelationshipsPaginator
default ListCompositionRelationshipsIterable listCompositionRelationshipsPaginator(ListCompositionRelationshipsRequest listCompositionRelationshipsRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
This is a variant of
listCompositionRelationships(software.amazon.awssdk.services.iotsitewise.model.ListCompositionRelationshipsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotsitewise.paginators.ListCompositionRelationshipsIterable responses = client.listCompositionRelationshipsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotsitewise.paginators.ListCompositionRelationshipsIterable responses = client .listCompositionRelationshipsPaginator(request); for (software.amazon.awssdk.services.iotsitewise.model.ListCompositionRelationshipsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotsitewise.paginators.ListCompositionRelationshipsIterable responses = client.listCompositionRelationshipsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCompositionRelationships(software.amazon.awssdk.services.iotsitewise.model.ListCompositionRelationshipsRequest)operation.- Parameters:
listCompositionRelationshipsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listCompositionRelationshipsPaginator
default ListCompositionRelationshipsIterable listCompositionRelationshipsPaginator(Consumer<ListCompositionRelationshipsRequest.Builder> listCompositionRelationshipsRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
This is a variant of
listCompositionRelationships(software.amazon.awssdk.services.iotsitewise.model.ListCompositionRelationshipsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotsitewise.paginators.ListCompositionRelationshipsIterable responses = client.listCompositionRelationshipsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotsitewise.paginators.ListCompositionRelationshipsIterable responses = client .listCompositionRelationshipsPaginator(request); for (software.amazon.awssdk.services.iotsitewise.model.ListCompositionRelationshipsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotsitewise.paginators.ListCompositionRelationshipsIterable responses = client.listCompositionRelationshipsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCompositionRelationships(software.amazon.awssdk.services.iotsitewise.model.ListCompositionRelationshipsRequest)operation.
This is a convenience which creates an instance of the
ListCompositionRelationshipsRequest.Builderavoiding the need to create one manually viaListCompositionRelationshipsRequest.builder()- Parameters:
listCompositionRelationshipsRequest- AConsumerthat will call methods onListCompositionRelationshipsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDashboards
default ListDashboardsResponse listDashboards(ListDashboardsRequest listDashboardsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves a paginated list of dashboards for an IoT SiteWise Monitor project.
- Parameters:
listDashboardsRequest-- Returns:
- Result of the ListDashboards operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDashboards
default ListDashboardsResponse listDashboards(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves a paginated list of dashboards for an IoT SiteWise Monitor project.
This is a convenience which creates an instance of the
ListDashboardsRequest.Builderavoiding the need to create one manually viaListDashboardsRequest.builder()- Parameters:
listDashboardsRequest- AConsumerthat will call methods onListDashboardsRequest.Builderto create a request.- Returns:
- Result of the ListDashboards operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDashboardsPaginator
default ListDashboardsIterable listDashboardsPaginator(ListDashboardsRequest listDashboardsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
This is a variant of
listDashboards(software.amazon.awssdk.services.iotsitewise.model.ListDashboardsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotsitewise.paginators.ListDashboardsIterable responses = client.listDashboardsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotsitewise.paginators.ListDashboardsIterable responses = client .listDashboardsPaginator(request); for (software.amazon.awssdk.services.iotsitewise.model.ListDashboardsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotsitewise.paginators.ListDashboardsIterable responses = client.listDashboardsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDashboards(software.amazon.awssdk.services.iotsitewise.model.ListDashboardsRequest)operation.- Parameters:
listDashboardsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDashboardsPaginator
default ListDashboardsIterable listDashboardsPaginator(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
This is a variant of
listDashboards(software.amazon.awssdk.services.iotsitewise.model.ListDashboardsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotsitewise.paginators.ListDashboardsIterable responses = client.listDashboardsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotsitewise.paginators.ListDashboardsIterable responses = client .listDashboardsPaginator(request); for (software.amazon.awssdk.services.iotsitewise.model.ListDashboardsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotsitewise.paginators.ListDashboardsIterable responses = client.listDashboardsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDashboards(software.amazon.awssdk.services.iotsitewise.model.ListDashboardsRequest)operation.
This is a convenience which creates an instance of the
ListDashboardsRequest.Builderavoiding the need to create one manually viaListDashboardsRequest.builder()- Parameters:
listDashboardsRequest- AConsumerthat will call methods onListDashboardsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listGateways
default ListGatewaysResponse listGateways(ListGatewaysRequest listGatewaysRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves a paginated list of gateways.
- Parameters:
listGatewaysRequest-- Returns:
- Result of the ListGateways operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listGateways
default ListGatewaysResponse listGateways(Consumer<ListGatewaysRequest.Builder> listGatewaysRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves a paginated list of gateways.
This is a convenience which creates an instance of the
ListGatewaysRequest.Builderavoiding the need to create one manually viaListGatewaysRequest.builder()- Parameters:
listGatewaysRequest- AConsumerthat will call methods onListGatewaysRequest.Builderto create a request.- Returns:
- Result of the ListGateways operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listGatewaysPaginator
default ListGatewaysIterable listGatewaysPaginator(ListGatewaysRequest listGatewaysRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
This is a variant of
listGateways(software.amazon.awssdk.services.iotsitewise.model.ListGatewaysRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotsitewise.paginators.ListGatewaysIterable responses = client.listGatewaysPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotsitewise.paginators.ListGatewaysIterable responses = client.listGatewaysPaginator(request); for (software.amazon.awssdk.services.iotsitewise.model.ListGatewaysResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotsitewise.paginators.ListGatewaysIterable responses = client.listGatewaysPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGateways(software.amazon.awssdk.services.iotsitewise.model.ListGatewaysRequest)operation.- Parameters:
listGatewaysRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listGatewaysPaginator
default ListGatewaysIterable listGatewaysPaginator(Consumer<ListGatewaysRequest.Builder> listGatewaysRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
This is a variant of
listGateways(software.amazon.awssdk.services.iotsitewise.model.ListGatewaysRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotsitewise.paginators.ListGatewaysIterable responses = client.listGatewaysPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotsitewise.paginators.ListGatewaysIterable responses = client.listGatewaysPaginator(request); for (software.amazon.awssdk.services.iotsitewise.model.ListGatewaysResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotsitewise.paginators.ListGatewaysIterable responses = client.listGatewaysPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGateways(software.amazon.awssdk.services.iotsitewise.model.ListGatewaysRequest)operation.
This is a convenience which creates an instance of the
ListGatewaysRequest.Builderavoiding the need to create one manually viaListGatewaysRequest.builder()- Parameters:
listGatewaysRequest- AConsumerthat will call methods onListGatewaysRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listPortals
default ListPortalsResponse listPortals(ListPortalsRequest listPortalsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves a paginated list of IoT SiteWise Monitor portals.
- Parameters:
listPortalsRequest-- Returns:
- Result of the ListPortals operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listPortals
default ListPortalsResponse listPortals(Consumer<ListPortalsRequest.Builder> listPortalsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves a paginated list of IoT SiteWise Monitor portals.
This is a convenience which creates an instance of the
ListPortalsRequest.Builderavoiding the need to create one manually viaListPortalsRequest.builder()- Parameters:
listPortalsRequest- AConsumerthat will call methods onListPortalsRequest.Builderto create a request.- Returns:
- Result of the ListPortals operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listPortalsPaginator
default ListPortalsIterable listPortalsPaginator(ListPortalsRequest listPortalsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
This is a variant of
listPortals(software.amazon.awssdk.services.iotsitewise.model.ListPortalsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotsitewise.paginators.ListPortalsIterable responses = client.listPortalsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotsitewise.paginators.ListPortalsIterable responses = client.listPortalsPaginator(request); for (software.amazon.awssdk.services.iotsitewise.model.ListPortalsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotsitewise.paginators.ListPortalsIterable responses = client.listPortalsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPortals(software.amazon.awssdk.services.iotsitewise.model.ListPortalsRequest)operation.- Parameters:
listPortalsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listPortalsPaginator
default ListPortalsIterable listPortalsPaginator(Consumer<ListPortalsRequest.Builder> listPortalsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
This is a variant of
listPortals(software.amazon.awssdk.services.iotsitewise.model.ListPortalsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotsitewise.paginators.ListPortalsIterable responses = client.listPortalsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotsitewise.paginators.ListPortalsIterable responses = client.listPortalsPaginator(request); for (software.amazon.awssdk.services.iotsitewise.model.ListPortalsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotsitewise.paginators.ListPortalsIterable responses = client.listPortalsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPortals(software.amazon.awssdk.services.iotsitewise.model.ListPortalsRequest)operation.
This is a convenience which creates an instance of the
ListPortalsRequest.Builderavoiding the need to create one manually viaListPortalsRequest.builder()- Parameters:
listPortalsRequest- AConsumerthat will call methods onListPortalsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listProjectAssets
default ListProjectAssetsResponse listProjectAssets(ListProjectAssetsRequest listProjectAssetsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves a paginated list of assets associated with an IoT SiteWise Monitor project.
- Parameters:
listProjectAssetsRequest-- Returns:
- Result of the ListProjectAssets operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listProjectAssets
default ListProjectAssetsResponse listProjectAssets(Consumer<ListProjectAssetsRequest.Builder> listProjectAssetsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves a paginated list of assets associated with an IoT SiteWise Monitor project.
This is a convenience which creates an instance of the
ListProjectAssetsRequest.Builderavoiding the need to create one manually viaListProjectAssetsRequest.builder()- Parameters:
listProjectAssetsRequest- AConsumerthat will call methods onListProjectAssetsRequest.Builderto create a request.- Returns:
- Result of the ListProjectAssets operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listProjectAssetsPaginator
default ListProjectAssetsIterable listProjectAssetsPaginator(ListProjectAssetsRequest listProjectAssetsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
This is a variant of
listProjectAssets(software.amazon.awssdk.services.iotsitewise.model.ListProjectAssetsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotsitewise.paginators.ListProjectAssetsIterable responses = client.listProjectAssetsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotsitewise.paginators.ListProjectAssetsIterable responses = client .listProjectAssetsPaginator(request); for (software.amazon.awssdk.services.iotsitewise.model.ListProjectAssetsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotsitewise.paginators.ListProjectAssetsIterable responses = client.listProjectAssetsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProjectAssets(software.amazon.awssdk.services.iotsitewise.model.ListProjectAssetsRequest)operation.- Parameters:
listProjectAssetsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listProjectAssetsPaginator
default ListProjectAssetsIterable listProjectAssetsPaginator(Consumer<ListProjectAssetsRequest.Builder> listProjectAssetsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
This is a variant of
listProjectAssets(software.amazon.awssdk.services.iotsitewise.model.ListProjectAssetsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotsitewise.paginators.ListProjectAssetsIterable responses = client.listProjectAssetsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotsitewise.paginators.ListProjectAssetsIterable responses = client .listProjectAssetsPaginator(request); for (software.amazon.awssdk.services.iotsitewise.model.ListProjectAssetsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotsitewise.paginators.ListProjectAssetsIterable responses = client.listProjectAssetsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProjectAssets(software.amazon.awssdk.services.iotsitewise.model.ListProjectAssetsRequest)operation.
This is a convenience which creates an instance of the
ListProjectAssetsRequest.Builderavoiding the need to create one manually viaListProjectAssetsRequest.builder()- Parameters:
listProjectAssetsRequest- AConsumerthat will call methods onListProjectAssetsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listProjects
default ListProjectsResponse listProjects(ListProjectsRequest listProjectsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves a paginated list of projects for an IoT SiteWise Monitor portal.
- Parameters:
listProjectsRequest-- Returns:
- Result of the ListProjects operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listProjects
default ListProjectsResponse listProjects(Consumer<ListProjectsRequest.Builder> listProjectsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves a paginated list of projects for an IoT SiteWise Monitor portal.
This is a convenience which creates an instance of the
ListProjectsRequest.Builderavoiding the need to create one manually viaListProjectsRequest.builder()- Parameters:
listProjectsRequest- AConsumerthat will call methods onListProjectsRequest.Builderto create a request.- Returns:
- Result of the ListProjects operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listProjectsPaginator
default ListProjectsIterable listProjectsPaginator(ListProjectsRequest listProjectsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
This is a variant of
listProjects(software.amazon.awssdk.services.iotsitewise.model.ListProjectsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotsitewise.paginators.ListProjectsIterable responses = client.listProjectsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotsitewise.paginators.ListProjectsIterable responses = client.listProjectsPaginator(request); for (software.amazon.awssdk.services.iotsitewise.model.ListProjectsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotsitewise.paginators.ListProjectsIterable responses = client.listProjectsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProjects(software.amazon.awssdk.services.iotsitewise.model.ListProjectsRequest)operation.- Parameters:
listProjectsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listProjectsPaginator
default ListProjectsIterable listProjectsPaginator(Consumer<ListProjectsRequest.Builder> listProjectsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
This is a variant of
listProjects(software.amazon.awssdk.services.iotsitewise.model.ListProjectsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotsitewise.paginators.ListProjectsIterable responses = client.listProjectsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotsitewise.paginators.ListProjectsIterable responses = client.listProjectsPaginator(request); for (software.amazon.awssdk.services.iotsitewise.model.ListProjectsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotsitewise.paginators.ListProjectsIterable responses = client.listProjectsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProjects(software.amazon.awssdk.services.iotsitewise.model.ListProjectsRequest)operation.
This is a convenience which creates an instance of the
ListProjectsRequest.Builderavoiding the need to create one manually viaListProjectsRequest.builder()- Parameters:
listProjectsRequest- AConsumerthat will call methods onListProjectsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, ResourceNotFoundException, ConflictingOperationException, LimitExceededException, UnauthorizedException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves the list of tags for an IoT SiteWise resource.
- Parameters:
listTagsForResourceRequest-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.InternalFailureException- IoT SiteWise can't process your request right now. Try again later.ThrottlingException- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.For more information, see Quotas in the IoT SiteWise User Guide.
ResourceNotFoundException- The requested resource can't be found.ConflictingOperationException- Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.LimitExceededException- You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.For more information, see Quotas in the IoT SiteWise User Guide.
UnauthorizedException- You are not authorized.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, ResourceNotFoundException, ConflictingOperationException, LimitExceededException, UnauthorizedException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves the list of tags for an IoT SiteWise resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.InternalFailureException- IoT SiteWise can't process your request right now. Try again later.ThrottlingException- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.For more information, see Quotas in the IoT SiteWise User Guide.
ResourceNotFoundException- The requested resource can't be found.ConflictingOperationException- Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.LimitExceededException- You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.For more information, see Quotas in the IoT SiteWise User Guide.
UnauthorizedException- You are not authorized.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTimeSeries
default ListTimeSeriesResponse listTimeSeries(ListTimeSeriesRequest listTimeSeriesRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves a paginated list of time series (data streams).
- Parameters:
listTimeSeriesRequest-- Returns:
- Result of the ListTimeSeries operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
listTimeSeries
default ListTimeSeriesResponse listTimeSeries(Consumer<ListTimeSeriesRequest.Builder> listTimeSeriesRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves a paginated list of time series (data streams).
This is a convenience which creates an instance of the
ListTimeSeriesRequest.Builderavoiding the need to create one manually viaListTimeSeriesRequest.builder()- Parameters:
listTimeSeriesRequest- AConsumerthat will call methods onListTimeSeriesRequest.Builderto create a request.- Returns:
- Result of the ListTimeSeries operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
listTimeSeriesPaginator
default ListTimeSeriesIterable listTimeSeriesPaginator(ListTimeSeriesRequest listTimeSeriesRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
This is a variant of
listTimeSeries(software.amazon.awssdk.services.iotsitewise.model.ListTimeSeriesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotsitewise.paginators.ListTimeSeriesIterable responses = client.listTimeSeriesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotsitewise.paginators.ListTimeSeriesIterable responses = client .listTimeSeriesPaginator(request); for (software.amazon.awssdk.services.iotsitewise.model.ListTimeSeriesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotsitewise.paginators.ListTimeSeriesIterable responses = client.listTimeSeriesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTimeSeries(software.amazon.awssdk.services.iotsitewise.model.ListTimeSeriesRequest)operation.- Parameters:
listTimeSeriesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
listTimeSeriesPaginator
default ListTimeSeriesIterable listTimeSeriesPaginator(Consumer<ListTimeSeriesRequest.Builder> listTimeSeriesRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
This is a variant of
listTimeSeries(software.amazon.awssdk.services.iotsitewise.model.ListTimeSeriesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotsitewise.paginators.ListTimeSeriesIterable responses = client.listTimeSeriesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotsitewise.paginators.ListTimeSeriesIterable responses = client .listTimeSeriesPaginator(request); for (software.amazon.awssdk.services.iotsitewise.model.ListTimeSeriesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotsitewise.paginators.ListTimeSeriesIterable responses = client.listTimeSeriesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTimeSeries(software.amazon.awssdk.services.iotsitewise.model.ListTimeSeriesRequest)operation.
This is a convenience which creates an instance of the
ListTimeSeriesRequest.Builderavoiding the need to create one manually viaListTimeSeriesRequest.builder()- Parameters:
listTimeSeriesRequest- AConsumerthat will call methods onListTimeSeriesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
putDefaultEncryptionConfiguration
default PutDefaultEncryptionConfigurationResponse putDefaultEncryptionConfiguration(PutDefaultEncryptionConfigurationRequest putDefaultEncryptionConfigurationRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, LimitExceededException, ConflictingOperationException, AwsServiceException, SdkClientException, IoTSiteWiseException
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:
- Result of the PutDefaultEncryptionConfiguration operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.InternalFailureException- IoT SiteWise can't process your request right now. Try again later.ThrottlingException- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException- You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.For more information, see Quotas in the IoT SiteWise User Guide.
ConflictingOperationException- Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putDefaultEncryptionConfiguration
default PutDefaultEncryptionConfigurationResponse putDefaultEncryptionConfiguration(Consumer<PutDefaultEncryptionConfigurationRequest.Builder> putDefaultEncryptionConfigurationRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, LimitExceededException, ConflictingOperationException, AwsServiceException, SdkClientException, IoTSiteWiseException
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.Builderavoiding the need to create one manually viaPutDefaultEncryptionConfigurationRequest.builder()- Parameters:
putDefaultEncryptionConfigurationRequest- AConsumerthat will call methods onPutDefaultEncryptionConfigurationRequest.Builderto create a request.- Returns:
- Result of the PutDefaultEncryptionConfiguration operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.InternalFailureException- IoT SiteWise can't process your request right now. Try again later.ThrottlingException- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException- You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.For more information, see Quotas in the IoT SiteWise User Guide.
ConflictingOperationException- Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putLoggingOptions
default PutLoggingOptionsResponse putLoggingOptions(PutLoggingOptionsRequest putLoggingOptionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ConflictingOperationException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTSiteWiseException
Sets logging options for IoT SiteWise.
- Parameters:
putLoggingOptionsRequest-- Returns:
- Result of the PutLoggingOptions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putLoggingOptions
default PutLoggingOptionsResponse putLoggingOptions(Consumer<PutLoggingOptionsRequest.Builder> putLoggingOptionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ConflictingOperationException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTSiteWiseException
Sets logging options for IoT SiteWise.
This is a convenience which creates an instance of the
PutLoggingOptionsRequest.Builderavoiding the need to create one manually viaPutLoggingOptionsRequest.builder()- Parameters:
putLoggingOptionsRequest- AConsumerthat will call methods onPutLoggingOptionsRequest.Builderto create a request.- Returns:
- Result of the PutLoggingOptions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putStorageConfiguration
default PutStorageConfigurationResponse putStorageConfiguration(PutStorageConfigurationRequest putStorageConfigurationRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ResourceNotFoundException, InternalFailureException, ThrottlingException, LimitExceededException, ConflictingOperationException, AwsServiceException, SdkClientException, IoTSiteWiseException
Configures storage settings for IoT SiteWise.
- Parameters:
putStorageConfigurationRequest-- Returns:
- Result of the PutStorageConfiguration operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.ResourceAlreadyExistsException- The resource already exists.ResourceNotFoundException- The requested resource can't be found.InternalFailureException- IoT SiteWise can't process your request right now. Try again later.ThrottlingException- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException- You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.For more information, see Quotas in the IoT SiteWise User Guide.
ConflictingOperationException- Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putStorageConfiguration
default PutStorageConfigurationResponse putStorageConfiguration(Consumer<PutStorageConfigurationRequest.Builder> putStorageConfigurationRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ResourceNotFoundException, InternalFailureException, ThrottlingException, LimitExceededException, ConflictingOperationException, AwsServiceException, SdkClientException, IoTSiteWiseException
Configures storage settings for IoT SiteWise.
This is a convenience which creates an instance of the
PutStorageConfigurationRequest.Builderavoiding the need to create one manually viaPutStorageConfigurationRequest.builder()- Parameters:
putStorageConfigurationRequest- AConsumerthat will call methods onPutStorageConfigurationRequest.Builderto create a request.- Returns:
- Result of the PutStorageConfiguration operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.ResourceAlreadyExistsException- The resource already exists.ResourceNotFoundException- The requested resource can't be found.InternalFailureException- IoT SiteWise can't process your request right now. Try again later.ThrottlingException- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException- You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.For more information, see Quotas in the IoT SiteWise User Guide.
ConflictingOperationException- Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, ResourceNotFoundException, ConflictingOperationException, LimitExceededException, UnauthorizedException, TooManyTagsException, AwsServiceException, SdkClientException, IoTSiteWiseException
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:
- Result of the TagResource operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.InternalFailureException- IoT SiteWise can't process your request right now. Try again later.ThrottlingException- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.For more information, see Quotas in the IoT SiteWise User Guide.
ResourceNotFoundException- The requested resource can't be found.ConflictingOperationException- Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.LimitExceededException- You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.For more information, see Quotas in the IoT SiteWise User Guide.
UnauthorizedException- You are not authorized.TooManyTagsException- You've reached the limit for the number of tags allowed for a resource. For more information, see Tag naming limits and requirements in the Amazon Web Services General Reference.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, ResourceNotFoundException, ConflictingOperationException, LimitExceededException, UnauthorizedException, TooManyTagsException, AwsServiceException, SdkClientException, IoTSiteWiseException
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.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.InternalFailureException- IoT SiteWise can't process your request right now. Try again later.ThrottlingException- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.For more information, see Quotas in the IoT SiteWise User Guide.
ResourceNotFoundException- The requested resource can't be found.ConflictingOperationException- Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.LimitExceededException- You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.For more information, see Quotas in the IoT SiteWise User Guide.
UnauthorizedException- You are not authorized.TooManyTagsException- You've reached the limit for the number of tags allowed for a resource. For more information, see Tag naming limits and requirements in the Amazon Web Services General Reference.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, ResourceNotFoundException, ConflictingOperationException, LimitExceededException, UnauthorizedException, AwsServiceException, SdkClientException, IoTSiteWiseException
Removes a tag from an IoT SiteWise resource.
- Parameters:
untagResourceRequest-- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.InternalFailureException- IoT SiteWise can't process your request right now. Try again later.ThrottlingException- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.For more information, see Quotas in the IoT SiteWise User Guide.
ResourceNotFoundException- The requested resource can't be found.ConflictingOperationException- Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.LimitExceededException- You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.For more information, see Quotas in the IoT SiteWise User Guide.
UnauthorizedException- You are not authorized.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, ResourceNotFoundException, ConflictingOperationException, LimitExceededException, UnauthorizedException, AwsServiceException, SdkClientException, IoTSiteWiseException
Removes a tag from an IoT SiteWise resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.InternalFailureException- IoT SiteWise can't process your request right now. Try again later.ThrottlingException- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.For more information, see Quotas in the IoT SiteWise User Guide.
ResourceNotFoundException- The requested resource can't be found.ConflictingOperationException- Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.LimitExceededException- You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.For more information, see Quotas in the IoT SiteWise User Guide.
UnauthorizedException- You are not authorized.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateAccessPolicy
default UpdateAccessPolicyResponse updateAccessPolicy(UpdateAccessPolicyRequest updateAccessPolicyRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Updates an existing access policy that specifies an identity's access to an IoT SiteWise Monitor portal or project resource.
- Parameters:
updateAccessPolicyRequest-- Returns:
- Result of the UpdateAccessPolicy operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateAccessPolicy
default UpdateAccessPolicyResponse updateAccessPolicy(Consumer<UpdateAccessPolicyRequest.Builder> updateAccessPolicyRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
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.Builderavoiding the need to create one manually viaUpdateAccessPolicyRequest.builder()- Parameters:
updateAccessPolicyRequest- AConsumerthat will call methods onUpdateAccessPolicyRequest.Builderto create a request.- Returns:
- Result of the UpdateAccessPolicy operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateAsset
default UpdateAssetResponse updateAsset(UpdateAssetRequest updateAssetRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ResourceNotFoundException, InternalFailureException, ThrottlingException, ConflictingOperationException, AwsServiceException, SdkClientException, IoTSiteWiseException
Updates an asset's name. For more information, see Updating assets and models in the IoT SiteWise User Guide.
- Parameters:
updateAssetRequest-- Returns:
- Result of the UpdateAsset operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateAsset
default UpdateAssetResponse updateAsset(Consumer<UpdateAssetRequest.Builder> updateAssetRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ResourceNotFoundException, InternalFailureException, ThrottlingException, ConflictingOperationException, AwsServiceException, SdkClientException, IoTSiteWiseException
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.Builderavoiding the need to create one manually viaUpdateAssetRequest.builder()- Parameters:
updateAssetRequest- AConsumerthat will call methods onUpdateAssetRequest.Builderto create a request.- Returns:
- Result of the UpdateAsset operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateAssetModel
default UpdateAssetModelResponse updateAssetModel(UpdateAssetModelRequest updateAssetModelRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ResourceNotFoundException, InternalFailureException, LimitExceededException, ThrottlingException, ConflictingOperationException, AwsServiceException, SdkClientException, IoTSiteWiseException
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:-
Submit an
UpdateAssetModelrequest with the entire existing property removed. -
Submit a second
UpdateAssetModelrequest that includes the new property. The new asset property will have the samenameas the previous one and IoT SiteWise will generate a new uniqueid.
- Parameters:
updateAssetModelRequest-- Returns:
- Result of the UpdateAssetModel operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.ResourceAlreadyExistsException- The resource already exists.ResourceNotFoundException- The requested resource can't be found.InternalFailureException- IoT SiteWise can't process your request right now. Try again later.LimitExceededException- You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.For more information, see Quotas in the IoT SiteWise User Guide.
ThrottlingException- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.For more information, see Quotas in the IoT SiteWise User Guide.
ConflictingOperationException- Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
updateAssetModel
default UpdateAssetModelResponse updateAssetModel(Consumer<UpdateAssetModelRequest.Builder> updateAssetModelRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ResourceNotFoundException, InternalFailureException, LimitExceededException, ThrottlingException, ConflictingOperationException, AwsServiceException, SdkClientException, IoTSiteWiseException
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:-
Submit an
UpdateAssetModelrequest with the entire existing property removed. -
Submit a second
UpdateAssetModelrequest that includes the new property. The new asset property will have the samenameas the previous one and IoT SiteWise will generate a new uniqueid.
This is a convenience which creates an instance of the
UpdateAssetModelRequest.Builderavoiding the need to create one manually viaUpdateAssetModelRequest.builder()- Parameters:
updateAssetModelRequest- AConsumerthat will call methods onUpdateAssetModelRequest.Builderto create a request.- Returns:
- Result of the UpdateAssetModel operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.ResourceAlreadyExistsException- The resource already exists.ResourceNotFoundException- The requested resource can't be found.InternalFailureException- IoT SiteWise can't process your request right now. Try again later.LimitExceededException- You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.For more information, see Quotas in the IoT SiteWise User Guide.
ThrottlingException- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.For more information, see Quotas in the IoT SiteWise User Guide.
ConflictingOperationException- Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
updateAssetModelCompositeModel
default UpdateAssetModelCompositeModelResponse updateAssetModelCompositeModel(UpdateAssetModelCompositeModelRequest updateAssetModelCompositeModelRequest) throws ConflictingOperationException, InternalFailureException, InvalidRequestException, ResourceAlreadyExistsException, ResourceNotFoundException, ThrottlingException, LimitExceededException, AwsServiceException, SdkClientException, IoTSiteWiseException
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:-
Submit an
UpdateAssetModelCompositeModelrequest with the entire existing property removed. -
Submit a second
UpdateAssetModelCompositeModelrequest that includes the new property. The new asset property will have the samenameas the previous one and IoT SiteWise will generate a new uniqueid.
- Parameters:
updateAssetModelCompositeModelRequest-- Returns:
- Result of the UpdateAssetModelCompositeModel operation returned by the service.
- Throws:
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.InvalidRequestException- The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.ResourceAlreadyExistsException- The resource already exists.ResourceNotFoundException- The requested resource can't be found.ThrottlingException- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException- You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.For more information, see Quotas in the IoT SiteWise User Guide.
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
updateAssetModelCompositeModel
default UpdateAssetModelCompositeModelResponse updateAssetModelCompositeModel(Consumer<UpdateAssetModelCompositeModelRequest.Builder> updateAssetModelCompositeModelRequest) throws ConflictingOperationException, InternalFailureException, InvalidRequestException, ResourceAlreadyExistsException, ResourceNotFoundException, ThrottlingException, LimitExceededException, AwsServiceException, SdkClientException, IoTSiteWiseException
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:-
Submit an
UpdateAssetModelCompositeModelrequest with the entire existing property removed. -
Submit a second
UpdateAssetModelCompositeModelrequest that includes the new property. The new asset property will have the samenameas the previous one and IoT SiteWise will generate a new uniqueid.
This is a convenience which creates an instance of the
UpdateAssetModelCompositeModelRequest.Builderavoiding the need to create one manually viaUpdateAssetModelCompositeModelRequest.builder()- Parameters:
updateAssetModelCompositeModelRequest- AConsumerthat will call methods onUpdateAssetModelCompositeModelRequest.Builderto create a request.- Returns:
- Result of the UpdateAssetModelCompositeModel operation returned by the service.
- Throws:
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.InvalidRequestException- The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.ResourceAlreadyExistsException- The resource already exists.ResourceNotFoundException- The requested resource can't be found.ThrottlingException- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException- You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.For more information, see Quotas in the IoT SiteWise User Guide.
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
updateAssetProperty
default UpdateAssetPropertyResponse updateAssetProperty(UpdateAssetPropertyRequest updateAssetPropertyRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, ConflictingOperationException, AwsServiceException, SdkClientException, IoTSiteWiseException
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:
- Result of the UpdateAssetProperty operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateAssetProperty
default UpdateAssetPropertyResponse updateAssetProperty(Consumer<UpdateAssetPropertyRequest.Builder> updateAssetPropertyRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, ConflictingOperationException, AwsServiceException, SdkClientException, IoTSiteWiseException
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.Builderavoiding the need to create one manually viaUpdateAssetPropertyRequest.builder()- Parameters:
updateAssetPropertyRequest- AConsumerthat will call methods onUpdateAssetPropertyRequest.Builderto create a request.- Returns:
- Result of the UpdateAssetProperty operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateDashboard
default UpdateDashboardResponse updateDashboard(UpdateDashboardRequest updateDashboardRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Updates an IoT SiteWise Monitor dashboard.
- Parameters:
updateDashboardRequest-- Returns:
- Result of the UpdateDashboard operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateDashboard
default UpdateDashboardResponse updateDashboard(Consumer<UpdateDashboardRequest.Builder> updateDashboardRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Updates an IoT SiteWise Monitor dashboard.
This is a convenience which creates an instance of the
UpdateDashboardRequest.Builderavoiding the need to create one manually viaUpdateDashboardRequest.builder()- Parameters:
updateDashboardRequest- AConsumerthat will call methods onUpdateDashboardRequest.Builderto create a request.- Returns:
- Result of the UpdateDashboard operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateGateway
default UpdateGatewayResponse updateGateway(UpdateGatewayRequest updateGatewayRequest) throws InvalidRequestException, ResourceNotFoundException, ConflictingOperationException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Updates a gateway's name.
- Parameters:
updateGatewayRequest-- Returns:
- Result of the UpdateGateway operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateGateway
default UpdateGatewayResponse updateGateway(Consumer<UpdateGatewayRequest.Builder> updateGatewayRequest) throws InvalidRequestException, ResourceNotFoundException, ConflictingOperationException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Updates a gateway's name.
This is a convenience which creates an instance of the
UpdateGatewayRequest.Builderavoiding the need to create one manually viaUpdateGatewayRequest.builder()- Parameters:
updateGatewayRequest- AConsumerthat will call methods onUpdateGatewayRequest.Builderto create a request.- Returns:
- Result of the UpdateGateway operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateGatewayCapabilityConfiguration
default UpdateGatewayCapabilityConfigurationResponse updateGatewayCapabilityConfiguration(UpdateGatewayCapabilityConfigurationRequest updateGatewayCapabilityConfigurationRequest) throws InvalidRequestException, ResourceNotFoundException, ConflictingOperationException, InternalFailureException, ThrottlingException, LimitExceededException, AwsServiceException, SdkClientException, IoTSiteWiseException
Updates a gateway capability configuration or defines a new capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway.
- Parameters:
updateGatewayCapabilityConfigurationRequest-- Returns:
- Result of the UpdateGatewayCapabilityConfiguration operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.ResourceNotFoundException- The requested resource can't be found.ConflictingOperationException- Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.InternalFailureException- IoT SiteWise can't process your request right now. Try again later.ThrottlingException- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException- You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.For more information, see Quotas in the IoT SiteWise User Guide.
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateGatewayCapabilityConfiguration
default UpdateGatewayCapabilityConfigurationResponse updateGatewayCapabilityConfiguration(Consumer<UpdateGatewayCapabilityConfigurationRequest.Builder> updateGatewayCapabilityConfigurationRequest) throws InvalidRequestException, ResourceNotFoundException, ConflictingOperationException, InternalFailureException, ThrottlingException, LimitExceededException, AwsServiceException, SdkClientException, IoTSiteWiseException
Updates a gateway capability configuration or defines a new capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway.
This is a convenience which creates an instance of the
UpdateGatewayCapabilityConfigurationRequest.Builderavoiding the need to create one manually viaUpdateGatewayCapabilityConfigurationRequest.builder()- Parameters:
updateGatewayCapabilityConfigurationRequest- AConsumerthat will call methods onUpdateGatewayCapabilityConfigurationRequest.Builderto create a request.- Returns:
- Result of the UpdateGatewayCapabilityConfiguration operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.ResourceNotFoundException- The requested resource can't be found.ConflictingOperationException- Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.InternalFailureException- IoT SiteWise can't process your request right now. Try again later.ThrottlingException- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException- You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.For more information, see Quotas in the IoT SiteWise User Guide.
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updatePortal
default UpdatePortalResponse updatePortal(UpdatePortalRequest updatePortalRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, ConflictingOperationException, AwsServiceException, SdkClientException, IoTSiteWiseException
Updates an IoT SiteWise Monitor portal.
- Parameters:
updatePortalRequest-- Returns:
- Result of the UpdatePortal operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
updatePortal
default UpdatePortalResponse updatePortal(Consumer<UpdatePortalRequest.Builder> updatePortalRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, ConflictingOperationException, AwsServiceException, SdkClientException, IoTSiteWiseException
Updates an IoT SiteWise Monitor portal.
This is a convenience which creates an instance of the
UpdatePortalRequest.Builderavoiding the need to create one manually viaUpdatePortalRequest.builder()- Parameters:
updatePortalRequest- AConsumerthat will call methods onUpdatePortalRequest.Builderto create a request.- Returns:
- Result of the UpdatePortal operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateProject
default UpdateProjectResponse updateProject(UpdateProjectRequest updateProjectRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Updates an IoT SiteWise Monitor project.
- Parameters:
updateProjectRequest-- Returns:
- Result of the UpdateProject operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateProject
default UpdateProjectResponse updateProject(Consumer<UpdateProjectRequest.Builder> updateProjectRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Updates an IoT SiteWise Monitor project.
This is a convenience which creates an instance of the
UpdateProjectRequest.Builderavoiding the need to create one manually viaUpdateProjectRequest.builder()- Parameters:
updateProjectRequest- AConsumerthat will call methods onUpdateProjectRequest.Builderto create a request.- Returns:
- Result of the UpdateProject operation returned by the service.
- Throws:
InvalidRequestException- The request isn't valid. This can 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.AwsServiceException- See Also:
- AWS API Documentation
-
waiter
default IoTSiteWiseWaiter waiter()
Create an instance ofIoTSiteWiseWaiterusing 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
IoTSiteWiseWaiter
-
create
static IoTSiteWiseClient create()
Create aIoTSiteWiseClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static IoTSiteWiseClientBuilder builder()
Create a builder that can be used to configure and create aIoTSiteWiseClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default IoTSiteWiseServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-