@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSIoTSiteWise extends Object implements AWSIoTSiteWise
AWSIoTSiteWise. Convenient method forms pass through to the corresponding overload
that takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
AssociateAssetsResult |
associateAssets(AssociateAssetsRequest request)
Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's model.
|
AssociateTimeSeriesToAssetPropertyResult |
associateTimeSeriesToAssetProperty(AssociateTimeSeriesToAssetPropertyRequest request)
Associates a time series (data stream) with an asset property.
|
BatchAssociateProjectAssetsResult |
batchAssociateProjectAssets(BatchAssociateProjectAssetsRequest request)
Associates a group (batch) of assets with an IoT SiteWise Monitor project.
|
BatchDisassociateProjectAssetsResult |
batchDisassociateProjectAssets(BatchDisassociateProjectAssetsRequest request)
Disassociates a group (batch) of assets from an IoT SiteWise Monitor project.
|
BatchGetAssetPropertyAggregatesResult |
batchGetAssetPropertyAggregates(BatchGetAssetPropertyAggregatesRequest request)
Gets aggregated values (for example, average, minimum, and maximum) for one or more asset properties.
|
BatchGetAssetPropertyValueResult |
batchGetAssetPropertyValue(BatchGetAssetPropertyValueRequest request)
Gets the current value for one or more asset properties.
|
BatchGetAssetPropertyValueHistoryResult |
batchGetAssetPropertyValueHistory(BatchGetAssetPropertyValueHistoryRequest request)
Gets the historical values for one or more asset properties.
|
BatchPutAssetPropertyValueResult |
batchPutAssetPropertyValue(BatchPutAssetPropertyValueRequest request)
Sends a list of asset property values to IoT SiteWise.
|
CreateAccessPolicyResult |
createAccessPolicy(CreateAccessPolicyRequest request)
Creates an access policy that grants the specified identity (IAM Identity Center user, IAM Identity Center group,
or IAM user) access to the specified IoT SiteWise Monitor portal or project resource.
|
CreateAssetResult |
createAsset(CreateAssetRequest request)
Creates an asset from an existing asset model.
|
CreateAssetModelResult |
createAssetModel(CreateAssetModelRequest request)
Creates an asset model from specified property and hierarchy definitions.
|
CreateAssetModelCompositeModelResult |
createAssetModelCompositeModel(CreateAssetModelCompositeModelRequest request)
Creates a custom composite model from specified property and hierarchy definitions.
|
CreateBulkImportJobResult |
createBulkImportJob(CreateBulkImportJobRequest request)
Defines a job to ingest data to IoT SiteWise from Amazon S3.
|
CreateDashboardResult |
createDashboard(CreateDashboardRequest request)
Creates a dashboard in an IoT SiteWise Monitor project.
|
CreateGatewayResult |
createGateway(CreateGatewayRequest request)
Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to
IoT SiteWise.
|
CreatePortalResult |
createPortal(CreatePortalRequest request)
Creates a portal, which can contain projects and dashboards.
|
CreateProjectResult |
createProject(CreateProjectRequest request)
Creates a project in the specified portal.
|
DeleteAccessPolicyResult |
deleteAccessPolicy(DeleteAccessPolicyRequest request)
Deletes an access policy that grants the specified identity access to the specified IoT SiteWise Monitor
resource.
|
DeleteAssetResult |
deleteAsset(DeleteAssetRequest request)
Deletes an asset.
|
DeleteAssetModelResult |
deleteAssetModel(DeleteAssetModelRequest request)
Deletes an asset model.
|
DeleteAssetModelCompositeModelResult |
deleteAssetModelCompositeModel(DeleteAssetModelCompositeModelRequest request)
Deletes a composite model.
|
DeleteDashboardResult |
deleteDashboard(DeleteDashboardRequest request)
Deletes a dashboard from IoT SiteWise Monitor.
|
DeleteGatewayResult |
deleteGateway(DeleteGatewayRequest request)
Deletes a gateway from IoT SiteWise.
|
DeletePortalResult |
deletePortal(DeletePortalRequest request)
Deletes a portal from IoT SiteWise Monitor.
|
DeleteProjectResult |
deleteProject(DeleteProjectRequest request)
Deletes a project from IoT SiteWise Monitor.
|
DeleteTimeSeriesResult |
deleteTimeSeries(DeleteTimeSeriesRequest request)
Deletes a time series (data stream).
|
DescribeAccessPolicyResult |
describeAccessPolicy(DescribeAccessPolicyRequest request)
Describes an access policy, which specifies an identity's access to an IoT SiteWise Monitor portal or project.
|
DescribeActionResult |
describeAction(DescribeActionRequest request)
Retrieves information about an action.
|
DescribeAssetResult |
describeAsset(DescribeAssetRequest request)
Retrieves information about an asset.
|
DescribeAssetCompositeModelResult |
describeAssetCompositeModel(DescribeAssetCompositeModelRequest request)
Retrieves information about an asset composite model (also known as an asset component).
|
DescribeAssetModelResult |
describeAssetModel(DescribeAssetModelRequest request)
Retrieves information about an asset model.
|
DescribeAssetModelCompositeModelResult |
describeAssetModelCompositeModel(DescribeAssetModelCompositeModelRequest request)
Retrieves information about an asset model composite model (also known as an asset model component).
|
DescribeAssetPropertyResult |
describeAssetProperty(DescribeAssetPropertyRequest request)
Retrieves information about an asset property.
|
DescribeBulkImportJobResult |
describeBulkImportJob(DescribeBulkImportJobRequest request)
Retrieves information about a bulk import job request.
|
DescribeDashboardResult |
describeDashboard(DescribeDashboardRequest request)
Retrieves information about a dashboard.
|
DescribeDefaultEncryptionConfigurationResult |
describeDefaultEncryptionConfiguration(DescribeDefaultEncryptionConfigurationRequest request)
Retrieves information about the default encryption configuration for the Amazon Web Services account in the
default or specified Region.
|
DescribeGatewayResult |
describeGateway(DescribeGatewayRequest request)
Retrieves information about a gateway.
|
DescribeGatewayCapabilityConfigurationResult |
describeGatewayCapabilityConfiguration(DescribeGatewayCapabilityConfigurationRequest request)
Retrieves information about a gateway capability configuration.
|
DescribeLoggingOptionsResult |
describeLoggingOptions(DescribeLoggingOptionsRequest request)
Retrieves the current IoT SiteWise logging options.
|
DescribePortalResult |
describePortal(DescribePortalRequest request)
Retrieves information about a portal.
|
DescribeProjectResult |
describeProject(DescribeProjectRequest request)
Retrieves information about a project.
|
DescribeStorageConfigurationResult |
describeStorageConfiguration(DescribeStorageConfigurationRequest request)
Retrieves information about the storage configuration for IoT SiteWise.
|
DescribeTimeSeriesResult |
describeTimeSeries(DescribeTimeSeriesRequest request)
Retrieves information about a time series (data stream).
|
DisassociateAssetsResult |
disassociateAssets(DisassociateAssetsRequest request)
Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model.
|
DisassociateTimeSeriesFromAssetPropertyResult |
disassociateTimeSeriesFromAssetProperty(DisassociateTimeSeriesFromAssetPropertyRequest request)
Disassociates a time series (data stream) from an asset property.
|
ExecuteActionResult |
executeAction(ExecuteActionRequest request)
Executes an action on a target resource.
|
ExecuteQueryResult |
executeQuery(ExecuteQueryRequest request)
Run SQL queries to retrieve metadata and time-series data from asset models, assets, measurements, metrics,
transforms, and aggregates.
|
GetAssetPropertyAggregatesResult |
getAssetPropertyAggregates(GetAssetPropertyAggregatesRequest request)
Gets aggregated values for an asset property.
|
GetAssetPropertyValueResult |
getAssetPropertyValue(GetAssetPropertyValueRequest request)
Gets an asset property's current value.
|
GetAssetPropertyValueHistoryResult |
getAssetPropertyValueHistory(GetAssetPropertyValueHistoryRequest request)
Gets the history of an asset property's values.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetInterpolatedAssetPropertyValuesResult |
getInterpolatedAssetPropertyValues(GetInterpolatedAssetPropertyValuesRequest request)
Get interpolated values for an asset property for a specified time interval, during a period of time.
|
ListAccessPoliciesResult |
listAccessPolicies(ListAccessPoliciesRequest request)
Retrieves a paginated list of access policies for an identity (an IAM Identity Center user, an IAM Identity
Center group, or an IAM user) or an IoT SiteWise Monitor resource (a portal or project).
|
ListActionsResult |
listActions(ListActionsRequest request)
Retrieves a paginated list of actions for a specific target resource.
|
ListAssetModelCompositeModelsResult |
listAssetModelCompositeModels(ListAssetModelCompositeModelsRequest request)
Retrieves a paginated list of composite models associated with the asset model
|
ListAssetModelPropertiesResult |
listAssetModelProperties(ListAssetModelPropertiesRequest request)
Retrieves a paginated list of properties associated with an asset model.
|
ListAssetModelsResult |
listAssetModels(ListAssetModelsRequest request)
Retrieves a paginated list of summaries of all asset models.
|
ListAssetPropertiesResult |
listAssetProperties(ListAssetPropertiesRequest request)
Retrieves a paginated list of properties associated with an asset.
|
ListAssetRelationshipsResult |
listAssetRelationships(ListAssetRelationshipsRequest request)
Retrieves a paginated list of asset relationships for an asset.
|
ListAssetsResult |
listAssets(ListAssetsRequest request)
Retrieves a paginated list of asset summaries.
|
ListAssociatedAssetsResult |
listAssociatedAssets(ListAssociatedAssetsRequest request)
Retrieves a paginated list of associated assets.
|
ListBulkImportJobsResult |
listBulkImportJobs(ListBulkImportJobsRequest request)
Retrieves a paginated list of bulk import job requests.
|
ListCompositionRelationshipsResult |
listCompositionRelationships(ListCompositionRelationshipsRequest request)
Retrieves a paginated list of composition relationships for an asset model of type
COMPONENT_MODEL. |
ListDashboardsResult |
listDashboards(ListDashboardsRequest request)
Retrieves a paginated list of dashboards for an IoT SiteWise Monitor project.
|
ListGatewaysResult |
listGateways(ListGatewaysRequest request)
Retrieves a paginated list of gateways.
|
ListPortalsResult |
listPortals(ListPortalsRequest request)
Retrieves a paginated list of IoT SiteWise Monitor portals.
|
ListProjectAssetsResult |
listProjectAssets(ListProjectAssetsRequest request)
Retrieves a paginated list of assets associated with an IoT SiteWise Monitor project.
|
ListProjectsResult |
listProjects(ListProjectsRequest request)
Retrieves a paginated list of projects for an IoT SiteWise Monitor portal.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Retrieves the list of tags for an IoT SiteWise resource.
|
ListTimeSeriesResult |
listTimeSeries(ListTimeSeriesRequest request)
Retrieves a paginated list of time series (data streams).
|
PutDefaultEncryptionConfigurationResult |
putDefaultEncryptionConfiguration(PutDefaultEncryptionConfigurationRequest request)
Sets the default encryption configuration for the Amazon Web Services account.
|
PutLoggingOptionsResult |
putLoggingOptions(PutLoggingOptionsRequest request)
Sets logging options for IoT SiteWise.
|
PutStorageConfigurationResult |
putStorageConfiguration(PutStorageConfigurationRequest request)
Configures storage settings for IoT SiteWise.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds tags to an IoT SiteWise resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes a tag from an IoT SiteWise resource.
|
UpdateAccessPolicyResult |
updateAccessPolicy(UpdateAccessPolicyRequest request)
Updates an existing access policy that specifies an identity's access to an IoT SiteWise Monitor portal or
project resource.
|
UpdateAssetResult |
updateAsset(UpdateAssetRequest request)
Updates an asset's name.
|
UpdateAssetModelResult |
updateAssetModel(UpdateAssetModelRequest request)
Updates an asset model and all of the assets that were created from the model.
|
UpdateAssetModelCompositeModelResult |
updateAssetModelCompositeModel(UpdateAssetModelCompositeModelRequest request)
Updates a composite model and all of the assets that were created from the model.
|
UpdateAssetPropertyResult |
updateAssetProperty(UpdateAssetPropertyRequest request)
Updates an asset property's alias and notification state.
|
UpdateDashboardResult |
updateDashboard(UpdateDashboardRequest request)
Updates an IoT SiteWise Monitor dashboard.
|
UpdateGatewayResult |
updateGateway(UpdateGatewayRequest request)
Updates a gateway's name.
|
UpdateGatewayCapabilityConfigurationResult |
updateGatewayCapabilityConfiguration(UpdateGatewayCapabilityConfigurationRequest request)
Updates a gateway capability configuration or defines a new capability configuration.
|
UpdatePortalResult |
updatePortal(UpdatePortalRequest request)
Updates an IoT SiteWise Monitor portal.
|
UpdateProjectResult |
updateProject(UpdateProjectRequest request)
Updates an IoT SiteWise Monitor project.
|
AWSIoTSiteWiseWaiters |
waiters() |
public AssociateAssetsResult associateAssets(AssociateAssetsRequest request)
AWSIoTSiteWiseAssociates 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.
associateAssets in interface AWSIoTSiteWisepublic AssociateTimeSeriesToAssetPropertyResult associateTimeSeriesToAssetProperty(AssociateTimeSeriesToAssetPropertyRequest request)
AWSIoTSiteWiseAssociates a time series (data stream) with an asset property.
associateTimeSeriesToAssetProperty in interface AWSIoTSiteWisepublic BatchAssociateProjectAssetsResult batchAssociateProjectAssets(BatchAssociateProjectAssetsRequest request)
AWSIoTSiteWiseAssociates a group (batch) of assets with an IoT SiteWise Monitor project.
batchAssociateProjectAssets in interface AWSIoTSiteWisepublic BatchDisassociateProjectAssetsResult batchDisassociateProjectAssets(BatchDisassociateProjectAssetsRequest request)
AWSIoTSiteWiseDisassociates a group (batch) of assets from an IoT SiteWise Monitor project.
batchDisassociateProjectAssets in interface AWSIoTSiteWisepublic BatchGetAssetPropertyAggregatesResult batchGetAssetPropertyAggregates(BatchGetAssetPropertyAggregatesRequest request)
AWSIoTSiteWiseGets 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.
batchGetAssetPropertyAggregates in interface AWSIoTSiteWisepublic BatchGetAssetPropertyValueResult batchGetAssetPropertyValue(BatchGetAssetPropertyValueRequest request)
AWSIoTSiteWiseGets the current value for one or more asset properties. For more information, see Querying current values in the IoT SiteWise User Guide.
batchGetAssetPropertyValue in interface AWSIoTSiteWisepublic BatchGetAssetPropertyValueHistoryResult batchGetAssetPropertyValueHistory(BatchGetAssetPropertyValueHistoryRequest request)
AWSIoTSiteWiseGets the historical values for one or more asset properties. For more information, see Querying historical values in the IoT SiteWise User Guide.
batchGetAssetPropertyValueHistory in interface AWSIoTSiteWisepublic BatchPutAssetPropertyValueResult batchPutAssetPropertyValue(BatchPutAssetPropertyValueRequest request)
AWSIoTSiteWiseSends 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.
batchPutAssetPropertyValue in interface AWSIoTSiteWisepublic CreateAccessPolicyResult createAccessPolicy(CreateAccessPolicyRequest request)
AWSIoTSiteWiseCreates an access policy that grants the specified identity (IAM Identity Center user, IAM Identity Center group, or IAM user) access to the specified IoT SiteWise Monitor portal or project resource.
createAccessPolicy in interface AWSIoTSiteWisepublic CreateAssetResult createAsset(CreateAssetRequest request)
AWSIoTSiteWiseCreates an asset from an existing asset model. For more information, see Creating assets in the IoT SiteWise User Guide.
createAsset in interface AWSIoTSiteWisepublic CreateAssetModelResult createAssetModel(CreateAssetModelRequest request)
AWSIoTSiteWiseCreates an asset model from specified property and hierarchy definitions. You create assets from asset models. With asset models, you can easily create assets of the same type that have standardized definitions. Each asset created from a model inherits the asset model's property and hierarchy definitions. For more information, see Defining asset models in the IoT SiteWise User Guide.
You can create two types of asset models, ASSET_MODEL or COMPONENT_MODEL.
ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.
COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
createAssetModel in interface AWSIoTSiteWisepublic CreateAssetModelCompositeModelResult createAssetModelCompositeModel(CreateAssetModelCompositeModelRequest request)
AWSIoTSiteWise
Creates a custom composite model from specified property and hierarchy definitions. There are two types of custom
composite models, inline and component-model-based.
Use component-model-based custom composite models to define standard, reusable components. A component-model-based custom composite model consists of a name, a description, and the ID of the component model it references. A component-model-based custom composite model has no properties of its own; its referenced component model provides its associated properties to any created assets. For more information, see Custom composite models (Components) in the IoT SiteWise User Guide.
Use inline custom composite models to organize the properties of an asset model. The properties of inline custom composite models are local to the asset model where they are included and can't be used to create multiple assets.
To create a component-model-based model, specify the composedAssetModelId of an existing asset model
with assetModelType of COMPONENT_MODEL.
To create an inline model, specify the assetModelCompositeModelProperties and don't include an
composedAssetModelId.
createAssetModelCompositeModel in interface AWSIoTSiteWisepublic CreateBulkImportJobResult createBulkImportJob(CreateBulkImportJobRequest request)
AWSIoTSiteWiseDefines a job to ingest data to IoT SiteWise from Amazon S3. For more information, see Create a bulk import job (CLI) in the Amazon Simple Storage Service User Guide.
Before you create a bulk import job, you must enable IoT SiteWise warm tier or IoT SiteWise cold tier. For more information about how to configure storage settings, see PutStorageConfiguration.
Bulk import is designed to store historical data to IoT SiteWise. It does not trigger computations or notifications on IoT SiteWise warm or cold tier storage.
createBulkImportJob in interface AWSIoTSiteWisepublic CreateDashboardResult createDashboard(CreateDashboardRequest request)
AWSIoTSiteWiseCreates a dashboard in an IoT SiteWise Monitor project.
createDashboard in interface AWSIoTSiteWisepublic CreateGatewayResult createGateway(CreateGatewayRequest request)
AWSIoTSiteWiseCreates 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.
createGateway in interface AWSIoTSiteWisepublic CreatePortalResult createPortal(CreatePortalRequest request)
AWSIoTSiteWiseCreates a portal, which can contain projects and dashboards. IoT SiteWise Monitor uses IAM Identity Center or IAM to authenticate portal users and manage user permissions.
Before you can sign in to a new portal, you must add at least one identity to that portal. For more information, see Adding or removing portal administrators in the IoT SiteWise User Guide.
createPortal in interface AWSIoTSiteWisepublic CreateProjectResult createProject(CreateProjectRequest request)
AWSIoTSiteWiseCreates a project in the specified portal.
Make sure that the project name and description don't contain confidential information.
createProject in interface AWSIoTSiteWisepublic DeleteAccessPolicyResult deleteAccessPolicy(DeleteAccessPolicyRequest request)
AWSIoTSiteWiseDeletes 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.
deleteAccessPolicy in interface AWSIoTSiteWisepublic DeleteAssetResult deleteAsset(DeleteAssetRequest request)
AWSIoTSiteWiseDeletes 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.
deleteAsset in interface AWSIoTSiteWisepublic DeleteAssetModelResult deleteAssetModel(DeleteAssetModelRequest request)
AWSIoTSiteWiseDeletes 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.
deleteAssetModel in interface AWSIoTSiteWisepublic DeleteAssetModelCompositeModelResult deleteAssetModelCompositeModel(DeleteAssetModelCompositeModelRequest request)
AWSIoTSiteWiseDeletes a composite model. This action can't be undone. You must delete all assets created from a composite model before you can delete the model. Also, you can't delete a composite model if a parent asset model exists that contains a property formula expression that depends on the asset model that you want to delete. For more information, see Deleting assets and models in the IoT SiteWise User Guide.
deleteAssetModelCompositeModel in interface AWSIoTSiteWisepublic DeleteDashboardResult deleteDashboard(DeleteDashboardRequest request)
AWSIoTSiteWiseDeletes a dashboard from IoT SiteWise Monitor.
deleteDashboard in interface AWSIoTSiteWisepublic DeleteGatewayResult deleteGateway(DeleteGatewayRequest request)
AWSIoTSiteWiseDeletes a gateway from IoT SiteWise. When you delete a gateway, some of the gateway's files remain in your gateway's file system.
deleteGateway in interface AWSIoTSiteWisepublic DeletePortalResult deletePortal(DeletePortalRequest request)
AWSIoTSiteWiseDeletes a portal from IoT SiteWise Monitor.
deletePortal in interface AWSIoTSiteWisepublic DeleteProjectResult deleteProject(DeleteProjectRequest request)
AWSIoTSiteWiseDeletes a project from IoT SiteWise Monitor.
deleteProject in interface AWSIoTSiteWisepublic DeleteTimeSeriesResult deleteTimeSeries(DeleteTimeSeriesRequest request)
AWSIoTSiteWiseDeletes 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.
deleteTimeSeries in interface AWSIoTSiteWisepublic DescribeAccessPolicyResult describeAccessPolicy(DescribeAccessPolicyRequest request)
AWSIoTSiteWiseDescribes an access policy, which specifies an identity's access to an IoT SiteWise Monitor portal or project.
describeAccessPolicy in interface AWSIoTSiteWisepublic DescribeActionResult describeAction(DescribeActionRequest request)
AWSIoTSiteWiseRetrieves information about an action.
describeAction in interface AWSIoTSiteWisepublic DescribeAssetResult describeAsset(DescribeAssetRequest request)
AWSIoTSiteWiseRetrieves information about an asset.
describeAsset in interface AWSIoTSiteWisepublic DescribeAssetCompositeModelResult describeAssetCompositeModel(DescribeAssetCompositeModelRequest request)
AWSIoTSiteWise
Retrieves information about an asset composite model (also known as an asset component). An
AssetCompositeModel is an instance of an AssetModelCompositeModel. If you want to see
information about the model this is based on, call DescribeAssetModelCompositeModel.
describeAssetCompositeModel in interface AWSIoTSiteWisepublic DescribeAssetModelResult describeAssetModel(DescribeAssetModelRequest request)
AWSIoTSiteWiseRetrieves information about an asset model.
describeAssetModel in interface AWSIoTSiteWisepublic DescribeAssetModelCompositeModelResult describeAssetModelCompositeModel(DescribeAssetModelCompositeModelRequest request)
AWSIoTSiteWiseRetrieves information about an asset model composite model (also known as an asset model component). For more information, see Custom composite models (Components) in the IoT SiteWise User Guide.
describeAssetModelCompositeModel in interface AWSIoTSiteWisepublic DescribeAssetPropertyResult describeAssetProperty(DescribeAssetPropertyRequest request)
AWSIoTSiteWiseRetrieves 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.
describeAssetProperty in interface AWSIoTSiteWisepublic DescribeBulkImportJobResult describeBulkImportJob(DescribeBulkImportJobRequest request)
AWSIoTSiteWiseRetrieves 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.
describeBulkImportJob in interface AWSIoTSiteWisepublic DescribeDashboardResult describeDashboard(DescribeDashboardRequest request)
AWSIoTSiteWiseRetrieves information about a dashboard.
describeDashboard in interface AWSIoTSiteWisepublic DescribeDefaultEncryptionConfigurationResult describeDefaultEncryptionConfiguration(DescribeDefaultEncryptionConfigurationRequest request)
AWSIoTSiteWiseRetrieves 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.
describeDefaultEncryptionConfiguration in interface AWSIoTSiteWisepublic DescribeGatewayResult describeGateway(DescribeGatewayRequest request)
AWSIoTSiteWiseRetrieves information about a gateway.
describeGateway in interface AWSIoTSiteWisepublic DescribeGatewayCapabilityConfigurationResult describeGatewayCapabilityConfiguration(DescribeGatewayCapabilityConfigurationRequest request)
AWSIoTSiteWiseRetrieves 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.
describeGatewayCapabilityConfiguration in interface AWSIoTSiteWisepublic DescribeLoggingOptionsResult describeLoggingOptions(DescribeLoggingOptionsRequest request)
AWSIoTSiteWiseRetrieves the current IoT SiteWise logging options.
describeLoggingOptions in interface AWSIoTSiteWisepublic DescribePortalResult describePortal(DescribePortalRequest request)
AWSIoTSiteWiseRetrieves information about a portal.
describePortal in interface AWSIoTSiteWisepublic DescribeProjectResult describeProject(DescribeProjectRequest request)
AWSIoTSiteWiseRetrieves information about a project.
describeProject in interface AWSIoTSiteWisepublic DescribeStorageConfigurationResult describeStorageConfiguration(DescribeStorageConfigurationRequest request)
AWSIoTSiteWiseRetrieves information about the storage configuration for IoT SiteWise.
describeStorageConfiguration in interface AWSIoTSiteWisepublic DescribeTimeSeriesResult describeTimeSeries(DescribeTimeSeriesRequest request)
AWSIoTSiteWiseRetrieves 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.
describeTimeSeries in interface AWSIoTSiteWisepublic DisassociateAssetsResult disassociateAssets(DisassociateAssetsRequest request)
AWSIoTSiteWiseDisassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model.
disassociateAssets in interface AWSIoTSiteWisepublic DisassociateTimeSeriesFromAssetPropertyResult disassociateTimeSeriesFromAssetProperty(DisassociateTimeSeriesFromAssetPropertyRequest request)
AWSIoTSiteWiseDisassociates a time series (data stream) from an asset property.
disassociateTimeSeriesFromAssetProperty in interface AWSIoTSiteWisepublic ExecuteActionResult executeAction(ExecuteActionRequest request)
AWSIoTSiteWiseExecutes an action on a target resource.
executeAction in interface AWSIoTSiteWisepublic ExecuteQueryResult executeQuery(ExecuteQueryRequest request)
AWSIoTSiteWiseRun SQL queries to retrieve metadata and time-series data from asset models, assets, measurements, metrics, transforms, and aggregates.
executeQuery in interface AWSIoTSiteWisepublic GetAssetPropertyAggregatesResult getAssetPropertyAggregates(GetAssetPropertyAggregatesRequest request)
AWSIoTSiteWiseGets 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.
getAssetPropertyAggregates in interface AWSIoTSiteWisepublic GetAssetPropertyValueResult getAssetPropertyValue(GetAssetPropertyValueRequest request)
AWSIoTSiteWiseGets 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.
getAssetPropertyValue in interface AWSIoTSiteWisepublic GetAssetPropertyValueHistoryResult getAssetPropertyValueHistory(GetAssetPropertyValueHistoryRequest request)
AWSIoTSiteWiseGets 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.
getAssetPropertyValueHistory in interface AWSIoTSiteWisepublic GetInterpolatedAssetPropertyValuesResult getInterpolatedAssetPropertyValues(GetInterpolatedAssetPropertyValuesRequest request)
AWSIoTSiteWiseGet 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.
getInterpolatedAssetPropertyValues in interface AWSIoTSiteWisepublic ListAccessPoliciesResult listAccessPolicies(ListAccessPoliciesRequest request)
AWSIoTSiteWiseRetrieves a paginated list of access policies for an identity (an IAM Identity Center user, an IAM Identity Center group, or an IAM user) or an IoT SiteWise Monitor resource (a portal or project).
listAccessPolicies in interface AWSIoTSiteWisepublic ListActionsResult listActions(ListActionsRequest request)
AWSIoTSiteWiseRetrieves a paginated list of actions for a specific target resource.
listActions in interface AWSIoTSiteWisepublic ListAssetModelCompositeModelsResult listAssetModelCompositeModels(ListAssetModelCompositeModelsRequest request)
AWSIoTSiteWiseRetrieves a paginated list of composite models associated with the asset model
listAssetModelCompositeModels in interface AWSIoTSiteWisepublic ListAssetModelPropertiesResult listAssetModelProperties(ListAssetModelPropertiesRequest request)
AWSIoTSiteWiseRetrieves a paginated list of properties associated with an asset model. If you update properties associated with the model before you finish listing all the properties, you need to start all over again.
listAssetModelProperties in interface AWSIoTSiteWisepublic ListAssetModelsResult listAssetModels(ListAssetModelsRequest request)
AWSIoTSiteWiseRetrieves a paginated list of summaries of all asset models.
listAssetModels in interface AWSIoTSiteWisepublic ListAssetPropertiesResult listAssetProperties(ListAssetPropertiesRequest request)
AWSIoTSiteWiseRetrieves a paginated list of properties associated with an asset. If you update properties associated with the model before you finish listing all the properties, you need to start all over again.
listAssetProperties in interface AWSIoTSiteWisepublic ListAssetRelationshipsResult listAssetRelationships(ListAssetRelationshipsRequest request)
AWSIoTSiteWiseRetrieves 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.
listAssetRelationships in interface AWSIoTSiteWisepublic ListAssetsResult listAssets(ListAssetsRequest request)
AWSIoTSiteWiseRetrieves 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.
listAssets in interface AWSIoTSiteWisepublic ListAssociatedAssetsResult listAssociatedAssets(ListAssociatedAssetsRequest request)
AWSIoTSiteWiseRetrieves 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.
listAssociatedAssets in interface AWSIoTSiteWisepublic ListBulkImportJobsResult listBulkImportJobs(ListBulkImportJobsRequest request)
AWSIoTSiteWiseRetrieves a paginated list of bulk import job requests. For more information, see List bulk import jobs (CLI) in the IoT SiteWise User Guide.
listBulkImportJobs in interface AWSIoTSiteWisepublic ListCompositionRelationshipsResult listCompositionRelationships(ListCompositionRelationshipsRequest request)
AWSIoTSiteWise
Retrieves a paginated list of composition relationships for an asset model of type COMPONENT_MODEL.
listCompositionRelationships in interface AWSIoTSiteWisepublic ListDashboardsResult listDashboards(ListDashboardsRequest request)
AWSIoTSiteWiseRetrieves a paginated list of dashboards for an IoT SiteWise Monitor project.
listDashboards in interface AWSIoTSiteWisepublic ListGatewaysResult listGateways(ListGatewaysRequest request)
AWSIoTSiteWiseRetrieves a paginated list of gateways.
listGateways in interface AWSIoTSiteWisepublic ListPortalsResult listPortals(ListPortalsRequest request)
AWSIoTSiteWiseRetrieves a paginated list of IoT SiteWise Monitor portals.
listPortals in interface AWSIoTSiteWisepublic ListProjectAssetsResult listProjectAssets(ListProjectAssetsRequest request)
AWSIoTSiteWiseRetrieves a paginated list of assets associated with an IoT SiteWise Monitor project.
listProjectAssets in interface AWSIoTSiteWisepublic ListProjectsResult listProjects(ListProjectsRequest request)
AWSIoTSiteWiseRetrieves a paginated list of projects for an IoT SiteWise Monitor portal.
listProjects in interface AWSIoTSiteWisepublic ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AWSIoTSiteWiseRetrieves the list of tags for an IoT SiteWise resource.
listTagsForResource in interface AWSIoTSiteWisepublic ListTimeSeriesResult listTimeSeries(ListTimeSeriesRequest request)
AWSIoTSiteWiseRetrieves a paginated list of time series (data streams).
listTimeSeries in interface AWSIoTSiteWisepublic PutDefaultEncryptionConfigurationResult putDefaultEncryptionConfiguration(PutDefaultEncryptionConfigurationRequest request)
AWSIoTSiteWiseSets the default encryption configuration for the Amazon Web Services account. For more information, see Key management in the IoT SiteWise User Guide.
putDefaultEncryptionConfiguration in interface AWSIoTSiteWisepublic PutLoggingOptionsResult putLoggingOptions(PutLoggingOptionsRequest request)
AWSIoTSiteWiseSets logging options for IoT SiteWise.
putLoggingOptions in interface AWSIoTSiteWisepublic PutStorageConfigurationResult putStorageConfiguration(PutStorageConfigurationRequest request)
AWSIoTSiteWiseConfigures storage settings for IoT SiteWise.
putStorageConfiguration in interface AWSIoTSiteWisepublic TagResourceResult tagResource(TagResourceRequest request)
AWSIoTSiteWiseAdds tags to an IoT SiteWise resource. If a tag already exists for the resource, this operation updates the tag's value.
tagResource in interface AWSIoTSiteWisepublic UntagResourceResult untagResource(UntagResourceRequest request)
AWSIoTSiteWiseRemoves a tag from an IoT SiteWise resource.
untagResource in interface AWSIoTSiteWisepublic UpdateAccessPolicyResult updateAccessPolicy(UpdateAccessPolicyRequest request)
AWSIoTSiteWiseUpdates an existing access policy that specifies an identity's access to an IoT SiteWise Monitor portal or project resource.
updateAccessPolicy in interface AWSIoTSiteWisepublic UpdateAssetResult updateAsset(UpdateAssetRequest request)
AWSIoTSiteWiseUpdates an asset's name. For more information, see Updating assets and models in the IoT SiteWise User Guide.
updateAsset in interface AWSIoTSiteWisepublic UpdateAssetModelResult updateAssetModel(UpdateAssetModelRequest request)
AWSIoTSiteWiseUpdates an asset model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models in the IoT SiteWise User Guide.
If you remove a property from an asset model, IoT SiteWise deletes all previous data for that property. You can’t change the type or data type of an existing property.
To replace an existing asset model property with a new one with the same name, do the following:
Submit an UpdateAssetModel request with the entire existing property removed.
Submit a second UpdateAssetModel request that includes the new property. The new asset property will
have the same name as the previous one and IoT SiteWise will generate a new unique id.
updateAssetModel in interface AWSIoTSiteWisepublic UpdateAssetModelCompositeModelResult updateAssetModelCompositeModel(UpdateAssetModelCompositeModelRequest request)
AWSIoTSiteWiseUpdates a composite model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models in the IoT SiteWise User Guide.
If you remove a property from a composite asset model, IoT SiteWise deletes all previous data for that property. You can’t change the type or data type of an existing property.
To replace an existing composite asset model property with a new one with the same name, do the
following:
Submit an UpdateAssetModelCompositeModel request with the entire existing property removed.
Submit a second UpdateAssetModelCompositeModel request that includes the new property. The new asset
property will have the same name as the previous one and IoT SiteWise will generate a new unique
id.
updateAssetModelCompositeModel in interface AWSIoTSiteWisepublic UpdateAssetPropertyResult updateAssetProperty(UpdateAssetPropertyRequest request)
AWSIoTSiteWiseUpdates 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.
updateAssetProperty in interface AWSIoTSiteWisepublic UpdateDashboardResult updateDashboard(UpdateDashboardRequest request)
AWSIoTSiteWiseUpdates an IoT SiteWise Monitor dashboard.
updateDashboard in interface AWSIoTSiteWisepublic UpdateGatewayResult updateGateway(UpdateGatewayRequest request)
AWSIoTSiteWiseUpdates a gateway's name.
updateGateway in interface AWSIoTSiteWisepublic UpdateGatewayCapabilityConfigurationResult updateGatewayCapabilityConfiguration(UpdateGatewayCapabilityConfigurationRequest request)
AWSIoTSiteWiseUpdates 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.
updateGatewayCapabilityConfiguration in interface AWSIoTSiteWisepublic UpdatePortalResult updatePortal(UpdatePortalRequest request)
AWSIoTSiteWiseUpdates an IoT SiteWise Monitor portal.
updatePortal in interface AWSIoTSiteWisepublic UpdateProjectResult updateProject(UpdateProjectRequest request)
AWSIoTSiteWiseUpdates an IoT SiteWise Monitor project.
updateProject in interface AWSIoTSiteWisepublic void shutdown()
AWSIoTSiteWiseshutdown in interface AWSIoTSiteWisepublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSIoTSiteWiseResponse metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata in interface AWSIoTSiteWiserequest - The originally executed request.public AWSIoTSiteWiseWaiters waiters()
waiters in interface AWSIoTSiteWise