@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface IoTSiteWiseClient extends SdkClient
builder() method.
Welcome to the AWS IoT SiteWise API Reference. AWS IoT SiteWise is an AWS service that connects Industrial Internet of Things (IIoT) devices to the power of the AWS Cloud. For more information, see the AWS IoT SiteWise User Guide. For information about AWS IoT SiteWise quotas, see Quotas in the AWS IoT SiteWise User Guide.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default AssociateAssetsResponse |
associateAssets(AssociateAssetsRequest associateAssetsRequest)
Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's model.
|
default AssociateAssetsResponse |
associateAssets(Consumer<AssociateAssetsRequest.Builder> associateAssetsRequest)
Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's model.
|
default BatchAssociateProjectAssetsResponse |
batchAssociateProjectAssets(BatchAssociateProjectAssetsRequest batchAssociateProjectAssetsRequest)
Associates a group (batch) of assets with an AWS IoT SiteWise Monitor project.
|
default BatchAssociateProjectAssetsResponse |
batchAssociateProjectAssets(Consumer<BatchAssociateProjectAssetsRequest.Builder> batchAssociateProjectAssetsRequest)
Associates a group (batch) of assets with an AWS IoT SiteWise Monitor project.
|
default BatchDisassociateProjectAssetsResponse |
batchDisassociateProjectAssets(BatchDisassociateProjectAssetsRequest batchDisassociateProjectAssetsRequest)
Disassociates a group (batch) of assets from an AWS IoT SiteWise Monitor project.
|
default BatchDisassociateProjectAssetsResponse |
batchDisassociateProjectAssets(Consumer<BatchDisassociateProjectAssetsRequest.Builder> batchDisassociateProjectAssetsRequest)
Disassociates a group (batch) of assets from an AWS IoT SiteWise Monitor project.
|
default BatchPutAssetPropertyValueResponse |
batchPutAssetPropertyValue(BatchPutAssetPropertyValueRequest batchPutAssetPropertyValueRequest)
Sends a list of asset property values to AWS IoT SiteWise.
|
default BatchPutAssetPropertyValueResponse |
batchPutAssetPropertyValue(Consumer<BatchPutAssetPropertyValueRequest.Builder> batchPutAssetPropertyValueRequest)
Sends a list of asset property values to AWS IoT SiteWise.
|
static IoTSiteWiseClientBuilder |
builder()
Create a builder that can be used to configure and create a
IoTSiteWiseClient. |
static IoTSiteWiseClient |
create()
Create a
IoTSiteWiseClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateAccessPolicyResponse |
createAccessPolicy(Consumer<CreateAccessPolicyRequest.Builder> createAccessPolicyRequest)
Creates an access policy that grants the specified identity (AWS SSO user, AWS SSO group, or IAM user) access to
the specified AWS IoT SiteWise Monitor portal or project resource.
|
default CreateAccessPolicyResponse |
createAccessPolicy(CreateAccessPolicyRequest createAccessPolicyRequest)
Creates an access policy that grants the specified identity (AWS SSO user, AWS SSO group, or IAM user) access to
the specified AWS IoT SiteWise Monitor portal or project resource.
|
default CreateAssetResponse |
createAsset(Consumer<CreateAssetRequest.Builder> createAssetRequest)
Creates an asset from an existing asset model.
|
default CreateAssetResponse |
createAsset(CreateAssetRequest createAssetRequest)
Creates an asset from an existing asset model.
|
default CreateAssetModelResponse |
createAssetModel(Consumer<CreateAssetModelRequest.Builder> createAssetModelRequest)
Creates an asset model from specified property and hierarchy definitions.
|
default CreateAssetModelResponse |
createAssetModel(CreateAssetModelRequest createAssetModelRequest)
Creates an asset model from specified property and hierarchy definitions.
|
default CreateDashboardResponse |
createDashboard(Consumer<CreateDashboardRequest.Builder> createDashboardRequest)
Creates a dashboard in an AWS IoT SiteWise Monitor project.
|
default CreateDashboardResponse |
createDashboard(CreateDashboardRequest createDashboardRequest)
Creates a dashboard in an AWS IoT SiteWise Monitor project.
|
default CreateGatewayResponse |
createGateway(Consumer<CreateGatewayRequest.Builder> createGatewayRequest)
Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to
AWS IoT SiteWise.
|
default CreateGatewayResponse |
createGateway(CreateGatewayRequest createGatewayRequest)
Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to
AWS IoT SiteWise.
|
default CreatePortalResponse |
createPortal(Consumer<CreatePortalRequest.Builder> createPortalRequest)
Creates a portal, which can contain projects and dashboards.
|
default CreatePortalResponse |
createPortal(CreatePortalRequest createPortalRequest)
Creates a portal, which can contain projects and dashboards.
|
default CreateProjectResponse |
createProject(Consumer<CreateProjectRequest.Builder> createProjectRequest)
Creates a project in the specified portal.
|
default CreateProjectResponse |
createProject(CreateProjectRequest createProjectRequest)
Creates a project in the specified portal.
|
default DeleteAccessPolicyResponse |
deleteAccessPolicy(Consumer<DeleteAccessPolicyRequest.Builder> deleteAccessPolicyRequest)
Deletes an access policy that grants the specified identity access to the specified AWS IoT SiteWise Monitor
resource.
|
default DeleteAccessPolicyResponse |
deleteAccessPolicy(DeleteAccessPolicyRequest deleteAccessPolicyRequest)
Deletes an access policy that grants the specified identity access to the specified AWS IoT SiteWise Monitor
resource.
|
default DeleteAssetResponse |
deleteAsset(Consumer<DeleteAssetRequest.Builder> deleteAssetRequest)
Deletes an asset.
|
default DeleteAssetResponse |
deleteAsset(DeleteAssetRequest deleteAssetRequest)
Deletes an asset.
|
default DeleteAssetModelResponse |
deleteAssetModel(Consumer<DeleteAssetModelRequest.Builder> deleteAssetModelRequest)
Deletes an asset model.
|
default DeleteAssetModelResponse |
deleteAssetModel(DeleteAssetModelRequest deleteAssetModelRequest)
Deletes an asset model.
|
default DeleteDashboardResponse |
deleteDashboard(Consumer<DeleteDashboardRequest.Builder> deleteDashboardRequest)
Deletes a dashboard from AWS IoT SiteWise Monitor.
|
default DeleteDashboardResponse |
deleteDashboard(DeleteDashboardRequest deleteDashboardRequest)
Deletes a dashboard from AWS IoT SiteWise Monitor.
|
default DeleteGatewayResponse |
deleteGateway(Consumer<DeleteGatewayRequest.Builder> deleteGatewayRequest)
Deletes a gateway from AWS IoT SiteWise.
|
default DeleteGatewayResponse |
deleteGateway(DeleteGatewayRequest deleteGatewayRequest)
Deletes a gateway from AWS IoT SiteWise.
|
default DeletePortalResponse |
deletePortal(Consumer<DeletePortalRequest.Builder> deletePortalRequest)
Deletes a portal from AWS IoT SiteWise Monitor.
|
default DeletePortalResponse |
deletePortal(DeletePortalRequest deletePortalRequest)
Deletes a portal from AWS IoT SiteWise Monitor.
|
default DeleteProjectResponse |
deleteProject(Consumer<DeleteProjectRequest.Builder> deleteProjectRequest)
Deletes a project from AWS IoT SiteWise Monitor.
|
default DeleteProjectResponse |
deleteProject(DeleteProjectRequest deleteProjectRequest)
Deletes a project from AWS IoT SiteWise Monitor.
|
default DescribeAccessPolicyResponse |
describeAccessPolicy(Consumer<DescribeAccessPolicyRequest.Builder> describeAccessPolicyRequest)
Describes an access policy, which specifies an identity's access to an AWS IoT SiteWise Monitor portal or
project.
|
default DescribeAccessPolicyResponse |
describeAccessPolicy(DescribeAccessPolicyRequest describeAccessPolicyRequest)
Describes an access policy, which specifies an identity's access to an AWS IoT SiteWise Monitor portal or
project.
|
default DescribeAssetResponse |
describeAsset(Consumer<DescribeAssetRequest.Builder> describeAssetRequest)
Retrieves information about an asset.
|
default DescribeAssetResponse |
describeAsset(DescribeAssetRequest describeAssetRequest)
Retrieves information about an asset.
|
default DescribeAssetModelResponse |
describeAssetModel(Consumer<DescribeAssetModelRequest.Builder> describeAssetModelRequest)
Retrieves information about an asset model.
|
default DescribeAssetModelResponse |
describeAssetModel(DescribeAssetModelRequest describeAssetModelRequest)
Retrieves information about an asset model.
|
default DescribeAssetPropertyResponse |
describeAssetProperty(Consumer<DescribeAssetPropertyRequest.Builder> describeAssetPropertyRequest)
Retrieves information about an asset property.
|
default DescribeAssetPropertyResponse |
describeAssetProperty(DescribeAssetPropertyRequest describeAssetPropertyRequest)
Retrieves information about an asset property.
|
default DescribeDashboardResponse |
describeDashboard(Consumer<DescribeDashboardRequest.Builder> describeDashboardRequest)
Retrieves information about a dashboard.
|
default DescribeDashboardResponse |
describeDashboard(DescribeDashboardRequest describeDashboardRequest)
Retrieves information about a dashboard.
|
default DescribeDefaultEncryptionConfigurationResponse |
describeDefaultEncryptionConfiguration(Consumer<DescribeDefaultEncryptionConfigurationRequest.Builder> describeDefaultEncryptionConfigurationRequest)
Retrieves information about the default encryption configuration for the AWS account in the default or specified
region.
|
default DescribeDefaultEncryptionConfigurationResponse |
describeDefaultEncryptionConfiguration(DescribeDefaultEncryptionConfigurationRequest describeDefaultEncryptionConfigurationRequest)
Retrieves information about the default encryption configuration for the AWS account in the default or specified
region.
|
default DescribeGatewayResponse |
describeGateway(Consumer<DescribeGatewayRequest.Builder> describeGatewayRequest)
Retrieves information about a gateway.
|
default DescribeGatewayResponse |
describeGateway(DescribeGatewayRequest describeGatewayRequest)
Retrieves information about a gateway.
|
default DescribeGatewayCapabilityConfigurationResponse |
describeGatewayCapabilityConfiguration(Consumer<DescribeGatewayCapabilityConfigurationRequest.Builder> describeGatewayCapabilityConfigurationRequest)
Retrieves information about a gateway capability configuration.
|
default DescribeGatewayCapabilityConfigurationResponse |
describeGatewayCapabilityConfiguration(DescribeGatewayCapabilityConfigurationRequest describeGatewayCapabilityConfigurationRequest)
Retrieves information about a gateway capability configuration.
|
default DescribeLoggingOptionsResponse |
describeLoggingOptions(Consumer<DescribeLoggingOptionsRequest.Builder> describeLoggingOptionsRequest)
Retrieves the current AWS IoT SiteWise logging options.
|
default DescribeLoggingOptionsResponse |
describeLoggingOptions(DescribeLoggingOptionsRequest describeLoggingOptionsRequest)
Retrieves the current AWS IoT SiteWise logging options.
|
default DescribePortalResponse |
describePortal(Consumer<DescribePortalRequest.Builder> describePortalRequest)
Retrieves information about a portal.
|
default DescribePortalResponse |
describePortal(DescribePortalRequest describePortalRequest)
Retrieves information about a portal.
|
default DescribeProjectResponse |
describeProject(Consumer<DescribeProjectRequest.Builder> describeProjectRequest)
Retrieves information about a project.
|
default DescribeProjectResponse |
describeProject(DescribeProjectRequest describeProjectRequest)
Retrieves information about a project.
|
default DisassociateAssetsResponse |
disassociateAssets(Consumer<DisassociateAssetsRequest.Builder> disassociateAssetsRequest)
Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model.
|
default DisassociateAssetsResponse |
disassociateAssets(DisassociateAssetsRequest disassociateAssetsRequest)
Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model.
|
default GetAssetPropertyAggregatesResponse |
getAssetPropertyAggregates(Consumer<GetAssetPropertyAggregatesRequest.Builder> getAssetPropertyAggregatesRequest)
Gets aggregated values for an asset property.
|
default GetAssetPropertyAggregatesResponse |
getAssetPropertyAggregates(GetAssetPropertyAggregatesRequest getAssetPropertyAggregatesRequest)
Gets aggregated values for an asset property.
|
default GetAssetPropertyAggregatesIterable |
getAssetPropertyAggregatesPaginator(Consumer<GetAssetPropertyAggregatesRequest.Builder> getAssetPropertyAggregatesRequest)
Gets aggregated values for an asset property.
|
default GetAssetPropertyAggregatesIterable |
getAssetPropertyAggregatesPaginator(GetAssetPropertyAggregatesRequest getAssetPropertyAggregatesRequest)
Gets aggregated values for an asset property.
|
default GetAssetPropertyValueResponse |
getAssetPropertyValue(Consumer<GetAssetPropertyValueRequest.Builder> getAssetPropertyValueRequest)
Gets an asset property's current value.
|
default GetAssetPropertyValueResponse |
getAssetPropertyValue(GetAssetPropertyValueRequest getAssetPropertyValueRequest)
Gets an asset property's current value.
|
default GetAssetPropertyValueHistoryResponse |
getAssetPropertyValueHistory(Consumer<GetAssetPropertyValueHistoryRequest.Builder> getAssetPropertyValueHistoryRequest)
Gets the history of an asset property's values.
|
default GetAssetPropertyValueHistoryResponse |
getAssetPropertyValueHistory(GetAssetPropertyValueHistoryRequest getAssetPropertyValueHistoryRequest)
Gets the history of an asset property's values.
|
default GetAssetPropertyValueHistoryIterable |
getAssetPropertyValueHistoryPaginator(Consumer<GetAssetPropertyValueHistoryRequest.Builder> getAssetPropertyValueHistoryRequest)
Gets the history of an asset property's values.
|
default GetAssetPropertyValueHistoryIterable |
getAssetPropertyValueHistoryPaginator(GetAssetPropertyValueHistoryRequest getAssetPropertyValueHistoryRequest)
Gets the history of an asset property's values.
|
default GetInterpolatedAssetPropertyValuesResponse |
getInterpolatedAssetPropertyValues(Consumer<GetInterpolatedAssetPropertyValuesRequest.Builder> getInterpolatedAssetPropertyValuesRequest)
Get interpolated values for an asset property for a specified time interval, during a period of time.
|
default GetInterpolatedAssetPropertyValuesResponse |
getInterpolatedAssetPropertyValues(GetInterpolatedAssetPropertyValuesRequest getInterpolatedAssetPropertyValuesRequest)
Get interpolated values for an asset property for a specified time interval, during a period of time.
|
default GetInterpolatedAssetPropertyValuesIterable |
getInterpolatedAssetPropertyValuesPaginator(Consumer<GetInterpolatedAssetPropertyValuesRequest.Builder> getInterpolatedAssetPropertyValuesRequest)
Get interpolated values for an asset property for a specified time interval, during a period of time.
|
default GetInterpolatedAssetPropertyValuesIterable |
getInterpolatedAssetPropertyValuesPaginator(GetInterpolatedAssetPropertyValuesRequest getInterpolatedAssetPropertyValuesRequest)
Get interpolated values for an asset property for a specified time interval, during a period of time.
|
default ListAccessPoliciesResponse |
listAccessPolicies(Consumer<ListAccessPoliciesRequest.Builder> listAccessPoliciesRequest)
Retrieves a paginated list of access policies for an identity (an AWS SSO user, an AWS SSO group, or an IAM user)
or an AWS IoT SiteWise Monitor resource (a portal or project).
|
default ListAccessPoliciesResponse |
listAccessPolicies(ListAccessPoliciesRequest listAccessPoliciesRequest)
Retrieves a paginated list of access policies for an identity (an AWS SSO user, an AWS SSO group, or an IAM user)
or an AWS IoT SiteWise Monitor resource (a portal or project).
|
default ListAccessPoliciesIterable |
listAccessPoliciesPaginator(Consumer<ListAccessPoliciesRequest.Builder> listAccessPoliciesRequest)
Retrieves a paginated list of access policies for an identity (an AWS SSO user, an AWS SSO group, or an IAM user)
or an AWS IoT SiteWise Monitor resource (a portal or project).
|
default ListAccessPoliciesIterable |
listAccessPoliciesPaginator(ListAccessPoliciesRequest listAccessPoliciesRequest)
Retrieves a paginated list of access policies for an identity (an AWS SSO user, an AWS SSO group, or an IAM user)
or an AWS IoT SiteWise Monitor resource (a portal or project).
|
default ListAssetModelsResponse |
listAssetModels(Consumer<ListAssetModelsRequest.Builder> listAssetModelsRequest)
Retrieves a paginated list of summaries of all asset models.
|
default ListAssetModelsResponse |
listAssetModels(ListAssetModelsRequest listAssetModelsRequest)
Retrieves a paginated list of summaries of all asset models.
|
default ListAssetModelsIterable |
listAssetModelsPaginator(Consumer<ListAssetModelsRequest.Builder> listAssetModelsRequest)
Retrieves a paginated list of summaries of all asset models.
|
default ListAssetModelsIterable |
listAssetModelsPaginator(ListAssetModelsRequest listAssetModelsRequest)
Retrieves a paginated list of summaries of all asset models.
|
default ListAssetRelationshipsResponse |
listAssetRelationships(Consumer<ListAssetRelationshipsRequest.Builder> listAssetRelationshipsRequest)
Retrieves a paginated list of asset relationships for an asset.
|
default ListAssetRelationshipsResponse |
listAssetRelationships(ListAssetRelationshipsRequest listAssetRelationshipsRequest)
Retrieves a paginated list of asset relationships for an asset.
|
default ListAssetRelationshipsIterable |
listAssetRelationshipsPaginator(Consumer<ListAssetRelationshipsRequest.Builder> listAssetRelationshipsRequest)
Retrieves a paginated list of asset relationships for an asset.
|
default ListAssetRelationshipsIterable |
listAssetRelationshipsPaginator(ListAssetRelationshipsRequest listAssetRelationshipsRequest)
Retrieves a paginated list of asset relationships for an asset.
|
default ListAssetsResponse |
listAssets(Consumer<ListAssetsRequest.Builder> listAssetsRequest)
Retrieves a paginated list of asset summaries.
|
default ListAssetsResponse |
listAssets(ListAssetsRequest listAssetsRequest)
Retrieves a paginated list of asset summaries.
|
default ListAssetsIterable |
listAssetsPaginator(Consumer<ListAssetsRequest.Builder> listAssetsRequest)
Retrieves a paginated list of asset summaries.
|
default ListAssetsIterable |
listAssetsPaginator(ListAssetsRequest listAssetsRequest)
Retrieves a paginated list of asset summaries.
|
default ListAssociatedAssetsResponse |
listAssociatedAssets(Consumer<ListAssociatedAssetsRequest.Builder> listAssociatedAssetsRequest)
Retrieves a paginated list of associated assets.
|
default ListAssociatedAssetsResponse |
listAssociatedAssets(ListAssociatedAssetsRequest listAssociatedAssetsRequest)
Retrieves a paginated list of associated assets.
|
default ListAssociatedAssetsIterable |
listAssociatedAssetsPaginator(Consumer<ListAssociatedAssetsRequest.Builder> listAssociatedAssetsRequest)
Retrieves a paginated list of associated assets.
|
default ListAssociatedAssetsIterable |
listAssociatedAssetsPaginator(ListAssociatedAssetsRequest listAssociatedAssetsRequest)
Retrieves a paginated list of associated assets.
|
default ListDashboardsResponse |
listDashboards(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest)
Retrieves a paginated list of dashboards for an AWS IoT SiteWise Monitor project.
|
default ListDashboardsResponse |
listDashboards(ListDashboardsRequest listDashboardsRequest)
Retrieves a paginated list of dashboards for an AWS IoT SiteWise Monitor project.
|
default ListDashboardsIterable |
listDashboardsPaginator(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest)
Retrieves a paginated list of dashboards for an AWS IoT SiteWise Monitor project.
|
default ListDashboardsIterable |
listDashboardsPaginator(ListDashboardsRequest listDashboardsRequest)
Retrieves a paginated list of dashboards for an AWS IoT SiteWise Monitor project.
|
default ListGatewaysResponse |
listGateways(Consumer<ListGatewaysRequest.Builder> listGatewaysRequest)
Retrieves a paginated list of gateways.
|
default ListGatewaysResponse |
listGateways(ListGatewaysRequest listGatewaysRequest)
Retrieves a paginated list of gateways.
|
default ListGatewaysIterable |
listGatewaysPaginator(Consumer<ListGatewaysRequest.Builder> listGatewaysRequest)
Retrieves a paginated list of gateways.
|
default ListGatewaysIterable |
listGatewaysPaginator(ListGatewaysRequest listGatewaysRequest)
Retrieves a paginated list of gateways.
|
default ListPortalsResponse |
listPortals(Consumer<ListPortalsRequest.Builder> listPortalsRequest)
Retrieves a paginated list of AWS IoT SiteWise Monitor portals.
|
default ListPortalsResponse |
listPortals(ListPortalsRequest listPortalsRequest)
Retrieves a paginated list of AWS IoT SiteWise Monitor portals.
|
default ListPortalsIterable |
listPortalsPaginator(Consumer<ListPortalsRequest.Builder> listPortalsRequest)
Retrieves a paginated list of AWS IoT SiteWise Monitor portals.
|
default ListPortalsIterable |
listPortalsPaginator(ListPortalsRequest listPortalsRequest)
Retrieves a paginated list of AWS IoT SiteWise Monitor portals.
|
default ListProjectAssetsResponse |
listProjectAssets(Consumer<ListProjectAssetsRequest.Builder> listProjectAssetsRequest)
Retrieves a paginated list of assets associated with an AWS IoT SiteWise Monitor project.
|
default ListProjectAssetsResponse |
listProjectAssets(ListProjectAssetsRequest listProjectAssetsRequest)
Retrieves a paginated list of assets associated with an AWS IoT SiteWise Monitor project.
|
default ListProjectAssetsIterable |
listProjectAssetsPaginator(Consumer<ListProjectAssetsRequest.Builder> listProjectAssetsRequest)
Retrieves a paginated list of assets associated with an AWS IoT SiteWise Monitor project.
|
default ListProjectAssetsIterable |
listProjectAssetsPaginator(ListProjectAssetsRequest listProjectAssetsRequest)
Retrieves a paginated list of assets associated with an AWS IoT SiteWise Monitor project.
|
default ListProjectsResponse |
listProjects(Consumer<ListProjectsRequest.Builder> listProjectsRequest)
Retrieves a paginated list of projects for an AWS IoT SiteWise Monitor portal.
|
default ListProjectsResponse |
listProjects(ListProjectsRequest listProjectsRequest)
Retrieves a paginated list of projects for an AWS IoT SiteWise Monitor portal.
|
default ListProjectsIterable |
listProjectsPaginator(Consumer<ListProjectsRequest.Builder> listProjectsRequest)
Retrieves a paginated list of projects for an AWS IoT SiteWise Monitor portal.
|
default ListProjectsIterable |
listProjectsPaginator(ListProjectsRequest listProjectsRequest)
Retrieves a paginated list of projects for an AWS IoT SiteWise Monitor portal.
|
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Retrieves the list of tags for an AWS IoT SiteWise resource.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Retrieves the list of tags for an AWS IoT SiteWise resource.
|
default PutDefaultEncryptionConfigurationResponse |
putDefaultEncryptionConfiguration(Consumer<PutDefaultEncryptionConfigurationRequest.Builder> putDefaultEncryptionConfigurationRequest)
Sets the default encryption configuration for the AWS account.
|
default PutDefaultEncryptionConfigurationResponse |
putDefaultEncryptionConfiguration(PutDefaultEncryptionConfigurationRequest putDefaultEncryptionConfigurationRequest)
Sets the default encryption configuration for the AWS account.
|
default PutLoggingOptionsResponse |
putLoggingOptions(Consumer<PutLoggingOptionsRequest.Builder> putLoggingOptionsRequest)
Sets logging options for AWS IoT SiteWise.
|
default PutLoggingOptionsResponse |
putLoggingOptions(PutLoggingOptionsRequest putLoggingOptionsRequest)
Sets logging options for AWS IoT SiteWise.
|
static ServiceMetadata |
serviceMetadata() |
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds tags to an AWS IoT SiteWise resource.
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Adds tags to an AWS IoT SiteWise resource.
|
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes a tag from an AWS IoT SiteWise resource.
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag from an AWS IoT SiteWise resource.
|
default UpdateAccessPolicyResponse |
updateAccessPolicy(Consumer<UpdateAccessPolicyRequest.Builder> updateAccessPolicyRequest)
Updates an existing access policy that specifies an identity's access to an AWS IoT SiteWise Monitor portal or
project resource.
|
default UpdateAccessPolicyResponse |
updateAccessPolicy(UpdateAccessPolicyRequest updateAccessPolicyRequest)
Updates an existing access policy that specifies an identity's access to an AWS IoT SiteWise Monitor portal or
project resource.
|
default UpdateAssetResponse |
updateAsset(Consumer<UpdateAssetRequest.Builder> updateAssetRequest)
Updates an asset's name.
|
default UpdateAssetResponse |
updateAsset(UpdateAssetRequest updateAssetRequest)
Updates an asset's name.
|
default UpdateAssetModelResponse |
updateAssetModel(Consumer<UpdateAssetModelRequest.Builder> updateAssetModelRequest)
Updates an asset model and all of the assets that were created from the model.
|
default UpdateAssetModelResponse |
updateAssetModel(UpdateAssetModelRequest updateAssetModelRequest)
Updates an asset model and all of the assets that were created from the model.
|
default UpdateAssetPropertyResponse |
updateAssetProperty(Consumer<UpdateAssetPropertyRequest.Builder> updateAssetPropertyRequest)
Updates an asset property's alias and notification state.
|
default UpdateAssetPropertyResponse |
updateAssetProperty(UpdateAssetPropertyRequest updateAssetPropertyRequest)
Updates an asset property's alias and notification state.
|
default UpdateDashboardResponse |
updateDashboard(Consumer<UpdateDashboardRequest.Builder> updateDashboardRequest)
Updates an AWS IoT SiteWise Monitor dashboard.
|
default UpdateDashboardResponse |
updateDashboard(UpdateDashboardRequest updateDashboardRequest)
Updates an AWS IoT SiteWise Monitor dashboard.
|
default UpdateGatewayResponse |
updateGateway(Consumer<UpdateGatewayRequest.Builder> updateGatewayRequest)
Updates a gateway's name.
|
default UpdateGatewayResponse |
updateGateway(UpdateGatewayRequest updateGatewayRequest)
Updates a gateway's name.
|
default UpdateGatewayCapabilityConfigurationResponse |
updateGatewayCapabilityConfiguration(Consumer<UpdateGatewayCapabilityConfigurationRequest.Builder> updateGatewayCapabilityConfigurationRequest)
Updates a gateway capability configuration or defines a new capability configuration.
|
default UpdateGatewayCapabilityConfigurationResponse |
updateGatewayCapabilityConfiguration(UpdateGatewayCapabilityConfigurationRequest updateGatewayCapabilityConfigurationRequest)
Updates a gateway capability configuration or defines a new capability configuration.
|
default UpdatePortalResponse |
updatePortal(Consumer<UpdatePortalRequest.Builder> updatePortalRequest)
Updates an AWS IoT SiteWise Monitor portal.
|
default UpdatePortalResponse |
updatePortal(UpdatePortalRequest updatePortalRequest)
Updates an AWS IoT SiteWise Monitor portal.
|
default UpdateProjectResponse |
updateProject(Consumer<UpdateProjectRequest.Builder> updateProjectRequest)
Updates an AWS IoT SiteWise Monitor project.
|
default UpdateProjectResponse |
updateProject(UpdateProjectRequest updateProjectRequest)
Updates an AWS IoT SiteWise Monitor project.
|
default IoTSiteWiseWaiter |
waiter()
Create an instance of
IoTSiteWiseWaiter using this client. |
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static IoTSiteWiseClient create()
IoTSiteWiseClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static IoTSiteWiseClientBuilder builder()
IoTSiteWiseClient.default AssociateAssetsResponse associateAssets(AssociateAssetsRequest associateAssetsRequest) throws InvalidRequestException, 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 AWS IoT SiteWise User Guide.
associateAssetsRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS 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 AWS IoT SiteWise User Guide.
ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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.AwsServiceExceptiondefault AssociateAssetsResponse associateAssets(Consumer<AssociateAssetsRequest.Builder> associateAssetsRequest) throws InvalidRequestException, 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 AWS IoT SiteWise User Guide.
This is a convenience which creates an instance of the AssociateAssetsRequest.Builder avoiding the need
to create one manually via AssociateAssetsRequest.builder()
associateAssetsRequest - A Consumer that will call methods on AssociateAssetsRequest.Builder to create a request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS 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 AWS IoT SiteWise User Guide.
ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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.AwsServiceExceptiondefault BatchAssociateProjectAssetsResponse batchAssociateProjectAssets(BatchAssociateProjectAssetsRequest batchAssociateProjectAssetsRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, LimitExceededException, AwsServiceException, SdkClientException, IoTSiteWiseException
Associates a group (batch) of assets with an AWS IoT SiteWise Monitor project.
batchAssociateProjectAssetsRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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 AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchAssociateProjectAssetsResponse batchAssociateProjectAssets(Consumer<BatchAssociateProjectAssetsRequest.Builder> batchAssociateProjectAssetsRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, LimitExceededException, AwsServiceException, SdkClientException, IoTSiteWiseException
Associates a group (batch) of assets with an AWS IoT SiteWise Monitor project.
This is a convenience which creates an instance of the BatchAssociateProjectAssetsRequest.Builder
avoiding the need to create one manually via BatchAssociateProjectAssetsRequest.builder()
batchAssociateProjectAssetsRequest - A Consumer that will call methods on BatchAssociateProjectAssetsRequest.Builder to create
a request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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 AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchDisassociateProjectAssetsResponse batchDisassociateProjectAssets(BatchDisassociateProjectAssetsRequest batchDisassociateProjectAssetsRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Disassociates a group (batch) of assets from an AWS IoT SiteWise Monitor project.
batchDisassociateProjectAssetsRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchDisassociateProjectAssetsResponse batchDisassociateProjectAssets(Consumer<BatchDisassociateProjectAssetsRequest.Builder> batchDisassociateProjectAssetsRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Disassociates a group (batch) of assets from an AWS IoT SiteWise Monitor project.
This is a convenience which creates an instance of the BatchDisassociateProjectAssetsRequest.Builder
avoiding the need to create one manually via BatchDisassociateProjectAssetsRequest.builder()
batchDisassociateProjectAssetsRequest - A Consumer that will call methods on BatchDisassociateProjectAssetsRequest.Builder to
create a request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchPutAssetPropertyValueResponse batchPutAssetPropertyValue(BatchPutAssetPropertyValueRequest batchPutAssetPropertyValueRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, LimitExceededException, ServiceUnavailableException, ConflictingOperationException, AwsServiceException, SdkClientException, IoTSiteWiseException
Sends a list of asset property values to AWS IoT SiteWise. Each value is a timestamp-quality-value (TQV) data point. For more information, see Ingesting data using the API in the AWS IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
The assetId and propertyId of an asset property.
A propertyAlias, which is a data stream alias (for example,
/company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
With respect to Unix epoch time, AWS 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. AWS IoT SiteWise rejects timestamps outside of the
inclusive range of [-7 days, +10 minutes] and returns a TimestampOutOfRangeException error.
For each asset property, AWS 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.
AWS IoT SiteWise authorizes access to each BatchPutAssetPropertyValue entry individually. For more
information, see BatchPutAssetPropertyValue authorization in the AWS IoT SiteWise User Guide.
batchPutAssetPropertyValueRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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 AWS 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.AwsServiceExceptiondefault 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 AWS IoT SiteWise. Each value is a timestamp-quality-value (TQV) data point. For more information, see Ingesting data using the API in the AWS IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
The assetId and propertyId of an asset property.
A propertyAlias, which is a data stream alias (for example,
/company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
With respect to Unix epoch time, AWS 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. AWS IoT SiteWise rejects timestamps outside of the
inclusive range of [-7 days, +10 minutes] and returns a TimestampOutOfRangeException error.
For each asset property, AWS 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.
AWS IoT SiteWise authorizes access to each BatchPutAssetPropertyValue entry individually. For more
information, see BatchPutAssetPropertyValue authorization in the AWS IoT SiteWise User Guide.
This is a convenience which creates an instance of the BatchPutAssetPropertyValueRequest.Builder avoiding
the need to create one manually via BatchPutAssetPropertyValueRequest.builder()
batchPutAssetPropertyValueRequest - A Consumer that will call methods on BatchPutAssetPropertyValueRequest.Builder to create a
request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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 AWS 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.AwsServiceExceptiondefault CreateAccessPolicyResponse createAccessPolicy(CreateAccessPolicyRequest createAccessPolicyRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, LimitExceededException, AwsServiceException, SdkClientException, IoTSiteWiseException
Creates an access policy that grants the specified identity (AWS SSO user, AWS SSO group, or IAM user) access to the specified AWS IoT SiteWise Monitor portal or project resource.
createAccessPolicyRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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 AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateAccessPolicyResponse createAccessPolicy(Consumer<CreateAccessPolicyRequest.Builder> createAccessPolicyRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, LimitExceededException, AwsServiceException, SdkClientException, IoTSiteWiseException
Creates an access policy that grants the specified identity (AWS SSO user, AWS SSO group, or IAM user) access to the specified AWS IoT SiteWise Monitor portal or project resource.
This is a convenience which creates an instance of the CreateAccessPolicyRequest.Builder avoiding the
need to create one manually via CreateAccessPolicyRequest.builder()
createAccessPolicyRequest - A Consumer that will call methods on CreateAccessPolicyRequest.Builder to create a
request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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 AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AWS IoT SiteWise User Guide.
createAssetRequest - 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 - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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 AWS 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.AwsServiceExceptiondefault 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 AWS IoT SiteWise User Guide.
This is a convenience which creates an instance of the CreateAssetRequest.Builder avoiding the need to
create one manually via CreateAssetRequest.builder()
createAssetRequest - A Consumer that will call methods on CreateAssetRequest.Builder to create a request.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 - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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 AWS 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.AwsServiceExceptiondefault 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 AWS IoT SiteWise User Guide.
createAssetModelRequest - 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 - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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 AWS 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.AwsServiceExceptiondefault 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 AWS IoT SiteWise User Guide.
This is a convenience which creates an instance of the CreateAssetModelRequest.Builder avoiding the need
to create one manually via CreateAssetModelRequest.builder()
createAssetModelRequest - A Consumer that will call methods on CreateAssetModelRequest.Builder to create a request.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 - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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 AWS 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.AwsServiceExceptiondefault CreateDashboardResponse createDashboard(CreateDashboardRequest createDashboardRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, LimitExceededException, AwsServiceException, SdkClientException, IoTSiteWiseException
Creates a dashboard in an AWS IoT SiteWise Monitor project.
createDashboardRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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 AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDashboardResponse createDashboard(Consumer<CreateDashboardRequest.Builder> createDashboardRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, LimitExceededException, AwsServiceException, SdkClientException, IoTSiteWiseException
Creates a dashboard in an AWS IoT SiteWise Monitor project.
This is a convenience which creates an instance of the CreateDashboardRequest.Builder avoiding the need
to create one manually via CreateDashboardRequest.builder()
createDashboardRequest - A Consumer that will call methods on CreateDashboardRequest.Builder to create a request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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 AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AWS IoT SiteWise. For more information, see Ingesting data using a gateway in the AWS IoT SiteWise User Guide.
createGatewayRequest - 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 - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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 AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AWS IoT SiteWise. For more information, see Ingesting data using a gateway in the AWS IoT SiteWise User Guide.
This is a convenience which creates an instance of the CreateGatewayRequest.Builder avoiding the need to
create one manually via CreateGatewayRequest.builder()
createGatewayRequest - A Consumer that will call methods on CreateGatewayRequest.Builder to create a request.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 - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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 AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreatePortalResponse createPortal(CreatePortalRequest createPortalRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, LimitExceededException, AwsServiceException, SdkClientException, IoTSiteWiseException
Creates a portal, which can contain projects and dashboards. AWS IoT SiteWise Monitor uses AWS SSO 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 AWS IoT SiteWise User Guide.
createPortalRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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 AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreatePortalResponse createPortal(Consumer<CreatePortalRequest.Builder> createPortalRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, LimitExceededException, AwsServiceException, SdkClientException, IoTSiteWiseException
Creates a portal, which can contain projects and dashboards. AWS IoT SiteWise Monitor uses AWS SSO 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 AWS IoT SiteWise User Guide.
This is a convenience which creates an instance of the CreatePortalRequest.Builder avoiding the need to
create one manually via CreatePortalRequest.builder()
createPortalRequest - A Consumer that will call methods on CreatePortalRequest.Builder to create a request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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 AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateProjectResponse createProject(CreateProjectRequest createProjectRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, LimitExceededException, AwsServiceException, SdkClientException, IoTSiteWiseException
Creates a project in the specified portal.
createProjectRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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 AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateProjectResponse createProject(Consumer<CreateProjectRequest.Builder> createProjectRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, LimitExceededException, AwsServiceException, SdkClientException, IoTSiteWiseException
Creates a project in the specified portal.
This is a convenience which creates an instance of the CreateProjectRequest.Builder avoiding the need to
create one manually via CreateProjectRequest.builder()
createProjectRequest - A Consumer that will call methods on CreateProjectRequest.Builder to create a request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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 AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AWS IoT SiteWise Monitor resource. You can use this operation to revoke access to an AWS IoT SiteWise Monitor resource.
deleteAccessPolicyRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AWS IoT SiteWise Monitor resource. You can use this operation to revoke access to an AWS IoT SiteWise Monitor resource.
This is a convenience which creates an instance of the DeleteAccessPolicyRequest.Builder avoiding the
need to create one manually via DeleteAccessPolicyRequest.builder()
deleteAccessPolicyRequest - A Consumer that will call methods on DeleteAccessPolicyRequest.Builder to create a
request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AWS IoT SiteWise User Guide.
You can't delete an asset that's associated to another asset. For more information, see DisassociateAssets.
deleteAssetRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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.AwsServiceExceptiondefault 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 AWS IoT SiteWise User Guide.
You can't delete an asset that's associated to another asset. For more information, see DisassociateAssets.
This is a convenience which creates an instance of the DeleteAssetRequest.Builder avoiding the need to
create one manually via DeleteAssetRequest.builder()
deleteAssetRequest - A Consumer that will call methods on DeleteAssetRequest.Builder to create a request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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.AwsServiceExceptiondefault 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 AWS IoT SiteWise User Guide.
deleteAssetModelRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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.AwsServiceExceptiondefault 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 AWS IoT SiteWise User Guide.
This is a convenience which creates an instance of the DeleteAssetModelRequest.Builder avoiding the need
to create one manually via DeleteAssetModelRequest.builder()
deleteAssetModelRequest - A Consumer that will call methods on DeleteAssetModelRequest.Builder to create a request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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.AwsServiceExceptiondefault DeleteDashboardResponse deleteDashboard(DeleteDashboardRequest deleteDashboardRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Deletes a dashboard from AWS IoT SiteWise Monitor.
deleteDashboardRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDashboardResponse deleteDashboard(Consumer<DeleteDashboardRequest.Builder> deleteDashboardRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Deletes a dashboard from AWS IoT SiteWise Monitor.
This is a convenience which creates an instance of the DeleteDashboardRequest.Builder avoiding the need
to create one manually via DeleteDashboardRequest.builder()
deleteDashboardRequest - A Consumer that will call methods on DeleteDashboardRequest.Builder to create a request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteGatewayResponse deleteGateway(DeleteGatewayRequest deleteGatewayRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Deletes a gateway from AWS IoT SiteWise. When you delete a gateway, some of the gateway's files remain in your gateway's file system.
deleteGatewayRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteGatewayResponse deleteGateway(Consumer<DeleteGatewayRequest.Builder> deleteGatewayRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Deletes a gateway from AWS IoT SiteWise. When you delete a gateway, some of the gateway's files remain in your gateway's file system.
This is a convenience which creates an instance of the DeleteGatewayRequest.Builder avoiding the need to
create one manually via DeleteGatewayRequest.builder()
deleteGatewayRequest - A Consumer that will call methods on DeleteGatewayRequest.Builder to create a request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeletePortalResponse deletePortal(DeletePortalRequest deletePortalRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, ConflictingOperationException, AwsServiceException, SdkClientException, IoTSiteWiseException
Deletes a portal from AWS IoT SiteWise Monitor.
deletePortalRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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.AwsServiceExceptiondefault DeletePortalResponse deletePortal(Consumer<DeletePortalRequest.Builder> deletePortalRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, ConflictingOperationException, AwsServiceException, SdkClientException, IoTSiteWiseException
Deletes a portal from AWS IoT SiteWise Monitor.
This is a convenience which creates an instance of the DeletePortalRequest.Builder avoiding the need to
create one manually via DeletePortalRequest.builder()
deletePortalRequest - A Consumer that will call methods on DeletePortalRequest.Builder to create a request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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.AwsServiceExceptiondefault DeleteProjectResponse deleteProject(DeleteProjectRequest deleteProjectRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Deletes a project from AWS IoT SiteWise Monitor.
deleteProjectRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteProjectResponse deleteProject(Consumer<DeleteProjectRequest.Builder> deleteProjectRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Deletes a project from AWS IoT SiteWise Monitor.
This is a convenience which creates an instance of the DeleteProjectRequest.Builder avoiding the need to
create one manually via DeleteProjectRequest.builder()
deleteProjectRequest - A Consumer that will call methods on DeleteProjectRequest.Builder to create a request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeAccessPolicyResponse describeAccessPolicy(DescribeAccessPolicyRequest describeAccessPolicyRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Describes an access policy, which specifies an identity's access to an AWS IoT SiteWise Monitor portal or project.
describeAccessPolicyRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AWS IoT SiteWise Monitor portal or project.
This is a convenience which creates an instance of the DescribeAccessPolicyRequest.Builder avoiding the
need to create one manually via DescribeAccessPolicyRequest.builder()
describeAccessPolicyRequest - A Consumer that will call methods on DescribeAccessPolicyRequest.Builder to create a
request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeAssetResponse describeAsset(DescribeAssetRequest describeAssetRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves information about an asset.
describeAssetRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via DescribeAssetRequest.builder()
describeAssetRequest - A Consumer that will call methods on DescribeAssetRequest.Builder to create a request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeAssetModelResponse describeAssetModel(DescribeAssetModelRequest describeAssetModelRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves information about an asset model.
describeAssetModelRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via DescribeAssetModelRequest.builder()
describeAssetModelRequest - A Consumer that will call methods on DescribeAssetModelRequest.Builder to create a
request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
describeAssetPropertyRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via DescribeAssetPropertyRequest.builder()
describeAssetPropertyRequest - A Consumer that will call methods on DescribeAssetPropertyRequest.Builder to create a
request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDashboardResponse describeDashboard(DescribeDashboardRequest describeDashboardRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves information about a dashboard.
describeDashboardRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the need
to create one manually via DescribeDashboardRequest.builder()
describeDashboardRequest - A Consumer that will call methods on DescribeDashboardRequest.Builder to create a request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDefaultEncryptionConfigurationResponse describeDefaultEncryptionConfiguration(DescribeDefaultEncryptionConfigurationRequest describeDefaultEncryptionConfigurationRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves information about the default encryption configuration for the AWS account in the default or specified region. For more information, see Key management in the AWS IoT SiteWise User Guide.
describeDefaultEncryptionConfigurationRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDefaultEncryptionConfigurationResponse describeDefaultEncryptionConfiguration(Consumer<DescribeDefaultEncryptionConfigurationRequest.Builder> describeDefaultEncryptionConfigurationRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves information about the default encryption configuration for the AWS account in the default or specified region. For more information, see Key management in the AWS IoT SiteWise User Guide.
This is a convenience which creates an instance of the
DescribeDefaultEncryptionConfigurationRequest.Builder avoiding the need to create one manually via
DescribeDefaultEncryptionConfigurationRequest.builder()
describeDefaultEncryptionConfigurationRequest - A Consumer that will call methods on DescribeDefaultEncryptionConfigurationRequest.Builder
to create a request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeGatewayResponse describeGateway(DescribeGatewayRequest describeGatewayRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves information about a gateway.
describeGatewayRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the need
to create one manually via DescribeGatewayRequest.builder()
describeGatewayRequest - A Consumer that will call methods on DescribeGatewayRequest.Builder to create a request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AWS 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.
describeGatewayCapabilityConfigurationRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AWS IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway.
This is a convenience which creates an instance of the
DescribeGatewayCapabilityConfigurationRequest.Builder avoiding the need to create one manually via
DescribeGatewayCapabilityConfigurationRequest.builder()
describeGatewayCapabilityConfigurationRequest - A Consumer that will call methods on DescribeGatewayCapabilityConfigurationRequest.Builder
to create a request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeLoggingOptionsResponse describeLoggingOptions(DescribeLoggingOptionsRequest describeLoggingOptionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves the current AWS IoT SiteWise logging options.
describeLoggingOptionsRequest - 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 AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
InternalFailureException - AWS 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.AwsServiceExceptiondefault DescribeLoggingOptionsResponse describeLoggingOptions(Consumer<DescribeLoggingOptionsRequest.Builder> describeLoggingOptionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves the current AWS IoT SiteWise logging options.
This is a convenience which creates an instance of the DescribeLoggingOptionsRequest.Builder avoiding the
need to create one manually via DescribeLoggingOptionsRequest.builder()
describeLoggingOptionsRequest - A Consumer that will call methods on DescribeLoggingOptionsRequest.Builder to create a
request.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 AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
InternalFailureException - AWS 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.AwsServiceExceptiondefault DescribePortalResponse describePortal(DescribePortalRequest describePortalRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves information about a portal.
describePortalRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via DescribePortalRequest.builder()
describePortalRequest - A Consumer that will call methods on DescribePortalRequest.Builder to create a request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeProjectResponse describeProject(DescribeProjectRequest describeProjectRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves information about a project.
describeProjectRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the need
to create one manually via DescribeProjectRequest.builder()
describeProjectRequest - A Consumer that will call methods on DescribeProjectRequest.Builder to create a request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
disassociateAssetsRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via DisassociateAssetsRequest.builder()
disassociateAssetsRequest - A Consumer that will call methods on DisassociateAssetsRequest.Builder to create a
request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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.AwsServiceExceptiondefault 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 AWS IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
The assetId and propertyId of an asset property.
A propertyAlias, which is a data stream alias (for example,
/company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
getAssetPropertyAggregatesRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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.AwsServiceExceptiondefault 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 AWS IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
The assetId and propertyId of an asset property.
A propertyAlias, which is a data stream alias (for example,
/company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
This is a convenience which creates an instance of the GetAssetPropertyAggregatesRequest.Builder avoiding
the need to create one manually via GetAssetPropertyAggregatesRequest.builder()
getAssetPropertyAggregatesRequest - A Consumer that will call methods on GetAssetPropertyAggregatesRequest.Builder to create a
request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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.AwsServiceExceptiondefault GetAssetPropertyAggregatesIterable getAssetPropertyAggregatesPaginator(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 AWS IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
The assetId and propertyId of an asset property.
A propertyAlias, which is a data stream alias (for example,
/company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
This is a 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
software.amazon.awssdk.services.iotsitewise.paginators.GetAssetPropertyAggregatesIterable responses = client.getAssetPropertyAggregatesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
getAssetPropertyAggregatesRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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.AwsServiceExceptiondefault GetAssetPropertyAggregatesIterable getAssetPropertyAggregatesPaginator(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 AWS IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
The assetId and propertyId of an asset property.
A propertyAlias, which is a data stream alias (for example,
/company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
This is a 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
software.amazon.awssdk.services.iotsitewise.paginators.GetAssetPropertyAggregatesIterable responses = client.getAssetPropertyAggregatesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder avoiding
the need to create one manually via GetAssetPropertyAggregatesRequest.builder()
getAssetPropertyAggregatesRequest - A Consumer that will call methods on GetAssetPropertyAggregatesRequest.Builder to create a
request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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.AwsServiceExceptiondefault 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 AWS IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
The assetId and propertyId of an asset property.
A propertyAlias, which is a data stream alias (for example,
/company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
getAssetPropertyValueRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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.AwsServiceExceptiondefault 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 AWS IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
The assetId and propertyId of an asset property.
A propertyAlias, which is a data stream alias (for example,
/company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
This is a convenience which creates an instance of the GetAssetPropertyValueRequest.Builder avoiding the
need to create one manually via GetAssetPropertyValueRequest.builder()
getAssetPropertyValueRequest - A Consumer that will call methods on GetAssetPropertyValueRequest.Builder to create a
request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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.AwsServiceExceptiondefault 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 AWS IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
The assetId and propertyId of an asset property.
A propertyAlias, which is a data stream alias (for example,
/company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
getAssetPropertyValueHistoryRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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.AwsServiceExceptiondefault 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 AWS IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
The assetId and propertyId of an asset property.
A propertyAlias, which is a data stream alias (for example,
/company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
This is a convenience which creates an instance of the GetAssetPropertyValueHistoryRequest.Builder
avoiding the need to create one manually via GetAssetPropertyValueHistoryRequest.builder()
getAssetPropertyValueHistoryRequest - A Consumer that will call methods on GetAssetPropertyValueHistoryRequest.Builder to create
a request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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.AwsServiceExceptiondefault GetAssetPropertyValueHistoryIterable getAssetPropertyValueHistoryPaginator(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 AWS IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
The assetId and propertyId of an asset property.
A propertyAlias, which is a data stream alias (for example,
/company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
This is a 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
software.amazon.awssdk.services.iotsitewise.paginators.GetAssetPropertyValueHistoryIterable responses = client.getAssetPropertyValueHistoryPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
getAssetPropertyValueHistoryRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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.AwsServiceExceptiondefault GetAssetPropertyValueHistoryIterable getAssetPropertyValueHistoryPaginator(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 AWS IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
The assetId and propertyId of an asset property.
A propertyAlias, which is a data stream alias (for example,
/company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
This is a 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
software.amazon.awssdk.services.iotsitewise.paginators.GetAssetPropertyValueHistoryIterable responses = client.getAssetPropertyValueHistoryPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder
avoiding the need to create one manually via GetAssetPropertyValueHistoryRequest.builder()
getAssetPropertyValueHistoryRequest - A Consumer that will call methods on GetAssetPropertyValueHistoryRequest.Builder to create
a request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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.AwsServiceExceptiondefault 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. For example, you can use the this operation to return the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days.
This API isn't available in China (Beijing).
To identify an asset property, you must specify one of the following:
The assetId and propertyId of an asset property.
A propertyAlias, which is a data stream alias (for example,
/company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
getInterpolatedAssetPropertyValuesRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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.AwsServiceExceptiondefault 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. For example, you can use the this operation to return the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days.
This API isn't available in China (Beijing).
To identify an asset property, you must specify one of the following:
The assetId and propertyId of an asset property.
A propertyAlias, which is a data stream alias (for example,
/company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
This is a convenience which creates an instance of the GetInterpolatedAssetPropertyValuesRequest.Builder
avoiding the need to create one manually via GetInterpolatedAssetPropertyValuesRequest.builder()
getInterpolatedAssetPropertyValuesRequest - A Consumer that will call methods on GetInterpolatedAssetPropertyValuesRequest.Builder to
create a request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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.AwsServiceExceptiondefault GetInterpolatedAssetPropertyValuesIterable getInterpolatedAssetPropertyValuesPaginator(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. For example, you can use the this operation to return the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days.
This API isn't available in China (Beijing).
To identify an asset property, you must specify one of the following:
The assetId and propertyId of an asset property.
A propertyAlias, which is a data stream alias (for example,
/company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
This is a 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
software.amazon.awssdk.services.iotsitewise.paginators.GetInterpolatedAssetPropertyValuesIterable responses = client.getInterpolatedAssetPropertyValuesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
getInterpolatedAssetPropertyValuesRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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.AwsServiceExceptiondefault GetInterpolatedAssetPropertyValuesIterable getInterpolatedAssetPropertyValuesPaginator(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. For example, you can use the this operation to return the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days.
This API isn't available in China (Beijing).
To identify an asset property, you must specify one of the following:
The assetId and propertyId of an asset property.
A propertyAlias, which is a data stream alias (for example,
/company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
This is a 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
software.amazon.awssdk.services.iotsitewise.paginators.GetInterpolatedAssetPropertyValuesIterable responses = client.getInterpolatedAssetPropertyValuesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder
avoiding the need to create one manually via GetInterpolatedAssetPropertyValuesRequest.builder()
getInterpolatedAssetPropertyValuesRequest - A Consumer that will call methods on GetInterpolatedAssetPropertyValuesRequest.Builder to
create a request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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.AwsServiceExceptiondefault ListAccessPoliciesResponse listAccessPolicies(ListAccessPoliciesRequest listAccessPoliciesRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves a paginated list of access policies for an identity (an AWS SSO user, an AWS SSO group, or an IAM user) or an AWS IoT SiteWise Monitor resource (a portal or project).
listAccessPoliciesRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAccessPoliciesResponse listAccessPolicies(Consumer<ListAccessPoliciesRequest.Builder> listAccessPoliciesRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves a paginated list of access policies for an identity (an AWS SSO user, an AWS SSO group, or an IAM user) or an AWS IoT SiteWise Monitor resource (a portal or project).
This is a convenience which creates an instance of the ListAccessPoliciesRequest.Builder avoiding the
need to create one manually via ListAccessPoliciesRequest.builder()
listAccessPoliciesRequest - A Consumer that will call methods on ListAccessPoliciesRequest.Builder to create a
request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAccessPoliciesIterable listAccessPoliciesPaginator(ListAccessPoliciesRequest listAccessPoliciesRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves a paginated list of access policies for an identity (an AWS SSO user, an AWS SSO group, or an IAM user) or an AWS IoT SiteWise Monitor resource (a portal or project).
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
software.amazon.awssdk.services.iotsitewise.paginators.ListAccessPoliciesIterable responses = client.listAccessPoliciesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listAccessPoliciesRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAccessPoliciesIterable listAccessPoliciesPaginator(Consumer<ListAccessPoliciesRequest.Builder> listAccessPoliciesRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves a paginated list of access policies for an identity (an AWS SSO user, an AWS SSO group, or an IAM user) or an AWS IoT SiteWise Monitor resource (a portal or project).
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
software.amazon.awssdk.services.iotsitewise.paginators.ListAccessPoliciesIterable responses = client.listAccessPoliciesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder avoiding the
need to create one manually via ListAccessPoliciesRequest.builder()
listAccessPoliciesRequest - A Consumer that will call methods on ListAccessPoliciesRequest.Builder to create a
request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAssetModelsResponse listAssetModels(ListAssetModelsRequest listAssetModelsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves a paginated list of summaries of all asset models.
listAssetModelsRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the need
to create one manually via ListAssetModelsRequest.builder()
listAssetModelsRequest - A Consumer that will call methods on ListAssetModelsRequest.Builder to create a request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAssetModelsIterable listAssetModelsPaginator(ListAssetModelsRequest listAssetModelsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves a paginated list of summaries of all asset models.
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
software.amazon.awssdk.services.iotsitewise.paginators.ListAssetModelsIterable responses = client.listAssetModelsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listAssetModelsRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAssetModelsIterable listAssetModelsPaginator(Consumer<ListAssetModelsRequest.Builder> listAssetModelsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves a paginated list of summaries of all asset models.
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
software.amazon.awssdk.services.iotsitewise.paginators.ListAssetModelsIterable responses = client.listAssetModelsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder avoiding the need
to create one manually via ListAssetModelsRequest.builder()
listAssetModelsRequest - A Consumer that will call methods on ListAssetModelsRequest.Builder to create a request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listAssetRelationshipsRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException - AWS 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 AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via ListAssetRelationshipsRequest.builder()
listAssetRelationshipsRequest - A Consumer that will call methods on ListAssetRelationshipsRequest.Builder to create a
request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException - AWS 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 AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAssetRelationshipsIterable listAssetRelationshipsPaginator(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.
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
software.amazon.awssdk.services.iotsitewise.paginators.ListAssetRelationshipsIterable responses = client.listAssetRelationshipsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listAssetRelationshipsRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException - AWS 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 AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAssetRelationshipsIterable listAssetRelationshipsPaginator(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 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
software.amazon.awssdk.services.iotsitewise.paginators.ListAssetRelationshipsIterable responses = client.listAssetRelationshipsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder avoiding the
need to create one manually via ListAssetRelationshipsRequest.builder()
listAssetRelationshipsRequest - A Consumer that will call methods on ListAssetRelationshipsRequest.Builder to create a
request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException - AWS 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 AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listAssetsRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException - AWS 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 AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via ListAssetsRequest.builder()
listAssetsRequest - A Consumer that will call methods on ListAssetsRequest.Builder to create a request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException - AWS 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 AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAssetsIterable listAssetsPaginator(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.
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
software.amazon.awssdk.services.iotsitewise.paginators.ListAssetsIterable responses = client.listAssetsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listAssetsRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException - AWS 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 AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAssetsIterable listAssetsPaginator(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 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
software.amazon.awssdk.services.iotsitewise.paginators.ListAssetsIterable responses = client.listAssetsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder avoiding the need to
create one manually via ListAssetsRequest.builder()
listAssetsRequest - A Consumer that will call methods on ListAssetsRequest.Builder to create a request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException - AWS 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 AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listAssociatedAssetsRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException - AWS 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 AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via ListAssociatedAssetsRequest.builder()
listAssociatedAssetsRequest - A Consumer that will call methods on ListAssociatedAssetsRequest.Builder to create a
request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException - AWS 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 AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAssociatedAssetsIterable listAssociatedAssetsPaginator(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.
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
software.amazon.awssdk.services.iotsitewise.paginators.ListAssociatedAssetsIterable responses = client.listAssociatedAssetsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listAssociatedAssetsRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException - AWS 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 AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAssociatedAssetsIterable listAssociatedAssetsPaginator(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 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
software.amazon.awssdk.services.iotsitewise.paginators.ListAssociatedAssetsIterable responses = client.listAssociatedAssetsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder avoiding the
need to create one manually via ListAssociatedAssetsRequest.builder()
listAssociatedAssetsRequest - A Consumer that will call methods on ListAssociatedAssetsRequest.Builder to create a
request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException - AWS 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 AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDashboardsResponse listDashboards(ListDashboardsRequest listDashboardsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves a paginated list of dashboards for an AWS IoT SiteWise Monitor project.
listDashboardsRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDashboardsResponse listDashboards(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves a paginated list of dashboards for an AWS IoT SiteWise Monitor project.
This is a convenience which creates an instance of the ListDashboardsRequest.Builder avoiding the need to
create one manually via ListDashboardsRequest.builder()
listDashboardsRequest - A Consumer that will call methods on ListDashboardsRequest.Builder to create a request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDashboardsIterable listDashboardsPaginator(ListDashboardsRequest listDashboardsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves a paginated list of dashboards for an AWS IoT SiteWise Monitor project.
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
software.amazon.awssdk.services.iotsitewise.paginators.ListDashboardsIterable responses = client.listDashboardsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listDashboardsRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDashboardsIterable listDashboardsPaginator(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves a paginated list of dashboards for an AWS IoT SiteWise Monitor project.
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
software.amazon.awssdk.services.iotsitewise.paginators.ListDashboardsIterable responses = client.listDashboardsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder avoiding the need to
create one manually via ListDashboardsRequest.builder()
listDashboardsRequest - A Consumer that will call methods on ListDashboardsRequest.Builder to create a request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListGatewaysResponse listGateways(ListGatewaysRequest listGatewaysRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves a paginated list of gateways.
listGatewaysRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via ListGatewaysRequest.builder()
listGatewaysRequest - A Consumer that will call methods on ListGatewaysRequest.Builder to create a request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListGatewaysIterable listGatewaysPaginator(ListGatewaysRequest listGatewaysRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves a paginated list of gateways.
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
software.amazon.awssdk.services.iotsitewise.paginators.ListGatewaysIterable responses = client.listGatewaysPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listGatewaysRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListGatewaysIterable listGatewaysPaginator(Consumer<ListGatewaysRequest.Builder> listGatewaysRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves a paginated list of gateways.
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
software.amazon.awssdk.services.iotsitewise.paginators.ListGatewaysIterable responses = client.listGatewaysPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder avoiding the need to
create one manually via ListGatewaysRequest.builder()
listGatewaysRequest - A Consumer that will call methods on ListGatewaysRequest.Builder to create a request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPortalsResponse listPortals(ListPortalsRequest listPortalsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves a paginated list of AWS IoT SiteWise Monitor portals.
listPortalsRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPortalsResponse listPortals(Consumer<ListPortalsRequest.Builder> listPortalsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves a paginated list of AWS IoT SiteWise Monitor portals.
This is a convenience which creates an instance of the ListPortalsRequest.Builder avoiding the need to
create one manually via ListPortalsRequest.builder()
listPortalsRequest - A Consumer that will call methods on ListPortalsRequest.Builder to create a request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPortalsIterable listPortalsPaginator(ListPortalsRequest listPortalsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves a paginated list of AWS IoT SiteWise Monitor portals.
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
software.amazon.awssdk.services.iotsitewise.paginators.ListPortalsIterable responses = client.listPortalsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listPortalsRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPortalsIterable listPortalsPaginator(Consumer<ListPortalsRequest.Builder> listPortalsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves a paginated list of AWS IoT SiteWise Monitor portals.
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
software.amazon.awssdk.services.iotsitewise.paginators.ListPortalsIterable responses = client.listPortalsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder avoiding the need to
create one manually via ListPortalsRequest.builder()
listPortalsRequest - A Consumer that will call methods on ListPortalsRequest.Builder to create a request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListProjectAssetsResponse listProjectAssets(ListProjectAssetsRequest listProjectAssetsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves a paginated list of assets associated with an AWS IoT SiteWise Monitor project.
listProjectAssetsRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListProjectAssetsResponse listProjectAssets(Consumer<ListProjectAssetsRequest.Builder> listProjectAssetsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves a paginated list of assets associated with an AWS IoT SiteWise Monitor project.
This is a convenience which creates an instance of the ListProjectAssetsRequest.Builder avoiding the need
to create one manually via ListProjectAssetsRequest.builder()
listProjectAssetsRequest - A Consumer that will call methods on ListProjectAssetsRequest.Builder to create a request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListProjectAssetsIterable listProjectAssetsPaginator(ListProjectAssetsRequest listProjectAssetsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves a paginated list of assets associated with an AWS IoT SiteWise Monitor project.
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
software.amazon.awssdk.services.iotsitewise.paginators.ListProjectAssetsIterable responses = client.listProjectAssetsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listProjectAssetsRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListProjectAssetsIterable listProjectAssetsPaginator(Consumer<ListProjectAssetsRequest.Builder> listProjectAssetsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves a paginated list of assets associated with an AWS IoT SiteWise Monitor project.
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
software.amazon.awssdk.services.iotsitewise.paginators.ListProjectAssetsIterable responses = client.listProjectAssetsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder avoiding the need
to create one manually via ListProjectAssetsRequest.builder()
listProjectAssetsRequest - A Consumer that will call methods on ListProjectAssetsRequest.Builder to create a request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListProjectsResponse listProjects(ListProjectsRequest listProjectsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves a paginated list of projects for an AWS IoT SiteWise Monitor portal.
listProjectsRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListProjectsResponse listProjects(Consumer<ListProjectsRequest.Builder> listProjectsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves a paginated list of projects for an AWS IoT SiteWise Monitor portal.
This is a convenience which creates an instance of the ListProjectsRequest.Builder avoiding the need to
create one manually via ListProjectsRequest.builder()
listProjectsRequest - A Consumer that will call methods on ListProjectsRequest.Builder to create a request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListProjectsIterable listProjectsPaginator(ListProjectsRequest listProjectsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves a paginated list of projects for an AWS IoT SiteWise Monitor portal.
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
software.amazon.awssdk.services.iotsitewise.paginators.ListProjectsIterable responses = client.listProjectsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listProjectsRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListProjectsIterable listProjectsPaginator(Consumer<ListProjectsRequest.Builder> listProjectsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves a paginated list of projects for an AWS IoT SiteWise Monitor portal.
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
software.amazon.awssdk.services.iotsitewise.paginators.ListProjectsIterable responses = client.listProjectsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder avoiding the need to
create one manually via ListProjectsRequest.builder()
listProjectsRequest - A Consumer that will call methods on ListProjectsRequest.Builder to create a request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, ResourceNotFoundException, ConflictingOperationException, LimitExceededException, UnauthorizedException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves the list of tags for an AWS IoT SiteWise resource.
listTagsForResourceRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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 AWS 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.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, ResourceNotFoundException, ConflictingOperationException, LimitExceededException, UnauthorizedException, AwsServiceException, SdkClientException, IoTSiteWiseException
Retrieves the list of tags for an AWS IoT SiteWise resource.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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 AWS 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.AwsServiceExceptiondefault PutDefaultEncryptionConfigurationResponse putDefaultEncryptionConfiguration(PutDefaultEncryptionConfigurationRequest putDefaultEncryptionConfigurationRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, LimitExceededException, ConflictingOperationException, AwsServiceException, SdkClientException, IoTSiteWiseException
Sets the default encryption configuration for the AWS account. For more information, see Key management in the AWS IoT SiteWise User Guide.
putDefaultEncryptionConfigurationRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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 AWS 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.AwsServiceExceptiondefault PutDefaultEncryptionConfigurationResponse putDefaultEncryptionConfiguration(Consumer<PutDefaultEncryptionConfigurationRequest.Builder> putDefaultEncryptionConfigurationRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, LimitExceededException, ConflictingOperationException, AwsServiceException, SdkClientException, IoTSiteWiseException
Sets the default encryption configuration for the AWS account. For more information, see Key management in the AWS IoT SiteWise User Guide.
This is a convenience which creates an instance of the PutDefaultEncryptionConfigurationRequest.Builder
avoiding the need to create one manually via PutDefaultEncryptionConfigurationRequest.builder()
putDefaultEncryptionConfigurationRequest - A Consumer that will call methods on PutDefaultEncryptionConfigurationRequest.Builder to
create a request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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 AWS 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.AwsServiceExceptiondefault PutLoggingOptionsResponse putLoggingOptions(PutLoggingOptionsRequest putLoggingOptionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ConflictingOperationException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTSiteWiseException
Sets logging options for AWS IoT SiteWise.
putLoggingOptionsRequest - 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 AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
InternalFailureException - AWS 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.AwsServiceExceptiondefault PutLoggingOptionsResponse putLoggingOptions(Consumer<PutLoggingOptionsRequest.Builder> putLoggingOptionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ConflictingOperationException, ResourceNotFoundException, AwsServiceException, SdkClientException, IoTSiteWiseException
Sets logging options for AWS IoT SiteWise.
This is a convenience which creates an instance of the PutLoggingOptionsRequest.Builder avoiding the need
to create one manually via PutLoggingOptionsRequest.builder()
putLoggingOptionsRequest - A Consumer that will call methods on PutLoggingOptionsRequest.Builder to create a request.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 AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
InternalFailureException - AWS 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.AwsServiceExceptiondefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, ResourceNotFoundException, ConflictingOperationException, LimitExceededException, UnauthorizedException, TooManyTagsException, AwsServiceException, SdkClientException, IoTSiteWiseException
Adds tags to an AWS IoT SiteWise resource. If a tag already exists for the resource, this operation updates the tag's value.
tagResourceRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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 AWS 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 AWS 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.AwsServiceExceptiondefault TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, ResourceNotFoundException, ConflictingOperationException, LimitExceededException, UnauthorizedException, TooManyTagsException, AwsServiceException, SdkClientException, IoTSiteWiseException
Adds tags to an AWS IoT SiteWise resource. If a tag already exists for the resource, this operation updates the tag's value.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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 AWS 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 AWS 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.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, ResourceNotFoundException, ConflictingOperationException, LimitExceededException, UnauthorizedException, AwsServiceException, SdkClientException, IoTSiteWiseException
Removes a tag from an AWS IoT SiteWise resource.
untagResourceRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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 AWS 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.AwsServiceExceptiondefault UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, ResourceNotFoundException, ConflictingOperationException, LimitExceededException, UnauthorizedException, AwsServiceException, SdkClientException, IoTSiteWiseException
Removes a tag from an AWS IoT SiteWise resource.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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 AWS 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.AwsServiceExceptiondefault 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 AWS IoT SiteWise Monitor portal or project resource.
updateAccessPolicyRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AWS IoT SiteWise Monitor portal or project resource.
This is a convenience which creates an instance of the UpdateAccessPolicyRequest.Builder avoiding the
need to create one manually via UpdateAccessPolicyRequest.builder()
updateAccessPolicyRequest - A Consumer that will call methods on UpdateAccessPolicyRequest.Builder to create a
request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AWS IoT SiteWise User Guide.
updateAssetRequest - 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 - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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.AwsServiceExceptiondefault 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 AWS IoT SiteWise User Guide.
This is a convenience which creates an instance of the UpdateAssetRequest.Builder avoiding the need to
create one manually via UpdateAssetRequest.builder()
updateAssetRequest - A Consumer that will call methods on UpdateAssetRequest.Builder to create a request.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 - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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.AwsServiceExceptiondefault 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 AWS IoT SiteWise User Guide.
This operation overwrites the existing model with the provided model. To avoid deleting your asset model's properties or hierarchies, you must include their IDs and definitions in the updated asset model payload. For more information, see DescribeAssetModel.
If you remove a property from an asset model, AWS IoT SiteWise deletes all previous data for that property. If you remove a hierarchy definition from an asset model, AWS IoT SiteWise disassociates every asset associated with that hierarchy. You can't change the type or data type of an existing property.
updateAssetModelRequest - 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 - AWS 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 AWS IoT SiteWise User Guide.
ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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.AwsServiceExceptiondefault 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 AWS IoT SiteWise User Guide.
This operation overwrites the existing model with the provided model. To avoid deleting your asset model's properties or hierarchies, you must include their IDs and definitions in the updated asset model payload. For more information, see DescribeAssetModel.
If you remove a property from an asset model, AWS IoT SiteWise deletes all previous data for that property. If you remove a hierarchy definition from an asset model, AWS IoT SiteWise disassociates every asset associated with that hierarchy. You can't change the type or data type of an existing property.
This is a convenience which creates an instance of the UpdateAssetModelRequest.Builder avoiding the need
to create one manually via UpdateAssetModelRequest.builder()
updateAssetModelRequest - A Consumer that will call methods on UpdateAssetModelRequest.Builder to create a request.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 - AWS 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 AWS IoT SiteWise User Guide.
ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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.AwsServiceExceptiondefault 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.
updateAssetPropertyRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via UpdateAssetPropertyRequest.builder()
updateAssetPropertyRequest - A Consumer that will call methods on UpdateAssetPropertyRequest.Builder to create a
request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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.AwsServiceExceptiondefault UpdateDashboardResponse updateDashboard(UpdateDashboardRequest updateDashboardRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Updates an AWS IoT SiteWise Monitor dashboard.
updateDashboardRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateDashboardResponse updateDashboard(Consumer<UpdateDashboardRequest.Builder> updateDashboardRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Updates an AWS IoT SiteWise Monitor dashboard.
This is a convenience which creates an instance of the UpdateDashboardRequest.Builder avoiding the need
to create one manually via UpdateDashboardRequest.builder()
updateDashboardRequest - A Consumer that will call methods on UpdateDashboardRequest.Builder to create a request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateGatewayResponse updateGateway(UpdateGatewayRequest updateGatewayRequest) throws InvalidRequestException, ResourceNotFoundException, ConflictingOperationException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Updates a gateway's name.
updateGatewayRequest - InvalidRequestException - The request isn't valid. This can 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 - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via UpdateGatewayRequest.builder()
updateGatewayRequest - A Consumer that will call methods on UpdateGatewayRequest.Builder to create a request.InvalidRequestException - The request isn't valid. This can 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 - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AWS 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.
updateGatewayCapabilityConfigurationRequest - InvalidRequestException - The request isn't valid. This can 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 - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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 AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AWS IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway.
This is a convenience which creates an instance of the
UpdateGatewayCapabilityConfigurationRequest.Builder avoiding the need to create one manually via
UpdateGatewayCapabilityConfigurationRequest.builder()
updateGatewayCapabilityConfigurationRequest - A Consumer that will call methods on UpdateGatewayCapabilityConfigurationRequest.Builder
to create a request.InvalidRequestException - The request isn't valid. This can 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 - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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 AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdatePortalResponse updatePortal(UpdatePortalRequest updatePortalRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, ConflictingOperationException, AwsServiceException, SdkClientException, IoTSiteWiseException
Updates an AWS IoT SiteWise Monitor portal.
updatePortalRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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.AwsServiceExceptiondefault UpdatePortalResponse updatePortal(Consumer<UpdatePortalRequest.Builder> updatePortalRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, ConflictingOperationException, AwsServiceException, SdkClientException, IoTSiteWiseException
Updates an AWS IoT SiteWise Monitor portal.
This is a convenience which creates an instance of the UpdatePortalRequest.Builder avoiding the need to
create one manually via UpdatePortalRequest.builder()
updatePortalRequest - A Consumer that will call methods on UpdatePortalRequest.Builder to create a request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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.AwsServiceExceptiondefault UpdateProjectResponse updateProject(UpdateProjectRequest updateProjectRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Updates an AWS IoT SiteWise Monitor project.
updateProjectRequest - InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateProjectResponse updateProject(Consumer<UpdateProjectRequest.Builder> updateProjectRequest) throws InvalidRequestException, ResourceNotFoundException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IoTSiteWiseException
Updates an AWS IoT SiteWise Monitor project.
This is a convenience which creates an instance of the UpdateProjectRequest.Builder avoiding the need to
create one manually via UpdateProjectRequest.builder()
updateProjectRequest - A Consumer that will call methods on UpdateProjectRequest.Builder to create a request.InvalidRequestException - The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException - The requested resource can't be found.InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IoTSiteWiseException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
default IoTSiteWiseWaiter waiter()
IoTSiteWiseWaiter using this client.
Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
IoTSiteWiseWaiterCopyright © 2021. All rights reserved.