@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSIoTSiteWise
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSIoTSiteWise
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.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
AssociateAssetsResult |
associateAssets(AssociateAssetsRequest associateAssetsRequest)
Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's model.
|
AssociateTimeSeriesToAssetPropertyResult |
associateTimeSeriesToAssetProperty(AssociateTimeSeriesToAssetPropertyRequest associateTimeSeriesToAssetPropertyRequest)
Associates a time series (data stream) with an asset property.
|
BatchAssociateProjectAssetsResult |
batchAssociateProjectAssets(BatchAssociateProjectAssetsRequest batchAssociateProjectAssetsRequest)
Associates a group (batch) of assets with an IoT SiteWise Monitor project.
|
BatchDisassociateProjectAssetsResult |
batchDisassociateProjectAssets(BatchDisassociateProjectAssetsRequest batchDisassociateProjectAssetsRequest)
Disassociates a group (batch) of assets from an IoT SiteWise Monitor project.
|
BatchGetAssetPropertyAggregatesResult |
batchGetAssetPropertyAggregates(BatchGetAssetPropertyAggregatesRequest batchGetAssetPropertyAggregatesRequest)
Gets aggregated values (for example, average, minimum, and maximum) for one or more asset properties.
|
BatchGetAssetPropertyValueResult |
batchGetAssetPropertyValue(BatchGetAssetPropertyValueRequest batchGetAssetPropertyValueRequest)
Gets the current value for one or more asset properties.
|
BatchGetAssetPropertyValueHistoryResult |
batchGetAssetPropertyValueHistory(BatchGetAssetPropertyValueHistoryRequest batchGetAssetPropertyValueHistoryRequest)
Gets the historical values for one or more asset properties.
|
BatchPutAssetPropertyValueResult |
batchPutAssetPropertyValue(BatchPutAssetPropertyValueRequest batchPutAssetPropertyValueRequest)
Sends a list of asset property values to IoT SiteWise.
|
CreateAccessPolicyResult |
createAccessPolicy(CreateAccessPolicyRequest createAccessPolicyRequest)
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 createAssetRequest)
Creates an asset from an existing asset model.
|
CreateAssetModelResult |
createAssetModel(CreateAssetModelRequest createAssetModelRequest)
Creates an asset model from specified property and hierarchy definitions.
|
CreateAssetModelCompositeModelResult |
createAssetModelCompositeModel(CreateAssetModelCompositeModelRequest createAssetModelCompositeModelRequest)
Creates a custom composite model from specified property and hierarchy definitions.
|
CreateBulkImportJobResult |
createBulkImportJob(CreateBulkImportJobRequest createBulkImportJobRequest)
Defines a job to ingest data to IoT SiteWise from Amazon S3.
|
CreateDashboardResult |
createDashboard(CreateDashboardRequest createDashboardRequest)
Creates a dashboard in an IoT SiteWise Monitor project.
|
CreateGatewayResult |
createGateway(CreateGatewayRequest createGatewayRequest)
Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to
IoT SiteWise.
|
CreatePortalResult |
createPortal(CreatePortalRequest createPortalRequest)
Creates a portal, which can contain projects and dashboards.
|
CreateProjectResult |
createProject(CreateProjectRequest createProjectRequest)
Creates a project in the specified portal.
|
DeleteAccessPolicyResult |
deleteAccessPolicy(DeleteAccessPolicyRequest deleteAccessPolicyRequest)
Deletes an access policy that grants the specified identity access to the specified IoT SiteWise Monitor
resource.
|
DeleteAssetResult |
deleteAsset(DeleteAssetRequest deleteAssetRequest)
Deletes an asset.
|
DeleteAssetModelResult |
deleteAssetModel(DeleteAssetModelRequest deleteAssetModelRequest)
Deletes an asset model.
|
DeleteAssetModelCompositeModelResult |
deleteAssetModelCompositeModel(DeleteAssetModelCompositeModelRequest deleteAssetModelCompositeModelRequest)
Deletes a composite model.
|
DeleteDashboardResult |
deleteDashboard(DeleteDashboardRequest deleteDashboardRequest)
Deletes a dashboard from IoT SiteWise Monitor.
|
DeleteGatewayResult |
deleteGateway(DeleteGatewayRequest deleteGatewayRequest)
Deletes a gateway from IoT SiteWise.
|
DeletePortalResult |
deletePortal(DeletePortalRequest deletePortalRequest)
Deletes a portal from IoT SiteWise Monitor.
|
DeleteProjectResult |
deleteProject(DeleteProjectRequest deleteProjectRequest)
Deletes a project from IoT SiteWise Monitor.
|
DeleteTimeSeriesResult |
deleteTimeSeries(DeleteTimeSeriesRequest deleteTimeSeriesRequest)
Deletes a time series (data stream).
|
DescribeAccessPolicyResult |
describeAccessPolicy(DescribeAccessPolicyRequest describeAccessPolicyRequest)
Describes an access policy, which specifies an identity's access to an IoT SiteWise Monitor portal or project.
|
DescribeActionResult |
describeAction(DescribeActionRequest describeActionRequest)
Retrieves information about an action.
|
DescribeAssetResult |
describeAsset(DescribeAssetRequest describeAssetRequest)
Retrieves information about an asset.
|
DescribeAssetCompositeModelResult |
describeAssetCompositeModel(DescribeAssetCompositeModelRequest describeAssetCompositeModelRequest)
Retrieves information about an asset composite model (also known as an asset component).
|
DescribeAssetModelResult |
describeAssetModel(DescribeAssetModelRequest describeAssetModelRequest)
Retrieves information about an asset model.
|
DescribeAssetModelCompositeModelResult |
describeAssetModelCompositeModel(DescribeAssetModelCompositeModelRequest describeAssetModelCompositeModelRequest)
Retrieves information about an asset model composite model (also known as an asset model component).
|
DescribeAssetPropertyResult |
describeAssetProperty(DescribeAssetPropertyRequest describeAssetPropertyRequest)
Retrieves information about an asset property.
|
DescribeBulkImportJobResult |
describeBulkImportJob(DescribeBulkImportJobRequest describeBulkImportJobRequest)
Retrieves information about a bulk import job request.
|
DescribeDashboardResult |
describeDashboard(DescribeDashboardRequest describeDashboardRequest)
Retrieves information about a dashboard.
|
DescribeDefaultEncryptionConfigurationResult |
describeDefaultEncryptionConfiguration(DescribeDefaultEncryptionConfigurationRequest describeDefaultEncryptionConfigurationRequest)
Retrieves information about the default encryption configuration for the Amazon Web Services account in the
default or specified Region.
|
DescribeGatewayResult |
describeGateway(DescribeGatewayRequest describeGatewayRequest)
Retrieves information about a gateway.
|
DescribeGatewayCapabilityConfigurationResult |
describeGatewayCapabilityConfiguration(DescribeGatewayCapabilityConfigurationRequest describeGatewayCapabilityConfigurationRequest)
Retrieves information about a gateway capability configuration.
|
DescribeLoggingOptionsResult |
describeLoggingOptions(DescribeLoggingOptionsRequest describeLoggingOptionsRequest)
Retrieves the current IoT SiteWise logging options.
|
DescribePortalResult |
describePortal(DescribePortalRequest describePortalRequest)
Retrieves information about a portal.
|
DescribeProjectResult |
describeProject(DescribeProjectRequest describeProjectRequest)
Retrieves information about a project.
|
DescribeStorageConfigurationResult |
describeStorageConfiguration(DescribeStorageConfigurationRequest describeStorageConfigurationRequest)
Retrieves information about the storage configuration for IoT SiteWise.
|
DescribeTimeSeriesResult |
describeTimeSeries(DescribeTimeSeriesRequest describeTimeSeriesRequest)
Retrieves information about a time series (data stream).
|
DisassociateAssetsResult |
disassociateAssets(DisassociateAssetsRequest disassociateAssetsRequest)
Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model.
|
DisassociateTimeSeriesFromAssetPropertyResult |
disassociateTimeSeriesFromAssetProperty(DisassociateTimeSeriesFromAssetPropertyRequest disassociateTimeSeriesFromAssetPropertyRequest)
Disassociates a time series (data stream) from an asset property.
|
ExecuteActionResult |
executeAction(ExecuteActionRequest executeActionRequest)
Executes an action on a target resource.
|
ExecuteQueryResult |
executeQuery(ExecuteQueryRequest executeQueryRequest)
Run SQL queries to retrieve metadata and time-series data from asset models, assets, measurements, metrics,
transforms, and aggregates.
|
GetAssetPropertyAggregatesResult |
getAssetPropertyAggregates(GetAssetPropertyAggregatesRequest getAssetPropertyAggregatesRequest)
Gets aggregated values for an asset property.
|
GetAssetPropertyValueResult |
getAssetPropertyValue(GetAssetPropertyValueRequest getAssetPropertyValueRequest)
Gets an asset property's current value.
|
GetAssetPropertyValueHistoryResult |
getAssetPropertyValueHistory(GetAssetPropertyValueHistoryRequest getAssetPropertyValueHistoryRequest)
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 getInterpolatedAssetPropertyValuesRequest)
Get interpolated values for an asset property for a specified time interval, during a period of time.
|
ListAccessPoliciesResult |
listAccessPolicies(ListAccessPoliciesRequest listAccessPoliciesRequest)
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 listActionsRequest)
Retrieves a paginated list of actions for a specific target resource.
|
ListAssetModelCompositeModelsResult |
listAssetModelCompositeModels(ListAssetModelCompositeModelsRequest listAssetModelCompositeModelsRequest)
Retrieves a paginated list of composite models associated with the asset model
|
ListAssetModelPropertiesResult |
listAssetModelProperties(ListAssetModelPropertiesRequest listAssetModelPropertiesRequest)
Retrieves a paginated list of properties associated with an asset model.
|
ListAssetModelsResult |
listAssetModels(ListAssetModelsRequest listAssetModelsRequest)
Retrieves a paginated list of summaries of all asset models.
|
ListAssetPropertiesResult |
listAssetProperties(ListAssetPropertiesRequest listAssetPropertiesRequest)
Retrieves a paginated list of properties associated with an asset.
|
ListAssetRelationshipsResult |
listAssetRelationships(ListAssetRelationshipsRequest listAssetRelationshipsRequest)
Retrieves a paginated list of asset relationships for an asset.
|
ListAssetsResult |
listAssets(ListAssetsRequest listAssetsRequest)
Retrieves a paginated list of asset summaries.
|
ListAssociatedAssetsResult |
listAssociatedAssets(ListAssociatedAssetsRequest listAssociatedAssetsRequest)
Retrieves a paginated list of associated assets.
|
ListBulkImportJobsResult |
listBulkImportJobs(ListBulkImportJobsRequest listBulkImportJobsRequest)
Retrieves a paginated list of bulk import job requests.
|
ListCompositionRelationshipsResult |
listCompositionRelationships(ListCompositionRelationshipsRequest listCompositionRelationshipsRequest)
Retrieves a paginated list of composition relationships for an asset model of type
COMPONENT_MODEL . |
ListDashboardsResult |
listDashboards(ListDashboardsRequest listDashboardsRequest)
Retrieves a paginated list of dashboards for an IoT SiteWise Monitor project.
|
ListGatewaysResult |
listGateways(ListGatewaysRequest listGatewaysRequest)
Retrieves a paginated list of gateways.
|
ListPortalsResult |
listPortals(ListPortalsRequest listPortalsRequest)
Retrieves a paginated list of IoT SiteWise Monitor portals.
|
ListProjectAssetsResult |
listProjectAssets(ListProjectAssetsRequest listProjectAssetsRequest)
Retrieves a paginated list of assets associated with an IoT SiteWise Monitor project.
|
ListProjectsResult |
listProjects(ListProjectsRequest listProjectsRequest)
Retrieves a paginated list of projects for an IoT SiteWise Monitor portal.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Retrieves the list of tags for an IoT SiteWise resource.
|
ListTimeSeriesResult |
listTimeSeries(ListTimeSeriesRequest listTimeSeriesRequest)
Retrieves a paginated list of time series (data streams).
|
PutDefaultEncryptionConfigurationResult |
putDefaultEncryptionConfiguration(PutDefaultEncryptionConfigurationRequest putDefaultEncryptionConfigurationRequest)
Sets the default encryption configuration for the Amazon Web Services account.
|
PutLoggingOptionsResult |
putLoggingOptions(PutLoggingOptionsRequest putLoggingOptionsRequest)
Sets logging options for IoT SiteWise.
|
PutStorageConfigurationResult |
putStorageConfiguration(PutStorageConfigurationRequest putStorageConfigurationRequest)
Configures storage settings for IoT SiteWise.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Adds tags to an IoT SiteWise resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag from an IoT SiteWise resource.
|
UpdateAccessPolicyResult |
updateAccessPolicy(UpdateAccessPolicyRequest updateAccessPolicyRequest)
Updates an existing access policy that specifies an identity's access to an IoT SiteWise Monitor portal or
project resource.
|
UpdateAssetResult |
updateAsset(UpdateAssetRequest updateAssetRequest)
Updates an asset's name.
|
UpdateAssetModelResult |
updateAssetModel(UpdateAssetModelRequest updateAssetModelRequest)
Updates an asset model and all of the assets that were created from the model.
|
UpdateAssetModelCompositeModelResult |
updateAssetModelCompositeModel(UpdateAssetModelCompositeModelRequest updateAssetModelCompositeModelRequest)
Updates a composite model and all of the assets that were created from the model.
|
UpdateAssetPropertyResult |
updateAssetProperty(UpdateAssetPropertyRequest updateAssetPropertyRequest)
Updates an asset property's alias and notification state.
|
UpdateDashboardResult |
updateDashboard(UpdateDashboardRequest updateDashboardRequest)
Updates an IoT SiteWise Monitor dashboard.
|
UpdateGatewayResult |
updateGateway(UpdateGatewayRequest updateGatewayRequest)
Updates a gateway's name.
|
UpdateGatewayCapabilityConfigurationResult |
updateGatewayCapabilityConfiguration(UpdateGatewayCapabilityConfigurationRequest updateGatewayCapabilityConfigurationRequest)
Updates a gateway capability configuration or defines a new capability configuration.
|
UpdatePortalResult |
updatePortal(UpdatePortalRequest updatePortalRequest)
Updates an IoT SiteWise Monitor portal.
|
UpdateProjectResult |
updateProject(UpdateProjectRequest updateProjectRequest)
Updates an IoT SiteWise Monitor project.
|
AWSIoTSiteWiseWaiters |
waiters() |
static final String ENDPOINT_PREFIX
AssociateAssetsResult associateAssets(AssociateAssetsRequest associateAssetsRequest)
Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's model. For more information, see Associating assets in the IoT SiteWise User Guide.
associateAssetsRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceAlreadyExistsException
- The resource already exists.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.LimitExceededException
- You've reached the limit for a resource. For example, this can occur if you're trying to associate more
than the allowed number of child assets or attempting to create more than the allowed number of
properties for an asset model.
For more information, see Quotas in the IoT SiteWise User Guide.
ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ConflictingOperationException
- Your request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.AssociateTimeSeriesToAssetPropertyResult associateTimeSeriesToAssetProperty(AssociateTimeSeriesToAssetPropertyRequest associateTimeSeriesToAssetPropertyRequest)
Associates a time series (data stream) with an asset property.
associateTimeSeriesToAssetPropertyRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ConflictingOperationException
- Your request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.BatchAssociateProjectAssetsResult batchAssociateProjectAssets(BatchAssociateProjectAssetsRequest batchAssociateProjectAssetsRequest)
Associates a group (batch) of assets with an IoT SiteWise Monitor project.
batchAssociateProjectAssetsRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException
- You've reached the limit for a resource. For example, this can occur if you're trying to associate more
than the allowed number of child assets or attempting to create more than the allowed number of
properties for an asset model.
For more information, see Quotas in the IoT SiteWise User Guide.
BatchDisassociateProjectAssetsResult batchDisassociateProjectAssets(BatchDisassociateProjectAssetsRequest batchDisassociateProjectAssetsRequest)
Disassociates a group (batch) of assets from an IoT SiteWise Monitor project.
batchDisassociateProjectAssetsRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
BatchGetAssetPropertyAggregatesResult batchGetAssetPropertyAggregates(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
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ServiceUnavailableException
- The requested service is unavailable.BatchGetAssetPropertyValueResult batchGetAssetPropertyValue(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
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ServiceUnavailableException
- The requested service is unavailable.BatchGetAssetPropertyValueHistoryResult batchGetAssetPropertyValueHistory(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
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ServiceUnavailableException
- The requested service is unavailable.BatchPutAssetPropertyValueResult batchPutAssetPropertyValue(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
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException
- You've reached the limit for a resource. For example, this can occur if you're trying to associate more
than the allowed number of child assets or attempting to create more than the allowed number of
properties for an asset model.
For more information, see Quotas in the IoT SiteWise User Guide.
ServiceUnavailableException
- The requested service is unavailable.ConflictingOperationException
- Your request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.CreateAccessPolicyResult createAccessPolicy(CreateAccessPolicyRequest createAccessPolicyRequest)
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.
createAccessPolicyRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException
- You've reached the limit for a resource. For example, this can occur if you're trying to associate more
than the allowed number of child assets or attempting to create more than the allowed number of
properties for an asset model.
For more information, see Quotas in the IoT SiteWise User Guide.
CreateAssetResult createAsset(CreateAssetRequest createAssetRequest)
Creates an asset from an existing asset model. For more information, see Creating assets in the IoT SiteWise User Guide.
createAssetRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceAlreadyExistsException
- The resource already exists.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException
- You've reached the limit for a resource. For example, this can occur if you're trying to associate more
than the allowed number of child assets or attempting to create more than the allowed number of
properties for an asset model.
For more information, see Quotas in the IoT SiteWise User Guide.
ConflictingOperationException
- Your request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.CreateAssetModelResult createAssetModel(CreateAssetModelRequest createAssetModelRequest)
Creates an asset model from specified property and hierarchy definitions. You create assets from asset models. With asset models, you can easily create assets of the same type that have standardized definitions. Each asset created from a model inherits the asset model's property and hierarchy definitions. For more information, see Defining asset models in the 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.
createAssetModelRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceAlreadyExistsException
- The resource already exists.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException
- You've reached the limit for a resource. For example, this can occur if you're trying to associate more
than the allowed number of child assets or attempting to create more than the allowed number of
properties for an asset model.
For more information, see Quotas in the IoT SiteWise User Guide.
ConflictingOperationException
- Your request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.CreateAssetModelCompositeModelResult createAssetModelCompositeModel(CreateAssetModelCompositeModelRequest createAssetModelCompositeModelRequest)
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
.
createAssetModelCompositeModelRequest
- ConflictingOperationException
- Your request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceAlreadyExistsException
- The resource already exists.ResourceNotFoundException
- The requested resource can't be found.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException
- You've reached the limit for a resource. For example, this can occur if you're trying to associate more
than the allowed number of child assets or attempting to create more than the allowed number of
properties for an asset model.
For more information, see Quotas in the IoT SiteWise User Guide.
CreateBulkImportJobResult createBulkImportJob(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.
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.
createBulkImportJobRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceAlreadyExistsException
- The resource already exists.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException
- You've reached the limit for a resource. For example, this can occur if you're trying to associate more
than the allowed number of child assets or attempting to create more than the allowed number of
properties for an asset model.
For more information, see Quotas in the IoT SiteWise User Guide.
ConflictingOperationException
- Your request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.CreateDashboardResult createDashboard(CreateDashboardRequest createDashboardRequest)
Creates a dashboard in an IoT SiteWise Monitor project.
createDashboardRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException
- You've reached the limit for a resource. For example, this can occur if you're trying to associate more
than the allowed number of child assets or attempting to create more than the allowed number of
properties for an asset model.
For more information, see Quotas in the IoT SiteWise User Guide.
CreateGatewayResult createGateway(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
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceAlreadyExistsException
- The resource already exists.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException
- You've reached the limit for a resource. For example, this can occur if you're trying to associate more
than the allowed number of child assets or attempting to create more than the allowed number of
properties for an asset model.
For more information, see Quotas in the IoT SiteWise User Guide.
CreatePortalResult createPortal(CreatePortalRequest createPortalRequest)
Creates a portal, which can contain projects and dashboards. IoT SiteWise Monitor uses IAM Identity Center or IAM to authenticate portal users and manage user permissions.
Before you can sign in to a new portal, you must add at least one identity to that portal. For more information, see Adding or removing portal administrators in the IoT SiteWise User Guide.
createPortalRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException
- You've reached the limit for a resource. For example, this can occur if you're trying to associate more
than the allowed number of child assets or attempting to create more than the allowed number of
properties for an asset model.
For more information, see Quotas in the IoT SiteWise User Guide.
CreateProjectResult createProject(CreateProjectRequest createProjectRequest)
Creates a project in the specified portal.
Make sure that the project name and description don't contain confidential information.
createProjectRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException
- You've reached the limit for a resource. For example, this can occur if you're trying to associate more
than the allowed number of child assets or attempting to create more than the allowed number of
properties for an asset model.
For more information, see Quotas in the IoT SiteWise User Guide.
DeleteAccessPolicyResult deleteAccessPolicy(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
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
DeleteAssetResult deleteAsset(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
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ConflictingOperationException
- Your request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.DeleteAssetModelResult deleteAssetModel(DeleteAssetModelRequest deleteAssetModelRequest)
Deletes an asset model. This action can't be undone. You must delete all assets created from an asset model before you can delete the model. Also, you can't delete an asset model if a parent asset model exists that contains a property formula expression that depends on the asset model that you want to delete. For more information, see Deleting assets and models in the IoT SiteWise User Guide.
deleteAssetModelRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ConflictingOperationException
- Your request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.DeleteAssetModelCompositeModelResult deleteAssetModelCompositeModel(DeleteAssetModelCompositeModelRequest deleteAssetModelCompositeModelRequest)
Deletes a composite model. This action can't be undone. You must delete all assets created from a composite model before you can delete the model. Also, you can't delete a composite model if a parent asset model exists that contains a property formula expression that depends on the asset model that you want to delete. For more information, see Deleting assets and models in the IoT SiteWise User Guide.
deleteAssetModelCompositeModelRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ConflictingOperationException
- Your request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.DeleteDashboardResult deleteDashboard(DeleteDashboardRequest deleteDashboardRequest)
Deletes a dashboard from IoT SiteWise Monitor.
deleteDashboardRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
DeleteGatewayResult deleteGateway(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
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException
- The requested resource can't be found.ConflictingOperationException
- Your request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
DeletePortalResult deletePortal(DeletePortalRequest deletePortalRequest)
Deletes a portal from IoT SiteWise Monitor.
deletePortalRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ConflictingOperationException
- Your request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.DeleteProjectResult deleteProject(DeleteProjectRequest deleteProjectRequest)
Deletes a project from IoT SiteWise Monitor.
deleteProjectRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
DeleteTimeSeriesResult deleteTimeSeries(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
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ConflictingOperationException
- Your request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.DescribeAccessPolicyResult describeAccessPolicy(DescribeAccessPolicyRequest describeAccessPolicyRequest)
Describes an access policy, which specifies an identity's access to an IoT SiteWise Monitor portal or project.
describeAccessPolicyRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
DescribeActionResult describeAction(DescribeActionRequest describeActionRequest)
Retrieves information about an action.
describeActionRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
DescribeAssetResult describeAsset(DescribeAssetRequest describeAssetRequest)
Retrieves information about an asset.
describeAssetRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
DescribeAssetCompositeModelResult describeAssetCompositeModel(DescribeAssetCompositeModelRequest describeAssetCompositeModelRequest)
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.
describeAssetCompositeModelRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
DescribeAssetModelResult describeAssetModel(DescribeAssetModelRequest describeAssetModelRequest)
Retrieves information about an asset model.
describeAssetModelRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
DescribeAssetModelCompositeModelResult describeAssetModelCompositeModel(DescribeAssetModelCompositeModelRequest describeAssetModelCompositeModelRequest)
Retrieves information about an asset model composite model (also known as an asset model component). For more information, see Custom composite models (Components) in the IoT SiteWise User Guide.
describeAssetModelCompositeModelRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
DescribeAssetPropertyResult describeAssetProperty(DescribeAssetPropertyRequest describeAssetPropertyRequest)
Retrieves information about an asset property.
When you call this operation for an attribute property, this response includes the default attribute value that you define in the asset model. If you update the default value in the model, this operation's response includes the new default value.
This operation doesn't return the value of the asset property. To get the value of an asset property, use GetAssetPropertyValue.
describeAssetPropertyRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
DescribeBulkImportJobResult describeBulkImportJob(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
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
DescribeDashboardResult describeDashboard(DescribeDashboardRequest describeDashboardRequest)
Retrieves information about a dashboard.
describeDashboardRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
DescribeDefaultEncryptionConfigurationResult describeDefaultEncryptionConfiguration(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
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
DescribeGatewayResult describeGateway(DescribeGatewayRequest describeGatewayRequest)
Retrieves information about a gateway.
describeGatewayRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
DescribeGatewayCapabilityConfigurationResult describeGatewayCapabilityConfiguration(DescribeGatewayCapabilityConfigurationRequest describeGatewayCapabilityConfigurationRequest)
Retrieves information about a gateway capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway.
describeGatewayCapabilityConfigurationRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
DescribeLoggingOptionsResult describeLoggingOptions(DescribeLoggingOptionsRequest describeLoggingOptionsRequest)
Retrieves the current IoT SiteWise logging options.
describeLoggingOptionsRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ResourceNotFoundException
- The requested resource can't be found.DescribePortalResult describePortal(DescribePortalRequest describePortalRequest)
Retrieves information about a portal.
describePortalRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
DescribeProjectResult describeProject(DescribeProjectRequest describeProjectRequest)
Retrieves information about a project.
describeProjectRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
DescribeStorageConfigurationResult describeStorageConfiguration(DescribeStorageConfigurationRequest describeStorageConfigurationRequest)
Retrieves information about the storage configuration for IoT SiteWise.
describeStorageConfigurationRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException
- You've reached the limit for a resource. For example, this can occur if you're trying to associate more
than the allowed number of child assets or attempting to create more than the allowed number of
properties for an asset model.
For more information, see Quotas in the IoT SiteWise User Guide.
ConflictingOperationException
- Your request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.DescribeTimeSeriesResult describeTimeSeries(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
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
DisassociateAssetsResult disassociateAssets(DisassociateAssetsRequest disassociateAssetsRequest)
Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model.
disassociateAssetsRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ConflictingOperationException
- Your request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.DisassociateTimeSeriesFromAssetPropertyResult disassociateTimeSeriesFromAssetProperty(DisassociateTimeSeriesFromAssetPropertyRequest disassociateTimeSeriesFromAssetPropertyRequest)
Disassociates a time series (data stream) from an asset property.
disassociateTimeSeriesFromAssetPropertyRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ConflictingOperationException
- Your request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.ExecuteActionResult executeAction(ExecuteActionRequest executeActionRequest)
Executes an action on a target resource.
executeActionRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException
- You've reached the limit for a resource. For example, this can occur if you're trying to associate more
than the allowed number of child assets or attempting to create more than the allowed number of
properties for an asset model.
For more information, see Quotas in the IoT SiteWise User Guide.
ConflictingOperationException
- Your request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.ExecuteQueryResult executeQuery(ExecuteQueryRequest executeQueryRequest)
Run SQL queries to retrieve metadata and time-series data from asset models, assets, measurements, metrics, transforms, and aggregates.
executeQueryRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
AccessDeniedException
- Access is denied.ValidationException
- The validation failed for this query.QueryTimeoutException
- The query timed out.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ServiceUnavailableException
- The requested service is unavailable.GetAssetPropertyAggregatesResult getAssetPropertyAggregates(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
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ServiceUnavailableException
- The requested service is unavailable.GetAssetPropertyValueResult getAssetPropertyValue(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
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ServiceUnavailableException
- The requested service is unavailable.GetAssetPropertyValueHistoryResult getAssetPropertyValueHistory(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
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ServiceUnavailableException
- The requested service is unavailable.GetInterpolatedAssetPropertyValuesResult getInterpolatedAssetPropertyValues(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
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ServiceUnavailableException
- The requested service is unavailable.ListAccessPoliciesResult listAccessPolicies(ListAccessPoliciesRequest listAccessPoliciesRequest)
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).
listAccessPoliciesRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ListActionsResult listActions(ListActionsRequest listActionsRequest)
Retrieves a paginated list of actions for a specific target resource.
listActionsRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ResourceNotFoundException
- The requested resource can't be found.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ListAssetModelCompositeModelsResult listAssetModelCompositeModels(ListAssetModelCompositeModelsRequest listAssetModelCompositeModelsRequest)
Retrieves a paginated list of composite models associated with the asset model
listAssetModelCompositeModelsRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ResourceNotFoundException
- The requested resource can't be found.ListAssetModelPropertiesResult listAssetModelProperties(ListAssetModelPropertiesRequest listAssetModelPropertiesRequest)
Retrieves a paginated list of properties associated with an asset model. If you update properties associated with the model before you finish listing all the properties, you need to start all over again.
listAssetModelPropertiesRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ResourceNotFoundException
- The requested resource can't be found.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ListAssetModelsResult listAssetModels(ListAssetModelsRequest listAssetModelsRequest)
Retrieves a paginated list of summaries of all asset models.
listAssetModelsRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ListAssetPropertiesResult listAssetProperties(ListAssetPropertiesRequest listAssetPropertiesRequest)
Retrieves a paginated list of properties associated with an asset. If you update properties associated with the model before you finish listing all the properties, you need to start all over again.
listAssetPropertiesRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ResourceNotFoundException
- The requested resource can't be found.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ListAssetRelationshipsResult listAssetRelationships(ListAssetRelationshipsRequest listAssetRelationshipsRequest)
Retrieves a paginated list of asset relationships for an asset. You can use this operation to identify an asset's root asset and all associated assets between that asset and its root.
listAssetRelationshipsRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ResourceNotFoundException
- The requested resource can't be found.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ListAssetsResult listAssets(ListAssetsRequest listAssetsRequest)
Retrieves a paginated list of asset summaries.
You can use this operation to do the following:
List assets based on a specific asset model.
List top-level assets.
You can't use this operation to list all assets. To retrieve summaries for all of your assets, use ListAssetModels to get all of your asset model IDs. Then, use ListAssets to get all assets for each asset model.
listAssetsRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ResourceNotFoundException
- The requested resource can't be found.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ListAssociatedAssetsResult listAssociatedAssets(ListAssociatedAssetsRequest listAssociatedAssetsRequest)
Retrieves a paginated list of associated assets.
You can use this operation to do the following:
List child assets associated to a parent asset by a hierarchy that you specify.
List an asset's parent asset.
listAssociatedAssetsRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ResourceNotFoundException
- The requested resource can't be found.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ListBulkImportJobsResult listBulkImportJobs(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
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ResourceNotFoundException
- The requested resource can't be found.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ListCompositionRelationshipsResult listCompositionRelationships(ListCompositionRelationshipsRequest listCompositionRelationshipsRequest)
Retrieves a paginated list of composition relationships for an asset model of type COMPONENT_MODEL
.
listCompositionRelationshipsRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ResourceNotFoundException
- The requested resource can't be found.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ListDashboardsResult listDashboards(ListDashboardsRequest listDashboardsRequest)
Retrieves a paginated list of dashboards for an IoT SiteWise Monitor project.
listDashboardsRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ListGatewaysResult listGateways(ListGatewaysRequest listGatewaysRequest)
Retrieves a paginated list of gateways.
listGatewaysRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ListPortalsResult listPortals(ListPortalsRequest listPortalsRequest)
Retrieves a paginated list of IoT SiteWise Monitor portals.
listPortalsRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ListProjectAssetsResult listProjectAssets(ListProjectAssetsRequest listProjectAssetsRequest)
Retrieves a paginated list of assets associated with an IoT SiteWise Monitor project.
listProjectAssetsRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ListProjectsResult listProjects(ListProjectsRequest listProjectsRequest)
Retrieves a paginated list of projects for an IoT SiteWise Monitor portal.
listProjectsRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Retrieves the list of tags for an IoT SiteWise resource.
listTagsForResourceRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ResourceNotFoundException
- The requested resource can't be found.ConflictingOperationException
- Your request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.LimitExceededException
- You've reached the limit for a resource. For example, this can occur if you're trying to associate more
than the allowed number of child assets or attempting to create more than the allowed number of
properties for an asset model.
For more information, see Quotas in the IoT SiteWise User Guide.
UnauthorizedException
- You are not authorized.ListTimeSeriesResult listTimeSeries(ListTimeSeriesRequest listTimeSeriesRequest)
Retrieves a paginated list of time series (data streams).
listTimeSeriesRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
PutDefaultEncryptionConfigurationResult putDefaultEncryptionConfiguration(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
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException
- You've reached the limit for a resource. For example, this can occur if you're trying to associate more
than the allowed number of child assets or attempting to create more than the allowed number of
properties for an asset model.
For more information, see Quotas in the IoT SiteWise User Guide.
ConflictingOperationException
- Your request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.PutLoggingOptionsResult putLoggingOptions(PutLoggingOptionsRequest putLoggingOptionsRequest)
Sets logging options for IoT SiteWise.
putLoggingOptionsRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ConflictingOperationException
- Your request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.ResourceNotFoundException
- The requested resource can't be found.PutStorageConfigurationResult putStorageConfiguration(PutStorageConfigurationRequest putStorageConfigurationRequest)
Configures storage settings for IoT SiteWise.
putStorageConfigurationRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceAlreadyExistsException
- The resource already exists.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException
- You've reached the limit for a resource. For example, this can occur if you're trying to associate more
than the allowed number of child assets or attempting to create more than the allowed number of
properties for an asset model.
For more information, see Quotas in the IoT SiteWise User Guide.
ConflictingOperationException
- Your request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.TagResourceResult tagResource(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
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ResourceNotFoundException
- The requested resource can't be found.ConflictingOperationException
- Your request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.LimitExceededException
- You've reached the limit for a resource. For example, this can occur if you're trying to associate more
than the allowed number of child assets or attempting to create more than the allowed number of
properties for an asset model.
For more information, see Quotas in the IoT SiteWise User Guide.
UnauthorizedException
- You are not authorized.TooManyTagsException
- You've reached the limit for the number of tags allowed for a resource. For more information, see Tag naming limits
and requirements in the Amazon Web Services General Reference.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag from an IoT SiteWise resource.
untagResourceRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ResourceNotFoundException
- The requested resource can't be found.ConflictingOperationException
- Your request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.LimitExceededException
- You've reached the limit for a resource. For example, this can occur if you're trying to associate more
than the allowed number of child assets or attempting to create more than the allowed number of
properties for an asset model.
For more information, see Quotas in the IoT SiteWise User Guide.
UnauthorizedException
- You are not authorized.UpdateAccessPolicyResult updateAccessPolicy(UpdateAccessPolicyRequest updateAccessPolicyRequest)
Updates an existing access policy that specifies an identity's access to an IoT SiteWise Monitor portal or project resource.
updateAccessPolicyRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
UpdateAssetResult updateAsset(UpdateAssetRequest updateAssetRequest)
Updates an asset's name. For more information, see Updating assets and models in the IoT SiteWise User Guide.
updateAssetRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceAlreadyExistsException
- The resource already exists.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ConflictingOperationException
- Your request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.UpdateAssetModelResult updateAssetModel(UpdateAssetModelRequest updateAssetModelRequest)
Updates an asset model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models in the 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
.
updateAssetModelRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceAlreadyExistsException
- The resource already exists.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.LimitExceededException
- You've reached the limit for a resource. For example, this can occur if you're trying to associate more
than the allowed number of child assets or attempting to create more than the allowed number of
properties for an asset model.
For more information, see Quotas in the IoT SiteWise User Guide.
ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ConflictingOperationException
- Your request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.UpdateAssetModelCompositeModelResult updateAssetModelCompositeModel(UpdateAssetModelCompositeModelRequest updateAssetModelCompositeModelRequest)
Updates a composite model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models in the IoT SiteWise User Guide.
If you remove a property from a composite asset model, IoT SiteWise deletes all previous data for that property. You can’t change the type or data type of an existing property.
To replace an existing composite asset model property with a new one with the same name
, do the
following:
Submit an 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
.
updateAssetModelCompositeModelRequest
- ConflictingOperationException
- Your request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceAlreadyExistsException
- The resource already exists.ResourceNotFoundException
- The requested resource can't be found.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException
- You've reached the limit for a resource. For example, this can occur if you're trying to associate more
than the allowed number of child assets or attempting to create more than the allowed number of
properties for an asset model.
For more information, see Quotas in the IoT SiteWise User Guide.
UpdateAssetPropertyResult updateAssetProperty(UpdateAssetPropertyRequest updateAssetPropertyRequest)
Updates an asset property's alias and notification state.
This operation overwrites the property's existing alias and notification state. To keep your existing property's alias or notification state, you must include the existing values in the UpdateAssetProperty request. For more information, see DescribeAssetProperty.
updateAssetPropertyRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ConflictingOperationException
- Your request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.UpdateDashboardResult updateDashboard(UpdateDashboardRequest updateDashboardRequest)
Updates an IoT SiteWise Monitor dashboard.
updateDashboardRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
UpdateGatewayResult updateGateway(UpdateGatewayRequest updateGatewayRequest)
Updates a gateway's name.
updateGatewayRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException
- The requested resource can't be found.ConflictingOperationException
- Your request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
UpdateGatewayCapabilityConfigurationResult updateGatewayCapabilityConfiguration(UpdateGatewayCapabilityConfigurationRequest updateGatewayCapabilityConfigurationRequest)
Updates a gateway capability configuration or defines a new capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway.
updateGatewayCapabilityConfigurationRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException
- The requested resource can't be found.ConflictingOperationException
- Your request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
LimitExceededException
- You've reached the limit for a resource. For example, this can occur if you're trying to associate more
than the allowed number of child assets or attempting to create more than the allowed number of
properties for an asset model.
For more information, see Quotas in the IoT SiteWise User Guide.
UpdatePortalResult updatePortal(UpdatePortalRequest updatePortalRequest)
Updates an IoT SiteWise Monitor portal.
updatePortalRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ConflictingOperationException
- Your request has conflicting operations. This can occur if you're trying to perform more than one
operation on the same resource at the same time.UpdateProjectResult updateProject(UpdateProjectRequest updateProjectRequest)
Updates an IoT SiteWise Monitor project.
updateProjectRequest
- InvalidRequestException
- The request isn't valid. This can occur if your request contains malformed JSON or unsupported
characters. Check your request and try again.ResourceNotFoundException
- The requested resource can't be found.InternalFailureException
- IoT SiteWise can't process your request right now. Try again later.ThrottlingException
- Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise
assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response 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.
request
- The originally executed request.AWSIoTSiteWiseWaiters waiters()