2026/07/29 - AWS IoT SiteWise - 45 new27 updated api methods
Changes We have released a new set of APIs in support of a major new feature within AWS IoT SiteWise called Scenario Discover. Please see user guide about the feature and the API guide in public documentation for new APIs.
Retrieves detailed information about a specific pipeline in a workspace.
See also: AWS API Documentation
Request Syntax
client.describe_pipeline(
workspaceName='string',
pipelineName='string',
pipelineVersion='string'
)
string
[REQUIRED]
The name of the workspace.
string
[REQUIRED]
The name of the pipeline.
string
The version number of the pipeline to retrieve. If not specified, returns the latest version.
dict
Response Syntax
{
'pipelineName': 'string',
'workspaceName': 'string',
'description': 'string',
'pipelineArn': 'string',
'version': 'string',
'environmentVariables': {
'string': 'string'
},
'computations': [
{
'computeNodeName': 'string',
'taskName': 'string',
'environmentVariables': {
'string': 'string'
},
'dependsOn': [
'string',
]
},
],
'status': {
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
'message': 'string'
},
'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED'
},
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
Response structure for DescribePipeline operation.
pipelineName (string) --
A unique name of the pipeline within the workspace.
workspaceName (string) --
The name of the workspace.
description (string) --
The description of the pipeline.
pipelineArn (string) --
The ARN of the pipeline.
version (string) --
The version of the pipeline.
environmentVariables (dict) --
The environment variables shared across all compute nodes in the pipeline.
(string) --
Environment variable name following POSIX naming rules Must not start with AWS_ prefix (case-insensitive)
(string) --
Environment variable value
computations (list) --
The list of compute nodes that form the pipeline DAG.
(dict) --
A single compute node in a pipeline DAG. Each compute node references a task and can declare dependencies on other nodes.
computeNodeName (string) --
The unique name for this compute node within the pipeline.
taskName (string) --
The name of the task to execute for this compute node.
environmentVariables (dict) --
Environment variables specific to this compute node. These override pipeline-level environment variables with the same key.
(string) --
Environment variable name following POSIX naming rules Must not start with AWS_ prefix (case-insensitive)
(string) --
Environment variable value
dependsOn (list) --
A list of compute node names that must complete successfully before this node can start.
(string) --
Reusable resource name with alphanumeric, hyphen, and underscore characters.
status (dict) --
The current lifecycle status of the pipeline.
error (dict) --
Contains associated error information, if any.
code (string) --
The error code.
message (string) --
The error message.
state (string) --
The current status of the resource.
createdAt (datetime) --
The time the pipeline was created, in Unix epoch time.
updatedAt (datetime) --
The time the pipeline was last updated, in Unix epoch time.
Updates an existing task in the specified workspace. Only the fields provided in the request are updated; fields not included in the request are preserved unchanged.
See also: AWS API Documentation
Request Syntax
client.update_task(
workspaceName='string',
taskName='string',
description='string',
taskConfiguration={
'containerTaskConfiguration': {
'ecrUri': 'string',
'taskExecutionRole': 'string',
'processingType': 'GENERIC_COMPUTE_PROCESSING'|'HARDWARE_ACCELERATED_PROCESSING',
'processingUnit': 'UNITS_2'|'UNITS_4'|'UNITS_8'|'UNITS_12'|'UNITS_16'|'UNITS_24'|'UNITS_32'|'UNITS_36'|'UNITS_48'|'UNITS_60'|'UNITS_64'|'UNITS_72'|'UNITS_84'|'UNITS_96',
'command': [
'string',
],
'timeoutSeconds': 123,
'environmentVariables': {
'string': 'string'
}
}
}
)
string
[REQUIRED]
The name of the workspace.
string
[REQUIRED]
The name of the task to update.
string
A new description for the task.
dict
The updated task execution configuration.
containerTaskConfiguration (dict) --
Configuration for running a custom container image on managed compute.
ecrUri (string) -- [REQUIRED]
The Amazon ECR image URI for the task container.
taskExecutionRole (string) -- [REQUIRED]
The ARN of the IAM role that grants the containerized workload permissions to access AWS resources.
processingType (string) -- [REQUIRED]
The processing type for compute resources.
processingUnit (string) -- [REQUIRED]
The processing unit allocation that determines the vCPU, memory, and GPU resources.
command (list) --
The command to execute in the container.
(string) --
timeoutSeconds (integer) --
The timeout in seconds for task execution. Default: 3600 (1 hour).
environmentVariables (dict) --
Environment variables passed to the container at runtime.
(string) --
Environment variable name following POSIX naming rules Must not start with AWS_ prefix (case-insensitive)
(string) --
Environment variable value
dict
Response Syntax
{
'version': 'string',
'status': {
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
'message': 'string'
},
'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED'
}
}
Response Structure
(dict) --
Response structure for UpdateTask operation.
version (string) --
The new version of the task created by this update.
status (dict) --
The current lifecycle status of the task.
error (dict) --
Contains associated error information, if any.
code (string) --
The error code.
message (string) --
The error message.
state (string) --
The current status of the resource.
Lists pipelines in a workspace. To get complete details about a pipeline, use DescribePipeline.
See also: AWS API Documentation
Request Syntax
client.list_pipelines(
workspaceName='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The name of the workspace.
string
The token to be used for the next set of paginated results.
integer
The maximum number of results to return for each paginated request. Default: 50.
dict
Response Syntax
{
'pipelineSummaries': [
{
'pipelineName': 'string',
'description': 'string',
'pipelineArn': 'string',
'version': 'string',
'status': {
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
'message': 'string'
},
'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED'
},
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Response structure for ListPipelines operation.
pipelineSummaries (list) --
A list that summarizes each pipeline in the workspace.
(dict) --
Contains summary information about a pipeline.
pipelineName (string) --
The name of the pipeline.
description (string) --
The description of the pipeline.
pipelineArn (string) --
The ARN of the pipeline.
version (string) --
The version of the pipeline.
status (dict) --
The current lifecycle status of the pipeline.
error (dict) --
Contains associated error information, if any.
code (string) --
The error code.
message (string) --
The error message.
state (string) --
The current status of the resource.
createdAt (datetime) --
The time the pipeline was created, in Unix epoch time.
updatedAt (datetime) --
The time the pipeline was last updated, in Unix epoch time.
nextToken (string) --
The token to be used for the next set of paginated results.
Lists pipeline executions for a specific pipeline in a workspace. Supports filtering by state and time range. State can be combined with either startTime or endTime filters. Time range filters are grouped: use startTime filters (startTimeAfter, startTimeBefore) or endTime filters (endTimeAfter, endTimeBefore), but not both. Combining startTime and endTime filters returns an InvalidRequestException. Note: endTime filters only return executions in terminal states, as in-progress executions have no endTime.
See also: AWS API Documentation
Request Syntax
client.list_pipeline_executions(
workspaceName='string',
pipelineName='string',
nextToken='string',
maxResults=123,
state='NOT_STARTED'|'RUNNING'|'SUCCEEDED'|'FAILED'|'CANCELLING'|'CANCELLED',
startTimeAfter=datetime(2015, 1, 1),
startTimeBefore=datetime(2015, 1, 1),
endTimeAfter=datetime(2015, 1, 1),
endTimeBefore=datetime(2015, 1, 1)
)
string
[REQUIRED]
The name of the workspace.
string
[REQUIRED]
The name of the pipeline.
string
The token to be used for the next set of paginated results.
integer
The maximum number of results to return per request. This is an upper bound; the actual number of results may be less. Default: 50.
string
Filter by execution state. If not specified, executions in all states are returned.
datetime
Inclusive lower bound on execution start time (ISO-8601). Only executions with startTime >= startTimeAfter are returned. Cannot be combined with endTimeAfter or endTimeBefore.
datetime
Exclusive upper bound on execution start time (ISO-8601). Only executions with startTime < startTimeBefore are returned. Cannot be combined with endTimeAfter or endTimeBefore.
datetime
Inclusive lower bound on execution end time (ISO-8601). Only executions with endTime >= endTimeAfter are returned. Cannot be combined with startTimeAfter or startTimeBefore. Only matches executions in terminal states.
datetime
Exclusive upper bound on execution end time (ISO-8601). Only executions with endTime < endTimeBefore are returned. Cannot be combined with startTimeAfter or startTimeBefore. Only matches executions in terminal states.
dict
Response Syntax
{
'pipelineExecutionSummaries': [
{
'pipelineExecutionId': 'string',
'pipelineVersion': 'string',
'status': {
'state': 'NOT_STARTED'|'RUNNING'|'SUCCEEDED'|'FAILED'|'CANCELLING'|'CANCELLED',
'stateDetails': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'EXECUTION_ERROR'|'TIMED_OUT',
'message': 'string',
'details': [
{
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'EXECUTION_ERROR'|'TIMED_OUT',
'message': 'string'
},
]
}
},
'executionPriority': 123,
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Response structure for ListPipelineExecutions operation.
pipelineExecutionSummaries (list) --
A list that summarizes each pipeline execution.
(dict) --
Contains summary information about a pipeline execution.
pipelineExecutionId (string) --
The unique identifier of the pipeline execution.
pipelineVersion (string) --
The pipeline version this execution ran against.
status (dict) --
The current execution status of the pipeline.
state (string) --
Current state of the pipeline execution.
stateDetails (dict) --
Additional information about the execution outcome. Populated when the execution has terminated (failed or cancelled).
code (string) --
Classification of the failure. Present when the execution failed.
message (string) --
Human-readable description of the outcome. For a failed execution, this describes why it failed; for a cancelled execution, this is the reason you supplied when calling CancelPipelineExecution.
details (list) --
Per-step error entries to help diagnose a failed execution. Present when the execution failed.
(dict) --
Contains a detailed error entry for granular troubleshooting of pipeline failures.
code (string) --
The error code.
message (string) --
The associated error message.
executionPriority (integer) --
Scheduling priority for the execution. When not specified, defaults to lowest priority.
startTime (datetime) --
The time the pipeline execution started, in Unix epoch time.
endTime (datetime) --
The time the pipeline execution completed, in Unix epoch time.
nextToken (string) --
The token to be used for the next set of paginated results.
Retrieves information about a query, including its status.
See also: AWS API Documentation
Request Syntax
client.describe_query(
workspaceName='string',
queryId='string'
)
string
[REQUIRED]
The name of the workspace associated with the query.
string
[REQUIRED]
The unique identifier for the query execution.
dict
Response Syntax
{
'queryId': 'string',
'status': 'SUBMITTED'|'RUNNING'|'COMPLETED'|'FAILED'|'CANCELED'|'CANCELING',
'submittedAt': datetime(2015, 1, 1),
'completedAt': datetime(2015, 1, 1),
'statistics': {
'rowCount': 123,
'bytesScanned': 123,
'executionTimeInMillis': 123
},
'errorMessage': 'string'
}
Response Structure
(dict) --
Contains the response for the DescribeQuery operation.
queryId (string) --
The unique identifier for the query execution.
status (string) --
The current query status.
submittedAt (datetime) --
The date and time when the query was submitted, in Unix epoch time.
completedAt (datetime) --
The date and time when the query reached a terminal state, in Unix epoch time. This field is present when the query status is COMPLETED, FAILED, or CANCELED.
statistics (dict) --
The query execution statistics. This field is present when the query status is COMPLETED.
rowCount (integer) --
The total number of rows returned by the query.
bytesScanned (integer) --
The total number of bytes scanned during query execution.
executionTimeInMillis (integer) --
The total query execution time, in milliseconds.
errorMessage (string) --
A human-readable error description. This field is present when the query status is FAILED.
Starts an asynchronous SQL query against workspace telemetry, annotations, data segment, and dataset data.
See also: AWS API Documentation
Request Syntax
client.start_query(
clientToken='string',
workspaceName='string',
queryStatement='string'
)
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.
string
[REQUIRED]
The name of the workspace to query.
string
[REQUIRED]
The SQL query to execute against the workspace telemetry, annotations, data segment, and dataset data.
dict
Response Syntax
{
'queryId': 'string',
'status': 'SUBMITTED'|'RUNNING'|'COMPLETED'|'FAILED'|'CANCELED'|'CANCELING'
}
Response Structure
(dict) --
Contains the response for the StartQuery operation.
queryId (string) --
The unique identifier for the query execution.
status (string) --
The initial query status. The value is always SUBMITTED upon creation.
Retrieves a paginated list of dataset export jobs for a workspace.
See also: AWS API Documentation
Request Syntax
client.list_dataset_export_jobs(
workspaceName='string',
filter='ALL'|'SUBMITTED'|'RUNNING'|'COMPLETED'|'COMPLETED_WITH_ERRORS'|'FAILED',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The name of the workspace whose dataset export jobs should be listed.
string
The optional filter that returns only jobs matching the given filter value. Defaults to ALL.
integer
The maximum number of results to return for each paginated request.
string
The token to be used for the next set of paginated results.
dict
Response Syntax
{
'jobs': [
{
'jobId': 'string',
'status': 'SUBMITTED'|'RUNNING'|'COMPLETED'|'COMPLETED_WITH_ERRORS'|'FAILED',
'startedAt': datetime(2015, 1, 1),
'completedAt': datetime(2015, 1, 1),
'destinationS3Uri': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Response for list dataset export jobs request.
jobs (list) --
A list of dataset export job summaries.
(dict) -- <p>Contains summary information about a dataset export job.</p>
jobId (string) -- <p>The unique identifier for the dataset export job.</p>
status (string) -- <p>The current status of the dataset export job.</p>
startedAt (datetime) -- <p>The timestamp when the job started processing.</p>
completedAt (datetime) -- <p>The timestamp when the job completed, or null if the job is still running.</p>
destinationS3Uri (string) -- <p>The S3 URI where output clips are written.</p>
nextToken (string) --
The token for the next set of results, or null if there are no additional results.
Retrieves a paginated list of workspaces. Use the nextToken parameter to retrieve additional results.
See also: AWS API Documentation
Request Syntax
client.list_workspaces(
nextToken='string',
maxResults=123
)
string
The token to be used for the next set of paginated results.
integer
The maximum number of results to return for each paginated request. Default: 50.
dict
Response Syntax
{
'workspaceSummaries': [
{
'name': 'string',
'arn': 'string',
'status': {
'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED',
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
'message': 'string'
}
},
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
workspaceSummaries (list) --
A list that summarizes each workspace.
(dict) --
Contains summary information about a workspace, including its name, ARN, status, and creation and update timestamps.
name (string) --
The name of the workspace.
arn (string) --
The ARN of the workspace.
status (dict) --
The status of the workspace.
state (string) --
The current state of the workspace.
error (dict) --
Contains associated error information, if any.
code (string) --
The error code.
message (string) --
The error message.
createdAt (datetime) --
The date the workspace was created, in Unix epoch time.
updatedAt (datetime) --
The date the workspace 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.
Disassociates a batch of data segments from a curated dataset. Disassociating a data segment doesn't delete the underlying data in the source session dataset.
See also: AWS API Documentation
Request Syntax
client.batch_disassociate_data_segments_from_dataset(
datasetId='string',
workspaceName='string',
disassociateDataSegmentEntries=[
{
'sourceDatasetId': 'string',
'timeSeriesId': 'string',
'startTimestamp': {
'timeInSeconds': 123,
'offsetInNanos': 123
},
'endTimestamp': {
'timeInSeconds': 123,
'offsetInNanos': 123
}
},
],
clientToken='string'
)
string
[REQUIRED]
The ID of the curated dataset to disassociate data segments from.
string
[REQUIRED]
The name of the workspace that contains the dataset.
list
[REQUIRED]
The list of data segment entries to disassociate from the dataset.
(dict) --
Contains information about a data segment entry to disassociate from a dataset.
sourceDatasetId (string) -- [REQUIRED]
The ID of the source dataset that contains the data segment.
timeSeriesId (string) -- [REQUIRED]
The ID of the time series.
startTimestamp (dict) -- [REQUIRED]
The nanosecond-precision start time of the data segment to disassociate.
timeInSeconds (integer) -- [REQUIRED]
The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.
offsetInNanos (integer) --
The nanosecond offset from timeInSeconds.
endTimestamp (dict) -- [REQUIRED]
The nanosecond-precision end time of the data segment to disassociate.
timeInSeconds (integer) -- [REQUIRED]
The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.
offsetInNanos (integer) --
The nanosecond offset from timeInSeconds.
string
A unique, case-sensitive identifier that you provide to ensure that the request is idempotent. If you retry a request that completed successfully using the same client token, the retry succeeds without performing any further actions.
This field is autopopulated if not provided.
dict
Response Syntax
{
'datasetId': 'string',
'datasetVersion': 'string',
'failedDisassociations': [
{
'sourceDatasetId': 'string',
'timeSeriesId': 'string',
'startTimestamp': {
'timeInSeconds': 123,
'offsetInNanos': 123
},
'endTimestamp': {
'timeInSeconds': 123,
'offsetInNanos': 123
},
'errorCode': 'INTERNAL_FAILURE'|'VALIDATION_ERROR'|'RESOURCE_NOT_FOUND'|'LIMIT_EXCEEDED'|'CONFLICTING_OPERATION',
'errorMessage': 'string'
},
]
}
Response Structure
(dict) --
datasetId (string) --
The ID of the dataset.
datasetVersion (string) --
The version of the dataset after disassociation.
failedDisassociations (list) --
A list of data segment disassociations that failed.
(dict) --
Contains error information for a data segment disassociation that failed.
sourceDatasetId (string) --
The ID of the source dataset.
timeSeriesId (string) --
The ID of the time series.
startTimestamp (dict) --
The nanosecond-precision start time of the data segment.
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.
endTimestamp (dict) --
The nanosecond-precision end time of the data segment.
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.
errorCode (string) --
The error code for the failed disassociation.
errorMessage (string) --
The error message for the failed disassociation.
Retrieves video data for a specific time range.
See also: AWS API Documentation
Request Syntax
client.get_capture_data(
workspaceName='string',
startTime={
'timeInSeconds': 123,
'offsetInNanos': 123
},
endTime={
'timeInSeconds': 123,
'offsetInNanos': 123
},
timeSeriesId='string',
propertyAlias='string',
formatSettings={
'framesPerSecond': 123,
'widthInPixels': 123,
'heightInPixels': 123
},
nextToken='string'
)
string
[REQUIRED]
The name of the workspace that contains the capture source.
dict
[REQUIRED]
The start time for the video data range.
timeInSeconds (integer) -- [REQUIRED]
The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.
offsetInNanos (integer) --
The nanosecond offset from timeInSeconds.
dict
[REQUIRED]
The end time for the video data range. Must be greater than startTime.
timeInSeconds (integer) -- [REQUIRED]
The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.
offsetInNanos (integer) --
The nanosecond offset from timeInSeconds.
string
The time series ID that identifies the capture source. Mutually exclusive with propertyAlias.
string
The property alias that identifies the capture source. Mutually exclusive with timeSeriesId.
dict
The optional format settings for the output.
framesPerSecond (integer) -- <p>The target frame rate for the output.</p>
widthInPixels (integer) -- <p>The target width of the output, in pixels.</p>
heightInPixels (integer) -- <p>The target height of the output, in pixels.</p>
string
The token from a previous response used to continue retrieving data.
dict
Response Syntax
{
'data': b'bytes',
'startTime': {
'timeInSeconds': 123,
'offsetInNanos': 123
},
'endTime': {
'timeInSeconds': 123,
'offsetInNanos': 123
},
'dataType': 'VIDEO-MP4',
'nextToken': 'string'
}
Response Structure
(dict) --
Response containing the video data.
data (bytes) --
The binary video data.
startTime (dict) --
The actual start time of the returned data.
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.
endTime (dict) --
The actual end time of the returned data.
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.
dataType (string) --
The type of the returned data.
nextToken (string) --
The token used to retrieve the next chunk. Absent if no more data is available.
Retrieves information about a workspace.
See also: AWS API Documentation
Request Syntax
client.describe_workspace(
workspaceName='string'
)
string
[REQUIRED]
The name of the workspace.
dict
Response Syntax
{
'workspaceArn': 'string',
'workspaceName': 'string',
'workspaceDescription': 'string',
'workspaceStatus': {
'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED',
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
'message': 'string'
}
},
'encryptionConfiguration': {
'encryptionType': 'SITEWISE_DEFAULT_ENCRYPTION'|'KMS_BASED_ENCRYPTION',
'kmsKeyArn': 'string'
},
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
workspaceArn (string) --
The ARN of the workspace.
workspaceName (string) --
The name of the workspace.
workspaceDescription (string) --
The description of the workspace.
workspaceStatus (dict) --
The status of the workspace, which contains the state and any error message.
state (string) --
The current state of the workspace.
error (dict) --
Contains associated error information, if any.
code (string) --
The error code.
message (string) --
The error message.
encryptionConfiguration (dict) --
The encryption configuration information for the workspace.
encryptionType (string) --
The type of encryption used for the workspace.
kmsKeyArn (string) --
The key ARN of the KMS key used for KMS encryption if encryptionType is KMS_BASED_ENCRYPTION.
createdAt (datetime) --
The date the workspace was created, in Unix epoch time.
updatedAt (datetime) --
The date the workspace was last updated, in Unix epoch time.
Cancels a pipeline execution in the specified workspace. If the execution is not in a terminal state (such as NOT_STARTED or RUNNING), it transitions to CANCELLING and asynchronously to CANCELLED. This operation is idempotent: calling it on an execution that is already CANCELLING or CANCELLED returns success with the current state. Calling it on a terminal execution (SUCCEEDED or FAILED) returns a conflict error. You can optionally provide a reason; it is returned in the stateDetails field when you describe the execution.
See also: AWS API Documentation
Request Syntax
client.cancel_pipeline_execution(
workspaceName='string',
pipelineName='string',
pipelineExecutionId='string',
reason='string'
)
string
[REQUIRED]
The name of the workspace.
string
[REQUIRED]
The name of the pipeline.
string
[REQUIRED]
The unique identifier of the pipeline execution.
string
A message describing why the pipeline execution is being cancelled.
dict
Response Syntax
{
'state': 'NOT_STARTED'|'RUNNING'|'SUCCEEDED'|'FAILED'|'CANCELLING'|'CANCELLED'
}
Response Structure
(dict) --
Response structure for CancelPipelineExecution operation.
state (string) --
The current execution state of the pipeline. Can only be CANCELLING or CANCELLED.
Lists enrichment jobs within a workspace with optional filtering and pagination. Results are ordered by createdAt timestamp descending (newest first).
Filtering
Combine filters to narrow results:
datasetId: Filter by dataset
propertyAlias OR timeSeriesId: Filter by time series (specify one, not both)
status: Filter by job status (e.g., RUNNING to find active jobs)
jobType: Filter by enrichment type (currently only EVENT_DETECTION)
startDate and endDate: Filter by job creation time range
Important Constraints
You must specify either propertyAlias OR timeSeriesId, but not both
Attempting to specify both results in an InvalidRequestException
Date filters use ISO 8601 format
startDate is exclusive, endDate is inclusive
Pagination
The operation returns up to maxResults jobs per page (default 50). If more results exist, the response includes a nextToken. Submit this token in a subsequent request to retrieve the next page.
Common Use Cases
Find all running jobs: Filter by status=RUNNING
List recent jobs for a dataset: Filter by datasetId with optional date range
Monitor jobs for a specific sensor: Filter by propertyAlias or timeSeriesId
Track all event detection jobs: Filter by jobType=EVENT_DETECTION
Performance
Performance is optimal when filtering by supported fields (datasetId, propertyAlias, timeSeriesId, status, jobType).
See also: AWS API Documentation
Request Syntax
client.list_enrichment_jobs(
workspaceName='string',
datasetId='string',
propertyAlias='string',
timeSeriesId='string',
status='PENDING'|'RUNNING'|'COMPLETED'|'FAILED'|'TIMED_OUT'|'CANCELLED',
jobType='EVENT_DETECTION',
startDate=datetime(2015, 1, 1),
endDate=datetime(2015, 1, 1),
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The name of the IoT SiteWise workspace to list enrichment jobs from.
string
Filter jobs by dataset ID. Returns only jobs analyzing data from the specified dataset.
string
Filter by property alias (human-readable sensor name). Specify either propertyAlias or timeSeriesId, but not both. Returns only jobs analyzing the specified property alias.
string
Filter by time series ID (system identifier). Specify either timeSeriesId or propertyAlias, but not both. Returns only jobs analyzing the specified time series.
string
Filter by job status. Returns only jobs in the specified status. Use RUNNING to find active jobs, or FAILED to identify jobs requiring attention.
string
Filter by enrichment job type. Currently only EVENT_DETECTION is supported. Use this filter to future-proof queries when additional job types are added.
datetime
The exclusive start of the date range for filtering jobs by creation time. Jobs created after this timestamp are included. Use ISO 8601 format (e.g., 2024-01-01T00:00:00Z).
datetime
The inclusive end of the date range for filtering jobs by creation time. Jobs created on or before this timestamp are included. Use ISO 8601 format (e.g., 2024-01-31T23:59:59Z).
integer
Maximum number of jobs to return per page. Defaults to 50 if not specified. Use smaller values for faster responses, larger values to reduce API calls.
string
Pagination token from a previous ListEnrichmentJobs response. Include this token to retrieve the next page of results. Omit for the first request.
dict
Response Syntax
{
'jobs': [
{
'jobId': 'string',
'status': 'PENDING'|'RUNNING'|'COMPLETED'|'FAILED'|'TIMED_OUT'|'CANCELLED',
'workspaceName': 'string',
'jobType': 'EVENT_DETECTION',
'datasetId': 'string',
'propertyAlias': 'string',
'timeSeriesId': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
jobs (list) --
Array of job summaries matching the filter criteria, ordered by creation time descending (newest first). Each summary includes key identifiers (jobId, datasetId, propertyAlias/timeSeriesId) and status information without the full job configuration. Use DescribeEnrichmentJob to retrieve complete details.
(dict) --
Summary information for an enrichment job returned by ListEnrichmentJobs. This lightweight representation includes identifiers, status, and key metadata without the full job configuration.
Use DescribeEnrichmentJob to retrieve:
Complete job configuration (trim settings, full parameters)
Detailed timestamps (completedAt, cancelledAt)
Failure messages for failed jobs
The summary is optimized for display in lists and dashboards, providing enough information to identify and filter jobs without the overhead of full configuration details.
jobId (string) --
Unique identifier for the enrichment job.
status (string) --
Current status of the job: PENDING, RUNNING, COMPLETED, FAILED, TIMED_OUT, or CANCELLED. Use this to quickly identify active jobs or jobs requiring attention.
workspaceName (string) --
The name of the IoT SiteWise workspace containing this job.
jobType (string) --
The type of enrichment job. Currently EVENT_DETECTION is the only supported type.
datasetId (string) --
The dataset being enriched. Useful for filtering and identifying jobs without fetching the full configuration. This allows you to quickly find all jobs related to a specific dataset.
propertyAlias (string) --
The property alias (human-readable sensor name) of the time series being enriched. Present when the job was created using a propertyAlias. Use this to identify which sensor the job analyzes.
timeSeriesId (string) --
The system identifier of the time series being enriched. Present when the job was created using a timeSeriesId. Use this to identify which time series the job analyzes.
createdAt (datetime) --
Timestamp when the job was created in ISO 8601 format.
updatedAt (datetime) --
Timestamp of the last job status change in ISO 8601 format. Use this to track recent activity and identify stale jobs. For active jobs, this shows the last time the job transitioned to a new status.
nextToken (string) --
Pagination token to retrieve the next page of results. If present, more jobs exist that match the filter criteria. Include this token in a subsequent ListEnrichmentJobs request to retrieve the next page. If absent, you have retrieved all matching jobs.
Retrieves a paginated list of queries for a workspace.
See also: AWS API Documentation
Request Syntax
client.list_queries(
workspaceName='string',
filter='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The name of the workspace to list queries for.
string
An optional filter to return only queries with the specified status. The value must be one of the supported query statuses: SUBMITTED, RUNNING, COMPLETED, FAILED, CANCELED, or CANCELING.
integer
The maximum number of results to return for each paginated request.
string
The token to be used for the next set of paginated results.
dict
Response Syntax
{
'queries': [
{
'queryId': 'string',
'status': 'SUBMITTED'|'RUNNING'|'COMPLETED'|'FAILED'|'CANCELED'|'CANCELING',
'submittedAt': datetime(2015, 1, 1),
'completedAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Contains the response for the ListQueries operation.
queries (list) --
A list of query summaries for the workspace.
(dict) --
Contains summary information about a query.
queryId (string) --
The unique identifier for the query execution.
status (string) --
The current query status.
submittedAt (datetime) --
The date and time when the query was submitted, in Unix epoch time.
completedAt (datetime) --
The date and time when the query reached a terminal state, in Unix epoch time.
nextToken (string) --
The token for the next set of results, or null if there are no additional results.
Retrieves detailed information about a specific task in a workspace.
See also: AWS API Documentation
Request Syntax
client.describe_task(
workspaceName='string',
taskName='string',
taskVersion='string'
)
string
[REQUIRED]
The name of the workspace.
string
[REQUIRED]
The name of the task.
string
The version number of the task to retrieve. If not specified, returns the latest version.
dict
Response Syntax
{
'workspaceName': 'string',
'taskName': 'string',
'description': 'string',
'taskArn': 'string',
'version': 'string',
'taskConfiguration': {
'containerTaskConfiguration': {
'ecrUri': 'string',
'taskExecutionRole': 'string',
'processingType': 'GENERIC_COMPUTE_PROCESSING'|'HARDWARE_ACCELERATED_PROCESSING',
'processingUnit': 'UNITS_2'|'UNITS_4'|'UNITS_8'|'UNITS_12'|'UNITS_16'|'UNITS_24'|'UNITS_32'|'UNITS_36'|'UNITS_48'|'UNITS_60'|'UNITS_64'|'UNITS_72'|'UNITS_84'|'UNITS_96',
'command': [
'string',
],
'timeoutSeconds': 123,
'environmentVariables': {
'string': 'string'
}
}
},
'status': {
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
'message': 'string'
},
'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED'
},
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
Response structure for DescribeTask operation.
workspaceName (string) --
The name of the workspace.
taskName (string) --
The name of the task.
description (string) --
The description of the task.
taskArn (string) --
The ARN of the task.
version (string) --
The version of the task.
taskConfiguration (dict) --
The task execution configuration. Contains a containerTaskConfiguration for custom container workloads.
containerTaskConfiguration (dict) --
Configuration for running a custom container image on managed compute.
ecrUri (string) --
The Amazon ECR image URI for the task container.
taskExecutionRole (string) --
The ARN of the IAM role that grants the containerized workload permissions to access AWS resources.
processingType (string) --
The processing type for compute resources.
processingUnit (string) --
The processing unit allocation that determines the vCPU, memory, and GPU resources.
command (list) --
The command to execute in the container.
(string) --
timeoutSeconds (integer) --
The timeout in seconds for task execution. Default: 3600 (1 hour).
environmentVariables (dict) --
Environment variables passed to the container at runtime.
(string) --
Environment variable name following POSIX naming rules Must not start with AWS_ prefix (case-insensitive)
(string) --
Environment variable value
status (dict) --
The current lifecycle status of the task.
error (dict) --
Contains associated error information, if any.
code (string) --
The error code.
message (string) --
The error message.
state (string) --
The current status of the resource.
createdAt (datetime) --
The time the task was created, in Unix epoch time.
updatedAt (datetime) --
The time the task was last updated, in Unix epoch time.
Creates a workspace in IoT SiteWise. A workspace isolates its resources, such as datasets, time series, pipelines, and tasks, and their data from other workspaces, and has its own quotas and throttling limits. You must specify an encryption configuration when you create a workspace. The operation returns immediately with the workspace in the CREATING state. Provisioning completes asynchronously, after which the workspace state is ACTIVE, or FAILED if provisioning doesn't complete.
See also: AWS API Documentation
Request Syntax
client.create_workspace(
workspaceName='string',
workspaceDescription='string',
encryptionConfiguration={
'encryptionType': 'SITEWISE_DEFAULT_ENCRYPTION'|'KMS_BASED_ENCRYPTION',
'kmsKeyId': 'string'
},
tags={
'string': 'string'
},
clientToken='string'
)
string
[REQUIRED]
The name of the workspace to create.
string
A description for the workspace.
dict
[REQUIRED]
The encryption configuration for the workspace.
encryptionType (string) -- [REQUIRED]
The encryption scheme for the workspace. SITEWISE_DEFAULT_ENCRYPTION encrypts data with the IoT SiteWise default key. KMS_BASED_ENCRYPTION encrypts data with the customer managed KMS key identified by kmsKeyId.
kmsKeyId (string) --
The customer managed KMS key used when encryptionType is KMS_BASED_ENCRYPTION. Accepts a key ID, key ARN, or key alias. Required for KMS_BASED_ENCRYPTION; must be omitted for SITEWISE_DEFAULT_ENCRYPTION. After a workspace's customer managed key configuration becomes active, the key can't be changed.
dict
A list of key-value pairs that contain metadata for the workspace. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.
(string) --
(string) --
string
A unique, case-sensitive identifier that you provide to ensure that the request is idempotent. If you retry a request that completed successfully using the same client token, the retry succeeds without performing any further actions.
This field is autopopulated if not provided.
dict
Response Syntax
{
'workspaceName': 'string',
'workspaceArn': 'string',
'workspaceStatus': {
'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED',
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
'message': 'string'
}
}
}
Response Structure
(dict) --
workspaceName (string) --
The name of the workspace.
workspaceArn (string) --
The ARN of the workspace.
workspaceStatus (dict) --
The status of the workspace, which is CREATING when the operation returns.
state (string) --
The current state of the workspace.
error (dict) --
Contains associated error information, if any.
code (string) --
The error code.
message (string) --
The error message.
Lists the searches in a workspace, most recently started first. Results can be narrowed with optional filters (status, search type, group, and started-at time range) and are paginated: when nextToken is present, pass it on a subsequent call to retrieve the next page.
See also: AWS API Documentation
Request Syntax
client.list_searches(
workspaceName='string',
maxResults=123,
nextToken='string',
listSearchesFilters={
'statusFilter': [
'QUEUED'|'RUNNING'|'SUCCEEDED'|'FAILED',
],
'startedAfter': datetime(2015, 1, 1),
'startedBefore': datetime(2015, 1, 1),
'groupIdFilter': [
'string',
],
'searchTypeFilter': [
'DEEP'|'QUICK',
]
}
)
string
[REQUIRED]
The name of the workspace whose searches are listed.
integer
The maximum number of searches to return in a single page. Valid range is 1 to 1,000; if omitted, a service-defined default is used.
string
The pagination token returned by a previous ListSearches call. Provide it to retrieve the next page; omit it to retrieve the first page.
dict
Optional filters that restrict which searches are returned.
statusFilter (list) --
Returns only searches whose status is one of the listed values.
(string) --
The lifecycle status of a search.
startedAfter (datetime) --
Returns only searches started at or after this time.
startedBefore (datetime) --
Returns only searches started at or before this time.
groupIdFilter (list) --
Returns only searches whose groupId is one of the listed values.
(string) --
A caller-supplied identifier used to group related searches together.
searchTypeFilter (list) --
Returns only searches whose searchType is one of the listed values.
(string) --
The search strategy, which trades off latency against recall. DEEP runs the full semantic and structured search for the highest-quality matches; QUICK returns faster, lower-recall results. When searchType is omitted on a request, the search defaults to QUICK.
dict
Response Syntax
{
'searchSummaries': [
{
'searchId': 'string',
'workspaceName': 'string',
'status': 'QUEUED'|'RUNNING'|'SUCCEEDED'|'FAILED',
'queryStatement': 'string',
'searchType': 'DEEP'|'QUICK',
'statusReason': 'string',
'startedAt': datetime(2015, 1, 1),
'groupId': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Output of the ListSearches operation.
searchSummaries (list) --
A page of search summaries, most recently started first.
(dict) --
A summary of a single search as returned by ListSearches.
searchId (string) --
The unique identifier of the search.
workspaceName (string) --
The name of the workspace the search runs against.
status (string) --
The current status of the search.
queryStatement (string) --
The natural-language query that was submitted for the search.
searchType (string) --
The search strategy used for the search.
statusReason (string) --
A human-readable explanation of the current status. Populated when the search has FAILED.
startedAt (datetime) --
The time at which the search was started.
groupId (string) --
The group identifier associated with the search, if one was supplied on the request.
nextToken (string) --
The pagination token to use in a subsequent ListSearches call to retrieve the next page. Absent when there are no more searches.
Retrieves detailed information about a specific enrichment job, including its current status, configuration, and timestamps.
Use Cases
Monitor job progress by checking status updates with DescribeEnrichmentJob
Retrieve the complete job configuration submitted during creation
Debug failed jobs by examining the failureMessage field
Track job lifecycle with creation, update, completion, and cancellation timestamps
Status Monitoring
Jobs progress through statuses: PENDING → RUNNING → terminal state
Terminal states:
COMPLETED: Job finished successfully; query IoT SiteWise for semantic search results
FAILED: Job encountered an error; check failureMessage for details
TIMED_OUT: Job exceeded maximum processing time
CANCELLED: Job was cancelled via CancelEnrichmentJob
Response Fields
The response includes:
Current job status and type
Full job configuration as originally submitted
Lifecycle timestamps (created, updated, completed, cancelled)
Failure details if status is FAILED
See also: AWS API Documentation
Request Syntax
client.describe_enrichment_job(
workspaceName='string',
jobId='string'
)
string
[REQUIRED]
The name of the IoT SiteWise workspace containing the enrichment job.
string
[REQUIRED]
The unique identifier of the enrichment job to retrieve. This is the jobId returned by CreateEnrichmentJob.
dict
Response Syntax
{
'jobId': 'string',
'status': 'PENDING'|'RUNNING'|'COMPLETED'|'FAILED'|'TIMED_OUT'|'CANCELLED',
'workspaceName': 'string',
'jobType': 'EVENT_DETECTION',
'jobConfiguration': {
'eventDetection': {
'datasetId': 'string',
'timeSeriesId': 'string',
'propertyAlias': 'string',
'trimSettings': {
'startTime': {
'timeInSeconds': 123,
'offsetInNanos': 123
},
'endTime': {
'timeInSeconds': 123,
'offsetInNanos': 123
}
}
}
},
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'completedAt': datetime(2015, 1, 1),
'cancelledAt': datetime(2015, 1, 1),
'failureMessage': 'string'
}
Response Structure
(dict) --
jobId (string) --
The unique identifier of the enrichment job.
status (string) --
Current status of the enrichment job. Possible values:
PENDING: Job is waiting to start processing
RUNNING: Job is actively processing video data
COMPLETED: Job finished successfully; embeddings available in IoT SiteWise
FAILED: Job encountered an error; see failureMessage for details
TIMED_OUT: Job exceeded maximum processing time limit
CANCELLED: Job was cancelled by user request
workspaceName (string) --
The name of the IoT SiteWise workspace containing the job.
jobType (string) --
The type of enrichment job, derived from the job configuration. Currently EVENT_DETECTION is the only supported type.
jobConfiguration (dict) --
The complete job configuration as originally submitted, including the analysis type and parameters. For event detection jobs, this includes the dataset ID, time series identifier, and trim settings defining the analysis time range.
eventDetection (dict) --
Event detection configuration that generates embeddings from video time-series data enabling natural language similarity search on events. The service processes video data and creates embeddings stored in IoT SiteWise for semantic querying.
datasetId (string) -- <p>The IoT SiteWise dataset ID containing the video time-series data to analyze. Query IoT SiteWise to discover available datasets in your workspace.</p>
timeSeriesId (string) -- <p>Unique system identifier for the video time series to analyze. Specify either timeSeriesId or propertyAlias, but not both. Use this when you have the system-generated time series identifier from IoT SiteWise.</p>
propertyAlias (string) -- <p>Human-readable alias for the video time series to analyze (e.g., /camera/warehouse/zone-a). Specify either propertyAlias or timeSeriesId, but not both. Use this when you have configured friendly aliases in IoT SiteWise for better readability.</p>
trimSettings (dict) -- <p>Time range settings defining which portion of the video time-series data to process. Required to ensure predictable processing time and prevent analyzing unbounded datasets. Start and end times must be within the dataset's time bounds.</p>
startTime (dict) -- <p>Start time for the video analysis time range in nanoseconds since Unix epoch (TimeInNanos format). Data segments at or after this time are included in the enrichment. Must be within the dataset's time bounds.</p> <p>Example (JavaScript): Date.parse('2024-01-01T00:00:00Z') * 1000000 Example (Python): int(datetime.timestamp() * 1e9)</p>
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.
endTime (dict) -- <p>End time for the video analysis time range in nanoseconds since Unix epoch (TimeInNanos format). Data segments at or before this time are included in the enrichment. Must be greater than startTime and within the dataset's time bounds.</p>
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.
createdAt (datetime) --
Timestamp when the enrichment job was created in ISO 8601 format.
updatedAt (datetime) --
Timestamp when the job status was last updated in ISO 8601 format. Useful for tracking recent activity.
completedAt (datetime) --
Timestamp when the job completed successfully in ISO 8601 format. Only present if status is COMPLETED.
cancelledAt (datetime) --
Timestamp when the job was cancelled in ISO 8601 format. Only present if status is CANCELLED.
failureMessage (string) --
Human-readable error message explaining why the job failed. Only present if status is FAILED. Use this information to diagnose configuration issues, permission problems, or data processing errors.
Deletes an application by ID
See also: AWS API Documentation
Request Syntax
client.delete_application(
workspaceName='string',
id='string'
)
string
[REQUIRED]
Name of the workspace to associate with the underlying Application
string
[REQUIRED]
ID of the Application to delete
dict
Response Syntax
{}
Response Structure
(dict) --
Deletes a batch of data segments from a session dataset. Deleting a data segment deletes the underlying time series data for the segment's time range.
See also: AWS API Documentation
Request Syntax
client.batch_delete_dataset_data_segments(
datasetId='string',
workspaceName='string',
deleteDataSegmentEntries=[
{
'timeSeriesId': 'string',
'startTimestamp': {
'timeInSeconds': 123,
'offsetInNanos': 123
},
'endTimestamp': {
'timeInSeconds': 123,
'offsetInNanos': 123
}
},
],
clientToken='string'
)
string
[REQUIRED]
The ID of the session dataset from which to delete data segments.
string
[REQUIRED]
The name of the workspace that contains the dataset.
list
[REQUIRED]
The list of data segment entries to delete.
(dict) --
Contains information about a data segment entry to delete.
timeSeriesId (string) -- [REQUIRED]
The ID of the time series.
startTimestamp (dict) -- [REQUIRED]
The nanosecond-precision start time of the data segment to delete.
timeInSeconds (integer) -- [REQUIRED]
The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.
offsetInNanos (integer) --
The nanosecond offset from timeInSeconds.
endTimestamp (dict) -- [REQUIRED]
The nanosecond-precision end time of the data segment to delete.
timeInSeconds (integer) -- [REQUIRED]
The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.
offsetInNanos (integer) --
The nanosecond offset from timeInSeconds.
string
A unique, case-sensitive identifier that you provide to ensure that the request is idempotent. If you retry a request that completed successfully using the same client token, the retry succeeds without performing any further actions.
This field is autopopulated if not provided.
dict
Response Syntax
{
'datasetId': 'string',
'datasetVersion': 'string',
'errors': [
{
'timeSeriesId': 'string',
'startTimestamp': {
'timeInSeconds': 123,
'offsetInNanos': 123
},
'endTimestamp': {
'timeInSeconds': 123,
'offsetInNanos': 123
},
'errorCode': 'INTERNAL_FAILURE'|'VALIDATION_ERROR'|'RESOURCE_NOT_FOUND'|'LIMIT_EXCEEDED'|'CONFLICTING_OPERATION',
'errorMessage': 'string'
},
]
}
Response Structure
(dict) --
datasetId (string) --
The ID of the dataset.
datasetVersion (string) --
The version of the dataset after deletion.
errors (list) --
A list of data segment deletions that failed.
(dict) --
Contains error information for a data segment deletion that failed.
timeSeriesId (string) --
The ID of the time series.
startTimestamp (dict) --
The nanosecond-precision start time of the data segment.
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.
endTimestamp (dict) --
The nanosecond-precision end time of the data segment.
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.
errorCode (string) --
The error code for the failed deletion.
errorMessage (string) --
The error message for the failed deletion.
Lists tasks in a workspace. To get complete details about a task, use DescribeTask.
See also: AWS API Documentation
Request Syntax
client.list_tasks(
workspaceName='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The name of the workspace.
string
The token to be used for the next set of paginated results.
integer
The maximum number of results to return for each paginated request. Default: 50.
dict
Response Syntax
{
'taskSummaries': [
{
'taskName': 'string',
'description': 'string',
'taskArn': 'string',
'version': 'string',
'status': {
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
'message': 'string'
},
'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED'
},
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Response structure for ListTasks operation.
taskSummaries (list) --
A list that summarizes each task in the workspace.
(dict) --
Contains summary information about a task.
taskName (string) --
The name of the task.
description (string) --
The description of the task.
taskArn (string) --
The ARN of the task.
version (string) --
The version of the task.
status (dict) --
The current lifecycle status of the task.
error (dict) --
Contains associated error information, if any.
code (string) --
The error code.
message (string) --
The error message.
state (string) --
The current status of the resource.
createdAt (datetime) --
The time the task was created, in Unix epoch time.
updatedAt (datetime) --
The time the task was last updated, in Unix epoch time.
nextToken (string) --
The token to be used for the next set of paginated results.
Creates an asynchronous enrichment job to analyze time-series sensor data. The operation returns immediately with job details while processing continues in the background.
Idempotency
Include a clientToken to make the operation idempotent. If you submit the same request with the same token within the idempotency window, you receive the original job details without creating a duplicate.
Prerequisites
Before creating a job, ensure:
The workspace is in ACTIVE state (not being deleted)
You have IAM permissions for the workspace, dataset, and time-series resources
You have KMS Decrypt permission on the workspace's customer-managed encryption key
No duplicate job (same workspace, dataset, property, and job type) is currently running
Workflow
Submit the job with configuration specifying which video data to analyze and the time range
Capture the jobId from the response
Use DescribeEnrichmentJob to monitor progress and check job status
When status reaches a terminal state (COMPLETED, FAILED, TIMED_OUT, CANCELLED), check results
For COMPLETED jobs, query IoT SiteWise for semantic search on video events
Error Handling
ConflictingOperationException: A duplicate job is already running for the same configuration
InvalidRequestException: Invalid parameters (e.g., both timeSeriesId and propertyAlias specified)
AccessDeniedException: Insufficient IAM or KMS permissions
LimitExceededException: Too many concurrent jobs or requests
See also: AWS API Documentation
Request Syntax
client.create_enrichment_job(
workspaceName='string',
jobConfiguration={
'eventDetection': {
'datasetId': 'string',
'timeSeriesId': 'string',
'propertyAlias': 'string',
'trimSettings': {
'startTime': {
'timeInSeconds': 123,
'offsetInNanos': 123
},
'endTime': {
'timeInSeconds': 123,
'offsetInNanos': 123
}
}
}
},
clientToken='string'
)
string
[REQUIRED]
The name of the IoT SiteWise workspace containing the video data to analyze.
dict
[REQUIRED]
Configuration defining the type of enrichment analysis to perform and which video data to analyze. Currently supports eventDetection for generating embeddings from video data for semantic search.
eventDetection (dict) --
Event detection configuration that generates embeddings from video time-series data enabling natural language similarity search on events. The service processes video data and creates embeddings stored in IoT SiteWise for semantic querying.
datasetId (string) -- [REQUIRED] <p>The IoT SiteWise dataset ID containing the video time-series data to analyze. Query IoT SiteWise to discover available datasets in your workspace.</p>
timeSeriesId (string) -- <p>Unique system identifier for the video time series to analyze. Specify either timeSeriesId or propertyAlias, but not both. Use this when you have the system-generated time series identifier from IoT SiteWise.</p>
propertyAlias (string) -- <p>Human-readable alias for the video time series to analyze (e.g., /camera/warehouse/zone-a). Specify either propertyAlias or timeSeriesId, but not both. Use this when you have configured friendly aliases in IoT SiteWise for better readability.</p>
trimSettings (dict) -- [REQUIRED] <p>Time range settings defining which portion of the video time-series data to process. Required to ensure predictable processing time and prevent analyzing unbounded datasets. Start and end times must be within the dataset's time bounds.</p>
startTime (dict) -- [REQUIRED] <p>Start time for the video analysis time range in nanoseconds since Unix epoch (TimeInNanos format). Data segments at or after this time are included in the enrichment. Must be within the dataset's time bounds.</p> <p>Example (JavaScript): Date.parse('2024-01-01T00:00:00Z') * 1000000 Example (Python): int(datetime.timestamp() * 1e9)</p>
timeInSeconds (integer) -- [REQUIRED]
The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.
offsetInNanos (integer) --
The nanosecond offset from timeInSeconds.
endTime (dict) -- [REQUIRED] <p>End time for the video analysis time range in nanoseconds since Unix epoch (TimeInNanos format). Data segments at or before this time are included in the enrichment. Must be greater than startTime and within the dataset's time bounds.</p>
timeInSeconds (integer) -- [REQUIRED]
The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.
offsetInNanos (integer) --
The nanosecond offset from timeInSeconds.
string
Optional unique token that makes the operation idempotent. If you submit the same request with the same token within the idempotency window, the service returns the original job without creating a duplicate. Use a UUID or timestamp-based token for each unique request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'jobId': 'string',
'status': 'PENDING'|'RUNNING'|'COMPLETED'|'FAILED'|'TIMED_OUT'|'CANCELLED',
'createdAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
jobId (string) --
Unique identifier for the enrichment job. Use this ID with DescribeEnrichmentJob to monitor progress or with CancelEnrichmentJob to cancel the job.
status (string) --
Initial status of the enrichment job, typically PENDING. The job will transition to RUNNING when processing begins, then to a terminal state (COMPLETED, FAILED, TIMED_OUT, or CANCELLED). Use DescribeEnrichmentJob to track status changes.
createdAt (datetime) --
Timestamp when the enrichment job was created in ISO 8601 format.
Updates an existing pipeline in the specified workspace. Only the fields provided in the request are updated; fields not included in the request are preserved unchanged. You can update the pipeline description, environment variables, and the list of compute nodes independently.
See also: AWS API Documentation
Request Syntax
client.update_pipeline(
workspaceName='string',
pipelineName='string',
description='string',
environmentVariables={
'string': 'string'
},
computations=[
{
'computeNodeName': 'string',
'taskName': 'string',
'environmentVariables': {
'string': 'string'
},
'dependsOn': [
'string',
]
},
]
)
string
[REQUIRED]
The name of the workspace.
string
[REQUIRED]
The name of the pipeline to update.
string
A new description for the pipeline.
dict
Updated environment variables shared across all compute nodes.
(string) --
Environment variable name following POSIX naming rules Must not start with AWS_ prefix (case-insensitive)
(string) --
Environment variable value
list
Updated list of compute nodes forming the pipeline DAG.
(dict) --
A single compute node in a pipeline DAG. Each compute node references a task and can declare dependencies on other nodes.
computeNodeName (string) -- [REQUIRED]
The unique name for this compute node within the pipeline.
taskName (string) -- [REQUIRED]
The name of the task to execute for this compute node.
environmentVariables (dict) --
Environment variables specific to this compute node. These override pipeline-level environment variables with the same key.
(string) --
Environment variable name following POSIX naming rules Must not start with AWS_ prefix (case-insensitive)
(string) --
Environment variable value
dependsOn (list) --
A list of compute node names that must complete successfully before this node can start.
(string) --
Reusable resource name with alphanumeric, hyphen, and underscore characters.
dict
Response Syntax
{
'version': 'string',
'status': {
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
'message': 'string'
},
'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED'
}
}
Response Structure
(dict) --
Response structure for UpdatePipeline operation.
version (string) --
The new version of the pipeline created by this update.
status (dict) --
The current lifecycle status of the pipeline.
error (dict) --
Contains associated error information, if any.
code (string) --
The error code.
message (string) --
The error message.
state (string) --
The current status of the resource.
Retrieves the ranked results of a search, ordered by descending relevance score. Results are available only after the search has reached the SUCCEEDED status. Calling this on a search that exists but has not yet completed returns InvalidRequestException, while calling it on a search that does not exist returns ResourceNotFoundException. The response is paginated: when nextToken is present, pass it on a subsequent call to retrieve the next page.
See also: AWS API Documentation
Request Syntax
client.get_search_results(
searchId='string',
workspaceName='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The identifier of the search whose results are retrieved.
string
[REQUIRED]
The name of the workspace the search belongs to.
integer
The maximum number of results to return in a single page. Valid range is 1 to 10,000; if omitted, a service-defined default is used.
string
The pagination token returned by a previous GetSearchResults call. Provide it to retrieve the next page of results; omit it to retrieve the first page.
dict
Response Syntax
{
'searchResults': [
{
'searchId': 'string',
'workspaceName': 'string',
'datasetId': 'string',
'timeSeriesId': 'string',
'startTimestamp': {
'timeInSeconds': 123,
'offsetInNanos': 123
},
'endTimestamp': {
'timeInSeconds': 123,
'offsetInNanos': 123
},
'topTimestamp': {
'timeInSeconds': 123,
'offsetInNanos': 123
},
'score': ...
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Output of the GetSearchResults operation.
searchResults (list) --
A page of search results, ordered by descending relevance score.
(dict) --
A single matching segment of time-series data returned by a search.
searchId (string) --
The identifier of the search that produced this result.
workspaceName (string) --
The name of the workspace the search ran against.
datasetId (string) --
The identifier of the dataset that contains the matching data.
timeSeriesId (string) --
The identifier of the time series that contains the matching data.
startTimestamp (dict) --
The start of the matching time-series segment, in nanoseconds since the Unix epoch.
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.
endTimestamp (dict) --
The end of the matching time-series segment, in nanoseconds since the Unix epoch.
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.
topTimestamp (dict) --
The timestamp of the most relevant point within the matching segment, in nanoseconds since the Unix epoch.
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.
score (float) --
The relevance score of this result. Higher scores indicate a stronger match.
nextToken (string) --
The pagination token to use in a subsequent GetSearchResults call to retrieve the next page. Absent when there are no more results.
Retrieves a paginated list of existing applications
See also: AWS API Documentation
Request Syntax
client.list_applications(
maxResults=123,
nextToken='string'
)
integer
Maximum number of results to return
string
Next Page Token
dict
Response Syntax
{
'nextToken': 'string',
'applications': [
{
'arn': 'string',
'id': 'string',
'name': 'string',
'status': 'CREATING'|'ACTIVE'|'DELETING',
'createdAt': datetime(2015, 1, 1),
'workspaceName': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
Next Page Token
applications (list) --
List of applications
(dict) --
Summary of an application for list operations
arn (string) --
ARN of the application
id (string) --
Unique identifier of the application
name (string) --
Name of the application
status (string) --
Current status of the application
createdAt (datetime) --
Timestamp when the application was created
workspaceName (string) --
Name of the workspace this application belongs to
Returns the current status and metadata of a single search, including the query that was submitted, the search type, and — when the search has failed — the reason. Use this to poll a search started with StartSearch until it reaches a terminal status ( SUCCEEDED or FAILED).
See also: AWS API Documentation
Request Syntax
client.describe_search(
workspaceName='string',
searchId='string'
)
string
[REQUIRED]
The name of the workspace the search belongs to.
string
[REQUIRED]
The identifier of the search to describe.
dict
Response Syntax
{
'searchId': 'string',
'workspaceName': 'string',
'status': 'QUEUED'|'RUNNING'|'SUCCEEDED'|'FAILED',
'queryStatement': 'string',
'searchType': 'DEEP'|'QUICK',
'statusReason': 'string',
'startedAt': datetime(2015, 1, 1),
'groupId': 'string'
}
Response Structure
(dict) --
Output of the DescribeSearch operation.
searchId (string) --
The unique identifier of the search.
workspaceName (string) --
The name of the workspace the search runs against.
status (string) --
The current status of the search.
queryStatement (string) --
The natural-language query that was submitted for the search.
searchType (string) --
The search strategy used for the search.
statusReason (string) --
A human-readable explanation of the current status. Populated when the search has FAILED.
startedAt (datetime) --
The time at which the search was started.
groupId (string) --
The group identifier associated with the search, if one was supplied on the request.
Cancels a running query.
See also: AWS API Documentation
Request Syntax
client.cancel_query(
workspaceName='string',
queryId='string'
)
string
[REQUIRED]
The name of the workspace associated with the query.
string
[REQUIRED]
The unique identifier for the query execution to cancel.
dict
Response Syntax
{
'queryId': 'string',
'status': 'SUBMITTED'|'RUNNING'|'COMPLETED'|'FAILED'|'CANCELED'|'CANCELING'
}
Response Structure
(dict) --
Contains the response for the CancelQuery operation.
queryId (string) --
The unique identifier for the cancelled query.
status (string) --
The current query status.
Deletes a pipeline from the specified workspace. A pipeline cannot be deleted if it has any active executions. Wait for all executions to complete before attempting to delete the pipeline, or use CancelPipelineExecution to stop a running execution.
See also: AWS API Documentation
Request Syntax
client.delete_pipeline(
workspaceName='string',
pipelineName='string'
)
string
[REQUIRED]
The name of the workspace.
string
[REQUIRED]
The name of the pipeline to delete.
dict
Response Syntax
{
'status': {
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
'message': 'string'
},
'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED'
}
}
Response Structure
(dict) --
Response structure for DeletePipeline operation.
status (dict) --
The current lifecycle status of the pipeline.
error (dict) --
Contains associated error information, if any.
code (string) --
The error code.
message (string) --
The error message.
state (string) --
The current status of the resource.
Cancels a running or pending enrichment job. This is an idempotent operation—calling it multiple times with the same jobId is safe and returns the current status.
Behavior
Jobs in PENDING or RUNNING status transition to CANCELLED
Jobs in RUNNING state may not be cancellable once they have progressed to certain processing stages
Jobs already in terminal states (COMPLETED, FAILED, TIMED_OUT) cannot be cancelled; the operation returns a ConflictingOperationException
Cancelling an already-CANCELLED job is a no-op and returns the current status (idempotent behavior)
The API responds immediately after recording the cancellation
Cleanup of job resources happens asynchronously in the background
When to Cancel
Cancel a job when:
The job is taking longer than expected
The job was created with incorrect parameters
You no longer need the results
Idempotency
You can safely retry cancellation requests. Calling CancelEnrichmentJob multiple times for the same job returns the current status without error as long as the job is not in a terminal state other than CANCELLED.
See also: AWS API Documentation
Request Syntax
client.cancel_enrichment_job(
workspaceName='string',
jobId='string'
)
string
[REQUIRED]
The name of the IoT SiteWise workspace containing the enrichment job to cancel.
string
[REQUIRED]
The unique identifier of the enrichment job to cancel. This is the jobId returned by CreateEnrichmentJob.
dict
Response Syntax
{
'jobId': 'string',
'status': 'PENDING'|'RUNNING'|'COMPLETED'|'FAILED'|'TIMED_OUT'|'CANCELLED'
}
Response Structure
(dict) --
jobId (string) --
The unique identifier of the cancelled enrichment job.
status (string) --
The status of the enrichment job after cancellation. This will be CANCELLED, indicating the job was successfully cancelled or was already in CANCELLED state (idempotent behavior).
Retrieves a paginated list of data segments associated with a dataset. Use the nextToken parameter to retrieve additional results.
See also: AWS API Documentation
Request Syntax
client.list_dataset_data_segments(
datasetId='string',
workspaceName='string',
datasetVersion='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The ID of the dataset.
string
[REQUIRED]
The name of the workspace that contains the dataset.
string
The version of the dataset to list data segments for.
integer
The maximum number of results to return for each paginated request. Default: 50.
string
The token to be used for the next set of paginated results.
dict
Response Syntax
{
'dataSegments': [
{
'sourceDatasetId': 'string',
'timeSeriesId': 'string',
'startTimestamp': {
'timeInSeconds': 123,
'offsetInNanos': 123
},
'endTimestamp': {
'timeInSeconds': 123,
'offsetInNanos': 123
},
'alias': 'string',
'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN'|'STRUCT'|'VIDEO'|'ANNOTATION'|'JSON',
'enrichment': {
'status': 'ENRICHED'|'NOT_ENRICHED',
'lastEnrichedAt': datetime(2015, 1, 1)
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
dataSegments (list) --
A list that summarizes each data segment.
(dict) --
Contains summary information about a data segment, including its source dataset, time series, timestamp range, and enrichment status.
sourceDatasetId (string) --
The ID of the source dataset that contains the data segment.
timeSeriesId (string) --
The ID of the time series.
startTimestamp (dict) --
The nanosecond-precision start time of the data segment.
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.
endTimestamp (dict) --
The nanosecond-precision end time of the data segment.
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.
alias (string) --
The alias of the time series.
dataType (string) --
The data type of the time series.
enrichment (dict) --
The enrichment information for the data segment.
status (string) --
The enrichment status of the data segment.
lastEnrichedAt (datetime) --
The date the data segment was last enriched, in Unix epoch time.
nextToken (string) --
The token for the next set of results, or null if there are no additional results.
Starts an asynchronous job that exports dataset and time-series data from a workspace to Amazon S3. The operation returns a jobId immediately; poll DescribeDatasetExportJob to track progress and ListDatasetExportJobs to enumerate a workspace's jobs.
See also: AWS API Documentation
Request Syntax
client.create_dataset_export_job(
workspaceName='string',
clientToken='string',
destinationS3Uri='string',
input={
'timeseries': [
{
'timeSeriesId': 'string',
'propertyAlias': 'string',
'trimSettings': {
'startTime': {
'timeInSeconds': 123,
'offsetInNanos': 123
},
'endTime': {
'timeInSeconds': 123,
'offsetInNanos': 123
}
},
'formatSettings': {
'framesPerSecond': 123,
'widthInPixels': 123,
'heightInPixels': 123
}
},
],
'dataset': {
'datasetId': 'string',
'trimSettings': {
'startTime': {
'timeInSeconds': 123,
'offsetInNanos': 123
},
'endTime': {
'timeInSeconds': 123,
'offsetInNanos': 123
}
},
'exportDataTypes': [
'VIDEO'|'TELEMETRY'|'ANNOTATION',
]
}
},
errorReportLocation={
's3Uri': 'string'
}
)
string
[REQUIRED]
The name of the workspace in which to create the dataset export job.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. The AWS SDKs and CLI populate this automatically.
This field is autopopulated if not provided.
string
[REQUIRED]
The S3 URI where output clips will be written.
dict
[REQUIRED]
The processing input source.
timeseries (list) -- <p>List of individual timeseries items to process.</p>
(dict) -- <p>A single timeseries item to process. Exactly one of timeSeriesId or propertyAlias must be provided.</p>
timeSeriesId (string) -- <p>The unique identifier for the timeseries. Mutually exclusive with propertyAlias.</p>
propertyAlias (string) -- <p>The customer-friendly alias for the timeseries. Mutually exclusive with timeSeriesId.</p>
trimSettings (dict) -- <p>The trim settings for the time range to export. Required for VIDEO and TELEMETRY data types; optional for ANNOTATION data types.</p>
startTime (dict) -- [REQUIRED] <p>The start time for the trim range.</p>
timeInSeconds (integer) -- [REQUIRED]
The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.
offsetInNanos (integer) --
The nanosecond offset from timeInSeconds.
endTime (dict) -- [REQUIRED] <p>The end time for the trim range. Must be greater than startTime.</p>
timeInSeconds (integer) -- [REQUIRED]
The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.
offsetInNanos (integer) --
The nanosecond offset from timeInSeconds.
formatSettings (dict) -- <p>The optional format settings for the output.</p>
framesPerSecond (integer) -- <p>The target frame rate for the output.</p>
widthInPixels (integer) -- <p>The target width of the output, in pixels.</p>
heightInPixels (integer) -- <p>The target height of the output, in pixels.</p>
dataset (dict) -- <p>A dataset containing multiple items to process.</p>
datasetId (string) -- [REQUIRED] <p>The unique identifier for the dataset.</p>
trimSettings (dict) -- <p>The trim settings applied to all items in the dataset. When omitted, the full dataset time range is used.</p>
startTime (dict) -- [REQUIRED] <p>The start time for the trim range.</p>
timeInSeconds (integer) -- [REQUIRED]
The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.
offsetInNanos (integer) --
The nanosecond offset from timeInSeconds.
endTime (dict) -- [REQUIRED] <p>The end time for the trim range. Must be greater than startTime.</p>
timeInSeconds (integer) -- [REQUIRED]
The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.
offsetInNanos (integer) --
The nanosecond offset from timeInSeconds.
exportDataTypes (list) -- <p>The optional subset of data types to export. If omitted, all data types are exported.</p>
(string) -- <p>Data types that can be exported from a dataset.</p>
dict
[REQUIRED]
The location where the error report will be written on failure.
s3Uri (string) -- [REQUIRED] <p>The S3 URI prefix for the error report.</p>
dict
Response Syntax
{
'jobId': 'string',
'workspaceName': 'string'
}
Response Structure
(dict) --
Response for create dataset export job request.
jobId (string) --
The unique identifier for the dataset export job.
workspaceName (string) --
The name of the workspace in which the dataset export job was created.
Deletes a workspace. Before you delete a workspace, you must delete all resources contained in or associated with the workspace, such as datasets, time series, pipelines, and tasks.
See also: AWS API Documentation
Request Syntax
client.delete_workspace(
workspaceName='string',
clientToken='string'
)
string
[REQUIRED]
The name of the workspace to delete.
string
A unique, case-sensitive identifier that you provide to ensure that the request is idempotent. If you retry a request that completed successfully using the same client token, the retry succeeds without performing any further actions.
This field is autopopulated if not provided.
dict
Response Syntax
{
'workspaceStatus': {
'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED',
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
'message': 'string'
}
}
}
Response Structure
(dict) --
workspaceStatus (dict) --
The status of the workspace after the deletion request, which is DELETING when the operation returns.
state (string) --
The current state of the workspace.
error (dict) --
Contains associated error information, if any.
code (string) --
The error code.
message (string) --
The error message.
Retrieves the paginated results of a query. Returns empty rows if the query is not yet complete.
See also: AWS API Documentation
Request Syntax
client.get_query_results(
workspaceName='string',
queryId='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The name of the workspace associated with the query.
string
[REQUIRED]
The unique identifier for the query execution.
integer
The maximum number of results to return for each paginated request.
string
The token to be used for the next set of paginated results.
dict
Response Syntax
{
'columnInfo': [
{
'name': 'string',
'type': 'string'
},
],
'rows': [
[
'string',
],
],
'nextToken': 'string'
}
Response Structure
(dict) --
Contains the response for the GetQueryResults operation.
columnInfo (list) --
A list of column metadata for the query results. Each entry contains the column name and data type. Present when the query status is COMPLETED.
(dict) --
Contains metadata about a column in the query results.
name (string) --
The name of the column.
type (string) --
The data type of the column. Valid values are STRING, DOUBLE, BOOLEAN, INTEGER, TIMESTAMP, and VARIANT.
rows (list) --
The result rows. Each row is a list of string column values, positional to match the columnInfo order. Present when the query status is COMPLETED.
(list) --
A single row of query results containing column values. Each element is a string-encoded column value, positional to match the columnInfo order.
(string) --
A string-encoded column value.
nextToken (string) --
The token for the next set of results, or null if there are no additional results.
Retrieves information about a dataset export job.
See also: AWS API Documentation
Request Syntax
client.describe_dataset_export_job(
workspaceName='string',
jobId='string'
)
string
[REQUIRED]
The name of the workspace that contains the dataset export job.
string
[REQUIRED]
The unique identifier for the dataset export job.
dict
Response Syntax
{
'jobId': 'string',
'workspaceName': 'string',
'status': 'SUBMITTED'|'RUNNING'|'COMPLETED'|'COMPLETED_WITH_ERRORS'|'FAILED',
'startedAt': datetime(2015, 1, 1),
'completedAt': datetime(2015, 1, 1),
'destinationS3Uri': 'string',
'errorReportLocation': {
's3Uri': 'string'
},
'input': {
'timeseries': [
{
'timeSeriesId': 'string',
'propertyAlias': 'string',
'trimSettings': {
'startTime': {
'timeInSeconds': 123,
'offsetInNanos': 123
},
'endTime': {
'timeInSeconds': 123,
'offsetInNanos': 123
}
},
'formatSettings': {
'framesPerSecond': 123,
'widthInPixels': 123,
'heightInPixels': 123
}
},
],
'dataset': {
'datasetId': 'string',
'trimSettings': {
'startTime': {
'timeInSeconds': 123,
'offsetInNanos': 123
},
'endTime': {
'timeInSeconds': 123,
'offsetInNanos': 123
}
},
'exportDataTypes': [
'VIDEO'|'TELEMETRY'|'ANNOTATION',
]
}
}
}
Response Structure
(dict) --
Response for describe dataset export job request.
jobId (string) --
The unique identifier for the dataset export job.
workspaceName (string) --
The name of the workspace that contains the dataset export job.
status (string) --
The current status of the dataset export job.
startedAt (datetime) --
The timestamp when the job started processing.
completedAt (datetime) --
The timestamp when the job completed, or null if the job is still running.
destinationS3Uri (string) --
The S3 URI where output clips are written.
errorReportLocation (dict) --
The location where the error report will be written on failure.
s3Uri (string) -- <p>The S3 URI prefix for the error report.</p>
input (dict) --
The processing input that was provided in the CreateDatasetExportJob request.
timeseries (list) -- <p>List of individual timeseries items to process.</p>
(dict) -- <p>A single timeseries item to process. Exactly one of timeSeriesId or propertyAlias must be provided.</p>
timeSeriesId (string) -- <p>The unique identifier for the timeseries. Mutually exclusive with propertyAlias.</p>
propertyAlias (string) -- <p>The customer-friendly alias for the timeseries. Mutually exclusive with timeSeriesId.</p>
trimSettings (dict) -- <p>The trim settings for the time range to export. Required for VIDEO and TELEMETRY data types; optional for ANNOTATION data types.</p>
startTime (dict) -- <p>The start time for the trim range.</p>
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.
endTime (dict) -- <p>The end time for the trim range. Must be greater than startTime.</p>
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.
formatSettings (dict) -- <p>The optional format settings for the output.</p>
framesPerSecond (integer) -- <p>The target frame rate for the output.</p>
widthInPixels (integer) -- <p>The target width of the output, in pixels.</p>
heightInPixels (integer) -- <p>The target height of the output, in pixels.</p>
dataset (dict) -- <p>A dataset containing multiple items to process.</p>
datasetId (string) -- <p>The unique identifier for the dataset.</p>
trimSettings (dict) -- <p>The trim settings applied to all items in the dataset. When omitted, the full dataset time range is used.</p>
startTime (dict) -- <p>The start time for the trim range.</p>
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.
endTime (dict) -- <p>The end time for the trim range. Must be greater than startTime.</p>
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.
exportDataTypes (list) -- <p>The optional subset of data types to export. If omitted, all data types are exported.</p>
(string) -- <p>Data types that can be exported from a dataset.</p>
Retrieves detailed information about a specific pipeline execution, including the overall execution status and the status of each individual compute node. Use this operation to monitor execution progress and inspect per-node results, environment variables, and error details.
See also: AWS API Documentation
Request Syntax
client.describe_pipeline_execution(
workspaceName='string',
pipelineName='string',
pipelineExecutionId='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The name of the workspace.
string
[REQUIRED]
The name of the pipeline.
string
[REQUIRED]
The unique identifier of the pipeline execution.
string
The token to be used for the next set of paginated results.
integer
The maximum number of compute nodes to return per request. This is an upper bound; the actual number of results may be less. Default: 50.
dict
Response Syntax
{
'pipelineExecutionId': 'string',
'pipelineName': 'string',
'workspaceName': 'string',
'pipelineVersion': 'string',
'status': {
'state': 'NOT_STARTED'|'RUNNING'|'SUCCEEDED'|'FAILED'|'CANCELLING'|'CANCELLED',
'stateDetails': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'EXECUTION_ERROR'|'TIMED_OUT',
'message': 'string',
'details': [
{
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'EXECUTION_ERROR'|'TIMED_OUT',
'message': 'string'
},
]
}
},
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'requestEnvironmentVariables': {
'global': {
'string': 'string'
},
'computeNodes': {
'string': {
'string': 'string'
}
}
},
'executionPriority': 123,
'computeNodeExecutionDetails': [
{
'computeNodeName': 'string',
'taskName': 'string',
'taskArn': 'string',
'taskVersion': 'string',
'dependsOn': [
'string',
],
'status': {
'state': 'NOT_STARTED'|'QUEUED'|'RUNNING'|'SUCCEEDED'|'FAILED',
'stateDetails': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'EXECUTION_ERROR'|'TIMED_OUT',
'message': 'string',
'details': [
{
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'EXECUTION_ERROR'|'TIMED_OUT',
'message': 'string'
},
]
}
},
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'executionEnvironmentVariables': {
'string': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Response structure for DescribePipelineExecution operation.
pipelineExecutionId (string) --
The unique identifier of the pipeline execution.
pipelineName (string) --
The name of the pipeline.
workspaceName (string) --
The name of the workspace.
pipelineVersion (string) --
The pipeline version this execution ran against.
status (dict) --
The current execution status of the pipeline.
state (string) --
Current state of the pipeline execution.
stateDetails (dict) --
Additional information about the execution outcome. Populated when the execution has terminated (failed or cancelled).
code (string) --
Classification of the failure. Present when the execution failed.
message (string) --
Human-readable description of the outcome. For a failed execution, this describes why it failed; for a cancelled execution, this is the reason you supplied when calling CancelPipelineExecution.
details (list) --
Per-step error entries to help diagnose a failed execution. Present when the execution failed.
(dict) --
Contains a detailed error entry for granular troubleshooting of pipeline failures.
code (string) --
The error code.
message (string) --
The associated error message.
startTime (datetime) --
The time the pipeline execution started, in Unix epoch time.
endTime (datetime) --
The time the pipeline execution completed, in Unix epoch time.
requestEnvironmentVariables (dict) --
The environment variables provided as input for the pipeline execution.
global (dict) --
Global environment variables that apply to all compute nodes in the pipeline execution.
(string) --
Environment variable name following POSIX naming rules Must not start with AWS_ prefix (case-insensitive)
(string) --
Environment variable value
computeNodes (dict) --
Per-compute-node environment variable overrides. Each entry maps a compute node name to its environment variable overrides.
(string) --
The compute node name from the pipeline definition.
(dict) --
Environment variable overrides specific to this compute node.
(string) --
Environment variable name following POSIX naming rules Must not start with AWS_ prefix (case-insensitive)
(string) --
Environment variable value
executionPriority (integer) --
Scheduling priority for the execution. When not specified, defaults to lowest priority.
computeNodeExecutionDetails (list) --
A list of compute node execution details within this pipeline execution.
(dict) --
Contains detailed execution information for a compute node within a pipeline execution.
computeNodeName (string) --
The name of the compute node.
taskName (string) --
The name of the task executed for this compute node.
taskArn (string) --
The ARN of the task.
taskVersion (string) --
The task version that executed for this compute node.
dependsOn (list) --
A list of compute node names that this node depends on.
(string) --
Reusable resource name with alphanumeric, hyphen, and underscore characters.
status (dict) --
The current execution status of the compute node.
state (string) --
Current state of the compute node execution.
stateDetails (dict) --
Additional information about the compute node's failure. Populated when the compute node has failed.
code (string) --
Classification of the failure.
message (string) --
Human-readable description of why the compute node failed.
details (list) --
Detailed error entries to help diagnose the failure.
(dict) --
Contains a detailed error entry for granular troubleshooting of pipeline failures.
code (string) --
The error code.
message (string) --
The associated error message.
startTime (datetime) --
The time the compute node execution started, in Unix epoch time.
endTime (datetime) --
The time the compute node execution completed, in Unix epoch time.
executionEnvironmentVariables (dict) --
The fully resolved environment variables used for this compute node execution.
(string) --
The environment variable name.
(string) --
The environment variable value.
nextToken (string) --
The token to be used for the next set of paginated results.
Updates a workspace. You can update only workspaces in the ACTIVE or FAILED state. Fields that you omit from the request are left unchanged. To recover a workspace in the FAILED state, call this operation and supply its encryption configuration again.
See also: AWS API Documentation
Request Syntax
client.update_workspace(
workspaceName='string',
workspaceDescription='string',
encryptionConfiguration={
'encryptionType': 'SITEWISE_DEFAULT_ENCRYPTION'|'KMS_BASED_ENCRYPTION',
'kmsKeyId': 'string'
},
clientToken='string'
)
string
[REQUIRED]
The name of the workspace to update.
string
A new description for the workspace.
dict
The encryption configuration for the workspace. Omit this field to leave encryption unchanged. After a customer managed key configuration becomes active, the key can't be changed; supplying the same key is accepted.
encryptionType (string) -- [REQUIRED]
The encryption scheme for the workspace. SITEWISE_DEFAULT_ENCRYPTION encrypts data with the IoT SiteWise default key. KMS_BASED_ENCRYPTION encrypts data with the customer managed KMS key identified by kmsKeyId.
kmsKeyId (string) --
The customer managed KMS key used when encryptionType is KMS_BASED_ENCRYPTION. Accepts a key ID, key ARN, or key alias. Required for KMS_BASED_ENCRYPTION; must be omitted for SITEWISE_DEFAULT_ENCRYPTION. After a workspace's customer managed key configuration becomes active, the key can't be changed.
string
A unique, case-sensitive identifier that you provide to ensure that the request is idempotent. If you retry a request that completed successfully using the same client token, the retry succeeds without performing any further actions.
This field is autopopulated if not provided.
dict
Response Syntax
{
'workspaceStatus': {
'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED',
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
'message': 'string'
}
}
}
Response Structure
(dict) --
workspaceStatus (dict) --
The status of the workspace after the update, which is UPDATING when the operation returns.
state (string) --
The current state of the workspace.
error (dict) --
Contains associated error information, if any.
code (string) --
The error code.
message (string) --
The error message.
Retrieves Application details based on the ID
See also: AWS API Documentation
Request Syntax
client.describe_application(
workspaceName='string',
id='string'
)
string
[REQUIRED]
Name of the workspace to associate with the underlying Application
string
[REQUIRED]
ID of the Application
dict
Response Syntax
{
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'dnsSubdomain': 'string',
'description': 'string',
'id': 'string',
'idcApplicationArn': 'string',
'name': 'string',
'status': 'CREATING'|'ACTIVE'|'DELETING',
'updatedAt': datetime(2015, 1, 1),
'workspaceName': 'string'
}
Response Structure
(dict) --
arn (string) --
ARN of the application
createdAt (datetime) --
Timestamp when the application was created
dnsSubdomain (string) --
DNS subdomain for the application
description (string) --
Description of the application
id (string) --
Unique identifier of the application
idcApplicationArn (string) --
Identity Center Application ARN associated with this application
name (string) --
Name of the application
status (string) --
Current status of the application
updatedAt (datetime) --
Timestamp when the application was last updated
workspaceName (string) --
Name of the workspace this application belongs to
Creates a new task in the specified workspace. A task defines a reusable containerized compute workload that can be referenced by one or more pipeline compute nodes.
Specify a containerTaskConfiguration for custom container workloads with configurable ECR image, processing type, processing unit, and environment variables.
See also: AWS API Documentation
Request Syntax
client.create_task(
workspaceName='string',
taskName='string',
description='string',
taskConfiguration={
'containerTaskConfiguration': {
'ecrUri': 'string',
'taskExecutionRole': 'string',
'processingType': 'GENERIC_COMPUTE_PROCESSING'|'HARDWARE_ACCELERATED_PROCESSING',
'processingUnit': 'UNITS_2'|'UNITS_4'|'UNITS_8'|'UNITS_12'|'UNITS_16'|'UNITS_24'|'UNITS_32'|'UNITS_36'|'UNITS_48'|'UNITS_60'|'UNITS_64'|'UNITS_72'|'UNITS_84'|'UNITS_96',
'command': [
'string',
],
'timeoutSeconds': 123,
'environmentVariables': {
'string': 'string'
}
}
},
tags={
'string': 'string'
},
clientToken='string'
)
string
[REQUIRED]
The name of the workspace.
string
[REQUIRED]
The name of the task to create. Must be unique within the workspace.
string
A description of the task.
dict
[REQUIRED]
The task execution configuration. Specify a containerTaskConfiguration for custom container workloads.
containerTaskConfiguration (dict) --
Configuration for running a custom container image on managed compute.
ecrUri (string) -- [REQUIRED]
The Amazon ECR image URI for the task container.
taskExecutionRole (string) -- [REQUIRED]
The ARN of the IAM role that grants the containerized workload permissions to access AWS resources.
processingType (string) -- [REQUIRED]
The processing type for compute resources.
processingUnit (string) -- [REQUIRED]
The processing unit allocation that determines the vCPU, memory, and GPU resources.
command (list) --
The command to execute in the container.
(string) --
timeoutSeconds (integer) --
The timeout in seconds for task execution. Default: 3600 (1 hour).
environmentVariables (dict) --
Environment variables passed to the container at runtime.
(string) --
Environment variable name following POSIX naming rules Must not start with AWS_ prefix (case-insensitive)
(string) --
Environment variable value
dict
A list of key-value pairs that contain metadata for the task. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.
(string) --
(string) --
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token, the server returns the cached result from the original successful request without performing the operation again.
This field is autopopulated if not provided.
dict
Response Syntax
{
'taskName': 'string',
'taskArn': 'string',
'version': 'string',
'status': {
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
'message': 'string'
},
'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED'
}
}
Response Structure
(dict) --
Response structure for CreateTask operation.
taskName (string) --
The name of the created task.
taskArn (string) --
The ARN of the created task.
version (string) --
The version of the newly created task.
status (dict) --
The current lifecycle status of the task.
error (dict) --
Contains associated error information, if any.
code (string) --
The error code.
message (string) --
The error message.
state (string) --
The current status of the resource.
Associates a batch of data segments with a curated dataset. Data segments are time-bounded slices of time series data selected from source session datasets. Data segments that belong to the same time series can't overlap in time, regardless of which dataset they belong to.
See also: AWS API Documentation
Request Syntax
client.batch_associate_data_segments_to_dataset(
datasetId='string',
workspaceName='string',
associateDataSegmentEntries=[
{
'sourceDatasetId': 'string',
'timeSeriesId': 'string',
'startTimestamp': {
'timeInSeconds': 123,
'offsetInNanos': 123
},
'endTimestamp': {
'timeInSeconds': 123,
'offsetInNanos': 123
}
},
],
clientToken='string'
)
string
[REQUIRED]
The ID of the curated dataset to associate data segments with.
string
[REQUIRED]
The name of the workspace that contains the dataset.
list
[REQUIRED]
The list of data segment entries to associate with the dataset.
(dict) --
Contains information about a data segment entry to associate with a dataset.
sourceDatasetId (string) -- [REQUIRED]
The ID of the source dataset that contains the data segment.
timeSeriesId (string) -- [REQUIRED]
The ID of the time series.
startTimestamp (dict) -- [REQUIRED]
The nanosecond-precision start time of the data segment to associate.
timeInSeconds (integer) -- [REQUIRED]
The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.
offsetInNanos (integer) --
The nanosecond offset from timeInSeconds.
endTimestamp (dict) -- [REQUIRED]
The nanosecond-precision end time of the data segment to associate.
timeInSeconds (integer) -- [REQUIRED]
The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.
offsetInNanos (integer) --
The nanosecond offset from timeInSeconds.
string
A unique, case-sensitive identifier that you provide to ensure that the request is idempotent. If you retry a request that completed successfully using the same client token, the retry succeeds without performing any further actions.
This field is autopopulated if not provided.
dict
Response Syntax
{
'datasetId': 'string',
'datasetVersion': 'string',
'failedAssociations': [
{
'sourceDatasetId': 'string',
'timeSeriesId': 'string',
'startTimestamp': {
'timeInSeconds': 123,
'offsetInNanos': 123
},
'endTimestamp': {
'timeInSeconds': 123,
'offsetInNanos': 123
},
'errorCode': 'INTERNAL_FAILURE'|'VALIDATION_ERROR'|'RESOURCE_NOT_FOUND'|'LIMIT_EXCEEDED'|'CONFLICTING_OPERATION',
'errorMessage': 'string'
},
]
}
Response Structure
(dict) --
datasetId (string) --
The ID of the dataset.
datasetVersion (string) --
The version of the dataset after association.
failedAssociations (list) --
A list of data segment associations that failed.
(dict) --
Contains error information for a data segment association that failed.
sourceDatasetId (string) --
The ID of the source dataset.
timeSeriesId (string) --
The ID of the time series.
startTimestamp (dict) --
The nanosecond-precision start time of the data segment.
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.
endTimestamp (dict) --
The nanosecond-precision end time of the data segment.
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.
errorCode (string) --
The error code for the failed association.
errorMessage (string) --
The error message for the failed association.
Retrieves a paginated list of data segment relationships for a session dataset. Use this operation to find the curated datasets that reference data segments of the specified session dataset. Use the nextToken parameter to retrieve additional results.
See also: AWS API Documentation
Request Syntax
client.list_dataset_data_segment_relationships(
datasetId='string',
workspaceName='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The ID of the session dataset to list data segment relationships for.
string
[REQUIRED]
The name of the workspace that contains the dataset.
integer
The maximum number of results to return for each paginated request. Default: 50.
string
The token to be used for the next set of paginated results.
dict
Response Syntax
{
'dataSegmentRelationshipSummaries': [
{
'targetDatasetId': 'string',
'sourceDatasetId': 'string',
'timeSeriesId': 'string',
'startTimestamp': {
'timeInSeconds': 123,
'offsetInNanos': 123
},
'endTimestamp': {
'timeInSeconds': 123,
'offsetInNanos': 123
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
dataSegmentRelationshipSummaries (list) --
A list that summarizes each data segment relationship.
(dict) --
Contains summary information about a data segment relationship between a source session dataset that contains the data and a curated dataset that references it, including the time series and timestamp range.
targetDatasetId (string) --
The ID of the curated dataset that references the data segment.
sourceDatasetId (string) --
The ID of the source session dataset that contains the data segment.
timeSeriesId (string) --
The ID of the time series.
startTimestamp (dict) --
The nanosecond-precision start time of the data segment.
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.
endTimestamp (dict) --
The nanosecond-precision end time of the data segment.
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.
nextToken (string) --
The token for the next set of results, or null if there are no additional results.
Creates a new application for the workspace and IdC application provided
See also: AWS API Documentation
Request Syntax
client.create_application(
clientToken='string',
idcInstanceArn='string',
workspaceName='string',
name='string',
description='string',
tags={
'string': 'string'
}
)
string
Unique client token for idempotent request handling
This field is autopopulated if not provided.
string
[REQUIRED]
Identity Center Instance ARN to create the application in
string
[REQUIRED]
Name of the workspace to associate with the underlying Application
string
[REQUIRED]
Name of the application
string
Description of the application
dict
A list of key-value pairs that contain metadata for the application.
(string) --
(string) --
dict
Response Syntax
{
'arn': 'string',
'id': 'string',
'dnsSubdomain': 'string',
'name': 'string',
'status': 'CREATING'|'ACTIVE'|'DELETING'
}
Response Structure
(dict) --
arn (string) --
ARN of the application
id (string) --
Unique identifier of the application
dnsSubdomain (string) --
DNS subdomain for the application
name (string) --
Name of the application
status (string) --
Current status of the application
Deletes a task from the specified workspace. A task cannot be deleted if it is currently referenced by any existing pipeline. Remove the task from all pipelines before attempting to delete it.
See also: AWS API Documentation
Request Syntax
client.delete_task(
workspaceName='string',
taskName='string'
)
string
[REQUIRED]
The name of the workspace.
string
[REQUIRED]
The name of the task to delete.
dict
Response Syntax
{
'status': {
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
'message': 'string'
},
'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED'
}
}
Response Structure
(dict) --
Response structure for DeleteTask operation.
status (dict) --
The current lifecycle status of the task.
error (dict) --
Contains associated error information, if any.
code (string) --
The error code.
message (string) --
The error message.
state (string) --
The current status of the resource.
Starts an asynchronous search over the data in a workspace. The search runs in the background; the response returns immediately with a searchId and an initial status of QUEUED. Use DescribeSearch to poll for completion and GetSearchResults to retrieve the results once the search reaches SUCCEEDED. The request is idempotent on clientToken: repeating a call with the same token returns the original search instead of starting a new one.
See also: AWS API Documentation
Request Syntax
client.start_search(
workspaceName='string',
queryStatement='string',
clientToken='string',
searchType='DEEP'|'QUICK',
searchFilters={
'timeSeriesIds': [
'string',
],
'datasetIds': [
'string',
],
'timeIntervals': [
{
'startTime': {
'timeInSeconds': 123,
'offsetInNanos': 123
},
'endTime': {
'timeInSeconds': 123,
'offsetInNanos': 123
}
},
]
},
groupId='string'
)
string
[REQUIRED]
The name of the workspace whose data is searched.
string
[REQUIRED]
The natural-language query describing the data to search for.
string
A unique, case-sensitive identifier you provide to ensure the request is idempotent. Repeating a StartSearch call with the same clientToken returns the original search rather than starting a new one. If omitted, the SDK autogenerates one.
This field is autopopulated if not provided.
string
The search strategy to use. Defaults to QUICK when omitted.
dict
Optional filters that restrict the search to a subset of the workspace's data.
timeSeriesIds (list) --
Restricts the search to these time series.
(string) --
datasetIds (list) --
Restricts the search to these datasets.
(string) -- Unique identifier for a dataset (UUID format)
timeIntervals (list) --
Restricts the search to these time intervals.
(dict) --
Contains a time interval with a start time and an end time. Use a time interval to restrict an operation, such as a search, to a specific time range.
startTime (dict) -- [REQUIRED]
The start of the time interval.
timeInSeconds (integer) -- [REQUIRED]
The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.
offsetInNanos (integer) --
The nanosecond offset from timeInSeconds.
endTime (dict) -- [REQUIRED]
The end of the time interval.
timeInSeconds (integer) -- [REQUIRED]
The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.
offsetInNanos (integer) --
The nanosecond offset from timeInSeconds.
string
An optional caller-supplied identifier used to group related searches together.
dict
Response Syntax
{
'searchId': 'string',
'workspaceName': 'string',
'status': 'QUEUED'|'RUNNING'|'SUCCEEDED'|'FAILED',
'groupId': 'string'
}
Response Structure
(dict) --
Output of the StartSearch operation.
searchId (string) --
The unique identifier assigned to the newly started search.
workspaceName (string) --
The name of the workspace the search runs against.
status (string) --
The initial status of the search. A newly started search is QUEUED.
groupId (string) --
The group identifier associated with the search, if one was supplied on the request.
Starts execution of a pipeline in the specified workspace. Each compute node runs according to the DAG dependency order defined in the pipeline. Nodes without dependencies start immediately, while dependent nodes wait for all upstream nodes to complete successfully.
You can provide runtime environment variable overrides that take the highest priority in the environment variable hierarchy, without modifying the pipeline definition.
See also: AWS API Documentation
Request Syntax
client.start_pipeline_execution(
workspaceName='string',
pipelineName='string',
executionEnvironmentVariableOverrides={
'global': {
'string': 'string'
},
'computeNodes': {
'string': {
'string': 'string'
}
}
},
executionPriority=123,
clientToken='string'
)
string
[REQUIRED]
The name of the workspace containing the pipeline.
string
[REQUIRED]
The name of the pipeline to execute.
dict
Runtime environment variable overrides for the execution. Includes global variables that apply to all compute nodes and computeNodes for per-node overrides. These take the highest priority in the environment variable hierarchy.
global (dict) --
Global environment variables that apply to all compute nodes in the pipeline execution.
(string) --
Environment variable name following POSIX naming rules Must not start with AWS_ prefix (case-insensitive)
(string) --
Environment variable value
computeNodes (dict) --
Per-compute-node environment variable overrides. Each entry maps a compute node name to its environment variable overrides.
(string) --
The compute node name from the pipeline definition.
(dict) --
Environment variable overrides specific to this compute node.
(string) --
Environment variable name following POSIX naming rules Must not start with AWS_ prefix (case-insensitive)
(string) --
Environment variable value
integer
Scheduling priority for the execution. Lower values indicate higher priority. Defaults to 2 when not specified.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token, the server returns the cached result from the original successful request without performing the operation again.
This field is autopopulated if not provided.
dict
Response Syntax
{
'pipelineExecutionId': 'string'
}
Response Structure
(dict) --
Response structure for StartPipelineExecution operation.
pipelineExecutionId (string) --
The unique identifier of the created pipeline execution.
Creates a new pipeline in the specified workspace. A pipeline defines a directed acyclic graph (DAG) of compute nodes, where each node references a task and can declare dependencies on other nodes. Cyclic dependencies are not allowed. Nodes without dependencies run in parallel, while nodes with dependencies wait for all upstream nodes to complete successfully before starting.
You can set environment variables at the pipeline level that are shared across all compute nodes, and override them at the individual compute node level.
See also: AWS API Documentation
Request Syntax
client.create_pipeline(
workspaceName='string',
pipelineName='string',
description='string',
environmentVariables={
'string': 'string'
},
computations=[
{
'computeNodeName': 'string',
'taskName': 'string',
'environmentVariables': {
'string': 'string'
},
'dependsOn': [
'string',
]
},
],
tags={
'string': 'string'
},
clientToken='string'
)
string
[REQUIRED]
The name of the workspace.
string
[REQUIRED]
The name of the pipeline to create. Must be unique within the workspace.
string
A description of the pipeline.
dict
Environment variables shared across all compute nodes in the pipeline. Individual compute nodes can override these values with their own environment variables.
(string) --
Environment variable name following POSIX naming rules Must not start with AWS_ prefix (case-insensitive)
(string) --
Environment variable value
list
[REQUIRED]
The list of compute nodes that form the pipeline DAG. Each compute node references a task and can declare dependencies on other nodes.
(dict) --
A single compute node in a pipeline DAG. Each compute node references a task and can declare dependencies on other nodes.
computeNodeName (string) -- [REQUIRED]
The unique name for this compute node within the pipeline.
taskName (string) -- [REQUIRED]
The name of the task to execute for this compute node.
environmentVariables (dict) --
Environment variables specific to this compute node. These override pipeline-level environment variables with the same key.
(string) --
Environment variable name following POSIX naming rules Must not start with AWS_ prefix (case-insensitive)
(string) --
Environment variable value
dependsOn (list) --
A list of compute node names that must complete successfully before this node can start.
(string) --
Reusable resource name with alphanumeric, hyphen, and underscore characters.
dict
A list of key-value pairs that contain metadata for the pipeline. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.
(string) --
(string) --
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token, the server returns the cached result from the original successful request without performing the operation again.
This field is autopopulated if not provided.
dict
Response Syntax
{
'pipelineName': 'string',
'pipelineArn': 'string',
'version': 'string',
'status': {
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
'message': 'string'
},
'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED'
}
}
Response Structure
(dict) --
Response structure for CreatePipeline operation.
pipelineName (string) --
The name of the created pipeline.
pipelineArn (string) --
The ARN of the created pipeline.
version (string) --
The version of the newly created pipeline.
status (dict) --
The current lifecycle status of the pipeline.
error (dict) --
Contains associated error information, if any.
code (string) --
The error code.
message (string) --
The error message.
state (string) --
The current status of the resource.
{'assetModelCompositeModels': {'properties': {'dataType': {'ANNOTATION',
'JSON',
'VIDEO'}}},
'assetModelProperties': {'dataType': {'JSON', 'ANNOTATION', 'VIDEO'}}}
Creates an asset model from specified property and hierarchy definitions. You create assets from asset models. With asset models, you can easily create assets of the same type that have standardized definitions. Each asset created from a model inherits the asset model's property and hierarchy definitions. For more information, see Defining asset models in the IoT SiteWise User Guide.
You can create three types of asset models, ASSET_MODEL, COMPONENT_MODEL, or an INTERFACE.
ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.
COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
INTERFACE – An interface is a type of model that defines a standard structure that can be applied to different asset models.
See also: AWS API Documentation
Request Syntax
client.create_asset_model(
assetModelName='string',
assetModelType='ASSET_MODEL'|'COMPONENT_MODEL'|'INTERFACE',
assetModelId='string',
assetModelExternalId='string',
assetModelDescription='string',
assetModelProperties=[
{
'id': 'string',
'externalId': 'string',
'name': 'string',
'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN'|'STRUCT'|'VIDEO'|'ANNOTATION'|'JSON',
'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',
'propertyPath': [
{
'id': 'string',
'name': 'string'
},
]
}
},
],
'processingConfig': {
'computeLocation': 'EDGE'|'CLOUD',
'forwardingConfig': {
'state': 'DISABLED'|'ENABLED'
}
}
},
'metric': {
'expression': 'string',
'variables': [
{
'name': 'string',
'value': {
'propertyId': 'string',
'hierarchyId': 'string',
'propertyPath': [
{
'id': 'string',
'name': 'string'
},
]
}
},
],
'window': {
'tumbling': {
'interval': 'string',
'offset': 'string'
}
},
'processingConfig': {
'computeLocation': 'EDGE'|'CLOUD'
}
}
}
},
],
assetModelHierarchies=[
{
'id': 'string',
'externalId': 'string',
'name': 'string',
'childAssetModelId': 'string'
},
],
assetModelCompositeModels=[
{
'id': 'string',
'externalId': 'string',
'name': 'string',
'description': 'string',
'type': 'string',
'properties': [
{
'id': 'string',
'externalId': 'string',
'name': 'string',
'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN'|'STRUCT'|'VIDEO'|'ANNOTATION'|'JSON',
'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',
'propertyPath': [
{
'id': 'string',
'name': 'string'
},
]
}
},
],
'processingConfig': {
'computeLocation': 'EDGE'|'CLOUD',
'forwardingConfig': {
'state': 'DISABLED'|'ENABLED'
}
}
},
'metric': {
'expression': 'string',
'variables': [
{
'name': 'string',
'value': {
'propertyId': 'string',
'hierarchyId': 'string',
'propertyPath': [
{
'id': 'string',
'name': 'string'
},
]
}
},
],
'window': {
'tumbling': {
'interval': 'string',
'offset': 'string'
}
},
'processingConfig': {
'computeLocation': 'EDGE'|'CLOUD'
}
}
}
},
]
},
],
clientToken='string',
tags={
'string': 'string'
}
)
string
[REQUIRED]
A unique name for the asset model.
string
The type of asset model.
ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.
COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
string
The ID to assign to the asset model, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
string
An external ID to assign to the asset model. The external ID must be unique within your Amazon Web Services account. For more information, see Using external IDs in the IoT SiteWise User Guide.
string
A description for the asset model.
list
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.
(dict) --
Contains an asset model property definition. This property definition is applied to all assets created from the asset model.
id (string) --
The ID to assign to the asset model property, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
externalId (string) --
An external ID to assign to the property definition. The external ID must be unique among property definitions within this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
name (string) -- [REQUIRED]
The name of the property definition.
dataType (string) -- [REQUIRED]
The data type of the property definition.
The VIDEO, ANNOTATION, and JSON data types aren't supported for asset model properties. These types are used only by time series that store data for datasets in a workspace.
If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this property.
dataTypeSpec (string) --
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.
unit (string) --
The unit of the property definition, such as Newtons or RPM.
type (dict) -- [REQUIRED]
The property definition type (see PropertyType). You can only specify one type in a property definition.
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) -- [REQUIRED]
The forwarding configuration for the given measurement property.
state (string) -- [REQUIRED]
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) -- [REQUIRED]
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) -- [REQUIRED]
The list of variables used in the expression.
(dict) --
Contains expression variable information.
name (string) -- [REQUIRED]
The friendly name of the variable to be used in the expression.
value (dict) -- [REQUIRED]
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. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
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. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
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.
propertyPath (list) --
The path of the property.
(dict) --
Represents one level between a property and the root of the asset model.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
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) -- [REQUIRED]
The compute location for the given transform property.
forwardingConfig (dict) --
The forwarding configuration for a given property.
state (string) -- [REQUIRED]
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) -- [REQUIRED]
The friendly name of the variable to be used in the expression.
value (dict) -- [REQUIRED]
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. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
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. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
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.
propertyPath (list) --
The path of the property.
(dict) --
Represents one level between a property and the root of the asset model.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
window (dict) -- [REQUIRED]
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) -- [REQUIRED]
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:
The offset time. For example, if you specify 18h for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The ISO 8601 format. For example, if you specify PT18H for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The 24-hour clock. For example, if you specify 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).
The offset time zone. For example, if you specify 2021-07-23T18:00-08 for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric.
If you create the metric after 6 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.
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) -- [REQUIRED]
The compute location for the given metric property.
list
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.
(dict) --
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.
id (string) --
The ID to assign to the asset model hierarchy, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
externalId (string) --
An external ID to assign to the asset model hierarchy. The external ID must be unique among asset model hierarchies within this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
name (string) -- [REQUIRED]
The name of the asset model hierarchy definition (as specified in the CreateAssetModel or UpdateAssetModel API operation).
childAssetModelId (string) -- [REQUIRED]
The ID of an asset model for this hierarchy. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
list
The composite models that are part of this asset model. It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model.
(dict) --
Contains a composite model definition in an asset model. This composite model definition is applied to all assets created from the asset model.
id (string) --
The ID to assign to the composite model, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
externalId (string) --
An external ID to assign to the composite model. The external ID must be unique among composite models within this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
name (string) -- [REQUIRED]
The name of the composite model.
description (string) --
The description of the composite model.
type (string) -- [REQUIRED]
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 an asset model property definition. This property definition is applied to all assets created from the asset model.
id (string) --
The ID to assign to the asset model property, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
externalId (string) --
An external ID to assign to the property definition. The external ID must be unique among property definitions within this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
name (string) -- [REQUIRED]
The name of the property definition.
dataType (string) -- [REQUIRED]
The data type of the property definition.
The VIDEO, ANNOTATION, and JSON data types aren't supported for asset model properties. These types are used only by time series that store data for datasets in a workspace.
If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this property.
dataTypeSpec (string) --
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.
unit (string) --
The unit of the property definition, such as Newtons or RPM.
type (dict) -- [REQUIRED]
The property definition type (see PropertyType). You can only specify one type in a property definition.
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) -- [REQUIRED]
The forwarding configuration for the given measurement property.
state (string) -- [REQUIRED]
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) -- [REQUIRED]
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) -- [REQUIRED]
The list of variables used in the expression.
(dict) --
Contains expression variable information.
name (string) -- [REQUIRED]
The friendly name of the variable to be used in the expression.
value (dict) -- [REQUIRED]
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. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
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. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
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.
propertyPath (list) --
The path of the property.
(dict) --
Represents one level between a property and the root of the asset model.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
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) -- [REQUIRED]
The compute location for the given transform property.
forwardingConfig (dict) --
The forwarding configuration for a given property.
state (string) -- [REQUIRED]
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) -- [REQUIRED]
The friendly name of the variable to be used in the expression.
value (dict) -- [REQUIRED]
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. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
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. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
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.
propertyPath (list) --
The path of the property.
(dict) --
Represents one level between a property and the root of the asset model.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
window (dict) -- [REQUIRED]
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) -- [REQUIRED]
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:
The offset time. For example, if you specify 18h for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The ISO 8601 format. For example, if you specify PT18H for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The 24-hour clock. For example, if you specify 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).
The offset time zone. For example, if you specify 2021-07-23T18:00-08 for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric.
If you create the metric after 6 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.
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) -- [REQUIRED]
The compute location for the given metric property.
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.
dict
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.
(string) --
(string) --
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, in UUID format. You can use this ID when you call other IoT SiteWise API operations.
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.
{'assetModelCompositeModelProperties': {'dataType': {'ANNOTATION',
'JSON',
'VIDEO'}}}
Response {'assetModelId': 'string'}
Creates a custom composite model from specified property and hierarchy definitions. There are two types of custom composite models, inline and component-model-based.
Use component-model-based custom composite models to define standard, reusable components. A component-model-based custom composite model consists of a name, a description, and the ID of the component model it references. A component-model-based custom composite model has no properties of its own; its referenced component model provides its associated properties to any created assets. For more information, see Custom composite models (Components) in the IoT SiteWise User Guide.
Use inline custom composite models to organize the properties of an asset model. The properties of inline custom composite models are local to the asset model where they are included and can't be used to create multiple assets.
To create a component-model-based model, specify the composedAssetModelId of an existing asset model with assetModelType of COMPONENT_MODEL.
To create an inline model, specify the assetModelCompositeModelProperties and don't include an composedAssetModelId.
See also: AWS API Documentation
Request Syntax
client.create_asset_model_composite_model(
assetModelId='string',
assetModelCompositeModelExternalId='string',
parentAssetModelCompositeModelId='string',
assetModelCompositeModelId='string',
assetModelCompositeModelDescription='string',
assetModelCompositeModelName='string',
assetModelCompositeModelType='string',
clientToken='string',
composedAssetModelId='string',
assetModelCompositeModelProperties=[
{
'id': 'string',
'externalId': 'string',
'name': 'string',
'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN'|'STRUCT'|'VIDEO'|'ANNOTATION'|'JSON',
'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',
'propertyPath': [
{
'id': 'string',
'name': 'string'
},
]
}
},
],
'processingConfig': {
'computeLocation': 'EDGE'|'CLOUD',
'forwardingConfig': {
'state': 'DISABLED'|'ENABLED'
}
}
},
'metric': {
'expression': 'string',
'variables': [
{
'name': 'string',
'value': {
'propertyId': 'string',
'hierarchyId': 'string',
'propertyPath': [
{
'id': 'string',
'name': 'string'
},
]
}
},
],
'window': {
'tumbling': {
'interval': 'string',
'offset': 'string'
}
},
'processingConfig': {
'computeLocation': 'EDGE'|'CLOUD'
}
}
}
},
],
ifMatch='string',
ifNoneMatch='string',
matchForVersionType='LATEST'|'ACTIVE'
)
string
[REQUIRED]
The ID of the asset model this composite model is a part of.
string
An external ID to assign to the composite model.
If the composite model is a derived composite model, or one nested inside a component model, you can only set the external ID using UpdateAssetModelCompositeModel and specifying the derived ID of the model or property from the created model it's a part of.
string
The ID of the parent composite model in this asset model relationship.
string
The ID of the composite model. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
string
A description for the composite model.
string
[REQUIRED]
A unique name for the composite model.
string
[REQUIRED]
The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.
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.
string
The ID of a component model which is reused to create this composite model.
list
The property definitions of the composite model. For more information, see Inline custom composite models in the IoT SiteWise User Guide.
You can specify up to 200 properties per composite model. For more information, see Quotas in the IoT SiteWise User Guide.
(dict) --
Contains an asset model property definition. This property definition is applied to all assets created from the asset model.
id (string) --
The ID to assign to the asset model property, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
externalId (string) --
An external ID to assign to the property definition. The external ID must be unique among property definitions within this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
name (string) -- [REQUIRED]
The name of the property definition.
dataType (string) -- [REQUIRED]
The data type of the property definition.
The VIDEO, ANNOTATION, and JSON data types aren't supported for asset model properties. These types are used only by time series that store data for datasets in a workspace.
If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this property.
dataTypeSpec (string) --
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.
unit (string) --
The unit of the property definition, such as Newtons or RPM.
type (dict) -- [REQUIRED]
The property definition type (see PropertyType). You can only specify one type in a property definition.
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) -- [REQUIRED]
The forwarding configuration for the given measurement property.
state (string) -- [REQUIRED]
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) -- [REQUIRED]
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) -- [REQUIRED]
The list of variables used in the expression.
(dict) --
Contains expression variable information.
name (string) -- [REQUIRED]
The friendly name of the variable to be used in the expression.
value (dict) -- [REQUIRED]
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. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
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. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
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.
propertyPath (list) --
The path of the property.
(dict) --
Represents one level between a property and the root of the asset model.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
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) -- [REQUIRED]
The compute location for the given transform property.
forwardingConfig (dict) --
The forwarding configuration for a given property.
state (string) -- [REQUIRED]
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) -- [REQUIRED]
The friendly name of the variable to be used in the expression.
value (dict) -- [REQUIRED]
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. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
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. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
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.
propertyPath (list) --
The path of the property.
(dict) --
Represents one level between a property and the root of the asset model.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
window (dict) -- [REQUIRED]
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) -- [REQUIRED]
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:
The offset time. For example, if you specify 18h for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The ISO 8601 format. For example, if you specify PT18H for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The 24-hour clock. For example, if you specify 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).
The offset time zone. For example, if you specify 2021-07-23T18:00-08 for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric.
If you create the metric after 6 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.
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) -- [REQUIRED]
The compute location for the given metric property.
string
The expected current entity tag (ETag) for the asset model’s latest or active version (specified using matchForVersionType). The create request is rejected if the tag does not match the latest or active version's current entity tag. See Optimistic locking for asset model writes in the IoT SiteWise User Guide.
string
Accepts * to reject the create request if an active version (specified using matchForVersionType as ACTIVE) already exists for the asset model.
string
Specifies the asset model version type ( LATEST or ACTIVE) used in conjunction with If-Match or If-None-Match headers to determine the target ETag for the create operation.
dict
Response Syntax
{
'assetModelCompositeModelId': 'string',
'assetModelCompositeModelPath': [
{
'id': 'string',
'name': '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'
},
]
}
},
'assetModelId': 'string'
}
Response Structure
(dict) --
assetModelCompositeModelId (string) --
The ID of the composed asset model. You can use this ID when you call other IoT SiteWise APIs.
assetModelCompositeModelPath (list) --
The path to the composite model listing the parent composite models.
(dict) --
Represents one level between a composite model and the root of the asset model.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
assetModelStatus (dict) --
Contains current status information for an asset model. For more information, see Asset and model states in the IoT SiteWise User Guide.
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.
assetModelId (string) --
The ID of the asset model.
{'datasetId': 'string',
'files': {'alias': 'string',
'fileFormat': {'annotation': {},
'csv': {'columnNames': ['ALIAS | ASSET_ID | '
'PROPERTY_ID | DATA_TYPE | '
'TIMESTAMP_SECONDS | '
'TIMESTAMP_NANO_OFFSET | '
'QUALITY | VALUE']},
'mp4': {},
'parquet': {}},
'startTime': {'offsetInNanos': 'integer', 'timeInSeconds': 'long'}},
'jobConfiguration': {'fileFormat': {'annotation': {}, 'mp4': {}}},
'workspaceName': 'string'}
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.
See also: AWS API Documentation
Request Syntax
client.create_bulk_import_job(
jobName='string',
jobRoleArn='string',
files=[
{
'bucket': 'string',
'key': 'string',
'versionId': 'string',
'alias': 'string',
'startTime': {
'timeInSeconds': 123,
'offsetInNanos': 123
},
'fileFormat': {
'csv': {
'columnNames': [
'ALIAS'|'ASSET_ID'|'PROPERTY_ID'|'DATA_TYPE'|'TIMESTAMP_SECONDS'|'TIMESTAMP_NANO_OFFSET'|'QUALITY'|'VALUE',
]
},
'parquet': {}
,
'mp4': {}
,
'annotation': {}
}
},
],
errorReportLocation={
'bucket': 'string',
'prefix': 'string'
},
jobConfiguration={
'fileFormat': {
'csv': {
'columnNames': [
'ALIAS'|'ASSET_ID'|'PROPERTY_ID'|'DATA_TYPE'|'TIMESTAMP_SECONDS'|'TIMESTAMP_NANO_OFFSET'|'QUALITY'|'VALUE',
]
},
'parquet': {}
,
'mp4': {}
,
'annotation': {}
}
},
adaptiveIngestion=True|False,
deleteFilesAfterImport=True|False,
datasetId='string',
workspaceName='string'
)
string
[REQUIRED]
The unique name that helps identify the job request.
string
[REQUIRED]
The ARN of the IAM role that allows IoT SiteWise to read Amazon S3 data.
list
[REQUIRED]
The files in the specified Amazon S3 bucket that contain your data. You can specify up to 100 files for each bulk import job. Each file supports the following size limits:
Parquet files – Up to 256 MiB.
Other file formats – Up to 5 GiB.
(dict) --
The file in Amazon S3 where your data is saved.
bucket (string) -- [REQUIRED]
The name of the Amazon S3 bucket from which data is imported.
key (string) -- [REQUIRED]
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.
versionId (string) --
The version ID to identify a specific version of the Amazon S3 object that contains your data.
alias (string) --
The alias associated with the file's time series.
startTime (dict) --
The nanosecond-precision start time for the file data.
timeInSeconds (integer) -- [REQUIRED]
The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.
offsetInNanos (integer) --
The nanosecond offset from timeInSeconds.
fileFormat (dict) --
The file format of the data in S3.
csv (dict) --
The file is in .CSV format.
columnNames (list) -- [REQUIRED]
The column names specified in the .csv file.
(string) --
parquet (dict) --
The file is in parquet format.
mp4 (dict) --
The MP4 format configuration.
annotation (dict) --
The annotation format configuration.
dict
[REQUIRED]
The Amazon S3 destination where errors associated with the job creation request are saved.
bucket (string) -- [REQUIRED]
The name of the Amazon S3 bucket to which errors associated with the bulk import job are sent.
prefix (string) -- [REQUIRED]
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.
dict
Contains the configuration information of a job, such as the file format used to save data in Amazon S3.
fileFormat (dict) --
The file format of the data in S3.
csv (dict) --
The file is in .CSV format.
columnNames (list) -- [REQUIRED]
The column names specified in the .csv file.
(string) --
parquet (dict) --
The file is in parquet format.
mp4 (dict) --
The MP4 format configuration.
annotation (dict) --
The annotation format configuration.
boolean
If set to true, ingest new data into IoT SiteWise storage. Measurements with notifications, metrics and transforms are computed. If set to false, historical data is ingested into IoT SiteWise as is.
boolean
If set to true, your data files is deleted from S3, after ingestion into IoT SiteWise storage.
string
The ID of the session dataset to ingest data into. Specify this field, together with workspaceName, to ingest data into a session dataset in a workspace.
string
The name of the workspace that contains the session dataset. Specify this field together with datasetId.
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.
{'datasetConfig': {'session': {'sessionEndTimestamp': {'offsetInNanos': 'integer',
'timeInSeconds': 'long'},
'sessionStartTimestamp': {'offsetInNanos': 'integer',
'timeInSeconds': 'long'}}},
'datasetSource': {'sourceFormat': {'TIMESERIES'}, 'sourceType': {'SITEWISE'}},
'datasetType': 'SESSION | CURATED | EXTERNAL',
'metadata': {'string': 'string'},
'workspaceName': 'string'}
Creates a dataset. Session and curated datasets are created in a workspace. A session dataset contains data segments of time series data, and a curated dataset curates data segments selected from source session datasets. A dataset that connects to an external datasource is created outside of a workspace.
See also: AWS API Documentation
Request Syntax
client.create_dataset(
datasetId='string',
datasetName='string',
datasetDescription='string',
datasetType='SESSION'|'CURATED'|'EXTERNAL',
datasetConfig={
'session': {
'sessionStartTimestamp': {
'timeInSeconds': 123,
'offsetInNanos': 123
},
'sessionEndTimestamp': {
'timeInSeconds': 123,
'offsetInNanos': 123
}
}
},
workspaceName='string',
metadata={
'string': 'string'
},
datasetSource={
'sourceType': 'KENDRA'|'SITEWISE',
'sourceFormat': 'KNOWLEDGE_BASE'|'TIMESERIES',
'sourceDetail': {
'kendra': {
'knowledgeBaseArn': 'string',
'roleArn': 'string'
}
}
},
clientToken='string',
tags={
'string': 'string'
}
)
string
The ID of the dataset.
string
[REQUIRED]
The name of the dataset.
string
A description about the dataset, and its functionality.
string
The type of dataset: a session dataset, a curated dataset, or a connection to an external datasource.
dict
The configuration for the dataset.
session (dict) --
The session configuration for a session-type dataset.
sessionStartTimestamp (dict) -- [REQUIRED]
The nanosecond-precision start time of the session.
timeInSeconds (integer) -- [REQUIRED]
The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.
offsetInNanos (integer) --
The nanosecond offset from timeInSeconds.
sessionEndTimestamp (dict) -- [REQUIRED]
The nanosecond-precision end time of the session.
timeInSeconds (integer) -- [REQUIRED]
The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.
offsetInNanos (integer) --
The nanosecond offset from timeInSeconds.
string
The name of the workspace that contains the dataset. Required for session and curated datasets. Omit this field for datasets that connect to an external datasource.
dict
The metadata for the dataset, provided as key-value pairs.
(string) --
(string) --
dict
[REQUIRED]
The data source for the dataset.
sourceType (string) -- [REQUIRED]
The type of data source for the dataset.
sourceFormat (string) -- [REQUIRED]
The format of the dataset source associated with the dataset.
sourceDetail (dict) --
The details of the dataset source associated with the dataset.
kendra (dict) --
Contains details about the Kendra dataset source.
knowledgeBaseArn (string) -- [REQUIRED]
The knowledgeBaseArn details for the Kendra dataset source.
roleArn (string) -- [REQUIRED]
The roleARN details for the Kendra dataset source.
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.
dict
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.
(string) --
(string) --
dict
Response Syntax
{
'datasetId': 'string',
'datasetArn': 'string',
'datasetStatus': {
'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) --
datasetId (string) --
The ID of the dataset.
datasetArn (string) --
The ARN of the dataset. The format is arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId}.
datasetStatus (dict) --
The status of the dataset. This contains the state and any error messages. State is CREATING after a successfull call to this API, and any associated error message. The state is ACTIVE when ready to use.
state (string) --
The current status of the dataset.
error (dict) --
Contains the details of an IoT SiteWise error.
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.
{'assetId': 'string'}
Deletes an asset. This action can't be undone. For more information, see Deleting assets and models in the IoT SiteWise User Guide.
See also: AWS API Documentation
Request Syntax
client.delete_asset(
assetId='string',
clientToken='string'
)
string
[REQUIRED]
The ID of the asset to delete. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
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.
dict
Response Syntax
{
'assetId': '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.
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.
{'assetModelId': 'string'}
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
client.delete_asset_model(
assetModelId='string',
clientToken='string',
ifMatch='string',
ifNoneMatch='string',
matchForVersionType='LATEST'|'ACTIVE'
)
string
[REQUIRED]
The ID of the asset model to delete. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
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.
string
The expected current entity tag (ETag) for the asset model’s latest or active version (specified using matchForVersionType). The delete request is rejected if the tag does not match the latest or active version's current entity tag. See Optimistic locking for asset model writes in the IoT SiteWise User Guide.
string
Accepts * to reject the delete request if an active version (specified using matchForVersionType as ACTIVE) already exists for the asset model.
string
Specifies the asset model version type ( LATEST or ACTIVE) used in conjunction with If-Match or If-None-Match headers to determine the target ETag for the delete operation.
dict
Response Syntax
{
'assetModelId': '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.
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.
{'assetModelId': 'string'}
Deletes a composite model. This action can't be undone. You must delete all assets created from a composite model before you can delete the model. Also, you can't delete a composite model if a parent asset model exists that contains a property formula expression that depends on the asset model that you want to delete. For more information, see Deleting assets and models in the IoT SiteWise User Guide.
See also: AWS API Documentation
Request Syntax
client.delete_asset_model_composite_model(
assetModelId='string',
assetModelCompositeModelId='string',
clientToken='string',
ifMatch='string',
ifNoneMatch='string',
matchForVersionType='LATEST'|'ACTIVE'
)
string
[REQUIRED]
The ID of the asset model, in UUID format.
string
[REQUIRED]
The ID of a composite model on this asset model.
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.
string
The expected current entity tag (ETag) for the asset model’s latest or active version (specified using matchForVersionType). The delete request is rejected if the tag does not match the latest or active version's current entity tag. See Optimistic locking for asset model writes in the IoT SiteWise User Guide.
string
Accepts * to reject the delete request if an active version (specified using matchForVersionType as ACTIVE) already exists for the asset model.
string
Specifies the asset model version type ( LATEST or ACTIVE) used in conjunction with If-Match or If-None-Match headers to determine the target ETag for the delete operation.
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'
},
]
}
},
'assetModelId': 'string'
}
Response Structure
(dict) --
assetModelStatus (dict) --
Contains current status information for an asset model. For more information, see Asset and model states in the IoT SiteWise User Guide.
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.
assetModelId (string) --
The ID of the asset model.
{'workspaceName': 'string'}
Deletes a dataset. This can't be undone. Deleting a session dataset also deletes the underlying time series data in the session. You can't delete a session dataset while a curated dataset references its data segments. First delete the curated dataset or disassociate the data segments. Deleting a curated dataset doesn't delete the underlying data in the source session datasets.
See also: AWS API Documentation
Request Syntax
client.delete_dataset(
datasetId='string',
workspaceName='string',
clientToken='string'
)
string
[REQUIRED]
The ID of the dataset.
string
The name of the workspace that contains the dataset.
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.
dict
Response Syntax
{
'datasetStatus': {
'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) --
datasetStatus (dict) --
The status of the dataset. This contains the state and any error messages. State is DELETING after a successfull call to this API, and any associated error message.
state (string) --
The current status of the dataset.
error (dict) --
Contains the details of an IoT SiteWise error.
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.
{'workspaceName': 'string'}
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. You can't delete a time series until all of its data segments have been deleted from session datasets.
To identify a time series, do one of the following:
If the time series isn't associated with an asset property, specify the alias of the time series.
If the time series is associated with an asset property, specify one of the following:
The alias of the time series.
The assetId and propertyId that identifies the asset property.
See also: AWS API Documentation
Request Syntax
client.delete_time_series(
alias='string',
assetId='string',
propertyId='string',
clientToken='string',
workspaceName='string'
)
string
The alias that identifies the time series.
string
The ID of the asset in which the asset property was created. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
string
The ID of the asset property. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
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.
string
The name of the workspace.
None
{'assetCompositeModels': {'properties': {'dataType': {'ANNOTATION',
'JSON',
'VIDEO'}}},
'assetProperties': {'dataType': {'JSON', 'ANNOTATION', 'VIDEO'}}}
Retrieves information about an asset.
See also: AWS API Documentation
Request Syntax
client.describe_asset(
assetId='string',
excludeProperties=True|False
)
string
[REQUIRED]
The ID of the asset. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
boolean
Whether or not to exclude asset properties from the response.
dict
Response Syntax
{
'assetId': 'string',
'assetExternalId': 'string',
'assetArn': 'string',
'assetName': 'string',
'assetModelId': 'string',
'assetProperties': [
{
'id': 'string',
'externalId': 'string',
'name': 'string',
'alias': 'string',
'notification': {
'topic': 'string',
'state': 'ENABLED'|'DISABLED'
},
'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN'|'STRUCT'|'VIDEO'|'ANNOTATION'|'JSON',
'dataTypeSpec': 'string',
'unit': 'string',
'path': [
{
'id': 'string',
'name': 'string'
},
]
},
],
'assetHierarchies': [
{
'id': 'string',
'externalId': 'string',
'name': 'string'
},
],
'assetCompositeModels': [
{
'name': 'string',
'description': 'string',
'type': 'string',
'properties': [
{
'id': 'string',
'externalId': 'string',
'name': 'string',
'alias': 'string',
'notification': {
'topic': 'string',
'state': 'ENABLED'|'DISABLED'
},
'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN'|'STRUCT'|'VIDEO'|'ANNOTATION'|'JSON',
'dataTypeSpec': 'string',
'unit': 'string',
'path': [
{
'id': 'string',
'name': 'string'
},
]
},
],
'id': 'string',
'externalId': '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',
'assetCompositeModelSummaries': [
{
'id': 'string',
'externalId': 'string',
'name': 'string',
'type': 'string',
'description': 'string',
'path': [
{
'id': 'string',
'name': 'string'
},
]
},
]
}
Response Structure
(dict) --
assetId (string) --
The ID of the asset, in UUID format.
assetExternalId (string) --
The external ID of the asset, if any.
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.
externalId (string) --
The external ID of the asset property. For more information, see Using external IDs in the IoT SiteWise User Guide.
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.
path (list) --
The structured path to the property from the root of the asset.
(dict) --
Represents one level between a property and the root of the asset.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
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.
externalId (string) --
The external ID of the hierarchy, if it has one. When you update an asset hierarchy, you may assign an external ID if it doesn't already have one. You can't change the external ID of an asset hierarchy that already has one. For more information, see Using external IDs in the IoT SiteWise User Guide.
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.
externalId (string) --
The external ID of the asset property. For more information, see Using external IDs in the IoT SiteWise User Guide.
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.
path (list) --
The structured path to the property from the root of the asset.
(dict) --
Represents one level between a property and the root of the asset.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
id (string) --
The ID of the asset composite model.
externalId (string) --
The external ID of the asset composite model. For more information, see Using external IDs in the IoT SiteWise User Guide.
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.
assetCompositeModelSummaries (list) --
The list of the immediate child custom composite model summaries for the asset.
(dict) --
Contains a summary of the composite model for a specific asset.
id (string) --
The ID of the composite model that this summary describes.
externalId (string) --
An external ID to assign to the asset model.
If the composite model is a derived composite model, or one nested inside a component model, you can only set the external ID using UpdateAssetModelCompositeModel and specifying the derived ID of the model or property from the created model it's a part of.
name (string) --
The name of the composite model that this summary describes.
type (string) --
The type of asset model.
ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.
COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
description (string) --
A description of the composite model that this summary describes.
path (list) --
The path that includes all the components of the asset model for the asset.
(dict) --
Represents one level between a composite model and the root of the asset.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
{'assetCompositeModelProperties': {'dataType': {'JSON', 'ANNOTATION', 'VIDEO'}}}
Retrieves information about an asset composite model (also known as an asset component). An AssetCompositeModel is an instance of an AssetModelCompositeModel. If you want to see information about the model this is based on, call DescribeAssetModelCompositeModel.
See also: AWS API Documentation
Request Syntax
client.describe_asset_composite_model(
assetId='string',
assetCompositeModelId='string'
)
string
[REQUIRED]
The ID of the asset. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
string
[REQUIRED]
The ID of a composite model on this asset. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
dict
Response Syntax
{
'assetId': 'string',
'assetCompositeModelId': 'string',
'assetCompositeModelExternalId': 'string',
'assetCompositeModelPath': [
{
'id': 'string',
'name': 'string'
},
],
'assetCompositeModelName': 'string',
'assetCompositeModelDescription': 'string',
'assetCompositeModelType': 'string',
'assetCompositeModelProperties': [
{
'id': 'string',
'externalId': 'string',
'name': 'string',
'alias': 'string',
'notification': {
'topic': 'string',
'state': 'ENABLED'|'DISABLED'
},
'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN'|'STRUCT'|'VIDEO'|'ANNOTATION'|'JSON',
'dataTypeSpec': 'string',
'unit': 'string',
'path': [
{
'id': 'string',
'name': 'string'
},
]
},
],
'assetCompositeModelSummaries': [
{
'id': 'string',
'externalId': 'string',
'name': 'string',
'type': 'string',
'description': 'string',
'path': [
{
'id': 'string',
'name': 'string'
},
]
},
],
'actionDefinitions': [
{
'actionDefinitionId': 'string',
'actionName': 'string',
'actionType': 'string'
},
]
}
Response Structure
(dict) --
assetId (string) --
The ID of the asset, in UUID format. This ID uniquely identifies the asset within IoT SiteWise and can be used with other IoT SiteWise APIs.
assetCompositeModelId (string) --
The ID of a composite model on this asset.
assetCompositeModelExternalId (string) --
An external ID to assign to the asset model.
If the composite model is a component-based composite model, or one nested inside a component model, you can only set the external ID using UpdateAssetModelCompositeModel and specifying the derived ID of the model or property from the created model it's a part of.
assetCompositeModelPath (list) --
The path to the composite model listing the parent composite models.
(dict) --
Represents one level between a composite model and the root of the asset.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
assetCompositeModelName (string) --
The unique, friendly name for the composite model.
assetCompositeModelDescription (string) --
A description for the composite model.
assetCompositeModelType (string) --
The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.
assetCompositeModelProperties (list) --
The property definitions of the composite model that was used to create the asset.
(dict) --
Contains asset property information.
id (string) --
The ID of the asset property.
externalId (string) --
The external ID of the asset property. For more information, see Using external IDs in the IoT SiteWise User Guide.
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.
path (list) --
The structured path to the property from the root of the asset.
(dict) --
Represents one level between a property and the root of the asset.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
assetCompositeModelSummaries (list) --
The list of composite model summaries.
(dict) --
Contains a summary of the composite model for a specific asset.
id (string) --
The ID of the composite model that this summary describes.
externalId (string) --
An external ID to assign to the asset model.
If the composite model is a derived composite model, or one nested inside a component model, you can only set the external ID using UpdateAssetModelCompositeModel and specifying the derived ID of the model or property from the created model it's a part of.
name (string) --
The name of the composite model that this summary describes.
type (string) --
The type of asset model.
ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.
COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
description (string) --
A description of the composite model that this summary describes.
path (list) --
The path that includes all the components of the asset model for the asset.
(dict) --
Represents one level between a composite model and the root of the asset.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
actionDefinitions (list) --
The available actions for a composite model on this asset.
(dict) --
Contains a definition for an action.
actionDefinitionId (string) --
The ID of the action definition.
actionName (string) --
The name of the action definition.
actionType (string) --
The type of the action definition.
{'assetModelCompositeModels': {'properties': {'dataType': {'ANNOTATION',
'JSON',
'VIDEO'}}},
'assetModelProperties': {'dataType': {'JSON', 'ANNOTATION', 'VIDEO'}}}
Retrieves information about an asset model. This includes details about the asset model's properties, hierarchies, composite models, and any interface relationships if the asset model implements interfaces.
See also: AWS API Documentation
Request Syntax
client.describe_asset_model(
assetModelId='string',
excludeProperties=True|False,
assetModelVersion='string'
)
string
[REQUIRED]
The ID of the asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
boolean
Whether or not to exclude asset model properties from the response.
string
The version alias that specifies the latest or active version of the asset model. The details are returned in the response. The default value is LATEST. See Asset model versions in the IoT SiteWise User Guide.
dict
Response Syntax
{
'assetModelId': 'string',
'assetModelExternalId': 'string',
'assetModelArn': 'string',
'assetModelName': 'string',
'assetModelType': 'ASSET_MODEL'|'COMPONENT_MODEL'|'INTERFACE',
'assetModelDescription': 'string',
'assetModelProperties': [
{
'id': 'string',
'externalId': 'string',
'name': 'string',
'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN'|'STRUCT'|'VIDEO'|'ANNOTATION'|'JSON',
'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',
'propertyPath': [
{
'id': 'string',
'name': 'string'
},
]
}
},
],
'processingConfig': {
'computeLocation': 'EDGE'|'CLOUD',
'forwardingConfig': {
'state': 'DISABLED'|'ENABLED'
}
}
},
'metric': {
'expression': 'string',
'variables': [
{
'name': 'string',
'value': {
'propertyId': 'string',
'hierarchyId': 'string',
'propertyPath': [
{
'id': 'string',
'name': 'string'
},
]
}
},
],
'window': {
'tumbling': {
'interval': 'string',
'offset': 'string'
}
},
'processingConfig': {
'computeLocation': 'EDGE'|'CLOUD'
}
}
},
'path': [
{
'id': 'string',
'name': 'string'
},
]
},
],
'assetModelHierarchies': [
{
'id': 'string',
'externalId': 'string',
'name': 'string',
'childAssetModelId': 'string'
},
],
'assetModelCompositeModels': [
{
'name': 'string',
'description': 'string',
'type': 'string',
'properties': [
{
'id': 'string',
'externalId': 'string',
'name': 'string',
'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN'|'STRUCT'|'VIDEO'|'ANNOTATION'|'JSON',
'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',
'propertyPath': [
{
'id': 'string',
'name': 'string'
},
]
}
},
],
'processingConfig': {
'computeLocation': 'EDGE'|'CLOUD',
'forwardingConfig': {
'state': 'DISABLED'|'ENABLED'
}
}
},
'metric': {
'expression': 'string',
'variables': [
{
'name': 'string',
'value': {
'propertyId': 'string',
'hierarchyId': 'string',
'propertyPath': [
{
'id': 'string',
'name': 'string'
},
]
}
},
],
'window': {
'tumbling': {
'interval': 'string',
'offset': 'string'
}
},
'processingConfig': {
'computeLocation': 'EDGE'|'CLOUD'
}
}
},
'path': [
{
'id': 'string',
'name': 'string'
},
]
},
],
'id': 'string',
'externalId': 'string'
},
],
'assetModelCompositeModelSummaries': [
{
'id': 'string',
'externalId': 'string',
'name': 'string',
'type': 'string',
'description': 'string',
'path': [
{
'id': 'string',
'name': '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'
},
]
}
},
'assetModelVersion': 'string',
'interfaceDetails': [
{
'id': 'string'
},
],
'eTag': 'string'
}
Response Structure
(dict) --
assetModelId (string) --
The ID of the asset model, in UUID format.
assetModelExternalId (string) --
The external ID of the asset model, if any.
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.
assetModelType (string) --
The type of asset model.
ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.
COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
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.
If you are callling UpdateAssetModel to create a new property: You can specify its ID here, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
If you are calling UpdateAssetModel to modify an existing property: This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
externalId (string) --
The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation. You can assign an external ID by specifying this value as part of a call to UpdateAssetModel. However, you can't change the external ID if one is already assigned. For more information, see Using external IDs in the IoT SiteWise User Guide.
name (string) --
The name of the asset model property.
dataType (string) --
The data type of the asset model property.
The VIDEO, ANNOTATION, and JSON data types aren't supported for asset model properties. These types are used only by time series that store data for datasets in a workspace.
If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this 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. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
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. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
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.
propertyPath (list) --
The path of the property.
(dict) --
Represents one level between a property and the root of the asset model.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
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. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
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. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
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.
propertyPath (list) --
The path of the property.
(dict) --
Represents one level between a property and the root of the asset model.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
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:
The offset time. For example, if you specify 18h for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The ISO 8601 format. For example, if you specify PT18H for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The 24-hour clock. For example, if you specify 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).
The offset time zone. For example, if you specify 2021-07-23T18:00-08 for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric.
If you create the metric after 6 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.
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.
path (list) --
The structured path to the property from the root of the asset model.
(dict) --
Represents one level between a property and the root of the asset model.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
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.
If you are callling UpdateAssetModel to create a new hierarchy: You can specify its ID here, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
If you are calling UpdateAssetModel to modify an existing hierarchy: This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
externalId (string) --
The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation. You can assign an external ID by specifying this value as part of a call to UpdateAssetModel. However, you can't change the external ID if one is already assigned. For more information, see Using external IDs in the IoT SiteWise User Guide.
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, in UUID format. All assets in this hierarchy must be instances of the childAssetModelId asset model. IoT SiteWise will always return the actual asset model ID for this value. However, when you are specifying this value as part of a call to UpdateAssetModel, you may provide either the asset model ID or else externalId: followed by the asset model's external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
assetModelCompositeModels (list) --
The list of built-in composite models for the asset model, such as those with those of type AWS/ALARMS.
(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.
If you are callling UpdateAssetModel to create a new property: You can specify its ID here, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
If you are calling UpdateAssetModel to modify an existing property: This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
externalId (string) --
The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation. You can assign an external ID by specifying this value as part of a call to UpdateAssetModel. However, you can't change the external ID if one is already assigned. For more information, see Using external IDs in the IoT SiteWise User Guide.
name (string) --
The name of the asset model property.
dataType (string) --
The data type of the asset model property.
The VIDEO, ANNOTATION, and JSON data types aren't supported for asset model properties. These types are used only by time series that store data for datasets in a workspace.
If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this 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. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
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. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
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.
propertyPath (list) --
The path of the property.
(dict) --
Represents one level between a property and the root of the asset model.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
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. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
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. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
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.
propertyPath (list) --
The path of the property.
(dict) --
Represents one level between a property and the root of the asset model.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
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:
The offset time. For example, if you specify 18h for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The ISO 8601 format. For example, if you specify PT18H for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The 24-hour clock. For example, if you specify 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).
The offset time zone. For example, if you specify 2021-07-23T18:00-08 for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric.
If you create the metric after 6 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.
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.
path (list) --
The structured path to the property from the root of the asset model.
(dict) --
Represents one level between a property and the root of the asset model.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
id (string) --
The ID of the asset model composite model.
externalId (string) --
The external ID of the asset model composite model. For more information, see Using external IDs in the IoT SiteWise User Guide.
assetModelCompositeModelSummaries (list) --
The list of the immediate child custom composite model summaries for the asset model.
(dict) --
Contains a summary of the composite model.
id (string) --
The ID of the composite model that this summary describes..
externalId (string) --
The external ID of a composite model on this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
name (string) --
The name of the composite model that this summary describes..
type (string) --
The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.
description (string) --
The description of the composite model that this summary describes..
path (list) --
The path that includes all the pieces that make up the composite model.
(dict) --
Represents one level between a composite model and the root of the asset model.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
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.
assetModelVersion (string) --
The version of the asset model. See Asset model versions in the IoT SiteWise User Guide.
interfaceDetails (list) --
A list of interface details that describe the interfaces implemented by this asset model, including interface asset model IDs and property mappings.
(dict) --
Contains information about the relationship between an asset model and an interface asset model that is applied to it.
id (string) --
The ID of the asset model that has the interface applied to it.
eTag (string) --
The entity tag (ETag) is a hash of the retrieved version of the asset model. It's used to make concurrent updates safely to the resource. See Optimistic locking for asset model writes in the IoT SiteWise User Guide.
See Optimistic locking for asset model writes in the IoT SiteWise User Guide.
{'assetModelCompositeModelProperties': {'dataType': {'ANNOTATION',
'JSON',
'VIDEO'}}}
Retrieves information about an asset model composite model (also known as an asset model component). For more information, see Custom composite models (Components) in the IoT SiteWise User Guide.
See also: AWS API Documentation
Request Syntax
client.describe_asset_model_composite_model(
assetModelId='string',
assetModelCompositeModelId='string',
assetModelVersion='string'
)
string
[REQUIRED]
The ID of the asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
string
[REQUIRED]
The ID of a composite model on this asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
string
The version alias that specifies the latest or active version of the asset model. The details are returned in the response. The default value is LATEST. See Asset model versions in the IoT SiteWise User Guide.
dict
Response Syntax
{
'assetModelId': 'string',
'assetModelCompositeModelId': 'string',
'assetModelCompositeModelExternalId': 'string',
'assetModelCompositeModelPath': [
{
'id': 'string',
'name': 'string'
},
],
'assetModelCompositeModelName': 'string',
'assetModelCompositeModelDescription': 'string',
'assetModelCompositeModelType': 'string',
'assetModelCompositeModelProperties': [
{
'id': 'string',
'externalId': 'string',
'name': 'string',
'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN'|'STRUCT'|'VIDEO'|'ANNOTATION'|'JSON',
'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',
'propertyPath': [
{
'id': 'string',
'name': 'string'
},
]
}
},
],
'processingConfig': {
'computeLocation': 'EDGE'|'CLOUD',
'forwardingConfig': {
'state': 'DISABLED'|'ENABLED'
}
}
},
'metric': {
'expression': 'string',
'variables': [
{
'name': 'string',
'value': {
'propertyId': 'string',
'hierarchyId': 'string',
'propertyPath': [
{
'id': 'string',
'name': 'string'
},
]
}
},
],
'window': {
'tumbling': {
'interval': 'string',
'offset': 'string'
}
},
'processingConfig': {
'computeLocation': 'EDGE'|'CLOUD'
}
}
},
'path': [
{
'id': 'string',
'name': 'string'
},
]
},
],
'compositionDetails': {
'compositionRelationship': [
{
'id': 'string'
},
]
},
'assetModelCompositeModelSummaries': [
{
'id': 'string',
'externalId': 'string',
'name': 'string',
'type': 'string',
'description': 'string',
'path': [
{
'id': 'string',
'name': 'string'
},
]
},
],
'actionDefinitions': [
{
'actionDefinitionId': 'string',
'actionName': 'string',
'actionType': 'string'
},
]
}
Response Structure
(dict) --
assetModelId (string) --
The ID of the asset model, in UUID format.
assetModelCompositeModelId (string) --
The ID of a composite model on this asset model.
assetModelCompositeModelExternalId (string) --
The external ID of a composite model on this asset model.
assetModelCompositeModelPath (list) --
The path to the composite model listing the parent composite models.
(dict) --
Represents one level between a composite model and the root of the asset model.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
assetModelCompositeModelName (string) --
The unique, friendly name for the composite model.
assetModelCompositeModelDescription (string) --
The description for the composite model.
assetModelCompositeModelType (string) --
The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.
assetModelCompositeModelProperties (list) --
The property definitions of the composite model.
(dict) --
Contains information about an asset model property.
id (string) --
The ID of the asset model property.
If you are callling UpdateAssetModel to create a new property: You can specify its ID here, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
If you are calling UpdateAssetModel to modify an existing property: This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
externalId (string) --
The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation. You can assign an external ID by specifying this value as part of a call to UpdateAssetModel. However, you can't change the external ID if one is already assigned. For more information, see Using external IDs in the IoT SiteWise User Guide.
name (string) --
The name of the asset model property.
dataType (string) --
The data type of the asset model property.
The VIDEO, ANNOTATION, and JSON data types aren't supported for asset model properties. These types are used only by time series that store data for datasets in a workspace.
If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this 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. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
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. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
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.
propertyPath (list) --
The path of the property.
(dict) --
Represents one level between a property and the root of the asset model.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
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. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
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. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
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.
propertyPath (list) --
The path of the property.
(dict) --
Represents one level between a property and the root of the asset model.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
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:
The offset time. For example, if you specify 18h for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The ISO 8601 format. For example, if you specify PT18H for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The 24-hour clock. For example, if you specify 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).
The offset time zone. For example, if you specify 2021-07-23T18:00-08 for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric.
If you create the metric after 6 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.
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.
path (list) --
The structured path to the property from the root of the asset model.
(dict) --
Represents one level between a property and the root of the asset model.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
compositionDetails (dict) --
Metadata for the composition relationship established by using composedAssetModelId in CreateAssetModelCompositeModel. For instance, an array detailing the path of the composition relationship for this composite model.
compositionRelationship (list) --
An array detailing the composition relationship for this composite model.
(dict) --
Represents a composite model that composed an asset model of type COMPONENT_MODEL.
id (string) --
The ID of the component.
assetModelCompositeModelSummaries (list) --
The list of composite model summaries for the composite model.
(dict) --
Contains a summary of the composite model.
id (string) --
The ID of the composite model that this summary describes..
externalId (string) --
The external ID of a composite model on this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
name (string) --
The name of the composite model that this summary describes..
type (string) --
The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.
description (string) --
The description of the composite model that this summary describes..
path (list) --
The path that includes all the pieces that make up the composite model.
(dict) --
Represents one level between a composite model and the root of the asset model.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
actionDefinitions (list) --
The available actions for a composite model on this asset model.
(dict) --
Contains a definition for an action.
actionDefinitionId (string) --
The ID of the action definition.
actionName (string) --
The name of the action definition.
actionType (string) --
The type of the action definition.
{'assetProperty': {'dataType': {'JSON', 'ANNOTATION', 'VIDEO'}},
'compositeModel': {'assetProperty': {'dataType': {'ANNOTATION',
'JSON',
'VIDEO'}}}}
Retrieves information about an asset property.
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
client.describe_asset_property(
assetId='string',
propertyId='string'
)
string
[REQUIRED]
The ID of the asset. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
string
[REQUIRED]
The ID of the asset property. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
dict
Response Syntax
{
'assetId': 'string',
'assetExternalId': 'string',
'assetName': 'string',
'assetModelId': 'string',
'assetProperty': {
'id': 'string',
'externalId': 'string',
'name': 'string',
'alias': 'string',
'notification': {
'topic': 'string',
'state': 'ENABLED'|'DISABLED'
},
'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN'|'STRUCT'|'VIDEO'|'ANNOTATION'|'JSON',
'unit': 'string',
'type': {
'attribute': {
'defaultValue': 'string'
},
'measurement': {
'processingConfig': {
'forwardingConfig': {
'state': 'DISABLED'|'ENABLED'
}
}
},
'transform': {
'expression': 'string',
'variables': [
{
'name': 'string',
'value': {
'propertyId': 'string',
'hierarchyId': 'string',
'propertyPath': [
{
'id': 'string',
'name': 'string'
},
]
}
},
],
'processingConfig': {
'computeLocation': 'EDGE'|'CLOUD',
'forwardingConfig': {
'state': 'DISABLED'|'ENABLED'
}
}
},
'metric': {
'expression': 'string',
'variables': [
{
'name': 'string',
'value': {
'propertyId': 'string',
'hierarchyId': 'string',
'propertyPath': [
{
'id': 'string',
'name': 'string'
},
]
}
},
],
'window': {
'tumbling': {
'interval': 'string',
'offset': 'string'
}
},
'processingConfig': {
'computeLocation': 'EDGE'|'CLOUD'
}
}
},
'path': [
{
'id': 'string',
'name': 'string'
},
]
},
'compositeModel': {
'name': 'string',
'type': 'string',
'assetProperty': {
'id': 'string',
'externalId': 'string',
'name': 'string',
'alias': 'string',
'notification': {
'topic': 'string',
'state': 'ENABLED'|'DISABLED'
},
'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN'|'STRUCT'|'VIDEO'|'ANNOTATION'|'JSON',
'unit': 'string',
'type': {
'attribute': {
'defaultValue': 'string'
},
'measurement': {
'processingConfig': {
'forwardingConfig': {
'state': 'DISABLED'|'ENABLED'
}
}
},
'transform': {
'expression': 'string',
'variables': [
{
'name': 'string',
'value': {
'propertyId': 'string',
'hierarchyId': 'string',
'propertyPath': [
{
'id': 'string',
'name': 'string'
},
]
}
},
],
'processingConfig': {
'computeLocation': 'EDGE'|'CLOUD',
'forwardingConfig': {
'state': 'DISABLED'|'ENABLED'
}
}
},
'metric': {
'expression': 'string',
'variables': [
{
'name': 'string',
'value': {
'propertyId': 'string',
'hierarchyId': 'string',
'propertyPath': [
{
'id': 'string',
'name': 'string'
},
]
}
},
],
'window': {
'tumbling': {
'interval': 'string',
'offset': 'string'
}
},
'processingConfig': {
'computeLocation': 'EDGE'|'CLOUD'
}
}
},
'path': [
{
'id': 'string',
'name': 'string'
},
]
},
'id': 'string',
'externalId': 'string'
}
}
Response Structure
(dict) --
assetId (string) --
The ID of the asset, in UUID format.
assetExternalId (string) --
The external ID of the asset. For more information, see Using external IDs in the IoT SiteWise User Guide.
assetName (string) --
The name of the asset.
assetModelId (string) --
The ID of the asset model, in UUID format.
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.
externalId (string) --
The external ID of the asset property. For more information, see Using external IDs in the IoT SiteWise User Guide.
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. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
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. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
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.
propertyPath (list) --
The path of the property.
(dict) --
Represents one level between a property and the root of the asset model.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
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. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
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. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
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.
propertyPath (list) --
The path of the property.
(dict) --
Represents one level between a property and the root of the asset model.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
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:
The offset time. For example, if you specify 18h for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The ISO 8601 format. For example, if you specify PT18H for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The 24-hour clock. For example, if you specify 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).
The offset time zone. For example, if you specify 2021-07-23T18:00-08 for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric.
If you create the metric after 6 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.
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.
path (list) --
The structured path to the property from the root of the asset.
(dict) --
Represents one level between a property and the root of the asset.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
compositeModel (dict) --
The composite 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.
externalId (string) --
The external ID of the asset property. For more information, see Using external IDs in the IoT SiteWise User Guide.
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. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
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. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
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.
propertyPath (list) --
The path of the property.
(dict) --
Represents one level between a property and the root of the asset model.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
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. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
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. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
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.
propertyPath (list) --
The path of the property.
(dict) --
Represents one level between a property and the root of the asset model.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
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:
The offset time. For example, if you specify 18h for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The ISO 8601 format. For example, if you specify PT18H for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The 24-hour clock. For example, if you specify 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).
The offset time zone. For example, if you specify 2021-07-23T18:00-08 for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric.
If you create the metric after 6 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.
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.
path (list) --
The structured path to the property from the root of the asset.
(dict) --
Represents one level between a property and the root of the asset.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
id (string) --
The ID of the composite model that contains the property.
externalId (string) --
The external ID of the composite model that contains the property. For more information, see Using external IDs in the IoT SiteWise User Guide.
{'workspaceName': 'string'}
Response {'datasetId': 'string',
'files': {'alias': 'string',
'fileFormat': {'annotation': {},
'csv': {'columnNames': ['ALIAS | ASSET_ID | '
'PROPERTY_ID | DATA_TYPE | '
'TIMESTAMP_SECONDS | '
'TIMESTAMP_NANO_OFFSET | '
'QUALITY | VALUE']},
'mp4': {},
'parquet': {}},
'startTime': {'offsetInNanos': 'integer', 'timeInSeconds': 'long'}},
'jobConfiguration': {'fileFormat': {'annotation': {}, 'mp4': {}}},
'workspaceName': 'string'}
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
client.describe_bulk_import_job(
jobId='string',
workspaceName='string'
)
string
[REQUIRED]
The ID of the job.
string
The name of the workspace.
dict
Response Syntax
{
'jobId': 'string',
'jobName': 'string',
'jobStatus': 'PENDING'|'CANCELLED'|'RUNNING'|'COMPLETED'|'FAILED'|'COMPLETED_WITH_FAILURES',
'jobRoleArn': 'string',
'files': [
{
'bucket': 'string',
'key': 'string',
'versionId': 'string',
'alias': 'string',
'startTime': {
'timeInSeconds': 123,
'offsetInNanos': 123
},
'fileFormat': {
'csv': {
'columnNames': [
'ALIAS'|'ASSET_ID'|'PROPERTY_ID'|'DATA_TYPE'|'TIMESTAMP_SECONDS'|'TIMESTAMP_NANO_OFFSET'|'QUALITY'|'VALUE',
]
},
'parquet': {},
'mp4': {},
'annotation': {}
}
},
],
'errorReportLocation': {
'bucket': 'string',
'prefix': 'string'
},
'jobConfiguration': {
'fileFormat': {
'csv': {
'columnNames': [
'ALIAS'|'ASSET_ID'|'PROPERTY_ID'|'DATA_TYPE'|'TIMESTAMP_SECONDS'|'TIMESTAMP_NANO_OFFSET'|'QUALITY'|'VALUE',
]
},
'parquet': {},
'mp4': {},
'annotation': {}
}
},
'jobCreationDate': datetime(2015, 1, 1),
'jobLastUpdateDate': datetime(2015, 1, 1),
'adaptiveIngestion': True|False,
'deleteFilesAfterImport': True|False,
'datasetId': 'string',
'workspaceName': 'string'
}
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.
jobRoleArn (string) --
The ARN of the IAM role that allows IoT SiteWise to read Amazon S3 data.
files (list) --
The files in the specified Amazon S3 bucket that contain your data. You can specify up to 100 files for each bulk import job. Each file supports the following size limits:
Parquet files – Up to 256 MiB.
Other file formats – Up to 5 GiB.
(dict) --
The file in Amazon S3 where your data is saved.
bucket (string) --
The name of the Amazon S3 bucket from which data is imported.
key (string) --
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.
versionId (string) --
The version ID to identify a specific version of the Amazon S3 object that contains your data.
alias (string) --
The alias associated with the file's time series.
startTime (dict) --
The nanosecond-precision start time for the file data.
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.
fileFormat (dict) --
The file format of the data in S3.
csv (dict) --
The file is in .CSV format.
columnNames (list) --
The column names specified in the .csv file.
(string) --
parquet (dict) --
The file is in parquet format.
mp4 (dict) --
The MP4 format configuration.
annotation (dict) --
The annotation format configuration.
errorReportLocation (dict) --
The Amazon S3 destination where errors associated with the job creation request are saved.
bucket (string) --
The name of the Amazon S3 bucket to which errors associated with the bulk import job are sent.
prefix (string) --
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.
jobConfiguration (dict) --
Contains the configuration information of a job, such as the file format used to save data in Amazon S3.
fileFormat (dict) --
The file format of the data in S3.
csv (dict) --
The file is in .CSV format.
columnNames (list) --
The column names specified in the .csv file.
(string) --
parquet (dict) --
The file is in parquet format.
mp4 (dict) --
The MP4 format configuration.
annotation (dict) --
The annotation format configuration.
jobCreationDate (datetime) --
The date the job was created, in Unix epoch TIME.
jobLastUpdateDate (datetime) --
The date the job was last updated, in Unix epoch time.
adaptiveIngestion (boolean) --
If set to true, ingest new data into IoT SiteWise storage. Measurements with notifications, metrics and transforms are computed. If set to false, historical data is ingested into IoT SiteWise as is.
deleteFilesAfterImport (boolean) --
If set to true, your data files is deleted from S3, after ingestion into IoT SiteWise storage.
datasetId (string) --
The ID of the dataset.
workspaceName (string) --
The name of the workspace.
{'datasetVersion': 'string', 'workspaceName': 'string'}
Response {'datasetConfig': {'session': {'sessionEndTimestamp': {'offsetInNanos': 'integer',
'timeInSeconds': 'long'},
'sessionStartTimestamp': {'offsetInNanos': 'integer',
'timeInSeconds': 'long'}}},
'datasetSource': {'sourceFormat': {'TIMESERIES'}, 'sourceType': {'SITEWISE'}},
'datasetType': 'SESSION | CURATED | EXTERNAL',
'enrichmentStatus': {'video': {'lastEnrichedAt': 'timestamp',
'status': 'FULLY_ENRICHED | PARTIALLY_ENRICHED '
'| NOT_ENRICHED'}},
'metadata': {'string': 'string'},
'workspaceName': 'string'}
Retrieves information about a dataset.
See also: AWS API Documentation
Request Syntax
client.describe_dataset(
datasetId='string',
workspaceName='string',
datasetVersion='string'
)
string
[REQUIRED]
The ID of the dataset.
string
The name of the workspace that contains the dataset.
string
The version of the dataset.
dict
Response Syntax
{
'datasetId': 'string',
'datasetArn': 'string',
'datasetName': 'string',
'datasetDescription': 'string',
'datasetType': 'SESSION'|'CURATED'|'EXTERNAL',
'datasetConfig': {
'session': {
'sessionStartTimestamp': {
'timeInSeconds': 123,
'offsetInNanos': 123
},
'sessionEndTimestamp': {
'timeInSeconds': 123,
'offsetInNanos': 123
}
}
},
'workspaceName': 'string',
'metadata': {
'string': 'string'
},
'datasetSource': {
'sourceType': 'KENDRA'|'SITEWISE',
'sourceFormat': 'KNOWLEDGE_BASE'|'TIMESERIES',
'sourceDetail': {
'kendra': {
'knowledgeBaseArn': 'string',
'roleArn': 'string'
}
}
},
'datasetStatus': {
'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED',
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
'message': 'string',
'details': [
{
'code': 'INCOMPATIBLE_COMPUTE_LOCATION'|'INCOMPATIBLE_FORWARDING_CONFIGURATION',
'message': 'string'
},
]
}
},
'datasetCreationDate': datetime(2015, 1, 1),
'datasetLastUpdateDate': datetime(2015, 1, 1),
'datasetVersion': 'string',
'enrichmentStatus': {
'video': {
'status': 'FULLY_ENRICHED'|'PARTIALLY_ENRICHED'|'NOT_ENRICHED',
'lastEnrichedAt': datetime(2015, 1, 1)
}
}
}
Response Structure
(dict) --
datasetId (string) --
The ID of the dataset.
datasetArn (string) --
The ARN of the dataset. The format is arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId}.
datasetName (string) --
The name of the dataset.
datasetDescription (string) --
A description about the dataset, and its functionality.
datasetType (string) --
The type of dataset: a session dataset, a curated dataset, or a connection to an external datasource.
datasetConfig (dict) --
The configuration for the dataset.
session (dict) --
The session configuration for a session-type dataset.
sessionStartTimestamp (dict) --
The nanosecond-precision start time of the session.
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.
sessionEndTimestamp (dict) --
The nanosecond-precision end time of the session.
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.
workspaceName (string) --
The name of the workspace that contains the dataset.
metadata (dict) --
The metadata for the dataset.
(string) --
(string) --
datasetSource (dict) --
The data source for the dataset.
sourceType (string) --
The type of data source for the dataset.
sourceFormat (string) --
The format of the dataset source associated with the dataset.
sourceDetail (dict) --
The details of the dataset source associated with the dataset.
kendra (dict) --
Contains details about the Kendra dataset source.
knowledgeBaseArn (string) --
The knowledgeBaseArn details for the Kendra dataset source.
roleArn (string) --
The roleARN details for the Kendra dataset source.
datasetStatus (dict) --
The status of the dataset. This contains the state and any error messages. State is CREATING after a successfull call to this API, and any associated error message. The state is ACTIVE when ready to use.
state (string) --
The current status of the dataset.
error (dict) --
Contains the details of an IoT SiteWise error.
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.
datasetCreationDate (datetime) --
The dataset creation date, in Unix epoch time.
datasetLastUpdateDate (datetime) --
The date the dataset was last updated, in Unix epoch time.
datasetVersion (string) --
The version of the dataset.
enrichmentStatus (dict) --
The enrichment status of the dataset.
video (dict) --
The enrichment status for video data in the dataset.
status (string) --
The enrichment status of the data type in the dataset.
lastEnrichedAt (datetime) --
The date the data was last enriched, in Unix epoch time.
{'workspaceName': 'string'}
Retrieves the current IoT SiteWise logging options.
See also: AWS API Documentation
Request Syntax
client.describe_logging_options(
workspaceName='string'
)
string
The name of the workspace.
dict
Response Syntax
{
'loggingOptions': {
'level': 'ERROR'|'INFO'|'OFF'
}
}
Response Structure
(dict) --
loggingOptions (dict) --
The current logging options.
level (string) --
The IoT SiteWise logging verbosity level.
{'workspaceName': 'string'}
Response {'dataType': {'JSON', 'ANNOTATION', 'VIDEO'}, 'workspaceName': 'string'}
Retrieves information about a time series (data stream).
To identify a time series, do one of the following:
If the time series isn't associated with an asset property, specify the alias of the time series.
If the time series is associated with an asset property, specify one of the following:
The alias of the time series.
The assetId and propertyId that identifies the asset property.
See also: AWS API Documentation
Request Syntax
client.describe_time_series(
alias='string',
assetId='string',
propertyId='string',
workspaceName='string'
)
string
The alias that identifies the time series.
string
The ID of the asset in which the asset property was created. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
string
The ID of the asset property. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
string
The name of the workspace.
dict
Response Syntax
{
'assetId': 'string',
'propertyId': 'string',
'alias': 'string',
'timeSeriesId': 'string',
'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN'|'STRUCT'|'VIDEO'|'ANNOTATION'|'JSON',
'dataTypeSpec': 'string',
'timeSeriesCreationDate': datetime(2015, 1, 1),
'timeSeriesLastUpdateDate': datetime(2015, 1, 1),
'timeSeriesArn': 'string',
'workspaceName': 'string'
}
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, in UUID format.
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.
timeSeriesArn (string) --
The ARN of the time series, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId}
workspaceName (string) --
The name of the workspace.
{'assetModelPropertySummaries': {'dataType': {'JSON', 'ANNOTATION', 'VIDEO'}}}
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
client.list_asset_model_properties(
assetModelId='string',
nextToken='string',
maxResults=123,
filter='ALL'|'BASE',
assetModelVersion='string'
)
string
[REQUIRED]
The ID of the asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
string
The token to be used for the next set of paginated results.
integer
The maximum number of results to return for each paginated request. If not specified, the default value is 50.
string
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
string
The version alias that specifies the latest or active version of the asset model. The details are returned in the response. The default value is LATEST. See Asset model versions in the IoT SiteWise User Guide.
dict
Response Syntax
{
'assetModelPropertySummaries': [
{
'id': 'string',
'externalId': 'string',
'name': 'string',
'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN'|'STRUCT'|'VIDEO'|'ANNOTATION'|'JSON',
'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',
'propertyPath': [
{
'id': 'string',
'name': 'string'
},
]
}
},
],
'processingConfig': {
'computeLocation': 'EDGE'|'CLOUD',
'forwardingConfig': {
'state': 'DISABLED'|'ENABLED'
}
}
},
'metric': {
'expression': 'string',
'variables': [
{
'name': 'string',
'value': {
'propertyId': 'string',
'hierarchyId': 'string',
'propertyPath': [
{
'id': 'string',
'name': 'string'
},
]
}
},
],
'window': {
'tumbling': {
'interval': 'string',
'offset': 'string'
}
},
'processingConfig': {
'computeLocation': 'EDGE'|'CLOUD'
}
}
},
'assetModelCompositeModelId': 'string',
'path': [
{
'id': 'string',
'name': 'string'
},
],
'interfaceSummaries': [
{
'interfaceAssetModelId': 'string',
'interfaceAssetModelPropertyId': '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. This includes information about which interfaces the property belongs to, if any.
id (string) --
The ID of the property.
externalId (string) --
The external ID of the property. For more information, see Using external IDs in the IoT SiteWise User Guide.
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. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
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. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
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.
propertyPath (list) --
The path of the property.
(dict) --
Represents one level between a property and the root of the asset model.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
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. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
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. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
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.
propertyPath (list) --
The path of the property.
(dict) --
Represents one level between a property and the root of the asset model.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
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:
The offset time. For example, if you specify 18h for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The ISO 8601 format. For example, if you specify PT18H for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The 24-hour clock. For example, if you specify 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).
The offset time zone. For example, if you specify 2021-07-23T18:00-08 for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric.
If you create the metric after 6 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.
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.
path (list) --
The structured path to the property from the root of the asset model.
(dict) --
Represents one level between a property and the root of the asset model.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
interfaceSummaries (list) --
A list of interface summaries that describe which interfaces this property belongs to, including the interface asset model ID and the corresponding property ID in the interface.
(dict) --
Contains summary information about an interface that a property belongs to.
interfaceAssetModelId (string) --
The ID of the interface asset model that contains this property.
interfaceAssetModelPropertyId (string) --
The ID of the property in the interface asset model that corresponds to this property.
nextToken (string) --
The token for the next set of results, or null if there are no additional results.
{'workspaceName': 'string'}
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
client.list_bulk_import_jobs(
nextToken='string',
maxResults=123,
filter='ALL'|'PENDING'|'RUNNING'|'CANCELLED'|'FAILED'|'COMPLETED_WITH_FAILURES'|'COMPLETED',
workspaceName='string'
)
string
The token to be used for the next set of paginated results.
integer
The maximum number of results to return for each paginated request.
string
You can use a filter to select the bulk import jobs that you want to retrieve.
string
The name of the workspace.
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 the 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.
{'datasetType': 'SESSION | CURATED | EXTERNAL',
'sourceType': {'SITEWISE'},
'workspaceName': 'string'}
Response {'datasetSummaries': {'datasetType': 'SESSION | CURATED | EXTERNAL',
'enrichmentStatus': {'video': {'lastEnrichedAt': 'timestamp',
'status': 'FULLY_ENRICHED '
'| '
'PARTIALLY_ENRICHED '
'| '
'NOT_ENRICHED'}},
'sourceType': 'KENDRA | SITEWISE'},
'workspaceName': 'string'}
Retrieves a paginated list of datasets for a specific target resource.
See also: AWS API Documentation
Request Syntax
client.list_datasets(
sourceType='KENDRA'|'SITEWISE',
workspaceName='string',
datasetType='SESSION'|'CURATED'|'EXTERNAL',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The type of data source for the dataset.
string
The name of the workspace to filter datasets by.
string
The type of dataset to filter by: a session dataset, a curated dataset, or a connection to an external datasource.
string
The token for the next set of results, or null if there are no additional results.
integer
The maximum number of results to return for each paginated request.
dict
Response Syntax
{
'datasetSummaries': [
{
'id': 'string',
'arn': 'string',
'name': 'string',
'description': 'string',
'sourceType': 'KENDRA'|'SITEWISE',
'datasetType': 'SESSION'|'CURATED'|'EXTERNAL',
'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'
},
]
}
},
'enrichmentStatus': {
'video': {
'status': 'FULLY_ENRICHED'|'PARTIALLY_ENRICHED'|'NOT_ENRICHED',
'lastEnrichedAt': datetime(2015, 1, 1)
}
}
},
],
'nextToken': 'string',
'workspaceName': 'string'
}
Response Structure
(dict) --
datasetSummaries (list) --
A list that summarizes the dataset response.
(dict) --
The summary details for the dataset.
id (string) --
The ID of the dataset.
arn (string) --
The ARN of the dataset. The format is arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId}.
name (string) --
The name of the dataset.
description (string) --
A description about the dataset, and its functionality.
sourceType (string) --
The data source type of the dataset.
datasetType (string) --
The type of dataset: a session dataset, a curated dataset, or a connection to an external datasource.
creationDate (datetime) --
The dataset creation date, in Unix epoch time.
lastUpdateDate (datetime) --
The date the dataset was last updated, in Unix epoch time.
status (dict) --
The status of the dataset. This contains the state and any error messages. The state is ACTIVE when ready to use.
state (string) --
The current status of the dataset.
error (dict) --
Contains the details of an IoT SiteWise error.
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.
enrichmentStatus (dict) --
The enrichment status of the dataset.
video (dict) --
The enrichment status for video data in the dataset.
status (string) --
The enrichment status of the data type in the dataset.
lastEnrichedAt (datetime) --
The date the data was last enriched, in Unix epoch time.
nextToken (string) --
The token for the next set of results, or null if there are no additional results.
workspaceName (string) --
The name of the workspace.
{'workspaceName': 'string'}
Response {'TimeSeriesSummaries': {'dataType': {'JSON', 'ANNOTATION', 'VIDEO'}},
'workspaceName': 'string'}
Retrieves a paginated list of time series (data streams).
See also: AWS API Documentation
Request Syntax
client.list_time_series(
nextToken='string',
maxResults=123,
assetId='string',
aliasPrefix='string',
timeSeriesType='ASSOCIATED'|'DISASSOCIATED',
workspaceName='string'
)
string
The token to be used for the next set of paginated results.
integer
The maximum number of results to return for each paginated request.
string
The ID of the asset in which the asset property was created. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
string
The alias prefix of the time series.
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.
string
The name of the workspace.
dict
Response Syntax
{
'TimeSeriesSummaries': [
{
'assetId': 'string',
'propertyId': 'string',
'alias': 'string',
'timeSeriesId': 'string',
'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN'|'STRUCT'|'VIDEO'|'ANNOTATION'|'JSON',
'dataTypeSpec': 'string',
'timeSeriesCreationDate': datetime(2015, 1, 1),
'timeSeriesLastUpdateDate': datetime(2015, 1, 1),
'timeSeriesArn': 'string'
},
],
'nextToken': 'string',
'workspaceName': '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, in UUID format.
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.
timeSeriesArn (string) --
The ARN of the time series, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId}
nextToken (string) --
The token for the next set of results, or null if there are no additional results.
workspaceName (string) --
The name of the workspace.
{'workspaceName': 'string'}
Sets logging options for IoT SiteWise.
See also: AWS API Documentation
Request Syntax
client.put_logging_options(
loggingOptions={
'level': 'ERROR'|'INFO'|'OFF'
},
workspaceName='string'
)
dict
[REQUIRED]
The logging options to set.
level (string) -- [REQUIRED]
The IoT SiteWise logging verbosity level.
string
The name of the workspace.
dict
Response Syntax
{}
Response Structure
(dict) --
{'assetId': 'string'}
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
client.update_asset(
assetId='string',
assetExternalId='string',
assetName='string',
clientToken='string',
assetDescription='string'
)
string
[REQUIRED]
The ID of the asset to update. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
string
An external ID to assign to the asset. The asset must not already have an external ID. The external ID must be unique within your Amazon Web Services account. For more information, see Using external IDs in the IoT SiteWise User Guide.
string
[REQUIRED]
A friendly name for the asset.
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.
string
A description for the asset.
dict
Response Syntax
{
'assetId': '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.
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.
{'assetModelCompositeModels': {'properties': {'dataType': {'ANNOTATION',
'JSON',
'VIDEO'}}},
'assetModelProperties': {'dataType': {'JSON', 'ANNOTATION', 'VIDEO'}}}
Response {'assetModelId': 'string'}
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.
See also: AWS API Documentation
Request Syntax
client.update_asset_model(
assetModelId='string',
assetModelExternalId='string',
assetModelName='string',
assetModelDescription='string',
assetModelProperties=[
{
'id': 'string',
'externalId': 'string',
'name': 'string',
'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN'|'STRUCT'|'VIDEO'|'ANNOTATION'|'JSON',
'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',
'propertyPath': [
{
'id': 'string',
'name': 'string'
},
]
}
},
],
'processingConfig': {
'computeLocation': 'EDGE'|'CLOUD',
'forwardingConfig': {
'state': 'DISABLED'|'ENABLED'
}
}
},
'metric': {
'expression': 'string',
'variables': [
{
'name': 'string',
'value': {
'propertyId': 'string',
'hierarchyId': 'string',
'propertyPath': [
{
'id': 'string',
'name': 'string'
},
]
}
},
],
'window': {
'tumbling': {
'interval': 'string',
'offset': 'string'
}
},
'processingConfig': {
'computeLocation': 'EDGE'|'CLOUD'
}
}
},
'path': [
{
'id': 'string',
'name': 'string'
},
]
},
],
assetModelHierarchies=[
{
'id': 'string',
'externalId': 'string',
'name': 'string',
'childAssetModelId': 'string'
},
],
assetModelCompositeModels=[
{
'name': 'string',
'description': 'string',
'type': 'string',
'properties': [
{
'id': 'string',
'externalId': 'string',
'name': 'string',
'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN'|'STRUCT'|'VIDEO'|'ANNOTATION'|'JSON',
'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',
'propertyPath': [
{
'id': 'string',
'name': 'string'
},
]
}
},
],
'processingConfig': {
'computeLocation': 'EDGE'|'CLOUD',
'forwardingConfig': {
'state': 'DISABLED'|'ENABLED'
}
}
},
'metric': {
'expression': 'string',
'variables': [
{
'name': 'string',
'value': {
'propertyId': 'string',
'hierarchyId': 'string',
'propertyPath': [
{
'id': 'string',
'name': 'string'
},
]
}
},
],
'window': {
'tumbling': {
'interval': 'string',
'offset': 'string'
}
},
'processingConfig': {
'computeLocation': 'EDGE'|'CLOUD'
}
}
},
'path': [
{
'id': 'string',
'name': 'string'
},
]
},
],
'id': 'string',
'externalId': 'string'
},
],
clientToken='string',
ifMatch='string',
ifNoneMatch='string',
matchForVersionType='LATEST'|'ACTIVE'
)
string
[REQUIRED]
The ID of the asset model to update. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
string
An external ID to assign to the asset model. The asset model must not already have an external ID. The external ID must be unique within your Amazon Web Services account. For more information, see Using external IDs in the IoT SiteWise User Guide.
string
[REQUIRED]
A unique name for the asset model.
string
A description for the asset model.
list
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.
(dict) --
Contains information about an asset model property.
id (string) --
The ID of the asset model property.
If you are callling UpdateAssetModel to create a new property: You can specify its ID here, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
If you are calling UpdateAssetModel to modify an existing property: This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
externalId (string) --
The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation. You can assign an external ID by specifying this value as part of a call to UpdateAssetModel. However, you can't change the external ID if one is already assigned. For more information, see Using external IDs in the IoT SiteWise User Guide.
name (string) -- [REQUIRED]
The name of the asset model property.
dataType (string) -- [REQUIRED]
The data type of the asset model property.
The VIDEO, ANNOTATION, and JSON data types aren't supported for asset model properties. These types are used only by time series that store data for datasets in a workspace.
If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this 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) -- [REQUIRED]
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) -- [REQUIRED]
The forwarding configuration for the given measurement property.
state (string) -- [REQUIRED]
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) -- [REQUIRED]
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) -- [REQUIRED]
The list of variables used in the expression.
(dict) --
Contains expression variable information.
name (string) -- [REQUIRED]
The friendly name of the variable to be used in the expression.
value (dict) -- [REQUIRED]
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. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
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. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
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.
propertyPath (list) --
The path of the property.
(dict) --
Represents one level between a property and the root of the asset model.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
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) -- [REQUIRED]
The compute location for the given transform property.
forwardingConfig (dict) --
The forwarding configuration for a given property.
state (string) -- [REQUIRED]
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) -- [REQUIRED]
The friendly name of the variable to be used in the expression.
value (dict) -- [REQUIRED]
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. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
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. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
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.
propertyPath (list) --
The path of the property.
(dict) --
Represents one level between a property and the root of the asset model.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
window (dict) -- [REQUIRED]
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) -- [REQUIRED]
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:
The offset time. For example, if you specify 18h for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The ISO 8601 format. For example, if you specify PT18H for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The 24-hour clock. For example, if you specify 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).
The offset time zone. For example, if you specify 2021-07-23T18:00-08 for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric.
If you create the metric after 6 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.
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) -- [REQUIRED]
The compute location for the given metric property.
path (list) --
The structured path to the property from the root of the asset model.
(dict) --
Represents one level between a property and the root of the asset model.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
list
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.
(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.
If you are callling UpdateAssetModel to create a new hierarchy: You can specify its ID here, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
If you are calling UpdateAssetModel to modify an existing hierarchy: This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
externalId (string) --
The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation. You can assign an external ID by specifying this value as part of a call to UpdateAssetModel. However, you can't change the external ID if one is already assigned. For more information, see Using external IDs in the IoT SiteWise User Guide.
name (string) -- [REQUIRED]
The name of the asset model hierarchy that you specify by using the CreateAssetModel or UpdateAssetModel API operation.
childAssetModelId (string) -- [REQUIRED]
The ID of the asset model, in UUID format. All assets in this hierarchy must be instances of the childAssetModelId asset model. IoT SiteWise will always return the actual asset model ID for this value. However, when you are specifying this value as part of a call to UpdateAssetModel, you may provide either the asset model ID or else externalId: followed by the asset model's external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
list
The composite models that are part of this asset model. It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this 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) -- [REQUIRED]
The name of the composite model.
description (string) --
The description of the composite model.
type (string) -- [REQUIRED]
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.
If you are callling UpdateAssetModel to create a new property: You can specify its ID here, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
If you are calling UpdateAssetModel to modify an existing property: This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
externalId (string) --
The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation. You can assign an external ID by specifying this value as part of a call to UpdateAssetModel. However, you can't change the external ID if one is already assigned. For more information, see Using external IDs in the IoT SiteWise User Guide.
name (string) -- [REQUIRED]
The name of the asset model property.
dataType (string) -- [REQUIRED]
The data type of the asset model property.
The VIDEO, ANNOTATION, and JSON data types aren't supported for asset model properties. These types are used only by time series that store data for datasets in a workspace.
If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this 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) -- [REQUIRED]
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) -- [REQUIRED]
The forwarding configuration for the given measurement property.
state (string) -- [REQUIRED]
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) -- [REQUIRED]
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) -- [REQUIRED]
The list of variables used in the expression.
(dict) --
Contains expression variable information.
name (string) -- [REQUIRED]
The friendly name of the variable to be used in the expression.
value (dict) -- [REQUIRED]
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. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
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. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
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.
propertyPath (list) --
The path of the property.
(dict) --
Represents one level between a property and the root of the asset model.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
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) -- [REQUIRED]
The compute location for the given transform property.
forwardingConfig (dict) --
The forwarding configuration for a given property.
state (string) -- [REQUIRED]
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) -- [REQUIRED]
The friendly name of the variable to be used in the expression.
value (dict) -- [REQUIRED]
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. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
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. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
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.
propertyPath (list) --
The path of the property.
(dict) --
Represents one level between a property and the root of the asset model.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
window (dict) -- [REQUIRED]
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) -- [REQUIRED]
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:
The offset time. For example, if you specify 18h for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The ISO 8601 format. For example, if you specify PT18H for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The 24-hour clock. For example, if you specify 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).
The offset time zone. For example, if you specify 2021-07-23T18:00-08 for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric.
If you create the metric after 6 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.
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) -- [REQUIRED]
The compute location for the given metric property.
path (list) --
The structured path to the property from the root of the asset model.
(dict) --
Represents one level between a property and the root of the asset model.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
id (string) --
The ID of the asset model composite model.
externalId (string) --
The external ID of the asset model composite model. For more information, see Using external IDs in the IoT SiteWise User Guide.
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.
string
The expected current entity tag (ETag) for the asset model’s latest or active version (specified using matchForVersionType). The update request is rejected if the tag does not match the latest or active version's current entity tag. See Optimistic locking for asset model writes in the IoT SiteWise User Guide.
string
Accepts * to reject the update request if an active version (specified using matchForVersionType as ACTIVE) already exists for the asset model.
string
Specifies the asset model version type ( LATEST or ACTIVE) used in conjunction with If-Match or If-None-Match headers to determine the target ETag for the update operation.
dict
Response Syntax
{
'assetModelId': '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.
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.
{'assetModelCompositeModelProperties': {'dataType': {'ANNOTATION',
'JSON',
'VIDEO'}}}
Response {'assetModelId': 'string'}
Updates a composite model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models in the IoT SiteWise User Guide.
See also: AWS API Documentation
Request Syntax
client.update_asset_model_composite_model(
assetModelId='string',
assetModelCompositeModelId='string',
assetModelCompositeModelExternalId='string',
assetModelCompositeModelDescription='string',
assetModelCompositeModelName='string',
clientToken='string',
assetModelCompositeModelProperties=[
{
'id': 'string',
'externalId': 'string',
'name': 'string',
'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN'|'STRUCT'|'VIDEO'|'ANNOTATION'|'JSON',
'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',
'propertyPath': [
{
'id': 'string',
'name': 'string'
},
]
}
},
],
'processingConfig': {
'computeLocation': 'EDGE'|'CLOUD',
'forwardingConfig': {
'state': 'DISABLED'|'ENABLED'
}
}
},
'metric': {
'expression': 'string',
'variables': [
{
'name': 'string',
'value': {
'propertyId': 'string',
'hierarchyId': 'string',
'propertyPath': [
{
'id': 'string',
'name': 'string'
},
]
}
},
],
'window': {
'tumbling': {
'interval': 'string',
'offset': 'string'
}
},
'processingConfig': {
'computeLocation': 'EDGE'|'CLOUD'
}
}
},
'path': [
{
'id': 'string',
'name': 'string'
},
]
},
],
ifMatch='string',
ifNoneMatch='string',
matchForVersionType='LATEST'|'ACTIVE'
)
string
[REQUIRED]
The ID of the asset model, in UUID format.
string
[REQUIRED]
The ID of a composite model on this asset model.
string
An external ID to assign to the asset model. You can only set the external ID of the asset model if it wasn't set when it was created, or you're setting it to the exact same thing as when it was created.
string
A description for the composite model.
string
[REQUIRED]
A unique name for the composite model.
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.
list
The property definitions of the composite model. For more information, see Inline custom composite models in the IoT SiteWise User Guide.
You can specify up to 200 properties per composite model. For more information, see Quotas in the IoT SiteWise User Guide.
(dict) --
Contains information about an asset model property.
id (string) --
The ID of the asset model property.
If you are callling UpdateAssetModel to create a new property: You can specify its ID here, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
If you are calling UpdateAssetModel to modify an existing property: This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
externalId (string) --
The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation. You can assign an external ID by specifying this value as part of a call to UpdateAssetModel. However, you can't change the external ID if one is already assigned. For more information, see Using external IDs in the IoT SiteWise User Guide.
name (string) -- [REQUIRED]
The name of the asset model property.
dataType (string) -- [REQUIRED]
The data type of the asset model property.
The VIDEO, ANNOTATION, and JSON data types aren't supported for asset model properties. These types are used only by time series that store data for datasets in a workspace.
If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this 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) -- [REQUIRED]
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) -- [REQUIRED]
The forwarding configuration for the given measurement property.
state (string) -- [REQUIRED]
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) -- [REQUIRED]
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) -- [REQUIRED]
The list of variables used in the expression.
(dict) --
Contains expression variable information.
name (string) -- [REQUIRED]
The friendly name of the variable to be used in the expression.
value (dict) -- [REQUIRED]
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. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
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. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
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.
propertyPath (list) --
The path of the property.
(dict) --
Represents one level between a property and the root of the asset model.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
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) -- [REQUIRED]
The compute location for the given transform property.
forwardingConfig (dict) --
The forwarding configuration for a given property.
state (string) -- [REQUIRED]
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) -- [REQUIRED]
The friendly name of the variable to be used in the expression.
value (dict) -- [REQUIRED]
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. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
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. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
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.
propertyPath (list) --
The path of the property.
(dict) --
Represents one level between a property and the root of the asset model.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
window (dict) -- [REQUIRED]
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) -- [REQUIRED]
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:
The offset time. For example, if you specify 18h for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The ISO 8601 format. For example, if you specify PT18H for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The 24-hour clock. For example, if you specify 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).
The offset time zone. For example, if you specify 2021-07-23T18:00-08 for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric.
If you create the metric after 6 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.
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) -- [REQUIRED]
The compute location for the given metric property.
path (list) --
The structured path to the property from the root of the asset model.
(dict) --
Represents one level between a property and the root of the asset model.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
string
The expected current entity tag (ETag) for the asset model’s latest or active version (specified using matchForVersionType). The update request is rejected if the tag does not match the latest or active version's current entity tag. See Optimistic locking for asset model writes in the IoT SiteWise User Guide.
string
Accepts * to reject the update request if an active version (specified using matchForVersionType as ACTIVE) already exists for the asset model.
string
Specifies the asset model version type ( LATEST or ACTIVE) used in conjunction with If-Match or If-None-Match headers to determine the target ETag for the update operation.
dict
Response Syntax
{
'assetModelCompositeModelPath': [
{
'id': 'string',
'name': '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'
},
]
}
},
'assetModelId': 'string'
}
Response Structure
(dict) --
assetModelCompositeModelPath (list) --
The path to the composite model listing the parent composite models.
(dict) --
Represents one level between a composite model and the root of the asset model.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
assetModelStatus (dict) --
Contains current status information for an asset model. For more information, see Asset and model states in the IoT SiteWise User Guide.
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.
assetModelId (string) --
The ID of the asset model.
{'datasetConfig': {'session': {'sessionEndTimestamp': {'offsetInNanos': 'integer',
'timeInSeconds': 'long'},
'sessionStartTimestamp': {'offsetInNanos': 'integer',
'timeInSeconds': 'long'}}},
'datasetSource': {'sourceFormat': {'TIMESERIES'}, 'sourceType': {'SITEWISE'}},
'metadata': {'string': 'string'},
'workspaceName': 'string'}
Updates a dataset.
See also: AWS API Documentation
Request Syntax
client.update_dataset(
datasetId='string',
workspaceName='string',
datasetName='string',
datasetDescription='string',
datasetConfig={
'session': {
'sessionStartTimestamp': {
'timeInSeconds': 123,
'offsetInNanos': 123
},
'sessionEndTimestamp': {
'timeInSeconds': 123,
'offsetInNanos': 123
}
}
},
metadata={
'string': 'string'
},
datasetSource={
'sourceType': 'KENDRA'|'SITEWISE',
'sourceFormat': 'KNOWLEDGE_BASE'|'TIMESERIES',
'sourceDetail': {
'kendra': {
'knowledgeBaseArn': 'string',
'roleArn': 'string'
}
}
},
clientToken='string'
)
string
[REQUIRED]
The ID of the dataset.
string
The name of the workspace that contains the dataset.
string
[REQUIRED]
The name of the dataset.
string
A description about the dataset, and its functionality.
dict
The updated configuration for the dataset.
session (dict) --
The session configuration for a session-type dataset.
sessionStartTimestamp (dict) -- [REQUIRED]
The nanosecond-precision start time of the session.
timeInSeconds (integer) -- [REQUIRED]
The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.
offsetInNanos (integer) --
The nanosecond offset from timeInSeconds.
sessionEndTimestamp (dict) -- [REQUIRED]
The nanosecond-precision end time of the session.
timeInSeconds (integer) -- [REQUIRED]
The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.
offsetInNanos (integer) --
The nanosecond offset from timeInSeconds.
dict
The updated metadata for the dataset.
(string) --
(string) --
dict
[REQUIRED]
The data source for the dataset.
sourceType (string) -- [REQUIRED]
The type of data source for the dataset.
sourceFormat (string) -- [REQUIRED]
The format of the dataset source associated with the dataset.
sourceDetail (dict) --
The details of the dataset source associated with the dataset.
kendra (dict) --
Contains details about the Kendra dataset source.
knowledgeBaseArn (string) -- [REQUIRED]
The knowledgeBaseArn details for the Kendra dataset source.
roleArn (string) -- [REQUIRED]
The roleARN details for the Kendra dataset source.
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.
dict
Response Syntax
{
'datasetId': 'string',
'datasetArn': 'string',
'datasetStatus': {
'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) --
datasetId (string) --
The ID of the dataset.
datasetArn (string) --
The ARN of the dataset. The format is arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId}.
datasetStatus (dict) --
The status of the dataset. This contains the state and any error messages. State is UPDATING after a successfull call to this API, and any associated error message. The state is ACTIVE when ready to use.
state (string) --
The current status of the dataset.
error (dict) --
Contains the details of an IoT SiteWise error.
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.