@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface IoTSiteWiseAsyncClient 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 CompletableFuture<AssociateAssetsResponse> |
associateAssets(AssociateAssetsRequest associateAssetsRequest)
Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's model.
|
default CompletableFuture<AssociateAssetsResponse> |
associateAssets(Consumer<AssociateAssetsRequest.Builder> associateAssetsRequest)
Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's model.
|
default CompletableFuture<BatchAssociateProjectAssetsResponse> |
batchAssociateProjectAssets(BatchAssociateProjectAssetsRequest batchAssociateProjectAssetsRequest)
Associates a group (batch) of assets with an AWS IoT SiteWise Monitor project.
|
default CompletableFuture<BatchAssociateProjectAssetsResponse> |
batchAssociateProjectAssets(Consumer<BatchAssociateProjectAssetsRequest.Builder> batchAssociateProjectAssetsRequest)
Associates a group (batch) of assets with an AWS IoT SiteWise Monitor project.
|
default CompletableFuture<BatchDisassociateProjectAssetsResponse> |
batchDisassociateProjectAssets(BatchDisassociateProjectAssetsRequest batchDisassociateProjectAssetsRequest)
Disassociates a group (batch) of assets from an AWS IoT SiteWise Monitor project.
|
default CompletableFuture<BatchDisassociateProjectAssetsResponse> |
batchDisassociateProjectAssets(Consumer<BatchDisassociateProjectAssetsRequest.Builder> batchDisassociateProjectAssetsRequest)
Disassociates a group (batch) of assets from an AWS IoT SiteWise Monitor project.
|
default CompletableFuture<BatchPutAssetPropertyValueResponse> |
batchPutAssetPropertyValue(BatchPutAssetPropertyValueRequest batchPutAssetPropertyValueRequest)
Sends a list of asset property values to AWS IoT SiteWise.
|
default CompletableFuture<BatchPutAssetPropertyValueResponse> |
batchPutAssetPropertyValue(Consumer<BatchPutAssetPropertyValueRequest.Builder> batchPutAssetPropertyValueRequest)
Sends a list of asset property values to AWS IoT SiteWise.
|
static IoTSiteWiseAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
IoTSiteWiseAsyncClient. |
static IoTSiteWiseAsyncClient |
create()
Create a
IoTSiteWiseAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<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 CompletableFuture<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 CompletableFuture<CreateAssetResponse> |
createAsset(Consumer<CreateAssetRequest.Builder> createAssetRequest)
Creates an asset from an existing asset model.
|
default CompletableFuture<CreateAssetResponse> |
createAsset(CreateAssetRequest createAssetRequest)
Creates an asset from an existing asset model.
|
default CompletableFuture<CreateAssetModelResponse> |
createAssetModel(Consumer<CreateAssetModelRequest.Builder> createAssetModelRequest)
Creates an asset model from specified property and hierarchy definitions.
|
default CompletableFuture<CreateAssetModelResponse> |
createAssetModel(CreateAssetModelRequest createAssetModelRequest)
Creates an asset model from specified property and hierarchy definitions.
|
default CompletableFuture<CreateDashboardResponse> |
createDashboard(Consumer<CreateDashboardRequest.Builder> createDashboardRequest)
Creates a dashboard in an AWS IoT SiteWise Monitor project.
|
default CompletableFuture<CreateDashboardResponse> |
createDashboard(CreateDashboardRequest createDashboardRequest)
Creates a dashboard in an AWS IoT SiteWise Monitor project.
|
default CompletableFuture<CreateGatewayResponse> |
createGateway(Consumer<CreateGatewayRequest.Builder> createGatewayRequest)
Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to
AWS IoT SiteWise.
|
default CompletableFuture<CreateGatewayResponse> |
createGateway(CreateGatewayRequest createGatewayRequest)
Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to
AWS IoT SiteWise.
|
default CompletableFuture<CreatePortalResponse> |
createPortal(Consumer<CreatePortalRequest.Builder> createPortalRequest)
Creates a portal, which can contain projects and dashboards.
|
default CompletableFuture<CreatePortalResponse> |
createPortal(CreatePortalRequest createPortalRequest)
Creates a portal, which can contain projects and dashboards.
|
default CompletableFuture<CreateProjectResponse> |
createProject(Consumer<CreateProjectRequest.Builder> createProjectRequest)
Creates a project in the specified portal.
|
default CompletableFuture<CreateProjectResponse> |
createProject(CreateProjectRequest createProjectRequest)
Creates a project in the specified portal.
|
default CompletableFuture<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 CompletableFuture<DeleteAccessPolicyResponse> |
deleteAccessPolicy(DeleteAccessPolicyRequest deleteAccessPolicyRequest)
Deletes an access policy that grants the specified identity access to the specified AWS IoT SiteWise Monitor
resource.
|
default CompletableFuture<DeleteAssetResponse> |
deleteAsset(Consumer<DeleteAssetRequest.Builder> deleteAssetRequest)
Deletes an asset.
|
default CompletableFuture<DeleteAssetResponse> |
deleteAsset(DeleteAssetRequest deleteAssetRequest)
Deletes an asset.
|
default CompletableFuture<DeleteAssetModelResponse> |
deleteAssetModel(Consumer<DeleteAssetModelRequest.Builder> deleteAssetModelRequest)
Deletes an asset model.
|
default CompletableFuture<DeleteAssetModelResponse> |
deleteAssetModel(DeleteAssetModelRequest deleteAssetModelRequest)
Deletes an asset model.
|
default CompletableFuture<DeleteDashboardResponse> |
deleteDashboard(Consumer<DeleteDashboardRequest.Builder> deleteDashboardRequest)
Deletes a dashboard from AWS IoT SiteWise Monitor.
|
default CompletableFuture<DeleteDashboardResponse> |
deleteDashboard(DeleteDashboardRequest deleteDashboardRequest)
Deletes a dashboard from AWS IoT SiteWise Monitor.
|
default CompletableFuture<DeleteGatewayResponse> |
deleteGateway(Consumer<DeleteGatewayRequest.Builder> deleteGatewayRequest)
Deletes a gateway from AWS IoT SiteWise.
|
default CompletableFuture<DeleteGatewayResponse> |
deleteGateway(DeleteGatewayRequest deleteGatewayRequest)
Deletes a gateway from AWS IoT SiteWise.
|
default CompletableFuture<DeletePortalResponse> |
deletePortal(Consumer<DeletePortalRequest.Builder> deletePortalRequest)
Deletes a portal from AWS IoT SiteWise Monitor.
|
default CompletableFuture<DeletePortalResponse> |
deletePortal(DeletePortalRequest deletePortalRequest)
Deletes a portal from AWS IoT SiteWise Monitor.
|
default CompletableFuture<DeleteProjectResponse> |
deleteProject(Consumer<DeleteProjectRequest.Builder> deleteProjectRequest)
Deletes a project from AWS IoT SiteWise Monitor.
|
default CompletableFuture<DeleteProjectResponse> |
deleteProject(DeleteProjectRequest deleteProjectRequest)
Deletes a project from AWS IoT SiteWise Monitor.
|
default CompletableFuture<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 CompletableFuture<DescribeAccessPolicyResponse> |
describeAccessPolicy(DescribeAccessPolicyRequest describeAccessPolicyRequest)
Describes an access policy, which specifies an identity's access to an AWS IoT SiteWise Monitor portal or
project.
|
default CompletableFuture<DescribeAssetResponse> |
describeAsset(Consumer<DescribeAssetRequest.Builder> describeAssetRequest)
Retrieves information about an asset.
|
default CompletableFuture<DescribeAssetResponse> |
describeAsset(DescribeAssetRequest describeAssetRequest)
Retrieves information about an asset.
|
default CompletableFuture<DescribeAssetModelResponse> |
describeAssetModel(Consumer<DescribeAssetModelRequest.Builder> describeAssetModelRequest)
Retrieves information about an asset model.
|
default CompletableFuture<DescribeAssetModelResponse> |
describeAssetModel(DescribeAssetModelRequest describeAssetModelRequest)
Retrieves information about an asset model.
|
default CompletableFuture<DescribeAssetPropertyResponse> |
describeAssetProperty(Consumer<DescribeAssetPropertyRequest.Builder> describeAssetPropertyRequest)
Retrieves information about an asset property.
|
default CompletableFuture<DescribeAssetPropertyResponse> |
describeAssetProperty(DescribeAssetPropertyRequest describeAssetPropertyRequest)
Retrieves information about an asset property.
|
default CompletableFuture<DescribeDashboardResponse> |
describeDashboard(Consumer<DescribeDashboardRequest.Builder> describeDashboardRequest)
Retrieves information about a dashboard.
|
default CompletableFuture<DescribeDashboardResponse> |
describeDashboard(DescribeDashboardRequest describeDashboardRequest)
Retrieves information about a dashboard.
|
default CompletableFuture<DescribeDefaultEncryptionConfigurationResponse> |
describeDefaultEncryptionConfiguration(Consumer<DescribeDefaultEncryptionConfigurationRequest.Builder> describeDefaultEncryptionConfigurationRequest)
Retrieves information about the default encryption configuration for the AWS account in the default or specified
region.
|
default CompletableFuture<DescribeDefaultEncryptionConfigurationResponse> |
describeDefaultEncryptionConfiguration(DescribeDefaultEncryptionConfigurationRequest describeDefaultEncryptionConfigurationRequest)
Retrieves information about the default encryption configuration for the AWS account in the default or specified
region.
|
default CompletableFuture<DescribeGatewayResponse> |
describeGateway(Consumer<DescribeGatewayRequest.Builder> describeGatewayRequest)
Retrieves information about a gateway.
|
default CompletableFuture<DescribeGatewayResponse> |
describeGateway(DescribeGatewayRequest describeGatewayRequest)
Retrieves information about a gateway.
|
default CompletableFuture<DescribeGatewayCapabilityConfigurationResponse> |
describeGatewayCapabilityConfiguration(Consumer<DescribeGatewayCapabilityConfigurationRequest.Builder> describeGatewayCapabilityConfigurationRequest)
Retrieves information about a gateway capability configuration.
|
default CompletableFuture<DescribeGatewayCapabilityConfigurationResponse> |
describeGatewayCapabilityConfiguration(DescribeGatewayCapabilityConfigurationRequest describeGatewayCapabilityConfigurationRequest)
Retrieves information about a gateway capability configuration.
|
default CompletableFuture<DescribeLoggingOptionsResponse> |
describeLoggingOptions(Consumer<DescribeLoggingOptionsRequest.Builder> describeLoggingOptionsRequest)
Retrieves the current AWS IoT SiteWise logging options.
|
default CompletableFuture<DescribeLoggingOptionsResponse> |
describeLoggingOptions(DescribeLoggingOptionsRequest describeLoggingOptionsRequest)
Retrieves the current AWS IoT SiteWise logging options.
|
default CompletableFuture<DescribePortalResponse> |
describePortal(Consumer<DescribePortalRequest.Builder> describePortalRequest)
Retrieves information about a portal.
|
default CompletableFuture<DescribePortalResponse> |
describePortal(DescribePortalRequest describePortalRequest)
Retrieves information about a portal.
|
default CompletableFuture<DescribeProjectResponse> |
describeProject(Consumer<DescribeProjectRequest.Builder> describeProjectRequest)
Retrieves information about a project.
|
default CompletableFuture<DescribeProjectResponse> |
describeProject(DescribeProjectRequest describeProjectRequest)
Retrieves information about a project.
|
default CompletableFuture<DisassociateAssetsResponse> |
disassociateAssets(Consumer<DisassociateAssetsRequest.Builder> disassociateAssetsRequest)
Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model.
|
default CompletableFuture<DisassociateAssetsResponse> |
disassociateAssets(DisassociateAssetsRequest disassociateAssetsRequest)
Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model.
|
default CompletableFuture<GetAssetPropertyAggregatesResponse> |
getAssetPropertyAggregates(Consumer<GetAssetPropertyAggregatesRequest.Builder> getAssetPropertyAggregatesRequest)
Gets aggregated values for an asset property.
|
default CompletableFuture<GetAssetPropertyAggregatesResponse> |
getAssetPropertyAggregates(GetAssetPropertyAggregatesRequest getAssetPropertyAggregatesRequest)
Gets aggregated values for an asset property.
|
default GetAssetPropertyAggregatesPublisher |
getAssetPropertyAggregatesPaginator(Consumer<GetAssetPropertyAggregatesRequest.Builder> getAssetPropertyAggregatesRequest)
Gets aggregated values for an asset property.
|
default GetAssetPropertyAggregatesPublisher |
getAssetPropertyAggregatesPaginator(GetAssetPropertyAggregatesRequest getAssetPropertyAggregatesRequest)
Gets aggregated values for an asset property.
|
default CompletableFuture<GetAssetPropertyValueResponse> |
getAssetPropertyValue(Consumer<GetAssetPropertyValueRequest.Builder> getAssetPropertyValueRequest)
Gets an asset property's current value.
|
default CompletableFuture<GetAssetPropertyValueResponse> |
getAssetPropertyValue(GetAssetPropertyValueRequest getAssetPropertyValueRequest)
Gets an asset property's current value.
|
default CompletableFuture<GetAssetPropertyValueHistoryResponse> |
getAssetPropertyValueHistory(Consumer<GetAssetPropertyValueHistoryRequest.Builder> getAssetPropertyValueHistoryRequest)
Gets the history of an asset property's values.
|
default CompletableFuture<GetAssetPropertyValueHistoryResponse> |
getAssetPropertyValueHistory(GetAssetPropertyValueHistoryRequest getAssetPropertyValueHistoryRequest)
Gets the history of an asset property's values.
|
default GetAssetPropertyValueHistoryPublisher |
getAssetPropertyValueHistoryPaginator(Consumer<GetAssetPropertyValueHistoryRequest.Builder> getAssetPropertyValueHistoryRequest)
Gets the history of an asset property's values.
|
default GetAssetPropertyValueHistoryPublisher |
getAssetPropertyValueHistoryPaginator(GetAssetPropertyValueHistoryRequest getAssetPropertyValueHistoryRequest)
Gets the history of an asset property's values.
|
default CompletableFuture<GetInterpolatedAssetPropertyValuesResponse> |
getInterpolatedAssetPropertyValues(Consumer<GetInterpolatedAssetPropertyValuesRequest.Builder> getInterpolatedAssetPropertyValuesRequest)
Get interpolated values for an asset property for a specified time interval, during a period of time.
|
default CompletableFuture<GetInterpolatedAssetPropertyValuesResponse> |
getInterpolatedAssetPropertyValues(GetInterpolatedAssetPropertyValuesRequest getInterpolatedAssetPropertyValuesRequest)
Get interpolated values for an asset property for a specified time interval, during a period of time.
|
default GetInterpolatedAssetPropertyValuesPublisher |
getInterpolatedAssetPropertyValuesPaginator(Consumer<GetInterpolatedAssetPropertyValuesRequest.Builder> getInterpolatedAssetPropertyValuesRequest)
Get interpolated values for an asset property for a specified time interval, during a period of time.
|
default GetInterpolatedAssetPropertyValuesPublisher |
getInterpolatedAssetPropertyValuesPaginator(GetInterpolatedAssetPropertyValuesRequest getInterpolatedAssetPropertyValuesRequest)
Get interpolated values for an asset property for a specified time interval, during a period of time.
|
default CompletableFuture<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 CompletableFuture<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 ListAccessPoliciesPublisher |
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 ListAccessPoliciesPublisher |
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 CompletableFuture<ListAssetModelsResponse> |
listAssetModels(Consumer<ListAssetModelsRequest.Builder> listAssetModelsRequest)
Retrieves a paginated list of summaries of all asset models.
|
default CompletableFuture<ListAssetModelsResponse> |
listAssetModels(ListAssetModelsRequest listAssetModelsRequest)
Retrieves a paginated list of summaries of all asset models.
|
default ListAssetModelsPublisher |
listAssetModelsPaginator(Consumer<ListAssetModelsRequest.Builder> listAssetModelsRequest)
Retrieves a paginated list of summaries of all asset models.
|
default ListAssetModelsPublisher |
listAssetModelsPaginator(ListAssetModelsRequest listAssetModelsRequest)
Retrieves a paginated list of summaries of all asset models.
|
default CompletableFuture<ListAssetRelationshipsResponse> |
listAssetRelationships(Consumer<ListAssetRelationshipsRequest.Builder> listAssetRelationshipsRequest)
Retrieves a paginated list of asset relationships for an asset.
|
default CompletableFuture<ListAssetRelationshipsResponse> |
listAssetRelationships(ListAssetRelationshipsRequest listAssetRelationshipsRequest)
Retrieves a paginated list of asset relationships for an asset.
|
default ListAssetRelationshipsPublisher |
listAssetRelationshipsPaginator(Consumer<ListAssetRelationshipsRequest.Builder> listAssetRelationshipsRequest)
Retrieves a paginated list of asset relationships for an asset.
|
default ListAssetRelationshipsPublisher |
listAssetRelationshipsPaginator(ListAssetRelationshipsRequest listAssetRelationshipsRequest)
Retrieves a paginated list of asset relationships for an asset.
|
default CompletableFuture<ListAssetsResponse> |
listAssets(Consumer<ListAssetsRequest.Builder> listAssetsRequest)
Retrieves a paginated list of asset summaries.
|
default CompletableFuture<ListAssetsResponse> |
listAssets(ListAssetsRequest listAssetsRequest)
Retrieves a paginated list of asset summaries.
|
default ListAssetsPublisher |
listAssetsPaginator(Consumer<ListAssetsRequest.Builder> listAssetsRequest)
Retrieves a paginated list of asset summaries.
|
default ListAssetsPublisher |
listAssetsPaginator(ListAssetsRequest listAssetsRequest)
Retrieves a paginated list of asset summaries.
|
default CompletableFuture<ListAssociatedAssetsResponse> |
listAssociatedAssets(Consumer<ListAssociatedAssetsRequest.Builder> listAssociatedAssetsRequest)
Retrieves a paginated list of associated assets.
|
default CompletableFuture<ListAssociatedAssetsResponse> |
listAssociatedAssets(ListAssociatedAssetsRequest listAssociatedAssetsRequest)
Retrieves a paginated list of associated assets.
|
default ListAssociatedAssetsPublisher |
listAssociatedAssetsPaginator(Consumer<ListAssociatedAssetsRequest.Builder> listAssociatedAssetsRequest)
Retrieves a paginated list of associated assets.
|
default ListAssociatedAssetsPublisher |
listAssociatedAssetsPaginator(ListAssociatedAssetsRequest listAssociatedAssetsRequest)
Retrieves a paginated list of associated assets.
|
default CompletableFuture<ListDashboardsResponse> |
listDashboards(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest)
Retrieves a paginated list of dashboards for an AWS IoT SiteWise Monitor project.
|
default CompletableFuture<ListDashboardsResponse> |
listDashboards(ListDashboardsRequest listDashboardsRequest)
Retrieves a paginated list of dashboards for an AWS IoT SiteWise Monitor project.
|
default ListDashboardsPublisher |
listDashboardsPaginator(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest)
Retrieves a paginated list of dashboards for an AWS IoT SiteWise Monitor project.
|
default ListDashboardsPublisher |
listDashboardsPaginator(ListDashboardsRequest listDashboardsRequest)
Retrieves a paginated list of dashboards for an AWS IoT SiteWise Monitor project.
|
default CompletableFuture<ListGatewaysResponse> |
listGateways(Consumer<ListGatewaysRequest.Builder> listGatewaysRequest)
Retrieves a paginated list of gateways.
|
default CompletableFuture<ListGatewaysResponse> |
listGateways(ListGatewaysRequest listGatewaysRequest)
Retrieves a paginated list of gateways.
|
default ListGatewaysPublisher |
listGatewaysPaginator(Consumer<ListGatewaysRequest.Builder> listGatewaysRequest)
Retrieves a paginated list of gateways.
|
default ListGatewaysPublisher |
listGatewaysPaginator(ListGatewaysRequest listGatewaysRequest)
Retrieves a paginated list of gateways.
|
default CompletableFuture<ListPortalsResponse> |
listPortals(Consumer<ListPortalsRequest.Builder> listPortalsRequest)
Retrieves a paginated list of AWS IoT SiteWise Monitor portals.
|
default CompletableFuture<ListPortalsResponse> |
listPortals(ListPortalsRequest listPortalsRequest)
Retrieves a paginated list of AWS IoT SiteWise Monitor portals.
|
default ListPortalsPublisher |
listPortalsPaginator(Consumer<ListPortalsRequest.Builder> listPortalsRequest)
Retrieves a paginated list of AWS IoT SiteWise Monitor portals.
|
default ListPortalsPublisher |
listPortalsPaginator(ListPortalsRequest listPortalsRequest)
Retrieves a paginated list of AWS IoT SiteWise Monitor portals.
|
default CompletableFuture<ListProjectAssetsResponse> |
listProjectAssets(Consumer<ListProjectAssetsRequest.Builder> listProjectAssetsRequest)
Retrieves a paginated list of assets associated with an AWS IoT SiteWise Monitor project.
|
default CompletableFuture<ListProjectAssetsResponse> |
listProjectAssets(ListProjectAssetsRequest listProjectAssetsRequest)
Retrieves a paginated list of assets associated with an AWS IoT SiteWise Monitor project.
|
default ListProjectAssetsPublisher |
listProjectAssetsPaginator(Consumer<ListProjectAssetsRequest.Builder> listProjectAssetsRequest)
Retrieves a paginated list of assets associated with an AWS IoT SiteWise Monitor project.
|
default ListProjectAssetsPublisher |
listProjectAssetsPaginator(ListProjectAssetsRequest listProjectAssetsRequest)
Retrieves a paginated list of assets associated with an AWS IoT SiteWise Monitor project.
|
default CompletableFuture<ListProjectsResponse> |
listProjects(Consumer<ListProjectsRequest.Builder> listProjectsRequest)
Retrieves a paginated list of projects for an AWS IoT SiteWise Monitor portal.
|
default CompletableFuture<ListProjectsResponse> |
listProjects(ListProjectsRequest listProjectsRequest)
Retrieves a paginated list of projects for an AWS IoT SiteWise Monitor portal.
|
default ListProjectsPublisher |
listProjectsPaginator(Consumer<ListProjectsRequest.Builder> listProjectsRequest)
Retrieves a paginated list of projects for an AWS IoT SiteWise Monitor portal.
|
default ListProjectsPublisher |
listProjectsPaginator(ListProjectsRequest listProjectsRequest)
Retrieves a paginated list of projects for an AWS IoT SiteWise Monitor portal.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Retrieves the list of tags for an AWS IoT SiteWise resource.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Retrieves the list of tags for an AWS IoT SiteWise resource.
|
default CompletableFuture<PutDefaultEncryptionConfigurationResponse> |
putDefaultEncryptionConfiguration(Consumer<PutDefaultEncryptionConfigurationRequest.Builder> putDefaultEncryptionConfigurationRequest)
Sets the default encryption configuration for the AWS account.
|
default CompletableFuture<PutDefaultEncryptionConfigurationResponse> |
putDefaultEncryptionConfiguration(PutDefaultEncryptionConfigurationRequest putDefaultEncryptionConfigurationRequest)
Sets the default encryption configuration for the AWS account.
|
default CompletableFuture<PutLoggingOptionsResponse> |
putLoggingOptions(Consumer<PutLoggingOptionsRequest.Builder> putLoggingOptionsRequest)
Sets logging options for AWS IoT SiteWise.
|
default CompletableFuture<PutLoggingOptionsResponse> |
putLoggingOptions(PutLoggingOptionsRequest putLoggingOptionsRequest)
Sets logging options for AWS IoT SiteWise.
|
default CompletableFuture<TagResourceResponse> |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds tags to an AWS IoT SiteWise resource.
|
default CompletableFuture<TagResourceResponse> |
tagResource(TagResourceRequest tagResourceRequest)
Adds tags to an AWS IoT SiteWise resource.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes a tag from an AWS IoT SiteWise resource.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag from an AWS IoT SiteWise resource.
|
default CompletableFuture<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 CompletableFuture<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 CompletableFuture<UpdateAssetResponse> |
updateAsset(Consumer<UpdateAssetRequest.Builder> updateAssetRequest)
Updates an asset's name.
|
default CompletableFuture<UpdateAssetResponse> |
updateAsset(UpdateAssetRequest updateAssetRequest)
Updates an asset's name.
|
default CompletableFuture<UpdateAssetModelResponse> |
updateAssetModel(Consumer<UpdateAssetModelRequest.Builder> updateAssetModelRequest)
Updates an asset model and all of the assets that were created from the model.
|
default CompletableFuture<UpdateAssetModelResponse> |
updateAssetModel(UpdateAssetModelRequest updateAssetModelRequest)
Updates an asset model and all of the assets that were created from the model.
|
default CompletableFuture<UpdateAssetPropertyResponse> |
updateAssetProperty(Consumer<UpdateAssetPropertyRequest.Builder> updateAssetPropertyRequest)
Updates an asset property's alias and notification state.
|
default CompletableFuture<UpdateAssetPropertyResponse> |
updateAssetProperty(UpdateAssetPropertyRequest updateAssetPropertyRequest)
Updates an asset property's alias and notification state.
|
default CompletableFuture<UpdateDashboardResponse> |
updateDashboard(Consumer<UpdateDashboardRequest.Builder> updateDashboardRequest)
Updates an AWS IoT SiteWise Monitor dashboard.
|
default CompletableFuture<UpdateDashboardResponse> |
updateDashboard(UpdateDashboardRequest updateDashboardRequest)
Updates an AWS IoT SiteWise Monitor dashboard.
|
default CompletableFuture<UpdateGatewayResponse> |
updateGateway(Consumer<UpdateGatewayRequest.Builder> updateGatewayRequest)
Updates a gateway's name.
|
default CompletableFuture<UpdateGatewayResponse> |
updateGateway(UpdateGatewayRequest updateGatewayRequest)
Updates a gateway's name.
|
default CompletableFuture<UpdateGatewayCapabilityConfigurationResponse> |
updateGatewayCapabilityConfiguration(Consumer<UpdateGatewayCapabilityConfigurationRequest.Builder> updateGatewayCapabilityConfigurationRequest)
Updates a gateway capability configuration or defines a new capability configuration.
|
default CompletableFuture<UpdateGatewayCapabilityConfigurationResponse> |
updateGatewayCapabilityConfiguration(UpdateGatewayCapabilityConfigurationRequest updateGatewayCapabilityConfigurationRequest)
Updates a gateway capability configuration or defines a new capability configuration.
|
default CompletableFuture<UpdatePortalResponse> |
updatePortal(Consumer<UpdatePortalRequest.Builder> updatePortalRequest)
Updates an AWS IoT SiteWise Monitor portal.
|
default CompletableFuture<UpdatePortalResponse> |
updatePortal(UpdatePortalRequest updatePortalRequest)
Updates an AWS IoT SiteWise Monitor portal.
|
default CompletableFuture<UpdateProjectResponse> |
updateProject(Consumer<UpdateProjectRequest.Builder> updateProjectRequest)
Updates an AWS IoT SiteWise Monitor project.
|
default CompletableFuture<UpdateProjectResponse> |
updateProject(UpdateProjectRequest updateProjectRequest)
Updates an AWS IoT SiteWise Monitor project.
|
default IoTSiteWiseAsyncWaiter |
waiter()
Create an instance of
IoTSiteWiseAsyncWaiter using this client. |
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static IoTSiteWiseAsyncClient create()
IoTSiteWiseAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static IoTSiteWiseAsyncClientBuilder builder()
IoTSiteWiseAsyncClient.default CompletableFuture<AssociateAssetsResponse> associateAssets(AssociateAssetsRequest associateAssetsRequest)
Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's model. For more information, see Associating assets in the AWS IoT SiteWise User Guide.
associateAssetsRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<AssociateAssetsResponse> associateAssets(Consumer<AssociateAssetsRequest.Builder> associateAssetsRequest)
Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's model. For more information, see Associating assets in the 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.For more information, see Quotas in the AWS IoT SiteWise User Guide.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<BatchAssociateProjectAssetsResponse> batchAssociateProjectAssets(BatchAssociateProjectAssetsRequest batchAssociateProjectAssetsRequest)
Associates a group (batch) of assets with an AWS IoT SiteWise Monitor project.
batchAssociateProjectAssetsRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<BatchAssociateProjectAssetsResponse> batchAssociateProjectAssets(Consumer<BatchAssociateProjectAssetsRequest.Builder> batchAssociateProjectAssetsRequest)
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.For more information, see Quotas in the AWS IoT SiteWise User Guide.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<BatchDisassociateProjectAssetsResponse> batchDisassociateProjectAssets(BatchDisassociateProjectAssetsRequest batchDisassociateProjectAssetsRequest)
Disassociates a group (batch) of assets from an AWS IoT SiteWise Monitor project.
batchDisassociateProjectAssetsRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<BatchDisassociateProjectAssetsResponse> batchDisassociateProjectAssets(Consumer<BatchDisassociateProjectAssetsRequest.Builder> batchDisassociateProjectAssetsRequest)
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.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<BatchPutAssetPropertyValueResponse> batchPutAssetPropertyValue(BatchPutAssetPropertyValueRequest batchPutAssetPropertyValueRequest)
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 - For more information, see Quotas in the AWS IoT SiteWise User Guide.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<BatchPutAssetPropertyValueResponse> batchPutAssetPropertyValue(Consumer<BatchPutAssetPropertyValueRequest.Builder> batchPutAssetPropertyValueRequest)
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.For more information, see Quotas in the AWS IoT SiteWise User Guide.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<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.
createAccessPolicyRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<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.
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.For more information, see Quotas in the AWS IoT SiteWise User Guide.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<CreateAssetResponse> createAsset(CreateAssetRequest createAssetRequest)
Creates an asset from an existing asset model. For more information, see Creating assets in the AWS IoT SiteWise User Guide.
createAssetRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<CreateAssetResponse> createAsset(Consumer<CreateAssetRequest.Builder> createAssetRequest)
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.For more information, see Quotas in the AWS IoT SiteWise User Guide.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<CreateAssetModelResponse> createAssetModel(CreateAssetModelRequest createAssetModelRequest)
Creates an asset model from specified property and hierarchy definitions. You create assets from asset models. With asset models, you can easily create assets of the same type that have standardized definitions. Each asset created from a model inherits the asset model's property and hierarchy definitions. For more information, see Defining asset models in the AWS IoT SiteWise User Guide.
createAssetModelRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<CreateAssetModelResponse> createAssetModel(Consumer<CreateAssetModelRequest.Builder> createAssetModelRequest)
Creates an asset model from specified property and hierarchy definitions. You create assets from asset models. With asset models, you can easily create assets of the same type that have standardized definitions. Each asset created from a model inherits the asset model's property and hierarchy definitions. For more information, see Defining asset models in the 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.For more information, see Quotas in the AWS IoT SiteWise User Guide.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<CreateDashboardResponse> createDashboard(CreateDashboardRequest createDashboardRequest)
Creates a dashboard in an AWS IoT SiteWise Monitor project.
createDashboardRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<CreateDashboardResponse> createDashboard(Consumer<CreateDashboardRequest.Builder> createDashboardRequest)
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.For more information, see Quotas in the AWS IoT SiteWise User Guide.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<CreateGatewayResponse> createGateway(CreateGatewayRequest createGatewayRequest)
Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to AWS IoT SiteWise. For more information, see Ingesting data using a gateway in the AWS IoT SiteWise User Guide.
createGatewayRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<CreateGatewayResponse> createGateway(Consumer<CreateGatewayRequest.Builder> createGatewayRequest)
Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to 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.For more information, see Quotas in the AWS IoT SiteWise User Guide.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<CreatePortalResponse> createPortal(CreatePortalRequest createPortalRequest)
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 - For more information, see Quotas in the AWS IoT SiteWise User Guide.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<CreatePortalResponse> createPortal(Consumer<CreatePortalRequest.Builder> createPortalRequest)
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.For more information, see Quotas in the AWS IoT SiteWise User Guide.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<CreateProjectResponse> createProject(CreateProjectRequest createProjectRequest)
Creates a project in the specified portal.
createProjectRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<CreateProjectResponse> createProject(Consumer<CreateProjectRequest.Builder> createProjectRequest)
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.For more information, see Quotas in the AWS IoT SiteWise User Guide.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<DeleteAccessPolicyResponse> deleteAccessPolicy(DeleteAccessPolicyRequest deleteAccessPolicyRequest)
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 - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<DeleteAccessPolicyResponse> deleteAccessPolicy(Consumer<DeleteAccessPolicyRequest.Builder> deleteAccessPolicyRequest)
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.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<DeleteAssetResponse> deleteAsset(DeleteAssetRequest deleteAssetRequest)
Deletes an asset. This action can't be undone. For more information, see Deleting assets and models in the AWS IoT SiteWise User Guide.
You can't delete an asset that's associated to another asset. For more information, see DisassociateAssets.
deleteAssetRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<DeleteAssetResponse> deleteAsset(Consumer<DeleteAssetRequest.Builder> deleteAssetRequest)
Deletes an asset. This action can't be undone. For more information, see Deleting assets and models in the 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.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<DeleteAssetModelResponse> deleteAssetModel(DeleteAssetModelRequest deleteAssetModelRequest)
Deletes an asset model. This action can't be undone. You must delete all assets created from an asset model before you can delete the model. Also, you can't delete an asset model if a parent asset model exists that contains a property formula expression that depends on the asset model that you want to delete. For more information, see Deleting assets and models in the AWS IoT SiteWise User Guide.
deleteAssetModelRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<DeleteAssetModelResponse> deleteAssetModel(Consumer<DeleteAssetModelRequest.Builder> deleteAssetModelRequest)
Deletes an asset model. This action can't be undone. You must delete all assets created from an asset model before you can delete the model. Also, you can't delete an asset model if a parent asset model exists that contains a property formula expression that depends on the asset model that you want to delete. For more information, see Deleting assets and models in the 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.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<DeleteDashboardResponse> deleteDashboard(DeleteDashboardRequest deleteDashboardRequest)
Deletes a dashboard from AWS IoT SiteWise Monitor.
deleteDashboardRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<DeleteDashboardResponse> deleteDashboard(Consumer<DeleteDashboardRequest.Builder> deleteDashboardRequest)
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.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<DeleteGatewayResponse> deleteGateway(DeleteGatewayRequest deleteGatewayRequest)
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 - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<DeleteGatewayResponse> deleteGateway(Consumer<DeleteGatewayRequest.Builder> deleteGatewayRequest)
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.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<DeletePortalResponse> deletePortal(DeletePortalRequest deletePortalRequest)
Deletes a portal from AWS IoT SiteWise Monitor.
deletePortalRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<DeletePortalResponse> deletePortal(Consumer<DeletePortalRequest.Builder> deletePortalRequest)
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.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<DeleteProjectResponse> deleteProject(DeleteProjectRequest deleteProjectRequest)
Deletes a project from AWS IoT SiteWise Monitor.
deleteProjectRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<DeleteProjectResponse> deleteProject(Consumer<DeleteProjectRequest.Builder> deleteProjectRequest)
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.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<DescribeAccessPolicyResponse> describeAccessPolicy(DescribeAccessPolicyRequest describeAccessPolicyRequest)
Describes an access policy, which specifies an identity's access to an AWS IoT SiteWise Monitor portal or project.
describeAccessPolicyRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<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.
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.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<DescribeAssetResponse> describeAsset(DescribeAssetRequest describeAssetRequest)
Retrieves information about an asset.
describeAssetRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<DescribeAssetResponse> describeAsset(Consumer<DescribeAssetRequest.Builder> describeAssetRequest)
Retrieves information about an asset.
This is a convenience which creates an instance of the DescribeAssetRequest.Builder avoiding the need to
create one manually via DescribeAssetRequest.builder()
describeAssetRequest - A Consumer that will call methods on DescribeAssetRequest.Builder to create a request.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<DescribeAssetModelResponse> describeAssetModel(DescribeAssetModelRequest describeAssetModelRequest)
Retrieves information about an asset model.
describeAssetModelRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<DescribeAssetModelResponse> describeAssetModel(Consumer<DescribeAssetModelRequest.Builder> describeAssetModelRequest)
Retrieves information about an asset model.
This is a convenience which creates an instance of the DescribeAssetModelRequest.Builder avoiding the
need to create one manually via DescribeAssetModelRequest.builder()
describeAssetModelRequest - A Consumer that will call methods on DescribeAssetModelRequest.Builder to create a
request.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<DescribeAssetPropertyResponse> describeAssetProperty(DescribeAssetPropertyRequest describeAssetPropertyRequest)
Retrieves information about an asset property.
When you call this operation for an attribute property, this response includes the default attribute value that you define in the asset model. If you update the default value in the model, this operation's response includes the new default value.
This operation doesn't return the value of the asset property. To get the value of an asset property, use GetAssetPropertyValue.
describeAssetPropertyRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<DescribeAssetPropertyResponse> describeAssetProperty(Consumer<DescribeAssetPropertyRequest.Builder> describeAssetPropertyRequest)
Retrieves information about an asset property.
When you call this operation for an attribute property, this response includes the default attribute value that you define in the asset model. If you update the default value in the model, this operation's response includes the new default value.
This operation doesn't return the value of the asset property. To get the value of an asset property, use GetAssetPropertyValue.
This is a convenience which creates an instance of the DescribeAssetPropertyRequest.Builder avoiding the
need to create one manually via DescribeAssetPropertyRequest.builder()
describeAssetPropertyRequest - A Consumer that will call methods on DescribeAssetPropertyRequest.Builder to create a
request.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<DescribeDashboardResponse> describeDashboard(DescribeDashboardRequest describeDashboardRequest)
Retrieves information about a dashboard.
describeDashboardRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<DescribeDashboardResponse> describeDashboard(Consumer<DescribeDashboardRequest.Builder> describeDashboardRequest)
Retrieves information about a dashboard.
This is a convenience which creates an instance of the DescribeDashboardRequest.Builder avoiding the need
to create one manually via DescribeDashboardRequest.builder()
describeDashboardRequest - A Consumer that will call methods on DescribeDashboardRequest.Builder to create a request.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<DescribeDefaultEncryptionConfigurationResponse> describeDefaultEncryptionConfiguration(DescribeDefaultEncryptionConfigurationRequest describeDefaultEncryptionConfigurationRequest)
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 - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<DescribeDefaultEncryptionConfigurationResponse> describeDefaultEncryptionConfiguration(Consumer<DescribeDefaultEncryptionConfigurationRequest.Builder> describeDefaultEncryptionConfigurationRequest)
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.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<DescribeGatewayResponse> describeGateway(DescribeGatewayRequest describeGatewayRequest)
Retrieves information about a gateway.
describeGatewayRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<DescribeGatewayResponse> describeGateway(Consumer<DescribeGatewayRequest.Builder> describeGatewayRequest)
Retrieves information about a gateway.
This is a convenience which creates an instance of the DescribeGatewayRequest.Builder avoiding the need
to create one manually via DescribeGatewayRequest.builder()
describeGatewayRequest - A Consumer that will call methods on DescribeGatewayRequest.Builder to create a request.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<DescribeGatewayCapabilityConfigurationResponse> describeGatewayCapabilityConfiguration(DescribeGatewayCapabilityConfigurationRequest describeGatewayCapabilityConfigurationRequest)
Retrieves information about a gateway capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the 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 - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<DescribeGatewayCapabilityConfigurationResponse> describeGatewayCapabilityConfiguration(Consumer<DescribeGatewayCapabilityConfigurationRequest.Builder> describeGatewayCapabilityConfigurationRequest)
Retrieves information about a gateway capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the 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.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<DescribeLoggingOptionsResponse> describeLoggingOptions(DescribeLoggingOptionsRequest describeLoggingOptionsRequest)
Retrieves the current AWS IoT SiteWise logging options.
describeLoggingOptionsRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<DescribeLoggingOptionsResponse> describeLoggingOptions(Consumer<DescribeLoggingOptionsRequest.Builder> describeLoggingOptionsRequest)
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.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<DescribePortalResponse> describePortal(DescribePortalRequest describePortalRequest)
Retrieves information about a portal.
describePortalRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<DescribePortalResponse> describePortal(Consumer<DescribePortalRequest.Builder> describePortalRequest)
Retrieves information about a portal.
This is a convenience which creates an instance of the DescribePortalRequest.Builder avoiding the need to
create one manually via DescribePortalRequest.builder()
describePortalRequest - A Consumer that will call methods on DescribePortalRequest.Builder to create a request.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<DescribeProjectResponse> describeProject(DescribeProjectRequest describeProjectRequest)
Retrieves information about a project.
describeProjectRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<DescribeProjectResponse> describeProject(Consumer<DescribeProjectRequest.Builder> describeProjectRequest)
Retrieves information about a project.
This is a convenience which creates an instance of the DescribeProjectRequest.Builder avoiding the need
to create one manually via DescribeProjectRequest.builder()
describeProjectRequest - A Consumer that will call methods on DescribeProjectRequest.Builder to create a request.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<DisassociateAssetsResponse> disassociateAssets(DisassociateAssetsRequest disassociateAssetsRequest)
Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model.
disassociateAssetsRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<DisassociateAssetsResponse> disassociateAssets(Consumer<DisassociateAssetsRequest.Builder> disassociateAssetsRequest)
Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model.
This is a convenience which creates an instance of the DisassociateAssetsRequest.Builder avoiding the
need to create one manually via DisassociateAssetsRequest.builder()
disassociateAssetsRequest - A Consumer that will call methods on DisassociateAssetsRequest.Builder to create a
request.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<GetAssetPropertyAggregatesResponse> getAssetPropertyAggregates(GetAssetPropertyAggregatesRequest getAssetPropertyAggregatesRequest)
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 - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<GetAssetPropertyAggregatesResponse> getAssetPropertyAggregates(Consumer<GetAssetPropertyAggregatesRequest.Builder> getAssetPropertyAggregatesRequest)
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.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default GetAssetPropertyAggregatesPublisher getAssetPropertyAggregatesPaginator(GetAssetPropertyAggregatesRequest getAssetPropertyAggregatesRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.iotsitewise.paginators.GetAssetPropertyAggregatesPublisher publisher = client.getAssetPropertyAggregatesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.iotsitewise.paginators.GetAssetPropertyAggregatesPublisher publisher = client.getAssetPropertyAggregatesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.GetAssetPropertyAggregatesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.iotsitewise.model.GetAssetPropertyAggregatesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getAssetPropertyAggregates(software.amazon.awssdk.services.iotsitewise.model.GetAssetPropertyAggregatesRequest)
operation.
getAssetPropertyAggregatesRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default GetAssetPropertyAggregatesPublisher getAssetPropertyAggregatesPaginator(Consumer<GetAssetPropertyAggregatesRequest.Builder> getAssetPropertyAggregatesRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.iotsitewise.paginators.GetAssetPropertyAggregatesPublisher publisher = client.getAssetPropertyAggregatesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.iotsitewise.paginators.GetAssetPropertyAggregatesPublisher publisher = client.getAssetPropertyAggregatesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.GetAssetPropertyAggregatesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.iotsitewise.model.GetAssetPropertyAggregatesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getAssetPropertyAggregates(software.amazon.awssdk.services.iotsitewise.model.GetAssetPropertyAggregatesRequest)
operation.
This is a convenience which creates an instance of the GetAssetPropertyAggregatesRequest.Builder avoiding
the need to create one manually via GetAssetPropertyAggregatesRequest.builder()
getAssetPropertyAggregatesRequest - A Consumer that will call methods on GetAssetPropertyAggregatesRequest.Builder to create a
request.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<GetAssetPropertyValueResponse> getAssetPropertyValue(GetAssetPropertyValueRequest getAssetPropertyValueRequest)
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 - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<GetAssetPropertyValueResponse> getAssetPropertyValue(Consumer<GetAssetPropertyValueRequest.Builder> getAssetPropertyValueRequest)
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.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<GetAssetPropertyValueHistoryResponse> getAssetPropertyValueHistory(GetAssetPropertyValueHistoryRequest getAssetPropertyValueHistoryRequest)
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 - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<GetAssetPropertyValueHistoryResponse> getAssetPropertyValueHistory(Consumer<GetAssetPropertyValueHistoryRequest.Builder> getAssetPropertyValueHistoryRequest)
Gets the history of an asset property's values. For more information, see Querying historical values in the 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.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default GetAssetPropertyValueHistoryPublisher getAssetPropertyValueHistoryPaginator(GetAssetPropertyValueHistoryRequest getAssetPropertyValueHistoryRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.iotsitewise.paginators.GetAssetPropertyValueHistoryPublisher publisher = client.getAssetPropertyValueHistoryPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.iotsitewise.paginators.GetAssetPropertyValueHistoryPublisher publisher = client.getAssetPropertyValueHistoryPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.GetAssetPropertyValueHistoryResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.iotsitewise.model.GetAssetPropertyValueHistoryResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getAssetPropertyValueHistory(software.amazon.awssdk.services.iotsitewise.model.GetAssetPropertyValueHistoryRequest)
operation.
getAssetPropertyValueHistoryRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default GetAssetPropertyValueHistoryPublisher getAssetPropertyValueHistoryPaginator(Consumer<GetAssetPropertyValueHistoryRequest.Builder> getAssetPropertyValueHistoryRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.iotsitewise.paginators.GetAssetPropertyValueHistoryPublisher publisher = client.getAssetPropertyValueHistoryPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.iotsitewise.paginators.GetAssetPropertyValueHistoryPublisher publisher = client.getAssetPropertyValueHistoryPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.GetAssetPropertyValueHistoryResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.iotsitewise.model.GetAssetPropertyValueHistoryResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getAssetPropertyValueHistory(software.amazon.awssdk.services.iotsitewise.model.GetAssetPropertyValueHistoryRequest)
operation.
This is a convenience which creates an instance of the GetAssetPropertyValueHistoryRequest.Builder
avoiding the need to create one manually via GetAssetPropertyValueHistoryRequest.builder()
getAssetPropertyValueHistoryRequest - A Consumer that will call methods on GetAssetPropertyValueHistoryRequest.Builder to create
a request.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<GetInterpolatedAssetPropertyValuesResponse> getInterpolatedAssetPropertyValues(GetInterpolatedAssetPropertyValuesRequest getInterpolatedAssetPropertyValuesRequest)
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 - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<GetInterpolatedAssetPropertyValuesResponse> getInterpolatedAssetPropertyValues(Consumer<GetInterpolatedAssetPropertyValuesRequest.Builder> getInterpolatedAssetPropertyValuesRequest)
Get interpolated values for an asset property for a specified time interval, during a period of time. 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.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default GetInterpolatedAssetPropertyValuesPublisher getInterpolatedAssetPropertyValuesPaginator(GetInterpolatedAssetPropertyValuesRequest getInterpolatedAssetPropertyValuesRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.iotsitewise.paginators.GetInterpolatedAssetPropertyValuesPublisher publisher = client.getInterpolatedAssetPropertyValuesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.iotsitewise.paginators.GetInterpolatedAssetPropertyValuesPublisher publisher = client.getInterpolatedAssetPropertyValuesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.GetInterpolatedAssetPropertyValuesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.iotsitewise.model.GetInterpolatedAssetPropertyValuesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getInterpolatedAssetPropertyValues(software.amazon.awssdk.services.iotsitewise.model.GetInterpolatedAssetPropertyValuesRequest)
operation.
getInterpolatedAssetPropertyValuesRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default GetInterpolatedAssetPropertyValuesPublisher getInterpolatedAssetPropertyValuesPaginator(Consumer<GetInterpolatedAssetPropertyValuesRequest.Builder> getInterpolatedAssetPropertyValuesRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.iotsitewise.paginators.GetInterpolatedAssetPropertyValuesPublisher publisher = client.getInterpolatedAssetPropertyValuesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.iotsitewise.paginators.GetInterpolatedAssetPropertyValuesPublisher publisher = client.getInterpolatedAssetPropertyValuesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.GetInterpolatedAssetPropertyValuesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.iotsitewise.model.GetInterpolatedAssetPropertyValuesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getInterpolatedAssetPropertyValues(software.amazon.awssdk.services.iotsitewise.model.GetInterpolatedAssetPropertyValuesRequest)
operation.
This is a convenience which creates an instance of the GetInterpolatedAssetPropertyValuesRequest.Builder
avoiding the need to create one manually via GetInterpolatedAssetPropertyValuesRequest.builder()
getInterpolatedAssetPropertyValuesRequest - A Consumer that will call methods on GetInterpolatedAssetPropertyValuesRequest.Builder to
create a request.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<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).
listAccessPoliciesRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<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).
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.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default ListAccessPoliciesPublisher 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).
This is a variant of
listAccessPolicies(software.amazon.awssdk.services.iotsitewise.model.ListAccessPoliciesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.iotsitewise.paginators.ListAccessPoliciesPublisher publisher = client.listAccessPoliciesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.iotsitewise.paginators.ListAccessPoliciesPublisher publisher = client.listAccessPoliciesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListAccessPoliciesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListAccessPoliciesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAccessPolicies(software.amazon.awssdk.services.iotsitewise.model.ListAccessPoliciesRequest)
operation.
listAccessPoliciesRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default ListAccessPoliciesPublisher 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).
This is a variant of
listAccessPolicies(software.amazon.awssdk.services.iotsitewise.model.ListAccessPoliciesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.iotsitewise.paginators.ListAccessPoliciesPublisher publisher = client.listAccessPoliciesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.iotsitewise.paginators.ListAccessPoliciesPublisher publisher = client.listAccessPoliciesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListAccessPoliciesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListAccessPoliciesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAccessPolicies(software.amazon.awssdk.services.iotsitewise.model.ListAccessPoliciesRequest)
operation.
This is a convenience which creates an instance of the ListAccessPoliciesRequest.Builder avoiding the
need to create one manually via ListAccessPoliciesRequest.builder()
listAccessPoliciesRequest - A Consumer that will call methods on ListAccessPoliciesRequest.Builder to create a
request.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<ListAssetModelsResponse> listAssetModels(ListAssetModelsRequest listAssetModelsRequest)
Retrieves a paginated list of summaries of all asset models.
listAssetModelsRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<ListAssetModelsResponse> listAssetModels(Consumer<ListAssetModelsRequest.Builder> listAssetModelsRequest)
Retrieves a paginated list of summaries of all asset models.
This is a convenience which creates an instance of the ListAssetModelsRequest.Builder avoiding the need
to create one manually via ListAssetModelsRequest.builder()
listAssetModelsRequest - A Consumer that will call methods on ListAssetModelsRequest.Builder to create a request.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default ListAssetModelsPublisher listAssetModelsPaginator(ListAssetModelsRequest listAssetModelsRequest)
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 publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.iotsitewise.paginators.ListAssetModelsPublisher publisher = client.listAssetModelsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.iotsitewise.paginators.ListAssetModelsPublisher publisher = client.listAssetModelsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListAssetModelsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListAssetModelsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssetModels(software.amazon.awssdk.services.iotsitewise.model.ListAssetModelsRequest) operation.
listAssetModelsRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default ListAssetModelsPublisher listAssetModelsPaginator(Consumer<ListAssetModelsRequest.Builder> listAssetModelsRequest)
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 publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.iotsitewise.paginators.ListAssetModelsPublisher publisher = client.listAssetModelsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.iotsitewise.paginators.ListAssetModelsPublisher publisher = client.listAssetModelsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListAssetModelsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListAssetModelsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssetModels(software.amazon.awssdk.services.iotsitewise.model.ListAssetModelsRequest) operation.
This is a convenience which creates an instance of the ListAssetModelsRequest.Builder avoiding the need
to create one manually via ListAssetModelsRequest.builder()
listAssetModelsRequest - A Consumer that will call methods on ListAssetModelsRequest.Builder to create a request.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<ListAssetRelationshipsResponse> listAssetRelationships(ListAssetRelationshipsRequest listAssetRelationshipsRequest)
Retrieves a paginated list of asset relationships for an asset. You can use this operation to identify an asset's root asset and all associated assets between that asset and its root.
listAssetRelationshipsRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<ListAssetRelationshipsResponse> listAssetRelationships(Consumer<ListAssetRelationshipsRequest.Builder> listAssetRelationshipsRequest)
Retrieves a paginated list of asset relationships for an asset. You can use this operation to identify an asset's root asset and all associated assets between that asset and its root.
This is a convenience which creates an instance of the ListAssetRelationshipsRequest.Builder avoiding the
need to create one manually via ListAssetRelationshipsRequest.builder()
listAssetRelationshipsRequest - A Consumer that will call methods on ListAssetRelationshipsRequest.Builder to create a
request.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default ListAssetRelationshipsPublisher listAssetRelationshipsPaginator(ListAssetRelationshipsRequest listAssetRelationshipsRequest)
Retrieves a paginated list of asset relationships for an asset. You can use this operation to identify an asset's root asset and all associated assets between that asset and its root.
This is a variant of
listAssetRelationships(software.amazon.awssdk.services.iotsitewise.model.ListAssetRelationshipsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.iotsitewise.paginators.ListAssetRelationshipsPublisher publisher = client.listAssetRelationshipsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.iotsitewise.paginators.ListAssetRelationshipsPublisher publisher = client.listAssetRelationshipsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListAssetRelationshipsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListAssetRelationshipsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssetRelationships(software.amazon.awssdk.services.iotsitewise.model.ListAssetRelationshipsRequest)
operation.
listAssetRelationshipsRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default ListAssetRelationshipsPublisher listAssetRelationshipsPaginator(Consumer<ListAssetRelationshipsRequest.Builder> listAssetRelationshipsRequest)
Retrieves a paginated list of asset relationships for an asset. You can use this operation to identify an asset's root asset and all associated assets between that asset and its root.
This is a variant of
listAssetRelationships(software.amazon.awssdk.services.iotsitewise.model.ListAssetRelationshipsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.iotsitewise.paginators.ListAssetRelationshipsPublisher publisher = client.listAssetRelationshipsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.iotsitewise.paginators.ListAssetRelationshipsPublisher publisher = client.listAssetRelationshipsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListAssetRelationshipsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListAssetRelationshipsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssetRelationships(software.amazon.awssdk.services.iotsitewise.model.ListAssetRelationshipsRequest)
operation.
This is a convenience which creates an instance of the ListAssetRelationshipsRequest.Builder avoiding the
need to create one manually via ListAssetRelationshipsRequest.builder()
listAssetRelationshipsRequest - A Consumer that will call methods on ListAssetRelationshipsRequest.Builder to create a
request.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<ListAssetsResponse> listAssets(ListAssetsRequest listAssetsRequest)
Retrieves a paginated list of asset summaries.
You can use this operation to do the following:
List assets based on a specific asset model.
List top-level assets.
You can't use this operation to list all assets. To retrieve summaries for all of your assets, use ListAssetModels to get all of your asset model IDs. Then, use ListAssets to get all assets for each asset model.
listAssetsRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<ListAssetsResponse> listAssets(Consumer<ListAssetsRequest.Builder> listAssetsRequest)
Retrieves a paginated list of asset summaries.
You can use this operation to do the following:
List assets based on a specific asset model.
List top-level assets.
You can't use this operation to list all assets. To retrieve summaries for all of your assets, use ListAssetModels to get all of your asset model IDs. Then, use ListAssets to get all assets for each asset model.
This is a convenience which creates an instance of the ListAssetsRequest.Builder avoiding the need to
create one manually via ListAssetsRequest.builder()
listAssetsRequest - A Consumer that will call methods on ListAssetsRequest.Builder to create a request.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default ListAssetsPublisher listAssetsPaginator(ListAssetsRequest listAssetsRequest)
Retrieves a paginated list of asset summaries.
You can use this operation to do the following:
List assets based on a specific asset model.
List top-level assets.
You can't use this operation to list all assets. To retrieve summaries for all of your assets, use ListAssetModels to get all of your asset model IDs. Then, use ListAssets to get all assets for each asset model.
This is a variant of listAssets(software.amazon.awssdk.services.iotsitewise.model.ListAssetsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.iotsitewise.paginators.ListAssetsPublisher publisher = client.listAssetsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.iotsitewise.paginators.ListAssetsPublisher publisher = client.listAssetsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListAssetsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListAssetsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssets(software.amazon.awssdk.services.iotsitewise.model.ListAssetsRequest) operation.
listAssetsRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default ListAssetsPublisher listAssetsPaginator(Consumer<ListAssetsRequest.Builder> listAssetsRequest)
Retrieves a paginated list of asset summaries.
You can use this operation to do the following:
List assets based on a specific asset model.
List top-level assets.
You can't use this operation to list all assets. To retrieve summaries for all of your assets, use ListAssetModels to get all of your asset model IDs. Then, use ListAssets to get all assets for each asset model.
This is a variant of listAssets(software.amazon.awssdk.services.iotsitewise.model.ListAssetsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.iotsitewise.paginators.ListAssetsPublisher publisher = client.listAssetsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.iotsitewise.paginators.ListAssetsPublisher publisher = client.listAssetsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListAssetsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListAssetsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssets(software.amazon.awssdk.services.iotsitewise.model.ListAssetsRequest) operation.
This is a convenience which creates an instance of the ListAssetsRequest.Builder avoiding the need to
create one manually via ListAssetsRequest.builder()
listAssetsRequest - A Consumer that will call methods on ListAssetsRequest.Builder to create a request.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<ListAssociatedAssetsResponse> listAssociatedAssets(ListAssociatedAssetsRequest listAssociatedAssetsRequest)
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 - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<ListAssociatedAssetsResponse> listAssociatedAssets(Consumer<ListAssociatedAssetsRequest.Builder> listAssociatedAssetsRequest)
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.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default ListAssociatedAssetsPublisher listAssociatedAssetsPaginator(ListAssociatedAssetsRequest listAssociatedAssetsRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.iotsitewise.paginators.ListAssociatedAssetsPublisher publisher = client.listAssociatedAssetsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.iotsitewise.paginators.ListAssociatedAssetsPublisher publisher = client.listAssociatedAssetsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListAssociatedAssetsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListAssociatedAssetsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssociatedAssets(software.amazon.awssdk.services.iotsitewise.model.ListAssociatedAssetsRequest)
operation.
listAssociatedAssetsRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default ListAssociatedAssetsPublisher listAssociatedAssetsPaginator(Consumer<ListAssociatedAssetsRequest.Builder> listAssociatedAssetsRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.iotsitewise.paginators.ListAssociatedAssetsPublisher publisher = client.listAssociatedAssetsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.iotsitewise.paginators.ListAssociatedAssetsPublisher publisher = client.listAssociatedAssetsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListAssociatedAssetsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListAssociatedAssetsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssociatedAssets(software.amazon.awssdk.services.iotsitewise.model.ListAssociatedAssetsRequest)
operation.
This is a convenience which creates an instance of the ListAssociatedAssetsRequest.Builder avoiding the
need to create one manually via ListAssociatedAssetsRequest.builder()
listAssociatedAssetsRequest - A Consumer that will call methods on ListAssociatedAssetsRequest.Builder to create a
request.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<ListDashboardsResponse> listDashboards(ListDashboardsRequest listDashboardsRequest)
Retrieves a paginated list of dashboards for an AWS IoT SiteWise Monitor project.
listDashboardsRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<ListDashboardsResponse> listDashboards(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest)
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.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default ListDashboardsPublisher listDashboardsPaginator(ListDashboardsRequest listDashboardsRequest)
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 publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.iotsitewise.paginators.ListDashboardsPublisher publisher = client.listDashboardsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.iotsitewise.paginators.ListDashboardsPublisher publisher = client.listDashboardsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListDashboardsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListDashboardsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDashboards(software.amazon.awssdk.services.iotsitewise.model.ListDashboardsRequest) operation.
listDashboardsRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default ListDashboardsPublisher listDashboardsPaginator(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest)
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 publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.iotsitewise.paginators.ListDashboardsPublisher publisher = client.listDashboardsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.iotsitewise.paginators.ListDashboardsPublisher publisher = client.listDashboardsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListDashboardsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListDashboardsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDashboards(software.amazon.awssdk.services.iotsitewise.model.ListDashboardsRequest) operation.
This is a convenience which creates an instance of the ListDashboardsRequest.Builder avoiding the need to
create one manually via ListDashboardsRequest.builder()
listDashboardsRequest - A Consumer that will call methods on ListDashboardsRequest.Builder to create a request.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<ListGatewaysResponse> listGateways(ListGatewaysRequest listGatewaysRequest)
Retrieves a paginated list of gateways.
listGatewaysRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<ListGatewaysResponse> listGateways(Consumer<ListGatewaysRequest.Builder> listGatewaysRequest)
Retrieves a paginated list of gateways.
This is a convenience which creates an instance of the ListGatewaysRequest.Builder avoiding the need to
create one manually via ListGatewaysRequest.builder()
listGatewaysRequest - A Consumer that will call methods on ListGatewaysRequest.Builder to create a request.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default ListGatewaysPublisher listGatewaysPaginator(ListGatewaysRequest listGatewaysRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.iotsitewise.paginators.ListGatewaysPublisher publisher = client.listGatewaysPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.iotsitewise.paginators.ListGatewaysPublisher publisher = client.listGatewaysPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListGatewaysResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListGatewaysResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGateways(software.amazon.awssdk.services.iotsitewise.model.ListGatewaysRequest) operation.
listGatewaysRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default ListGatewaysPublisher listGatewaysPaginator(Consumer<ListGatewaysRequest.Builder> listGatewaysRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.iotsitewise.paginators.ListGatewaysPublisher publisher = client.listGatewaysPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.iotsitewise.paginators.ListGatewaysPublisher publisher = client.listGatewaysPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListGatewaysResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListGatewaysResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGateways(software.amazon.awssdk.services.iotsitewise.model.ListGatewaysRequest) operation.
This is a convenience which creates an instance of the ListGatewaysRequest.Builder avoiding the need to
create one manually via ListGatewaysRequest.builder()
listGatewaysRequest - A Consumer that will call methods on ListGatewaysRequest.Builder to create a request.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<ListPortalsResponse> listPortals(ListPortalsRequest listPortalsRequest)
Retrieves a paginated list of AWS IoT SiteWise Monitor portals.
listPortalsRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<ListPortalsResponse> listPortals(Consumer<ListPortalsRequest.Builder> listPortalsRequest)
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.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default ListPortalsPublisher listPortalsPaginator(ListPortalsRequest listPortalsRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.iotsitewise.paginators.ListPortalsPublisher publisher = client.listPortalsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.iotsitewise.paginators.ListPortalsPublisher publisher = client.listPortalsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListPortalsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListPortalsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPortals(software.amazon.awssdk.services.iotsitewise.model.ListPortalsRequest) operation.
listPortalsRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default ListPortalsPublisher listPortalsPaginator(Consumer<ListPortalsRequest.Builder> listPortalsRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.iotsitewise.paginators.ListPortalsPublisher publisher = client.listPortalsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.iotsitewise.paginators.ListPortalsPublisher publisher = client.listPortalsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListPortalsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListPortalsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPortals(software.amazon.awssdk.services.iotsitewise.model.ListPortalsRequest) operation.
This is a convenience which creates an instance of the ListPortalsRequest.Builder avoiding the need to
create one manually via ListPortalsRequest.builder()
listPortalsRequest - A Consumer that will call methods on ListPortalsRequest.Builder to create a request.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<ListProjectAssetsResponse> listProjectAssets(ListProjectAssetsRequest listProjectAssetsRequest)
Retrieves a paginated list of assets associated with an AWS IoT SiteWise Monitor project.
listProjectAssetsRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<ListProjectAssetsResponse> listProjectAssets(Consumer<ListProjectAssetsRequest.Builder> listProjectAssetsRequest)
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.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default ListProjectAssetsPublisher listProjectAssetsPaginator(ListProjectAssetsRequest listProjectAssetsRequest)
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 publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.iotsitewise.paginators.ListProjectAssetsPublisher publisher = client.listProjectAssetsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.iotsitewise.paginators.ListProjectAssetsPublisher publisher = client.listProjectAssetsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListProjectAssetsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListProjectAssetsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProjectAssets(software.amazon.awssdk.services.iotsitewise.model.ListProjectAssetsRequest)
operation.
listProjectAssetsRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default ListProjectAssetsPublisher listProjectAssetsPaginator(Consumer<ListProjectAssetsRequest.Builder> listProjectAssetsRequest)
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 publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.iotsitewise.paginators.ListProjectAssetsPublisher publisher = client.listProjectAssetsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.iotsitewise.paginators.ListProjectAssetsPublisher publisher = client.listProjectAssetsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListProjectAssetsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListProjectAssetsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProjectAssets(software.amazon.awssdk.services.iotsitewise.model.ListProjectAssetsRequest)
operation.
This is a convenience which creates an instance of the ListProjectAssetsRequest.Builder avoiding the need
to create one manually via ListProjectAssetsRequest.builder()
listProjectAssetsRequest - A Consumer that will call methods on ListProjectAssetsRequest.Builder to create a request.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<ListProjectsResponse> listProjects(ListProjectsRequest listProjectsRequest)
Retrieves a paginated list of projects for an AWS IoT SiteWise Monitor portal.
listProjectsRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<ListProjectsResponse> listProjects(Consumer<ListProjectsRequest.Builder> listProjectsRequest)
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.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default ListProjectsPublisher listProjectsPaginator(ListProjectsRequest listProjectsRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.iotsitewise.paginators.ListProjectsPublisher publisher = client.listProjectsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.iotsitewise.paginators.ListProjectsPublisher publisher = client.listProjectsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListProjectsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListProjectsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProjects(software.amazon.awssdk.services.iotsitewise.model.ListProjectsRequest) operation.
listProjectsRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default ListProjectsPublisher listProjectsPaginator(Consumer<ListProjectsRequest.Builder> listProjectsRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.iotsitewise.paginators.ListProjectsPublisher publisher = client.listProjectsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.iotsitewise.paginators.ListProjectsPublisher publisher = client.listProjectsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotsitewise.model.ListProjectsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.iotsitewise.model.ListProjectsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProjects(software.amazon.awssdk.services.iotsitewise.model.ListProjectsRequest) operation.
This is a convenience which creates an instance of the ListProjectsRequest.Builder avoiding the need to
create one manually via ListProjectsRequest.builder()
listProjectsRequest - A Consumer that will call methods on ListProjectsRequest.Builder to create a request.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Retrieves the list of tags for an AWS IoT SiteWise resource.
listTagsForResourceRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
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.For more information, see Quotas in the AWS IoT SiteWise User Guide.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<PutDefaultEncryptionConfigurationResponse> putDefaultEncryptionConfiguration(PutDefaultEncryptionConfigurationRequest putDefaultEncryptionConfigurationRequest)
Sets the default encryption configuration for the AWS account. For more information, see Key management in the AWS IoT SiteWise User Guide.
putDefaultEncryptionConfigurationRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<PutDefaultEncryptionConfigurationResponse> putDefaultEncryptionConfiguration(Consumer<PutDefaultEncryptionConfigurationRequest.Builder> putDefaultEncryptionConfigurationRequest)
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.For more information, see Quotas in the AWS IoT SiteWise User Guide.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<PutLoggingOptionsResponse> putLoggingOptions(PutLoggingOptionsRequest putLoggingOptionsRequest)
Sets logging options for AWS IoT SiteWise.
putLoggingOptionsRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<PutLoggingOptionsResponse> putLoggingOptions(Consumer<PutLoggingOptionsRequest.Builder> putLoggingOptionsRequest)
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.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Adds tags to an AWS IoT SiteWise resource. If a tag already exists for the resource, this operation updates the tag's value.
tagResourceRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
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.For more information, see Quotas in the AWS IoT SiteWise User Guide.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag from an AWS IoT SiteWise resource.
untagResourceRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
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.For more information, see Quotas in the AWS IoT SiteWise User Guide.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<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.
updateAccessPolicyRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<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.
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.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<UpdateAssetResponse> updateAsset(UpdateAssetRequest updateAssetRequest)
Updates an asset's name. For more information, see Updating assets and models in the AWS IoT SiteWise User Guide.
updateAssetRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<UpdateAssetResponse> updateAsset(Consumer<UpdateAssetRequest.Builder> updateAssetRequest)
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.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<UpdateAssetModelResponse> updateAssetModel(UpdateAssetModelRequest updateAssetModelRequest)
Updates an asset model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models in the 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 - For more information, see Quotas in the AWS IoT SiteWise User Guide.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<UpdateAssetModelResponse> updateAssetModel(Consumer<UpdateAssetModelRequest.Builder> updateAssetModelRequest)
Updates an asset model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models in the 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.For more information, see Quotas in the AWS IoT SiteWise User Guide.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<UpdateAssetPropertyResponse> updateAssetProperty(UpdateAssetPropertyRequest updateAssetPropertyRequest)
Updates an asset property's alias and notification state.
This operation overwrites the property's existing alias and notification state. To keep your existing property's alias or notification state, you must include the existing values in the UpdateAssetProperty request. For more information, see DescribeAssetProperty.
updateAssetPropertyRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<UpdateAssetPropertyResponse> updateAssetProperty(Consumer<UpdateAssetPropertyRequest.Builder> updateAssetPropertyRequest)
Updates an asset property's alias and notification state.
This operation overwrites the property's existing alias and notification state. To keep your existing property's alias or notification state, you must include the existing values in the UpdateAssetProperty request. For more information, see DescribeAssetProperty.
This is a convenience which creates an instance of the UpdateAssetPropertyRequest.Builder avoiding the
need to create one manually via UpdateAssetPropertyRequest.builder()
updateAssetPropertyRequest - A Consumer that will call methods on UpdateAssetPropertyRequest.Builder to create a
request.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<UpdateDashboardResponse> updateDashboard(UpdateDashboardRequest updateDashboardRequest)
Updates an AWS IoT SiteWise Monitor dashboard.
updateDashboardRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<UpdateDashboardResponse> updateDashboard(Consumer<UpdateDashboardRequest.Builder> updateDashboardRequest)
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.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<UpdateGatewayResponse> updateGateway(UpdateGatewayRequest updateGatewayRequest)
Updates a gateway's name.
updateGatewayRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<UpdateGatewayResponse> updateGateway(Consumer<UpdateGatewayRequest.Builder> updateGatewayRequest)
Updates a gateway's name.
This is a convenience which creates an instance of the UpdateGatewayRequest.Builder avoiding the need to
create one manually via UpdateGatewayRequest.builder()
updateGatewayRequest - A Consumer that will call methods on UpdateGatewayRequest.Builder to create a request.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<UpdateGatewayCapabilityConfigurationResponse> updateGatewayCapabilityConfiguration(UpdateGatewayCapabilityConfigurationRequest updateGatewayCapabilityConfigurationRequest)
Updates a gateway capability configuration or defines a new capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the 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 - For more information, see Quotas in the AWS IoT SiteWise User Guide.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<UpdateGatewayCapabilityConfigurationResponse> updateGatewayCapabilityConfiguration(Consumer<UpdateGatewayCapabilityConfigurationRequest.Builder> updateGatewayCapabilityConfigurationRequest)
Updates a gateway capability configuration or defines a new capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the 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.For more information, see Quotas in the AWS IoT SiteWise User Guide.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<UpdatePortalResponse> updatePortal(UpdatePortalRequest updatePortalRequest)
Updates an AWS IoT SiteWise Monitor portal.
updatePortalRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<UpdatePortalResponse> updatePortal(Consumer<UpdatePortalRequest.Builder> updatePortalRequest)
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.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<UpdateProjectResponse> updateProject(UpdateProjectRequest updateProjectRequest)
Updates an AWS IoT SiteWise Monitor project.
updateProjectRequest - For more information, see Quotas in the AWS IoT SiteWise User Guide.
default CompletableFuture<UpdateProjectResponse> updateProject(Consumer<UpdateProjectRequest.Builder> updateProjectRequest)
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.For more information, see Quotas in the AWS IoT SiteWise User Guide.
default IoTSiteWiseAsyncWaiter waiter()
IoTSiteWiseAsyncWaiter using this client.
Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
IoTSiteWiseAsyncWaiterCopyright © 2021. All rights reserved.