@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSIoTSiteWiseAsync extends AWSIoTSiteWise
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSIoTSiteWiseAsync instead.
Welcome to the IoT SiteWise API Reference. IoT SiteWise is an Amazon Web Services service that connects Industrial Internet of Things (IIoT) devices to the power of the Amazon Web Services Cloud. For more information, see the IoT SiteWise User Guide. For information about IoT SiteWise quotas, see Quotas in the IoT SiteWise User Guide.
ENDPOINT_PREFIXassociateAssets, associateTimeSeriesToAssetProperty, batchAssociateProjectAssets, batchDisassociateProjectAssets, batchGetAssetPropertyAggregates, batchGetAssetPropertyValue, batchGetAssetPropertyValueHistory, batchPutAssetPropertyValue, createAccessPolicy, createAsset, createAssetModel, createBulkImportJob, createDashboard, createGateway, createPortal, createProject, deleteAccessPolicy, deleteAsset, deleteAssetModel, deleteDashboard, deleteGateway, deletePortal, deleteProject, deleteTimeSeries, describeAccessPolicy, describeAsset, describeAssetModel, describeAssetProperty, describeBulkImportJob, describeDashboard, describeDefaultEncryptionConfiguration, describeGateway, describeGatewayCapabilityConfiguration, describeLoggingOptions, describePortal, describeProject, describeStorageConfiguration, describeTimeSeries, disassociateAssets, disassociateTimeSeriesFromAssetProperty, getAssetPropertyAggregates, getAssetPropertyValue, getAssetPropertyValueHistory, getCachedResponseMetadata, getInterpolatedAssetPropertyValues, listAccessPolicies, listAssetModels, listAssetRelationships, listAssets, listAssociatedAssets, listBulkImportJobs, listDashboards, listGateways, listPortals, listProjectAssets, listProjects, listTagsForResource, listTimeSeries, putDefaultEncryptionConfiguration, putLoggingOptions, putStorageConfiguration, shutdown, tagResource, untagResource, updateAccessPolicy, updateAsset, updateAssetModel, updateAssetProperty, updateDashboard, updateGateway, updateGatewayCapabilityConfiguration, updatePortal, updateProject, waitersFuture<AssociateAssetsResult> associateAssetsAsync(AssociateAssetsRequest associateAssetsRequest)
Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's model. For more information, see Associating assets in the IoT SiteWise User Guide.
associateAssetsRequest - Future<AssociateAssetsResult> associateAssetsAsync(AssociateAssetsRequest associateAssetsRequest, AsyncHandler<AssociateAssetsRequest,AssociateAssetsResult> asyncHandler)
Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's model. For more information, see Associating assets in the IoT SiteWise User Guide.
associateAssetsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<AssociateTimeSeriesToAssetPropertyResult> associateTimeSeriesToAssetPropertyAsync(AssociateTimeSeriesToAssetPropertyRequest associateTimeSeriesToAssetPropertyRequest)
Associates a time series (data stream) with an asset property.
associateTimeSeriesToAssetPropertyRequest - Future<AssociateTimeSeriesToAssetPropertyResult> associateTimeSeriesToAssetPropertyAsync(AssociateTimeSeriesToAssetPropertyRequest associateTimeSeriesToAssetPropertyRequest, AsyncHandler<AssociateTimeSeriesToAssetPropertyRequest,AssociateTimeSeriesToAssetPropertyResult> asyncHandler)
Associates a time series (data stream) with an asset property.
associateTimeSeriesToAssetPropertyRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<BatchAssociateProjectAssetsResult> batchAssociateProjectAssetsAsync(BatchAssociateProjectAssetsRequest batchAssociateProjectAssetsRequest)
Associates a group (batch) of assets with an IoT SiteWise Monitor project.
batchAssociateProjectAssetsRequest - Future<BatchAssociateProjectAssetsResult> batchAssociateProjectAssetsAsync(BatchAssociateProjectAssetsRequest batchAssociateProjectAssetsRequest, AsyncHandler<BatchAssociateProjectAssetsRequest,BatchAssociateProjectAssetsResult> asyncHandler)
Associates a group (batch) of assets with an IoT SiteWise Monitor project.
batchAssociateProjectAssetsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<BatchDisassociateProjectAssetsResult> batchDisassociateProjectAssetsAsync(BatchDisassociateProjectAssetsRequest batchDisassociateProjectAssetsRequest)
Disassociates a group (batch) of assets from an IoT SiteWise Monitor project.
batchDisassociateProjectAssetsRequest - Future<BatchDisassociateProjectAssetsResult> batchDisassociateProjectAssetsAsync(BatchDisassociateProjectAssetsRequest batchDisassociateProjectAssetsRequest, AsyncHandler<BatchDisassociateProjectAssetsRequest,BatchDisassociateProjectAssetsResult> asyncHandler)
Disassociates a group (batch) of assets from an IoT SiteWise Monitor project.
batchDisassociateProjectAssetsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<BatchGetAssetPropertyAggregatesResult> batchGetAssetPropertyAggregatesAsync(BatchGetAssetPropertyAggregatesRequest batchGetAssetPropertyAggregatesRequest)
Gets aggregated values (for example, average, minimum, and maximum) for one or more asset properties. For more information, see Querying aggregates in the IoT SiteWise User Guide.
batchGetAssetPropertyAggregatesRequest - Future<BatchGetAssetPropertyAggregatesResult> batchGetAssetPropertyAggregatesAsync(BatchGetAssetPropertyAggregatesRequest batchGetAssetPropertyAggregatesRequest, AsyncHandler<BatchGetAssetPropertyAggregatesRequest,BatchGetAssetPropertyAggregatesResult> asyncHandler)
Gets aggregated values (for example, average, minimum, and maximum) for one or more asset properties. For more information, see Querying aggregates in the IoT SiteWise User Guide.
batchGetAssetPropertyAggregatesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<BatchGetAssetPropertyValueResult> batchGetAssetPropertyValueAsync(BatchGetAssetPropertyValueRequest batchGetAssetPropertyValueRequest)
Gets the current value for one or more asset properties. For more information, see Querying current values in the IoT SiteWise User Guide.
batchGetAssetPropertyValueRequest - Future<BatchGetAssetPropertyValueResult> batchGetAssetPropertyValueAsync(BatchGetAssetPropertyValueRequest batchGetAssetPropertyValueRequest, AsyncHandler<BatchGetAssetPropertyValueRequest,BatchGetAssetPropertyValueResult> asyncHandler)
Gets the current value for one or more asset properties. For more information, see Querying current values in the IoT SiteWise User Guide.
batchGetAssetPropertyValueRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<BatchGetAssetPropertyValueHistoryResult> batchGetAssetPropertyValueHistoryAsync(BatchGetAssetPropertyValueHistoryRequest batchGetAssetPropertyValueHistoryRequest)
Gets the historical values for one or more asset properties. For more information, see Querying historical values in the IoT SiteWise User Guide.
batchGetAssetPropertyValueHistoryRequest - Future<BatchGetAssetPropertyValueHistoryResult> batchGetAssetPropertyValueHistoryAsync(BatchGetAssetPropertyValueHistoryRequest batchGetAssetPropertyValueHistoryRequest, AsyncHandler<BatchGetAssetPropertyValueHistoryRequest,BatchGetAssetPropertyValueHistoryResult> asyncHandler)
Gets the historical values for one or more asset properties. For more information, see Querying historical values in the IoT SiteWise User Guide.
batchGetAssetPropertyValueHistoryRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<BatchPutAssetPropertyValueResult> batchPutAssetPropertyValueAsync(BatchPutAssetPropertyValueRequest batchPutAssetPropertyValueRequest)
Sends a list of asset property values to IoT SiteWise. Each value is a timestamp-quality-value (TQV) data point. For more information, see Ingesting data using the API in the IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
The assetId and propertyId of an asset property.
A propertyAlias, which is a data stream alias (for example,
/company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
With respect to Unix epoch time, IoT SiteWise accepts only TQVs that have a timestamp of no more than 7 days in
the past and no more than 10 minutes in the future. IoT SiteWise rejects timestamps outside of the inclusive
range of [-7 days, +10 minutes] and returns a TimestampOutOfRangeException error.
For each asset property, IoT SiteWise overwrites TQVs with duplicate timestamps unless the newer TQV has a
different quality. For example, if you store a TQV {T1, GOOD, V1}, then storing
{T1, GOOD, V2} replaces the existing TQV.
IoT SiteWise authorizes access to each BatchPutAssetPropertyValue entry individually. For more
information, see BatchPutAssetPropertyValue authorization in the IoT SiteWise User Guide.
batchPutAssetPropertyValueRequest - Future<BatchPutAssetPropertyValueResult> batchPutAssetPropertyValueAsync(BatchPutAssetPropertyValueRequest batchPutAssetPropertyValueRequest, AsyncHandler<BatchPutAssetPropertyValueRequest,BatchPutAssetPropertyValueResult> asyncHandler)
Sends a list of asset property values to IoT SiteWise. Each value is a timestamp-quality-value (TQV) data point. For more information, see Ingesting data using the API in the IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
The assetId and propertyId of an asset property.
A propertyAlias, which is a data stream alias (for example,
/company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
With respect to Unix epoch time, IoT SiteWise accepts only TQVs that have a timestamp of no more than 7 days in
the past and no more than 10 minutes in the future. IoT SiteWise rejects timestamps outside of the inclusive
range of [-7 days, +10 minutes] and returns a TimestampOutOfRangeException error.
For each asset property, IoT SiteWise overwrites TQVs with duplicate timestamps unless the newer TQV has a
different quality. For example, if you store a TQV {T1, GOOD, V1}, then storing
{T1, GOOD, V2} replaces the existing TQV.
IoT SiteWise authorizes access to each BatchPutAssetPropertyValue entry individually. For more
information, see BatchPutAssetPropertyValue authorization in the IoT SiteWise User Guide.
batchPutAssetPropertyValueRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateAccessPolicyResult> createAccessPolicyAsync(CreateAccessPolicyRequest createAccessPolicyRequest)
Creates an access policy that grants the specified identity (Amazon Web Services SSO user, Amazon Web Services SSO group, or IAM user) access to the specified IoT SiteWise Monitor portal or project resource.
createAccessPolicyRequest - Future<CreateAccessPolicyResult> createAccessPolicyAsync(CreateAccessPolicyRequest createAccessPolicyRequest, AsyncHandler<CreateAccessPolicyRequest,CreateAccessPolicyResult> asyncHandler)
Creates an access policy that grants the specified identity (Amazon Web Services SSO user, Amazon Web Services SSO group, or IAM user) access to the specified IoT SiteWise Monitor portal or project resource.
createAccessPolicyRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateAssetResult> createAssetAsync(CreateAssetRequest createAssetRequest)
Creates an asset from an existing asset model. For more information, see Creating assets in the IoT SiteWise User Guide.
createAssetRequest - Future<CreateAssetResult> createAssetAsync(CreateAssetRequest createAssetRequest, AsyncHandler<CreateAssetRequest,CreateAssetResult> asyncHandler)
Creates an asset from an existing asset model. For more information, see Creating assets in the IoT SiteWise User Guide.
createAssetRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateAssetModelResult> createAssetModelAsync(CreateAssetModelRequest createAssetModelRequest)
Creates an asset model from specified property and hierarchy definitions. You create assets from asset models. With asset models, you can easily create assets of the same type that have standardized definitions. Each asset created from a model inherits the asset model's property and hierarchy definitions. For more information, see Defining asset models in the IoT SiteWise User Guide.
createAssetModelRequest - Future<CreateAssetModelResult> createAssetModelAsync(CreateAssetModelRequest createAssetModelRequest, AsyncHandler<CreateAssetModelRequest,CreateAssetModelResult> asyncHandler)
Creates an asset model from specified property and hierarchy definitions. You create assets from asset models. With asset models, you can easily create assets of the same type that have standardized definitions. Each asset created from a model inherits the asset model's property and hierarchy definitions. For more information, see Defining asset models in the IoT SiteWise User Guide.
createAssetModelRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateBulkImportJobResult> createBulkImportJobAsync(CreateBulkImportJobRequest createBulkImportJobRequest)
Defines a job to ingest data to IoT SiteWise from Amazon S3. For more information, see Create a bulk import job (CLI) in the Amazon Simple Storage Service User Guide.
You must enable IoT SiteWise to export data to Amazon S3 before you create a bulk import job. For more information about how to configure storage settings, see PutStorageConfiguration.
createBulkImportJobRequest - Future<CreateBulkImportJobResult> createBulkImportJobAsync(CreateBulkImportJobRequest createBulkImportJobRequest, AsyncHandler<CreateBulkImportJobRequest,CreateBulkImportJobResult> asyncHandler)
Defines a job to ingest data to IoT SiteWise from Amazon S3. For more information, see Create a bulk import job (CLI) in the Amazon Simple Storage Service User Guide.
You must enable IoT SiteWise to export data to Amazon S3 before you create a bulk import job. For more information about how to configure storage settings, see PutStorageConfiguration.
createBulkImportJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateDashboardResult> createDashboardAsync(CreateDashboardRequest createDashboardRequest)
Creates a dashboard in an IoT SiteWise Monitor project.
createDashboardRequest - Future<CreateDashboardResult> createDashboardAsync(CreateDashboardRequest createDashboardRequest, AsyncHandler<CreateDashboardRequest,CreateDashboardResult> asyncHandler)
Creates a dashboard in an IoT SiteWise Monitor project.
createDashboardRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateGatewayResult> createGatewayAsync(CreateGatewayRequest createGatewayRequest)
Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to IoT SiteWise. For more information, see Ingesting data using a gateway in the IoT SiteWise User Guide.
createGatewayRequest - Future<CreateGatewayResult> createGatewayAsync(CreateGatewayRequest createGatewayRequest, AsyncHandler<CreateGatewayRequest,CreateGatewayResult> asyncHandler)
Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to IoT SiteWise. For more information, see Ingesting data using a gateway in the IoT SiteWise User Guide.
createGatewayRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreatePortalResult> createPortalAsync(CreatePortalRequest createPortalRequest)
Creates a portal, which can contain projects and dashboards. IoT SiteWise Monitor uses Amazon Web Services 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 IoT SiteWise User Guide.
createPortalRequest - Future<CreatePortalResult> createPortalAsync(CreatePortalRequest createPortalRequest, AsyncHandler<CreatePortalRequest,CreatePortalResult> asyncHandler)
Creates a portal, which can contain projects and dashboards. IoT SiteWise Monitor uses Amazon Web Services 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 IoT SiteWise User Guide.
createPortalRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateProjectResult> createProjectAsync(CreateProjectRequest createProjectRequest)
Creates a project in the specified portal.
Make sure that the project name and description don't contain confidential information.
createProjectRequest - Future<CreateProjectResult> createProjectAsync(CreateProjectRequest createProjectRequest, AsyncHandler<CreateProjectRequest,CreateProjectResult> asyncHandler)
Creates a project in the specified portal.
Make sure that the project name and description don't contain confidential information.
createProjectRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteAccessPolicyResult> deleteAccessPolicyAsync(DeleteAccessPolicyRequest deleteAccessPolicyRequest)
Deletes an access policy that grants the specified identity access to the specified IoT SiteWise Monitor resource. You can use this operation to revoke access to an IoT SiteWise Monitor resource.
deleteAccessPolicyRequest - Future<DeleteAccessPolicyResult> deleteAccessPolicyAsync(DeleteAccessPolicyRequest deleteAccessPolicyRequest, AsyncHandler<DeleteAccessPolicyRequest,DeleteAccessPolicyResult> asyncHandler)
Deletes an access policy that grants the specified identity access to the specified IoT SiteWise Monitor resource. You can use this operation to revoke access to an IoT SiteWise Monitor resource.
deleteAccessPolicyRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteAssetResult> deleteAssetAsync(DeleteAssetRequest deleteAssetRequest)
Deletes an asset. This action can't be undone. For more information, see Deleting assets and models in the IoT SiteWise User Guide.
You can't delete an asset that's associated to another asset. For more information, see DisassociateAssets.
deleteAssetRequest - Future<DeleteAssetResult> deleteAssetAsync(DeleteAssetRequest deleteAssetRequest, AsyncHandler<DeleteAssetRequest,DeleteAssetResult> asyncHandler)
Deletes an asset. This action can't be undone. For more information, see Deleting assets and models in the IoT SiteWise User Guide.
You can't delete an asset that's associated to another asset. For more information, see DisassociateAssets.
deleteAssetRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteAssetModelResult> deleteAssetModelAsync(DeleteAssetModelRequest deleteAssetModelRequest)
Deletes an asset model. This action can't be undone. You must delete all assets created from an asset model before you can delete the model. Also, you can't delete an asset model if a parent asset model exists that contains a property formula expression that depends on the asset model that you want to delete. For more information, see Deleting assets and models in the IoT SiteWise User Guide.
deleteAssetModelRequest - Future<DeleteAssetModelResult> deleteAssetModelAsync(DeleteAssetModelRequest deleteAssetModelRequest, AsyncHandler<DeleteAssetModelRequest,DeleteAssetModelResult> asyncHandler)
Deletes an asset model. This action can't be undone. You must delete all assets created from an asset model before you can delete the model. Also, you can't delete an asset model if a parent asset model exists that contains a property formula expression that depends on the asset model that you want to delete. For more information, see Deleting assets and models in the IoT SiteWise User Guide.
deleteAssetModelRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteDashboardResult> deleteDashboardAsync(DeleteDashboardRequest deleteDashboardRequest)
Deletes a dashboard from IoT SiteWise Monitor.
deleteDashboardRequest - Future<DeleteDashboardResult> deleteDashboardAsync(DeleteDashboardRequest deleteDashboardRequest, AsyncHandler<DeleteDashboardRequest,DeleteDashboardResult> asyncHandler)
Deletes a dashboard from IoT SiteWise Monitor.
deleteDashboardRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteGatewayResult> deleteGatewayAsync(DeleteGatewayRequest deleteGatewayRequest)
Deletes a gateway from IoT SiteWise. When you delete a gateway, some of the gateway's files remain in your gateway's file system.
deleteGatewayRequest - Future<DeleteGatewayResult> deleteGatewayAsync(DeleteGatewayRequest deleteGatewayRequest, AsyncHandler<DeleteGatewayRequest,DeleteGatewayResult> asyncHandler)
Deletes a gateway from IoT SiteWise. When you delete a gateway, some of the gateway's files remain in your gateway's file system.
deleteGatewayRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeletePortalResult> deletePortalAsync(DeletePortalRequest deletePortalRequest)
Deletes a portal from IoT SiteWise Monitor.
deletePortalRequest - Future<DeletePortalResult> deletePortalAsync(DeletePortalRequest deletePortalRequest, AsyncHandler<DeletePortalRequest,DeletePortalResult> asyncHandler)
Deletes a portal from IoT SiteWise Monitor.
deletePortalRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteProjectResult> deleteProjectAsync(DeleteProjectRequest deleteProjectRequest)
Deletes a project from IoT SiteWise Monitor.
deleteProjectRequest - Future<DeleteProjectResult> deleteProjectAsync(DeleteProjectRequest deleteProjectRequest, AsyncHandler<DeleteProjectRequest,DeleteProjectResult> asyncHandler)
Deletes a project from IoT SiteWise Monitor.
deleteProjectRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteTimeSeriesResult> deleteTimeSeriesAsync(DeleteTimeSeriesRequest deleteTimeSeriesRequest)
Deletes a time series (data stream). If you delete a time series that's associated with an asset property, the asset property still exists, but the time series will no longer be associated with this asset property.
To identify a time series, do one of the following:
If the time series isn't associated with an asset property, specify the alias of the time series.
If the time series is associated with an asset property, specify one of the following:
The alias of the time series.
The assetId and propertyId that identifies the asset property.
deleteTimeSeriesRequest - Future<DeleteTimeSeriesResult> deleteTimeSeriesAsync(DeleteTimeSeriesRequest deleteTimeSeriesRequest, AsyncHandler<DeleteTimeSeriesRequest,DeleteTimeSeriesResult> asyncHandler)
Deletes a time series (data stream). If you delete a time series that's associated with an asset property, the asset property still exists, but the time series will no longer be associated with this asset property.
To identify a time series, do one of the following:
If the time series isn't associated with an asset property, specify the alias of the time series.
If the time series is associated with an asset property, specify one of the following:
The alias of the time series.
The assetId and propertyId that identifies the asset property.
deleteTimeSeriesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeAccessPolicyResult> describeAccessPolicyAsync(DescribeAccessPolicyRequest describeAccessPolicyRequest)
Describes an access policy, which specifies an identity's access to an IoT SiteWise Monitor portal or project.
describeAccessPolicyRequest - Future<DescribeAccessPolicyResult> describeAccessPolicyAsync(DescribeAccessPolicyRequest describeAccessPolicyRequest, AsyncHandler<DescribeAccessPolicyRequest,DescribeAccessPolicyResult> asyncHandler)
Describes an access policy, which specifies an identity's access to an IoT SiteWise Monitor portal or project.
describeAccessPolicyRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeAssetResult> describeAssetAsync(DescribeAssetRequest describeAssetRequest)
Retrieves information about an asset.
describeAssetRequest - Future<DescribeAssetResult> describeAssetAsync(DescribeAssetRequest describeAssetRequest, AsyncHandler<DescribeAssetRequest,DescribeAssetResult> asyncHandler)
Retrieves information about an asset.
describeAssetRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeAssetModelResult> describeAssetModelAsync(DescribeAssetModelRequest describeAssetModelRequest)
Retrieves information about an asset model.
describeAssetModelRequest - Future<DescribeAssetModelResult> describeAssetModelAsync(DescribeAssetModelRequest describeAssetModelRequest, AsyncHandler<DescribeAssetModelRequest,DescribeAssetModelResult> asyncHandler)
Retrieves information about an asset model.
describeAssetModelRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeAssetPropertyResult> describeAssetPropertyAsync(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 - Future<DescribeAssetPropertyResult> describeAssetPropertyAsync(DescribeAssetPropertyRequest describeAssetPropertyRequest, AsyncHandler<DescribeAssetPropertyRequest,DescribeAssetPropertyResult> asyncHandler)
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 - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeBulkImportJobResult> describeBulkImportJobAsync(DescribeBulkImportJobRequest describeBulkImportJobRequest)
Retrieves information about a bulk import job request. For more information, see Describe a bulk import job (CLI) in the Amazon Simple Storage Service User Guide.
describeBulkImportJobRequest - Future<DescribeBulkImportJobResult> describeBulkImportJobAsync(DescribeBulkImportJobRequest describeBulkImportJobRequest, AsyncHandler<DescribeBulkImportJobRequest,DescribeBulkImportJobResult> asyncHandler)
Retrieves information about a bulk import job request. For more information, see Describe a bulk import job (CLI) in the Amazon Simple Storage Service User Guide.
describeBulkImportJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeDashboardResult> describeDashboardAsync(DescribeDashboardRequest describeDashboardRequest)
Retrieves information about a dashboard.
describeDashboardRequest - Future<DescribeDashboardResult> describeDashboardAsync(DescribeDashboardRequest describeDashboardRequest, AsyncHandler<DescribeDashboardRequest,DescribeDashboardResult> asyncHandler)
Retrieves information about a dashboard.
describeDashboardRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeDefaultEncryptionConfigurationResult> describeDefaultEncryptionConfigurationAsync(DescribeDefaultEncryptionConfigurationRequest describeDefaultEncryptionConfigurationRequest)
Retrieves information about the default encryption configuration for the Amazon Web Services account in the default or specified Region. For more information, see Key management in the IoT SiteWise User Guide.
describeDefaultEncryptionConfigurationRequest - Future<DescribeDefaultEncryptionConfigurationResult> describeDefaultEncryptionConfigurationAsync(DescribeDefaultEncryptionConfigurationRequest describeDefaultEncryptionConfigurationRequest, AsyncHandler<DescribeDefaultEncryptionConfigurationRequest,DescribeDefaultEncryptionConfigurationResult> asyncHandler)
Retrieves information about the default encryption configuration for the Amazon Web Services account in the default or specified Region. For more information, see Key management in the IoT SiteWise User Guide.
describeDefaultEncryptionConfigurationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeGatewayResult> describeGatewayAsync(DescribeGatewayRequest describeGatewayRequest)
Retrieves information about a gateway.
describeGatewayRequest - Future<DescribeGatewayResult> describeGatewayAsync(DescribeGatewayRequest describeGatewayRequest, AsyncHandler<DescribeGatewayRequest,DescribeGatewayResult> asyncHandler)
Retrieves information about a gateway.
describeGatewayRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeGatewayCapabilityConfigurationResult> describeGatewayCapabilityConfigurationAsync(DescribeGatewayCapabilityConfigurationRequest describeGatewayCapabilityConfigurationRequest)
Retrieves information about a gateway capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway.
describeGatewayCapabilityConfigurationRequest - Future<DescribeGatewayCapabilityConfigurationResult> describeGatewayCapabilityConfigurationAsync(DescribeGatewayCapabilityConfigurationRequest describeGatewayCapabilityConfigurationRequest, AsyncHandler<DescribeGatewayCapabilityConfigurationRequest,DescribeGatewayCapabilityConfigurationResult> asyncHandler)
Retrieves information about a gateway capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway.
describeGatewayCapabilityConfigurationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeLoggingOptionsResult> describeLoggingOptionsAsync(DescribeLoggingOptionsRequest describeLoggingOptionsRequest)
Retrieves the current IoT SiteWise logging options.
describeLoggingOptionsRequest - Future<DescribeLoggingOptionsResult> describeLoggingOptionsAsync(DescribeLoggingOptionsRequest describeLoggingOptionsRequest, AsyncHandler<DescribeLoggingOptionsRequest,DescribeLoggingOptionsResult> asyncHandler)
Retrieves the current IoT SiteWise logging options.
describeLoggingOptionsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribePortalResult> describePortalAsync(DescribePortalRequest describePortalRequest)
Retrieves information about a portal.
describePortalRequest - Future<DescribePortalResult> describePortalAsync(DescribePortalRequest describePortalRequest, AsyncHandler<DescribePortalRequest,DescribePortalResult> asyncHandler)
Retrieves information about a portal.
describePortalRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeProjectResult> describeProjectAsync(DescribeProjectRequest describeProjectRequest)
Retrieves information about a project.
describeProjectRequest - Future<DescribeProjectResult> describeProjectAsync(DescribeProjectRequest describeProjectRequest, AsyncHandler<DescribeProjectRequest,DescribeProjectResult> asyncHandler)
Retrieves information about a project.
describeProjectRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeStorageConfigurationResult> describeStorageConfigurationAsync(DescribeStorageConfigurationRequest describeStorageConfigurationRequest)
Retrieves information about the storage configuration for IoT SiteWise.
describeStorageConfigurationRequest - Future<DescribeStorageConfigurationResult> describeStorageConfigurationAsync(DescribeStorageConfigurationRequest describeStorageConfigurationRequest, AsyncHandler<DescribeStorageConfigurationRequest,DescribeStorageConfigurationResult> asyncHandler)
Retrieves information about the storage configuration for IoT SiteWise.
describeStorageConfigurationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeTimeSeriesResult> describeTimeSeriesAsync(DescribeTimeSeriesRequest describeTimeSeriesRequest)
Retrieves information about a time series (data stream).
To identify a time series, do one of the following:
If the time series isn't associated with an asset property, specify the alias of the time series.
If the time series is associated with an asset property, specify one of the following:
The alias of the time series.
The assetId and propertyId that identifies the asset property.
describeTimeSeriesRequest - Future<DescribeTimeSeriesResult> describeTimeSeriesAsync(DescribeTimeSeriesRequest describeTimeSeriesRequest, AsyncHandler<DescribeTimeSeriesRequest,DescribeTimeSeriesResult> asyncHandler)
Retrieves information about a time series (data stream).
To identify a time series, do one of the following:
If the time series isn't associated with an asset property, specify the alias of the time series.
If the time series is associated with an asset property, specify one of the following:
The alias of the time series.
The assetId and propertyId that identifies the asset property.
describeTimeSeriesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DisassociateAssetsResult> disassociateAssetsAsync(DisassociateAssetsRequest disassociateAssetsRequest)
Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model.
disassociateAssetsRequest - Future<DisassociateAssetsResult> disassociateAssetsAsync(DisassociateAssetsRequest disassociateAssetsRequest, AsyncHandler<DisassociateAssetsRequest,DisassociateAssetsResult> asyncHandler)
Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model.
disassociateAssetsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DisassociateTimeSeriesFromAssetPropertyResult> disassociateTimeSeriesFromAssetPropertyAsync(DisassociateTimeSeriesFromAssetPropertyRequest disassociateTimeSeriesFromAssetPropertyRequest)
Disassociates a time series (data stream) from an asset property.
disassociateTimeSeriesFromAssetPropertyRequest - Future<DisassociateTimeSeriesFromAssetPropertyResult> disassociateTimeSeriesFromAssetPropertyAsync(DisassociateTimeSeriesFromAssetPropertyRequest disassociateTimeSeriesFromAssetPropertyRequest, AsyncHandler<DisassociateTimeSeriesFromAssetPropertyRequest,DisassociateTimeSeriesFromAssetPropertyResult> asyncHandler)
Disassociates a time series (data stream) from an asset property.
disassociateTimeSeriesFromAssetPropertyRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetAssetPropertyAggregatesResult> getAssetPropertyAggregatesAsync(GetAssetPropertyAggregatesRequest getAssetPropertyAggregatesRequest)
Gets aggregated values for an asset property. For more information, see Querying aggregates in the IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
The assetId and propertyId of an asset property.
A propertyAlias, which is a data stream alias (for example,
/company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
getAssetPropertyAggregatesRequest - Future<GetAssetPropertyAggregatesResult> getAssetPropertyAggregatesAsync(GetAssetPropertyAggregatesRequest getAssetPropertyAggregatesRequest, AsyncHandler<GetAssetPropertyAggregatesRequest,GetAssetPropertyAggregatesResult> asyncHandler)
Gets aggregated values for an asset property. For more information, see Querying aggregates in the IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
The assetId and propertyId of an asset property.
A propertyAlias, which is a data stream alias (for example,
/company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
getAssetPropertyAggregatesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetAssetPropertyValueResult> getAssetPropertyValueAsync(GetAssetPropertyValueRequest getAssetPropertyValueRequest)
Gets an asset property's current value. For more information, see Querying current values in the IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
The assetId and propertyId of an asset property.
A propertyAlias, which is a data stream alias (for example,
/company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
getAssetPropertyValueRequest - Future<GetAssetPropertyValueResult> getAssetPropertyValueAsync(GetAssetPropertyValueRequest getAssetPropertyValueRequest, AsyncHandler<GetAssetPropertyValueRequest,GetAssetPropertyValueResult> asyncHandler)
Gets an asset property's current value. For more information, see Querying current values in the IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
The assetId and propertyId of an asset property.
A propertyAlias, which is a data stream alias (for example,
/company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
getAssetPropertyValueRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetAssetPropertyValueHistoryResult> getAssetPropertyValueHistoryAsync(GetAssetPropertyValueHistoryRequest getAssetPropertyValueHistoryRequest)
Gets the history of an asset property's values. For more information, see Querying historical values in the IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
The assetId and propertyId of an asset property.
A propertyAlias, which is a data stream alias (for example,
/company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
getAssetPropertyValueHistoryRequest - Future<GetAssetPropertyValueHistoryResult> getAssetPropertyValueHistoryAsync(GetAssetPropertyValueHistoryRequest getAssetPropertyValueHistoryRequest, AsyncHandler<GetAssetPropertyValueHistoryRequest,GetAssetPropertyValueHistoryResult> asyncHandler)
Gets the history of an asset property's values. For more information, see Querying historical values in the IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
The assetId and propertyId of an asset property.
A propertyAlias, which is a data stream alias (for example,
/company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
getAssetPropertyValueHistoryRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetInterpolatedAssetPropertyValuesResult> getInterpolatedAssetPropertyValuesAsync(GetInterpolatedAssetPropertyValuesRequest getInterpolatedAssetPropertyValuesRequest)
Get interpolated values for an asset property for a specified time interval, during a period of time. If your time series is missing data points during the specified time interval, you can use interpolation to estimate the missing data.
For example, you can use this operation to return the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days.
To identify an asset property, you must specify one of the following:
The assetId and propertyId of an asset property.
A propertyAlias, which is a data stream alias (for example,
/company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
getInterpolatedAssetPropertyValuesRequest - Future<GetInterpolatedAssetPropertyValuesResult> getInterpolatedAssetPropertyValuesAsync(GetInterpolatedAssetPropertyValuesRequest getInterpolatedAssetPropertyValuesRequest, AsyncHandler<GetInterpolatedAssetPropertyValuesRequest,GetInterpolatedAssetPropertyValuesResult> asyncHandler)
Get interpolated values for an asset property for a specified time interval, during a period of time. If your time series is missing data points during the specified time interval, you can use interpolation to estimate the missing data.
For example, you can use this operation to return the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days.
To identify an asset property, you must specify one of the following:
The assetId and propertyId of an asset property.
A propertyAlias, which is a data stream alias (for example,
/company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
getInterpolatedAssetPropertyValuesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListAccessPoliciesResult> listAccessPoliciesAsync(ListAccessPoliciesRequest listAccessPoliciesRequest)
Retrieves a paginated list of access policies for an identity (an Amazon Web Services SSO user, an Amazon Web Services SSO group, or an IAM user) or an IoT SiteWise Monitor resource (a portal or project).
listAccessPoliciesRequest - Future<ListAccessPoliciesResult> listAccessPoliciesAsync(ListAccessPoliciesRequest listAccessPoliciesRequest, AsyncHandler<ListAccessPoliciesRequest,ListAccessPoliciesResult> asyncHandler)
Retrieves a paginated list of access policies for an identity (an Amazon Web Services SSO user, an Amazon Web Services SSO group, or an IAM user) or an IoT SiteWise Monitor resource (a portal or project).
listAccessPoliciesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListAssetModelsResult> listAssetModelsAsync(ListAssetModelsRequest listAssetModelsRequest)
Retrieves a paginated list of summaries of all asset models.
listAssetModelsRequest - Future<ListAssetModelsResult> listAssetModelsAsync(ListAssetModelsRequest listAssetModelsRequest, AsyncHandler<ListAssetModelsRequest,ListAssetModelsResult> asyncHandler)
Retrieves a paginated list of summaries of all asset models.
listAssetModelsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListAssetRelationshipsResult> listAssetRelationshipsAsync(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 - Future<ListAssetRelationshipsResult> listAssetRelationshipsAsync(ListAssetRelationshipsRequest listAssetRelationshipsRequest, AsyncHandler<ListAssetRelationshipsRequest,ListAssetRelationshipsResult> asyncHandler)
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 - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListAssetsResult> listAssetsAsync(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 - Future<ListAssetsResult> listAssetsAsync(ListAssetsRequest listAssetsRequest, AsyncHandler<ListAssetsRequest,ListAssetsResult> asyncHandler)
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 - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListAssociatedAssetsResult> listAssociatedAssetsAsync(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 - Future<ListAssociatedAssetsResult> listAssociatedAssetsAsync(ListAssociatedAssetsRequest listAssociatedAssetsRequest, AsyncHandler<ListAssociatedAssetsRequest,ListAssociatedAssetsResult> asyncHandler)
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 - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListBulkImportJobsResult> listBulkImportJobsAsync(ListBulkImportJobsRequest listBulkImportJobsRequest)
Retrieves a paginated list of bulk import job requests. For more information, see List bulk import jobs (CLI) in the IoT SiteWise User Guide.
listBulkImportJobsRequest - Future<ListBulkImportJobsResult> listBulkImportJobsAsync(ListBulkImportJobsRequest listBulkImportJobsRequest, AsyncHandler<ListBulkImportJobsRequest,ListBulkImportJobsResult> asyncHandler)
Retrieves a paginated list of bulk import job requests. For more information, see List bulk import jobs (CLI) in the IoT SiteWise User Guide.
listBulkImportJobsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListDashboardsResult> listDashboardsAsync(ListDashboardsRequest listDashboardsRequest)
Retrieves a paginated list of dashboards for an IoT SiteWise Monitor project.
listDashboardsRequest - Future<ListDashboardsResult> listDashboardsAsync(ListDashboardsRequest listDashboardsRequest, AsyncHandler<ListDashboardsRequest,ListDashboardsResult> asyncHandler)
Retrieves a paginated list of dashboards for an IoT SiteWise Monitor project.
listDashboardsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListGatewaysResult> listGatewaysAsync(ListGatewaysRequest listGatewaysRequest)
Retrieves a paginated list of gateways.
listGatewaysRequest - Future<ListGatewaysResult> listGatewaysAsync(ListGatewaysRequest listGatewaysRequest, AsyncHandler<ListGatewaysRequest,ListGatewaysResult> asyncHandler)
Retrieves a paginated list of gateways.
listGatewaysRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListPortalsResult> listPortalsAsync(ListPortalsRequest listPortalsRequest)
Retrieves a paginated list of IoT SiteWise Monitor portals.
listPortalsRequest - Future<ListPortalsResult> listPortalsAsync(ListPortalsRequest listPortalsRequest, AsyncHandler<ListPortalsRequest,ListPortalsResult> asyncHandler)
Retrieves a paginated list of IoT SiteWise Monitor portals.
listPortalsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListProjectAssetsResult> listProjectAssetsAsync(ListProjectAssetsRequest listProjectAssetsRequest)
Retrieves a paginated list of assets associated with an IoT SiteWise Monitor project.
listProjectAssetsRequest - Future<ListProjectAssetsResult> listProjectAssetsAsync(ListProjectAssetsRequest listProjectAssetsRequest, AsyncHandler<ListProjectAssetsRequest,ListProjectAssetsResult> asyncHandler)
Retrieves a paginated list of assets associated with an IoT SiteWise Monitor project.
listProjectAssetsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListProjectsResult> listProjectsAsync(ListProjectsRequest listProjectsRequest)
Retrieves a paginated list of projects for an IoT SiteWise Monitor portal.
listProjectsRequest - Future<ListProjectsResult> listProjectsAsync(ListProjectsRequest listProjectsRequest, AsyncHandler<ListProjectsRequest,ListProjectsResult> asyncHandler)
Retrieves a paginated list of projects for an IoT SiteWise Monitor portal.
listProjectsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Retrieves the list of tags for an IoT SiteWise resource.
listTagsForResourceRequest - Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Retrieves the list of tags for an IoT SiteWise resource.
listTagsForResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListTimeSeriesResult> listTimeSeriesAsync(ListTimeSeriesRequest listTimeSeriesRequest)
Retrieves a paginated list of time series (data streams).
listTimeSeriesRequest - Future<ListTimeSeriesResult> listTimeSeriesAsync(ListTimeSeriesRequest listTimeSeriesRequest, AsyncHandler<ListTimeSeriesRequest,ListTimeSeriesResult> asyncHandler)
Retrieves a paginated list of time series (data streams).
listTimeSeriesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutDefaultEncryptionConfigurationResult> putDefaultEncryptionConfigurationAsync(PutDefaultEncryptionConfigurationRequest putDefaultEncryptionConfigurationRequest)
Sets the default encryption configuration for the Amazon Web Services account. For more information, see Key management in the IoT SiteWise User Guide.
putDefaultEncryptionConfigurationRequest - Future<PutDefaultEncryptionConfigurationResult> putDefaultEncryptionConfigurationAsync(PutDefaultEncryptionConfigurationRequest putDefaultEncryptionConfigurationRequest, AsyncHandler<PutDefaultEncryptionConfigurationRequest,PutDefaultEncryptionConfigurationResult> asyncHandler)
Sets the default encryption configuration for the Amazon Web Services account. For more information, see Key management in the IoT SiteWise User Guide.
putDefaultEncryptionConfigurationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutLoggingOptionsResult> putLoggingOptionsAsync(PutLoggingOptionsRequest putLoggingOptionsRequest)
Sets logging options for IoT SiteWise.
putLoggingOptionsRequest - Future<PutLoggingOptionsResult> putLoggingOptionsAsync(PutLoggingOptionsRequest putLoggingOptionsRequest, AsyncHandler<PutLoggingOptionsRequest,PutLoggingOptionsResult> asyncHandler)
Sets logging options for IoT SiteWise.
putLoggingOptionsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutStorageConfigurationResult> putStorageConfigurationAsync(PutStorageConfigurationRequest putStorageConfigurationRequest)
Configures storage settings for IoT SiteWise.
putStorageConfigurationRequest - Future<PutStorageConfigurationResult> putStorageConfigurationAsync(PutStorageConfigurationRequest putStorageConfigurationRequest, AsyncHandler<PutStorageConfigurationRequest,PutStorageConfigurationResult> asyncHandler)
Configures storage settings for IoT SiteWise.
putStorageConfigurationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest)
Adds tags to an IoT SiteWise resource. If a tag already exists for the resource, this operation updates the tag's value.
tagResourceRequest - Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Adds tags to an IoT SiteWise resource. If a tag already exists for the resource, this operation updates the tag's value.
tagResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
Removes a tag from an IoT SiteWise resource.
untagResourceRequest - Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes a tag from an IoT SiteWise resource.
untagResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateAccessPolicyResult> updateAccessPolicyAsync(UpdateAccessPolicyRequest updateAccessPolicyRequest)
Updates an existing access policy that specifies an identity's access to an IoT SiteWise Monitor portal or project resource.
updateAccessPolicyRequest - Future<UpdateAccessPolicyResult> updateAccessPolicyAsync(UpdateAccessPolicyRequest updateAccessPolicyRequest, AsyncHandler<UpdateAccessPolicyRequest,UpdateAccessPolicyResult> asyncHandler)
Updates an existing access policy that specifies an identity's access to an IoT SiteWise Monitor portal or project resource.
updateAccessPolicyRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateAssetResult> updateAssetAsync(UpdateAssetRequest updateAssetRequest)
Updates an asset's name. For more information, see Updating assets and models in the IoT SiteWise User Guide.
updateAssetRequest - Future<UpdateAssetResult> updateAssetAsync(UpdateAssetRequest updateAssetRequest, AsyncHandler<UpdateAssetRequest,UpdateAssetResult> asyncHandler)
Updates an asset's name. For more information, see Updating assets and models in the IoT SiteWise User Guide.
updateAssetRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateAssetModelResult> updateAssetModelAsync(UpdateAssetModelRequest updateAssetModelRequest)
Updates an asset model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models in the IoT SiteWise User Guide.
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, IoT SiteWise deletes all previous data for that property. If you remove a hierarchy definition from an asset model, IoT SiteWise disassociates every asset associated with that hierarchy. You can't change the type or data type of an existing property.
updateAssetModelRequest - Future<UpdateAssetModelResult> updateAssetModelAsync(UpdateAssetModelRequest updateAssetModelRequest, AsyncHandler<UpdateAssetModelRequest,UpdateAssetModelResult> asyncHandler)
Updates an asset model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models in the IoT SiteWise User Guide.
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, IoT SiteWise deletes all previous data for that property. If you remove a hierarchy definition from an asset model, IoT SiteWise disassociates every asset associated with that hierarchy. You can't change the type or data type of an existing property.
updateAssetModelRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateAssetPropertyResult> updateAssetPropertyAsync(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 - Future<UpdateAssetPropertyResult> updateAssetPropertyAsync(UpdateAssetPropertyRequest updateAssetPropertyRequest, AsyncHandler<UpdateAssetPropertyRequest,UpdateAssetPropertyResult> asyncHandler)
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 - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateDashboardResult> updateDashboardAsync(UpdateDashboardRequest updateDashboardRequest)
Updates an IoT SiteWise Monitor dashboard.
updateDashboardRequest - Future<UpdateDashboardResult> updateDashboardAsync(UpdateDashboardRequest updateDashboardRequest, AsyncHandler<UpdateDashboardRequest,UpdateDashboardResult> asyncHandler)
Updates an IoT SiteWise Monitor dashboard.
updateDashboardRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateGatewayResult> updateGatewayAsync(UpdateGatewayRequest updateGatewayRequest)
Updates a gateway's name.
updateGatewayRequest - Future<UpdateGatewayResult> updateGatewayAsync(UpdateGatewayRequest updateGatewayRequest, AsyncHandler<UpdateGatewayRequest,UpdateGatewayResult> asyncHandler)
Updates a gateway's name.
updateGatewayRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateGatewayCapabilityConfigurationResult> updateGatewayCapabilityConfigurationAsync(UpdateGatewayCapabilityConfigurationRequest updateGatewayCapabilityConfigurationRequest)
Updates a gateway capability configuration or defines a new capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway.
updateGatewayCapabilityConfigurationRequest - Future<UpdateGatewayCapabilityConfigurationResult> updateGatewayCapabilityConfigurationAsync(UpdateGatewayCapabilityConfigurationRequest updateGatewayCapabilityConfigurationRequest, AsyncHandler<UpdateGatewayCapabilityConfigurationRequest,UpdateGatewayCapabilityConfigurationResult> asyncHandler)
Updates a gateway capability configuration or defines a new capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway.
updateGatewayCapabilityConfigurationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdatePortalResult> updatePortalAsync(UpdatePortalRequest updatePortalRequest)
Updates an IoT SiteWise Monitor portal.
updatePortalRequest - Future<UpdatePortalResult> updatePortalAsync(UpdatePortalRequest updatePortalRequest, AsyncHandler<UpdatePortalRequest,UpdatePortalResult> asyncHandler)
Updates an IoT SiteWise Monitor portal.
updatePortalRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateProjectResult> updateProjectAsync(UpdateProjectRequest updateProjectRequest)
Updates an IoT SiteWise Monitor project.
updateProjectRequest - Future<UpdateProjectResult> updateProjectAsync(UpdateProjectRequest updateProjectRequest, AsyncHandler<UpdateProjectRequest,UpdateProjectResult> asyncHandler)
Updates an IoT SiteWise Monitor project.
updateProjectRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.