Table of Contents
IoTSiteWise.Client¶A low-level client representing AWS IoT SiteWise
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 .
import boto3
client = boto3.client('iotsitewise')
These are the available methods:
associate_assets()associate_time_series_to_asset_property()batch_associate_project_assets()batch_disassociate_project_assets()batch_get_asset_property_aggregates()batch_get_asset_property_value()batch_get_asset_property_value_history()batch_put_asset_property_value()can_paginate()close()create_access_policy()create_asset()create_asset_model()create_bulk_import_job()create_dashboard()create_gateway()create_portal()create_project()delete_access_policy()delete_asset()delete_asset_model()delete_dashboard()delete_gateway()delete_portal()delete_project()delete_time_series()describe_access_policy()describe_asset()describe_asset_model()describe_asset_property()describe_bulk_import_job()describe_dashboard()describe_default_encryption_configuration()describe_gateway()describe_gateway_capability_configuration()describe_logging_options()describe_portal()describe_project()describe_storage_configuration()describe_time_series()disassociate_assets()disassociate_time_series_from_asset_property()get_asset_property_aggregates()get_asset_property_value()get_asset_property_value_history()get_interpolated_asset_property_values()get_paginator()get_waiter()list_access_policies()list_asset_model_properties()list_asset_models()list_asset_properties()list_asset_relationships()list_assets()list_associated_assets()list_bulk_import_jobs()list_dashboards()list_gateways()list_portals()list_project_assets()list_projects()list_tags_for_resource()list_time_series()put_default_encryption_configuration()put_logging_options()put_storage_configuration()tag_resource()untag_resource()update_access_policy()update_asset()update_asset_model()update_asset_property()update_dashboard()update_gateway()update_gateway_capability_configuration()update_portal()update_project()associate_assets(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.associate_assets(
assetId='string',
hierarchyId='string',
childAssetId='string',
clientToken='string'
)
[REQUIRED]
The ID of the parent asset.
[REQUIRED]
The ID of a hierarchy in the parent asset's model. Hierarchies allow different groupings of assets to be formed that all come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide .
[REQUIRED]
The ID of the child asset to be associated.
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
This field is autopopulated if not provided.
None
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceAlreadyExistsExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.LimitExceededExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionIoTSiteWise.Client.exceptions.ConflictingOperationExceptionassociate_time_series_to_asset_property(**kwargs)¶Associates a time series (data stream) with an asset property.
See also: AWS API Documentation
Request Syntax
response = client.associate_time_series_to_asset_property(
alias='string',
assetId='string',
propertyId='string',
clientToken='string'
)
[REQUIRED]
The alias that identifies the time series.
[REQUIRED]
The ID of the asset in which the asset property was created.
[REQUIRED]
The ID of the asset property.
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
This field is autopopulated if not provided.
None
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionIoTSiteWise.Client.exceptions.ConflictingOperationExceptionbatch_associate_project_assets(**kwargs)¶Associates a group (batch) of assets with an IoT SiteWise Monitor project.
See also: AWS API Documentation
Request Syntax
response = client.batch_associate_project_assets(
projectId='string',
assetIds=[
'string',
],
clientToken='string'
)
[REQUIRED]
The ID of the project to which to associate the assets.
[REQUIRED]
The IDs of the assets to be associated to the project.
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
This field is autopopulated if not provided.
dict
Response Syntax
{
'errors': [
{
'assetId': 'string',
'code': 'INTERNAL_FAILURE',
'message': 'string'
},
]
}
Response Structure
(dict) --
errors (list) --
A list of associated error information, if any.
(dict) --
Contains error details for the requested associate project asset action.
assetId (string) --
The ID of the asset.
code (string) --
The error code.
message (string) --
The error message.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionIoTSiteWise.Client.exceptions.LimitExceededExceptionbatch_disassociate_project_assets(**kwargs)¶Disassociates a group (batch) of assets from an IoT SiteWise Monitor project.
See also: AWS API Documentation
Request Syntax
response = client.batch_disassociate_project_assets(
projectId='string',
assetIds=[
'string',
],
clientToken='string'
)
[REQUIRED]
The ID of the project from which to disassociate the assets.
[REQUIRED]
The IDs of the assets to be disassociated from the project.
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
This field is autopopulated if not provided.
dict
Response Syntax
{
'errors': [
{
'assetId': 'string',
'code': 'INTERNAL_FAILURE',
'message': 'string'
},
]
}
Response Structure
(dict) --
errors (list) --
A list of associated error information, if any.
(dict) --
Contains error details for the requested associate project asset action.
assetId (string) --
The ID of the asset.
code (string) --
The error code.
message (string) --
The error message.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionbatch_get_asset_property_aggregates(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.batch_get_asset_property_aggregates(
entries=[
{
'entryId': 'string',
'assetId': 'string',
'propertyId': 'string',
'propertyAlias': 'string',
'aggregateTypes': [
'AVERAGE'|'COUNT'|'MAXIMUM'|'MINIMUM'|'SUM'|'STANDARD_DEVIATION',
],
'resolution': 'string',
'startDate': datetime(2015, 1, 1),
'endDate': datetime(2015, 1, 1),
'qualities': [
'GOOD'|'BAD'|'UNCERTAIN',
],
'timeOrdering': 'ASCENDING'|'DESCENDING'
},
],
nextToken='string',
maxResults=123
)
[REQUIRED]
The list of asset property aggregate entries for the batch get request. You can specify up to 16 entries per request.
Contains information for an asset property aggregate entry that is associated with the BatchGetAssetPropertyAggregates API.
To identify an asset property, you must specify one of the following:
assetId and propertyId of an asset property.propertyAlias , which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature ). To define an asset property's alias, see UpdateAssetProperty .The ID of the entry.
The ID of the asset in which the asset property was created.
The ID of the asset property.
The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature ). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide .
The data aggregating function.
The time interval over which to aggregate data.
The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.
The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.
The quality by which to filter asset data.
The chronological sorting order of the requested information.
Default: ASCENDING
The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first.
maxResults . The maximum value of maxResults is 4000.dict
Response Syntax
{
'errorEntries': [
{
'errorCode': 'ResourceNotFoundException'|'InvalidRequestException'|'AccessDeniedException',
'errorMessage': 'string',
'entryId': 'string'
},
],
'successEntries': [
{
'entryId': 'string',
'aggregatedValues': [
{
'timestamp': datetime(2015, 1, 1),
'quality': 'GOOD'|'BAD'|'UNCERTAIN',
'value': {
'average': 123.0,
'count': 123.0,
'maximum': 123.0,
'minimum': 123.0,
'sum': 123.0,
'standardDeviation': 123.0
}
},
]
},
],
'skippedEntries': [
{
'entryId': 'string',
'completionStatus': 'SUCCESS'|'ERROR',
'errorInfo': {
'errorCode': 'ResourceNotFoundException'|'InvalidRequestException'|'AccessDeniedException',
'errorTimestamp': datetime(2015, 1, 1)
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
errorEntries (list) --
A list of the errors (if any) associated with the batch request. Each error entry contains the entryId of the entry that failed.
(dict) --
Contains error information for an asset property aggregate entry that is associated with the BatchGetAssetPropertyAggregates API.
errorCode (string) --
The error code.
errorMessage (string) --
The associated error message.
entryId (string) --
The ID of the entry.
successEntries (list) --
A list of entries that were processed successfully by this batch request. Each success entry contains the entryId of the entry that succeeded and the latest query result.
(dict) --
Contains success information for an entry that is associated with the BatchGetAssetPropertyAggregates API.
entryId (string) --
The ID of the entry.
aggregatedValues (list) --
The requested aggregated asset property values (for example, average, minimum, and maximum).
(dict) --
Contains aggregated asset property values (for example, average, minimum, and maximum).
timestamp (datetime) --
The date the aggregating computations occurred, in Unix epoch time.
quality (string) --
The quality of the aggregated data.
value (dict) --
The value of the aggregates.
average (float) --
The average (mean) value of the time series over a time interval window.
count (float) --
The count of data points in the time series over a time interval window.
maximum (float) --
The maximum value of the time series over a time interval window.
minimum (float) --
The minimum value of the time series over a time interval window.
sum (float) --
The sum of the time series over a time interval window.
standardDeviation (float) --
The standard deviation of the time series over a time interval window.
skippedEntries (list) --
A list of entries that were not processed by this batch request. because these entries had been completely processed by previous paginated requests. Each skipped entry contains the entryId of the entry that skipped.
(dict) --
Contains information for an entry that has been processed by the previous BatchGetAssetPropertyAggregates request.
entryId (string) --
The ID of the entry.
completionStatus (string) --
The completion status of each entry that is associated with the BatchGetAssetPropertyAggregates API.
errorInfo (dict) --
The error information, such as the error code and the timestamp.
errorCode (string) --
The error code.
errorTimestamp (datetime) --
The date the error occurred, in Unix epoch time.
nextToken (string) --
The token for the next set of results, or null if there are no additional results.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionIoTSiteWise.Client.exceptions.ServiceUnavailableExceptionbatch_get_asset_property_value(**kwargs)¶Gets the current value for one or more asset properties. For more information, see Querying current values in the IoT SiteWise User Guide .
See also: AWS API Documentation
Request Syntax
response = client.batch_get_asset_property_value(
entries=[
{
'entryId': 'string',
'assetId': 'string',
'propertyId': 'string',
'propertyAlias': 'string'
},
],
nextToken='string'
)
[REQUIRED]
The list of asset property value entries for the batch get request. You can specify up to 16 entries per request.
Contains information for an asset property value entry that is associated with the BatchGetAssetPropertyValue API.
To identify an asset property, you must specify one of the following:
assetId and propertyId of an asset property.propertyAlias , which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature ). To define an asset property's alias, see UpdateAssetProperty .The ID of the entry.
The ID of the asset in which the asset property was created.
The ID of the asset property.
The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature ). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide .
dict
Response Syntax
{
'errorEntries': [
{
'errorCode': 'ResourceNotFoundException'|'InvalidRequestException'|'AccessDeniedException',
'errorMessage': 'string',
'entryId': 'string'
},
],
'successEntries': [
{
'entryId': 'string',
'assetPropertyValue': {
'value': {
'stringValue': 'string',
'integerValue': 123,
'doubleValue': 123.0,
'booleanValue': True|False
},
'timestamp': {
'timeInSeconds': 123,
'offsetInNanos': 123
},
'quality': 'GOOD'|'BAD'|'UNCERTAIN'
}
},
],
'skippedEntries': [
{
'entryId': 'string',
'completionStatus': 'SUCCESS'|'ERROR',
'errorInfo': {
'errorCode': 'ResourceNotFoundException'|'InvalidRequestException'|'AccessDeniedException',
'errorTimestamp': datetime(2015, 1, 1)
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
errorEntries (list) --
A list of the errors (if any) associated with the batch request. Each error entry contains the entryId of the entry that failed.
(dict) --
Contains error information for an asset property value entry that is associated with the BatchGetAssetPropertyValue API.
errorCode (string) --
The error code.
errorMessage (string) --
The associated error message.
entryId (string) --
The ID of the entry.
successEntries (list) --
A list of entries that were processed successfully by this batch request. Each success entry contains the entryId of the entry that succeeded and the latest query result.
(dict) --
Contains success information for an entry that is associated with the BatchGetAssetPropertyValue API.
entryId (string) --
The ID of the entry.
assetPropertyValue (dict) --
Contains asset property value information.
value (dict) --
The value of the asset property (see Variant ).
stringValue (string) --
Asset property data of type string (sequence of characters).
integerValue (integer) --
Asset property data of type integer (whole number).
doubleValue (float) --
Asset property data of type double (floating point number).
booleanValue (boolean) --
Asset property data of type Boolean (true or false).
timestamp (dict) --
The timestamp of the asset property value.
timeInSeconds (integer) --
The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos .
offsetInNanos (integer) --
The nanosecond offset from timeInSeconds .
quality (string) --
The quality of the asset property value.
skippedEntries (list) --
A list of entries that were not processed by this batch request. because these entries had been completely processed by previous paginated requests. Each skipped entry contains the entryId of the entry that skipped.
(dict) --
Contains information for an entry that has been processed by the previous BatchGetAssetPropertyValue request.
entryId (string) --
The ID of the entry.
completionStatus (string) --
The completion status of each entry that is associated with the BatchGetAssetPropertyValue request.
errorInfo (dict) --
The error information, such as the error code and the timestamp.
errorCode (string) --
The error code.
errorTimestamp (datetime) --
The date the error occurred, in Unix epoch time.
nextToken (string) --
The token for the next set of results, or null if there are no additional results.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionIoTSiteWise.Client.exceptions.ServiceUnavailableExceptionbatch_get_asset_property_value_history(**kwargs)¶Gets the historical values for one or more asset properties. For more information, see Querying historical values in the IoT SiteWise User Guide .
See also: AWS API Documentation
Request Syntax
response = client.batch_get_asset_property_value_history(
entries=[
{
'entryId': 'string',
'assetId': 'string',
'propertyId': 'string',
'propertyAlias': 'string',
'startDate': datetime(2015, 1, 1),
'endDate': datetime(2015, 1, 1),
'qualities': [
'GOOD'|'BAD'|'UNCERTAIN',
],
'timeOrdering': 'ASCENDING'|'DESCENDING'
},
],
nextToken='string',
maxResults=123
)
[REQUIRED]
The list of asset property historical value entries for the batch get request. You can specify up to 16 entries per request.
Contains information for an asset property historical value entry that is associated with the BatchGetAssetPropertyValueHistory API.
To identify an asset property, you must specify one of the following:
assetId and propertyId of an asset property.propertyAlias , which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature ). To define an asset property's alias, see UpdateAssetProperty .The ID of the entry.
The ID of the asset in which the asset property was created.
The ID of the asset property.
The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature ). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide .
The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.
The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.
The quality by which to filter asset data.
The chronological sorting order of the requested information.
Default: ASCENDING
The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first.
maxResults . The maximum value of maxResults is 4000.dict
Response Syntax
{
'errorEntries': [
{
'errorCode': 'ResourceNotFoundException'|'InvalidRequestException'|'AccessDeniedException',
'errorMessage': 'string',
'entryId': 'string'
},
],
'successEntries': [
{
'entryId': 'string',
'assetPropertyValueHistory': [
{
'value': {
'stringValue': 'string',
'integerValue': 123,
'doubleValue': 123.0,
'booleanValue': True|False
},
'timestamp': {
'timeInSeconds': 123,
'offsetInNanos': 123
},
'quality': 'GOOD'|'BAD'|'UNCERTAIN'
},
]
},
],
'skippedEntries': [
{
'entryId': 'string',
'completionStatus': 'SUCCESS'|'ERROR',
'errorInfo': {
'errorCode': 'ResourceNotFoundException'|'InvalidRequestException'|'AccessDeniedException',
'errorTimestamp': datetime(2015, 1, 1)
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
errorEntries (list) --
A list of the errors (if any) associated with the batch request. Each error entry contains the entryId of the entry that failed.
(dict) --
A list of the errors (if any) associated with the batch request. Each error entry contains the entryId of the entry that failed.
errorCode (string) --
The error code.
errorMessage (string) --
The associated error message.
entryId (string) --
The ID of the entry.
successEntries (list) --
A list of entries that were processed successfully by this batch request. Each success entry contains the entryId of the entry that succeeded and the latest query result.
(dict) --
Contains success information for an entry that is associated with the BatchGetAssetPropertyValueHistory API.
entryId (string) --
The ID of the entry.
assetPropertyValueHistory (list) --
The requested historical values for the specified asset property.
(dict) --
Contains asset property value information.
value (dict) --
The value of the asset property (see Variant ).
stringValue (string) --
Asset property data of type string (sequence of characters).
integerValue (integer) --
Asset property data of type integer (whole number).
doubleValue (float) --
Asset property data of type double (floating point number).
booleanValue (boolean) --
Asset property data of type Boolean (true or false).
timestamp (dict) --
The timestamp of the asset property value.
timeInSeconds (integer) --
The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos .
offsetInNanos (integer) --
The nanosecond offset from timeInSeconds .
quality (string) --
The quality of the asset property value.
skippedEntries (list) --
A list of entries that were not processed by this batch request. because these entries had been completely processed by previous paginated requests. Each skipped entry contains the entryId of the entry that skipped.
(dict) --
Contains information for an entry that has been processed by the previous BatchGetAssetPropertyValueHistory request.
entryId (string) --
The ID of the entry.
completionStatus (string) --
The completion status of each entry that is associated with the BatchGetAssetPropertyValueHistory API.
errorInfo (dict) --
The error information, such as the error code and the timestamp.
errorCode (string) --
The error code.
errorTimestamp (datetime) --
The date the error occurred, in Unix epoch time.
nextToken (string) --
The token for the next set of results, or null if there are no additional results.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionIoTSiteWise.Client.exceptions.ServiceUnavailableExceptionbatch_put_asset_property_value(**kwargs)¶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:
assetId and propertyId of an asset property.propertyAlias , which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature ). To define an asset property's alias, see UpdateAssetProperty .Warning
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 .
See also: AWS API Documentation
Request Syntax
response = client.batch_put_asset_property_value(
entries=[
{
'entryId': 'string',
'assetId': 'string',
'propertyId': 'string',
'propertyAlias': 'string',
'propertyValues': [
{
'value': {
'stringValue': 'string',
'integerValue': 123,
'doubleValue': 123.0,
'booleanValue': True|False
},
'timestamp': {
'timeInSeconds': 123,
'offsetInNanos': 123
},
'quality': 'GOOD'|'BAD'|'UNCERTAIN'
},
]
},
]
)
[REQUIRED]
The list of asset property value entries for the batch put request. You can specify up to 10 entries per request.
Contains a list of value updates for an asset property in the list of asset entries consumed by the BatchPutAssetPropertyValue API operation.
The user specified ID for the entry. You can use this ID to identify which entries failed.
The ID of the asset to update.
The ID of the asset property for this entry.
The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature ). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide .
The list of property values to upload. You can specify up to 10 propertyValues array elements.
Contains asset property value information.
The value of the asset property (see Variant ).
Asset property data of type string (sequence of characters).
Asset property data of type integer (whole number).
Asset property data of type double (floating point number).
Asset property data of type Boolean (true or false).
The timestamp of the asset property value.
The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos .
The nanosecond offset from timeInSeconds .
The quality of the asset property value.
{
'errorEntries': [
{
'entryId': 'string',
'errors': [
{
'errorCode': 'ResourceNotFoundException'|'InvalidRequestException'|'InternalFailureException'|'ServiceUnavailableException'|'ThrottlingException'|'LimitExceededException'|'ConflictingOperationException'|'TimestampOutOfRangeException'|'AccessDeniedException',
'errorMessage': 'string',
'timestamps': [
{
'timeInSeconds': 123,
'offsetInNanos': 123
},
]
},
]
},
]
}
Response Structure
A list of the errors (if any) associated with the batch put request. Each error entry contains the entryId of the entry that failed.
Contains error information for asset property value entries that are associated with the BatchPutAssetPropertyValue API.
The ID of the failed entry.
The list of update property value errors.
Contains error information from updating a batch of asset property values.
The error code.
The associated error message.
A list of timestamps for each error, if any.
Contains a timestamp with optional nanosecond granularity.
The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos .
The nanosecond offset from timeInSeconds .
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionIoTSiteWise.Client.exceptions.LimitExceededExceptionIoTSiteWise.Client.exceptions.ServiceUnavailableExceptionIoTSiteWise.Client.exceptions.ConflictingOperationExceptioncan_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
create_access_policy(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.create_access_policy(
accessPolicyIdentity={
'user': {
'id': 'string'
},
'group': {
'id': 'string'
},
'iamUser': {
'arn': 'string'
},
'iamRole': {
'arn': 'string'
}
},
accessPolicyResource={
'portal': {
'id': 'string'
},
'project': {
'id': 'string'
}
},
accessPolicyPermission='ADMINISTRATOR'|'VIEWER',
clientToken='string',
tags={
'string': 'string'
}
)
[REQUIRED]
The identity for this access policy. Choose an IAM Identity Center user, an IAM Identity Center group, or an IAM user.
An IAM Identity Center user identity.
The IAM Identity Center ID of the user.
An IAM Identity Center group identity.
The IAM Identity Center ID of the group.
An IAM user identity.
The ARN of the IAM user. For more information, see IAM ARNs in the IAM User Guide .
Note
If you delete the IAM user, access policies that contain this identity include an empty arn . You can delete the access policy for the IAM user that no longer exists.
An IAM role identity.
The ARN of the IAM role. For more information, see IAM ARNs in the IAM User Guide .
[REQUIRED]
The IoT SiteWise Monitor resource for this access policy. Choose either a portal or a project.
A portal resource.
The ID of the portal.
A project resource.
The ID of the project.
[REQUIRED]
The permission level for this access policy. Note that a project ADMINISTRATOR is also known as a project owner.
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
This field is autopopulated if not provided.
A list of key-value pairs that contain metadata for the access policy. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide .
dict
Response Syntax
{
'accessPolicyId': 'string',
'accessPolicyArn': 'string'
}
Response Structure
(dict) --
accessPolicyId (string) --
The ID of the access policy.
accessPolicyArn (string) --
The ARN of the access policy, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId}
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionIoTSiteWise.Client.exceptions.LimitExceededExceptioncreate_asset(**kwargs)¶Creates an asset from an existing asset model. For more information, see Creating assets in the IoT SiteWise User Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_asset(
assetName='string',
assetModelId='string',
clientToken='string',
tags={
'string': 'string'
},
assetDescription='string'
)
[REQUIRED]
A friendly name for the asset.
[REQUIRED]
The ID of the asset model from which to create the asset.
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
This field is autopopulated if not provided.
A list of key-value pairs that contain metadata for the asset. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide .
dict
Response Syntax
{
'assetId': 'string',
'assetArn': 'string',
'assetStatus': {
'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED',
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
'message': 'string',
'details': [
{
'code': 'INCOMPATIBLE_COMPUTE_LOCATION'|'INCOMPATIBLE_FORWARDING_CONFIGURATION',
'message': 'string'
},
]
}
}
}
Response Structure
(dict) --
assetId (string) --
The ID of the asset. This ID uniquely identifies the asset within IoT SiteWise and can be used with other IoT SiteWise APIs.
assetArn (string) --
The ARN of the asset, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}
assetStatus (dict) --
The status of the asset, which contains a state (CREATING after successfully calling this operation) and any error message.
state (string) --
The current status of the asset.
error (dict) --
Contains associated error information, if any.
code (string) --
The error code.
message (string) --
The error message.
details (list) --
A list of detailed errors.
(dict) --
Contains detailed error information.
code (string) --
The error code.
message (string) --
The error message.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceAlreadyExistsExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionIoTSiteWise.Client.exceptions.LimitExceededExceptionIoTSiteWise.Client.exceptions.ConflictingOperationExceptioncreate_asset_model(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.create_asset_model(
assetModelName='string',
assetModelDescription='string',
assetModelProperties=[
{
'name': 'string',
'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN'|'STRUCT',
'dataTypeSpec': 'string',
'unit': 'string',
'type': {
'attribute': {
'defaultValue': 'string'
},
'measurement': {
'processingConfig': {
'forwardingConfig': {
'state': 'DISABLED'|'ENABLED'
}
}
},
'transform': {
'expression': 'string',
'variables': [
{
'name': 'string',
'value': {
'propertyId': 'string',
'hierarchyId': 'string'
}
},
],
'processingConfig': {
'computeLocation': 'EDGE'|'CLOUD',
'forwardingConfig': {
'state': 'DISABLED'|'ENABLED'
}
}
},
'metric': {
'expression': 'string',
'variables': [
{
'name': 'string',
'value': {
'propertyId': 'string',
'hierarchyId': 'string'
}
},
],
'window': {
'tumbling': {
'interval': 'string',
'offset': 'string'
}
},
'processingConfig': {
'computeLocation': 'EDGE'|'CLOUD'
}
}
}
},
],
assetModelHierarchies=[
{
'name': 'string',
'childAssetModelId': 'string'
},
],
assetModelCompositeModels=[
{
'name': 'string',
'description': 'string',
'type': 'string',
'properties': [
{
'name': 'string',
'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN'|'STRUCT',
'dataTypeSpec': 'string',
'unit': 'string',
'type': {
'attribute': {
'defaultValue': 'string'
},
'measurement': {
'processingConfig': {
'forwardingConfig': {
'state': 'DISABLED'|'ENABLED'
}
}
},
'transform': {
'expression': 'string',
'variables': [
{
'name': 'string',
'value': {
'propertyId': 'string',
'hierarchyId': 'string'
}
},
],
'processingConfig': {
'computeLocation': 'EDGE'|'CLOUD',
'forwardingConfig': {
'state': 'DISABLED'|'ENABLED'
}
}
},
'metric': {
'expression': 'string',
'variables': [
{
'name': 'string',
'value': {
'propertyId': 'string',
'hierarchyId': 'string'
}
},
],
'window': {
'tumbling': {
'interval': 'string',
'offset': 'string'
}
},
'processingConfig': {
'computeLocation': 'EDGE'|'CLOUD'
}
}
}
},
]
},
],
clientToken='string',
tags={
'string': 'string'
}
)
[REQUIRED]
A unique, friendly name for the asset model.
The property definitions of the asset model. For more information, see Asset properties in the IoT SiteWise User Guide .
You can specify up to 200 properties per asset model. For more information, see Quotas in the IoT SiteWise User Guide .
Contains an asset model property definition. This property definition is applied to all assets created from the asset model.
The name of the property definition.
The data type of the property definition.
If you specify STRUCT , you must also specify dataTypeSpec to identify the type of the structure for this property.
The data type of the structure for this property. This parameter is required on properties that have the STRUCT data type.
The options for this parameter depend on the type of the composite model in which you define this property. Use AWS/ALARM_STATE for alarm state in alarm composite models.
The unit of the property definition, such as Newtons or RPM .
The property definition type (see PropertyType ). You can only specify one type in a property definition.
Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an IIoT wind turbine.
The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see Updating attribute values in the IoT SiteWise User Guide .
Specifies an asset measurement property. A measurement represents a device's raw sensor data stream, such as timestamped temperature values or timestamped power values.
The processing configuration for the given measurement property. You can configure measurements to be kept at the edge or forwarded to the Amazon Web Services Cloud. By default, measurements are forwarded to the cloud.
The forwarding configuration for the given measurement property.
The forwarding state for the given property.
Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.
The mathematical expression that defines the transformation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.
For more information, see Quotas in the IoT SiteWise User Guide .
The list of variables used in the expression.
Contains expression variable information.
The friendly name of the variable to be used in the expression.
The variable that identifies an asset property from which to use values.
The ID of the property to use as the variable. You can use the property name if it's from the same asset model.
The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID.
You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId . For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide .
The processing configuration for the given transform property. You can configure transforms to be kept at the edge or forwarded to the Amazon Web Services Cloud. You can also configure transforms to be computed at the edge or in the cloud.
The compute location for the given transform property.
The forwarding configuration for a given property.
The forwarding state for the given property.
Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.
The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.
For more information, see Quotas in the IoT SiteWise User Guide .
The list of variables used in the expression.
Contains expression variable information.
The friendly name of the variable to be used in the expression.
The variable that identifies an asset property from which to use values.
The ID of the property to use as the variable. You can use the property name if it's from the same asset model.
The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID.
You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId . For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide .
The window (time interval) over which IoT SiteWise computes the metric's aggregation expression. IoT SiteWise computes one data point per window .
The tumbling time interval window.
The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.
IoT SiteWise computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval at the end of each hour, and so on.
When IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. IoT SiteWise places the computed data point at the end of the interval.
The offset for the tumbling window. The offset parameter accepts the following:
18h for offset and 1d for interval , IoT SiteWise aggregates data in one of the following ways:PT18H for offset and 1d for interval , IoT SiteWise aggregates data in one of the following ways:00:03:00 for offset , 5m for interval , and you create the metric at 2 PM (UTC), you get the first aggregation result at 2:03 PM (UTC). You get the second aggregation result at 2:08 PM (UTC).2021-07-23T18:00-08 for offset and 1d for interval , IoT SiteWise aggregates data in one of the following ways:The processing configuration for the given metric property. You can configure metrics to be computed at the edge or in the Amazon Web Services Cloud. By default, metrics are forwarded to the cloud.
The compute location for the given metric property.
The hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide .
You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the IoT SiteWise User Guide .
Contains an asset model hierarchy used in asset model creation. An asset model hierarchy determines the kind (or type) of asset that can belong to a hierarchy.
The name of the asset model hierarchy definition (as specified in the CreateAssetModel or UpdateAssetModel API operation).
The ID of an asset model for this hierarchy.
The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties. Each composite model has a type that defines the properties that the composite model supports. Use composite asset models to define alarms on this asset model.
Contains a composite model definition in an asset model. This composite model definition is applied to all assets created from the asset model.
The name of the composite model.
The description of the composite model.
The type of the composite model. For alarm composite models, this type is AWS/ALARM .
The asset property definitions for this composite model.
Contains an asset model property definition. This property definition is applied to all assets created from the asset model.
The name of the property definition.
The data type of the property definition.
If you specify STRUCT , you must also specify dataTypeSpec to identify the type of the structure for this property.
The data type of the structure for this property. This parameter is required on properties that have the STRUCT data type.
The options for this parameter depend on the type of the composite model in which you define this property. Use AWS/ALARM_STATE for alarm state in alarm composite models.
The unit of the property definition, such as Newtons or RPM .
The property definition type (see PropertyType ). You can only specify one type in a property definition.
Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an IIoT wind turbine.
The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see Updating attribute values in the IoT SiteWise User Guide .
Specifies an asset measurement property. A measurement represents a device's raw sensor data stream, such as timestamped temperature values or timestamped power values.
The processing configuration for the given measurement property. You can configure measurements to be kept at the edge or forwarded to the Amazon Web Services Cloud. By default, measurements are forwarded to the cloud.
The forwarding configuration for the given measurement property.
The forwarding state for the given property.
Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.
The mathematical expression that defines the transformation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.
For more information, see Quotas in the IoT SiteWise User Guide .
The list of variables used in the expression.
Contains expression variable information.
The friendly name of the variable to be used in the expression.
The variable that identifies an asset property from which to use values.
The ID of the property to use as the variable. You can use the property name if it's from the same asset model.
The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID.
You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId . For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide .
The processing configuration for the given transform property. You can configure transforms to be kept at the edge or forwarded to the Amazon Web Services Cloud. You can also configure transforms to be computed at the edge or in the cloud.
The compute location for the given transform property.
The forwarding configuration for a given property.
The forwarding state for the given property.
Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.
The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.
For more information, see Quotas in the IoT SiteWise User Guide .
The list of variables used in the expression.
Contains expression variable information.
The friendly name of the variable to be used in the expression.
The variable that identifies an asset property from which to use values.
The ID of the property to use as the variable. You can use the property name if it's from the same asset model.
The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID.
You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId . For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide .
The window (time interval) over which IoT SiteWise computes the metric's aggregation expression. IoT SiteWise computes one data point per window .
The tumbling time interval window.
The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.
IoT SiteWise computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval at the end of each hour, and so on.
When IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. IoT SiteWise places the computed data point at the end of the interval.
The offset for the tumbling window. The offset parameter accepts the following:
18h for offset and 1d for interval , IoT SiteWise aggregates data in one of the following ways:PT18H for offset and 1d for interval , IoT SiteWise aggregates data in one of the following ways:00:03:00 for offset , 5m for interval , and you create the metric at 2 PM (UTC), you get the first aggregation result at 2:03 PM (UTC). You get the second aggregation result at 2:08 PM (UTC).2021-07-23T18:00-08 for offset and 1d for interval , IoT SiteWise aggregates data in one of the following ways:The processing configuration for the given metric property. You can configure metrics to be computed at the edge or in the Amazon Web Services Cloud. By default, metrics are forwarded to the cloud.
The compute location for the given metric property.
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
This field is autopopulated if not provided.
A list of key-value pairs that contain metadata for the asset model. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide .
dict
Response Syntax
{
'assetModelId': 'string',
'assetModelArn': 'string',
'assetModelStatus': {
'state': 'CREATING'|'ACTIVE'|'UPDATING'|'PROPAGATING'|'DELETING'|'FAILED',
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
'message': 'string',
'details': [
{
'code': 'INCOMPATIBLE_COMPUTE_LOCATION'|'INCOMPATIBLE_FORWARDING_CONFIGURATION',
'message': 'string'
},
]
}
}
}
Response Structure
(dict) --
assetModelId (string) --
The ID of the asset model. You can use this ID when you call other IoT SiteWise APIs.
assetModelArn (string) --
The ARN of the asset model, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}
assetModelStatus (dict) --
The status of the asset model, which contains a state (CREATING after successfully calling this operation) and any error message.
state (string) --
The current state of the asset model.
error (dict) --
Contains associated error information, if any.
code (string) --
The error code.
message (string) --
The error message.
details (list) --
A list of detailed errors.
(dict) --
Contains detailed error information.
code (string) --
The error code.
message (string) --
The error message.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceAlreadyExistsExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionIoTSiteWise.Client.exceptions.LimitExceededExceptionIoTSiteWise.Client.exceptions.ConflictingOperationExceptioncreate_bulk_import_job(**kwargs)¶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 .
Warning
You must enable IoT SiteWise to export data to Amazon S3 before you create a bulk import job. For more information about how to configure storage settings, see PutStorageConfiguration .
See also: AWS API Documentation
Request Syntax
response = client.create_bulk_import_job(
jobName='string',
jobRoleArn='string',
files=[
{
'bucket': 'string',
'key': 'string',
'versionId': 'string'
},
],
errorReportLocation={
'bucket': 'string',
'prefix': 'string'
},
jobConfiguration={
'fileFormat': {
'csv': {
'columnNames': [
'ALIAS'|'ASSET_ID'|'PROPERTY_ID'|'DATA_TYPE'|'TIMESTAMP_SECONDS'|'TIMESTAMP_NANO_OFFSET'|'QUALITY'|'VALUE',
]
}
}
}
)
[REQUIRED]
The unique name that helps identify the job request.
[REQUIRED]
The ARN of the IAM role that allows IoT SiteWise to read Amazon S3 data.
[REQUIRED]
The files in the specified Amazon S3 bucket that contain your data.
The file in Amazon S3 where your data is saved.
The name of the Amazon S3 bucket from which data is imported.
The key of the Amazon S3 object that contains your data. Each object has a key that is a unique identifier. Each object has exactly one key.
The version ID to identify a specific version of the Amazon S3 object that contains your data.
[REQUIRED]
The Amazon S3 destination where errors associated with the job creation request are saved.
The name of the Amazon S3 bucket to which errors associated with the bulk import job are sent.
Amazon S3 uses the prefix as a folder name to organize data in the bucket. Each Amazon S3 object has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/). For more information, see Organizing objects using prefixes in the Amazon Simple Storage Service User Guide .
[REQUIRED]
Contains the configuration information of a job, such as the file format used to save data in Amazon S3.
The file format of the data in Amazon S3.
The .csv file format.
The column names specified in the .csv file.
dict
Response Syntax
{
'jobId': 'string',
'jobName': 'string',
'jobStatus': 'PENDING'|'CANCELLED'|'RUNNING'|'COMPLETED'|'FAILED'|'COMPLETED_WITH_FAILURES'
}
Response Structure
(dict) --
jobId (string) --
The ID of the job.
jobName (string) --
The unique name that helps identify the job request.
jobStatus (string) --
The status of the bulk import job can be one of following values.
PENDING – IoT SiteWise is waiting for the current bulk import job to finish.CANCELLED – The bulk import job has been canceled.RUNNING – IoT SiteWise is processing your request to import your data from Amazon S3.COMPLETED – IoT SiteWise successfully completed your request to import data from Amazon S3.FAILED – IoT SiteWise couldn't process your request to import data from Amazon S3. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.COMPLETED_WITH_FAILURES – IoT SiteWise completed your request to import data from Amazon S3 with errors. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceAlreadyExistsExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionIoTSiteWise.Client.exceptions.LimitExceededExceptionIoTSiteWise.Client.exceptions.ConflictingOperationExceptioncreate_dashboard(**kwargs)¶Creates a dashboard in an IoT SiteWise Monitor project.
See also: AWS API Documentation
Request Syntax
response = client.create_dashboard(
projectId='string',
dashboardName='string',
dashboardDescription='string',
dashboardDefinition='string',
clientToken='string',
tags={
'string': 'string'
}
)
[REQUIRED]
The ID of the project in which to create the dashboard.
[REQUIRED]
A friendly name for the dashboard.
[REQUIRED]
The dashboard definition specified in a JSON literal. For detailed information, see Creating dashboards (CLI) in the IoT SiteWise User Guide .
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
This field is autopopulated if not provided.
A list of key-value pairs that contain metadata for the dashboard. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide .
dict
Response Syntax
{
'dashboardId': 'string',
'dashboardArn': 'string'
}
Response Structure
(dict) --
dashboardId (string) --
The ID of the dashboard.
dashboardArn (string) --
The ARN of the dashboard, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionIoTSiteWise.Client.exceptions.LimitExceededExceptioncreate_gateway(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.create_gateway(
gatewayName='string',
gatewayPlatform={
'greengrass': {
'groupArn': 'string'
},
'greengrassV2': {
'coreDeviceThingName': 'string'
}
},
tags={
'string': 'string'
}
)
[REQUIRED]
A unique, friendly name for the gateway.
[REQUIRED]
The gateway's platform. You can only specify one platform in a gateway.
A gateway that runs on IoT Greengrass.
The ARN of the Greengrass group. For more information about how to find a group's ARN, see ListGroups and GetGroup in the IoT Greengrass API Reference .
A gateway that runs on IoT Greengrass V2.
The name of the IoT thing for your IoT Greengrass V2 core device.
A list of key-value pairs that contain metadata for the gateway. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide .
dict
Response Syntax
{
'gatewayId': 'string',
'gatewayArn': 'string'
}
Response Structure
(dict) --
gatewayId (string) --
The ID of the gateway device. You can use this ID when you call other IoT SiteWise APIs.
gatewayArn (string) --
The ARN of the gateway, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceAlreadyExistsExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionIoTSiteWise.Client.exceptions.LimitExceededExceptioncreate_portal(**kwargs)¶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.
Note
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 .
See also: AWS API Documentation
Request Syntax
response = client.create_portal(
portalName='string',
portalDescription='string',
portalContactEmail='string',
clientToken='string',
portalLogoImageFile={
'data': b'bytes',
'type': 'PNG'
},
roleArn='string',
tags={
'string': 'string'
},
portalAuthMode='IAM'|'SSO',
notificationSenderEmail='string',
alarms={
'alarmRoleArn': 'string',
'notificationLambdaArn': 'string'
}
)
[REQUIRED]
A friendly name for the portal.
[REQUIRED]
The Amazon Web Services administrator's contact email address.
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
This field is autopopulated if not provided.
A logo image to display in the portal. Upload a square, high-resolution image. The image is displayed on a dark background.
The image file contents, represented as a base64-encoded string. The file size must be less than 1 MB.
The file type of the image.
[REQUIRED]
The ARN of a service role that allows the portal's users to access your IoT SiteWise resources on your behalf. For more information, see Using service roles for IoT SiteWise Monitor in the IoT SiteWise User Guide .
A list of key-value pairs that contain metadata for the portal. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide .
The service to use to authenticate users to the portal. Choose from the following options:
SSO – The portal uses IAM Identity Center (successor to Single Sign-On) to authenticate users and manage user permissions. Before you can create a portal that uses IAM Identity Center, you must enable IAM Identity Center. For more information, see Enabling IAM Identity Center in the IoT SiteWise User Guide . This option is only available in Amazon Web Services Regions other than the China Regions.IAM – The portal uses Identity and Access Management to authenticate users and manage user permissions.You can't change this value after you create a portal.
Default: SSO
The email address that sends alarm notifications.
Warning
If you use the IoT Events managed Lambda function to manage your emails, you must verify the sender email address in Amazon SES .
Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range. For more information, see Monitoring with alarms in the IoT SiteWise Application Guide .
The ARN of the IAM role that allows the alarm to perform actions and access Amazon Web Services resources and services, such as IoT Events.
The ARN of the Lambda function that manages alarm notifications. For more information, see Managing alarm notifications in the IoT Events Developer Guide .
dict
Response Syntax
{
'portalId': 'string',
'portalArn': 'string',
'portalStartUrl': 'string',
'portalStatus': {
'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'FAILED',
'error': {
'code': 'INTERNAL_FAILURE'|'VALIDATION_ERROR'|'LIMIT_EXCEEDED',
'message': 'string'
}
},
'ssoApplicationId': 'string'
}
Response Structure
(dict) --
portalId (string) --
The ID of the created portal.
portalArn (string) --
The ARN of the portal, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}
portalStartUrl (string) --
The URL for the IoT SiteWise Monitor portal. You can use this URL to access portals that use IAM Identity Center for authentication. For portals that use IAM for authentication, you must use the IoT SiteWise console to get a URL that you can use to access the portal.
portalStatus (dict) --
The status of the portal, which contains a state (CREATING after successfully calling this operation) and any error message.
state (string) --
The current state of the portal.
error (dict) --
Contains associated error information, if any.
code (string) --
The error code.
message (string) --
The error message.
ssoApplicationId (string) --
The associated IAM Identity Center application ID, if the portal uses IAM Identity Center.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionIoTSiteWise.Client.exceptions.LimitExceededExceptioncreate_project(**kwargs)¶Creates a project in the specified portal.
Note
Make sure that the project name and description don't contain confidential information.
See also: AWS API Documentation
Request Syntax
response = client.create_project(
portalId='string',
projectName='string',
projectDescription='string',
clientToken='string',
tags={
'string': 'string'
}
)
[REQUIRED]
The ID of the portal in which to create the project.
[REQUIRED]
A friendly name for the project.
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
This field is autopopulated if not provided.
A list of key-value pairs that contain metadata for the project. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide .
dict
Response Syntax
{
'projectId': 'string',
'projectArn': 'string'
}
Response Structure
(dict) --
projectId (string) --
The ID of the project.
projectArn (string) --
The ARN of the project, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId}
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionIoTSiteWise.Client.exceptions.LimitExceededExceptiondelete_access_policy(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.delete_access_policy(
accessPolicyId='string',
clientToken='string'
)
[REQUIRED]
The ID of the access policy to be deleted.
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
This field is autopopulated if not provided.
dict
Response Syntax
{}
Response Structure
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptiondelete_asset(**kwargs)¶Deletes an asset. This action can't be undone. For more information, see Deleting assets and models in the IoT SiteWise User Guide .
Note
You can't delete an asset that's associated to another asset. For more information, see DisassociateAssets .
See also: AWS API Documentation
Request Syntax
response = client.delete_asset(
assetId='string',
clientToken='string'
)
[REQUIRED]
The ID of the asset to delete.
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
This field is autopopulated if not provided.
dict
Response Syntax
{
'assetStatus': {
'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED',
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
'message': 'string',
'details': [
{
'code': 'INCOMPATIBLE_COMPUTE_LOCATION'|'INCOMPATIBLE_FORWARDING_CONFIGURATION',
'message': 'string'
},
]
}
}
}
Response Structure
(dict) --
assetStatus (dict) --
The status of the asset, which contains a state (DELETING after successfully calling this operation) and any error message.
state (string) --
The current status of the asset.
error (dict) --
Contains associated error information, if any.
code (string) --
The error code.
message (string) --
The error message.
details (list) --
A list of detailed errors.
(dict) --
Contains detailed error information.
code (string) --
The error code.
message (string) --
The error message.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionIoTSiteWise.Client.exceptions.ConflictingOperationExceptiondelete_asset_model(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.delete_asset_model(
assetModelId='string',
clientToken='string'
)
[REQUIRED]
The ID of the asset model to delete.
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
This field is autopopulated if not provided.
dict
Response Syntax
{
'assetModelStatus': {
'state': 'CREATING'|'ACTIVE'|'UPDATING'|'PROPAGATING'|'DELETING'|'FAILED',
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
'message': 'string',
'details': [
{
'code': 'INCOMPATIBLE_COMPUTE_LOCATION'|'INCOMPATIBLE_FORWARDING_CONFIGURATION',
'message': 'string'
},
]
}
}
}
Response Structure
(dict) --
assetModelStatus (dict) --
The status of the asset model, which contains a state (DELETING after successfully calling this operation) and any error message.
state (string) --
The current state of the asset model.
error (dict) --
Contains associated error information, if any.
code (string) --
The error code.
message (string) --
The error message.
details (list) --
A list of detailed errors.
(dict) --
Contains detailed error information.
code (string) --
The error code.
message (string) --
The error message.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionIoTSiteWise.Client.exceptions.ConflictingOperationExceptiondelete_dashboard(**kwargs)¶Deletes a dashboard from IoT SiteWise Monitor.
See also: AWS API Documentation
Request Syntax
response = client.delete_dashboard(
dashboardId='string',
clientToken='string'
)
[REQUIRED]
The ID of the dashboard to delete.
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
This field is autopopulated if not provided.
dict
Response Syntax
{}
Response Structure
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptiondelete_gateway(**kwargs)¶Deletes a gateway from IoT SiteWise. When you delete a gateway, some of the gateway's files remain in your gateway's file system.
See also: AWS API Documentation
Request Syntax
response = client.delete_gateway(
gatewayId='string'
)
[REQUIRED]
The ID of the gateway to delete.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptiondelete_portal(**kwargs)¶Deletes a portal from IoT SiteWise Monitor.
See also: AWS API Documentation
Request Syntax
response = client.delete_portal(
portalId='string',
clientToken='string'
)
[REQUIRED]
The ID of the portal to delete.
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
This field is autopopulated if not provided.
dict
Response Syntax
{
'portalStatus': {
'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'FAILED',
'error': {
'code': 'INTERNAL_FAILURE'|'VALIDATION_ERROR'|'LIMIT_EXCEEDED',
'message': 'string'
}
}
}
Response Structure
(dict) --
portalStatus (dict) --
The status of the portal, which contains a state (DELETING after successfully calling this operation) and any error message.
state (string) --
The current state of the portal.
error (dict) --
Contains associated error information, if any.
code (string) --
The error code.
message (string) --
The error message.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionIoTSiteWise.Client.exceptions.ConflictingOperationExceptiondelete_project(**kwargs)¶Deletes a project from IoT SiteWise Monitor.
See also: AWS API Documentation
Request Syntax
response = client.delete_project(
projectId='string',
clientToken='string'
)
[REQUIRED]
The ID of the project.
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
This field is autopopulated if not provided.
dict
Response Syntax
{}
Response Structure
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptiondelete_time_series(**kwargs)¶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:
alias of the time series.alias of the time series.assetId and propertyId that identifies the asset property.See also: AWS API Documentation
Request Syntax
response = client.delete_time_series(
alias='string',
assetId='string',
propertyId='string',
clientToken='string'
)
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
This field is autopopulated if not provided.
None
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionIoTSiteWise.Client.exceptions.ConflictingOperationExceptiondescribe_access_policy(**kwargs)¶Describes an access policy, which specifies an identity's access to an IoT SiteWise Monitor portal or project.
See also: AWS API Documentation
Request Syntax
response = client.describe_access_policy(
accessPolicyId='string'
)
[REQUIRED]
The ID of the access policy.
{
'accessPolicyId': 'string',
'accessPolicyArn': 'string',
'accessPolicyIdentity': {
'user': {
'id': 'string'
},
'group': {
'id': 'string'
},
'iamUser': {
'arn': 'string'
},
'iamRole': {
'arn': 'string'
}
},
'accessPolicyResource': {
'portal': {
'id': 'string'
},
'project': {
'id': 'string'
}
},
'accessPolicyPermission': 'ADMINISTRATOR'|'VIEWER',
'accessPolicyCreationDate': datetime(2015, 1, 1),
'accessPolicyLastUpdateDate': datetime(2015, 1, 1)
}
Response Structure
The ID of the access policy.
The ARN of the access policy, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId}
The identity (IAM Identity Center user, IAM Identity Center group, or IAM user) to which this access policy applies.
An IAM Identity Center user identity.
The IAM Identity Center ID of the user.
An IAM Identity Center group identity.
The IAM Identity Center ID of the group.
An IAM user identity.
The ARN of the IAM user. For more information, see IAM ARNs in the IAM User Guide .
Note
If you delete the IAM user, access policies that contain this identity include an empty arn . You can delete the access policy for the IAM user that no longer exists.
An IAM role identity.
The ARN of the IAM role. For more information, see IAM ARNs in the IAM User Guide .
The IoT SiteWise Monitor resource (portal or project) to which this access policy provides access.
A portal resource.
The ID of the portal.
A project resource.
The ID of the project.
The access policy permission. Note that a project ADMINISTRATOR is also known as a project owner.
The date the access policy was created, in Unix epoch time.
The date the access policy was last updated, in Unix epoch time.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptiondescribe_asset(**kwargs)¶Retrieves information about an asset.
See also: AWS API Documentation
Request Syntax
response = client.describe_asset(
assetId='string',
excludeProperties=True|False
)
[REQUIRED]
The ID of the asset.
dict
Response Syntax
{
'assetId': 'string',
'assetArn': 'string',
'assetName': 'string',
'assetModelId': 'string',
'assetProperties': [
{
'id': 'string',
'name': 'string',
'alias': 'string',
'notification': {
'topic': 'string',
'state': 'ENABLED'|'DISABLED'
},
'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN'|'STRUCT',
'dataTypeSpec': 'string',
'unit': 'string'
},
],
'assetHierarchies': [
{
'id': 'string',
'name': 'string'
},
],
'assetCompositeModels': [
{
'name': 'string',
'description': 'string',
'type': 'string',
'properties': [
{
'id': 'string',
'name': 'string',
'alias': 'string',
'notification': {
'topic': 'string',
'state': 'ENABLED'|'DISABLED'
},
'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN'|'STRUCT',
'dataTypeSpec': 'string',
'unit': 'string'
},
],
'id': 'string'
},
],
'assetCreationDate': datetime(2015, 1, 1),
'assetLastUpdateDate': datetime(2015, 1, 1),
'assetStatus': {
'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED',
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
'message': 'string',
'details': [
{
'code': 'INCOMPATIBLE_COMPUTE_LOCATION'|'INCOMPATIBLE_FORWARDING_CONFIGURATION',
'message': 'string'
},
]
}
},
'assetDescription': 'string'
}
Response Structure
(dict) --
assetId (string) --
The ID of the asset.
assetArn (string) --
The ARN of the asset, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}
assetName (string) --
The name of the asset.
assetModelId (string) --
The ID of the asset model that was used to create the asset.
assetProperties (list) --
The list of asset properties for the asset.
This object doesn't include properties that you define in composite models. You can find composite model properties in the assetCompositeModels object.
(dict) --
Contains asset property information.
id (string) --
The ID of the asset property.
name (string) --
The name of the property.
alias (string) --
The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature ). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide .
notification (dict) --
The asset property's notification topic and state. For more information, see UpdateAssetProperty .
topic (string) --
The MQTT topic to which IoT SiteWise publishes property value update notifications.
state (string) --
The current notification state.
dataType (string) --
The data type of the asset property.
dataTypeSpec (string) --
The data type of the structure for this property. This parameter exists on properties that have the STRUCT data type.
unit (string) --
The unit (such as Newtons or RPM ) of the asset property.
assetHierarchies (list) --
A list of asset hierarchies that each contain a hierarchyId . A hierarchy specifies allowed parent/child asset relationships.
(dict) --
Describes an asset hierarchy that contains a hierarchy's name and ID.
id (string) --
The ID of the hierarchy. This ID is a hierarchyId .
name (string) --
The hierarchy name provided in the CreateAssetModel or UpdateAssetModel API operation.
assetCompositeModels (list) --
The composite models for the asset.
(dict) --
Contains information about a composite model in an asset. This object contains the asset's properties that you define in the composite model.
name (string) --
The name of the composite model.
description (string) --
The description of the composite model.
type (string) --
The type of the composite model. For alarm composite models, this type is AWS/ALARM .
properties (list) --
The asset properties that this composite model defines.
(dict) --
Contains asset property information.
id (string) --
The ID of the asset property.
name (string) --
The name of the property.
alias (string) --
The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature ). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide .
notification (dict) --
The asset property's notification topic and state. For more information, see UpdateAssetProperty .
topic (string) --
The MQTT topic to which IoT SiteWise publishes property value update notifications.
state (string) --
The current notification state.
dataType (string) --
The data type of the asset property.
dataTypeSpec (string) --
The data type of the structure for this property. This parameter exists on properties that have the STRUCT data type.
unit (string) --
The unit (such as Newtons or RPM ) of the asset property.
id (string) --
The ID of the asset composite model.
assetCreationDate (datetime) --
The date the asset was created, in Unix epoch time.
assetLastUpdateDate (datetime) --
The date the asset was last updated, in Unix epoch time.
assetStatus (dict) --
The current status of the asset, which contains a state and any error message.
state (string) --
The current status of the asset.
error (dict) --
Contains associated error information, if any.
code (string) --
The error code.
message (string) --
The error message.
details (list) --
A list of detailed errors.
(dict) --
Contains detailed error information.
code (string) --
The error code.
message (string) --
The error message.
assetDescription (string) --
A description for the asset.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptiondescribe_asset_model(**kwargs)¶Retrieves information about an asset model.
See also: AWS API Documentation
Request Syntax
response = client.describe_asset_model(
assetModelId='string',
excludeProperties=True|False
)
[REQUIRED]
The ID of the asset model.
dict
Response Syntax
{
'assetModelId': 'string',
'assetModelArn': 'string',
'assetModelName': 'string',
'assetModelDescription': 'string',
'assetModelProperties': [
{
'id': 'string',
'name': 'string',
'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN'|'STRUCT',
'dataTypeSpec': 'string',
'unit': 'string',
'type': {
'attribute': {
'defaultValue': 'string'
},
'measurement': {
'processingConfig': {
'forwardingConfig': {
'state': 'DISABLED'|'ENABLED'
}
}
},
'transform': {
'expression': 'string',
'variables': [
{
'name': 'string',
'value': {
'propertyId': 'string',
'hierarchyId': 'string'
}
},
],
'processingConfig': {
'computeLocation': 'EDGE'|'CLOUD',
'forwardingConfig': {
'state': 'DISABLED'|'ENABLED'
}
}
},
'metric': {
'expression': 'string',
'variables': [
{
'name': 'string',
'value': {
'propertyId': 'string',
'hierarchyId': 'string'
}
},
],
'window': {
'tumbling': {
'interval': 'string',
'offset': 'string'
}
},
'processingConfig': {
'computeLocation': 'EDGE'|'CLOUD'
}
}
}
},
],
'assetModelHierarchies': [
{
'id': 'string',
'name': 'string',
'childAssetModelId': 'string'
},
],
'assetModelCompositeModels': [
{
'name': 'string',
'description': 'string',
'type': 'string',
'properties': [
{
'id': 'string',
'name': 'string',
'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN'|'STRUCT',
'dataTypeSpec': 'string',
'unit': 'string',
'type': {
'attribute': {
'defaultValue': 'string'
},
'measurement': {
'processingConfig': {
'forwardingConfig': {
'state': 'DISABLED'|'ENABLED'
}
}
},
'transform': {
'expression': 'string',
'variables': [
{
'name': 'string',
'value': {
'propertyId': 'string',
'hierarchyId': 'string'
}
},
],
'processingConfig': {
'computeLocation': 'EDGE'|'CLOUD',
'forwardingConfig': {
'state': 'DISABLED'|'ENABLED'
}
}
},
'metric': {
'expression': 'string',
'variables': [
{
'name': 'string',
'value': {
'propertyId': 'string',
'hierarchyId': 'string'
}
},
],
'window': {
'tumbling': {
'interval': 'string',
'offset': 'string'
}
},
'processingConfig': {
'computeLocation': 'EDGE'|'CLOUD'
}
}
}
},
],
'id': 'string'
},
],
'assetModelCreationDate': datetime(2015, 1, 1),
'assetModelLastUpdateDate': datetime(2015, 1, 1),
'assetModelStatus': {
'state': 'CREATING'|'ACTIVE'|'UPDATING'|'PROPAGATING'|'DELETING'|'FAILED',
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
'message': 'string',
'details': [
{
'code': 'INCOMPATIBLE_COMPUTE_LOCATION'|'INCOMPATIBLE_FORWARDING_CONFIGURATION',
'message': 'string'
},
]
}
}
}
Response Structure
(dict) --
assetModelId (string) --
The ID of the asset model.
assetModelArn (string) --
The ARN of the asset model, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}
assetModelName (string) --
The name of the asset model.
assetModelDescription (string) --
The asset model's description.
assetModelProperties (list) --
The list of asset properties for the asset model.
This object doesn't include properties that you define in composite models. You can find composite model properties in the assetModelCompositeModels object.
(dict) --
Contains information about an asset model property.
id (string) --
The ID of the asset model property.
name (string) --
The name of the asset model property.
dataType (string) --
The data type of the asset model property.
dataTypeSpec (string) --
The data type of the structure for this property. This parameter exists on properties that have the STRUCT data type.
unit (string) --
The unit of the asset model property, such as Newtons or RPM .
type (dict) --
The property type (see PropertyType ).
attribute (dict) --
Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an IIoT wind turbine.
defaultValue (string) --
The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see Updating attribute values in the IoT SiteWise User Guide .
measurement (dict) --
Specifies an asset measurement property. A measurement represents a device's raw sensor data stream, such as timestamped temperature values or timestamped power values.
processingConfig (dict) --
The processing configuration for the given measurement property. You can configure measurements to be kept at the edge or forwarded to the Amazon Web Services Cloud. By default, measurements are forwarded to the cloud.
forwardingConfig (dict) --
The forwarding configuration for the given measurement property.
state (string) --
The forwarding state for the given property.
transform (dict) --
Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.
expression (string) --
The mathematical expression that defines the transformation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.
For more information, see Quotas in the IoT SiteWise User Guide .
variables (list) --
The list of variables used in the expression.
(dict) --
Contains expression variable information.
name (string) --
The friendly name of the variable to be used in the expression.
value (dict) --
The variable that identifies an asset property from which to use values.
propertyId (string) --
The ID of the property to use as the variable. You can use the property name if it's from the same asset model.
hierarchyId (string) --
The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID.
You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId . For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide .
processingConfig (dict) --
The processing configuration for the given transform property. You can configure transforms to be kept at the edge or forwarded to the Amazon Web Services Cloud. You can also configure transforms to be computed at the edge or in the cloud.
computeLocation (string) --
The compute location for the given transform property.
forwardingConfig (dict) --
The forwarding configuration for a given property.
state (string) --
The forwarding state for the given property.
metric (dict) --
Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.
expression (string) --
The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.
For more information, see Quotas in the IoT SiteWise User Guide .
variables (list) --
The list of variables used in the expression.
(dict) --
Contains expression variable information.
name (string) --
The friendly name of the variable to be used in the expression.
value (dict) --
The variable that identifies an asset property from which to use values.
propertyId (string) --
The ID of the property to use as the variable. You can use the property name if it's from the same asset model.
hierarchyId (string) --
The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID.
You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId . For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide .
window (dict) --
The window (time interval) over which IoT SiteWise computes the metric's aggregation expression. IoT SiteWise computes one data point per window .
tumbling (dict) --
The tumbling time interval window.
interval (string) --
The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.
IoT SiteWise computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval at the end of each hour, and so on.
When IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. IoT SiteWise places the computed data point at the end of the interval.
offset (string) --
The offset for the tumbling window. The offset parameter accepts the following:
18h for offset and 1d for interval , IoT SiteWise aggregates data in one of the following ways:PT18H for offset and 1d for interval , IoT SiteWise aggregates data in one of the following ways:00:03:00 for offset , 5m for interval , and you create the metric at 2 PM (UTC), you get the first aggregation result at 2:03 PM (UTC). You get the second aggregation result at 2:08 PM (UTC).2021-07-23T18:00-08 for offset and 1d for interval , IoT SiteWise aggregates data in one of the following ways:processingConfig (dict) --
The processing configuration for the given metric property. You can configure metrics to be computed at the edge or in the Amazon Web Services Cloud. By default, metrics are forwarded to the cloud.
computeLocation (string) --
The compute location for the given metric property.
assetModelHierarchies (list) --
A list of asset model hierarchies that each contain a childAssetModelId and a hierarchyId (named id ). A hierarchy specifies allowed parent/child asset relationships for an asset model.
(dict) --
Describes an asset hierarchy that contains a hierarchy's name, ID, and child asset model ID that specifies the type of asset that can be in this hierarchy.
id (string) --
The ID of the asset model hierarchy. This ID is a hierarchyId .
name (string) --
The name of the asset model hierarchy that you specify by using the CreateAssetModel or UpdateAssetModel API operation.
childAssetModelId (string) --
The ID of the asset model. All assets in this hierarchy must be instances of the childAssetModelId asset model.
assetModelCompositeModels (list) --
The list of composite asset models for the asset model.
(dict) --
Contains information about a composite model in an asset model. This object contains the asset property definitions that you define in the composite model.
name (string) --
The name of the composite model.
description (string) --
The description of the composite model.
type (string) --
The type of the composite model. For alarm composite models, this type is AWS/ALARM .
properties (list) --
The asset property definitions for this composite model.
(dict) --
Contains information about an asset model property.
id (string) --
The ID of the asset model property.
name (string) --
The name of the asset model property.
dataType (string) --
The data type of the asset model property.
dataTypeSpec (string) --
The data type of the structure for this property. This parameter exists on properties that have the STRUCT data type.
unit (string) --
The unit of the asset model property, such as Newtons or RPM .
type (dict) --
The property type (see PropertyType ).
attribute (dict) --
Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an IIoT wind turbine.
defaultValue (string) --
The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see Updating attribute values in the IoT SiteWise User Guide .
measurement (dict) --
Specifies an asset measurement property. A measurement represents a device's raw sensor data stream, such as timestamped temperature values or timestamped power values.
processingConfig (dict) --
The processing configuration for the given measurement property. You can configure measurements to be kept at the edge or forwarded to the Amazon Web Services Cloud. By default, measurements are forwarded to the cloud.
forwardingConfig (dict) --
The forwarding configuration for the given measurement property.
state (string) --
The forwarding state for the given property.
transform (dict) --
Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.
expression (string) --
The mathematical expression that defines the transformation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.
For more information, see Quotas in the IoT SiteWise User Guide .
variables (list) --
The list of variables used in the expression.
(dict) --
Contains expression variable information.
name (string) --
The friendly name of the variable to be used in the expression.
value (dict) --
The variable that identifies an asset property from which to use values.
propertyId (string) --
The ID of the property to use as the variable. You can use the property name if it's from the same asset model.
hierarchyId (string) --
The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID.
You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId . For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide .
processingConfig (dict) --
The processing configuration for the given transform property. You can configure transforms to be kept at the edge or forwarded to the Amazon Web Services Cloud. You can also configure transforms to be computed at the edge or in the cloud.
computeLocation (string) --
The compute location for the given transform property.
forwardingConfig (dict) --
The forwarding configuration for a given property.
state (string) --
The forwarding state for the given property.
metric (dict) --
Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.
expression (string) --
The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.
For more information, see Quotas in the IoT SiteWise User Guide .
variables (list) --
The list of variables used in the expression.
(dict) --
Contains expression variable information.
name (string) --
The friendly name of the variable to be used in the expression.
value (dict) --
The variable that identifies an asset property from which to use values.
propertyId (string) --
The ID of the property to use as the variable. You can use the property name if it's from the same asset model.
hierarchyId (string) --
The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID.
You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId . For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide .
window (dict) --
The window (time interval) over which IoT SiteWise computes the metric's aggregation expression. IoT SiteWise computes one data point per window .
tumbling (dict) --
The tumbling time interval window.
interval (string) --
The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.
IoT SiteWise computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval at the end of each hour, and so on.
When IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. IoT SiteWise places the computed data point at the end of the interval.
offset (string) --
The offset for the tumbling window. The offset parameter accepts the following:
18h for offset and 1d for interval , IoT SiteWise aggregates data in one of the following ways:PT18H for offset and 1d for interval , IoT SiteWise aggregates data in one of the following ways:00:03:00 for offset , 5m for interval , and you create the metric at 2 PM (UTC), you get the first aggregation result at 2:03 PM (UTC). You get the second aggregation result at 2:08 PM (UTC).2021-07-23T18:00-08 for offset and 1d for interval , IoT SiteWise aggregates data in one of the following ways:processingConfig (dict) --
The processing configuration for the given metric property. You can configure metrics to be computed at the edge or in the Amazon Web Services Cloud. By default, metrics are forwarded to the cloud.
computeLocation (string) --
The compute location for the given metric property.
id (string) --
The ID of the asset model composite model.
assetModelCreationDate (datetime) --
The date the asset model was created, in Unix epoch time.
assetModelLastUpdateDate (datetime) --
The date the asset model was last updated, in Unix epoch time.
assetModelStatus (dict) --
The current status of the asset model, which contains a state and any error message.
state (string) --
The current state of the asset model.
error (dict) --
Contains associated error information, if any.
code (string) --
The error code.
message (string) --
The error message.
details (list) --
A list of detailed errors.
(dict) --
Contains detailed error information.
code (string) --
The error code.
message (string) --
The error message.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptiondescribe_asset_property(**kwargs)¶Retrieves information about an asset property.
Note
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 .
See also: AWS API Documentation
Request Syntax
response = client.describe_asset_property(
assetId='string',
propertyId='string'
)
[REQUIRED]
The ID of the asset.
[REQUIRED]
The ID of the asset property.
dict
Response Syntax
{
'assetId': 'string',
'assetName': 'string',
'assetModelId': 'string',
'assetProperty': {
'id': 'string',
'name': 'string',
'alias': 'string',
'notification': {
'topic': 'string',
'state': 'ENABLED'|'DISABLED'
},
'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN'|'STRUCT',
'unit': 'string',
'type': {
'attribute': {
'defaultValue': 'string'
},
'measurement': {
'processingConfig': {
'forwardingConfig': {
'state': 'DISABLED'|'ENABLED'
}
}
},
'transform': {
'expression': 'string',
'variables': [
{
'name': 'string',
'value': {
'propertyId': 'string',
'hierarchyId': 'string'
}
},
],
'processingConfig': {
'computeLocation': 'EDGE'|'CLOUD',
'forwardingConfig': {
'state': 'DISABLED'|'ENABLED'
}
}
},
'metric': {
'expression': 'string',
'variables': [
{
'name': 'string',
'value': {
'propertyId': 'string',
'hierarchyId': 'string'
}
},
],
'window': {
'tumbling': {
'interval': 'string',
'offset': 'string'
}
},
'processingConfig': {
'computeLocation': 'EDGE'|'CLOUD'
}
}
}
},
'compositeModel': {
'name': 'string',
'type': 'string',
'assetProperty': {
'id': 'string',
'name': 'string',
'alias': 'string',
'notification': {
'topic': 'string',
'state': 'ENABLED'|'DISABLED'
},
'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN'|'STRUCT',
'unit': 'string',
'type': {
'attribute': {
'defaultValue': 'string'
},
'measurement': {
'processingConfig': {
'forwardingConfig': {
'state': 'DISABLED'|'ENABLED'
}
}
},
'transform': {
'expression': 'string',
'variables': [
{
'name': 'string',
'value': {
'propertyId': 'string',
'hierarchyId': 'string'
}
},
],
'processingConfig': {
'computeLocation': 'EDGE'|'CLOUD',
'forwardingConfig': {
'state': 'DISABLED'|'ENABLED'
}
}
},
'metric': {
'expression': 'string',
'variables': [
{
'name': 'string',
'value': {
'propertyId': 'string',
'hierarchyId': 'string'
}
},
],
'window': {
'tumbling': {
'interval': 'string',
'offset': 'string'
}
},
'processingConfig': {
'computeLocation': 'EDGE'|'CLOUD'
}
}
}
},
'id': 'string'
}
}
Response Structure
(dict) --
assetId (string) --
The ID of the asset.
assetName (string) --
The name of the asset.
assetModelId (string) --
The ID of the asset model.
assetProperty (dict) --
The asset property's definition, alias, and notification state.
This response includes this object for normal asset properties. If you describe an asset property in a composite model, this response includes the asset property information in compositeModel .
id (string) --
The ID of the asset property.
name (string) --
The name of the property.
alias (string) --
The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature ). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide .
notification (dict) --
The asset property's notification topic and state. For more information, see UpdateAssetProperty .
topic (string) --
The MQTT topic to which IoT SiteWise publishes property value update notifications.
state (string) --
The current notification state.
dataType (string) --
The property data type.
unit (string) --
The unit (such as Newtons or RPM ) of the asset property.
type (dict) --
The property type (see PropertyType ). A property contains one type.
attribute (dict) --
Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an IIoT wind turbine.
defaultValue (string) --
The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see Updating attribute values in the IoT SiteWise User Guide .
measurement (dict) --
Specifies an asset measurement property. A measurement represents a device's raw sensor data stream, such as timestamped temperature values or timestamped power values.
processingConfig (dict) --
The processing configuration for the given measurement property. You can configure measurements to be kept at the edge or forwarded to the Amazon Web Services Cloud. By default, measurements are forwarded to the cloud.
forwardingConfig (dict) --
The forwarding configuration for the given measurement property.
state (string) --
The forwarding state for the given property.
transform (dict) --
Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.
expression (string) --
The mathematical expression that defines the transformation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.
For more information, see Quotas in the IoT SiteWise User Guide .
variables (list) --
The list of variables used in the expression.
(dict) --
Contains expression variable information.
name (string) --
The friendly name of the variable to be used in the expression.
value (dict) --
The variable that identifies an asset property from which to use values.
propertyId (string) --
The ID of the property to use as the variable. You can use the property name if it's from the same asset model.
hierarchyId (string) --
The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID.
You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId . For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide .
processingConfig (dict) --
The processing configuration for the given transform property. You can configure transforms to be kept at the edge or forwarded to the Amazon Web Services Cloud. You can also configure transforms to be computed at the edge or in the cloud.
computeLocation (string) --
The compute location for the given transform property.
forwardingConfig (dict) --
The forwarding configuration for a given property.
state (string) --
The forwarding state for the given property.
metric (dict) --
Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.
expression (string) --
The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.
For more information, see Quotas in the IoT SiteWise User Guide .
variables (list) --
The list of variables used in the expression.
(dict) --
Contains expression variable information.
name (string) --
The friendly name of the variable to be used in the expression.
value (dict) --
The variable that identifies an asset property from which to use values.
propertyId (string) --
The ID of the property to use as the variable. You can use the property name if it's from the same asset model.
hierarchyId (string) --
The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID.
You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId . For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide .
window (dict) --
The window (time interval) over which IoT SiteWise computes the metric's aggregation expression. IoT SiteWise computes one data point per window .
tumbling (dict) --
The tumbling time interval window.
interval (string) --
The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.
IoT SiteWise computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval at the end of each hour, and so on.
When IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. IoT SiteWise places the computed data point at the end of the interval.
offset (string) --
The offset for the tumbling window. The offset parameter accepts the following:
18h for offset and 1d for interval , IoT SiteWise aggregates data in one of the following ways:PT18H for offset and 1d for interval , IoT SiteWise aggregates data in one of the following ways:00:03:00 for offset , 5m for interval , and you create the metric at 2 PM (UTC), you get the first aggregation result at 2:03 PM (UTC). You get the second aggregation result at 2:08 PM (UTC).2021-07-23T18:00-08 for offset and 1d for interval , IoT SiteWise aggregates data in one of the following ways:processingConfig (dict) --
The processing configuration for the given metric property. You can configure metrics to be computed at the edge or in the Amazon Web Services Cloud. By default, metrics are forwarded to the cloud.
computeLocation (string) --
The compute location for the given metric property.
compositeModel (dict) --
The composite asset model that declares this asset property, if this asset property exists in a composite model.
name (string) --
The name of the property.
type (string) --
The type of the composite model that defines this property.
assetProperty (dict) --
Contains asset property information.
id (string) --
The ID of the asset property.
name (string) --
The name of the property.
alias (string) --
The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature ). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide .
notification (dict) --
The asset property's notification topic and state. For more information, see UpdateAssetProperty .
topic (string) --
The MQTT topic to which IoT SiteWise publishes property value update notifications.
state (string) --
The current notification state.
dataType (string) --
The property data type.
unit (string) --
The unit (such as Newtons or RPM ) of the asset property.
type (dict) --
The property type (see PropertyType ). A property contains one type.
attribute (dict) --
Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an IIoT wind turbine.
defaultValue (string) --
The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see Updating attribute values in the IoT SiteWise User Guide .
measurement (dict) --
Specifies an asset measurement property. A measurement represents a device's raw sensor data stream, such as timestamped temperature values or timestamped power values.
processingConfig (dict) --
The processing configuration for the given measurement property. You can configure measurements to be kept at the edge or forwarded to the Amazon Web Services Cloud. By default, measurements are forwarded to the cloud.
forwardingConfig (dict) --
The forwarding configuration for the given measurement property.
state (string) --
The forwarding state for the given property.
transform (dict) --
Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.
expression (string) --
The mathematical expression that defines the transformation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.
For more information, see Quotas in the IoT SiteWise User Guide .
variables (list) --
The list of variables used in the expression.
(dict) --
Contains expression variable information.
name (string) --
The friendly name of the variable to be used in the expression.
value (dict) --
The variable that identifies an asset property from which to use values.
propertyId (string) --
The ID of the property to use as the variable. You can use the property name if it's from the same asset model.
hierarchyId (string) --
The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID.
You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId . For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide .
processingConfig (dict) --
The processing configuration for the given transform property. You can configure transforms to be kept at the edge or forwarded to the Amazon Web Services Cloud. You can also configure transforms to be computed at the edge or in the cloud.
computeLocation (string) --
The compute location for the given transform property.
forwardingConfig (dict) --
The forwarding configuration for a given property.
state (string) --
The forwarding state for the given property.
metric (dict) --
Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.
expression (string) --
The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.
For more information, see Quotas in the IoT SiteWise User Guide .
variables (list) --
The list of variables used in the expression.
(dict) --
Contains expression variable information.
name (string) --
The friendly name of the variable to be used in the expression.
value (dict) --
The variable that identifies an asset property from which to use values.
propertyId (string) --
The ID of the property to use as the variable. You can use the property name if it's from the same asset model.
hierarchyId (string) --
The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID.
You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId . For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide .
window (dict) --
The window (time interval) over which IoT SiteWise computes the metric's aggregation expression. IoT SiteWise computes one data point per window .
tumbling (dict) --
The tumbling time interval window.
interval (string) --
The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.
IoT SiteWise computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval at the end of each hour, and so on.
When IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. IoT SiteWise places the computed data point at the end of the interval.
offset (string) --
The offset for the tumbling window. The offset parameter accepts the following:
18h for offset and 1d for interval , IoT SiteWise aggregates data in one of the following ways:PT18H for offset and 1d for interval , IoT SiteWise aggregates data in one of the following ways:00:03:00 for offset , 5m for interval , and you create the metric at 2 PM (UTC), you get the first aggregation result at 2:03 PM (UTC). You get the second aggregation result at 2:08 PM (UTC).2021-07-23T18:00-08 for offset and 1d for interval , IoT SiteWise aggregates data in one of the following ways:processingConfig (dict) --
The processing configuration for the given metric property. You can configure metrics to be computed at the edge or in the Amazon Web Services Cloud. By default, metrics are forwarded to the cloud.
computeLocation (string) --
The compute location for the given metric property.
id (string) --
The ID of the composite model that contains the property.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptiondescribe_bulk_import_job(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.describe_bulk_import_job(
jobId='string'
)
[REQUIRED]
The ID of the job.
{
'jobId': 'string',
'jobName': 'string',
'jobStatus': 'PENDING'|'CANCELLED'|'RUNNING'|'COMPLETED'|'FAILED'|'COMPLETED_WITH_FAILURES',
'jobRoleArn': 'string',
'files': [
{
'bucket': 'string',
'key': 'string',
'versionId': 'string'
},
],
'errorReportLocation': {
'bucket': 'string',
'prefix': 'string'
},
'jobConfiguration': {
'fileFormat': {
'csv': {
'columnNames': [
'ALIAS'|'ASSET_ID'|'PROPERTY_ID'|'DATA_TYPE'|'TIMESTAMP_SECONDS'|'TIMESTAMP_NANO_OFFSET'|'QUALITY'|'VALUE',
]
}
}
},
'jobCreationDate': datetime(2015, 1, 1),
'jobLastUpdateDate': datetime(2015, 1, 1)
}
Response Structure
The ID of the job.
The unique name that helps identify the job request.
The status of the bulk import job can be one of following values.
PENDING – IoT SiteWise is waiting for the current bulk import job to finish.CANCELLED – The bulk import job has been canceled.RUNNING – IoT SiteWise is processing your request to import your data from Amazon S3.COMPLETED – IoT SiteWise successfully completed your request to import data from Amazon S3.FAILED – IoT SiteWise couldn't process your request to import data from Amazon S3. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.COMPLETED_WITH_FAILURES – IoT SiteWise completed your request to import data from Amazon S3 with errors. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.The ARN of the IAM role that allows IoT SiteWise to read Amazon S3 data.
The files in the specified Amazon S3 bucket that contain your data.
The file in Amazon S3 where your data is saved.
The name of the Amazon S3 bucket from which data is imported.
The key of the Amazon S3 object that contains your data. Each object has a key that is a unique identifier. Each object has exactly one key.
The version ID to identify a specific version of the Amazon S3 object that contains your data.
The Amazon S3 destination where errors associated with the job creation request are saved.
The name of the Amazon S3 bucket to which errors associated with the bulk import job are sent.
Amazon S3 uses the prefix as a folder name to organize data in the bucket. Each Amazon S3 object has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/). For more information, see Organizing objects using prefixes in the Amazon Simple Storage Service User Guide .
Contains the configuration information of a job, such as the file format used to save data in Amazon S3.
The file format of the data in Amazon S3.
The .csv file format.
The column names specified in the .csv file.
The date the job was created, in Unix epoch TIME.
The date the job was last updated, in Unix epoch time.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptiondescribe_dashboard(**kwargs)¶Retrieves information about a dashboard.
See also: AWS API Documentation
Request Syntax
response = client.describe_dashboard(
dashboardId='string'
)
[REQUIRED]
The ID of the dashboard.
{
'dashboardId': 'string',
'dashboardArn': 'string',
'dashboardName': 'string',
'projectId': 'string',
'dashboardDescription': 'string',
'dashboardDefinition': 'string',
'dashboardCreationDate': datetime(2015, 1, 1),
'dashboardLastUpdateDate': datetime(2015, 1, 1)
}
Response Structure
The ID of the dashboard.
The ARN of the dashboard, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}
The name of the dashboard.
The ID of the project that the dashboard is in.
The dashboard's description.
The dashboard's definition JSON literal. For detailed information, see Creating dashboards (CLI) in the IoT SiteWise User Guide .
The date the dashboard was created, in Unix epoch time.
The date the dashboard was last updated, in Unix epoch time.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptiondescribe_default_encryption_configuration()¶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 .
See also: AWS API Documentation
Request Syntax
response = client.describe_default_encryption_configuration()
{
'encryptionType': 'SITEWISE_DEFAULT_ENCRYPTION'|'KMS_BASED_ENCRYPTION',
'kmsKeyArn': 'string',
'configurationStatus': {
'state': 'ACTIVE'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED',
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
'message': 'string'
}
}
}
Response Structure
The type of encryption used for the encryption configuration.
The key ARN of the customer managed key used for KMS encryption if you use KMS_BASED_ENCRYPTION .
The status of the account configuration. This contains the ConfigurationState . If there's an error, it also contains the ErrorDetails .
The current state of the configuration.
Contains associated error information, if any.
The error code.
The error message.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptiondescribe_gateway(**kwargs)¶Retrieves information about a gateway.
See also: AWS API Documentation
Request Syntax
response = client.describe_gateway(
gatewayId='string'
)
[REQUIRED]
The ID of the gateway device.
{
'gatewayId': 'string',
'gatewayName': 'string',
'gatewayArn': 'string',
'gatewayPlatform': {
'greengrass': {
'groupArn': 'string'
},
'greengrassV2': {
'coreDeviceThingName': 'string'
}
},
'gatewayCapabilitySummaries': [
{
'capabilityNamespace': 'string',
'capabilitySyncStatus': 'IN_SYNC'|'OUT_OF_SYNC'|'SYNC_FAILED'|'UNKNOWN'
},
],
'creationDate': datetime(2015, 1, 1),
'lastUpdateDate': datetime(2015, 1, 1)
}
Response Structure
The ID of the gateway device.
The name of the gateway.
The ARN of the gateway, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}
The gateway's platform.
A gateway that runs on IoT Greengrass.
The ARN of the Greengrass group. For more information about how to find a group's ARN, see ListGroups and GetGroup in the IoT Greengrass API Reference .
A gateway that runs on IoT Greengrass V2.
The name of the IoT thing for your IoT Greengrass V2 core device.
A list of gateway capability summaries that each contain a namespace and status. Each gateway capability defines data sources for the gateway. To retrieve a capability configuration's definition, use DescribeGatewayCapabilityConfiguration .
Contains a summary of a gateway capability configuration.
The namespace of the capability configuration. For example, if you configure OPC-UA sources from the IoT SiteWise console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version , where version is a number such as 1 .
The synchronization status of the capability configuration. The sync status can be one of the following:
IN_SYNC – The gateway is running the capability configuration.OUT_OF_SYNC – The gateway hasn't received the capability configuration.SYNC_FAILED – The gateway rejected the capability configuration.The date the gateway was created, in Unix epoch time.
The date the gateway was last updated, in Unix epoch time.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptiondescribe_gateway_capability_configuration(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.describe_gateway_capability_configuration(
gatewayId='string',
capabilityNamespace='string'
)
[REQUIRED]
The ID of the gateway that defines the capability configuration.
[REQUIRED]
The namespace of the capability configuration. For example, if you configure OPC-UA sources from the IoT SiteWise console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version , where version is a number such as 1 .
dict
Response Syntax
{
'gatewayId': 'string',
'capabilityNamespace': 'string',
'capabilityConfiguration': 'string',
'capabilitySyncStatus': 'IN_SYNC'|'OUT_OF_SYNC'|'SYNC_FAILED'|'UNKNOWN'
}
Response Structure
(dict) --
gatewayId (string) --
The ID of the gateway that defines the capability configuration.
capabilityNamespace (string) --
The namespace of the gateway capability.
capabilityConfiguration (string) --
The JSON document that defines the gateway capability's configuration. For more information, see Configuring data sources (CLI) in the IoT SiteWise User Guide .
capabilitySyncStatus (string) --
The synchronization status of the capability configuration. The sync status can be one of the following:
IN_SYNC – The gateway is running the capability configuration.OUT_OF_SYNC – The gateway hasn't received the capability configuration.SYNC_FAILED – The gateway rejected the capability configuration.Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptiondescribe_logging_options()¶Retrieves the current IoT SiteWise logging options.
See also: AWS API Documentation
Request Syntax
response = client.describe_logging_options()
{
'loggingOptions': {
'level': 'ERROR'|'INFO'|'OFF'
}
}
Response Structure
The current logging options.
The IoT SiteWise logging verbosity level.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptiondescribe_portal(**kwargs)¶Retrieves information about a portal.
See also: AWS API Documentation
Request Syntax
response = client.describe_portal(
portalId='string'
)
[REQUIRED]
The ID of the portal.
{
'portalId': 'string',
'portalArn': 'string',
'portalName': 'string',
'portalDescription': 'string',
'portalClientId': 'string',
'portalStartUrl': 'string',
'portalContactEmail': 'string',
'portalStatus': {
'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'FAILED',
'error': {
'code': 'INTERNAL_FAILURE'|'VALIDATION_ERROR'|'LIMIT_EXCEEDED',
'message': 'string'
}
},
'portalCreationDate': datetime(2015, 1, 1),
'portalLastUpdateDate': datetime(2015, 1, 1),
'portalLogoImageLocation': {
'id': 'string',
'url': 'string'
},
'roleArn': 'string',
'portalAuthMode': 'IAM'|'SSO',
'notificationSenderEmail': 'string',
'alarms': {
'alarmRoleArn': 'string',
'notificationLambdaArn': 'string'
}
}
Response Structure
The ID of the portal.
The ARN of the portal, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}
The name of the portal.
The portal's description.
The IAM Identity Center application generated client ID (used with IAM Identity Center APIs). IoT SiteWise includes portalClientId for only portals that use IAM Identity Center to authenticate users.
The URL for the IoT SiteWise Monitor portal. You can use this URL to access portals that use IAM Identity Center for authentication. For portals that use IAM for authentication, you must use the IoT SiteWise console to get a URL that you can use to access the portal.
The Amazon Web Services administrator's contact email address.
The current status of the portal, which contains a state and any error message.
The current state of the portal.
Contains associated error information, if any.
The error code.
The error message.
The date the portal was created, in Unix epoch time.
The date the portal was last updated, in Unix epoch time.
The portal's logo image, which is available at a URL.
The ID of the image.
The URL where the image is available. The URL is valid for 15 minutes so that you can view and download the image
The ARN of the service role that allows the portal's users to access your IoT SiteWise resources on your behalf. For more information, see Using service roles for IoT SiteWise Monitor in the IoT SiteWise User Guide .
The service to use to authenticate users to the portal.
The email address that sends alarm notifications.
Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal.
The ARN of the IAM role that allows the alarm to perform actions and access Amazon Web Services resources and services, such as IoT Events.
The ARN of the Lambda function that manages alarm notifications. For more information, see Managing alarm notifications in the IoT Events Developer Guide .
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptiondescribe_project(**kwargs)¶Retrieves information about a project.
See also: AWS API Documentation
Request Syntax
response = client.describe_project(
projectId='string'
)
[REQUIRED]
The ID of the project.
{
'projectId': 'string',
'projectArn': 'string',
'projectName': 'string',
'portalId': 'string',
'projectDescription': 'string',
'projectCreationDate': datetime(2015, 1, 1),
'projectLastUpdateDate': datetime(2015, 1, 1)
}
Response Structure
The ID of the project.
The ARN of the project, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId}
The name of the project.
The ID of the portal that the project is in.
The project's description.
The date the project was created, in Unix epoch time.
The date the project was last updated, in Unix epoch time.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptiondescribe_storage_configuration()¶Retrieves information about the storage configuration for IoT SiteWise.
See also: AWS API Documentation
Request Syntax
response = client.describe_storage_configuration()
{
'storageType': 'SITEWISE_DEFAULT_STORAGE'|'MULTI_LAYER_STORAGE',
'multiLayerStorage': {
'customerManagedS3Storage': {
's3ResourceArn': 'string',
'roleArn': 'string'
}
},
'disassociatedDataStorage': 'ENABLED'|'DISABLED',
'retentionPeriod': {
'numberOfDays': 123,
'unlimited': True|False
},
'configurationStatus': {
'state': 'ACTIVE'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED',
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
'message': 'string'
}
},
'lastUpdateDate': datetime(2015, 1, 1)
}
Response Structure
The storage tier that you specified for your data. The storageType parameter can be one of the following values:
SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves your data into the hot tier. The hot tier is a service-managed database.MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold tier and the hot tier. The cold tier is a customer-managed Amazon S3 bucket.Contains information about the storage destination.
Contains information about a customer managed Amazon S3 bucket.
The ARN of the Amazon S3 object. For more information about how to find the ARN for an Amazon S3 object, see Amazon S3 resources in the Amazon Simple Storage Service User Guide .
The ARN of the Identity and Access Management role that allows IoT SiteWise to send data to Amazon S3.
Contains the storage configuration for time series (data streams) that aren't associated with asset properties. The disassociatedDataStorage can be one of the following values:
ENABLED – IoT SiteWise accepts time series that aren't associated with asset properties.Warning
After the disassociatedDataStorage is enabled, you can't disable it.
DISABLED – IoT SiteWise doesn't accept time series (data streams) that aren't associated with asset properties.For more information, see Data streams in the IoT SiteWise User Guide .
How many days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.
The number of days that your data is kept.
Note
If you specified a value for this parameter, the unlimited parameter must be false .
If true, your data is kept indefinitely.
Note
If configured to true , you must not specify a value for the numberOfDays parameter.
Contains current status information for the configuration.
The current state of the configuration.
Contains associated error information, if any.
The error code.
The error message.
The date the storage configuration was last updated, in Unix epoch time.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionIoTSiteWise.Client.exceptions.LimitExceededExceptionIoTSiteWise.Client.exceptions.ConflictingOperationExceptiondescribe_time_series(**kwargs)¶Retrieves information about a time series (data stream).
To identify a time series, do one of the following:
alias of the time series.alias of the time series.assetId and propertyId that identifies the asset property.See also: AWS API Documentation
Request Syntax
response = client.describe_time_series(
alias='string',
assetId='string',
propertyId='string'
)
dict
Response Syntax
{
'assetId': 'string',
'propertyId': 'string',
'alias': 'string',
'timeSeriesId': 'string',
'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN'|'STRUCT',
'dataTypeSpec': 'string',
'timeSeriesCreationDate': datetime(2015, 1, 1),
'timeSeriesLastUpdateDate': datetime(2015, 1, 1)
}
Response Structure
(dict) --
assetId (string) --
The ID of the asset in which the asset property was created.
propertyId (string) --
The ID of the asset property.
alias (string) --
The alias that identifies the time series.
timeSeriesId (string) --
The ID of the time series.
dataType (string) --
The data type of the time series.
If you specify STRUCT , you must also specify dataTypeSpec to identify the type of the structure for this time series.
dataTypeSpec (string) --
The data type of the structure for this time series. This parameter is required for time series that have the STRUCT data type.
The options for this parameter depend on the type of the composite model in which you created the asset property that is associated with your time series. Use AWS/ALARM_STATE for alarm state in alarm composite models.
timeSeriesCreationDate (datetime) --
The date that the time series was created, in Unix epoch time.
timeSeriesLastUpdateDate (datetime) --
The date that the time series was last updated, in Unix epoch time.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptiondisassociate_assets(**kwargs)¶Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_assets(
assetId='string',
hierarchyId='string',
childAssetId='string',
clientToken='string'
)
[REQUIRED]
The ID of the parent asset from which to disassociate the child asset.
[REQUIRED]
The ID of a hierarchy in the parent asset's model. Hierarchies allow different groupings of assets to be formed that all come from the same asset model. You can use the hierarchy ID to identify the correct asset to disassociate. For more information, see Asset hierarchies in the IoT SiteWise User Guide .
[REQUIRED]
The ID of the child asset to disassociate.
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
This field is autopopulated if not provided.
None
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionIoTSiteWise.Client.exceptions.ConflictingOperationExceptiondisassociate_time_series_from_asset_property(**kwargs)¶Disassociates a time series (data stream) from an asset property.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_time_series_from_asset_property(
alias='string',
assetId='string',
propertyId='string',
clientToken='string'
)
[REQUIRED]
The alias that identifies the time series.
[REQUIRED]
The ID of the asset in which the asset property was created.
[REQUIRED]
The ID of the asset property.
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
This field is autopopulated if not provided.
None
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionIoTSiteWise.Client.exceptions.ConflictingOperationExceptionget_asset_property_aggregates(**kwargs)¶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:
assetId and propertyId of an asset property.propertyAlias , which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature ). To define an asset property's alias, see UpdateAssetProperty .See also: AWS API Documentation
Request Syntax
response = client.get_asset_property_aggregates(
assetId='string',
propertyId='string',
propertyAlias='string',
aggregateTypes=[
'AVERAGE'|'COUNT'|'MAXIMUM'|'MINIMUM'|'SUM'|'STANDARD_DEVIATION',
],
resolution='string',
qualities=[
'GOOD'|'BAD'|'UNCERTAIN',
],
startDate=datetime(2015, 1, 1),
endDate=datetime(2015, 1, 1),
timeOrdering='ASCENDING'|'DESCENDING',
nextToken='string',
maxResults=123
)
/company/windfarm/3/turbine/7/temperature ). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide .[REQUIRED]
The data aggregating function.
[REQUIRED]
The time interval over which to aggregate data.
The quality by which to filter asset data.
[REQUIRED]
The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.
[REQUIRED]
The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.
The chronological sorting order of the requested information.
Default: ASCENDING
The maximum number of results to return for each paginated request.
Default: 100
dict
Response Syntax
{
'aggregatedValues': [
{
'timestamp': datetime(2015, 1, 1),
'quality': 'GOOD'|'BAD'|'UNCERTAIN',
'value': {
'average': 123.0,
'count': 123.0,
'maximum': 123.0,
'minimum': 123.0,
'sum': 123.0,
'standardDeviation': 123.0
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
aggregatedValues (list) --
The requested aggregated values.
(dict) --
Contains aggregated asset property values (for example, average, minimum, and maximum).
timestamp (datetime) --
The date the aggregating computations occurred, in Unix epoch time.
quality (string) --
The quality of the aggregated data.
value (dict) --
The value of the aggregates.
average (float) --
The average (mean) value of the time series over a time interval window.
count (float) --
The count of data points in the time series over a time interval window.
maximum (float) --
The maximum value of the time series over a time interval window.
minimum (float) --
The minimum value of the time series over a time interval window.
sum (float) --
The sum of the time series over a time interval window.
standardDeviation (float) --
The standard deviation of the time series over a time interval window.
nextToken (string) --
The token for the next set of results, or null if there are no additional results.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionIoTSiteWise.Client.exceptions.ServiceUnavailableExceptionget_asset_property_value(**kwargs)¶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:
assetId and propertyId of an asset property.propertyAlias , which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature ). To define an asset property's alias, see UpdateAssetProperty .See also: AWS API Documentation
Request Syntax
response = client.get_asset_property_value(
assetId='string',
propertyId='string',
propertyAlias='string'
)
/company/windfarm/3/turbine/7/temperature ). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide .dict
Response Syntax
{
'propertyValue': {
'value': {
'stringValue': 'string',
'integerValue': 123,
'doubleValue': 123.0,
'booleanValue': True|False
},
'timestamp': {
'timeInSeconds': 123,
'offsetInNanos': 123
},
'quality': 'GOOD'|'BAD'|'UNCERTAIN'
}
}
Response Structure
(dict) --
propertyValue (dict) --
The current asset property value.
value (dict) --
The value of the asset property (see Variant ).
stringValue (string) --
Asset property data of type string (sequence of characters).
integerValue (integer) --
Asset property data of type integer (whole number).
doubleValue (float) --
Asset property data of type double (floating point number).
booleanValue (boolean) --
Asset property data of type Boolean (true or false).
timestamp (dict) --
The timestamp of the asset property value.
timeInSeconds (integer) --
The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos .
offsetInNanos (integer) --
The nanosecond offset from timeInSeconds .
quality (string) --
The quality of the asset property value.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionIoTSiteWise.Client.exceptions.ServiceUnavailableExceptionget_asset_property_value_history(**kwargs)¶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:
assetId and propertyId of an asset property.propertyAlias , which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature ). To define an asset property's alias, see UpdateAssetProperty .See also: AWS API Documentation
Request Syntax
response = client.get_asset_property_value_history(
assetId='string',
propertyId='string',
propertyAlias='string',
startDate=datetime(2015, 1, 1),
endDate=datetime(2015, 1, 1),
qualities=[
'GOOD'|'BAD'|'UNCERTAIN',
],
timeOrdering='ASCENDING'|'DESCENDING',
nextToken='string',
maxResults=123
)
/company/windfarm/3/turbine/7/temperature ). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide .The quality by which to filter asset data.
The chronological sorting order of the requested information.
Default: ASCENDING
The maximum number of results to return for each paginated request.
Default: 100
dict
Response Syntax
{
'assetPropertyValueHistory': [
{
'value': {
'stringValue': 'string',
'integerValue': 123,
'doubleValue': 123.0,
'booleanValue': True|False
},
'timestamp': {
'timeInSeconds': 123,
'offsetInNanos': 123
},
'quality': 'GOOD'|'BAD'|'UNCERTAIN'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
assetPropertyValueHistory (list) --
The asset property's value history.
(dict) --
Contains asset property value information.
value (dict) --
The value of the asset property (see Variant ).
stringValue (string) --
Asset property data of type string (sequence of characters).
integerValue (integer) --
Asset property data of type integer (whole number).
doubleValue (float) --
Asset property data of type double (floating point number).
booleanValue (boolean) --
Asset property data of type Boolean (true or false).
timestamp (dict) --
The timestamp of the asset property value.
timeInSeconds (integer) --
The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos .
offsetInNanos (integer) --
The nanosecond offset from timeInSeconds .
quality (string) --
The quality of the asset property value.
nextToken (string) --
The token for the next set of results, or null if there are no additional results.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionIoTSiteWise.Client.exceptions.ServiceUnavailableExceptionget_interpolated_asset_property_values(**kwargs)¶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:
assetId and propertyId of an asset property.propertyAlias , which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature ). To define an asset property's alias, see UpdateAssetProperty .See also: AWS API Documentation
Request Syntax
response = client.get_interpolated_asset_property_values(
assetId='string',
propertyId='string',
propertyAlias='string',
startTimeInSeconds=123,
startTimeOffsetInNanos=123,
endTimeInSeconds=123,
endTimeOffsetInNanos=123,
quality='GOOD'|'BAD'|'UNCERTAIN',
intervalInSeconds=123,
nextToken='string',
maxResults=123,
type='string',
intervalWindowInSeconds=123
)
/company/windfarm/3/turbine/7/temperature ). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide .[REQUIRED]
The exclusive start of the range from which to interpolate data, expressed in seconds in Unix epoch time.
startTimeInSeconds .[REQUIRED]
The inclusive end of the range from which to interpolate data, expressed in seconds in Unix epoch time.
endTimeInSeconds .[REQUIRED]
The quality of the asset property value. You can use this parameter as a filter to choose only the asset property values that have a specific quality.
[REQUIRED]
The time interval in seconds over which to interpolate data. Each interval starts when the previous one ends.
[REQUIRED]
The interpolation type.
Valid values: LINEAR_INTERPOLATION | LOCF_INTERPOLATION
LINEAR_INTERPOLATION – Estimates missing data using linear interpolation . 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. If the interpolation starts July 1, 2021, at 9 AM, IoT SiteWise returns the first interpolated value on July 2, 2021, at 9 AM, the second interpolated value on July 3, 2021, at 9 AM, and so on.LOCF_INTERPOLATION – Estimates missing data using last observation carried forward interpolation If no data point is found for an interval, IoT SiteWise returns the last observed data point for the previous interval and carries forward this interpolated value until a new data point is found. For example, you can get the state of an on-off valve every 24 hours over a duration of 7 days. If the interpolation starts July 1, 2021, at 9 AM, IoT SiteWise returns the last observed data point between July 1, 2021, at 9 AM and July 2, 2021, at 9 AM as the first interpolated value. If a data point isn't found after 9 AM on July 2, 2021, IoT SiteWise uses the same interpolated value for the rest of the days.The query interval for the window, in seconds. IoT SiteWise computes each interpolated value by using data points from the timestamp of each interval, minus the window to the timestamp of each interval plus the window. If not specified, the window ranges between the start time minus the interval and the end time plus the interval.
Note
intervalWindowInSeconds parameter, the value for the type parameter must be LINEAR_INTERPOLATION .For example, you can get the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days. If the interpolation starts on July 1, 2021, at 9 AM with a window of 2 hours, IoT SiteWise uses the data points from 7 AM (9 AM minus 2 hours) to 11 AM (9 AM plus 2 hours) on July 2, 2021 to compute the first interpolated value. Next, IoT SiteWise uses the data points from 7 AM (9 AM minus 2 hours) to 11 AM (9 AM plus 2 hours) on July 3, 2021 to compute the second interpolated value, and so on.
dict
Response Syntax
{
'interpolatedAssetPropertyValues': [
{
'timestamp': {
'timeInSeconds': 123,
'offsetInNanos': 123
},
'value': {
'stringValue': 'string',
'integerValue': 123,
'doubleValue': 123.0,
'booleanValue': True|False
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
interpolatedAssetPropertyValues (list) --
The requested interpolated values.
(dict) --
Contains information about an interpolated asset property value.
timestamp (dict) --
Contains a timestamp with optional nanosecond granularity.
timeInSeconds (integer) --
The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos .
offsetInNanos (integer) --
The nanosecond offset from timeInSeconds .
value (dict) --
Contains an asset property value (of a single type only).
stringValue (string) --
Asset property data of type string (sequence of characters).
integerValue (integer) --
Asset property data of type integer (whole number).
doubleValue (float) --
Asset property data of type double (floating point number).
booleanValue (boolean) --
Asset property data of type Boolean (true or false).
nextToken (string) --
The token for the next set of results, or null if there are no additional results.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionIoTSiteWise.Client.exceptions.ServiceUnavailableExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_waiter(waiter_name)¶Returns an object that can wait for some condition.
list_access_policies(**kwargs)¶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).
See also: AWS API Documentation
Request Syntax
response = client.list_access_policies(
identityType='USER'|'GROUP'|'IAM',
identityId='string',
resourceType='PORTAL'|'PROJECT',
resourceId='string',
iamArn='string',
nextToken='string',
maxResults=123
)
identityId .USER or GROUP for identityType .resourceId .resourceType .IAM for identityType .The maximum number of results to return for each paginated request.
Default: 50
dict
Response Syntax
{
'accessPolicySummaries': [
{
'id': 'string',
'identity': {
'user': {
'id': 'string'
},
'group': {
'id': 'string'
},
'iamUser': {
'arn': 'string'
},
'iamRole': {
'arn': 'string'
}
},
'resource': {
'portal': {
'id': 'string'
},
'project': {
'id': 'string'
}
},
'permission': 'ADMINISTRATOR'|'VIEWER',
'creationDate': datetime(2015, 1, 1),
'lastUpdateDate': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
accessPolicySummaries (list) --
A list that summarizes each access policy.
(dict) --
Contains an access policy that defines an identity's access to an IoT SiteWise Monitor resource.
id (string) --
The ID of the access policy.
identity (dict) --
The identity (an IAM Identity Center user, an IAM Identity Center group, or an IAM user).
user (dict) --
An IAM Identity Center user identity.
id (string) --
The IAM Identity Center ID of the user.
group (dict) --
An IAM Identity Center group identity.
id (string) --
The IAM Identity Center ID of the group.
iamUser (dict) --
An IAM user identity.
arn (string) --
The ARN of the IAM user. For more information, see IAM ARNs in the IAM User Guide .
Note
If you delete the IAM user, access policies that contain this identity include an empty arn . You can delete the access policy for the IAM user that no longer exists.
iamRole (dict) --
An IAM role identity.
arn (string) --
The ARN of the IAM role. For more information, see IAM ARNs in the IAM User Guide .
resource (dict) --
The IoT SiteWise Monitor resource (a portal or project).
portal (dict) --
A portal resource.
id (string) --
The ID of the portal.
project (dict) --
A project resource.
id (string) --
The ID of the project.
permission (string) --
The permissions for the access policy. Note that a project ADMINISTRATOR is also known as a project owner.
creationDate (datetime) --
The date the access policy was created, in Unix epoch time.
lastUpdateDate (datetime) --
The date the access policy was last updated, in Unix epoch time.
nextToken (string) --
The token for the next set of results, or null if there are no additional results.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionlist_asset_model_properties(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.list_asset_model_properties(
assetModelId='string',
nextToken='string',
maxResults=123,
filter='ALL'|'BASE'
)
[REQUIRED]
The ID of the asset model.
Filters the requested list of asset model properties. You can choose one of the following options:
ALL – The list includes all asset model properties for a given asset model ID.BASE – The list includes only base asset model properties for a given asset model ID.Default: BASE
dict
Response Syntax
{
'assetModelPropertySummaries': [
{
'id': 'string',
'name': 'string',
'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN'|'STRUCT',
'dataTypeSpec': 'string',
'unit': 'string',
'type': {
'attribute': {
'defaultValue': 'string'
},
'measurement': {
'processingConfig': {
'forwardingConfig': {
'state': 'DISABLED'|'ENABLED'
}
}
},
'transform': {
'expression': 'string',
'variables': [
{
'name': 'string',
'value': {
'propertyId': 'string',
'hierarchyId': 'string'
}
},
],
'processingConfig': {
'computeLocation': 'EDGE'|'CLOUD',
'forwardingConfig': {
'state': 'DISABLED'|'ENABLED'
}
}
},
'metric': {
'expression': 'string',
'variables': [
{
'name': 'string',
'value': {
'propertyId': 'string',
'hierarchyId': 'string'
}
},
],
'window': {
'tumbling': {
'interval': 'string',
'offset': 'string'
}
},
'processingConfig': {
'computeLocation': 'EDGE'|'CLOUD'
}
}
},
'assetModelCompositeModelId': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
assetModelPropertySummaries (list) --
A list that summarizes the properties associated with the specified asset model.
(dict) --
Contains a summary of a property associated with a model.
id (string) --
The ID of the property.
name (string) --
The name of the property.
dataType (string) --
The data type of the property.
dataTypeSpec (string) --
The data type of the structure for this property. This parameter exists on properties that have the STRUCT data type.
unit (string) --
The unit (such as Newtons or RPM ) of the property.
type (dict) --
Contains a property type, which can be one of attribute , measurement , metric , or transform .
attribute (dict) --
Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an IIoT wind turbine.
defaultValue (string) --
The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see Updating attribute values in the IoT SiteWise User Guide .
measurement (dict) --
Specifies an asset measurement property. A measurement represents a device's raw sensor data stream, such as timestamped temperature values or timestamped power values.
processingConfig (dict) --
The processing configuration for the given measurement property. You can configure measurements to be kept at the edge or forwarded to the Amazon Web Services Cloud. By default, measurements are forwarded to the cloud.
forwardingConfig (dict) --
The forwarding configuration for the given measurement property.
state (string) --
The forwarding state for the given property.
transform (dict) --
Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.
expression (string) --
The mathematical expression that defines the transformation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.
For more information, see Quotas in the IoT SiteWise User Guide .
variables (list) --
The list of variables used in the expression.
(dict) --
Contains expression variable information.
name (string) --
The friendly name of the variable to be used in the expression.
value (dict) --
The variable that identifies an asset property from which to use values.
propertyId (string) --
The ID of the property to use as the variable. You can use the property name if it's from the same asset model.
hierarchyId (string) --
The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID.
You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId . For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide .
processingConfig (dict) --
The processing configuration for the given transform property. You can configure transforms to be kept at the edge or forwarded to the Amazon Web Services Cloud. You can also configure transforms to be computed at the edge or in the cloud.
computeLocation (string) --
The compute location for the given transform property.
forwardingConfig (dict) --
The forwarding configuration for a given property.
state (string) --
The forwarding state for the given property.
metric (dict) --
Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.
expression (string) --
The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.
For more information, see Quotas in the IoT SiteWise User Guide .
variables (list) --
The list of variables used in the expression.
(dict) --
Contains expression variable information.
name (string) --
The friendly name of the variable to be used in the expression.
value (dict) --
The variable that identifies an asset property from which to use values.
propertyId (string) --
The ID of the property to use as the variable. You can use the property name if it's from the same asset model.
hierarchyId (string) --
The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID.
You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId . For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide .
window (dict) --
The window (time interval) over which IoT SiteWise computes the metric's aggregation expression. IoT SiteWise computes one data point per window .
tumbling (dict) --
The tumbling time interval window.
interval (string) --
The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.
IoT SiteWise computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval at the end of each hour, and so on.
When IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. IoT SiteWise places the computed data point at the end of the interval.
offset (string) --
The offset for the tumbling window. The offset parameter accepts the following:
18h for offset and 1d for interval , IoT SiteWise aggregates data in one of the following ways:PT18H for offset and 1d for interval , IoT SiteWise aggregates data in one of the following ways:00:03:00 for offset , 5m for interval , and you create the metric at 2 PM (UTC), you get the first aggregation result at 2:03 PM (UTC). You get the second aggregation result at 2:08 PM (UTC).2021-07-23T18:00-08 for offset and 1d for interval , IoT SiteWise aggregates data in one of the following ways:processingConfig (dict) --
The processing configuration for the given metric property. You can configure metrics to be computed at the edge or in the Amazon Web Services Cloud. By default, metrics are forwarded to the cloud.
computeLocation (string) --
The compute location for the given metric property.
assetModelCompositeModelId (string) --
The ID of the composite model that contains the asset model property.
nextToken (string) --
The token for the next set of results, or null if there are no additional results.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionlist_asset_models(**kwargs)¶Retrieves a paginated list of summaries of all asset models.
See also: AWS API Documentation
Request Syntax
response = client.list_asset_models(
nextToken='string',
maxResults=123
)
The maximum number of results to return for each paginated request.
Default: 50
dict
Response Syntax
{
'assetModelSummaries': [
{
'id': 'string',
'arn': 'string',
'name': 'string',
'description': 'string',
'creationDate': datetime(2015, 1, 1),
'lastUpdateDate': datetime(2015, 1, 1),
'status': {
'state': 'CREATING'|'ACTIVE'|'UPDATING'|'PROPAGATING'|'DELETING'|'FAILED',
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
'message': 'string',
'details': [
{
'code': 'INCOMPATIBLE_COMPUTE_LOCATION'|'INCOMPATIBLE_FORWARDING_CONFIGURATION',
'message': 'string'
},
]
}
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
assetModelSummaries (list) --
A list that summarizes each asset model.
(dict) --
Contains a summary of an asset model.
id (string) --
The ID of the asset model (used with IoT SiteWise APIs).
arn (string) --
The ARN of the asset model, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}
name (string) --
The name of the asset model.
description (string) --
The asset model description.
creationDate (datetime) --
The date the asset model was created, in Unix epoch time.
lastUpdateDate (datetime) --
The date the asset model was last updated, in Unix epoch time.
status (dict) --
The current status of the asset model.
state (string) --
The current state of the asset model.
error (dict) --
Contains associated error information, if any.
code (string) --
The error code.
message (string) --
The error message.
details (list) --
A list of detailed errors.
(dict) --
Contains detailed error information.
code (string) --
The error code.
message (string) --
The error message.
nextToken (string) --
The token for the next set of results, or null if there are no additional results.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionlist_asset_properties(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.list_asset_properties(
assetId='string',
nextToken='string',
maxResults=123,
filter='ALL'|'BASE'
)
[REQUIRED]
The ID of the asset.
Filters the requested list of asset properties. You can choose one of the following options:
ALL – The list includes all asset properties for a given asset model ID.BASE – The list includes only base asset properties for a given asset model ID.Default: BASE
dict
Response Syntax
{
'assetPropertySummaries': [
{
'id': 'string',
'alias': 'string',
'unit': 'string',
'notification': {
'topic': 'string',
'state': 'ENABLED'|'DISABLED'
},
'assetCompositeModelId': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
assetPropertySummaries (list) --
A list that summarizes the properties associated with the specified asset.
(dict) --
Contains a summary of a property associated with an asset.
id (string) --
The ID of the property.
alias (string) --
The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature ). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide .
unit (string) --
The unit of measure (such as Newtons or RPM) of the asset property.
notification (dict) --
Contains asset property value notification information. When the notification state is enabled, IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see Interacting with other services in the IoT SiteWise User Guide .
topic (string) --
The MQTT topic to which IoT SiteWise publishes property value update notifications.
state (string) --
The current notification state.
assetCompositeModelId (string) --
The ID of the composite model that contains the asset property.
nextToken (string) --
The token for the next set of results, or null if there are no additional results.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionlist_asset_relationships(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.list_asset_relationships(
assetId='string',
traversalType='PATH_TO_ROOT',
nextToken='string',
maxResults=123
)
[REQUIRED]
The ID of the asset.
[REQUIRED]
The type of traversal to use to identify asset relationships. Choose the following option:
PATH_TO_ROOT – Identify the asset's parent assets up to the root asset. The asset that you specify in assetId is the first result in the list of assetRelationshipSummaries , and the root asset is the last result.dict
Response Syntax
{
'assetRelationshipSummaries': [
{
'hierarchyInfo': {
'parentAssetId': 'string',
'childAssetId': 'string'
},
'relationshipType': 'HIERARCHY'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
assetRelationshipSummaries (list) --
A list that summarizes each asset relationship.
(dict) --
Contains information about assets that are related to one another.
hierarchyInfo (dict) --
The assets that are related through an asset hierarchy.
This object is present if the relationshipType is HIERARCHY .
parentAssetId (string) --
The ID of the parent asset in this asset relationship.
childAssetId (string) --
The ID of the child asset in this asset relationship.
relationshipType (string) --
The relationship type of the assets in this relationship. This value is one of the following:
HIERARCHY – The assets are related through an asset hierarchy. If you specify this relationship type, this asset relationship includes the hierarchyInfo object.nextToken (string) --
The token for the next set of results, or null if there are no additional results.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionlist_assets(**kwargs)¶Retrieves a paginated list of asset summaries.
You can use this operation to do the following:
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.
See also: AWS API Documentation
Request Syntax
response = client.list_assets(
nextToken='string',
maxResults=123,
assetModelId='string',
filter='ALL'|'TOP_LEVEL'
)
The maximum number of results to return for each paginated request.
Default: 50
ALL for filter .The filter for the requested list of assets. Choose one of the following options:
ALL – The list includes all assets for a given asset model ID. The assetModelId parameter is required if you filter by ALL .TOP_LEVEL – The list includes only top-level assets in the asset hierarchy tree.Default: ALL
dict
Response Syntax
{
'assetSummaries': [
{
'id': 'string',
'arn': 'string',
'name': 'string',
'assetModelId': 'string',
'creationDate': datetime(2015, 1, 1),
'lastUpdateDate': datetime(2015, 1, 1),
'status': {
'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED',
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
'message': 'string',
'details': [
{
'code': 'INCOMPATIBLE_COMPUTE_LOCATION'|'INCOMPATIBLE_FORWARDING_CONFIGURATION',
'message': 'string'
},
]
}
},
'hierarchies': [
{
'id': 'string',
'name': 'string'
},
],
'description': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
assetSummaries (list) --
A list that summarizes each asset.
(dict) --
Contains a summary of an asset.
id (string) --
The ID of the asset.
arn (string) --
The ARN of the asset, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}
name (string) --
The name of the asset.
assetModelId (string) --
The ID of the asset model used to create this asset.
creationDate (datetime) --
The date the asset was created, in Unix epoch time.
lastUpdateDate (datetime) --
The date the asset was last updated, in Unix epoch time.
status (dict) --
The current status of the asset.
state (string) --
The current status of the asset.
error (dict) --
Contains associated error information, if any.
code (string) --
The error code.
message (string) --
The error message.
details (list) --
A list of detailed errors.
(dict) --
Contains detailed error information.
code (string) --
The error code.
message (string) --
The error message.
hierarchies (list) --
A list of asset hierarchies that each contain a hierarchyId . A hierarchy specifies allowed parent/child asset relationships.
(dict) --
Describes an asset hierarchy that contains a hierarchy's name and ID.
id (string) --
The ID of the hierarchy. This ID is a hierarchyId .
name (string) --
The hierarchy name provided in the CreateAssetModel or UpdateAssetModel API operation.
description (string) --
A description for the asset.
nextToken (string) --
The token for the next set of results, or null if there are no additional results.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionlist_associated_assets(**kwargs)¶Retrieves a paginated list of associated assets.
You can use this operation to do the following:
See also: AWS API Documentation
Request Syntax
response = client.list_associated_assets(
assetId='string',
hierarchyId='string',
traversalDirection='PARENT'|'CHILD',
nextToken='string',
maxResults=123
)
[REQUIRED]
The ID of the asset to query.
The ID of the hierarchy by which child assets are associated to the asset. To find a hierarchy ID, use the DescribeAsset or DescribeAssetModel operations. This parameter is required if you choose CHILD for traversalDirection .
For more information, see Asset hierarchies in the IoT SiteWise User Guide .
The direction to list associated assets. Choose one of the following options:
CHILD – The list includes all child assets associated to the asset. The hierarchyId parameter is required if you choose CHILD .PARENT – The list includes the asset's parent asset.Default: CHILD
The maximum number of results to return for each paginated request.
Default: 50
dict
Response Syntax
{
'assetSummaries': [
{
'id': 'string',
'arn': 'string',
'name': 'string',
'assetModelId': 'string',
'creationDate': datetime(2015, 1, 1),
'lastUpdateDate': datetime(2015, 1, 1),
'status': {
'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED',
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
'message': 'string',
'details': [
{
'code': 'INCOMPATIBLE_COMPUTE_LOCATION'|'INCOMPATIBLE_FORWARDING_CONFIGURATION',
'message': 'string'
},
]
}
},
'hierarchies': [
{
'id': 'string',
'name': 'string'
},
],
'description': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
assetSummaries (list) --
A list that summarizes the associated assets.
(dict) --
Contains a summary of an associated asset.
id (string) --
The ID of the asset.
arn (string) --
The ARN of the asset, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}
name (string) --
The name of the asset.
assetModelId (string) --
The ID of the asset model used to create the asset.
creationDate (datetime) --
The date the asset was created, in Unix epoch time.
lastUpdateDate (datetime) --
The date the asset was last updated, in Unix epoch time.
status (dict) --
The current status of the asset.
state (string) --
The current status of the asset.
error (dict) --
Contains associated error information, if any.
code (string) --
The error code.
message (string) --
The error message.
details (list) --
A list of detailed errors.
(dict) --
Contains detailed error information.
code (string) --
The error code.
message (string) --
The error message.
hierarchies (list) --
A list of asset hierarchies that each contain a hierarchyId . A hierarchy specifies allowed parent/child asset relationships.
(dict) --
Describes an asset hierarchy that contains a hierarchy's name and ID.
id (string) --
The ID of the hierarchy. This ID is a hierarchyId .
name (string) --
The hierarchy name provided in the CreateAssetModel or UpdateAssetModel API operation.
description (string) --
A description for the asset.
nextToken (string) --
The token for the next set of results, or null if there are no additional results.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionlist_bulk_import_jobs(**kwargs)¶Retrieves a paginated list of bulk import job requests. For more information, see List bulk import jobs (CLI) in the IoT SiteWise User Guide .
See also: AWS API Documentation
Request Syntax
response = client.list_bulk_import_jobs(
nextToken='string',
maxResults=123,
filter='ALL'|'PENDING'|'RUNNING'|'CANCELLED'|'FAILED'|'COMPLETED_WITH_FAILURES'|'COMPLETED'
)
dict
Response Syntax
{
'jobSummaries': [
{
'id': 'string',
'name': 'string',
'status': 'PENDING'|'CANCELLED'|'RUNNING'|'COMPLETED'|'FAILED'|'COMPLETED_WITH_FAILURES'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
jobSummaries (list) --
One or more job summaries to list.
(dict) --
Contains a job summary information.
id (string) --
The ID of the job.
name (string) --
The unique name that helps identify the job request.
status (string) --
The status of the bulk import job can be one of following values.
PENDING – IoT SiteWise is waiting for the current bulk import job to finish.CANCELLED – The bulk import job has been canceled.RUNNING – IoT SiteWise is processing your request to import your data from Amazon S3.COMPLETED – IoT SiteWise successfully completed your request to import data from Amazon S3.FAILED – IoT SiteWise couldn't process your request to import data from Amazon S3. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.COMPLETED_WITH_FAILURES – IoT SiteWise completed your request to import data from Amazon S3 with errors. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.nextToken (string) --
The token for the next set of results, or null if there are no additional results.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionlist_dashboards(**kwargs)¶Retrieves a paginated list of dashboards for an IoT SiteWise Monitor project.
See also: AWS API Documentation
Request Syntax
response = client.list_dashboards(
projectId='string',
nextToken='string',
maxResults=123
)
[REQUIRED]
The ID of the project.
The maximum number of results to return for each paginated request.
Default: 50
dict
Response Syntax
{
'dashboardSummaries': [
{
'id': 'string',
'name': 'string',
'description': 'string',
'creationDate': datetime(2015, 1, 1),
'lastUpdateDate': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
dashboardSummaries (list) --
A list that summarizes each dashboard in the project.
(dict) --
Contains a dashboard summary.
id (string) --
The ID of the dashboard.
name (string) --
The name of the dashboard
description (string) --
The dashboard's description.
creationDate (datetime) --
The date the dashboard was created, in Unix epoch time.
lastUpdateDate (datetime) --
The date the dashboard was last updated, in Unix epoch time.
nextToken (string) --
The token for the next set of results, or null if there are no additional results.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionlist_gateways(**kwargs)¶Retrieves a paginated list of gateways.
See also: AWS API Documentation
Request Syntax
response = client.list_gateways(
nextToken='string',
maxResults=123
)
The maximum number of results to return for each paginated request.
Default: 50
dict
Response Syntax
{
'gatewaySummaries': [
{
'gatewayId': 'string',
'gatewayName': 'string',
'gatewayPlatform': {
'greengrass': {
'groupArn': 'string'
},
'greengrassV2': {
'coreDeviceThingName': 'string'
}
},
'gatewayCapabilitySummaries': [
{
'capabilityNamespace': 'string',
'capabilitySyncStatus': 'IN_SYNC'|'OUT_OF_SYNC'|'SYNC_FAILED'|'UNKNOWN'
},
],
'creationDate': datetime(2015, 1, 1),
'lastUpdateDate': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
gatewaySummaries (list) --
A list that summarizes each gateway.
(dict) --
Contains a summary of a gateway.
gatewayId (string) --
The ID of the gateway device.
gatewayName (string) --
The name of the asset.
gatewayPlatform (dict) --
Contains a gateway's platform information.
greengrass (dict) --
A gateway that runs on IoT Greengrass.
groupArn (string) --
The ARN of the Greengrass group. For more information about how to find a group's ARN, see ListGroups and GetGroup in the IoT Greengrass API Reference .
greengrassV2 (dict) --
A gateway that runs on IoT Greengrass V2.
coreDeviceThingName (string) --
The name of the IoT thing for your IoT Greengrass V2 core device.
gatewayCapabilitySummaries (list) --
A list of gateway capability summaries that each contain a namespace and status. Each gateway capability defines data sources for the gateway. To retrieve a capability configuration's definition, use DescribeGatewayCapabilityConfiguration .
(dict) --
Contains a summary of a gateway capability configuration.
capabilityNamespace (string) --
The namespace of the capability configuration. For example, if you configure OPC-UA sources from the IoT SiteWise console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version , where version is a number such as 1 .
capabilitySyncStatus (string) --
The synchronization status of the capability configuration. The sync status can be one of the following:
IN_SYNC – The gateway is running the capability configuration.OUT_OF_SYNC – The gateway hasn't received the capability configuration.SYNC_FAILED – The gateway rejected the capability configuration.creationDate (datetime) --
The date the gateway was created, in Unix epoch time.
lastUpdateDate (datetime) --
The date the gateway was last updated, in Unix epoch time.
nextToken (string) --
The token for the next set of results, or null if there are no additional results.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionlist_portals(**kwargs)¶Retrieves a paginated list of IoT SiteWise Monitor portals.
See also: AWS API Documentation
Request Syntax
response = client.list_portals(
nextToken='string',
maxResults=123
)
The maximum number of results to return for each paginated request.
Default: 50
dict
Response Syntax
{
'portalSummaries': [
{
'id': 'string',
'name': 'string',
'description': 'string',
'startUrl': 'string',
'creationDate': datetime(2015, 1, 1),
'lastUpdateDate': datetime(2015, 1, 1),
'roleArn': 'string',
'status': {
'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'FAILED',
'error': {
'code': 'INTERNAL_FAILURE'|'VALIDATION_ERROR'|'LIMIT_EXCEEDED',
'message': 'string'
}
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
portalSummaries (list) --
A list that summarizes each portal.
(dict) --
Contains a portal summary.
id (string) --
The ID of the portal.
name (string) --
The name of the portal.
description (string) --
The portal's description.
startUrl (string) --
The URL for the IoT SiteWise Monitor portal. You can use this URL to access portals that use IAM Identity Center for authentication. For portals that use IAM for authentication, you must use the IoT SiteWise console to get a URL that you can use to access the portal.
creationDate (datetime) --
The date the portal was created, in Unix epoch time.
lastUpdateDate (datetime) --
The date the portal was last updated, in Unix epoch time.
roleArn (string) --
The ARN of the service role that allows the portal's users to access your IoT SiteWise resources on your behalf. For more information, see Using service roles for IoT SiteWise Monitor in the IoT SiteWise User Guide .
status (dict) --
Contains information about the current status of a portal.
state (string) --
The current state of the portal.
error (dict) --
Contains associated error information, if any.
code (string) --
The error code.
message (string) --
The error message.
nextToken (string) --
The token for the next set of results, or null if there are no additional results.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionlist_project_assets(**kwargs)¶Retrieves a paginated list of assets associated with an IoT SiteWise Monitor project.
See also: AWS API Documentation
Request Syntax
response = client.list_project_assets(
projectId='string',
nextToken='string',
maxResults=123
)
[REQUIRED]
The ID of the project.
The maximum number of results to return for each paginated request.
Default: 50
dict
Response Syntax
{
'assetIds': [
'string',
],
'nextToken': 'string'
}
Response Structure
(dict) --
assetIds (list) --
A list that contains the IDs of each asset associated with the project.
nextToken (string) --
The token for the next set of results, or null if there are no additional results.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionlist_projects(**kwargs)¶Retrieves a paginated list of projects for an IoT SiteWise Monitor portal.
See also: AWS API Documentation
Request Syntax
response = client.list_projects(
portalId='string',
nextToken='string',
maxResults=123
)
[REQUIRED]
The ID of the portal.
The maximum number of results to return for each paginated request.
Default: 50
dict
Response Syntax
{
'projectSummaries': [
{
'id': 'string',
'name': 'string',
'description': 'string',
'creationDate': datetime(2015, 1, 1),
'lastUpdateDate': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
projectSummaries (list) --
A list that summarizes each project in the portal.
(dict) --
Contains project summary information.
id (string) --
The ID of the project.
name (string) --
The name of the project.
description (string) --
The project's description.
creationDate (datetime) --
The date the project was created, in Unix epoch time.
lastUpdateDate (datetime) --
The date the project was last updated, in Unix epoch time.
nextToken (string) --
The token for the next set of results, or null if there are no additional results.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionRetrieves the list of tags for an IoT SiteWise resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
resourceArn='string'
)
[REQUIRED]
The ARN of the resource.
{
'tags': {
'string': 'string'
}
}
Response Structure
The list of key-value pairs that contain metadata for the resource. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide .
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.ConflictingOperationExceptionIoTSiteWise.Client.exceptions.LimitExceededExceptionIoTSiteWise.Client.exceptions.UnauthorizedExceptionlist_time_series(**kwargs)¶Retrieves a paginated list of time series (data streams).
See also: AWS API Documentation
Request Syntax
response = client.list_time_series(
nextToken='string',
maxResults=123,
assetId='string',
aliasPrefix='string',
timeSeriesType='ASSOCIATED'|'DISASSOCIATED'
)
The type of the time series. The time series type can be one of the following values:
ASSOCIATED – The time series is associated with an asset property.DISASSOCIATED – The time series isn't associated with any asset property.dict
Response Syntax
{
'TimeSeriesSummaries': [
{
'assetId': 'string',
'propertyId': 'string',
'alias': 'string',
'timeSeriesId': 'string',
'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN'|'STRUCT',
'dataTypeSpec': 'string',
'timeSeriesCreationDate': datetime(2015, 1, 1),
'timeSeriesLastUpdateDate': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
TimeSeriesSummaries (list) --
One or more time series summaries to list.
(dict) --
Contains a summary of a time series (data stream).
assetId (string) --
The ID of the asset in which the asset property was created.
propertyId (string) --
The ID of the asset property.
alias (string) --
The alias that identifies the time series.
timeSeriesId (string) --
The ID of the time series.
dataType (string) --
The data type of the time series.
If you specify STRUCT , you must also specify dataTypeSpec to identify the type of the structure for this time series.
dataTypeSpec (string) --
The data type of the structure for this time series. This parameter is required for time series that have the STRUCT data type.
The options for this parameter depend on the type of the composite model in which you created the asset property that is associated with your time series. Use AWS/ALARM_STATE for alarm state in alarm composite models.
timeSeriesCreationDate (datetime) --
The date that the time series was created, in Unix epoch time.
timeSeriesLastUpdateDate (datetime) --
The date that the time series was last updated, in Unix epoch time.
nextToken (string) --
The token for the next set of results, or null if there are no additional results.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionput_default_encryption_configuration(**kwargs)¶Sets the default encryption configuration for the Amazon Web Services account. For more information, see Key management in the IoT SiteWise User Guide .
See also: AWS API Documentation
Request Syntax
response = client.put_default_encryption_configuration(
encryptionType='SITEWISE_DEFAULT_ENCRYPTION'|'KMS_BASED_ENCRYPTION',
kmsKeyId='string'
)
[REQUIRED]
The type of encryption used for the encryption configuration.
KMS_BASED_ENCRYPTION .dict
Response Syntax
{
'encryptionType': 'SITEWISE_DEFAULT_ENCRYPTION'|'KMS_BASED_ENCRYPTION',
'kmsKeyArn': 'string',
'configurationStatus': {
'state': 'ACTIVE'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED',
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
'message': 'string'
}
}
}
Response Structure
(dict) --
encryptionType (string) --
The type of encryption used for the encryption configuration.
kmsKeyArn (string) --
The Key ARN of the KMS key used for KMS encryption if you use KMS_BASED_ENCRYPTION .
configurationStatus (dict) --
The status of the account configuration. This contains the ConfigurationState . If there is an error, it also contains the ErrorDetails .
state (string) --
The current state of the configuration.
error (dict) --
Contains associated error information, if any.
code (string) --
The error code.
message (string) --
The error message.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionIoTSiteWise.Client.exceptions.LimitExceededExceptionIoTSiteWise.Client.exceptions.ConflictingOperationExceptionput_logging_options(**kwargs)¶Sets logging options for IoT SiteWise.
See also: AWS API Documentation
Request Syntax
response = client.put_logging_options(
loggingOptions={
'level': 'ERROR'|'INFO'|'OFF'
}
)
[REQUIRED]
The logging options to set.
The IoT SiteWise logging verbosity level.
{}
Response Structure
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ConflictingOperationExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionput_storage_configuration(**kwargs)¶Configures storage settings for IoT SiteWise.
See also: AWS API Documentation
Request Syntax
response = client.put_storage_configuration(
storageType='SITEWISE_DEFAULT_STORAGE'|'MULTI_LAYER_STORAGE',
multiLayerStorage={
'customerManagedS3Storage': {
's3ResourceArn': 'string',
'roleArn': 'string'
}
},
disassociatedDataStorage='ENABLED'|'DISABLED',
retentionPeriod={
'numberOfDays': 123,
'unlimited': True|False
}
)
[REQUIRED]
The storage tier that you specified for your data. The storageType parameter can be one of the following values:
SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves your data into the hot tier. The hot tier is a service-managed database.MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold tier and the hot tier. The cold tier is a customer-managed Amazon S3 bucket.Identifies a storage destination. If you specified MULTI_LAYER_STORAGE for the storage type, you must specify a MultiLayerStorage object.
Contains information about a customer managed Amazon S3 bucket.
The ARN of the Amazon S3 object. For more information about how to find the ARN for an Amazon S3 object, see Amazon S3 resources in the Amazon Simple Storage Service User Guide .
The ARN of the Identity and Access Management role that allows IoT SiteWise to send data to Amazon S3.
Contains the storage configuration for time series (data streams) that aren't associated with asset properties. The disassociatedDataStorage can be one of the following values:
ENABLED – IoT SiteWise accepts time series that aren't associated with asset properties.Warning
After the disassociatedDataStorage is enabled, you can't disable it.
DISABLED – IoT SiteWise doesn't accept time series (data streams) that aren't associated with asset properties.For more information, see Data streams in the IoT SiteWise User Guide .
How many days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.
The number of days that your data is kept.
Note
If you specified a value for this parameter, the unlimited parameter must be false .
If true, your data is kept indefinitely.
Note
If configured to true , you must not specify a value for the numberOfDays parameter.
dict
Response Syntax
{
'storageType': 'SITEWISE_DEFAULT_STORAGE'|'MULTI_LAYER_STORAGE',
'multiLayerStorage': {
'customerManagedS3Storage': {
's3ResourceArn': 'string',
'roleArn': 'string'
}
},
'disassociatedDataStorage': 'ENABLED'|'DISABLED',
'retentionPeriod': {
'numberOfDays': 123,
'unlimited': True|False
},
'configurationStatus': {
'state': 'ACTIVE'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED',
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
'message': 'string'
}
}
}
Response Structure
(dict) --
storageType (string) --
The storage tier that you specified for your data. The storageType parameter can be one of the following values:
SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves your data into the hot tier. The hot tier is a service-managed database.MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold tier and the hot tier. The cold tier is a customer-managed Amazon S3 bucket.multiLayerStorage (dict) --
Contains information about the storage destination.
customerManagedS3Storage (dict) --
Contains information about a customer managed Amazon S3 bucket.
s3ResourceArn (string) --
The ARN of the Amazon S3 object. For more information about how to find the ARN for an Amazon S3 object, see Amazon S3 resources in the Amazon Simple Storage Service User Guide .
roleArn (string) --
The ARN of the Identity and Access Management role that allows IoT SiteWise to send data to Amazon S3.
disassociatedDataStorage (string) --
Contains the storage configuration for time series (data streams) that aren't associated with asset properties. The disassociatedDataStorage can be one of the following values:
ENABLED – IoT SiteWise accepts time series that aren't associated with asset properties.Warning
After the disassociatedDataStorage is enabled, you can't disable it.
DISABLED – IoT SiteWise doesn't accept time series (data streams) that aren't associated with asset properties.For more information, see Data streams in the IoT SiteWise User Guide .
retentionPeriod (dict) --
How many days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.
numberOfDays (integer) --
The number of days that your data is kept.
Note
If you specified a value for this parameter, the unlimited parameter must be false .
unlimited (boolean) --
If true, your data is kept indefinitely.
Note
If configured to true , you must not specify a value for the numberOfDays parameter.
configurationStatus (dict) --
Contains current status information for the configuration.
state (string) --
The current state of the configuration.
error (dict) --
Contains associated error information, if any.
code (string) --
The error code.
message (string) --
The error message.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceAlreadyExistsExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionIoTSiteWise.Client.exceptions.LimitExceededExceptionIoTSiteWise.Client.exceptions.ConflictingOperationExceptiontag_resource(**kwargs)¶Adds tags to an IoT SiteWise resource. If a tag already exists for the resource, this operation updates the tag's value.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
resourceArn='string',
tags={
'string': 'string'
}
)
[REQUIRED]
The ARN of the resource to tag.
[REQUIRED]
A list of key-value pairs that contain metadata for the resource. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide .
dict
Response Syntax
{}
Response Structure
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.ConflictingOperationExceptionIoTSiteWise.Client.exceptions.LimitExceededExceptionIoTSiteWise.Client.exceptions.UnauthorizedExceptionIoTSiteWise.Client.exceptions.TooManyTagsExceptionuntag_resource(**kwargs)¶Removes a tag from an IoT SiteWise resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
[REQUIRED]
The ARN of the resource to untag.
[REQUIRED]
A list of keys for tags to remove from the resource.
dict
Response Syntax
{}
Response Structure
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.ConflictingOperationExceptionIoTSiteWise.Client.exceptions.LimitExceededExceptionIoTSiteWise.Client.exceptions.UnauthorizedExceptionupdate_access_policy(**kwargs)¶Updates an existing access policy that specifies an identity's access to an IoT SiteWise Monitor portal or project resource.
See also: AWS API Documentation
Request Syntax
response = client.update_access_policy(
accessPolicyId='string',
accessPolicyIdentity={
'user': {
'id': 'string'
},
'group': {
'id': 'string'
},
'iamUser': {
'arn': 'string'
},
'iamRole': {
'arn': 'string'
}
},
accessPolicyResource={
'portal': {
'id': 'string'
},
'project': {
'id': 'string'
}
},
accessPolicyPermission='ADMINISTRATOR'|'VIEWER',
clientToken='string'
)
[REQUIRED]
The ID of the access policy.
[REQUIRED]
The identity for this access policy. Choose an IAM Identity Center user, an IAM Identity Center group, or an IAM user.
An IAM Identity Center user identity.
The IAM Identity Center ID of the user.
An IAM Identity Center group identity.
The IAM Identity Center ID of the group.
An IAM user identity.
The ARN of the IAM user. For more information, see IAM ARNs in the IAM User Guide .
Note
If you delete the IAM user, access policies that contain this identity include an empty arn . You can delete the access policy for the IAM user that no longer exists.
An IAM role identity.
The ARN of the IAM role. For more information, see IAM ARNs in the IAM User Guide .
[REQUIRED]
The IoT SiteWise Monitor resource for this access policy. Choose either a portal or a project.
A portal resource.
The ID of the portal.
A project resource.
The ID of the project.
[REQUIRED]
The permission level for this access policy. Note that a project ADMINISTRATOR is also known as a project owner.
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
This field is autopopulated if not provided.
dict
Response Syntax
{}
Response Structure
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionupdate_asset(**kwargs)¶Updates an asset's name. For more information, see Updating assets and models in the IoT SiteWise User Guide .
See also: AWS API Documentation
Request Syntax
response = client.update_asset(
assetId='string',
assetName='string',
clientToken='string',
assetDescription='string'
)
[REQUIRED]
The ID of the asset to update.
[REQUIRED]
A friendly name for the asset.
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
This field is autopopulated if not provided.
dict
Response Syntax
{
'assetStatus': {
'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED',
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
'message': 'string',
'details': [
{
'code': 'INCOMPATIBLE_COMPUTE_LOCATION'|'INCOMPATIBLE_FORWARDING_CONFIGURATION',
'message': 'string'
},
]
}
}
}
Response Structure
(dict) --
assetStatus (dict) --
The status of the asset, which contains a state (UPDATING after successfully calling this operation) and any error message.
state (string) --
The current status of the asset.
error (dict) --
Contains associated error information, if any.
code (string) --
The error code.
message (string) --
The error message.
details (list) --
A list of detailed errors.
(dict) --
Contains detailed error information.
code (string) --
The error code.
message (string) --
The error message.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceAlreadyExistsExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionIoTSiteWise.Client.exceptions.ConflictingOperationExceptionupdate_asset_model(**kwargs)¶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 .
Warning
This operation overwrites the existing model with the provided model. To avoid deleting your asset model's properties or hierarchies, you must include their IDs and definitions in the updated asset model payload. For more information, see DescribeAssetModel .
If you remove a property from an asset model, IoT SiteWise deletes all previous data for that property. If you remove a hierarchy definition from an asset model, IoT SiteWise disassociates every asset associated with that hierarchy. You can't change the type or data type of an existing property.
See also: AWS API Documentation
Request Syntax
response = client.update_asset_model(
assetModelId='string',
assetModelName='string',
assetModelDescription='string',
assetModelProperties=[
{
'id': 'string',
'name': 'string',
'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN'|'STRUCT',
'dataTypeSpec': 'string',
'unit': 'string',
'type': {
'attribute': {
'defaultValue': 'string'
},
'measurement': {
'processingConfig': {
'forwardingConfig': {
'state': 'DISABLED'|'ENABLED'
}
}
},
'transform': {
'expression': 'string',
'variables': [
{
'name': 'string',
'value': {
'propertyId': 'string',
'hierarchyId': 'string'
}
},
],
'processingConfig': {
'computeLocation': 'EDGE'|'CLOUD',
'forwardingConfig': {
'state': 'DISABLED'|'ENABLED'
}
}
},
'metric': {
'expression': 'string',
'variables': [
{
'name': 'string',
'value': {
'propertyId': 'string',
'hierarchyId': 'string'
}
},
],
'window': {
'tumbling': {
'interval': 'string',
'offset': 'string'
}
},
'processingConfig': {
'computeLocation': 'EDGE'|'CLOUD'
}
}
}
},
],
assetModelHierarchies=[
{
'id': 'string',
'name': 'string',
'childAssetModelId': 'string'
},
],
assetModelCompositeModels=[
{
'name': 'string',
'description': 'string',
'type': 'string',
'properties': [
{
'id': 'string',
'name': 'string',
'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN'|'STRUCT',
'dataTypeSpec': 'string',
'unit': 'string',
'type': {
'attribute': {
'defaultValue': 'string'
},
'measurement': {
'processingConfig': {
'forwardingConfig': {
'state': 'DISABLED'|'ENABLED'
}
}
},
'transform': {
'expression': 'string',
'variables': [
{
'name': 'string',
'value': {
'propertyId': 'string',
'hierarchyId': 'string'
}
},
],
'processingConfig': {
'computeLocation': 'EDGE'|'CLOUD',
'forwardingConfig': {
'state': 'DISABLED'|'ENABLED'
}
}
},
'metric': {
'expression': 'string',
'variables': [
{
'name': 'string',
'value': {
'propertyId': 'string',
'hierarchyId': 'string'
}
},
],
'window': {
'tumbling': {
'interval': 'string',
'offset': 'string'
}
},
'processingConfig': {
'computeLocation': 'EDGE'|'CLOUD'
}
}
}
},
],
'id': 'string'
},
],
clientToken='string'
)
[REQUIRED]
The ID of the asset model to update.
[REQUIRED]
A unique, friendly name for the asset model.
The updated property definitions of the asset model. For more information, see Asset properties in the IoT SiteWise User Guide .
You can specify up to 200 properties per asset model. For more information, see Quotas in the IoT SiteWise User Guide .
Contains information about an asset model property.
The ID of the asset model property.
The name of the asset model property.
The data type of the asset model property.
The data type of the structure for this property. This parameter exists on properties that have the STRUCT data type.
The unit of the asset model property, such as Newtons or RPM .
The property type (see PropertyType ).
Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an IIoT wind turbine.
The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see Updating attribute values in the IoT SiteWise User Guide .
Specifies an asset measurement property. A measurement represents a device's raw sensor data stream, such as timestamped temperature values or timestamped power values.
The processing configuration for the given measurement property. You can configure measurements to be kept at the edge or forwarded to the Amazon Web Services Cloud. By default, measurements are forwarded to the cloud.
The forwarding configuration for the given measurement property.
The forwarding state for the given property.
Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.
The mathematical expression that defines the transformation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.
For more information, see Quotas in the IoT SiteWise User Guide .
The list of variables used in the expression.
Contains expression variable information.
The friendly name of the variable to be used in the expression.
The variable that identifies an asset property from which to use values.
The ID of the property to use as the variable. You can use the property name if it's from the same asset model.
The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID.
You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId . For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide .
The processing configuration for the given transform property. You can configure transforms to be kept at the edge or forwarded to the Amazon Web Services Cloud. You can also configure transforms to be computed at the edge or in the cloud.
The compute location for the given transform property.
The forwarding configuration for a given property.
The forwarding state for the given property.
Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.
The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.
For more information, see Quotas in the IoT SiteWise User Guide .
The list of variables used in the expression.
Contains expression variable information.
The friendly name of the variable to be used in the expression.
The variable that identifies an asset property from which to use values.
The ID of the property to use as the variable. You can use the property name if it's from the same asset model.
The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID.
You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId . For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide .
The window (time interval) over which IoT SiteWise computes the metric's aggregation expression. IoT SiteWise computes one data point per window .
The tumbling time interval window.
The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.
IoT SiteWise computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval at the end of each hour, and so on.
When IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. IoT SiteWise places the computed data point at the end of the interval.
The offset for the tumbling window. The offset parameter accepts the following:
18h for offset and 1d for interval , IoT SiteWise aggregates data in one of the following ways:PT18H for offset and 1d for interval , IoT SiteWise aggregates data in one of the following ways:00:03:00 for offset , 5m for interval , and you create the metric at 2 PM (UTC), you get the first aggregation result at 2:03 PM (UTC). You get the second aggregation result at 2:08 PM (UTC).2021-07-23T18:00-08 for offset and 1d for interval , IoT SiteWise aggregates data in one of the following ways:The processing configuration for the given metric property. You can configure metrics to be computed at the edge or in the Amazon Web Services Cloud. By default, metrics are forwarded to the cloud.
The compute location for the given metric property.
The updated hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide .
You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the IoT SiteWise User Guide .
Describes an asset hierarchy that contains a hierarchy's name, ID, and child asset model ID that specifies the type of asset that can be in this hierarchy.
The ID of the asset model hierarchy. This ID is a hierarchyId .
The name of the asset model hierarchy that you specify by using the CreateAssetModel or UpdateAssetModel API operation.
The ID of the asset model. All assets in this hierarchy must be instances of the childAssetModelId asset model.
The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties. Each composite model has a type that defines the properties that the composite model supports. Use composite asset models to define alarms on this asset model.
Contains information about a composite model in an asset model. This object contains the asset property definitions that you define in the composite model.
The name of the composite model.
The description of the composite model.
The type of the composite model. For alarm composite models, this type is AWS/ALARM .
The asset property definitions for this composite model.
Contains information about an asset model property.
The ID of the asset model property.
The name of the asset model property.
The data type of the asset model property.
The data type of the structure for this property. This parameter exists on properties that have the STRUCT data type.
The unit of the asset model property, such as Newtons or RPM .
The property type (see PropertyType ).
Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an IIoT wind turbine.
The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see Updating attribute values in the IoT SiteWise User Guide .
Specifies an asset measurement property. A measurement represents a device's raw sensor data stream, such as timestamped temperature values or timestamped power values.
The processing configuration for the given measurement property. You can configure measurements to be kept at the edge or forwarded to the Amazon Web Services Cloud. By default, measurements are forwarded to the cloud.
The forwarding configuration for the given measurement property.
The forwarding state for the given property.
Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.
The mathematical expression that defines the transformation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.
For more information, see Quotas in the IoT SiteWise User Guide .
The list of variables used in the expression.
Contains expression variable information.
The friendly name of the variable to be used in the expression.
The variable that identifies an asset property from which to use values.
The ID of the property to use as the variable. You can use the property name if it's from the same asset model.
The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID.
You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId . For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide .
The processing configuration for the given transform property. You can configure transforms to be kept at the edge or forwarded to the Amazon Web Services Cloud. You can also configure transforms to be computed at the edge or in the cloud.
The compute location for the given transform property.
The forwarding configuration for a given property.
The forwarding state for the given property.
Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.
The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.
For more information, see Quotas in the IoT SiteWise User Guide .
The list of variables used in the expression.
Contains expression variable information.
The friendly name of the variable to be used in the expression.
The variable that identifies an asset property from which to use values.
The ID of the property to use as the variable. You can use the property name if it's from the same asset model.
The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID.
You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId . For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide .
The window (time interval) over which IoT SiteWise computes the metric's aggregation expression. IoT SiteWise computes one data point per window .
The tumbling time interval window.
The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.
IoT SiteWise computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval at the end of each hour, and so on.
When IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. IoT SiteWise places the computed data point at the end of the interval.
The offset for the tumbling window. The offset parameter accepts the following:
18h for offset and 1d for interval , IoT SiteWise aggregates data in one of the following ways:PT18H for offset and 1d for interval , IoT SiteWise aggregates data in one of the following ways:00:03:00 for offset , 5m for interval , and you create the metric at 2 PM (UTC), you get the first aggregation result at 2:03 PM (UTC). You get the second aggregation result at 2:08 PM (UTC).2021-07-23T18:00-08 for offset and 1d for interval , IoT SiteWise aggregates data in one of the following ways:The processing configuration for the given metric property. You can configure metrics to be computed at the edge or in the Amazon Web Services Cloud. By default, metrics are forwarded to the cloud.
The compute location for the given metric property.
The ID of the asset model composite model.
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
This field is autopopulated if not provided.
dict
Response Syntax
{
'assetModelStatus': {
'state': 'CREATING'|'ACTIVE'|'UPDATING'|'PROPAGATING'|'DELETING'|'FAILED',
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
'message': 'string',
'details': [
{
'code': 'INCOMPATIBLE_COMPUTE_LOCATION'|'INCOMPATIBLE_FORWARDING_CONFIGURATION',
'message': 'string'
},
]
}
}
}
Response Structure
(dict) --
assetModelStatus (dict) --
The status of the asset model, which contains a state (UPDATING after successfully calling this operation) and any error message.
state (string) --
The current state of the asset model.
error (dict) --
Contains associated error information, if any.
code (string) --
The error code.
message (string) --
The error message.
details (list) --
A list of detailed errors.
(dict) --
Contains detailed error information.
code (string) --
The error code.
message (string) --
The error message.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceAlreadyExistsExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.LimitExceededExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionIoTSiteWise.Client.exceptions.ConflictingOperationExceptionupdate_asset_property(**kwargs)¶Updates an asset property's alias and notification state.
Warning
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 .
See also: AWS API Documentation
Request Syntax
response = client.update_asset_property(
assetId='string',
propertyId='string',
propertyAlias='string',
propertyNotificationState='ENABLED'|'DISABLED',
clientToken='string',
propertyUnit='string'
)
[REQUIRED]
The ID of the asset to be updated.
[REQUIRED]
The ID of the asset property to be updated.
The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature ). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide .
If you omit this parameter, the alias is removed from the property.
The MQTT notification state (enabled or disabled) for this asset property. When the notification state is enabled, IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see Interacting with other services in the IoT SiteWise User Guide .
If you omit this parameter, the notification state is set to DISABLED .
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
This field is autopopulated if not provided.
assetModelProperty in the asset model.None
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionIoTSiteWise.Client.exceptions.ConflictingOperationExceptionupdate_dashboard(**kwargs)¶Updates an IoT SiteWise Monitor dashboard.
See also: AWS API Documentation
Request Syntax
response = client.update_dashboard(
dashboardId='string',
dashboardName='string',
dashboardDescription='string',
dashboardDefinition='string',
clientToken='string'
)
[REQUIRED]
The ID of the dashboard to update.
[REQUIRED]
A new friendly name for the dashboard.
[REQUIRED]
The new dashboard definition, as specified in a JSON literal. For detailed information, see Creating dashboards (CLI) in the IoT SiteWise User Guide .
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
This field is autopopulated if not provided.
dict
Response Syntax
{}
Response Structure
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionupdate_gateway(**kwargs)¶Updates a gateway's name.
See also: AWS API Documentation
Request Syntax
response = client.update_gateway(
gatewayId='string',
gatewayName='string'
)
[REQUIRED]
The ID of the gateway to update.
[REQUIRED]
A unique, friendly name for the gateway.
None
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.ConflictingOperationExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionupdate_gateway_capability_configuration(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.update_gateway_capability_configuration(
gatewayId='string',
capabilityNamespace='string',
capabilityConfiguration='string'
)
[REQUIRED]
The ID of the gateway to be updated.
[REQUIRED]
The namespace of the gateway capability configuration to be updated. For example, if you configure OPC-UA sources from the IoT SiteWise console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version , where version is a number such as 1 .
[REQUIRED]
The JSON document that defines the configuration for the gateway capability. For more information, see Configuring data sources (CLI) in the IoT SiteWise User Guide .
dict
Response Syntax
{
'capabilityNamespace': 'string',
'capabilitySyncStatus': 'IN_SYNC'|'OUT_OF_SYNC'|'SYNC_FAILED'|'UNKNOWN'
}
Response Structure
(dict) --
capabilityNamespace (string) --
The namespace of the gateway capability.
capabilitySyncStatus (string) --
The synchronization status of the capability configuration. The sync status can be one of the following:
IN_SYNC – The gateway is running the capability configuration.OUT_OF_SYNC – The gateway hasn't received the capability configuration.SYNC_FAILED – The gateway rejected the capability configuration.After you update a capability configuration, its sync status is OUT_OF_SYNC until the gateway receives and applies or rejects the updated configuration.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.ConflictingOperationExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionIoTSiteWise.Client.exceptions.LimitExceededExceptionupdate_portal(**kwargs)¶Updates an IoT SiteWise Monitor portal.
See also: AWS API Documentation
Request Syntax
response = client.update_portal(
portalId='string',
portalName='string',
portalDescription='string',
portalContactEmail='string',
portalLogoImage={
'id': 'string',
'file': {
'data': b'bytes',
'type': 'PNG'
}
},
roleArn='string',
clientToken='string',
notificationSenderEmail='string',
alarms={
'alarmRoleArn': 'string',
'notificationLambdaArn': 'string'
}
)
[REQUIRED]
The ID of the portal to update.
[REQUIRED]
A new friendly name for the portal.
[REQUIRED]
The Amazon Web Services administrator's contact email address.
Contains an image that is one of the following:
The ID of an existing image. Specify this parameter to keep an existing image.
Contains an image file.
The image file contents, represented as a base64-encoded string. The file size must be less than 1 MB.
The file type of the image.
[REQUIRED]
The ARN of a service role that allows the portal's users to access your IoT SiteWise resources on your behalf. For more information, see Using service roles for IoT SiteWise Monitor in the IoT SiteWise User Guide .
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
This field is autopopulated if not provided.
Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range. For more information, see Monitoring with alarms in the IoT SiteWise Application Guide .
The ARN of the IAM role that allows the alarm to perform actions and access Amazon Web Services resources and services, such as IoT Events.
The ARN of the Lambda function that manages alarm notifications. For more information, see Managing alarm notifications in the IoT Events Developer Guide .
dict
Response Syntax
{
'portalStatus': {
'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'FAILED',
'error': {
'code': 'INTERNAL_FAILURE'|'VALIDATION_ERROR'|'LIMIT_EXCEEDED',
'message': 'string'
}
}
}
Response Structure
(dict) --
portalStatus (dict) --
The status of the portal, which contains a state (UPDATING after successfully calling this operation) and any error message.
state (string) --
The current state of the portal.
error (dict) --
Contains associated error information, if any.
code (string) --
The error code.
message (string) --
The error message.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionIoTSiteWise.Client.exceptions.ConflictingOperationExceptionupdate_project(**kwargs)¶Updates an IoT SiteWise Monitor project.
See also: AWS API Documentation
Request Syntax
response = client.update_project(
projectId='string',
projectName='string',
projectDescription='string',
clientToken='string'
)
[REQUIRED]
The ID of the project to update.
[REQUIRED]
A new friendly name for the project.
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
This field is autopopulated if not provided.
dict
Response Syntax
{}
Response Structure
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionThe available paginators are:
IoTSiteWise.Paginator.GetAssetPropertyAggregatesIoTSiteWise.Paginator.GetAssetPropertyValueHistoryIoTSiteWise.Paginator.GetInterpolatedAssetPropertyValuesIoTSiteWise.Paginator.ListAccessPoliciesIoTSiteWise.Paginator.ListAssetModelPropertiesIoTSiteWise.Paginator.ListAssetModelsIoTSiteWise.Paginator.ListAssetPropertiesIoTSiteWise.Paginator.ListAssetRelationshipsIoTSiteWise.Paginator.ListAssetsIoTSiteWise.Paginator.ListAssociatedAssetsIoTSiteWise.Paginator.ListBulkImportJobsIoTSiteWise.Paginator.ListDashboardsIoTSiteWise.Paginator.ListGatewaysIoTSiteWise.Paginator.ListPortalsIoTSiteWise.Paginator.ListProjectAssetsIoTSiteWise.Paginator.ListProjectsIoTSiteWise.Paginator.ListTimeSeriesIoTSiteWise.Paginator.GetAssetPropertyAggregates¶paginator = client.get_paginator('get_asset_property_aggregates')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from IoTSiteWise.Client.get_asset_property_aggregates().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
assetId='string',
propertyId='string',
propertyAlias='string',
aggregateTypes=[
'AVERAGE'|'COUNT'|'MAXIMUM'|'MINIMUM'|'SUM'|'STANDARD_DEVIATION',
],
resolution='string',
qualities=[
'GOOD'|'BAD'|'UNCERTAIN',
],
startDate=datetime(2015, 1, 1),
endDate=datetime(2015, 1, 1),
timeOrdering='ASCENDING'|'DESCENDING',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
/company/windfarm/3/turbine/7/temperature ). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide .[REQUIRED]
The data aggregating function.
[REQUIRED]
The time interval over which to aggregate data.
The quality by which to filter asset data.
[REQUIRED]
The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.
[REQUIRED]
The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.
The chronological sorting order of the requested information.
Default: ASCENDING
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'aggregatedValues': [
{
'timestamp': datetime(2015, 1, 1),
'quality': 'GOOD'|'BAD'|'UNCERTAIN',
'value': {
'average': 123.0,
'count': 123.0,
'maximum': 123.0,
'minimum': 123.0,
'sum': 123.0,
'standardDeviation': 123.0
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
aggregatedValues (list) --
The requested aggregated values.
(dict) --
Contains aggregated asset property values (for example, average, minimum, and maximum).
timestamp (datetime) --
The date the aggregating computations occurred, in Unix epoch time.
quality (string) --
The quality of the aggregated data.
value (dict) --
The value of the aggregates.
average (float) --
The average (mean) value of the time series over a time interval window.
count (float) --
The count of data points in the time series over a time interval window.
maximum (float) --
The maximum value of the time series over a time interval window.
minimum (float) --
The minimum value of the time series over a time interval window.
sum (float) --
The sum of the time series over a time interval window.
standardDeviation (float) --
The standard deviation of the time series over a time interval window.
NextToken (string) --
A token to resume pagination.
IoTSiteWise.Paginator.GetAssetPropertyValueHistory¶paginator = client.get_paginator('get_asset_property_value_history')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from IoTSiteWise.Client.get_asset_property_value_history().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
assetId='string',
propertyId='string',
propertyAlias='string',
startDate=datetime(2015, 1, 1),
endDate=datetime(2015, 1, 1),
qualities=[
'GOOD'|'BAD'|'UNCERTAIN',
],
timeOrdering='ASCENDING'|'DESCENDING',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
/company/windfarm/3/turbine/7/temperature ). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide .The quality by which to filter asset data.
The chronological sorting order of the requested information.
Default: ASCENDING
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'assetPropertyValueHistory': [
{
'value': {
'stringValue': 'string',
'integerValue': 123,
'doubleValue': 123.0,
'booleanValue': True|False
},
'timestamp': {
'timeInSeconds': 123,
'offsetInNanos': 123
},
'quality': 'GOOD'|'BAD'|'UNCERTAIN'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
assetPropertyValueHistory (list) --
The asset property's value history.
(dict) --
Contains asset property value information.
value (dict) --
The value of the asset property (see Variant ).
stringValue (string) --
Asset property data of type string (sequence of characters).
integerValue (integer) --
Asset property data of type integer (whole number).
doubleValue (float) --
Asset property data of type double (floating point number).
booleanValue (boolean) --
Asset property data of type Boolean (true or false).
timestamp (dict) --
The timestamp of the asset property value.
timeInSeconds (integer) --
The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos .
offsetInNanos (integer) --
The nanosecond offset from timeInSeconds .
quality (string) --
The quality of the asset property value.
NextToken (string) --
A token to resume pagination.
IoTSiteWise.Paginator.GetInterpolatedAssetPropertyValues¶paginator = client.get_paginator('get_interpolated_asset_property_values')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from IoTSiteWise.Client.get_interpolated_asset_property_values().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
assetId='string',
propertyId='string',
propertyAlias='string',
startTimeInSeconds=123,
startTimeOffsetInNanos=123,
endTimeInSeconds=123,
endTimeOffsetInNanos=123,
quality='GOOD'|'BAD'|'UNCERTAIN',
intervalInSeconds=123,
type='string',
intervalWindowInSeconds=123,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
/company/windfarm/3/turbine/7/temperature ). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide .[REQUIRED]
The exclusive start of the range from which to interpolate data, expressed in seconds in Unix epoch time.
startTimeInSeconds .[REQUIRED]
The inclusive end of the range from which to interpolate data, expressed in seconds in Unix epoch time.
endTimeInSeconds .[REQUIRED]
The quality of the asset property value. You can use this parameter as a filter to choose only the asset property values that have a specific quality.
[REQUIRED]
The time interval in seconds over which to interpolate data. Each interval starts when the previous one ends.
[REQUIRED]
The interpolation type.
Valid values: LINEAR_INTERPOLATION | LOCF_INTERPOLATION
LINEAR_INTERPOLATION – Estimates missing data using linear interpolation . 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. If the interpolation starts July 1, 2021, at 9 AM, IoT SiteWise returns the first interpolated value on July 2, 2021, at 9 AM, the second interpolated value on July 3, 2021, at 9 AM, and so on.LOCF_INTERPOLATION – Estimates missing data using last observation carried forward interpolation If no data point is found for an interval, IoT SiteWise returns the last observed data point for the previous interval and carries forward this interpolated value until a new data point is found. For example, you can get the state of an on-off valve every 24 hours over a duration of 7 days. If the interpolation starts July 1, 2021, at 9 AM, IoT SiteWise returns the last observed data point between July 1, 2021, at 9 AM and July 2, 2021, at 9 AM as the first interpolated value. If a data point isn't found after 9 AM on July 2, 2021, IoT SiteWise uses the same interpolated value for the rest of the days.The query interval for the window, in seconds. IoT SiteWise computes each interpolated value by using data points from the timestamp of each interval, minus the window to the timestamp of each interval plus the window. If not specified, the window ranges between the start time minus the interval and the end time plus the interval.
Note
intervalWindowInSeconds parameter, the value for the type parameter must be LINEAR_INTERPOLATION .For example, you can get the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days. If the interpolation starts on July 1, 2021, at 9 AM with a window of 2 hours, IoT SiteWise uses the data points from 7 AM (9 AM minus 2 hours) to 11 AM (9 AM plus 2 hours) on July 2, 2021 to compute the first interpolated value. Next, IoT SiteWise uses the data points from 7 AM (9 AM minus 2 hours) to 11 AM (9 AM plus 2 hours) on July 3, 2021 to compute the second interpolated value, and so on.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'interpolatedAssetPropertyValues': [
{
'timestamp': {
'timeInSeconds': 123,
'offsetInNanos': 123
},
'value': {
'stringValue': 'string',
'integerValue': 123,
'doubleValue': 123.0,
'booleanValue': True|False
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
interpolatedAssetPropertyValues (list) --
The requested interpolated values.
(dict) --
Contains information about an interpolated asset property value.
timestamp (dict) --
Contains a timestamp with optional nanosecond granularity.
timeInSeconds (integer) --
The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos .
offsetInNanos (integer) --
The nanosecond offset from timeInSeconds .
value (dict) --
Contains an asset property value (of a single type only).
stringValue (string) --
Asset property data of type string (sequence of characters).
integerValue (integer) --
Asset property data of type integer (whole number).
doubleValue (float) --
Asset property data of type double (floating point number).
booleanValue (boolean) --
Asset property data of type Boolean (true or false).
NextToken (string) --
A token to resume pagination.
IoTSiteWise.Paginator.ListAccessPolicies¶paginator = client.get_paginator('list_access_policies')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from IoTSiteWise.Client.list_access_policies().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
identityType='USER'|'GROUP'|'IAM',
identityId='string',
resourceType='PORTAL'|'PROJECT',
resourceId='string',
iamArn='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
identityId .USER or GROUP for identityType .resourceId .resourceType .IAM for identityType .A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'accessPolicySummaries': [
{
'id': 'string',
'identity': {
'user': {
'id': 'string'
},
'group': {
'id': 'string'
},
'iamUser': {
'arn': 'string'
},
'iamRole': {
'arn': 'string'
}
},
'resource': {
'portal': {
'id': 'string'
},
'project': {
'id': 'string'
}
},
'permission': 'ADMINISTRATOR'|'VIEWER',
'creationDate': datetime(2015, 1, 1),
'lastUpdateDate': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
accessPolicySummaries (list) --
A list that summarizes each access policy.
(dict) --
Contains an access policy that defines an identity's access to an IoT SiteWise Monitor resource.
id (string) --
The ID of the access policy.
identity (dict) --
The identity (an IAM Identity Center user, an IAM Identity Center group, or an IAM user).
user (dict) --
An IAM Identity Center user identity.
id (string) --
The IAM Identity Center ID of the user.
group (dict) --
An IAM Identity Center group identity.
id (string) --
The IAM Identity Center ID of the group.
iamUser (dict) --
An IAM user identity.
arn (string) --
The ARN of the IAM user. For more information, see IAM ARNs in the IAM User Guide .
Note
If you delete the IAM user, access policies that contain this identity include an empty arn . You can delete the access policy for the IAM user that no longer exists.
iamRole (dict) --
An IAM role identity.
arn (string) --
The ARN of the IAM role. For more information, see IAM ARNs in the IAM User Guide .
resource (dict) --
The IoT SiteWise Monitor resource (a portal or project).
portal (dict) --
A portal resource.
id (string) --
The ID of the portal.
project (dict) --
A project resource.
id (string) --
The ID of the project.
permission (string) --
The permissions for the access policy. Note that a project ADMINISTRATOR is also known as a project owner.
creationDate (datetime) --
The date the access policy was created, in Unix epoch time.
lastUpdateDate (datetime) --
The date the access policy was last updated, in Unix epoch time.
NextToken (string) --
A token to resume pagination.
IoTSiteWise.Paginator.ListAssetModelProperties¶paginator = client.get_paginator('list_asset_model_properties')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from IoTSiteWise.Client.list_asset_model_properties().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
assetModelId='string',
filter='ALL'|'BASE',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of the asset model.
Filters the requested list of asset model properties. You can choose one of the following options:
ALL – The list includes all asset model properties for a given asset model ID.BASE – The list includes only base asset model properties for a given asset model ID.Default: BASE
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'assetModelPropertySummaries': [
{
'id': 'string',
'name': 'string',
'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN'|'STRUCT',
'dataTypeSpec': 'string',
'unit': 'string',
'type': {
'attribute': {
'defaultValue': 'string'
},
'measurement': {
'processingConfig': {
'forwardingConfig': {
'state': 'DISABLED'|'ENABLED'
}
}
},
'transform': {
'expression': 'string',
'variables': [
{
'name': 'string',
'value': {
'propertyId': 'string',
'hierarchyId': 'string'
}
},
],
'processingConfig': {
'computeLocation': 'EDGE'|'CLOUD',
'forwardingConfig': {
'state': 'DISABLED'|'ENABLED'
}
}
},
'metric': {
'expression': 'string',
'variables': [
{
'name': 'string',
'value': {
'propertyId': 'string',
'hierarchyId': 'string'
}
},
],
'window': {
'tumbling': {
'interval': 'string',
'offset': 'string'
}
},
'processingConfig': {
'computeLocation': 'EDGE'|'CLOUD'
}
}
},
'assetModelCompositeModelId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
assetModelPropertySummaries (list) --
A list that summarizes the properties associated with the specified asset model.
(dict) --
Contains a summary of a property associated with a model.
id (string) --
The ID of the property.
name (string) --
The name of the property.
dataType (string) --
The data type of the property.
dataTypeSpec (string) --
The data type of the structure for this property. This parameter exists on properties that have the STRUCT data type.
unit (string) --
The unit (such as Newtons or RPM ) of the property.
type (dict) --
Contains a property type, which can be one of attribute , measurement , metric , or transform .
attribute (dict) --
Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an IIoT wind turbine.
defaultValue (string) --
The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see Updating attribute values in the IoT SiteWise User Guide .
measurement (dict) --
Specifies an asset measurement property. A measurement represents a device's raw sensor data stream, such as timestamped temperature values or timestamped power values.
processingConfig (dict) --
The processing configuration for the given measurement property. You can configure measurements to be kept at the edge or forwarded to the Amazon Web Services Cloud. By default, measurements are forwarded to the cloud.
forwardingConfig (dict) --
The forwarding configuration for the given measurement property.
state (string) --
The forwarding state for the given property.
transform (dict) --
Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.
expression (string) --
The mathematical expression that defines the transformation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.
For more information, see Quotas in the IoT SiteWise User Guide .
variables (list) --
The list of variables used in the expression.
(dict) --
Contains expression variable information.
name (string) --
The friendly name of the variable to be used in the expression.
value (dict) --
The variable that identifies an asset property from which to use values.
propertyId (string) --
The ID of the property to use as the variable. You can use the property name if it's from the same asset model.
hierarchyId (string) --
The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID.
You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId . For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide .
processingConfig (dict) --
The processing configuration for the given transform property. You can configure transforms to be kept at the edge or forwarded to the Amazon Web Services Cloud. You can also configure transforms to be computed at the edge or in the cloud.
computeLocation (string) --
The compute location for the given transform property.
forwardingConfig (dict) --
The forwarding configuration for a given property.
state (string) --
The forwarding state for the given property.
metric (dict) --
Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.
expression (string) --
The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.
For more information, see Quotas in the IoT SiteWise User Guide .
variables (list) --
The list of variables used in the expression.
(dict) --
Contains expression variable information.
name (string) --
The friendly name of the variable to be used in the expression.
value (dict) --
The variable that identifies an asset property from which to use values.
propertyId (string) --
The ID of the property to use as the variable. You can use the property name if it's from the same asset model.
hierarchyId (string) --
The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID.
You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId . For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide .
window (dict) --
The window (time interval) over which IoT SiteWise computes the metric's aggregation expression. IoT SiteWise computes one data point per window .
tumbling (dict) --
The tumbling time interval window.
interval (string) --
The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.
IoT SiteWise computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval at the end of each hour, and so on.
When IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. IoT SiteWise places the computed data point at the end of the interval.
offset (string) --
The offset for the tumbling window. The offset parameter accepts the following:
18h for offset and 1d for interval , IoT SiteWise aggregates data in one of the following ways:PT18H for offset and 1d for interval , IoT SiteWise aggregates data in one of the following ways:00:03:00 for offset , 5m for interval , and you create the metric at 2 PM (UTC), you get the first aggregation result at 2:03 PM (UTC). You get the second aggregation result at 2:08 PM (UTC).2021-07-23T18:00-08 for offset and 1d for interval , IoT SiteWise aggregates data in one of the following ways:processingConfig (dict) --
The processing configuration for the given metric property. You can configure metrics to be computed at the edge or in the Amazon Web Services Cloud. By default, metrics are forwarded to the cloud.
computeLocation (string) --
The compute location for the given metric property.
assetModelCompositeModelId (string) --
The ID of the composite model that contains the asset model property.
NextToken (string) --
A token to resume pagination.
IoTSiteWise.Paginator.ListAssetModels¶paginator = client.get_paginator('list_asset_models')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from IoTSiteWise.Client.list_asset_models().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'assetModelSummaries': [
{
'id': 'string',
'arn': 'string',
'name': 'string',
'description': 'string',
'creationDate': datetime(2015, 1, 1),
'lastUpdateDate': datetime(2015, 1, 1),
'status': {
'state': 'CREATING'|'ACTIVE'|'UPDATING'|'PROPAGATING'|'DELETING'|'FAILED',
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
'message': 'string',
'details': [
{
'code': 'INCOMPATIBLE_COMPUTE_LOCATION'|'INCOMPATIBLE_FORWARDING_CONFIGURATION',
'message': 'string'
},
]
}
}
},
],
'NextToken': 'string'
}
Response Structure
A list that summarizes each asset model.
Contains a summary of an asset model.
The ID of the asset model (used with IoT SiteWise APIs).
The ARN of the asset model, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}
The name of the asset model.
The asset model description.
The date the asset model was created, in Unix epoch time.
The date the asset model was last updated, in Unix epoch time.
The current status of the asset model.
The current state of the asset model.
Contains associated error information, if any.
The error code.
The error message.
A list of detailed errors.
Contains detailed error information.
The error code.
The error message.
A token to resume pagination.
IoTSiteWise.Paginator.ListAssetProperties¶paginator = client.get_paginator('list_asset_properties')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from IoTSiteWise.Client.list_asset_properties().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
assetId='string',
filter='ALL'|'BASE',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of the asset.
Filters the requested list of asset properties. You can choose one of the following options:
ALL – The list includes all asset properties for a given asset model ID.BASE – The list includes only base asset properties for a given asset model ID.Default: BASE
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'assetPropertySummaries': [
{
'id': 'string',
'alias': 'string',
'unit': 'string',
'notification': {
'topic': 'string',
'state': 'ENABLED'|'DISABLED'
},
'assetCompositeModelId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
assetPropertySummaries (list) --
A list that summarizes the properties associated with the specified asset.
(dict) --
Contains a summary of a property associated with an asset.
id (string) --
The ID of the property.
alias (string) --
The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature ). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide .
unit (string) --
The unit of measure (such as Newtons or RPM) of the asset property.
notification (dict) --
Contains asset property value notification information. When the notification state is enabled, IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see Interacting with other services in the IoT SiteWise User Guide .
topic (string) --
The MQTT topic to which IoT SiteWise publishes property value update notifications.
state (string) --
The current notification state.
assetCompositeModelId (string) --
The ID of the composite model that contains the asset property.
NextToken (string) --
A token to resume pagination.
IoTSiteWise.Paginator.ListAssetRelationships¶paginator = client.get_paginator('list_asset_relationships')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from IoTSiteWise.Client.list_asset_relationships().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
assetId='string',
traversalType='PATH_TO_ROOT',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of the asset.
[REQUIRED]
The type of traversal to use to identify asset relationships. Choose the following option:
PATH_TO_ROOT – Identify the asset's parent assets up to the root asset. The asset that you specify in assetId is the first result in the list of assetRelationshipSummaries , and the root asset is the last result.A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'assetRelationshipSummaries': [
{
'hierarchyInfo': {
'parentAssetId': 'string',
'childAssetId': 'string'
},
'relationshipType': 'HIERARCHY'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
assetRelationshipSummaries (list) --
A list that summarizes each asset relationship.
(dict) --
Contains information about assets that are related to one another.
hierarchyInfo (dict) --
The assets that are related through an asset hierarchy.
This object is present if the relationshipType is HIERARCHY .
parentAssetId (string) --
The ID of the parent asset in this asset relationship.
childAssetId (string) --
The ID of the child asset in this asset relationship.
relationshipType (string) --
The relationship type of the assets in this relationship. This value is one of the following:
HIERARCHY – The assets are related through an asset hierarchy. If you specify this relationship type, this asset relationship includes the hierarchyInfo object.NextToken (string) --
A token to resume pagination.
IoTSiteWise.Paginator.ListAssets¶paginator = client.get_paginator('list_assets')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from IoTSiteWise.Client.list_assets().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
assetModelId='string',
filter='ALL'|'TOP_LEVEL',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
ALL for filter .The filter for the requested list of assets. Choose one of the following options:
ALL – The list includes all assets for a given asset model ID. The assetModelId parameter is required if you filter by ALL .TOP_LEVEL – The list includes only top-level assets in the asset hierarchy tree.Default: ALL
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'assetSummaries': [
{
'id': 'string',
'arn': 'string',
'name': 'string',
'assetModelId': 'string',
'creationDate': datetime(2015, 1, 1),
'lastUpdateDate': datetime(2015, 1, 1),
'status': {
'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED',
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
'message': 'string',
'details': [
{
'code': 'INCOMPATIBLE_COMPUTE_LOCATION'|'INCOMPATIBLE_FORWARDING_CONFIGURATION',
'message': 'string'
},
]
}
},
'hierarchies': [
{
'id': 'string',
'name': 'string'
},
],
'description': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
assetSummaries (list) --
A list that summarizes each asset.
(dict) --
Contains a summary of an asset.
id (string) --
The ID of the asset.
arn (string) --
The ARN of the asset, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}
name (string) --
The name of the asset.
assetModelId (string) --
The ID of the asset model used to create this asset.
creationDate (datetime) --
The date the asset was created, in Unix epoch time.
lastUpdateDate (datetime) --
The date the asset was last updated, in Unix epoch time.
status (dict) --
The current status of the asset.
state (string) --
The current status of the asset.
error (dict) --
Contains associated error information, if any.
code (string) --
The error code.
message (string) --
The error message.
details (list) --
A list of detailed errors.
(dict) --
Contains detailed error information.
code (string) --
The error code.
message (string) --
The error message.
hierarchies (list) --
A list of asset hierarchies that each contain a hierarchyId . A hierarchy specifies allowed parent/child asset relationships.
(dict) --
Describes an asset hierarchy that contains a hierarchy's name and ID.
id (string) --
The ID of the hierarchy. This ID is a hierarchyId .
name (string) --
The hierarchy name provided in the CreateAssetModel or UpdateAssetModel API operation.
description (string) --
A description for the asset.
NextToken (string) --
A token to resume pagination.
IoTSiteWise.Paginator.ListAssociatedAssets¶paginator = client.get_paginator('list_associated_assets')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from IoTSiteWise.Client.list_associated_assets().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
assetId='string',
hierarchyId='string',
traversalDirection='PARENT'|'CHILD',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of the asset to query.
The ID of the hierarchy by which child assets are associated to the asset. To find a hierarchy ID, use the DescribeAsset or DescribeAssetModel operations. This parameter is required if you choose CHILD for traversalDirection .
For more information, see Asset hierarchies in the IoT SiteWise User Guide .
The direction to list associated assets. Choose one of the following options:
CHILD – The list includes all child assets associated to the asset. The hierarchyId parameter is required if you choose CHILD .PARENT – The list includes the asset's parent asset.Default: CHILD
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'assetSummaries': [
{
'id': 'string',
'arn': 'string',
'name': 'string',
'assetModelId': 'string',
'creationDate': datetime(2015, 1, 1),
'lastUpdateDate': datetime(2015, 1, 1),
'status': {
'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED',
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
'message': 'string',
'details': [
{
'code': 'INCOMPATIBLE_COMPUTE_LOCATION'|'INCOMPATIBLE_FORWARDING_CONFIGURATION',
'message': 'string'
},
]
}
},
'hierarchies': [
{
'id': 'string',
'name': 'string'
},
],
'description': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
assetSummaries (list) --
A list that summarizes the associated assets.
(dict) --
Contains a summary of an associated asset.
id (string) --
The ID of the asset.
arn (string) --
The ARN of the asset, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}
name (string) --
The name of the asset.
assetModelId (string) --
The ID of the asset model used to create the asset.
creationDate (datetime) --
The date the asset was created, in Unix epoch time.
lastUpdateDate (datetime) --
The date the asset was last updated, in Unix epoch time.
status (dict) --
The current status of the asset.
state (string) --
The current status of the asset.
error (dict) --
Contains associated error information, if any.
code (string) --
The error code.
message (string) --
The error message.
details (list) --
A list of detailed errors.
(dict) --
Contains detailed error information.
code (string) --
The error code.
message (string) --
The error message.
hierarchies (list) --
A list of asset hierarchies that each contain a hierarchyId . A hierarchy specifies allowed parent/child asset relationships.
(dict) --
Describes an asset hierarchy that contains a hierarchy's name and ID.
id (string) --
The ID of the hierarchy. This ID is a hierarchyId .
name (string) --
The hierarchy name provided in the CreateAssetModel or UpdateAssetModel API operation.
description (string) --
A description for the asset.
NextToken (string) --
A token to resume pagination.
IoTSiteWise.Paginator.ListBulkImportJobs¶paginator = client.get_paginator('list_bulk_import_jobs')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from IoTSiteWise.Client.list_bulk_import_jobs().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
filter='ALL'|'PENDING'|'RUNNING'|'CANCELLED'|'FAILED'|'COMPLETED_WITH_FAILURES'|'COMPLETED',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'jobSummaries': [
{
'id': 'string',
'name': 'string',
'status': 'PENDING'|'CANCELLED'|'RUNNING'|'COMPLETED'|'FAILED'|'COMPLETED_WITH_FAILURES'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
jobSummaries (list) --
One or more job summaries to list.
(dict) --
Contains a job summary information.
id (string) --
The ID of the job.
name (string) --
The unique name that helps identify the job request.
status (string) --
The status of the bulk import job can be one of following values.
PENDING – IoT SiteWise is waiting for the current bulk import job to finish.CANCELLED – The bulk import job has been canceled.RUNNING – IoT SiteWise is processing your request to import your data from Amazon S3.COMPLETED – IoT SiteWise successfully completed your request to import data from Amazon S3.FAILED – IoT SiteWise couldn't process your request to import data from Amazon S3. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.COMPLETED_WITH_FAILURES – IoT SiteWise completed your request to import data from Amazon S3 with errors. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.NextToken (string) --
A token to resume pagination.
IoTSiteWise.Paginator.ListDashboards¶paginator = client.get_paginator('list_dashboards')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from IoTSiteWise.Client.list_dashboards().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
projectId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of the project.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'dashboardSummaries': [
{
'id': 'string',
'name': 'string',
'description': 'string',
'creationDate': datetime(2015, 1, 1),
'lastUpdateDate': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
dashboardSummaries (list) --
A list that summarizes each dashboard in the project.
(dict) --
Contains a dashboard summary.
id (string) --
The ID of the dashboard.
name (string) --
The name of the dashboard
description (string) --
The dashboard's description.
creationDate (datetime) --
The date the dashboard was created, in Unix epoch time.
lastUpdateDate (datetime) --
The date the dashboard was last updated, in Unix epoch time.
NextToken (string) --
A token to resume pagination.
IoTSiteWise.Paginator.ListGateways¶paginator = client.get_paginator('list_gateways')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from IoTSiteWise.Client.list_gateways().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'gatewaySummaries': [
{
'gatewayId': 'string',
'gatewayName': 'string',
'gatewayPlatform': {
'greengrass': {
'groupArn': 'string'
},
'greengrassV2': {
'coreDeviceThingName': 'string'
}
},
'gatewayCapabilitySummaries': [
{
'capabilityNamespace': 'string',
'capabilitySyncStatus': 'IN_SYNC'|'OUT_OF_SYNC'|'SYNC_FAILED'|'UNKNOWN'
},
],
'creationDate': datetime(2015, 1, 1),
'lastUpdateDate': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
A list that summarizes each gateway.
Contains a summary of a gateway.
The ID of the gateway device.
The name of the asset.
Contains a gateway's platform information.
A gateway that runs on IoT Greengrass.
The ARN of the Greengrass group. For more information about how to find a group's ARN, see ListGroups and GetGroup in the IoT Greengrass API Reference .
A gateway that runs on IoT Greengrass V2.
The name of the IoT thing for your IoT Greengrass V2 core device.
A list of gateway capability summaries that each contain a namespace and status. Each gateway capability defines data sources for the gateway. To retrieve a capability configuration's definition, use DescribeGatewayCapabilityConfiguration .
Contains a summary of a gateway capability configuration.
The namespace of the capability configuration. For example, if you configure OPC-UA sources from the IoT SiteWise console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version , where version is a number such as 1 .
The synchronization status of the capability configuration. The sync status can be one of the following:
IN_SYNC – The gateway is running the capability configuration.OUT_OF_SYNC – The gateway hasn't received the capability configuration.SYNC_FAILED – The gateway rejected the capability configuration.The date the gateway was created, in Unix epoch time.
The date the gateway was last updated, in Unix epoch time.
A token to resume pagination.
IoTSiteWise.Paginator.ListPortals¶paginator = client.get_paginator('list_portals')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from IoTSiteWise.Client.list_portals().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'portalSummaries': [
{
'id': 'string',
'name': 'string',
'description': 'string',
'startUrl': 'string',
'creationDate': datetime(2015, 1, 1),
'lastUpdateDate': datetime(2015, 1, 1),
'roleArn': 'string',
'status': {
'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'FAILED',
'error': {
'code': 'INTERNAL_FAILURE'|'VALIDATION_ERROR'|'LIMIT_EXCEEDED',
'message': 'string'
}
}
},
],
'NextToken': 'string'
}
Response Structure
A list that summarizes each portal.
Contains a portal summary.
The ID of the portal.
The name of the portal.
The portal's description.
The URL for the IoT SiteWise Monitor portal. You can use this URL to access portals that use IAM Identity Center for authentication. For portals that use IAM for authentication, you must use the IoT SiteWise console to get a URL that you can use to access the portal.
The date the portal was created, in Unix epoch time.
The date the portal was last updated, in Unix epoch time.
The ARN of the service role that allows the portal's users to access your IoT SiteWise resources on your behalf. For more information, see Using service roles for IoT SiteWise Monitor in the IoT SiteWise User Guide .
Contains information about the current status of a portal.
The current state of the portal.
Contains associated error information, if any.
The error code.
The error message.
A token to resume pagination.
IoTSiteWise.Paginator.ListProjectAssets¶paginator = client.get_paginator('list_project_assets')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from IoTSiteWise.Client.list_project_assets().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
projectId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of the project.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'assetIds': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
assetIds (list) --
A list that contains the IDs of each asset associated with the project.
NextToken (string) --
A token to resume pagination.
IoTSiteWise.Paginator.ListProjects¶paginator = client.get_paginator('list_projects')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from IoTSiteWise.Client.list_projects().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
portalId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of the portal.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'projectSummaries': [
{
'id': 'string',
'name': 'string',
'description': 'string',
'creationDate': datetime(2015, 1, 1),
'lastUpdateDate': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
projectSummaries (list) --
A list that summarizes each project in the portal.
(dict) --
Contains project summary information.
id (string) --
The ID of the project.
name (string) --
The name of the project.
description (string) --
The project's description.
creationDate (datetime) --
The date the project was created, in Unix epoch time.
lastUpdateDate (datetime) --
The date the project was last updated, in Unix epoch time.
NextToken (string) --
A token to resume pagination.
IoTSiteWise.Paginator.ListTimeSeries¶paginator = client.get_paginator('list_time_series')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from IoTSiteWise.Client.list_time_series().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
assetId='string',
aliasPrefix='string',
timeSeriesType='ASSOCIATED'|'DISASSOCIATED',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The type of the time series. The time series type can be one of the following values:
ASSOCIATED – The time series is associated with an asset property.DISASSOCIATED – The time series isn't associated with any asset property.A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'TimeSeriesSummaries': [
{
'assetId': 'string',
'propertyId': 'string',
'alias': 'string',
'timeSeriesId': 'string',
'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN'|'STRUCT',
'dataTypeSpec': 'string',
'timeSeriesCreationDate': datetime(2015, 1, 1),
'timeSeriesLastUpdateDate': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
TimeSeriesSummaries (list) --
One or more time series summaries to list.
(dict) --
Contains a summary of a time series (data stream).
assetId (string) --
The ID of the asset in which the asset property was created.
propertyId (string) --
The ID of the asset property.
alias (string) --
The alias that identifies the time series.
timeSeriesId (string) --
The ID of the time series.
dataType (string) --
The data type of the time series.
If you specify STRUCT , you must also specify dataTypeSpec to identify the type of the structure for this time series.
dataTypeSpec (string) --
The data type of the structure for this time series. This parameter is required for time series that have the STRUCT data type.
The options for this parameter depend on the type of the composite model in which you created the asset property that is associated with your time series. Use AWS/ALARM_STATE for alarm state in alarm composite models.
timeSeriesCreationDate (datetime) --
The date that the time series was created, in Unix epoch time.
timeSeriesLastUpdateDate (datetime) --
The date that the time series was last updated, in Unix epoch time.
NextToken (string) --
A token to resume pagination.
The available waiters are:
IoTSiteWise.Waiter.AssetActiveIoTSiteWise.Waiter.AssetModelActiveIoTSiteWise.Waiter.AssetModelNotExistsIoTSiteWise.Waiter.AssetNotExistsIoTSiteWise.Waiter.PortalActiveIoTSiteWise.Waiter.PortalNotExistsIoTSiteWise.Waiter.AssetActive¶waiter = client.get_waiter('asset_active')
wait(**kwargs)¶Polls IoTSiteWise.Client.describe_asset() every 3 seconds until a successful state is reached. An error is returned after 20 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
assetId='string',
excludeProperties=True|False,
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
The ID of the asset.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 3
The maximum number of attempts to be made. Default: 20
None
IoTSiteWise.Waiter.AssetModelActive¶waiter = client.get_waiter('asset_model_active')
wait(**kwargs)¶Polls IoTSiteWise.Client.describe_asset_model() every 3 seconds until a successful state is reached. An error is returned after 20 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
assetModelId='string',
excludeProperties=True|False,
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
The ID of the asset model.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 3
The maximum number of attempts to be made. Default: 20
None
IoTSiteWise.Waiter.AssetModelNotExists¶waiter = client.get_waiter('asset_model_not_exists')
wait(**kwargs)¶Polls IoTSiteWise.Client.describe_asset_model() every 3 seconds until a successful state is reached. An error is returned after 20 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
assetModelId='string',
excludeProperties=True|False,
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
The ID of the asset model.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 3
The maximum number of attempts to be made. Default: 20
None
IoTSiteWise.Waiter.AssetNotExists¶waiter = client.get_waiter('asset_not_exists')
wait(**kwargs)¶Polls IoTSiteWise.Client.describe_asset() every 3 seconds until a successful state is reached. An error is returned after 20 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
assetId='string',
excludeProperties=True|False,
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
The ID of the asset.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 3
The maximum number of attempts to be made. Default: 20
None
IoTSiteWise.Waiter.PortalActive¶waiter = client.get_waiter('portal_active')
wait(**kwargs)¶Polls IoTSiteWise.Client.describe_portal() every 3 seconds until a successful state is reached. An error is returned after 20 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
portalId='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
The ID of the portal.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 3
The maximum number of attempts to be made. Default: 20
None
IoTSiteWise.Waiter.PortalNotExists¶waiter = client.get_waiter('portal_not_exists')
wait(**kwargs)¶Polls IoTSiteWise.Client.describe_portal() every 3 seconds until a successful state is reached. An error is returned after 20 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
portalId='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
The ID of the portal.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 3
The maximum number of attempts to be made. Default: 20
None