Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's model. For more information, see Associating assets in the IoT SiteWise User Guide.
", "endpoint":{"hostPrefix":"api."} }, "AssociateTimeSeriesToAssetProperty":{ "name":"AssociateTimeSeriesToAssetProperty", "http":{ "method":"POST", "requestUri":"/timeseries/associate/" }, "input":{"shape":"AssociateTimeSeriesToAssetPropertyRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"}, {"shape":"ConflictingOperationException"} ], "documentation":"Associates a time series (data stream) with an asset property.
", "endpoint":{"hostPrefix":"api."} }, "BatchAssociateDataSegmentsToDataset":{ "name":"BatchAssociateDataSegmentsToDataset", "http":{ "method":"POST", "requestUri":"/datasets/{datasetId}/data-segments/associate", "responseCode":200 }, "input":{"shape":"BatchAssociateDataSegmentsToDatasetRequest"}, "output":{"shape":"BatchAssociateDataSegmentsToDatasetResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"}, {"shape":"LimitExceededException"}, {"shape":"ConflictingOperationException"} ], "documentation":"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.
", "endpoint":{"hostPrefix":"api."} }, "BatchAssociateProjectAssets":{ "name":"BatchAssociateProjectAssets", "http":{ "method":"POST", "requestUri":"/projects/{projectId}/assets/associate", "responseCode":200 }, "input":{"shape":"BatchAssociateProjectAssetsRequest"}, "output":{"shape":"BatchAssociateProjectAssetsResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"}, {"shape":"LimitExceededException"} ], "documentation":"The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.
Associates a group (batch) of assets with an IoT SiteWise Monitor project.
", "endpoint":{"hostPrefix":"monitor."} }, "BatchDeleteDatasetDataSegments":{ "name":"BatchDeleteDatasetDataSegments", "http":{ "method":"POST", "requestUri":"/datasets/{datasetId}/data-segments/batch-delete" }, "input":{"shape":"BatchDeleteDatasetDataSegmentsRequest"}, "output":{"shape":"BatchDeleteDatasetDataSegmentsResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictingOperationException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"} ], "documentation":"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.
", "endpoint":{"hostPrefix":"api."} }, "BatchDisassociateDataSegmentsFromDataset":{ "name":"BatchDisassociateDataSegmentsFromDataset", "http":{ "method":"POST", "requestUri":"/datasets/{datasetId}/data-segments/disassociate", "responseCode":200 }, "input":{"shape":"BatchDisassociateDataSegmentsFromDatasetRequest"}, "output":{"shape":"BatchDisassociateDataSegmentsFromDatasetResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"}, {"shape":"ConflictingOperationException"} ], "documentation":"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.
", "endpoint":{"hostPrefix":"api."} }, "BatchDisassociateProjectAssets":{ "name":"BatchDisassociateProjectAssets", "http":{ "method":"POST", "requestUri":"/projects/{projectId}/assets/disassociate", "responseCode":200 }, "input":{"shape":"BatchDisassociateProjectAssetsRequest"}, "output":{"shape":"BatchDisassociateProjectAssetsResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"} ], "documentation":"Disassociates a group (batch) of assets from an IoT SiteWise Monitor project.
", "endpoint":{"hostPrefix":"monitor."} }, "BatchGetAssetPropertyAggregates":{ "name":"BatchGetAssetPropertyAggregates", "http":{ "method":"POST", "requestUri":"/properties/batch/aggregates" }, "input":{"shape":"BatchGetAssetPropertyAggregatesRequest"}, "output":{"shape":"BatchGetAssetPropertyAggregatesResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"Gets aggregated values (for example, average, minimum, and maximum) for one or more asset properties. For more information, see Querying aggregates in the IoT SiteWise User Guide.
", "endpoint":{"hostPrefix":"data."} }, "BatchGetAssetPropertyValue":{ "name":"BatchGetAssetPropertyValue", "http":{ "method":"POST", "requestUri":"/properties/batch/latest" }, "input":{"shape":"BatchGetAssetPropertyValueRequest"}, "output":{"shape":"BatchGetAssetPropertyValueResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"Gets the current value for one or more asset properties. For more information, see Querying current values in the IoT SiteWise User Guide.
", "endpoint":{"hostPrefix":"data."} }, "BatchGetAssetPropertyValueHistory":{ "name":"BatchGetAssetPropertyValueHistory", "http":{ "method":"POST", "requestUri":"/properties/batch/history" }, "input":{"shape":"BatchGetAssetPropertyValueHistoryRequest"}, "output":{"shape":"BatchGetAssetPropertyValueHistoryResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"Gets the historical values for one or more asset properties. For more information, see Querying historical values in the IoT SiteWise User Guide.
", "endpoint":{"hostPrefix":"data."} }, "BatchPutAssetPropertyValue":{ "name":"BatchPutAssetPropertyValue", "http":{ "method":"POST", "requestUri":"/properties" }, "input":{"shape":"BatchPutAssetPropertyValueRequest"}, "output":{"shape":"BatchPutAssetPropertyValueResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ConflictingOperationException"} ], "documentation":"Sends a list of asset property values to IoT SiteWise. Each value is a timestamp-quality-value (TQV) data point. For more information, see Ingesting data using the API in the IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
The assetId and propertyId of an asset property.
A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
With respect to Unix epoch time, IoT SiteWise accepts only TQVs that have a timestamp of no more than 7 days in the past and no more than 10 minutes in the future. IoT SiteWise rejects timestamps outside of the inclusive range of [-7 days, +10 minutes] and returns a TimestampOutOfRangeException error.
For each asset property, IoT SiteWise overwrites TQVs with duplicate timestamps unless the newer TQV has a different quality. For example, if you store a TQV {T1, GOOD, V1}, then storing {T1, GOOD, V2} replaces the existing TQV.
IoT SiteWise authorizes access to each BatchPutAssetPropertyValue entry individually. For more information, see BatchPutAssetPropertyValue authorization in the IoT SiteWise User Guide.
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.
Cancel a job when:
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.
", "endpoint":{"hostPrefix":"data."}, "idempotent":true }, "CancelPipelineExecution":{ "name":"CancelPipelineExecution", "http":{ "method":"POST", "requestUri":"/workspaces/{workspaceName}/pipelines/{pipelineName}/executions/{pipelineExecutionId}/cancel", "responseCode":202 }, "input":{"shape":"CancelPipelineExecutionRequest"}, "output":{"shape":"CancelPipelineExecutionResponse"}, "errors":[ {"shape":"InternalFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"ConflictingOperationException"} ], "documentation":"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.
", "endpoint":{"hostPrefix":"data."} }, "CancelQuery":{ "name":"CancelQuery", "http":{ "method":"POST", "requestUri":"/workspaces/{workspaceName}/queries/{queryId}/cancel", "responseCode":202 }, "input":{"shape":"CancelQueryRequest"}, "output":{"shape":"CancelQueryResponse"}, "errors":[ {"shape":"InternalFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"ConflictingOperationException"} ], "documentation":"Cancels a running query.
", "endpoint":{"hostPrefix":"data."}, "idempotent":true }, "CreateAccessPolicy":{ "name":"CreateAccessPolicy", "http":{ "method":"POST", "requestUri":"/access-policies", "responseCode":201 }, "input":{"shape":"CreateAccessPolicyRequest"}, "output":{"shape":"CreateAccessPolicyResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"}, {"shape":"LimitExceededException"} ], "documentation":"The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.
Creates an access policy that grants the specified identity (IAM Identity Center user, IAM Identity Center group, or IAM user) access to the specified IoT SiteWise Monitor portal or project resource.
Support for access policies that use an SSO Group as the identity is not supported at this time.
Creates a new application for the workspace and IdC application provided
", "endpoint":{"hostPrefix":"api."}, "idempotent":true }, "CreateAsset":{ "name":"CreateAsset", "http":{ "method":"POST", "requestUri":"/assets", "responseCode":202 }, "input":{"shape":"CreateAssetRequest"}, "output":{"shape":"CreateAssetResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceAlreadyExistsException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"}, {"shape":"LimitExceededException"}, {"shape":"ConflictingOperationException"} ], "documentation":"Creates an asset from an existing asset model. For more information, see Creating assets in the IoT SiteWise User Guide.
", "endpoint":{"hostPrefix":"api."} }, "CreateAssetModel":{ "name":"CreateAssetModel", "http":{ "method":"POST", "requestUri":"/asset-models", "responseCode":202 }, "input":{"shape":"CreateAssetModelRequest"}, "output":{"shape":"CreateAssetModelResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceAlreadyExistsException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"}, {"shape":"LimitExceededException"}, {"shape":"ConflictingOperationException"} ], "documentation":"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.
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.
Defines a job to ingest data to IoT SiteWise from Amazon S3. For more information, see Create a bulk import job (CLI) in the Amazon Simple Storage Service User Guide.
Before you create a bulk import job that ingests data into time series outside of a workspace, you must enable IoT SiteWise warm tier or IoT SiteWise cold tier. For more information about how to configure storage settings, see PutStorageConfiguration. This requirement doesn't apply to bulk import jobs that ingest data into a session dataset in a workspace (jobs that specify a workspaceName and datasetId). Those jobs don't use IoT SiteWise warm or cold tier storage.
Bulk import is designed to store historical data to IoT SiteWise.
Newly ingested data in the hot tier triggers notifications and computations.
After data moves from the hot tier to the warm or cold tier based on retention settings, it does not trigger computations or notifications.
Data older than 7 days does not trigger computations or notifications.
Create a computation model with a configuration and data binding.
", "endpoint":{"hostPrefix":"api."} }, "CreateDashboard":{ "name":"CreateDashboard", "http":{ "method":"POST", "requestUri":"/dashboards", "responseCode":201 }, "input":{"shape":"CreateDashboardRequest"}, "output":{"shape":"CreateDashboardResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"}, {"shape":"LimitExceededException"} ], "documentation":"The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.
Creates a dashboard in an IoT SiteWise Monitor project.
", "endpoint":{"hostPrefix":"monitor."} }, "CreateDataset":{ "name":"CreateDataset", "http":{ "method":"POST", "requestUri":"/datasets", "responseCode":202 }, "input":{"shape":"CreateDatasetRequest"}, "output":{"shape":"CreateDatasetResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceAlreadyExistsException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"}, {"shape":"LimitExceededException"}, {"shape":"ConflictingOperationException"} ], "documentation":"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.
", "endpoint":{"hostPrefix":"api."} }, "CreateDatasetExportJob":{ "name":"CreateDatasetExportJob", "http":{ "method":"POST", "requestUri":"/workspaces/{workspaceName}/dataset-export-jobs", "responseCode":202 }, "input":{"shape":"CreateDatasetExportJobRequest"}, "output":{"shape":"CreateDatasetExportJobResponse"}, "errors":[ {"shape":"InternalFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"ConflictingOperationException"} ], "documentation":"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.
", "endpoint":{"hostPrefix":"data."}, "idempotent":true }, "CreateEnrichmentJob":{ "name":"CreateEnrichmentJob", "http":{ "method":"POST", "requestUri":"/workspaces/{workspaceName}/enrichment-jobs", "responseCode":200 }, "input":{"shape":"CreateEnrichmentJobRequest"}, "output":{"shape":"CreateEnrichmentJobResponse"}, "errors":[ {"shape":"InternalFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"InvalidRequestException"}, {"shape":"ThrottlingException"}, {"shape":"LimitExceededException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictingOperationException"} ], "documentation":"Creates an asynchronous enrichment job to analyze time-series sensor data. The operation returns immediately with job details while processing continues in the background.
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.
Before creating a job, ensure:
Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to IoT SiteWise. For more information, see Ingesting data using a gateway in the IoT SiteWise User Guide.
", "endpoint":{"hostPrefix":"api."} }, "CreatePipeline":{ "name":"CreatePipeline", "http":{ "method":"POST", "requestUri":"/workspaces/{workspaceName}/pipelines", "responseCode":200 }, "input":{"shape":"CreatePipelineRequest"}, "output":{"shape":"CreatePipelineResponse"}, "errors":[ {"shape":"InternalFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"LimitExceededException"}, {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"ConflictingOperationException"} ], "documentation":"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.
", "endpoint":{"hostPrefix":"api."}, "idempotent":true }, "CreatePortal":{ "name":"CreatePortal", "http":{ "method":"POST", "requestUri":"/portals", "responseCode":202 }, "input":{"shape":"CreatePortalRequest"}, "output":{"shape":"CreatePortalResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"}, {"shape":"LimitExceededException"} ], "documentation":"The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.
Creates a portal, which can contain projects and dashboards. IoT SiteWise Monitor uses IAM Identity Center or IAM to authenticate portal users and manage user permissions.
Before you can sign in to a new portal, you must add at least one identity to that portal. For more information, see Adding or removing portal administrators in the IoT SiteWise User Guide.
The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.
Creates a project in the specified portal.
Make sure that the project name and description don't contain confidential information.
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.
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.
Deletes an access policy that grants the specified identity access to the specified IoT SiteWise Monitor resource. You can use this operation to revoke access to an IoT SiteWise Monitor resource.
", "endpoint":{"hostPrefix":"monitor."} }, "DeleteApplication":{ "name":"DeleteApplication", "http":{ "method":"DELETE", "requestUri":"/workspaces/{workspaceName}/applications/{id}", "responseCode":204 }, "input":{"shape":"DeleteApplicationRequest"}, "output":{"shape":"DeleteApplicationResponse"}, "errors":[ {"shape":"InternalFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"InvalidRequestException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictingOperationException"} ], "documentation":"Deletes an application by ID
", "endpoint":{"hostPrefix":"api."}, "idempotent":true }, "DeleteAsset":{ "name":"DeleteAsset", "http":{ "method":"DELETE", "requestUri":"/assets/{assetId}", "responseCode":202 }, "input":{"shape":"DeleteAssetRequest"}, "output":{"shape":"DeleteAssetResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"}, {"shape":"ConflictingOperationException"} ], "documentation":"Deletes an asset. This action can't be undone. For more information, see Deleting assets and models in the IoT SiteWise User Guide.
You can't delete an asset that's associated to another asset. For more information, see DisassociateAssets.
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.
", "endpoint":{"hostPrefix":"api."} }, "DeleteAssetModelCompositeModel":{ "name":"DeleteAssetModelCompositeModel", "http":{ "method":"DELETE", "requestUri":"/asset-models/{assetModelId}/composite-models/{assetModelCompositeModelId}", "responseCode":202 }, "input":{"shape":"DeleteAssetModelCompositeModelRequest"}, "output":{"shape":"DeleteAssetModelCompositeModelResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"}, {"shape":"ConflictingOperationException"}, {"shape":"PreconditionFailedException"} ], "documentation":"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.
", "endpoint":{"hostPrefix":"api."} }, "DeleteAssetModelInterfaceRelationship":{ "name":"DeleteAssetModelInterfaceRelationship", "http":{ "method":"DELETE", "requestUri":"/asset-models/{assetModelId}/interface/{interfaceAssetModelId}/asset-model-interface-relationship", "responseCode":202 }, "input":{"shape":"DeleteAssetModelInterfaceRelationshipRequest"}, "output":{"shape":"DeleteAssetModelInterfaceRelationshipResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"}, {"shape":"ConflictingOperationException"} ], "documentation":"Deletes an interface relationship between an asset model and an interface asset model.
", "endpoint":{"hostPrefix":"api."} }, "DeleteComputationModel":{ "name":"DeleteComputationModel", "http":{ "method":"DELETE", "requestUri":"/computation-models/{computationModelId}", "responseCode":202 }, "input":{"shape":"DeleteComputationModelRequest"}, "output":{"shape":"DeleteComputationModelResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"}, {"shape":"ConflictingOperationException"} ], "documentation":"Deletes a computation model. This action can't be undone.
", "endpoint":{"hostPrefix":"api."} }, "DeleteDashboard":{ "name":"DeleteDashboard", "http":{ "method":"DELETE", "requestUri":"/dashboards/{dashboardId}", "responseCode":204 }, "input":{"shape":"DeleteDashboardRequest"}, "output":{"shape":"DeleteDashboardResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"} ], "documentation":"Deletes a dashboard from IoT SiteWise Monitor.
", "endpoint":{"hostPrefix":"monitor."} }, "DeleteDataset":{ "name":"DeleteDataset", "http":{ "method":"DELETE", "requestUri":"/datasets/{datasetId}", "responseCode":202 }, "input":{"shape":"DeleteDatasetRequest"}, "output":{"shape":"DeleteDatasetResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"}, {"shape":"ConflictingOperationException"} ], "documentation":"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.
", "endpoint":{"hostPrefix":"api."} }, "DeleteGateway":{ "name":"DeleteGateway", "http":{ "method":"DELETE", "requestUri":"/20200301/gateways/{gatewayId}" }, "input":{"shape":"DeleteGatewayRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictingOperationException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"} ], "documentation":"Deletes a gateway from IoT SiteWise. When you delete a gateway, some of the gateway's files remain in your gateway's file system.
", "endpoint":{"hostPrefix":"api."} }, "DeletePipeline":{ "name":"DeletePipeline", "http":{ "method":"DELETE", "requestUri":"/workspaces/{workspaceName}/pipelines/{pipelineName}", "responseCode":200 }, "input":{"shape":"DeletePipelineRequest"}, "output":{"shape":"DeletePipelineResponse"}, "errors":[ {"shape":"InternalFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"ConflictingOperationException"} ], "documentation":"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.
", "endpoint":{"hostPrefix":"api."}, "idempotent":true }, "DeletePortal":{ "name":"DeletePortal", "http":{ "method":"DELETE", "requestUri":"/portals/{portalId}", "responseCode":202 }, "input":{"shape":"DeletePortalRequest"}, "output":{"shape":"DeletePortalResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"}, {"shape":"ConflictingOperationException"} ], "documentation":"Deletes a portal from IoT SiteWise Monitor.
", "endpoint":{"hostPrefix":"monitor."} }, "DeleteProject":{ "name":"DeleteProject", "http":{ "method":"DELETE", "requestUri":"/projects/{projectId}", "responseCode":204 }, "input":{"shape":"DeleteProjectRequest"}, "output":{"shape":"DeleteProjectResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"} ], "documentation":"Deletes a project from IoT SiteWise Monitor.
", "endpoint":{"hostPrefix":"monitor."} }, "DeleteTask":{ "name":"DeleteTask", "http":{ "method":"DELETE", "requestUri":"/workspaces/{workspaceName}/tasks/{taskName}", "responseCode":200 }, "input":{"shape":"DeleteTaskRequest"}, "output":{"shape":"DeleteTaskResponse"}, "errors":[ {"shape":"InternalFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"ConflictingOperationException"} ], "documentation":"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.
", "endpoint":{"hostPrefix":"api."}, "idempotent":true }, "DeleteTimeSeries":{ "name":"DeleteTimeSeries", "http":{ "method":"POST", "requestUri":"/timeseries/delete/" }, "input":{"shape":"DeleteTimeSeriesRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"}, {"shape":"ConflictingOperationException"} ], "documentation":"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.
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.
", "endpoint":{"hostPrefix":"api."}, "idempotent":true }, "DescribeAccessPolicy":{ "name":"DescribeAccessPolicy", "http":{ "method":"GET", "requestUri":"/access-policies/{accessPolicyId}", "responseCode":200 }, "input":{"shape":"DescribeAccessPolicyRequest"}, "output":{"shape":"DescribeAccessPolicyResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"} ], "documentation":"Describes an access policy, which specifies an identity's access to an IoT SiteWise Monitor portal or project.
", "endpoint":{"hostPrefix":"monitor."} }, "DescribeAction":{ "name":"DescribeAction", "http":{ "method":"GET", "requestUri":"/actions/{actionId}" }, "input":{"shape":"DescribeActionRequest"}, "output":{"shape":"DescribeActionResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"} ], "documentation":"Retrieves information about an action.
", "endpoint":{"hostPrefix":"api."} }, "DescribeApplication":{ "name":"DescribeApplication", "http":{ "method":"GET", "requestUri":"/workspaces/{workspaceName}/applications/{id}", "responseCode":200 }, "input":{"shape":"DescribeApplicationRequest"}, "output":{"shape":"DescribeApplicationResponse"}, "errors":[ {"shape":"InternalFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"InvalidRequestException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Retrieves Application details based on the ID
", "endpoint":{"hostPrefix":"api."}, "readonly":true }, "DescribeAsset":{ "name":"DescribeAsset", "http":{ "method":"GET", "requestUri":"/assets/{assetId}" }, "input":{"shape":"DescribeAssetRequest"}, "output":{"shape":"DescribeAssetResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"} ], "documentation":"Retrieves information about an asset.
", "endpoint":{"hostPrefix":"api."} }, "DescribeAssetCompositeModel":{ "name":"DescribeAssetCompositeModel", "http":{ "method":"GET", "requestUri":"/assets/{assetId}/composite-models/{assetCompositeModelId}" }, "input":{"shape":"DescribeAssetCompositeModelRequest"}, "output":{"shape":"DescribeAssetCompositeModelResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"} ], "documentation":"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.
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.
", "endpoint":{"hostPrefix":"api."} }, "DescribeAssetModelCompositeModel":{ "name":"DescribeAssetModelCompositeModel", "http":{ "method":"GET", "requestUri":"/asset-models/{assetModelId}/composite-models/{assetModelCompositeModelId}" }, "input":{"shape":"DescribeAssetModelCompositeModelRequest"}, "output":{"shape":"DescribeAssetModelCompositeModelResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"} ], "documentation":"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.
", "endpoint":{"hostPrefix":"api."} }, "DescribeAssetModelInterfaceRelationship":{ "name":"DescribeAssetModelInterfaceRelationship", "http":{ "method":"GET", "requestUri":"/asset-models/{assetModelId}/interface/{interfaceAssetModelId}/asset-model-interface-relationship" }, "input":{"shape":"DescribeAssetModelInterfaceRelationshipRequest"}, "output":{"shape":"DescribeAssetModelInterfaceRelationshipResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"} ], "documentation":"Retrieves information about an interface relationship between an asset model and an interface asset model.
", "endpoint":{"hostPrefix":"api."} }, "DescribeAssetProperty":{ "name":"DescribeAssetProperty", "http":{ "method":"GET", "requestUri":"/assets/{assetId}/properties/{propertyId}" }, "input":{"shape":"DescribeAssetPropertyRequest"}, "output":{"shape":"DescribeAssetPropertyResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"} ], "documentation":"Retrieves information about an asset property.
When you call this operation for an attribute property, this response includes the default attribute value that you define in the asset model. If you update the default value in the model, this operation's response includes the new default value.
This operation doesn't return the value of the asset property. To get the value of an asset property, use GetAssetPropertyValue.
", "endpoint":{"hostPrefix":"api."} }, "DescribeBulkImportJob":{ "name":"DescribeBulkImportJob", "http":{ "method":"GET", "requestUri":"/jobs/{jobId}" }, "input":{"shape":"DescribeBulkImportJobRequest"}, "output":{"shape":"DescribeBulkImportJobResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"} ], "documentation":"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.
", "endpoint":{"hostPrefix":"data."} }, "DescribeComputationModel":{ "name":"DescribeComputationModel", "http":{ "method":"GET", "requestUri":"/computation-models/{computationModelId}" }, "input":{"shape":"DescribeComputationModelRequest"}, "output":{"shape":"DescribeComputationModelResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"} ], "documentation":"Retrieves information about a computation model.
", "endpoint":{"hostPrefix":"api."} }, "DescribeComputationModelExecutionSummary":{ "name":"DescribeComputationModelExecutionSummary", "http":{ "method":"GET", "requestUri":"/computation-models/{computationModelId}/execution-summary" }, "input":{"shape":"DescribeComputationModelExecutionSummaryRequest"}, "output":{"shape":"DescribeComputationModelExecutionSummaryResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"} ], "documentation":"Retrieves information about the execution summary of a computation model.
", "endpoint":{"hostPrefix":"api."} }, "DescribeDashboard":{ "name":"DescribeDashboard", "http":{ "method":"GET", "requestUri":"/dashboards/{dashboardId}", "responseCode":200 }, "input":{"shape":"DescribeDashboardRequest"}, "output":{"shape":"DescribeDashboardResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"} ], "documentation":"Retrieves information about a dashboard.
", "endpoint":{"hostPrefix":"monitor."} }, "DescribeDataset":{ "name":"DescribeDataset", "http":{ "method":"GET", "requestUri":"/datasets/{datasetId}" }, "input":{"shape":"DescribeDatasetRequest"}, "output":{"shape":"DescribeDatasetResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"} ], "documentation":"Retrieves information about a dataset.
", "endpoint":{"hostPrefix":"api."} }, "DescribeDatasetExportJob":{ "name":"DescribeDatasetExportJob", "http":{ "method":"GET", "requestUri":"/workspaces/{workspaceName}/dataset-export-jobs/{jobId}", "responseCode":200 }, "input":{"shape":"DescribeDatasetExportJobRequest"}, "output":{"shape":"DescribeDatasetExportJobResponse"}, "errors":[ {"shape":"InternalFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Retrieves information about a dataset export job.
", "endpoint":{"hostPrefix":"data."}, "readonly":true }, "DescribeDefaultEncryptionConfiguration":{ "name":"DescribeDefaultEncryptionConfiguration", "http":{ "method":"GET", "requestUri":"/configuration/account/encryption" }, "input":{"shape":"DescribeDefaultEncryptionConfigurationRequest"}, "output":{"shape":"DescribeDefaultEncryptionConfigurationResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"} ], "documentation":"Retrieves information about the default encryption configuration for the Amazon Web Services account in the default or specified Region. For more information, see Key management in the IoT SiteWise User Guide.
", "endpoint":{"hostPrefix":"api."} }, "DescribeEnrichmentJob":{ "name":"DescribeEnrichmentJob", "http":{ "method":"GET", "requestUri":"/workspaces/{workspaceName}/enrichment-jobs/{jobId}", "responseCode":200 }, "input":{"shape":"DescribeEnrichmentJobRequest"}, "output":{"shape":"DescribeEnrichmentJobResponse"}, "errors":[ {"shape":"InternalFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"InvalidRequestException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ConflictingOperationException"} ], "documentation":"Retrieves detailed information about a specific enrichment job, including its current status, configuration, and timestamps.
Jobs progress through statuses: PENDING → RUNNING → terminal state
Terminal states:
The response includes:
Retrieves information about the execution.
", "endpoint":{"hostPrefix":"api."} }, "DescribeGateway":{ "name":"DescribeGateway", "http":{ "method":"GET", "requestUri":"/20200301/gateways/{gatewayId}" }, "input":{"shape":"DescribeGatewayRequest"}, "output":{"shape":"DescribeGatewayResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"} ], "documentation":"Retrieves information about a gateway.
", "endpoint":{"hostPrefix":"api."} }, "DescribeGatewayCapabilityConfiguration":{ "name":"DescribeGatewayCapabilityConfiguration", "http":{ "method":"GET", "requestUri":"/20200301/gateways/{gatewayId}/capability/{capabilityNamespace}" }, "input":{"shape":"DescribeGatewayCapabilityConfigurationRequest"}, "output":{"shape":"DescribeGatewayCapabilityConfigurationResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"} ], "documentation":"Each gateway capability defines data sources for a gateway. This is the namespace of the gateway capability.
. The namespace follows the format service:capability:version, where:
service - The service providing the capability, or iotsitewise.
capability - The specific capability type. Options include: opcuacollector for the OPC UA data source collector, or publisher for data publisher capability.
version - The version number of the capability. Option include 2 for Classic streams, V2 gateways, and 3 for MQTT-enabled, V3 gateways.
After updating a capability configuration, the sync status becomes OUT_OF_SYNC until the gateway processes the configuration.Use DescribeGatewayCapabilityConfiguration to check the sync status and verify the configuration was applied.
A gateway can have multiple capability configurations with different namespaces.
", "endpoint":{"hostPrefix":"api."} }, "DescribeLoggingOptions":{ "name":"DescribeLoggingOptions", "http":{ "method":"GET", "requestUri":"/logging" }, "input":{"shape":"DescribeLoggingOptionsRequest"}, "output":{"shape":"DescribeLoggingOptionsResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ThrottlingException"}, {"shape":"InternalFailureException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Retrieves the current IoT SiteWise logging options.
", "endpoint":{"hostPrefix":"api."} }, "DescribePipeline":{ "name":"DescribePipeline", "http":{ "method":"GET", "requestUri":"/workspaces/{workspaceName}/pipelines/{pipelineName}", "responseCode":200 }, "input":{"shape":"DescribePipelineRequest"}, "output":{"shape":"DescribePipelineResponse"}, "errors":[ {"shape":"InternalFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Retrieves detailed information about a specific pipeline in a workspace.
", "endpoint":{"hostPrefix":"api."}, "readonly":true }, "DescribePipelineExecution":{ "name":"DescribePipelineExecution", "http":{ "method":"GET", "requestUri":"/workspaces/{workspaceName}/pipelines/{pipelineName}/executions/{pipelineExecutionId}", "responseCode":200 }, "input":{"shape":"DescribePipelineExecutionRequest"}, "output":{"shape":"DescribePipelineExecutionResponse"}, "errors":[ {"shape":"InternalFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"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.
", "endpoint":{"hostPrefix":"data."}, "readonly":true }, "DescribePortal":{ "name":"DescribePortal", "http":{ "method":"GET", "requestUri":"/portals/{portalId}", "responseCode":200 }, "input":{"shape":"DescribePortalRequest"}, "output":{"shape":"DescribePortalResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"} ], "documentation":"Retrieves information about a portal.
", "endpoint":{"hostPrefix":"monitor."} }, "DescribeProject":{ "name":"DescribeProject", "http":{ "method":"GET", "requestUri":"/projects/{projectId}", "responseCode":200 }, "input":{"shape":"DescribeProjectRequest"}, "output":{"shape":"DescribeProjectResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"} ], "documentation":"Retrieves information about a project.
", "endpoint":{"hostPrefix":"monitor."} }, "DescribeQuery":{ "name":"DescribeQuery", "http":{ "method":"GET", "requestUri":"/workspaces/{workspaceName}/queries/{queryId}", "responseCode":200 }, "input":{"shape":"DescribeQueryRequest"}, "output":{"shape":"DescribeQueryResponse"}, "errors":[ {"shape":"InternalFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Retrieves information about a query, including its status.
", "endpoint":{"hostPrefix":"data."}, "readonly":true }, "DescribeSearch":{ "name":"DescribeSearch", "http":{ "method":"GET", "requestUri":"/workspaces/{workspaceName}/searches/{searchId}", "responseCode":200 }, "input":{"shape":"DescribeSearchRequest"}, "output":{"shape":"DescribeSearchResponse"}, "errors":[ {"shape":"InternalFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"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).
Retrieves information about the storage configuration for IoT SiteWise.
", "endpoint":{"hostPrefix":"api."} }, "DescribeTask":{ "name":"DescribeTask", "http":{ "method":"GET", "requestUri":"/workspaces/{workspaceName}/tasks/{taskName}", "responseCode":200 }, "input":{"shape":"DescribeTaskRequest"}, "output":{"shape":"DescribeTaskResponse"}, "errors":[ {"shape":"InternalFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Retrieves detailed information about a specific task in a workspace.
", "endpoint":{"hostPrefix":"api."}, "readonly":true }, "DescribeTimeSeries":{ "name":"DescribeTimeSeries", "http":{ "method":"GET", "requestUri":"/timeseries/describe/" }, "input":{"shape":"DescribeTimeSeriesRequest"}, "output":{"shape":"DescribeTimeSeriesResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"} ], "documentation":"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.
Retrieves information about a workspace.
", "endpoint":{"hostPrefix":"api."}, "readonly":true }, "DisassociateAssets":{ "name":"DisassociateAssets", "http":{ "method":"POST", "requestUri":"/assets/{assetId}/disassociate" }, "input":{"shape":"DisassociateAssetsRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"}, {"shape":"ConflictingOperationException"} ], "documentation":"Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model.
", "endpoint":{"hostPrefix":"api."} }, "DisassociateTimeSeriesFromAssetProperty":{ "name":"DisassociateTimeSeriesFromAssetProperty", "http":{ "method":"POST", "requestUri":"/timeseries/disassociate/" }, "input":{"shape":"DisassociateTimeSeriesFromAssetPropertyRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"}, {"shape":"ConflictingOperationException"} ], "documentation":"Disassociates a time series (data stream) from an asset property.
", "endpoint":{"hostPrefix":"api."} }, "ExecuteAction":{ "name":"ExecuteAction", "http":{ "method":"POST", "requestUri":"/actions", "responseCode":202 }, "input":{"shape":"ExecuteActionRequest"}, "output":{"shape":"ExecuteActionResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"}, {"shape":"LimitExceededException"}, {"shape":"ConflictingOperationException"} ], "documentation":"Executes an action on a target resource.
", "endpoint":{"hostPrefix":"api."} }, "ExecuteQuery":{ "name":"ExecuteQuery", "http":{ "method":"POST", "requestUri":"/queries/execution" }, "input":{"shape":"ExecuteQueryRequest"}, "output":{"shape":"ExecuteQueryResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"QueryTimeoutException"}, {"shape":"InternalFailureException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"Run SQL queries to retrieve metadata and time-series data from asset models, assets, measurements, metrics, transforms, and aggregates.
", "endpoint":{"hostPrefix":"data."} }, "GetAssetPropertyAggregates":{ "name":"GetAssetPropertyAggregates", "http":{ "method":"GET", "requestUri":"/properties/aggregates" }, "input":{"shape":"GetAssetPropertyAggregatesRequest"}, "output":{"shape":"GetAssetPropertyAggregatesResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"Gets aggregated values for an asset property. For more information, see Querying aggregates in the IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
The assetId and propertyId of an asset property.
A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
Gets an asset property's current value. For more information, see Querying current values in the IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
The assetId and propertyId of an asset property.
A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
Gets the history of an asset property's values. For more information, see Querying historical values in the IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
The assetId and propertyId of an asset property.
A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
Retrieves video data for a specific time range.
", "endpoint":{"hostPrefix":"data."}, "readonly":true }, "GetInterpolatedAssetPropertyValues":{ "name":"GetInterpolatedAssetPropertyValues", "http":{ "method":"GET", "requestUri":"/properties/interpolated" }, "input":{"shape":"GetInterpolatedAssetPropertyValuesRequest"}, "output":{"shape":"GetInterpolatedAssetPropertyValuesResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"Get interpolated values for an asset property for a specified time interval, during a period of time. If your time series is missing data points during the specified time interval, you can use interpolation to estimate the missing data.
For example, you can use this operation to return the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days.
To identify an asset property, you must specify one of the following:
The assetId and propertyId of an asset property.
A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
Retrieves the paginated results of a query. Returns empty rows if the query is not yet complete.
", "endpoint":{"hostPrefix":"data."}, "readonly":true }, "GetSearchResults":{ "name":"GetSearchResults", "http":{ "method":"GET", "requestUri":"/workspaces/{workspaceName}/searches/{searchId}/results", "responseCode":200 }, "input":{"shape":"GetSearchResultsRequest"}, "output":{"shape":"GetSearchResultsResponse"}, "errors":[ {"shape":"InternalFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"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.
Invokes SiteWise Assistant to start or continue a conversation.
", "endpoint":{"hostPrefix":"data."} }, "ListAccessPolicies":{ "name":"ListAccessPolicies", "http":{ "method":"GET", "requestUri":"/access-policies", "responseCode":200 }, "input":{"shape":"ListAccessPoliciesRequest"}, "output":{"shape":"ListAccessPoliciesResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"} ], "documentation":"Retrieves a paginated list of access policies for an identity (an IAM Identity Center user, an IAM Identity Center group, or an IAM user) or an IoT SiteWise Monitor resource (a portal or project).
", "endpoint":{"hostPrefix":"monitor."} }, "ListActions":{ "name":"ListActions", "http":{ "method":"GET", "requestUri":"/actions" }, "input":{"shape":"ListActionsRequest"}, "output":{"shape":"ListActionsResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InternalFailureException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Retrieves a paginated list of actions for a specific target resource.
", "endpoint":{"hostPrefix":"api."} }, "ListApplications":{ "name":"ListApplications", "http":{ "method":"GET", "requestUri":"/applications", "responseCode":200 }, "input":{"shape":"ListApplicationsRequest"}, "output":{"shape":"ListApplicationsResponse"}, "errors":[ {"shape":"InternalFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Retrieves a paginated list of existing applications
", "endpoint":{"hostPrefix":"api."}, "readonly":true }, "ListAssetModelCompositeModels":{ "name":"ListAssetModelCompositeModels", "http":{ "method":"GET", "requestUri":"/asset-models/{assetModelId}/composite-models" }, "input":{"shape":"ListAssetModelCompositeModelsRequest"}, "output":{"shape":"ListAssetModelCompositeModelsResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Retrieves a paginated list of composite models associated with the asset model
", "endpoint":{"hostPrefix":"api."} }, "ListAssetModelProperties":{ "name":"ListAssetModelProperties", "http":{ "method":"GET", "requestUri":"/asset-models/{assetModelId}/properties" }, "input":{"shape":"ListAssetModelPropertiesRequest"}, "output":{"shape":"ListAssetModelPropertiesResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InternalFailureException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"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.
", "endpoint":{"hostPrefix":"api."} }, "ListAssetModels":{ "name":"ListAssetModels", "http":{ "method":"GET", "requestUri":"/asset-models" }, "input":{"shape":"ListAssetModelsRequest"}, "output":{"shape":"ListAssetModelsResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"} ], "documentation":"Retrieves a paginated list of summaries of all asset models.
", "endpoint":{"hostPrefix":"api."} }, "ListAssetProperties":{ "name":"ListAssetProperties", "http":{ "method":"GET", "requestUri":"/assets/{assetId}/properties" }, "input":{"shape":"ListAssetPropertiesRequest"}, "output":{"shape":"ListAssetPropertiesResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InternalFailureException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Retrieves a paginated list of properties associated with an asset. If you update properties associated with the model before you finish listing all the properties, you need to start all over again.
", "endpoint":{"hostPrefix":"api."} }, "ListAssetRelationships":{ "name":"ListAssetRelationships", "http":{ "method":"GET", "requestUri":"/assets/{assetId}/assetRelationships" }, "input":{"shape":"ListAssetRelationshipsRequest"}, "output":{"shape":"ListAssetRelationshipsResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InternalFailureException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Retrieves a paginated list of asset relationships for an asset. You can use this operation to identify an asset's root asset and all associated assets between that asset and its root.
", "endpoint":{"hostPrefix":"api."} }, "ListAssets":{ "name":"ListAssets", "http":{ "method":"GET", "requestUri":"/assets" }, "input":{"shape":"ListAssetsRequest"}, "output":{"shape":"ListAssetsResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InternalFailureException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Retrieves a paginated list of asset summaries.
You can use this operation to do the following:
List assets based on a specific asset model.
List top-level assets.
You can't use this operation to list all assets. To retrieve summaries for all of your assets, use ListAssetModels to get all of your asset model IDs. Then, use ListAssets to get all assets for each asset model.
", "endpoint":{"hostPrefix":"api."} }, "ListAssociatedAssets":{ "name":"ListAssociatedAssets", "http":{ "method":"GET", "requestUri":"/assets/{assetId}/hierarchies" }, "input":{"shape":"ListAssociatedAssetsRequest"}, "output":{"shape":"ListAssociatedAssetsResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InternalFailureException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Retrieves a paginated list of associated assets.
You can use this operation to do the following:
CHILD - List all child assets associated to the asset.
PARENT - List the asset's parent asset.
Retrieves a paginated list of bulk import job requests. For more information, see List bulk import jobs (CLI) in the IoT SiteWise User Guide.
", "endpoint":{"hostPrefix":"data."} }, "ListCompositionRelationships":{ "name":"ListCompositionRelationships", "http":{ "method":"GET", "requestUri":"/asset-models/{assetModelId}/composition-relationships" }, "input":{"shape":"ListCompositionRelationshipsRequest"}, "output":{"shape":"ListCompositionRelationshipsResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InternalFailureException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Retrieves a paginated list of composition relationships for an asset model of type COMPONENT_MODEL.
Lists all data binding usages for computation models. This allows to identify where specific data bindings are being utilized across the computation models. This track dependencies between data sources and computation models.
", "endpoint":{"hostPrefix":"api."} }, "ListComputationModelResolveToResources":{ "name":"ListComputationModelResolveToResources", "http":{ "method":"GET", "requestUri":"/computation-models/{computationModelId}/resolve-to-resources" }, "input":{"shape":"ListComputationModelResolveToResourcesRequest"}, "output":{"shape":"ListComputationModelResolveToResourcesResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InternalFailureException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Lists all distinct resources that are resolved from the executed actions of the computation model.
", "endpoint":{"hostPrefix":"api."} }, "ListComputationModels":{ "name":"ListComputationModels", "http":{ "method":"GET", "requestUri":"/computation-models" }, "input":{"shape":"ListComputationModelsRequest"}, "output":{"shape":"ListComputationModelsResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"} ], "documentation":"Retrieves a paginated list of summaries of all computation models.
", "endpoint":{"hostPrefix":"api."} }, "ListDashboards":{ "name":"ListDashboards", "http":{ "method":"GET", "requestUri":"/dashboards", "responseCode":200 }, "input":{"shape":"ListDashboardsRequest"}, "output":{"shape":"ListDashboardsResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"} ], "documentation":"Retrieves a paginated list of dashboards for an IoT SiteWise Monitor project.
", "endpoint":{"hostPrefix":"monitor."} }, "ListDatasetDataSegmentRelationships":{ "name":"ListDatasetDataSegmentRelationships", "http":{ "method":"GET", "requestUri":"/datasets/{datasetId}/data-segment-relationships" }, "input":{"shape":"ListDatasetDataSegmentRelationshipsRequest"}, "output":{"shape":"ListDatasetDataSegmentRelationshipsResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"} ], "documentation":"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.
Retrieves a paginated list of data segments associated with a dataset. Use the nextToken parameter to retrieve additional results.
Retrieves a paginated list of dataset export jobs for a workspace.
", "endpoint":{"hostPrefix":"data."}, "readonly":true }, "ListDatasets":{ "name":"ListDatasets", "http":{ "method":"GET", "requestUri":"/datasets" }, "input":{"shape":"ListDatasetsRequest"}, "output":{"shape":"ListDatasetsResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"} ], "documentation":"Retrieves a paginated list of datasets for a specific target resource.
", "endpoint":{"hostPrefix":"api."} }, "ListEnrichmentJobs":{ "name":"ListEnrichmentJobs", "http":{ "method":"GET", "requestUri":"/workspaces/{workspaceName}/enrichment-jobs", "responseCode":200 }, "input":{"shape":"ListEnrichmentJobsRequest"}, "output":{"shape":"ListEnrichmentJobsResponse"}, "errors":[ {"shape":"InternalFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"InvalidRequestException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ConflictingOperationException"} ], "documentation":"Lists enrichment jobs within a workspace with optional filtering and pagination. Results are ordered by createdAt timestamp descending (newest first).
Combine filters to narrow results:
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.
Performance is optimal when filtering by supported fields (datasetId, propertyAlias, timeSeriesId, status, jobType).
", "endpoint":{"hostPrefix":"data."}, "readonly":true }, "ListExecutions":{ "name":"ListExecutions", "http":{ "method":"GET", "requestUri":"/executions" }, "input":{"shape":"ListExecutionsRequest"}, "output":{"shape":"ListExecutionsResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InternalFailureException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Retrieves a paginated list of summaries of all executions.
", "endpoint":{"hostPrefix":"api."} }, "ListGateways":{ "name":"ListGateways", "http":{ "method":"GET", "requestUri":"/20200301/gateways" }, "input":{"shape":"ListGatewaysRequest"}, "output":{"shape":"ListGatewaysResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"} ], "documentation":"Retrieves a paginated list of gateways.
", "endpoint":{"hostPrefix":"api."} }, "ListInterfaceRelationships":{ "name":"ListInterfaceRelationships", "http":{ "method":"GET", "requestUri":"/interface/{interfaceAssetModelId}/asset-models" }, "input":{"shape":"ListInterfaceRelationshipsRequest"}, "output":{"shape":"ListInterfaceRelationshipsResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"} ], "documentation":"Retrieves a paginated list of asset models that have a specific interface asset model applied to them.
", "endpoint":{"hostPrefix":"api."} }, "ListPipelineExecutions":{ "name":"ListPipelineExecutions", "http":{ "method":"GET", "requestUri":"/workspaces/{workspaceName}/pipelines/{pipelineName}/executions", "responseCode":200 }, "input":{"shape":"ListPipelineExecutionsRequest"}, "output":{"shape":"ListPipelineExecutionsResponse"}, "errors":[ {"shape":"InternalFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"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.
", "endpoint":{"hostPrefix":"data."}, "readonly":true }, "ListPipelines":{ "name":"ListPipelines", "http":{ "method":"GET", "requestUri":"/workspaces/{workspaceName}/pipelines", "responseCode":200 }, "input":{"shape":"ListPipelinesRequest"}, "output":{"shape":"ListPipelinesResponse"}, "errors":[ {"shape":"InternalFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Lists pipelines in a workspace. To get complete details about a pipeline, use DescribePipeline.
", "endpoint":{"hostPrefix":"api."}, "readonly":true }, "ListPortals":{ "name":"ListPortals", "http":{ "method":"GET", "requestUri":"/portals", "responseCode":200 }, "input":{"shape":"ListPortalsRequest"}, "output":{"shape":"ListPortalsResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"} ], "documentation":"Retrieves a paginated list of IoT SiteWise Monitor portals.
", "endpoint":{"hostPrefix":"monitor."} }, "ListProjectAssets":{ "name":"ListProjectAssets", "http":{ "method":"GET", "requestUri":"/projects/{projectId}/assets", "responseCode":200 }, "input":{"shape":"ListProjectAssetsRequest"}, "output":{"shape":"ListProjectAssetsResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"} ], "documentation":"Retrieves a paginated list of assets associated with an IoT SiteWise Monitor project.
", "endpoint":{"hostPrefix":"monitor."} }, "ListProjects":{ "name":"ListProjects", "http":{ "method":"GET", "requestUri":"/projects", "responseCode":200 }, "input":{"shape":"ListProjectsRequest"}, "output":{"shape":"ListProjectsResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"} ], "documentation":"Retrieves a paginated list of projects for an IoT SiteWise Monitor portal.
", "endpoint":{"hostPrefix":"monitor."} }, "ListQueries":{ "name":"ListQueries", "http":{ "method":"GET", "requestUri":"/workspaces/{workspaceName}/queries", "responseCode":200 }, "input":{"shape":"ListQueriesRequest"}, "output":{"shape":"ListQueriesResponse"}, "errors":[ {"shape":"InternalFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Retrieves a paginated list of queries for a workspace.
", "endpoint":{"hostPrefix":"data."}, "readonly":true }, "ListSearches":{ "name":"ListSearches", "http":{ "method":"POST", "requestUri":"/workspaces/{workspaceName}/searches/list", "responseCode":200 }, "input":{"shape":"ListSearchesRequest"}, "output":{"shape":"ListSearchesResponse"}, "errors":[ {"shape":"InternalFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"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.
Retrieves the list of tags for an IoT SiteWise resource.
", "endpoint":{"hostPrefix":"api."} }, "ListTasks":{ "name":"ListTasks", "http":{ "method":"GET", "requestUri":"/workspaces/{workspaceName}/tasks", "responseCode":200 }, "input":{"shape":"ListTasksRequest"}, "output":{"shape":"ListTasksResponse"}, "errors":[ {"shape":"InternalFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Lists tasks in a workspace. To get complete details about a task, use DescribeTask.
", "endpoint":{"hostPrefix":"api."}, "readonly":true }, "ListTimeSeries":{ "name":"ListTimeSeries", "http":{ "method":"GET", "requestUri":"/timeseries/" }, "input":{"shape":"ListTimeSeriesRequest"}, "output":{"shape":"ListTimeSeriesResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"} ], "documentation":"Retrieves a paginated list of time series (data streams).
", "endpoint":{"hostPrefix":"api."} }, "ListWorkspaces":{ "name":"ListWorkspaces", "http":{ "method":"GET", "requestUri":"/workspaces" }, "input":{"shape":"ListWorkspacesRequest"}, "output":{"shape":"ListWorkspacesResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"InvalidRequestException"}, {"shape":"ThrottlingException"}, {"shape":"InternalFailureException"} ], "documentation":"Retrieves a paginated list of workspaces. Use the nextToken parameter to retrieve additional results.
Creates or updates an interface relationship between an asset model and an interface asset model. This operation applies an interface to an asset model.
", "endpoint":{"hostPrefix":"api."} }, "PutDefaultEncryptionConfiguration":{ "name":"PutDefaultEncryptionConfiguration", "http":{ "method":"POST", "requestUri":"/configuration/account/encryption" }, "input":{"shape":"PutDefaultEncryptionConfigurationRequest"}, "output":{"shape":"PutDefaultEncryptionConfigurationResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"}, {"shape":"LimitExceededException"}, {"shape":"ConflictingOperationException"} ], "documentation":"Sets the default encryption configuration for the Amazon Web Services account. For more information, see Key management in the IoT SiteWise User Guide.
", "endpoint":{"hostPrefix":"api."} }, "PutLoggingOptions":{ "name":"PutLoggingOptions", "http":{ "method":"PUT", "requestUri":"/logging" }, "input":{"shape":"PutLoggingOptionsRequest"}, "output":{"shape":"PutLoggingOptionsResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ThrottlingException"}, {"shape":"InternalFailureException"}, {"shape":"ConflictingOperationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Sets logging options for IoT SiteWise.
", "endpoint":{"hostPrefix":"api."} }, "PutStorageConfiguration":{ "name":"PutStorageConfiguration", "http":{ "method":"POST", "requestUri":"/configuration/account/storage" }, "input":{"shape":"PutStorageConfigurationRequest"}, "output":{"shape":"PutStorageConfigurationResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceAlreadyExistsException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"}, {"shape":"LimitExceededException"}, {"shape":"ConflictingOperationException"} ], "documentation":"Configures storage settings for IoT SiteWise.
", "endpoint":{"hostPrefix":"api."} }, "StartPipelineExecution":{ "name":"StartPipelineExecution", "http":{ "method":"POST", "requestUri":"/workspaces/{workspaceName}/pipelines/{pipelineName}/executions", "responseCode":202 }, "input":{"shape":"StartPipelineExecutionRequest"}, "output":{"shape":"StartPipelineExecutionResponse"}, "errors":[ {"shape":"InternalFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"LimitExceededException"}, {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"ConflictingOperationException"} ], "documentation":"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.
", "endpoint":{"hostPrefix":"data."}, "idempotent":true }, "StartQuery":{ "name":"StartQuery", "http":{ "method":"POST", "requestUri":"/workspaces/{workspaceName}/queries", "responseCode":202 }, "input":{"shape":"StartQueryRequest"}, "output":{"shape":"StartQueryResponse"}, "errors":[ {"shape":"InternalFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"ConflictingOperationException"} ], "documentation":"Starts an asynchronous SQL query against workspace telemetry, annotations, data segment, and dataset data.
", "endpoint":{"hostPrefix":"data."}, "idempotent":true }, "StartSearch":{ "name":"StartSearch", "http":{ "method":"POST", "requestUri":"/workspaces/{workspaceName}/searches", "responseCode":202 }, "input":{"shape":"StartSearchRequest"}, "output":{"shape":"StartSearchResponse"}, "errors":[ {"shape":"InternalFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"InvalidRequestException"}, {"shape":"LimitExceededException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"ConflictingOperationException"} ], "documentation":"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.
Adds tags to an IoT SiteWise resource. If a tag already exists for the resource, this operation updates the tag's value.
", "endpoint":{"hostPrefix":"api."} }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"DELETE", "requestUri":"/tags" }, "input":{"shape":"UntagResourceRequest"}, "output":{"shape":"UntagResourceResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictingOperationException"}, {"shape":"LimitExceededException"}, {"shape":"UnauthorizedException"} ], "documentation":"Removes a tag from an IoT SiteWise resource.
", "endpoint":{"hostPrefix":"api."} }, "UpdateAccessPolicy":{ "name":"UpdateAccessPolicy", "http":{ "method":"PUT", "requestUri":"/access-policies/{accessPolicyId}", "responseCode":200 }, "input":{"shape":"UpdateAccessPolicyRequest"}, "output":{"shape":"UpdateAccessPolicyResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"} ], "documentation":"The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.
Updates an existing access policy that specifies an identity's access to an IoT SiteWise Monitor portal or project resource.
", "endpoint":{"hostPrefix":"monitor."} }, "UpdateAsset":{ "name":"UpdateAsset", "http":{ "method":"PUT", "requestUri":"/assets/{assetId}", "responseCode":202 }, "input":{"shape":"UpdateAssetRequest"}, "output":{"shape":"UpdateAssetResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceAlreadyExistsException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"}, {"shape":"ConflictingOperationException"} ], "documentation":"Updates an asset's name. For more information, see Updating assets and models in the IoT SiteWise User Guide.
", "endpoint":{"hostPrefix":"api."} }, "UpdateAssetModel":{ "name":"UpdateAssetModel", "http":{ "method":"PUT", "requestUri":"/asset-models/{assetModelId}", "responseCode":202 }, "input":{"shape":"UpdateAssetModelRequest"}, "output":{"shape":"UpdateAssetModelResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceAlreadyExistsException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"LimitExceededException"}, {"shape":"ThrottlingException"}, {"shape":"ConflictingOperationException"}, {"shape":"PreconditionFailedException"} ], "documentation":"Updates an asset model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models in the IoT SiteWise User Guide.
If you remove a property from an asset model, IoT SiteWise deletes all previous data for that property. You can’t change the type or data type of an existing property.
To replace an existing asset model property with a new one with the same name, do the following:
Submit an UpdateAssetModel request with the entire existing property removed.
Submit a second UpdateAssetModel request that includes the new property. The new asset property will have the same name as the previous one and IoT SiteWise will generate a new unique id.
Updates a composite model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models in the IoT SiteWise User Guide.
If you remove a property from a composite asset model, IoT SiteWise deletes all previous data for that property. You can’t change the type or data type of an existing property.
To replace an existing composite asset model property with a new one with the same name, do the following:
Submit an UpdateAssetModelCompositeModel request with the entire existing property removed.
Submit a second UpdateAssetModelCompositeModel request that includes the new property. The new asset property will have the same name as the previous one and IoT SiteWise will generate a new unique id.
Updates an asset property's alias and notification state.
This operation overwrites the property's existing alias and notification state. To keep your existing property's alias or notification state, you must include the existing values in the UpdateAssetProperty request. For more information, see DescribeAssetProperty.
Updates the computation model.
", "endpoint":{"hostPrefix":"api."} }, "UpdateDashboard":{ "name":"UpdateDashboard", "http":{ "method":"PUT", "requestUri":"/dashboards/{dashboardId}", "responseCode":200 }, "input":{"shape":"UpdateDashboardRequest"}, "output":{"shape":"UpdateDashboardResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"} ], "documentation":"The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.
Updates an IoT SiteWise Monitor dashboard.
", "endpoint":{"hostPrefix":"monitor."} }, "UpdateDataset":{ "name":"UpdateDataset", "http":{ "method":"PUT", "requestUri":"/datasets/{datasetId}", "responseCode":202 }, "input":{"shape":"UpdateDatasetRequest"}, "output":{"shape":"UpdateDatasetResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceAlreadyExistsException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"LimitExceededException"}, {"shape":"ThrottlingException"}, {"shape":"ConflictingOperationException"} ], "documentation":"Updates a dataset.
", "endpoint":{"hostPrefix":"api."} }, "UpdateGateway":{ "name":"UpdateGateway", "http":{ "method":"PUT", "requestUri":"/20200301/gateways/{gatewayId}" }, "input":{"shape":"UpdateGatewayRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictingOperationException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"} ], "documentation":"Updates a gateway's name.
", "endpoint":{"hostPrefix":"api."} }, "UpdateGatewayCapabilityConfiguration":{ "name":"UpdateGatewayCapabilityConfiguration", "http":{ "method":"POST", "requestUri":"/20200301/gateways/{gatewayId}/capability", "responseCode":201 }, "input":{"shape":"UpdateGatewayCapabilityConfigurationRequest"}, "output":{"shape":"UpdateGatewayCapabilityConfigurationResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictingOperationException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"}, {"shape":"LimitExceededException"} ], "documentation":"Updates a gateway capability configuration or defines a new capability configuration. Each gateway capability defines data sources for a gateway.
Important workflow notes:
Each gateway capability defines data sources for a gateway. This is the namespace of the gateway capability.
. The namespace follows the format service:capability:version, where:
service - The service providing the capability, or iotsitewise.
capability - The specific capability type. Options include: opcuacollector for the OPC UA data source collector, or publisher for data publisher capability.
version - The version number of the capability. Option include 2 for Classic streams, V2 gateways, and 3 for MQTT-enabled, V3 gateways.
After updating a capability configuration, the sync status becomes OUT_OF_SYNC until the gateway processes the configuration.Use DescribeGatewayCapabilityConfiguration to check the sync status and verify the configuration was applied.
A gateway can have multiple capability configurations with different namespaces.
", "endpoint":{"hostPrefix":"api."} }, "UpdatePipeline":{ "name":"UpdatePipeline", "http":{ "method":"PUT", "requestUri":"/workspaces/{workspaceName}/pipelines/{pipelineName}", "responseCode":200 }, "input":{"shape":"UpdatePipelineRequest"}, "output":{"shape":"UpdatePipelineResponse"}, "errors":[ {"shape":"InternalFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"LimitExceededException"}, {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"ConflictingOperationException"} ], "documentation":"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.
", "endpoint":{"hostPrefix":"api."}, "idempotent":true }, "UpdatePortal":{ "name":"UpdatePortal", "http":{ "method":"PUT", "requestUri":"/portals/{portalId}", "responseCode":202 }, "input":{"shape":"UpdatePortalRequest"}, "output":{"shape":"UpdatePortalResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"}, {"shape":"ConflictingOperationException"} ], "documentation":"The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.
Updates an IoT SiteWise Monitor portal.
", "endpoint":{"hostPrefix":"monitor."} }, "UpdateProject":{ "name":"UpdateProject", "http":{ "method":"PUT", "requestUri":"/projects/{projectId}", "responseCode":200 }, "input":{"shape":"UpdateProjectRequest"}, "output":{"shape":"UpdateProjectResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"} ], "documentation":"The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.
Updates an IoT SiteWise Monitor project.
", "endpoint":{"hostPrefix":"monitor."} }, "UpdateTask":{ "name":"UpdateTask", "http":{ "method":"PUT", "requestUri":"/workspaces/{workspaceName}/tasks/{taskName}", "responseCode":200 }, "input":{"shape":"UpdateTaskRequest"}, "output":{"shape":"UpdateTaskResponse"}, "errors":[ {"shape":"InternalFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"ConflictingOperationException"} ], "documentation":"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.
", "endpoint":{"hostPrefix":"api."}, "idempotent":true }, "UpdateWorkspace":{ "name":"UpdateWorkspace", "http":{ "method":"PUT", "requestUri":"/workspaces/{workspaceName}" }, "input":{"shape":"UpdateWorkspaceRequest"}, "output":{"shape":"UpdateWorkspaceResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidRequestException"}, {"shape":"ConflictingOperationException"}, {"shape":"ThrottlingException"}, {"shape":"InternalFailureException"} ], "documentation":"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.
Access is denied.
", "error":{"httpStatusCode":403}, "exception":true }, "AccessPolicySummaries":{ "type":"list", "member":{"shape":"AccessPolicySummary"} }, "AccessPolicySummary":{ "type":"structure", "required":[ "id", "identity", "resource", "permission" ], "members":{ "id":{ "shape":"ID", "documentation":"The ID of the access policy.
" }, "identity":{ "shape":"Identity", "documentation":"The identity (an IAM Identity Center user, an IAM Identity Center group, or an IAM user).
" }, "resource":{ "shape":"Resource", "documentation":"The IoT SiteWise Monitor resource (a portal or project).
" }, "permission":{ "shape":"Permission", "documentation":"The permissions for the access policy. Note that a project ADMINISTRATOR is also known as a project owner.
The date the access policy was created, in Unix epoch time.
" }, "lastUpdateDate":{ "shape":"Timestamp", "documentation":"The date the access policy was last updated, in Unix epoch time.
" } }, "documentation":"Contains an access policy that defines an identity's access to an IoT SiteWise Monitor resource.
" }, "ActionDefinition":{ "type":"structure", "required":[ "actionDefinitionId", "actionName", "actionType" ], "members":{ "actionDefinitionId":{ "shape":"ID", "documentation":"The ID of the action definition.
" }, "actionName":{ "shape":"Name", "documentation":"The name of the action definition.
" }, "actionType":{ "shape":"Name", "documentation":"The type of the action definition.
" } }, "documentation":"Contains a definition for an action.
" }, "ActionDefinitions":{ "type":"list", "member":{"shape":"ActionDefinition"} }, "ActionPayload":{ "type":"structure", "required":["stringValue"], "members":{ "stringValue":{ "shape":"ActionPayloadString", "documentation":"The payload of the action in a JSON string.
" } }, "documentation":"The JSON payload of the action.
" }, "ActionPayloadString":{ "type":"string", "pattern":"[^\\u0000-\\u001F\\u007F]+" }, "ActionSummaries":{ "type":"list", "member":{"shape":"ActionSummary"} }, "ActionSummary":{ "type":"structure", "members":{ "actionId":{ "shape":"ID", "documentation":"The ID of the action.
" }, "actionDefinitionId":{ "shape":"ID", "documentation":"The ID of the action definition.
" }, "targetResource":{ "shape":"TargetResource", "documentation":"The resource the action will be taken on.
" }, "resolveTo":{ "shape":"ResolveTo", "documentation":"The detailed resource this action resolves to.
" } }, "documentation":"Contains the summary of the actions, including information about where the action resolves to.
" }, "AdaptiveIngestion":{"type":"boolean"}, "AggregateType":{ "type":"string", "enum":[ "AVERAGE", "COUNT", "MAXIMUM", "MINIMUM", "SUM", "STANDARD_DEVIATION" ] }, "AggregateTypes":{ "type":"list", "member":{"shape":"AggregateType"}, "min":1 }, "AggregatedDoubleValue":{"type":"double"}, "AggregatedValue":{ "type":"structure", "required":[ "timestamp", "value" ], "members":{ "timestamp":{ "shape":"Timestamp", "documentation":"The date the aggregating computations occurred, in Unix epoch time.
" }, "quality":{ "shape":"Quality", "documentation":"The quality of the aggregated data.
" }, "value":{ "shape":"Aggregates", "documentation":"The value of the aggregates.
" } }, "documentation":"Contains aggregated asset property values (for example, average, minimum, and maximum).
" }, "AggregatedValues":{ "type":"list", "member":{"shape":"AggregatedValue"} }, "Aggregates":{ "type":"structure", "members":{ "average":{ "shape":"AggregatedDoubleValue", "documentation":"The average (mean) value of the time series over a time interval window.
" }, "count":{ "shape":"AggregatedDoubleValue", "documentation":"The count of data points in the time series over a time interval window.
" }, "maximum":{ "shape":"AggregatedDoubleValue", "documentation":"The maximum value of the time series over a time interval window.
" }, "minimum":{ "shape":"AggregatedDoubleValue", "documentation":"The minimum value of the time series over a time interval window.
" }, "sum":{ "shape":"AggregatedDoubleValue", "documentation":"The sum of the time series over a time interval window.
" }, "standardDeviation":{ "shape":"AggregatedDoubleValue", "documentation":"The standard deviation of the time series over a time interval window.
" } }, "documentation":"Contains the (pre-calculated) aggregate values for an asset property.
" }, "Alarms":{ "type":"structure", "required":["alarmRoleArn"], "members":{ "alarmRoleArn":{ "shape":"IamArn", "documentation":"The ARN of the IAM role that allows the alarm to perform actions and access Amazon Web Services resources and services, such as IoT Events.
" }, "notificationLambdaArn":{ "shape":"ARN", "documentation":"The ARN of the Lambda function that manages alarm notifications. For more information, see Managing alarm notifications in the IoT Events Developer Guide.
" } }, "documentation":"Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range. For more information, see Monitoring with alarms in the IoT SiteWise Application Guide.
" }, "AmazonResourceName":{ "type":"string", "max":1011, "min":1 }, "Annotation":{ "type":"structure", "members":{}, "documentation":"The annotation format configuration for bulk import files.
" }, "ApplicationDescription":{ "type":"string", "documentation":"Description of the application
", "max":2048, "min":1, "pattern":"[a-zA-Z0-9_-]+" }, "ApplicationId":{ "type":"string", "documentation":"Unique identifier for the application
", "max":36, "min":36, "pattern":"[a-z0-9-]{36}" }, "ApplicationList":{ "type":"list", "member":{"shape":"ApplicationSummary"}, "documentation":"List of applications
" }, "ApplicationName":{ "type":"string", "documentation":"Name of the application
", "max":256, "min":1, "pattern":"[A-Za-z0-9](?:[A-Za-z0-9 ._()\\-]*[A-Za-z0-9._()\\-])?" }, "ApplicationStatus":{ "type":"string", "documentation":"Current status of the application
", "enum":[ "CREATING", "ACTIVE", "DELETING" ] }, "ApplicationSummary":{ "type":"structure", "required":[ "arn", "id", "name", "status", "createdAt", "workspaceName" ], "members":{ "arn":{ "shape":"ARN", "documentation":"ARN of the application
" }, "id":{ "shape":"ApplicationId", "documentation":"Unique identifier of the application
" }, "name":{ "shape":"ApplicationName", "documentation":"Name of the application
" }, "status":{ "shape":"ApplicationStatus", "documentation":"Current status of the application
" }, "createdAt":{ "shape":"Timestamp", "documentation":"Timestamp when the application was created
" }, "workspaceName":{ "shape":"WorkspaceName", "documentation":"Name of the workspace this application belongs to
" } }, "documentation":"Summary of an application for list operations
" }, "AssetBindingValueFilter":{ "type":"structure", "required":["assetId"], "members":{ "assetId":{ "shape":"ID", "documentation":"The ID of the asset to filter data bindings by. Only data bindings referencing this specific asset are matched.
" } }, "documentation":"A filter used to match data bindings based on a specific asset. This filter identifies all computation models referencing a particular asset in their data bindings.
" }, "AssetCompositeModel":{ "type":"structure", "required":[ "name", "type", "properties" ], "members":{ "name":{ "shape":"Name", "documentation":"The name of the composite model.
" }, "description":{ "shape":"Description", "documentation":"The description of the composite model.
" }, "type":{ "shape":"Name", "documentation":"The type of the composite model. For alarm composite models, this type is AWS/ALARM.
The asset properties that this composite model defines.
" }, "id":{ "shape":"ID", "documentation":"The ID of the asset composite model.
" }, "externalId":{ "shape":"ExternalId", "documentation":"The external ID of the asset composite model. For more information, see Using external IDs in the IoT SiteWise User Guide.
" } }, "documentation":"Contains information about a composite model in an asset. This object contains the asset's properties that you define in the composite model.
" }, "AssetCompositeModelPath":{ "type":"list", "member":{"shape":"AssetCompositeModelPathSegment"} }, "AssetCompositeModelPathSegment":{ "type":"structure", "members":{ "id":{ "shape":"ID", "documentation":"The ID of the path segment.
" }, "name":{ "shape":"Name", "documentation":"The name of the path segment.
" } }, "documentation":"Represents one level between a composite model and the root of the asset.
" }, "AssetCompositeModelSummaries":{ "type":"list", "member":{"shape":"AssetCompositeModelSummary"} }, "AssetCompositeModelSummary":{ "type":"structure", "required":[ "id", "name", "type", "description", "path" ], "members":{ "id":{ "shape":"ID", "documentation":"The ID of the composite model that this summary describes.
" }, "externalId":{ "shape":"ExternalId", "documentation":"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.
The name of the composite model that this summary describes.
" }, "type":{ "shape":"Name", "documentation":"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.
A description of the composite model that this summary describes.
" }, "path":{ "shape":"AssetCompositeModelPath", "documentation":"The path that includes all the components of the asset model for the asset.
" } }, "documentation":"Contains a summary of the composite model for a specific asset.
" }, "AssetCompositeModels":{ "type":"list", "member":{"shape":"AssetCompositeModel"} }, "AssetErrorCode":{ "type":"string", "enum":["INTERNAL_FAILURE"] }, "AssetErrorDetails":{ "type":"structure", "required":[ "assetId", "code", "message" ], "members":{ "assetId":{ "shape":"ID", "documentation":"The ID of the asset, in UUID format.
" }, "code":{ "shape":"AssetErrorCode", "documentation":"The error code.
" }, "message":{ "shape":"AssetErrorMessage", "documentation":"The error message.
" } }, "documentation":"Contains error details for the requested associate project asset action.
" }, "AssetErrorMessage":{"type":"string"}, "AssetHierarchies":{ "type":"list", "member":{"shape":"AssetHierarchy"} }, "AssetHierarchy":{ "type":"structure", "required":["name"], "members":{ "id":{ "shape":"ID", "documentation":"The ID of the hierarchy. This ID is a hierarchyId.
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":{ "shape":"Name", "documentation":"The hierarchy name provided in the CreateAssetModel or UpdateAssetModel API operation.
" } }, "documentation":"Describes an asset hierarchy that contains a hierarchy's name and ID.
" }, "AssetHierarchyInfo":{ "type":"structure", "members":{ "parentAssetId":{ "shape":"ID", "documentation":"The ID of the parent asset in this asset relationship.
" }, "childAssetId":{ "shape":"ID", "documentation":"The ID of the child asset in this asset relationship.
" } }, "documentation":"Contains information about a parent asset and a child asset that are related through an asset hierarchy.
" }, "AssetIDs":{ "type":"list", "member":{"shape":"ID"} }, "AssetModelBindingValueFilter":{ "type":"structure", "required":["assetModelId"], "members":{ "assetModelId":{ "shape":"ID", "documentation":"The ID of the asset model to filter data bindings by. Only data bindings referemncing this specific asset model are matched.
" } }, "documentation":"A filter used to match data bindings based on a specific asset model. This filter identifies all computation models referencing a particular asset model in their data bindings.
" }, "AssetModelCompositeModel":{ "type":"structure", "required":[ "name", "type" ], "members":{ "name":{ "shape":"Name", "documentation":"The name of the composite model.
" }, "description":{ "shape":"Description", "documentation":"The description of the composite model.
" }, "type":{ "shape":"Name", "documentation":"The type of the composite model. For alarm composite models, this type is AWS/ALARM.
The asset property definitions for this composite model.
" }, "id":{ "shape":"CustomID", "documentation":"The ID of the asset model composite model.
" }, "externalId":{ "shape":"ExternalId", "documentation":"The external ID of the asset model composite model. For more information, see Using external IDs in the IoT SiteWise User Guide.
" } }, "documentation":"Contains information about a composite model in an asset model. This object contains the asset property definitions that you define in the composite model.
" }, "AssetModelCompositeModelDefinition":{ "type":"structure", "required":[ "name", "type" ], "members":{ "id":{ "shape":"ID", "documentation":"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":{ "shape":"ExternalId", "documentation":"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":{ "shape":"Name", "documentation":"The name of the composite model.
" }, "description":{ "shape":"Description", "documentation":"The description of the composite model.
" }, "type":{ "shape":"Name", "documentation":"The type of the composite model. For alarm composite models, this type is AWS/ALARM.
The asset property definitions for this composite model.
" } }, "documentation":"Contains a composite model definition in an asset model. This composite model definition is applied to all assets created from the asset model.
" }, "AssetModelCompositeModelDefinitions":{ "type":"list", "member":{"shape":"AssetModelCompositeModelDefinition"} }, "AssetModelCompositeModelPath":{ "type":"list", "member":{"shape":"AssetModelCompositeModelPathSegment"} }, "AssetModelCompositeModelPathSegment":{ "type":"structure", "members":{ "id":{ "shape":"ID", "documentation":"The ID of the path segment.
" }, "name":{ "shape":"Name", "documentation":"The name of the path segment.
" } }, "documentation":"Represents one level between a composite model and the root of the asset model.
" }, "AssetModelCompositeModelSummaries":{ "type":"list", "member":{"shape":"AssetModelCompositeModelSummary"} }, "AssetModelCompositeModelSummary":{ "type":"structure", "required":[ "id", "name", "type" ], "members":{ "id":{ "shape":"ID", "documentation":"The ID of the composite model that this summary describes..
" }, "externalId":{ "shape":"ExternalId", "documentation":"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":{ "shape":"Name", "documentation":"The name of the composite model that this summary describes..
" }, "type":{ "shape":"Name", "documentation":"The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.
The description of the composite model that this summary describes..
" }, "path":{ "shape":"AssetModelCompositeModelPath", "documentation":"The path that includes all the pieces that make up the composite model.
" } }, "documentation":"Contains a summary of the composite model.
" }, "AssetModelCompositeModels":{ "type":"list", "member":{"shape":"AssetModelCompositeModel"} }, "AssetModelHierarchies":{ "type":"list", "member":{"shape":"AssetModelHierarchy"} }, "AssetModelHierarchy":{ "type":"structure", "required":[ "name", "childAssetModelId" ], "members":{ "id":{ "shape":"CustomID", "documentation":"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.
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":{ "shape":"Name", "documentation":"The name of the asset model hierarchy that you specify by using the CreateAssetModel or UpdateAssetModel API operation.
" }, "childAssetModelId":{ "shape":"CustomID", "documentation":"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.
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.
" }, "AssetModelHierarchyDefinition":{ "type":"structure", "required":[ "name", "childAssetModelId" ], "members":{ "id":{ "shape":"ID", "documentation":"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":{ "shape":"ExternalId", "documentation":"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":{ "shape":"Name", "documentation":"The name of the asset model hierarchy definition (as specified in the CreateAssetModel or UpdateAssetModel API operation).
" }, "childAssetModelId":{ "shape":"CustomID", "documentation":"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.
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.
" }, "AssetModelHierarchyDefinitions":{ "type":"list", "member":{"shape":"AssetModelHierarchyDefinition"} }, "AssetModelProperties":{ "type":"list", "member":{"shape":"AssetModelProperty"} }, "AssetModelProperty":{ "type":"structure", "required":[ "name", "dataType", "type" ], "members":{ "id":{ "shape":"CustomID", "documentation":"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.
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":{ "shape":"Name", "documentation":"The name of the asset model property.
" }, "dataType":{ "shape":"PropertyDataType", "documentation":"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.
The data type of the structure for this property. This parameter exists on properties that have the STRUCT data type.
The unit of the asset model property, such as Newtons or RPM.
The property type (see PropertyType).
The structured path to the property from the root of the asset model.
" } }, "documentation":"Contains information about an asset model property.
" }, "AssetModelPropertyBindingValue":{ "type":"structure", "required":[ "assetModelId", "propertyId" ], "members":{ "assetModelId":{ "shape":"ID", "documentation":"The ID of the asset model, in UUID format.
" }, "propertyId":{ "shape":"ID", "documentation":"The ID of the asset model property used in data binding value.
" } }, "documentation":"Contains information about an assetModelProperty binding value.
The ID of the asset model containing the filter property. This identifies the specific asset model that contains the property of interest.
" }, "propertyId":{ "shape":"ID", "documentation":"The ID of the property within the asset model to filter by. Only data bindings referencing this specific property of the specified asset model are matched.
" } }, "documentation":"A filter used to match data bindings based on a specific asset model property. This filter identifies all computation models that reference a particular property of an asset model in their data bindings.
" }, "AssetModelPropertyDefinition":{ "type":"structure", "required":[ "name", "dataType", "type" ], "members":{ "id":{ "shape":"ID", "documentation":"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":{ "shape":"ExternalId", "documentation":"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":{ "shape":"Name", "documentation":"The name of the property definition.
" }, "dataType":{ "shape":"PropertyDataType", "documentation":"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.
The data type of the structure for this property. This parameter is required on properties that have the STRUCT data type.
The options for this parameter depend on the type of the composite model in which you define this property. Use AWS/ALARM_STATE for alarm state in alarm composite models.
The unit of the property definition, such as Newtons or RPM.
The property definition type (see PropertyType). You can only specify one type in a property definition.
Contains an asset model property definition. This property definition is applied to all assets created from the asset model.
" }, "AssetModelPropertyDefinitions":{ "type":"list", "member":{"shape":"AssetModelPropertyDefinition"} }, "AssetModelPropertyPath":{ "type":"list", "member":{"shape":"AssetModelPropertyPathSegment"} }, "AssetModelPropertyPathSegment":{ "type":"structure", "members":{ "id":{ "shape":"ID", "documentation":"The ID of the path segment.
" }, "name":{ "shape":"Name", "documentation":"The name of the path segment.
" } }, "documentation":"Represents one level between a property and the root of the asset model.
" }, "AssetModelPropertySummaries":{ "type":"list", "member":{"shape":"AssetModelPropertySummary"} }, "AssetModelPropertySummary":{ "type":"structure", "required":[ "name", "dataType", "type" ], "members":{ "id":{ "shape":"ID", "documentation":"The ID of the property.
" }, "externalId":{ "shape":"ExternalId", "documentation":"The external ID of the property. For more information, see Using external IDs in the IoT SiteWise User Guide.
" }, "name":{ "shape":"Name", "documentation":"The name of the property.
" }, "dataType":{ "shape":"PropertyDataType", "documentation":"The data type of the property.
" }, "dataTypeSpec":{ "shape":"Name", "documentation":"The data type of the structure for this property. This parameter exists on properties that have the STRUCT data type.
The unit (such as Newtons or RPM) of the property.
The ID of the composite model that contains the asset model property.
" }, "path":{ "shape":"AssetModelPropertyPath", "documentation":"The structured path to the property from the root of the asset model.
" }, "interfaceSummaries":{ "shape":"InterfaceSummaries", "documentation":"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.
" } }, "documentation":"Contains a summary of a property associated with a model. This includes information about which interfaces the property belongs to, if any.
" }, "AssetModelState":{ "type":"string", "enum":[ "CREATING", "ACTIVE", "UPDATING", "PROPAGATING", "DELETING", "FAILED" ] }, "AssetModelStatus":{ "type":"structure", "required":["state"], "members":{ "state":{ "shape":"AssetModelState", "documentation":"The current state of the asset model.
" }, "error":{ "shape":"ErrorDetails", "documentation":"Contains associated error information, if any.
" } }, "documentation":"Contains current status information for an asset model. For more information, see Asset and model states in the IoT SiteWise User Guide.
" }, "AssetModelSummaries":{ "type":"list", "member":{"shape":"AssetModelSummary"} }, "AssetModelSummary":{ "type":"structure", "required":[ "id", "arn", "name", "description", "creationDate", "lastUpdateDate", "status" ], "members":{ "id":{ "shape":"ID", "documentation":"The ID of the asset model (used with IoT SiteWise API operations).
" }, "externalId":{ "shape":"ExternalId", "documentation":"The external ID of the asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
" }, "arn":{ "shape":"ARN", "documentation":"The ARN of the asset model, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}
The name of the asset model.
" }, "assetModelType":{ "shape":"AssetModelType", "documentation":"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.
The asset model description.
" }, "creationDate":{ "shape":"Timestamp", "documentation":"The date the asset model was created, in Unix epoch time.
" }, "lastUpdateDate":{ "shape":"Timestamp", "documentation":"The date the asset model was last updated, in Unix epoch time.
" }, "status":{ "shape":"AssetModelStatus", "documentation":"The current status of the asset model.
" }, "version":{ "shape":"Version", "documentation":"The version number of the asset model.
" } }, "documentation":"Contains a summary of an asset model.
" }, "AssetModelType":{ "type":"string", "enum":[ "ASSET_MODEL", "COMPONENT_MODEL", "INTERFACE" ] }, "AssetModelVersionFilter":{ "type":"string", "pattern":"^(LATEST|ACTIVE)$" }, "AssetModelVersionType":{ "type":"string", "enum":[ "LATEST", "ACTIVE" ] }, "AssetProperties":{ "type":"list", "member":{"shape":"AssetProperty"} }, "AssetProperty":{ "type":"structure", "required":[ "id", "name", "dataType" ], "members":{ "id":{ "shape":"ID", "documentation":"The ID of the asset property.
" }, "externalId":{ "shape":"ExternalId", "documentation":"The external ID of the asset property. For more information, see Using external IDs in the IoT SiteWise User Guide.
" }, "name":{ "shape":"Name", "documentation":"The name of the property.
" }, "alias":{ "shape":"PropertyAlias", "documentation":"The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.
The asset property's notification topic and state. For more information, see UpdateAssetProperty.
" }, "dataType":{ "shape":"PropertyDataType", "documentation":"The data type of the asset property.
" }, "dataTypeSpec":{ "shape":"Name", "documentation":"The data type of the structure for this property. This parameter exists on properties that have the STRUCT data type.
The unit (such as Newtons or RPM) of the asset property.
The structured path to the property from the root of the asset.
" } }, "documentation":"Contains asset property information.
" }, "AssetPropertyAlias":{ "type":"string", "max":2048, "min":1, "pattern":"[^\\u0000-\\u001F\\u007F]+" }, "AssetPropertyBindingValue":{ "type":"structure", "required":[ "assetId", "propertyId" ], "members":{ "assetId":{ "shape":"ID", "documentation":"The ID of the asset containing the property. This identifies the specific asset instance's property value used in the computation model.
" }, "propertyId":{ "shape":"ID", "documentation":"The ID of the property within the asset. This identifies the specific property's value used in the computation model.
" } }, "documentation":"Represents a data binding value referencing a specific asset property. It's used to bind computation model variables to actual asset property values for processing.
" }, "AssetPropertyBindingValueFilter":{ "type":"structure", "required":[ "assetId", "propertyId" ], "members":{ "assetId":{ "shape":"ID", "documentation":"The ID of the asset containing the property to filter by. This identifies the specific asset instance containing the property of interest.
" }, "propertyId":{ "shape":"ID", "documentation":"The ID of the property within the asset to filter by. Only data bindings referencing this specific property of the specified asset are matched.
" } }, "documentation":"A filter used to match data bindings based on a specific asset property. This filter helps identify all computation models referencing a particular property of an asset in their data bindings.
" }, "AssetPropertyPath":{ "type":"list", "member":{"shape":"AssetPropertyPathSegment"} }, "AssetPropertyPathSegment":{ "type":"structure", "members":{ "id":{ "shape":"ID", "documentation":"The ID of the path segment.
" }, "name":{ "shape":"Name", "documentation":"The name of the path segment.
" } }, "documentation":"Represents one level between a property and the root of the asset.
" }, "AssetPropertySummaries":{ "type":"list", "member":{"shape":"AssetPropertySummary"} }, "AssetPropertySummary":{ "type":"structure", "required":["id"], "members":{ "id":{ "shape":"ID", "documentation":"The ID of the property.
" }, "externalId":{ "shape":"ExternalId", "documentation":"The external ID of the property. For more information, see Using external IDs in the IoT SiteWise User Guide.
" }, "alias":{ "shape":"PropertyAlias", "documentation":"The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.
The unit of measure (such as Newtons or RPM) of the asset property.
" }, "notification":{"shape":"PropertyNotification"}, "assetCompositeModelId":{ "shape":"ID", "documentation":"The ID of the composite model that contains the asset property.
" }, "path":{ "shape":"AssetPropertyPath", "documentation":"The structured path to the property from the root of the asset.
" } }, "documentation":"Contains a summary of a property associated with an asset.
" }, "AssetPropertyValue":{ "type":"structure", "required":[ "value", "timestamp" ], "members":{ "value":{ "shape":"Variant", "documentation":"The value of the asset property (see Variant).
The timestamp of the asset property value.
" }, "quality":{ "shape":"Quality", "documentation":"The quality of the asset property value.
" } }, "documentation":"Contains asset property value information.
" }, "AssetPropertyValueHistory":{ "type":"list", "member":{"shape":"AssetPropertyValue"} }, "AssetPropertyValues":{ "type":"list", "member":{"shape":"AssetPropertyValue"} }, "AssetRelationshipSummaries":{ "type":"list", "member":{"shape":"AssetRelationshipSummary"} }, "AssetRelationshipSummary":{ "type":"structure", "required":["relationshipType"], "members":{ "hierarchyInfo":{ "shape":"AssetHierarchyInfo", "documentation":"The assets that are related through an asset hierarchy.
This object is present if the relationshipType is HIERARCHY.
The relationship type of the assets in this relationship. This value is one of the following:
HIERARCHY – The assets are related through an asset hierarchy. If you specify this relationship type, this asset relationship includes the hierarchyInfo object.
Contains information about assets that are related to one another.
" }, "AssetRelationshipType":{ "type":"string", "enum":["HIERARCHY"] }, "AssetState":{ "type":"string", "enum":[ "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED" ] }, "AssetStatus":{ "type":"structure", "required":["state"], "members":{ "state":{ "shape":"AssetState", "documentation":"The current status of the asset.
" }, "error":{ "shape":"ErrorDetails", "documentation":"Contains associated error information, if any.
" } }, "documentation":"Contains information about the current status of an asset. For more information, see Asset and model states in the IoT SiteWise User Guide.
" }, "AssetSummaries":{ "type":"list", "member":{"shape":"AssetSummary"} }, "AssetSummary":{ "type":"structure", "required":[ "id", "arn", "name", "assetModelId", "creationDate", "lastUpdateDate", "status", "hierarchies" ], "members":{ "id":{ "shape":"ID", "documentation":"The ID of the asset, in UUID format.
" }, "externalId":{ "shape":"ExternalId", "documentation":"The external ID of the asset. For more information, see Using external IDs in the IoT SiteWise User Guide.
" }, "arn":{ "shape":"ARN", "documentation":"The ARN of the asset, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}
The name of the asset.
" }, "assetModelId":{ "shape":"ID", "documentation":"The ID of the asset model used to create this asset.
" }, "creationDate":{ "shape":"Timestamp", "documentation":"The date the asset was created, in Unix epoch time.
" }, "lastUpdateDate":{ "shape":"Timestamp", "documentation":"The date the asset was last updated, in Unix epoch time.
" }, "status":{ "shape":"AssetStatus", "documentation":"The current status of the asset.
" }, "hierarchies":{ "shape":"AssetHierarchies", "documentation":"A list of asset hierarchies that each contain a hierarchyId. A hierarchy specifies allowed parent/child asset relationships.
A description for the asset.
" } }, "documentation":"Contains a summary of an asset.
" }, "AssociateAssetsRequest":{ "type":"structure", "required":[ "assetId", "hierarchyId", "childAssetId" ], "members":{ "assetId":{ "shape":"CustomID", "documentation":"The ID of the parent 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.
The ID of a hierarchy in the parent asset's 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.) Hierarchies allow different groupings of assets to be formed that all come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.
The ID of the child asset to be associated. 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.
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.
", "idempotencyToken":true } } }, "AssociateDataSegmentEntries":{ "type":"list", "member":{"shape":"AssociateDataSegmentEntry"} }, "AssociateDataSegmentEntry":{ "type":"structure", "required":[ "sourceDatasetId", "timeSeriesId", "startTimestamp", "endTimestamp" ], "members":{ "sourceDatasetId":{ "shape":"ID", "documentation":"The ID of the source dataset that contains the data segment.
" }, "timeSeriesId":{ "shape":"TimeSeriesId", "documentation":"The ID of the time series.
" }, "startTimestamp":{ "shape":"TimeInNanos", "documentation":"The nanosecond-precision start time of the data segment to associate.
" }, "endTimestamp":{ "shape":"TimeInNanos", "documentation":"The nanosecond-precision end time of the data segment to associate.
" } }, "documentation":"Contains information about a data segment entry to associate with a dataset.
" }, "AssociateTimeSeriesToAssetPropertyRequest":{ "type":"structure", "required":[ "alias", "assetId", "propertyId" ], "members":{ "alias":{ "shape":"PropertyAlias", "documentation":"The alias that identifies the time series.
", "location":"querystring", "locationName":"alias" }, "assetId":{ "shape":"CustomID", "documentation":"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.
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.
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.
", "idempotencyToken":true } } }, "AssociatedAssetsSummaries":{ "type":"list", "member":{"shape":"AssociatedAssetsSummary"} }, "AssociatedAssetsSummary":{ "type":"structure", "required":[ "id", "arn", "name", "assetModelId", "creationDate", "lastUpdateDate", "status", "hierarchies" ], "members":{ "id":{ "shape":"ID", "documentation":"The ID of the asset, in UUID format.
" }, "externalId":{ "shape":"ExternalId", "documentation":"The external ID of the asset. For more information, see Using external IDs in the IoT SiteWise User Guide.
" }, "arn":{ "shape":"ARN", "documentation":"The ARN of the asset, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}
The name of the asset.
" }, "assetModelId":{ "shape":"ID", "documentation":"The ID of the asset model used to create the asset.
" }, "creationDate":{ "shape":"Timestamp", "documentation":"The date the asset was created, in Unix epoch time.
" }, "lastUpdateDate":{ "shape":"Timestamp", "documentation":"The date the asset was last updated, in Unix epoch time.
" }, "status":{ "shape":"AssetStatus", "documentation":"The current status of the asset.
" }, "hierarchies":{ "shape":"AssetHierarchies", "documentation":"A list of asset hierarchies that each contain a hierarchyId. A hierarchy specifies allowed parent/child asset relationships.
A description for the asset.
" } }, "documentation":"Contains a summary of an associated asset.
" }, "Attribute":{ "type":"structure", "members":{ "defaultValue":{ "shape":"DefaultValue", "documentation":"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.
" } }, "documentation":"Contains an asset attribute property. For more information, see Attributes in the IoT SiteWise User Guide.
" }, "AuthMode":{ "type":"string", "enum":[ "IAM", "SSO" ] }, "BatchAssociateDataSegmentsToDatasetRequest":{ "type":"structure", "required":[ "datasetId", "workspaceName", "associateDataSegmentEntries" ], "members":{ "datasetId":{ "shape":"ID", "documentation":"The ID of the curated dataset to associate data segments with.
", "location":"uri", "locationName":"datasetId" }, "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace that contains the dataset.
" }, "associateDataSegmentEntries":{ "shape":"AssociateDataSegmentEntries", "documentation":"The list of data segment entries to associate with the dataset.
" }, "clientToken":{ "shape":"ClientToken", "documentation":"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.
", "idempotencyToken":true } } }, "BatchAssociateDataSegmentsToDatasetResponse":{ "type":"structure", "required":[ "datasetId", "datasetVersion", "failedAssociations" ], "members":{ "datasetId":{ "shape":"ID", "documentation":"The ID of the dataset.
" }, "datasetVersion":{ "shape":"Version", "documentation":"The version of the dataset after association.
" }, "failedAssociations":{ "shape":"FailedDataSegmentAssociations", "documentation":"A list of data segment associations that failed.
" } } }, "BatchAssociateProjectAssetsErrors":{ "type":"list", "member":{"shape":"AssetErrorDetails"} }, "BatchAssociateProjectAssetsRequest":{ "type":"structure", "required":[ "projectId", "assetIds" ], "members":{ "projectId":{ "shape":"ID", "documentation":"The ID of the project to which to associate the assets.
", "location":"uri", "locationName":"projectId" }, "assetIds":{ "shape":"IDs", "documentation":"The IDs of the assets to be associated to the project.
" }, "clientToken":{ "shape":"ClientToken", "documentation":"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.
", "idempotencyToken":true } } }, "BatchAssociateProjectAssetsResponse":{ "type":"structure", "members":{ "errors":{ "shape":"BatchAssociateProjectAssetsErrors", "documentation":"A list of associated error information, if any.
" } } }, "BatchDeleteDatasetDataSegmentsRequest":{ "type":"structure", "required":[ "datasetId", "workspaceName", "deleteDataSegmentEntries" ], "members":{ "datasetId":{ "shape":"ID", "documentation":"The ID of the session dataset from which to delete data segments.
", "location":"uri", "locationName":"datasetId" }, "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace that contains the dataset.
" }, "deleteDataSegmentEntries":{ "shape":"DeleteDataSegmentEntries", "documentation":"The list of data segment entries to delete.
" }, "clientToken":{ "shape":"ClientToken", "documentation":"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.
", "idempotencyToken":true } } }, "BatchDeleteDatasetDataSegmentsResponse":{ "type":"structure", "required":[ "datasetId", "datasetVersion", "errors" ], "members":{ "datasetId":{ "shape":"ID", "documentation":"The ID of the dataset.
" }, "datasetVersion":{ "shape":"Version", "documentation":"The version of the dataset after deletion.
" }, "errors":{ "shape":"FailedDataSegmentDeletions", "documentation":"A list of data segment deletions that failed.
" } } }, "BatchDisassociateDataSegmentsFromDatasetRequest":{ "type":"structure", "required":[ "datasetId", "workspaceName", "disassociateDataSegmentEntries" ], "members":{ "datasetId":{ "shape":"ID", "documentation":"The ID of the curated dataset to disassociate data segments from.
", "location":"uri", "locationName":"datasetId" }, "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace that contains the dataset.
" }, "disassociateDataSegmentEntries":{ "shape":"DisassociateDataSegmentEntries", "documentation":"The list of data segment entries to disassociate from the dataset.
" }, "clientToken":{ "shape":"ClientToken", "documentation":"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.
", "idempotencyToken":true } } }, "BatchDisassociateDataSegmentsFromDatasetResponse":{ "type":"structure", "required":[ "datasetId", "datasetVersion", "failedDisassociations" ], "members":{ "datasetId":{ "shape":"ID", "documentation":"The ID of the dataset.
" }, "datasetVersion":{ "shape":"Version", "documentation":"The version of the dataset after disassociation.
" }, "failedDisassociations":{ "shape":"FailedDataSegmentDisassociations", "documentation":"A list of data segment disassociations that failed.
" } } }, "BatchDisassociateProjectAssetsErrors":{ "type":"list", "member":{"shape":"AssetErrorDetails"} }, "BatchDisassociateProjectAssetsRequest":{ "type":"structure", "required":[ "projectId", "assetIds" ], "members":{ "projectId":{ "shape":"ID", "documentation":"The ID of the project from which to disassociate the assets.
", "location":"uri", "locationName":"projectId" }, "assetIds":{ "shape":"IDs", "documentation":"The IDs of the assets to be disassociated from the project.
" }, "clientToken":{ "shape":"ClientToken", "documentation":"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.
", "idempotencyToken":true } } }, "BatchDisassociateProjectAssetsResponse":{ "type":"structure", "members":{ "errors":{ "shape":"BatchDisassociateProjectAssetsErrors", "documentation":"A list of associated error information, if any.
" } } }, "BatchEntryCompletionStatus":{ "type":"string", "enum":[ "SUCCESS", "ERROR" ] }, "BatchGetAssetPropertyAggregatesEntries":{ "type":"list", "member":{"shape":"BatchGetAssetPropertyAggregatesEntry"} }, "BatchGetAssetPropertyAggregatesEntry":{ "type":"structure", "required":[ "entryId", "aggregateTypes", "resolution", "startDate", "endDate" ], "members":{ "entryId":{ "shape":"EntryId", "documentation":"The ID of the entry.
" }, "assetId":{ "shape":"ID", "documentation":"The ID of the asset in which the asset property was created.
" }, "propertyId":{ "shape":"ID", "documentation":"The ID of the asset property, in UUID format.
" }, "propertyAlias":{ "shape":"AssetPropertyAlias", "documentation":"The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.
The data aggregating function.
" }, "resolution":{ "shape":"Resolution", "documentation":"The time interval over which to aggregate data.
" }, "startDate":{ "shape":"Timestamp", "documentation":"The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.
" }, "endDate":{ "shape":"Timestamp", "documentation":"The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.
" }, "qualities":{ "shape":"Qualities", "documentation":"The quality by which to filter asset data.
" }, "timeOrdering":{ "shape":"TimeOrdering", "documentation":"The chronological sorting order of the requested information.
Default: ASCENDING
Contains information for an asset property aggregate entry that is associated with the BatchGetAssetPropertyAggregates API.
To identify an asset property, you must specify one of the following:
The assetId and propertyId of an asset property.
A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
The error code.
" }, "errorMessage":{ "shape":"ErrorMessage", "documentation":"The associated error message.
" }, "entryId":{ "shape":"EntryId", "documentation":"The ID of the entry.
" } }, "documentation":"Contains error information for an asset property aggregate entry that is associated with the BatchGetAssetPropertyAggregates API.
" }, "BatchGetAssetPropertyAggregatesErrorInfo":{ "type":"structure", "required":[ "errorCode", "errorTimestamp" ], "members":{ "errorCode":{ "shape":"BatchGetAssetPropertyAggregatesErrorCode", "documentation":"The error code.
" }, "errorTimestamp":{ "shape":"Timestamp", "documentation":"The date the error occurred, in Unix epoch time.
" } }, "documentation":"Contains the error code and the timestamp for an asset property aggregate entry that is associated with the BatchGetAssetPropertyAggregates API.
" }, "BatchGetAssetPropertyAggregatesMaxResults":{ "type":"integer", "min":1 }, "BatchGetAssetPropertyAggregatesRequest":{ "type":"structure", "required":["entries"], "members":{ "entries":{ "shape":"BatchGetAssetPropertyAggregatesEntries", "documentation":"The list of asset property aggregate entries for the batch get request. You can specify up to 16 entries per request.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The token to be used for the next set of paginated results.
" }, "maxResults":{ "shape":"BatchGetAssetPropertyAggregatesMaxResults", "documentation":"The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first.
The size of the result set is equal to 1 MB.
The number of data points in the result set is equal to the value of maxResults. The maximum value of maxResults is 4000.
A list of the errors (if any) associated with the batch request. Each error entry contains the entryId of the entry that failed.
A list of entries that were processed successfully by this batch request. Each success entry contains the entryId of the entry that succeeded and the latest query result.
A list of entries that were not processed by this batch request. because these entries had been completely processed by previous paginated requests. Each skipped entry contains the entryId of the entry that skipped.
The token for the next set of results, or null if there are no additional results.
" } } }, "BatchGetAssetPropertyAggregatesSkippedEntries":{ "type":"list", "member":{"shape":"BatchGetAssetPropertyAggregatesSkippedEntry"} }, "BatchGetAssetPropertyAggregatesSkippedEntry":{ "type":"structure", "required":[ "entryId", "completionStatus" ], "members":{ "entryId":{ "shape":"EntryId", "documentation":"The ID of the entry.
" }, "completionStatus":{ "shape":"BatchEntryCompletionStatus", "documentation":"The completion status of each entry that is associated with the BatchGetAssetPropertyAggregates API.
" }, "errorInfo":{ "shape":"BatchGetAssetPropertyAggregatesErrorInfo", "documentation":"The error information, such as the error code and the timestamp.
" } }, "documentation":"Contains information for an entry that has been processed by the previous BatchGetAssetPropertyAggregates request.
" }, "BatchGetAssetPropertyAggregatesSuccessEntries":{ "type":"list", "member":{"shape":"BatchGetAssetPropertyAggregatesSuccessEntry"} }, "BatchGetAssetPropertyAggregatesSuccessEntry":{ "type":"structure", "required":[ "entryId", "aggregatedValues" ], "members":{ "entryId":{ "shape":"EntryId", "documentation":"The ID of the entry.
" }, "aggregatedValues":{ "shape":"AggregatedValues", "documentation":"The requested aggregated asset property values (for example, average, minimum, and maximum).
" } }, "documentation":"Contains success information for an entry that is associated with the BatchGetAssetPropertyAggregates API.
" }, "BatchGetAssetPropertyValueEntries":{ "type":"list", "member":{"shape":"BatchGetAssetPropertyValueEntry"} }, "BatchGetAssetPropertyValueEntry":{ "type":"structure", "required":["entryId"], "members":{ "entryId":{ "shape":"EntryId", "documentation":"The ID of the entry.
" }, "assetId":{ "shape":"ID", "documentation":"The ID of the asset in which the asset property was created.
" }, "propertyId":{ "shape":"ID", "documentation":"The ID of the asset property, in UUID format.
" }, "propertyAlias":{ "shape":"AssetPropertyAlias", "documentation":"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.
Contains information for an asset property value entry that is associated with the BatchGetAssetPropertyValue API.
To identify an asset property, you must specify one of the following:
The assetId and propertyId of an asset property.
A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
The error code.
" }, "errorMessage":{ "shape":"ErrorMessage", "documentation":"The associated error message.
" }, "entryId":{ "shape":"EntryId", "documentation":"The ID of the entry.
" } }, "documentation":"Contains error information for an asset property value entry that is associated with the BatchGetAssetPropertyValue API.
" }, "BatchGetAssetPropertyValueErrorInfo":{ "type":"structure", "required":[ "errorCode", "errorTimestamp" ], "members":{ "errorCode":{ "shape":"BatchGetAssetPropertyValueErrorCode", "documentation":"The error code.
" }, "errorTimestamp":{ "shape":"Timestamp", "documentation":"The date the error occurred, in Unix epoch time.
" } }, "documentation":"The error information, such as the error code and the timestamp.
" }, "BatchGetAssetPropertyValueHistoryEntries":{ "type":"list", "member":{"shape":"BatchGetAssetPropertyValueHistoryEntry"} }, "BatchGetAssetPropertyValueHistoryEntry":{ "type":"structure", "required":["entryId"], "members":{ "entryId":{ "shape":"EntryId", "documentation":"The ID of the entry.
" }, "assetId":{ "shape":"ID", "documentation":"The ID of the asset in which the asset property was created.
" }, "propertyId":{ "shape":"ID", "documentation":"The ID of the asset property, in UUID format.
" }, "propertyAlias":{ "shape":"AssetPropertyAlias", "documentation":"The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.
The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.
" }, "endDate":{ "shape":"Timestamp", "documentation":"The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.
" }, "qualities":{ "shape":"Qualities", "documentation":"The quality by which to filter asset data.
" }, "timeOrdering":{ "shape":"TimeOrdering", "documentation":"The chronological sorting order of the requested information.
Default: ASCENDING
Contains information for an asset property historical value entry that is associated with the BatchGetAssetPropertyValueHistory API.
To identify an asset property, you must specify one of the following:
The assetId and propertyId of an asset property.
A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
The error code.
" }, "errorMessage":{ "shape":"ErrorMessage", "documentation":"The associated error message.
" }, "entryId":{ "shape":"EntryId", "documentation":"The ID of the entry.
" } }, "documentation":"A list of the errors (if any) associated with the batch request. Each error entry contains the entryId of the entry that failed.
The error code.
" }, "errorTimestamp":{ "shape":"Timestamp", "documentation":"The date the error occurred, in Unix epoch time.
" } }, "documentation":"The error information, such as the error code and the timestamp.
" }, "BatchGetAssetPropertyValueHistoryMaxResults":{ "type":"integer", "min":1 }, "BatchGetAssetPropertyValueHistoryRequest":{ "type":"structure", "required":["entries"], "members":{ "entries":{ "shape":"BatchGetAssetPropertyValueHistoryEntries", "documentation":"The list of asset property historical value entries for the batch get request. You can specify up to 16 entries per request.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The token to be used for the next set of paginated results.
" }, "maxResults":{ "shape":"BatchGetAssetPropertyValueHistoryMaxResults", "documentation":"The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first.
The size of the result set is equal to 4 MB.
The number of data points in the result set is equal to the value of maxResults. The maximum value of maxResults is 20000.
A list of the errors (if any) associated with the batch request. Each error entry contains the entryId of the entry that failed.
A list of entries that were processed successfully by this batch request. Each success entry contains the entryId of the entry that succeeded and the latest query result.
A list of entries that were not processed by this batch request. because these entries had been completely processed by previous paginated requests. Each skipped entry contains the entryId of the entry that skipped.
The token for the next set of results, or null if there are no additional results.
" } } }, "BatchGetAssetPropertyValueHistorySkippedEntries":{ "type":"list", "member":{"shape":"BatchGetAssetPropertyValueHistorySkippedEntry"} }, "BatchGetAssetPropertyValueHistorySkippedEntry":{ "type":"structure", "required":[ "entryId", "completionStatus" ], "members":{ "entryId":{ "shape":"EntryId", "documentation":"The ID of the entry.
" }, "completionStatus":{ "shape":"BatchEntryCompletionStatus", "documentation":"The completion status of each entry that is associated with the BatchGetAssetPropertyValueHistory API.
" }, "errorInfo":{ "shape":"BatchGetAssetPropertyValueHistoryErrorInfo", "documentation":"The error information, such as the error code and the timestamp.
" } }, "documentation":"Contains information for an entry that has been processed by the previous BatchGetAssetPropertyValueHistory request.
" }, "BatchGetAssetPropertyValueHistorySuccessEntries":{ "type":"list", "member":{"shape":"BatchGetAssetPropertyValueHistorySuccessEntry"} }, "BatchGetAssetPropertyValueHistorySuccessEntry":{ "type":"structure", "required":[ "entryId", "assetPropertyValueHistory" ], "members":{ "entryId":{ "shape":"EntryId", "documentation":"The ID of the entry.
" }, "assetPropertyValueHistory":{ "shape":"AssetPropertyValueHistory", "documentation":"The requested historical values for the specified asset property.
" } }, "documentation":"Contains success information for an entry that is associated with the BatchGetAssetPropertyValueHistory API.
" }, "BatchGetAssetPropertyValueRequest":{ "type":"structure", "required":["entries"], "members":{ "entries":{ "shape":"BatchGetAssetPropertyValueEntries", "documentation":"The list of asset property value entries for the batch get request. You can specify up to 128 entries per request.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The token to be used for the next set of paginated results.
" } } }, "BatchGetAssetPropertyValueResponse":{ "type":"structure", "required":[ "errorEntries", "successEntries", "skippedEntries" ], "members":{ "errorEntries":{ "shape":"BatchGetAssetPropertyValueErrorEntries", "documentation":"A list of the errors (if any) associated with the batch request. Each error entry contains the entryId of the entry that failed.
A list of entries that were processed successfully by this batch request. Each success entry contains the entryId of the entry that succeeded and the latest query result.
A list of entries that were not processed by this batch request. because these entries had been completely processed by previous paginated requests. Each skipped entry contains the entryId of the entry that skipped.
The token for the next set of results, or null if there are no additional results.
" } } }, "BatchGetAssetPropertyValueSkippedEntries":{ "type":"list", "member":{"shape":"BatchGetAssetPropertyValueSkippedEntry"} }, "BatchGetAssetPropertyValueSkippedEntry":{ "type":"structure", "required":[ "entryId", "completionStatus" ], "members":{ "entryId":{ "shape":"EntryId", "documentation":"The ID of the entry.
" }, "completionStatus":{ "shape":"BatchEntryCompletionStatus", "documentation":"The completion status of each entry that is associated with the BatchGetAssetPropertyValue request.
" }, "errorInfo":{ "shape":"BatchGetAssetPropertyValueErrorInfo", "documentation":"The error information, such as the error code and the timestamp.
" } }, "documentation":"Contains information for an entry that has been processed by the previous BatchGetAssetPropertyValue request.
" }, "BatchGetAssetPropertyValueSuccessEntries":{ "type":"list", "member":{"shape":"BatchGetAssetPropertyValueSuccessEntry"} }, "BatchGetAssetPropertyValueSuccessEntry":{ "type":"structure", "required":["entryId"], "members":{ "entryId":{ "shape":"EntryId", "documentation":"The ID of the entry.
" }, "assetPropertyValue":{"shape":"AssetPropertyValue"} }, "documentation":"Contains success information for an entry that is associated with the BatchGetAssetPropertyValue API.
" }, "BatchPutAssetPropertyError":{ "type":"structure", "required":[ "errorCode", "errorMessage", "timestamps" ], "members":{ "errorCode":{ "shape":"BatchPutAssetPropertyValueErrorCode", "documentation":"The error code.
" }, "errorMessage":{ "shape":"ErrorMessage", "documentation":"The associated error message.
" }, "timestamps":{ "shape":"Timestamps", "documentation":"A list of timestamps for each error, if any.
" } }, "documentation":"Contains error information from updating a batch of asset property values.
" }, "BatchPutAssetPropertyErrorEntries":{ "type":"list", "member":{"shape":"BatchPutAssetPropertyErrorEntry"} }, "BatchPutAssetPropertyErrorEntry":{ "type":"structure", "required":[ "entryId", "errors" ], "members":{ "entryId":{ "shape":"EntryId", "documentation":"The ID of the failed entry.
" }, "errors":{ "shape":"BatchPutAssetPropertyErrors", "documentation":"The list of update property value errors.
" } }, "documentation":"Contains error information for asset property value entries that are associated with the BatchPutAssetPropertyValue API.
" }, "BatchPutAssetPropertyErrors":{ "type":"list", "member":{"shape":"BatchPutAssetPropertyError"} }, "BatchPutAssetPropertyValueErrorCode":{ "type":"string", "enum":[ "ResourceNotFoundException", "InvalidRequestException", "InternalFailureException", "ServiceUnavailableException", "ThrottlingException", "LimitExceededException", "ConflictingOperationException", "TimestampOutOfRangeException", "AccessDeniedException" ] }, "BatchPutAssetPropertyValueRequest":{ "type":"structure", "required":["entries"], "members":{ "enablePartialEntryProcessing":{ "shape":"BooleanValue", "documentation":"This setting enables partial ingestion at entry-level. If set to true, we ingest all TQVs not resulting in an error. If set to false, an invalid TQV fails ingestion of the entire entry that contains it.
The list of asset property value entries for the batch put request. You can specify up to 10 entries per request.
" } } }, "BatchPutAssetPropertyValueResponse":{ "type":"structure", "required":["errorEntries"], "members":{ "errorEntries":{ "shape":"BatchPutAssetPropertyErrorEntries", "documentation":"A list of the errors (if any) associated with the batch put request. Each error entry contains the entryId of the entry that failed.
The name of the IoT SiteWise workspace containing the enrichment job to cancel.
", "location":"uri", "locationName":"workspaceName" }, "jobId":{ "shape":"ID", "documentation":"The unique identifier of the enrichment job to cancel. This is the jobId returned by CreateEnrichmentJob.
", "location":"uri", "locationName":"jobId" } } }, "CancelEnrichmentJobResponse":{ "type":"structure", "required":[ "jobId", "status" ], "members":{ "jobId":{ "shape":"ID", "documentation":"The unique identifier of the cancelled enrichment job.
" }, "status":{ "shape":"EnrichmentJobStatus", "documentation":"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).
" } } }, "CancelPipelineExecutionRequest":{ "type":"structure", "required":[ "workspaceName", "pipelineName", "pipelineExecutionId" ], "members":{ "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace.
", "location":"uri", "locationName":"workspaceName" }, "pipelineName":{ "shape":"ResourceName", "documentation":"The name of the pipeline.
", "location":"uri", "locationName":"pipelineName" }, "pipelineExecutionId":{ "shape":"ID", "documentation":"The unique identifier of the pipeline execution.
", "location":"uri", "locationName":"pipelineExecutionId" }, "reason":{ "shape":"CancelPipelineExecutionRequestReasonString", "documentation":"A message describing why the pipeline execution is being cancelled.
" } }, "documentation":"Request structure for CancelPipelineExecution operation.
" }, "CancelPipelineExecutionRequestReasonString":{ "type":"string", "max":1024, "min":1 }, "CancelPipelineExecutionResponse":{ "type":"structure", "required":["state"], "members":{ "state":{ "shape":"PipelineExecutionState", "documentation":"The current execution state of the pipeline. Can only be CANCELLING or CANCELLED.
" } }, "documentation":"Response structure for CancelPipelineExecution operation.
" }, "CancelQueryRequest":{ "type":"structure", "required":[ "workspaceName", "queryId" ], "members":{ "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace associated with the query.
", "location":"uri", "locationName":"workspaceName" }, "queryId":{ "shape":"QueryId", "documentation":"The unique identifier for the query execution to cancel.
", "location":"uri", "locationName":"queryId" } } }, "CancelQueryResponse":{ "type":"structure", "required":[ "queryId", "status" ], "members":{ "queryId":{ "shape":"QueryId", "documentation":"The unique identifier for the cancelled query.
" }, "status":{ "shape":"QueryStatus", "documentation":"The current query status.
" } }, "documentation":"Contains the response for the CancelQuery operation.
" }, "CapabilityConfiguration":{ "type":"string", "max":10000000, "min":1 }, "CapabilityNamespace":{ "type":"string", "max":512, "min":1, "pattern":"^[a-zA-Z]+:[a-zA-Z]+:[0-9]+$" }, "CapabilitySyncStatus":{ "type":"string", "enum":[ "IN_SYNC", "OUT_OF_SYNC", "SYNC_FAILED", "UNKNOWN", "NOT_APPLICABLE" ] }, "CaptureBlob":{ "type":"blob", "documentation":"A binary blob containing video data.
" }, "Citation":{ "type":"structure", "members":{ "reference":{ "shape":"Reference", "documentation":"Contains information about the data source.
" }, "content":{ "shape":"Content", "documentation":"Contains the cited text from the data source.
" } }, "documentation":"Contains text content to which the SiteWise Assistant refers to, and generate the final response. It also contains information about the source.
" }, "Citations":{ "type":"list", "member":{"shape":"Citation"} }, "ClientToken":{ "type":"string", "max":64, "min":36, "pattern":"\\S{36,64}" }, "ColumnDataType":{ "type":"string", "documentation":"The data type of a column. Valid values are STRING, DOUBLE, BOOLEAN, INTEGER, TIMESTAMP, and VARIANT.
", "max":64, "min":1 }, "ColumnInfo":{ "type":"structure", "members":{ "name":{ "shape":"String", "documentation":"The name of the column description.
" }, "type":{ "shape":"ColumnType", "documentation":"The type of the column description.
" } }, "documentation":"A description of the column in the query results.
" }, "ColumnInformation":{ "type":"structure", "required":[ "name", "type" ], "members":{ "name":{ "shape":"ColumnLabel", "documentation":"The name of the column.
" }, "type":{ "shape":"ColumnDataType", "documentation":"The data type of the column. Valid values are STRING, DOUBLE, BOOLEAN, INTEGER, TIMESTAMP, and VARIANT.
" } }, "documentation":"Contains metadata about a column in the query results.
" }, "ColumnInformationList":{ "type":"list", "member":{"shape":"ColumnInformation"}, "documentation":"A list of column metadata entries for the query results.
" }, "ColumnLabel":{ "type":"string", "documentation":"The name of a column in the query results.
", "max":256, "min":1 }, "ColumnName":{ "type":"string", "enum":[ "ALIAS", "ASSET_ID", "PROPERTY_ID", "DATA_TYPE", "TIMESTAMP_SECONDS", "TIMESTAMP_NANO_OFFSET", "QUALITY", "VALUE" ] }, "ColumnNames":{ "type":"list", "member":{"shape":"ColumnName"} }, "ColumnType":{ "type":"structure", "members":{ "scalarType":{ "shape":"ScalarType", "documentation":"The allowed data types that the column has as it's value.
" } }, "documentation":"The data type of the column.
" }, "ColumnValue":{ "type":"string", "documentation":"A string-encoded column value.
", "max":1048576, "min":0 }, "ColumnsList":{ "type":"list", "member":{"shape":"ColumnInfo"} }, "CommandList":{ "type":"list", "member":{"shape":"String"}, "documentation":"A list of command strings to execute in the container.
", "sensitive":true }, "CompositeModelProperty":{ "type":"structure", "required":[ "name", "type", "assetProperty" ], "members":{ "name":{ "shape":"Name", "documentation":"The name of the property.
" }, "type":{ "shape":"Name", "documentation":"The type of the composite model that defines this property.
" }, "assetProperty":{"shape":"Property"}, "id":{ "shape":"ID", "documentation":"The ID of the composite model that contains the property.
" }, "externalId":{ "shape":"ExternalId", "documentation":"The external ID of the composite model that contains the property. For more information, see Using external IDs in the IoT SiteWise User Guide.
" } }, "documentation":"Contains information about a composite model property on an asset.
" }, "CompositionDetails":{ "type":"structure", "members":{ "compositionRelationship":{ "shape":"CompositionRelationship", "documentation":"An array detailing the composition relationship for this composite model.
" } }, "documentation":"Metadata for the composition relationship established by using composedAssetModelId in CreateAssetModelCompositeModel .
The ID of the component.
" } }, "documentation":"Represents a composite model that composed an asset model of type COMPONENT_MODEL.
The ID of the asset model, in UUID format.
" }, "assetModelCompositeModelId":{ "shape":"ID", "documentation":"The ID of a composite model on this asset model.
" }, "assetModelCompositeModelType":{ "shape":"Name", "documentation":"The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.
Contains a summary of the components of the composite model.
" }, "ComputationModelAnomalyDetectionConfiguration":{ "type":"structure", "required":[ "inputProperties", "resultProperty" ], "members":{ "inputProperties":{ "shape":"InputProperties", "documentation":"Define the variable name associated with input properties, with the following format ${VariableName}.
Define the variable name associated with the result property, and the following format ${VariableName}.
Contains the configuration of the type of anomaly detection computation model.
" }, "ComputationModelConfiguration":{ "type":"structure", "members":{ "anomalyDetection":{ "shape":"ComputationModelAnomalyDetectionConfiguration", "documentation":"The configuration for the anomaly detection type of computation model.
" } }, "documentation":"The configuration for the computation model.
" }, "ComputationModelDataBinding":{ "type":"map", "key":{"shape":"ComputationModelDataBindingVariable"}, "value":{"shape":"ComputationModelDataBindingValue"} }, "ComputationModelDataBindingUsageSummaries":{ "type":"list", "member":{"shape":"ComputationModelDataBindingUsageSummary"} }, "ComputationModelDataBindingUsageSummary":{ "type":"structure", "required":[ "computationModelIds", "matchedDataBinding" ], "members":{ "computationModelIds":{ "shape":"ComputationModelIdList", "documentation":"The list of computation model IDs that use this data binding. This allows identification of all computation models affected by changes to the referenced data source.
" }, "matchedDataBinding":{ "shape":"MatchedDataBinding", "documentation":"The data binding matched by the filter criteria. Contains details about specific data binding values used by the computation models.
" } }, "documentation":"A summary of how a specific data binding is used across computation models. This tracks dependencies between data sources and computation models, allowing you to understand the impact of changes to data sources.
" }, "ComputationModelDataBindingValue":{ "type":"structure", "members":{ "assetModelProperty":{ "shape":"AssetModelPropertyBindingValue", "documentation":"Specifies an asset model property data binding value.
" }, "assetProperty":{ "shape":"AssetPropertyBindingValue", "documentation":"The asset property value used for computation model data binding.
" }, "list":{ "shape":"BindingValueList", "documentation":"Specifies a list of data binding value.
" } }, "documentation":"Contains computation model data binding value information, which can be one of assetModelProperty, list.
A summary of the resource that a computation model resolves to.
" }, "ComputationModelState":{ "type":"string", "enum":[ "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED" ] }, "ComputationModelStatus":{ "type":"structure", "required":["state"], "members":{ "state":{ "shape":"ComputationModelState", "documentation":"The current state of the computation model.
" }, "error":{"shape":"ErrorDetails"} }, "documentation":"Contains current status information for a computation model.
" }, "ComputationModelSummaries":{ "type":"list", "member":{"shape":"ComputationModelSummary"} }, "ComputationModelSummary":{ "type":"structure", "required":[ "id", "arn", "name", "type", "creationDate", "lastUpdateDate", "status", "version" ], "members":{ "id":{ "shape":"ID", "documentation":"The ID of the computation model.
" }, "arn":{ "shape":"ARN", "documentation":"The ARN of the computation model, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:computation-model/${ComputationModelId}
The name of the computation model.
" }, "description":{ "shape":"RestrictedDescription", "documentation":"The description of the computation model.
" }, "type":{ "shape":"ComputationModelType", "documentation":"The type of the computation model.
" }, "creationDate":{ "shape":"Timestamp", "documentation":"The model creation date, in Unix epoch time.
" }, "lastUpdateDate":{ "shape":"Timestamp", "documentation":"The time the model was last updated, in Unix epoch time.
" }, "status":{ "shape":"ComputationModelStatus", "documentation":"The current status of the computation model.
" }, "version":{ "shape":"Version", "documentation":"The version of the computation model.
" } }, "documentation":"Contains a summary of a computation model.
" }, "ComputationModelType":{ "type":"string", "enum":["ANOMALY_DETECTION"] }, "ComputationModelVersionFilter":{ "type":"string", "pattern":"^(LATEST|ACTIVE|[1-9]{1}\\d{0,9})$" }, "ComputeLocation":{ "type":"string", "enum":[ "EDGE", "CLOUD" ] }, "ComputeNode":{ "type":"structure", "required":[ "computeNodeName", "taskName" ], "members":{ "computeNodeName":{ "shape":"ResourceName", "documentation":"The unique name for this compute node within the pipeline.
" }, "taskName":{ "shape":"ResourceName", "documentation":"The name of the task to execute for this compute node.
" }, "environmentVariables":{ "shape":"EnvironmentVariablesMap", "documentation":"Environment variables specific to this compute node. These override pipeline-level environment variables with the same key.
" }, "dependsOn":{ "shape":"ComputeNodeNameList", "documentation":"A list of compute node names that must complete successfully before this node can start.
" } }, "documentation":"A single compute node in a pipeline DAG. Each compute node references a task and can declare dependencies on other nodes.
" }, "ComputeNodeEnvironmentVariablesMap":{ "type":"map", "key":{ "shape":"ResourceName", "documentation":"The compute node name from the pipeline definition.
" }, "value":{ "shape":"EnvironmentVariablesMap", "documentation":"Environment variable overrides specific to this compute node.
" }, "documentation":"A map of compute node names to their environment variable overrides.
", "max":50, "min":0 }, "ComputeNodeErrorCode":{ "type":"string", "documentation":"Classification of a compute node execution failure.
", "enum":[ "VALIDATION_ERROR", "INTERNAL_FAILURE", "EXECUTION_ERROR", "TIMED_OUT" ] }, "ComputeNodeExecutionDetails":{ "type":"structure", "required":[ "computeNodeName", "taskName", "taskArn", "taskVersion", "dependsOn", "status" ], "members":{ "computeNodeName":{ "shape":"ResourceName", "documentation":"The name of the compute node.
" }, "taskName":{ "shape":"ResourceName", "documentation":"The name of the task executed for this compute node.
" }, "taskArn":{ "shape":"ARN", "documentation":"The ARN of the task.
" }, "taskVersion":{ "shape":"Version", "documentation":"The task version that executed for this compute node.
" }, "dependsOn":{ "shape":"ComputeNodeNameList", "documentation":"A list of compute node names that this node depends on.
" }, "status":{ "shape":"ComputeNodeExecutionStatus", "documentation":"The current execution status of the compute node.
" }, "startTime":{ "shape":"Timestamp", "documentation":"The time the compute node execution started, in Unix epoch time.
" }, "endTime":{ "shape":"Timestamp", "documentation":"The time the compute node execution completed, in Unix epoch time.
" }, "executionEnvironmentVariables":{ "shape":"ExecutionEnvironmentVariablesMap", "documentation":"The fully resolved environment variables used for this compute node execution.
" } }, "documentation":"Contains detailed execution information for a compute node within a pipeline execution.
" }, "ComputeNodeExecutionDetailsList":{ "type":"list", "member":{"shape":"ComputeNodeExecutionDetails"}, "documentation":"A list of compute node execution details.
" }, "ComputeNodeExecutionState":{ "type":"string", "documentation":"The state of an individual compute node execution.
", "enum":[ "NOT_STARTED", "QUEUED", "RUNNING", "SUCCEEDED", "FAILED" ] }, "ComputeNodeExecutionStateDetails":{ "type":"structure", "required":[ "code", "message" ], "members":{ "code":{ "shape":"ComputeNodeErrorCode", "documentation":"Classification of the failure.
" }, "message":{ "shape":"String", "documentation":"Human-readable description of why the compute node failed.
" }, "details":{ "shape":"DetailedErrorList", "documentation":"Detailed error entries to help diagnose the failure.
" } }, "documentation":"Additional information about a compute node that has failed.
" }, "ComputeNodeExecutionStatus":{ "type":"structure", "required":["state"], "members":{ "state":{ "shape":"ComputeNodeExecutionState", "documentation":"Current state of the compute node execution.
" }, "stateDetails":{ "shape":"ComputeNodeExecutionStateDetails", "documentation":"Additional information about the compute node's failure. Populated when the compute node has failed.
" } }, "documentation":"Current execution status of a compute node within a pipeline execution.
" }, "ComputeNodeList":{ "type":"list", "member":{"shape":"ComputeNode"}, "documentation":"A list of compute nodes forming a pipeline DAG.
", "max":50, "min":0 }, "ComputeNodeNameList":{ "type":"list", "member":{"shape":"ResourceName"}, "documentation":"A list of compute node names for declaring dependencies.
", "max":10, "min":0 }, "ConfigurationErrorDetails":{ "type":"structure", "required":[ "code", "message" ], "members":{ "code":{ "shape":"ErrorCode", "documentation":"The error code.
" }, "message":{ "shape":"ErrorMessage", "documentation":"The error message.
" } }, "documentation":"Contains the details of an IoT SiteWise configuration error.
" }, "ConfigurationState":{ "type":"string", "enum":[ "ACTIVE", "UPDATE_IN_PROGRESS", "UPDATE_FAILED" ] }, "ConfigurationStatus":{ "type":"structure", "required":["state"], "members":{ "state":{ "shape":"ConfigurationState", "documentation":"The current state of the configuration.
" }, "error":{ "shape":"ConfigurationErrorDetails", "documentation":"Contains associated error information, if any.
" } }, "documentation":"Contains current status information for the configuration.
" }, "ConflictingOperationException":{ "type":"structure", "required":[ "message", "resourceId", "resourceArn" ], "members":{ "message":{"shape":"ErrorMessage"}, "resourceId":{ "shape":"ResourceId", "documentation":"The ID of the resource that conflicts with this operation.
" }, "resourceArn":{ "shape":"ResourceArn", "documentation":"The ARN of the resource that conflicts with this operation.
" } }, "documentation":"Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
", "error":{"httpStatusCode":409}, "exception":true }, "ContainerTaskConfiguration":{ "type":"structure", "required":[ "ecrUri", "taskExecutionRole", "processingType", "processingUnit" ], "members":{ "ecrUri":{ "shape":"EcrUri", "documentation":"The Amazon ECR image URI for the task container.
" }, "taskExecutionRole":{ "shape":"IamRoleArn", "documentation":"The ARN of the IAM role that grants the containerized workload permissions to access AWS resources.
" }, "processingType":{ "shape":"ProcessingType", "documentation":"The processing type for compute resources.
" }, "processingUnit":{ "shape":"ProcessingUnit", "documentation":"The processing unit allocation that determines the vCPU, memory, and GPU resources.
" }, "command":{ "shape":"CommandList", "documentation":"The command to execute in the container.
" }, "timeoutSeconds":{ "shape":"TimeoutSeconds", "documentation":"The timeout in seconds for task execution. Default: 3600 (1 hour).
" }, "environmentVariables":{ "shape":"EnvironmentVariablesMap", "documentation":"Environment variables passed to the container at runtime.
" } }, "documentation":"Configuration for a container task, including the container image, IAM role, and compute settings.
" }, "Content":{ "type":"structure", "members":{ "text":{ "shape":"String", "documentation":"The cited text from the data source.
" } }, "documentation":"Contains the cited text from the data source.
" }, "ConversationId":{ "type":"string", "max":36, "min":36, "pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" }, "CoreDeviceOperatingSystem":{ "type":"string", "enum":[ "LINUX_AARCH64", "LINUX_AMD64", "WINDOWS_AMD64" ] }, "CoreDeviceThingName":{ "type":"string", "max":128, "min":1, "pattern":"^[a-zA-Z0-9:_-]+$" }, "CreateAccessPolicyRequest":{ "type":"structure", "required":[ "accessPolicyIdentity", "accessPolicyResource", "accessPolicyPermission" ], "members":{ "accessPolicyIdentity":{ "shape":"Identity", "documentation":"The identity for this access policy. Choose an IAM Identity Center user, an IAM Identity Center group, or an IAM user.
" }, "accessPolicyResource":{ "shape":"Resource", "documentation":"The IoT SiteWise Monitor resource for this access policy. Choose either a portal or a project.
" }, "accessPolicyPermission":{ "shape":"Permission", "documentation":"The permission level for this access policy. Note that a project ADMINISTRATOR is also known as a project owner.
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
", "idempotencyToken":true }, "tags":{ "shape":"TagMap", "documentation":"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.
" } } }, "CreateAccessPolicyResponse":{ "type":"structure", "required":[ "accessPolicyId", "accessPolicyArn" ], "members":{ "accessPolicyId":{ "shape":"ID", "documentation":"The ID of the access policy.
" }, "accessPolicyArn":{ "shape":"ARN", "documentation":"The ARN of the access policy, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId}
Unique client token for idempotent request handling
", "idempotencyToken":true }, "idcInstanceArn":{ "shape":"ARN", "documentation":"Identity Center Instance ARN to create the application in
" }, "workspaceName":{ "shape":"WorkspaceName", "documentation":"Name of the workspace to associate with the underlying Application
" }, "name":{ "shape":"ApplicationName", "documentation":"Name of the application
" }, "description":{ "shape":"Description", "documentation":"Description of the application
" }, "tags":{ "shape":"TagMap", "documentation":"A list of key-value pairs that contain metadata for the application.
" } } }, "CreateApplicationResponse":{ "type":"structure", "required":[ "arn", "id", "dnsSubdomain", "name", "status" ], "members":{ "arn":{ "shape":"ARN", "documentation":"ARN of the application
" }, "id":{ "shape":"ApplicationId", "documentation":"Unique identifier of the application
" }, "dnsSubdomain":{ "shape":"DnsSubdomain", "documentation":"DNS subdomain for the application
" }, "name":{ "shape":"ApplicationName", "documentation":"Name of the application
" }, "status":{ "shape":"ApplicationStatus", "documentation":"Current status of the application
" } } }, "CreateAssetModelCompositeModelRequest":{ "type":"structure", "required":[ "assetModelId", "assetModelCompositeModelName", "assetModelCompositeModelType" ], "members":{ "assetModelId":{ "shape":"CustomID", "documentation":"The ID of the asset model this composite model is a part of.
", "location":"uri", "locationName":"assetModelId" }, "assetModelCompositeModelExternalId":{ "shape":"ExternalId", "documentation":"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.
The ID of the parent composite model in this asset model relationship.
" }, "assetModelCompositeModelId":{ "shape":"ID", "documentation":"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.
" }, "assetModelCompositeModelDescription":{ "shape":"Description", "documentation":"A description for the composite model.
" }, "assetModelCompositeModelName":{ "shape":"Name", "documentation":"A unique name for the composite model.
" }, "assetModelCompositeModelType":{ "shape":"Name", "documentation":"The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.
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.
", "idempotencyToken":true }, "composedAssetModelId":{ "shape":"CustomID", "documentation":"The ID of a component model which is reused to create this composite model.
" }, "assetModelCompositeModelProperties":{ "shape":"AssetModelPropertyDefinitions", "documentation":"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.
" }, "ifMatch":{ "shape":"ETag", "documentation":"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.
Accepts * to reject the create request if an active version (specified using matchForVersionType as ACTIVE) already exists for the asset model.
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.
The ID of the composed asset model. You can use this ID when you call other IoT SiteWise APIs.
" }, "assetModelCompositeModelPath":{ "shape":"AssetModelCompositeModelPath", "documentation":"The path to the composite model listing the parent composite models.
" }, "assetModelStatus":{"shape":"AssetModelStatus"}, "assetModelId":{ "shape":"ID", "documentation":"The ID of the asset model.
" } } }, "CreateAssetModelRequest":{ "type":"structure", "required":["assetModelName"], "members":{ "assetModelName":{ "shape":"Name", "documentation":"A unique name for the asset model.
" }, "assetModelType":{ "shape":"AssetModelType", "documentation":"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.
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.
" }, "assetModelExternalId":{ "shape":"ExternalId", "documentation":"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.
" }, "assetModelDescription":{ "shape":"Description", "documentation":"A description for the asset model.
" }, "assetModelProperties":{ "shape":"AssetModelPropertyDefinitions", "documentation":"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.
" }, "assetModelHierarchies":{ "shape":"AssetModelHierarchyDefinitions", "documentation":"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.
" }, "assetModelCompositeModels":{ "shape":"AssetModelCompositeModelDefinitions", "documentation":"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.
When creating custom composite models, you need to use CreateAssetModelCompositeModel. For more information, see Creating custom composite models (Components) in the IoT SiteWise User Guide.
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
", "idempotencyToken":true }, "tags":{ "shape":"TagMap", "documentation":"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.
" } } }, "CreateAssetModelResponse":{ "type":"structure", "required":[ "assetModelId", "assetModelArn", "assetModelStatus" ], "members":{ "assetModelId":{ "shape":"ID", "documentation":"The ID of the asset model, in UUID format. You can use this ID when you call other IoT SiteWise API operations.
" }, "assetModelArn":{ "shape":"ARN", "documentation":"The ARN of the asset model, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}
The status of the asset model, which contains a state (CREATING after successfully calling this operation) and any error message.
A friendly name for the asset.
" }, "assetModelId":{ "shape":"CustomID", "documentation":"The ID of the asset model from which to create 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.
The ID to assign to the asset, 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.
" }, "assetExternalId":{ "shape":"ExternalId", "documentation":"An external ID to assign to the asset. 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.
" }, "clientToken":{ "shape":"ClientToken", "documentation":"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.
", "idempotencyToken":true }, "tags":{ "shape":"TagMap", "documentation":"A list of key-value pairs that contain metadata for the asset. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.
" }, "assetDescription":{ "shape":"Description", "documentation":"A description for the asset.
" } } }, "CreateAssetResponse":{ "type":"structure", "required":[ "assetId", "assetArn", "assetStatus" ], "members":{ "assetId":{ "shape":"ID", "documentation":"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 API operations.
" }, "assetArn":{ "shape":"ARN", "documentation":"The ARN of the asset, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}
The status of the asset, which contains a state (CREATING after successfully calling this operation) and any error message.
The unique name that helps identify the job request.
" }, "jobRoleArn":{ "shape":"ARN", "documentation":"The ARN of the IAM role that allows IoT SiteWise to read Amazon S3 data.
" }, "files":{ "shape":"Files", "documentation":"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.
The Amazon S3 destination where errors associated with the job creation request are saved.
" }, "jobConfiguration":{ "shape":"JobConfiguration", "documentation":"Contains the configuration information of a job, such as the file format used to save data in Amazon S3.
" }, "adaptiveIngestion":{ "shape":"AdaptiveIngestion", "documentation":"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":{ "shape":"DeleteFilesAfterImport", "documentation":"If set to true, your data files is deleted from S3, after ingestion into IoT SiteWise storage.
" }, "datasetId":{ "shape":"ID", "documentation":"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.
The name of the workspace that contains the session dataset. Specify this field together with datasetId.
The ID of the job.
" }, "jobName":{ "shape":"BulkImportJobName", "documentation":"The unique name that helps identify the job request.
" }, "jobStatus":{ "shape":"JobStatus", "documentation":"The status of the bulk import job can be one of following values:
PENDING – IoT SiteWise is waiting for the current bulk import job to finish.
CANCELLED – The bulk import job has been canceled.
RUNNING – IoT SiteWise is processing your request to import your data from Amazon S3.
COMPLETED – IoT SiteWise successfully completed your request to import data from Amazon S3.
FAILED – IoT SiteWise couldn't process your request to import data from Amazon S3. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.
COMPLETED_WITH_FAILURES – IoT SiteWise completed your request to import data from Amazon S3 with errors. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.
The name of the computation model.
" }, "computationModelDescription":{ "shape":"RestrictedDescription", "documentation":"The description of the computation model.
" }, "computationModelConfiguration":{ "shape":"ComputationModelConfiguration", "documentation":"The configuration for the computation model.
" }, "computationModelDataBinding":{ "shape":"ComputationModelDataBinding", "documentation":"The data binding for the computation model. Key is a variable name defined in configuration. Value is a ComputationModelDataBindingValue referenced by the variable.
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.
", "idempotencyToken":true }, "tags":{ "shape":"TagMap", "documentation":"A list of key-value pairs that contain metadata for the asset. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.
" } } }, "CreateComputationModelResponse":{ "type":"structure", "required":[ "computationModelId", "computationModelArn", "computationModelStatus" ], "members":{ "computationModelId":{ "shape":"ID", "documentation":"The ID of the computation model.
" }, "computationModelArn":{ "shape":"ARN", "documentation":"The ARN of the computation model, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:computation-model/${ComputationModelId}
The status of the computation model, containing a state (CREATING after successfully calling this operation) and any error messages.
" } } }, "CreateDashboardRequest":{ "type":"structure", "required":[ "projectId", "dashboardName", "dashboardDefinition" ], "members":{ "projectId":{ "shape":"ID", "documentation":"The ID of the project in which to create the dashboard.
" }, "dashboardName":{ "shape":"Name", "documentation":"A friendly name for the dashboard.
" }, "dashboardDescription":{ "shape":"Description", "documentation":"A description for the dashboard.
" }, "dashboardDefinition":{ "shape":"DashboardDefinition", "documentation":"The dashboard definition specified in a JSON literal.
IoT SiteWise Monitor (Classic) see Create dashboards (CLI)
IoT SiteWise Monitor (AI-aware) see Create dashboards (CLI)
in the IoT SiteWise User Guide
" }, "clientToken":{ "shape":"ClientToken", "documentation":"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.
", "idempotencyToken":true }, "tags":{ "shape":"TagMap", "documentation":"A list of key-value pairs that contain metadata for the dashboard. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.
" } } }, "CreateDashboardResponse":{ "type":"structure", "required":[ "dashboardId", "dashboardArn" ], "members":{ "dashboardId":{ "shape":"ID", "documentation":"The ID of the dashboard.
" }, "dashboardArn":{ "shape":"ARN", "documentation":"The ARN of the dashboard, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}
The name of the workspace in which to create the dataset export job.
", "location":"uri", "locationName":"workspaceName" }, "clientToken":{ "shape":"ClientToken", "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. The AWS SDKs and CLI populate this automatically.
", "idempotencyToken":true }, "destinationS3Uri":{ "shape":"S3Uri", "documentation":"The S3 URI where output clips will be written.
" }, "input":{ "shape":"ProcessingInput", "documentation":"The processing input source.
" }, "errorReportLocation":{ "shape":"ExportErrorReportLocation", "documentation":"The location where the error report will be written on failure.
" } }, "documentation":"Request to create a dataset export job.
" }, "CreateDatasetExportJobResponse":{ "type":"structure", "required":[ "jobId", "workspaceName" ], "members":{ "jobId":{ "shape":"DatasetExportJobId", "documentation":"The unique identifier for the dataset export job.
" }, "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace in which the dataset export job was created.
" } }, "documentation":"Response for create dataset export job request.
" }, "CreateDatasetRequest":{ "type":"structure", "required":[ "datasetName", "datasetSource" ], "members":{ "datasetId":{ "shape":"ID", "documentation":"The ID of the dataset.
" }, "datasetName":{ "shape":"RestrictedName", "documentation":"The name of the dataset.
" }, "datasetDescription":{ "shape":"Description", "documentation":"A description about the dataset, and its functionality.
" }, "datasetType":{ "shape":"DatasetTypeEnum", "documentation":"The type of dataset: a session dataset, a curated dataset, or a connection to an external datasource.
" }, "datasetConfig":{ "shape":"DatasetConfig", "documentation":"The configuration for the dataset.
" }, "workspaceName":{ "shape":"WorkspaceName", "documentation":"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.
" }, "metadata":{ "shape":"Metadata", "documentation":"The metadata for the dataset, provided as key-value pairs.
" }, "datasetSource":{ "shape":"DatasetSource", "documentation":"The data source for the dataset.
" }, "clientToken":{ "shape":"ClientToken", "documentation":"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.
", "idempotencyToken":true }, "tags":{ "shape":"TagMap", "documentation":"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.
" } } }, "CreateDatasetResponse":{ "type":"structure", "required":[ "datasetId", "datasetArn", "datasetStatus" ], "members":{ "datasetId":{ "shape":"ID", "documentation":"The ID of the dataset.
" }, "datasetArn":{ "shape":"ARN", "documentation":"The ARN of the dataset. The format is arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId}.
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.
The name of the IoT SiteWise workspace containing the video data to analyze.
", "location":"uri", "locationName":"workspaceName" }, "jobConfiguration":{ "shape":"EnrichmentJobConfiguration", "documentation":"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.
" }, "clientToken":{ "shape":"ClientToken", "documentation":"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.
", "idempotencyToken":true } } }, "CreateEnrichmentJobResponse":{ "type":"structure", "required":[ "jobId", "status", "createdAt" ], "members":{ "jobId":{ "shape":"ID", "documentation":"Unique identifier for the enrichment job. Use this ID with DescribeEnrichmentJob to monitor progress or with CancelEnrichmentJob to cancel the job.
" }, "status":{ "shape":"EnrichmentJobStatus", "documentation":"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":{ "shape":"Timestamp", "documentation":"Timestamp when the enrichment job was created in ISO 8601 format.
" } } }, "CreateGatewayRequest":{ "type":"structure", "required":[ "gatewayName", "gatewayPlatform" ], "members":{ "gatewayName":{ "shape":"GatewayName", "documentation":"A unique name for the gateway.
" }, "gatewayPlatform":{ "shape":"GatewayPlatform", "documentation":"The gateway's platform. You can only specify one platform in a gateway.
" }, "gatewayVersion":{ "shape":"GatewayVersion", "documentation":"The version of the gateway to create. Specify 3 to create an MQTT-enabled, V3 gateway and 2 to create a Classic streams, V2 gateway. If not specified, the default is 2 (Classic streams, V2 gateway).
When creating a V3 gateway (gatewayVersion=3) with the GreengrassV2 platform, you must also specify the coreDeviceOperatingSystem parameter.
We recommend creating an MQTT-enabled gateway for self-hosted gateways and Siemens Industrial Edge gateways. For more information on gateway versions, see Use Amazon Web Services IoT SiteWise Edge Edge gateways.
" }, "tags":{ "shape":"TagMap", "documentation":"A list of key-value pairs that contain metadata for the gateway. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.
" } } }, "CreateGatewayResponse":{ "type":"structure", "required":[ "gatewayId", "gatewayArn" ], "members":{ "gatewayId":{ "shape":"ID", "documentation":"The ID of the gateway device. You can use this ID when you call other IoT SiteWise API operations.
" }, "gatewayArn":{ "shape":"ARN", "documentation":"The ARN of the gateway, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}
The name of the workspace.
", "location":"uri", "locationName":"workspaceName" }, "pipelineName":{ "shape":"ResourceName", "documentation":"The name of the pipeline to create. Must be unique within the workspace.
" }, "description":{ "shape":"Description", "documentation":"A description of the pipeline.
" }, "environmentVariables":{ "shape":"EnvironmentVariablesMap", "documentation":"Environment variables shared across all compute nodes in the pipeline. Individual compute nodes can override these values with their own environment variables.
" }, "computations":{ "shape":"ComputeNodeList", "documentation":"The list of compute nodes that form the pipeline DAG. Each compute node references a task and can declare dependencies on other nodes.
" }, "tags":{ "shape":"TagMap", "documentation":"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.
" }, "clientToken":{ "shape":"ClientToken", "documentation":"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.
", "idempotencyToken":true } }, "documentation":"Request structure for CreatePipeline operation.
" }, "CreatePipelineResponse":{ "type":"structure", "required":[ "pipelineName", "pipelineArn", "version", "status" ], "members":{ "pipelineName":{ "shape":"ResourceName", "documentation":"The name of the created pipeline.
" }, "pipelineArn":{ "shape":"ARN", "documentation":"The ARN of the created pipeline.
" }, "version":{ "shape":"Version", "documentation":"The version of the newly created pipeline.
" }, "status":{ "shape":"ResourceStatus", "documentation":"The current lifecycle status of the pipeline.
" } }, "documentation":"Response structure for CreatePipeline operation.
" }, "CreatePortalRequest":{ "type":"structure", "required":[ "portalName", "portalContactEmail", "roleArn" ], "members":{ "portalName":{ "shape":"Name", "documentation":"A friendly name for the portal.
" }, "portalDescription":{ "shape":"Description", "documentation":"A description for the portal.
" }, "portalContactEmail":{ "shape":"Email", "documentation":"The Amazon Web Services administrator's contact email address.
" }, "clientToken":{ "shape":"ClientToken", "documentation":"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.
", "idempotencyToken":true }, "portalLogoImageFile":{ "shape":"ImageFile", "documentation":"A logo image to display in the portal. Upload a square, high-resolution image. The image is displayed on a dark background.
" }, "roleArn":{ "shape":"IamArn", "documentation":"The ARN of a service role that allows the portal's users to access your IoT SiteWise resources on your behalf. For more information, see Using service roles for IoT SiteWise Monitor in the IoT SiteWise User Guide.
" }, "tags":{ "shape":"TagMap", "documentation":"A list of key-value pairs that contain metadata for the portal. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.
" }, "portalAuthMode":{ "shape":"AuthMode", "documentation":"The service to use to authenticate users to the portal. Choose from the following options:
SSO – The portal uses IAM Identity Center to authenticate users and manage user permissions. Before you can create a portal that uses IAM Identity Center, you must enable IAM Identity Center. For more information, see Enabling IAM Identity Center in the IoT SiteWise User Guide. This option is only available in Amazon Web Services Regions other than the China Regions.
IAM – The portal uses Identity and Access Management to authenticate users and manage user permissions.
You can't change this value after you create a portal.
Default: SSO
The email address that sends alarm notifications.
If you use the IoT Events managed Lambda function to manage your emails, you must verify the sender email address in Amazon SES.
Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range. For more information, see Monitoring with alarms in the IoT SiteWise Application Guide.
" }, "portalType":{ "shape":"PortalType", "documentation":"Define the type of portal. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.
The configuration entry associated with the specific portal type. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.
The ID of the created portal.
" }, "portalArn":{ "shape":"ARN", "documentation":"The ARN of the portal, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}
The URL for the IoT SiteWise Monitor portal. You can use this URL to access portals that use IAM Identity Center for authentication. For portals that use IAM for authentication, you must use the IoT SiteWise console to get a URL that you can use to access the portal.
" }, "portalStatus":{ "shape":"PortalStatus", "documentation":"The status of the portal, which contains a state (CREATING after successfully calling this operation) and any error message.
The associated IAM Identity Center application ID, if the portal uses IAM Identity Center.
" } } }, "CreateProjectRequest":{ "type":"structure", "required":[ "portalId", "projectName" ], "members":{ "portalId":{ "shape":"ID", "documentation":"The ID of the portal in which to create the project.
" }, "projectName":{ "shape":"Name", "documentation":"A friendly name for the project.
" }, "projectDescription":{ "shape":"Description", "documentation":"A description for the project.
" }, "clientToken":{ "shape":"ClientToken", "documentation":"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.
", "idempotencyToken":true }, "tags":{ "shape":"TagMap", "documentation":"A list of key-value pairs that contain metadata for the project. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.
" } } }, "CreateProjectResponse":{ "type":"structure", "required":[ "projectId", "projectArn" ], "members":{ "projectId":{ "shape":"ID", "documentation":"The ID of the project.
" }, "projectArn":{ "shape":"ARN", "documentation":"The ARN of the project, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId}
The name of the workspace.
", "location":"uri", "locationName":"workspaceName" }, "taskName":{ "shape":"ResourceName", "documentation":"The name of the task to create. Must be unique within the workspace.
" }, "description":{ "shape":"Description", "documentation":"A description of the task.
" }, "taskConfiguration":{ "shape":"TaskConfiguration", "documentation":"The task execution configuration. Specify a containerTaskConfiguration for custom container workloads.
" }, "tags":{ "shape":"TagMap", "documentation":"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.
" }, "clientToken":{ "shape":"ClientToken", "documentation":"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.
", "idempotencyToken":true } }, "documentation":"Request structure for CreateTask operation.
" }, "CreateTaskResponse":{ "type":"structure", "required":[ "taskName", "taskArn", "version", "status" ], "members":{ "taskName":{ "shape":"ResourceName", "documentation":"The name of the created task.
" }, "taskArn":{ "shape":"ARN", "documentation":"The ARN of the created task.
" }, "version":{ "shape":"Version", "documentation":"The version of the newly created task.
" }, "status":{ "shape":"ResourceStatus", "documentation":"The current lifecycle status of the task.
" } }, "documentation":"Response structure for CreateTask operation.
" }, "CreateWorkspaceRequest":{ "type":"structure", "required":[ "workspaceName", "encryptionConfiguration" ], "members":{ "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace to create.
" }, "workspaceDescription":{ "shape":"Description", "documentation":"A description for the workspace.
" }, "encryptionConfiguration":{ "shape":"WorkspaceEncryptionConfiguration", "documentation":"The encryption configuration for the workspace.
" }, "tags":{ "shape":"TagMap", "documentation":"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.
" }, "clientToken":{ "shape":"ClientToken", "documentation":"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.
", "idempotencyToken":true } } }, "CreateWorkspaceResponse":{ "type":"structure", "required":[ "workspaceName", "workspaceArn", "workspaceStatus" ], "members":{ "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace.
" }, "workspaceArn":{ "shape":"ARN", "documentation":"The ARN of the workspace.
" }, "workspaceStatus":{ "shape":"WorkspaceStatus", "documentation":"The status of the workspace, which is CREATING when the operation returns.
The column names specified in the .csv file.
" } }, "documentation":"A .CSV file.
" }, "CustomID":{ "type":"string", "max":139, "min":13, "pattern":"^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9_]+" }, "CustomerManagedS3Storage":{ "type":"structure", "required":[ "s3ResourceArn", "roleArn" ], "members":{ "s3ResourceArn":{ "shape":"ARN", "documentation":"The ARN of the Amazon S3 object. For more information about how to find the ARN for an Amazon S3 object, see Amazon S3 resources in the Amazon Simple Storage Service User Guide.
" }, "roleArn":{ "shape":"ARN", "documentation":"The ARN of the Identity and Access Management role that allows IoT SiteWise to send data to Amazon S3.
" } }, "documentation":"Contains information about a customer managed Amazon S3 bucket.
" }, "DashboardDefinition":{ "type":"string", "max":204800, "min":0, "pattern":".+" }, "DashboardSummaries":{ "type":"list", "member":{"shape":"DashboardSummary"} }, "DashboardSummary":{ "type":"structure", "required":[ "id", "name" ], "members":{ "id":{ "shape":"ID", "documentation":"The ID of the dashboard.
" }, "name":{ "shape":"Name", "documentation":"The name of the dashboard
" }, "description":{ "shape":"Description", "documentation":"The dashboard's description.
" }, "creationDate":{ "shape":"Timestamp", "documentation":"The date the dashboard was created, in Unix epoch time.
" }, "lastUpdateDate":{ "shape":"Timestamp", "documentation":"The date the dashboard was last updated, in Unix epoch time.
" } }, "documentation":"Contains a dashboard summary.
" }, "DataBindingValue":{ "type":"structure", "members":{ "assetModelProperty":{"shape":"AssetModelPropertyBindingValue"}, "assetProperty":{ "shape":"AssetPropertyBindingValue", "documentation":"The asset property value used in the data binding.
" } }, "documentation":"Represents a value used in a data binding. It can be an asset property or an asset model property.
" }, "DataBindingValueFilter":{ "type":"structure", "members":{ "asset":{ "shape":"AssetBindingValueFilter", "documentation":"Filter criteria for matching data bindings based on a specific asset. Used to list all data bindings referencing a particular asset or its properties.
" }, "assetModel":{ "shape":"AssetModelBindingValueFilter", "documentation":"Filter criteria for matching data bindings based on a specific asset model. Used to list all data bindings referencing a particular asset model or its properties.
" }, "assetProperty":{ "shape":"AssetPropertyBindingValueFilter", "documentation":"Filter criteria for matching data bindings based on a specific asset property. Used to list all data bindings referencing a particular property of an asset.
" }, "assetModelProperty":{ "shape":"AssetModelPropertyBindingValueFilter", "documentation":"Filter criteria for matching data bindings based on a specific asset model property. Used to list all data bindings referencing a particular property of an asset model.
" } }, "documentation":"A filter used to match specific data binding values based on criteria. This filter allows searching for data bindings by asset, asset model, asset property, or asset model property.
" }, "DataSegmentEnrichment":{ "type":"structure", "required":["status"], "members":{ "status":{ "shape":"EnrichmentStatus", "documentation":"The enrichment status of the data segment.
" }, "lastEnrichedAt":{ "shape":"Timestamp", "documentation":"The date the data segment was last enriched, in Unix epoch time.
" } }, "documentation":"Contains enrichment status information for a data segment.
" }, "DataSegmentErrorCode":{ "type":"string", "enum":[ "INTERNAL_FAILURE", "VALIDATION_ERROR", "RESOURCE_NOT_FOUND", "LIMIT_EXCEEDED", "CONFLICTING_OPERATION" ] }, "DataSegmentErrorMessage":{ "type":"string", "max":2048, "min":1 }, "DataSegmentRelationshipSummaries":{ "type":"list", "member":{"shape":"DataSegmentRelationshipSummary"} }, "DataSegmentRelationshipSummary":{ "type":"structure", "required":[ "targetDatasetId", "sourceDatasetId", "timeSeriesId", "startTimestamp", "endTimestamp" ], "members":{ "targetDatasetId":{ "shape":"ID", "documentation":"The ID of the curated dataset that references the data segment.
" }, "sourceDatasetId":{ "shape":"ID", "documentation":"The ID of the source session dataset that contains the data segment.
" }, "timeSeriesId":{ "shape":"TimeSeriesId", "documentation":"The ID of the time series.
" }, "startTimestamp":{ "shape":"TimeInNanos", "documentation":"The nanosecond-precision start time of the data segment.
" }, "endTimestamp":{ "shape":"TimeInNanos", "documentation":"The nanosecond-precision end time of the data segment.
" } }, "documentation":"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.
" }, "DataSegmentSummaries":{ "type":"list", "member":{"shape":"DataSegmentSummary"} }, "DataSegmentSummary":{ "type":"structure", "required":[ "sourceDatasetId", "timeSeriesId", "startTimestamp", "endTimestamp", "alias", "dataType" ], "members":{ "sourceDatasetId":{ "shape":"ID", "documentation":"The ID of the source dataset that contains the data segment.
" }, "timeSeriesId":{ "shape":"TimeSeriesId", "documentation":"The ID of the time series.
" }, "startTimestamp":{ "shape":"TimeInNanos", "documentation":"The nanosecond-precision start time of the data segment.
" }, "endTimestamp":{ "shape":"TimeInNanos", "documentation":"The nanosecond-precision end time of the data segment.
" }, "alias":{ "shape":"PropertyAlias", "documentation":"The alias of the time series.
" }, "dataType":{ "shape":"PropertyDataType", "documentation":"The data type of the time series.
" }, "enrichment":{ "shape":"DataSegmentEnrichment", "documentation":"The enrichment information for the data segment.
" } }, "documentation":"Contains summary information about a data segment, including its source dataset, time series, timestamp range, and enrichment status.
" }, "DataSetIdList":{ "type":"list", "member":{"shape":"DatasetId"}, "documentation":"A list of dataset identifiers to restrict a search to.
", "max":100, "min":1 }, "DataSetReference":{ "type":"structure", "members":{ "datasetArn":{ "shape":"String", "documentation":"The ARN of the dataset. The format is arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId}.
The data source for the dataset.
" } }, "documentation":"Contains information about the dataset use and it's source.
" }, "DatasetConfig":{ "type":"structure", "members":{ "session":{ "shape":"SessionConfig", "documentation":"The session configuration for a session-type dataset.
" } }, "documentation":"Contains the configuration for a dataset.
" }, "DatasetEnrichment":{ "type":"structure", "members":{ "video":{ "shape":"DatasetEnrichmentEntry", "documentation":"The enrichment status for video data in the dataset.
" } }, "documentation":"Contains the enrichment status information for a dataset across data types.
" }, "DatasetEnrichmentEntry":{ "type":"structure", "required":["status"], "members":{ "status":{ "shape":"DatasetEnrichmentStatus", "documentation":"The enrichment status of the data type in the dataset.
" }, "lastEnrichedAt":{ "shape":"Timestamp", "documentation":"The date the data was last enriched, in Unix epoch time.
" } }, "documentation":"Contains enrichment status information for a specific data type in a dataset.
" }, "DatasetEnrichmentStatus":{ "type":"string", "enum":[ "FULLY_ENRICHED", "PARTIALLY_ENRICHED", "NOT_ENRICHED" ] }, "DatasetExportJobFilter":{ "type":"string", "documentation":"<p>Filter for ListDatasetExportJobs. ALL returns jobs in any status; otherwise returns jobs in the specified status.</p>", "enum":[ "ALL", "SUBMITTED", "RUNNING", "COMPLETED", "COMPLETED_WITH_ERRORS", "FAILED" ] }, "DatasetExportJobId":{ "type":"string", "documentation":"<p>The unique identifier for a dataset export job.</p>", "max":36, "min":36, "pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" }, "DatasetExportJobStatus":{ "type":"string", "documentation":"<p>The status of a dataset export job.</p>", "enum":[ "SUBMITTED", "RUNNING", "COMPLETED", "COMPLETED_WITH_ERRORS", "FAILED" ] }, "DatasetId":{ "type":"string", "documentation":"Unique identifier for a dataset (UUID format)", "max":36, "min":36, "pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "DatasetItem":{ "type":"structure", "required":["datasetId"], "members":{ "datasetId":{ "shape":"DatasetId", "documentation":"<p>The unique identifier for the dataset.</p>" }, "trimSettings":{ "shape":"TrimSettings", "documentation":"<p>The trim settings applied to all items in the dataset. When omitted, the full dataset time range is used.</p>" }, "exportDataTypes":{ "shape":"ExportDataTypeList", "documentation":"<p>The optional subset of data types to export. If omitted, all data types are exported.</p>" } }, "documentation":"<p>A dataset to process.</p>" }, "DatasetSource":{ "type":"structure", "required":[ "sourceType", "sourceFormat" ], "members":{ "sourceType":{ "shape":"DatasetSourceType", "documentation":"The type of data source for the dataset.
" }, "sourceFormat":{ "shape":"DatasetSourceFormat", "documentation":"The format of the dataset source associated with the dataset.
" }, "sourceDetail":{ "shape":"SourceDetail", "documentation":"The details of the dataset source associated with the dataset.
" } }, "documentation":"The data source for the dataset.
" }, "DatasetSourceFormat":{ "type":"string", "enum":[ "KNOWLEDGE_BASE", "TIMESERIES" ] }, "DatasetSourceType":{ "type":"string", "enum":[ "KENDRA", "SITEWISE" ] }, "DatasetState":{ "type":"string", "enum":[ "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED" ] }, "DatasetStatus":{ "type":"structure", "required":["state"], "members":{ "state":{ "shape":"DatasetState", "documentation":"The current status of the dataset.
" }, "error":{"shape":"ErrorDetails"} }, "documentation":"The status of the dataset. This contains the state and any error messages. The state is ACTIVE when ready to use.
The ID of the dataset.
" }, "arn":{ "shape":"ARN", "documentation":"The ARN of the dataset. The format is arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId}.
The name of the dataset.
" }, "description":{ "shape":"Description", "documentation":"A description about the dataset, and its functionality.
" }, "sourceType":{ "shape":"DatasetSourceType", "documentation":"The data source type of the dataset.
" }, "datasetType":{ "shape":"DatasetTypeEnum", "documentation":"The type of dataset: a session dataset, a curated dataset, or a connection to an external datasource.
" }, "creationDate":{ "shape":"Timestamp", "documentation":"The dataset creation date, in Unix epoch time.
" }, "lastUpdateDate":{ "shape":"Timestamp", "documentation":"The date the dataset was last updated, in Unix epoch time.
" }, "status":{ "shape":"DatasetStatus", "documentation":"The status of the dataset. This contains the state and any error messages. The state is ACTIVE when ready to use.
The enrichment status of the dataset.
" } }, "documentation":"The summary details for the dataset.
" }, "DatasetTypeEnum":{ "type":"string", "enum":[ "SESSION", "CURATED", "EXTERNAL" ] }, "Datum":{ "type":"structure", "members":{ "scalarValue":{ "shape":"ScalarValue", "documentation":"Indicates if the data point is a scalar value such as integer, string, double, or Boolean.
" }, "arrayValue":{ "shape":"DatumList", "documentation":"Indicates if the data point is an array.
" }, "rowValue":{ "shape":"Row", "documentation":"Indicates if the data point is a row.
" }, "nullValue":{ "shape":"NullableBoolean", "documentation":"Indicates if the data point is null.
" } }, "documentation":"Represents a single data point in a query result.
" }, "DatumList":{ "type":"list", "member":{"shape":"Datum"} }, "DefaultValue":{ "type":"string", "pattern":"[^\\u0000-\\u001F\\u007F]+" }, "DeleteAccessPolicyRequest":{ "type":"structure", "required":["accessPolicyId"], "members":{ "accessPolicyId":{ "shape":"ID", "documentation":"The ID of the access policy to be deleted.
", "location":"uri", "locationName":"accessPolicyId" }, "clientToken":{ "shape":"ClientToken", "documentation":"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.
", "idempotencyToken":true, "location":"querystring", "locationName":"clientToken" } } }, "DeleteAccessPolicyResponse":{ "type":"structure", "members":{} }, "DeleteApplicationRequest":{ "type":"structure", "required":[ "workspaceName", "id" ], "members":{ "workspaceName":{ "shape":"WorkspaceName", "documentation":"Name of the workspace to associate with the underlying Application
", "location":"uri", "locationName":"workspaceName" }, "id":{ "shape":"ApplicationId", "documentation":"ID of the Application to delete
", "location":"uri", "locationName":"id" } } }, "DeleteApplicationResponse":{ "type":"structure", "members":{} }, "DeleteAssetModelCompositeModelRequest":{ "type":"structure", "required":[ "assetModelId", "assetModelCompositeModelId" ], "members":{ "assetModelId":{ "shape":"CustomID", "documentation":"The ID of the asset model, in UUID format.
", "location":"uri", "locationName":"assetModelId" }, "assetModelCompositeModelId":{ "shape":"CustomID", "documentation":"The ID of a composite model on this asset model.
", "location":"uri", "locationName":"assetModelCompositeModelId" }, "clientToken":{ "shape":"ClientToken", "documentation":"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.
", "idempotencyToken":true, "location":"querystring", "locationName":"clientToken" }, "ifMatch":{ "shape":"ETag", "documentation":"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.
Accepts * to reject the delete request if an active version (specified using matchForVersionType as ACTIVE) already exists for the asset model.
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.
The ID of the asset model.
" } } }, "DeleteAssetModelInterfaceRelationshipRequest":{ "type":"structure", "required":[ "assetModelId", "interfaceAssetModelId" ], "members":{ "assetModelId":{ "shape":"CustomID", "documentation":"The ID of the asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID.
", "location":"uri", "locationName":"assetModelId" }, "interfaceAssetModelId":{ "shape":"CustomID", "documentation":"The ID of the interface asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID.
", "location":"uri", "locationName":"interfaceAssetModelId" }, "clientToken":{ "shape":"ClientToken", "documentation":"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.
", "idempotencyToken":true, "location":"querystring", "locationName":"clientToken" } } }, "DeleteAssetModelInterfaceRelationshipResponse":{ "type":"structure", "required":[ "assetModelId", "interfaceAssetModelId", "assetModelArn", "assetModelStatus" ], "members":{ "assetModelId":{ "shape":"ID", "documentation":"The ID of the asset model.
" }, "interfaceAssetModelId":{ "shape":"ID", "documentation":"The ID of the interface asset model.
" }, "assetModelArn":{ "shape":"ARN", "documentation":"The ARN of the asset model, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}
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.
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.
", "idempotencyToken":true, "location":"querystring", "locationName":"clientToken" }, "ifMatch":{ "shape":"ETag", "documentation":"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.
Accepts * to reject the delete request if an active version (specified using matchForVersionType as ACTIVE) already exists for the asset model.
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.
The ID of the asset model.
" }, "assetModelStatus":{ "shape":"AssetModelStatus", "documentation":"The status of the asset model, which contains a state (DELETING after successfully calling this operation) and any error message.
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.
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.
", "idempotencyToken":true, "location":"querystring", "locationName":"clientToken" } } }, "DeleteAssetResponse":{ "type":"structure", "required":["assetStatus"], "members":{ "assetId":{ "shape":"ID", "documentation":"The ID of the asset.
" }, "assetStatus":{ "shape":"AssetStatus", "documentation":"The status of the asset, which contains a state (DELETING after successfully calling this operation) and any error message.
The ID of the computation model.
", "location":"uri", "locationName":"computationModelId" }, "clientToken":{ "shape":"ClientToken", "documentation":"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.
", "idempotencyToken":true, "location":"querystring", "locationName":"clientToken" } } }, "DeleteComputationModelResponse":{ "type":"structure", "required":["computationModelStatus"], "members":{ "computationModelStatus":{ "shape":"ComputationModelStatus", "documentation":"The status of the computation model. It contains a state (DELETING after successfully calling this operation) and any error messages.
" } } }, "DeleteDashboardRequest":{ "type":"structure", "required":["dashboardId"], "members":{ "dashboardId":{ "shape":"ID", "documentation":"The ID of the dashboard to delete.
", "location":"uri", "locationName":"dashboardId" }, "clientToken":{ "shape":"ClientToken", "documentation":"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.
", "idempotencyToken":true, "location":"querystring", "locationName":"clientToken" } } }, "DeleteDashboardResponse":{ "type":"structure", "members":{} }, "DeleteDataSegmentEntries":{ "type":"list", "member":{"shape":"DeleteDataSegmentEntry"}, "max":10, "min":1 }, "DeleteDataSegmentEntry":{ "type":"structure", "required":[ "timeSeriesId", "startTimestamp", "endTimestamp" ], "members":{ "timeSeriesId":{ "shape":"ID", "documentation":"The ID of the time series.
" }, "startTimestamp":{ "shape":"TimeInNanos", "documentation":"The nanosecond-precision start time of the data segment to delete.
" }, "endTimestamp":{ "shape":"TimeInNanos", "documentation":"The nanosecond-precision end time of the data segment to delete.
" } }, "documentation":"Contains information about a data segment entry to delete.
" }, "DeleteDatasetRequest":{ "type":"structure", "required":["datasetId"], "members":{ "datasetId":{ "shape":"ID", "documentation":"The ID of the dataset.
", "location":"uri", "locationName":"datasetId" }, "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace that contains the dataset.
", "location":"querystring", "locationName":"workspaceName" }, "clientToken":{ "shape":"ClientToken", "documentation":"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.
", "idempotencyToken":true, "location":"querystring", "locationName":"clientToken" } } }, "DeleteDatasetResponse":{ "type":"structure", "required":["datasetStatus"], "members":{ "datasetStatus":{ "shape":"DatasetStatus", "documentation":"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.
The ID of the gateway to delete.
", "location":"uri", "locationName":"gatewayId" } } }, "DeletePipelineRequest":{ "type":"structure", "required":[ "workspaceName", "pipelineName" ], "members":{ "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace.
", "location":"uri", "locationName":"workspaceName" }, "pipelineName":{ "shape":"ResourceName", "documentation":"The name of the pipeline to delete.
", "location":"uri", "locationName":"pipelineName" } }, "documentation":"Request structure for DeletePipeline operation.
" }, "DeletePipelineResponse":{ "type":"structure", "required":["status"], "members":{ "status":{ "shape":"ResourceStatus", "documentation":"The current lifecycle status of the pipeline.
" } }, "documentation":"Response structure for DeletePipeline operation.
" }, "DeletePortalRequest":{ "type":"structure", "required":["portalId"], "members":{ "portalId":{ "shape":"ID", "documentation":"The ID of the portal to delete.
", "location":"uri", "locationName":"portalId" }, "clientToken":{ "shape":"ClientToken", "documentation":"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.
", "idempotencyToken":true, "location":"querystring", "locationName":"clientToken" } } }, "DeletePortalResponse":{ "type":"structure", "required":["portalStatus"], "members":{ "portalStatus":{ "shape":"PortalStatus", "documentation":"The status of the portal, which contains a state (DELETING after successfully calling this operation) and any error message.
The ID of the project.
", "location":"uri", "locationName":"projectId" }, "clientToken":{ "shape":"ClientToken", "documentation":"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.
", "idempotencyToken":true, "location":"querystring", "locationName":"clientToken" } } }, "DeleteProjectResponse":{ "type":"structure", "members":{} }, "DeleteTaskRequest":{ "type":"structure", "required":[ "workspaceName", "taskName" ], "members":{ "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace.
", "location":"uri", "locationName":"workspaceName" }, "taskName":{ "shape":"ResourceName", "documentation":"The name of the task to delete.
", "location":"uri", "locationName":"taskName" } }, "documentation":"Request structure for DeleteTask operation.
" }, "DeleteTaskResponse":{ "type":"structure", "required":["status"], "members":{ "status":{ "shape":"ResourceStatus", "documentation":"The current lifecycle status of the task.
" } }, "documentation":"Response structure for DeleteTask operation.
" }, "DeleteTimeSeriesRequest":{ "type":"structure", "members":{ "alias":{ "shape":"PropertyAlias", "documentation":"The alias that identifies the time series.
", "location":"querystring", "locationName":"alias" }, "assetId":{ "shape":"CustomID", "documentation":"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.
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.
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.
", "idempotencyToken":true }, "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace.
", "location":"querystring", "locationName":"workspaceName" } } }, "DeleteWorkspaceRequest":{ "type":"structure", "required":["workspaceName"], "members":{ "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace to delete.
", "location":"uri", "locationName":"workspaceName" }, "clientToken":{ "shape":"ClientToken", "documentation":"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.
", "idempotencyToken":true, "location":"querystring", "locationName":"clientToken" } } }, "DeleteWorkspaceResponse":{ "type":"structure", "required":["workspaceStatus"], "members":{ "workspaceStatus":{ "shape":"WorkspaceStatus", "documentation":"The status of the workspace after the deletion request, which is DELETING when the operation returns.
The ID of the access policy.
", "location":"uri", "locationName":"accessPolicyId" } } }, "DescribeAccessPolicyResponse":{ "type":"structure", "required":[ "accessPolicyId", "accessPolicyArn", "accessPolicyIdentity", "accessPolicyResource", "accessPolicyPermission", "accessPolicyCreationDate", "accessPolicyLastUpdateDate" ], "members":{ "accessPolicyId":{ "shape":"ID", "documentation":"The ID of the access policy.
" }, "accessPolicyArn":{ "shape":"ARN", "documentation":"The ARN of the access policy, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId}
The identity (IAM Identity Center user, IAM Identity Center group, or IAM user) to which this access policy applies.
" }, "accessPolicyResource":{ "shape":"Resource", "documentation":"The IoT SiteWise Monitor resource (portal or project) to which this access policy provides access.
" }, "accessPolicyPermission":{ "shape":"Permission", "documentation":"The access policy permission. Note that a project ADMINISTRATOR is also known as a project owner.
The date the access policy was created, in Unix epoch time.
" }, "accessPolicyLastUpdateDate":{ "shape":"Timestamp", "documentation":"The date the access policy was last updated, in Unix epoch time.
" } } }, "DescribeActionRequest":{ "type":"structure", "required":["actionId"], "members":{ "actionId":{ "shape":"ID", "documentation":"The ID of the action.
", "location":"uri", "locationName":"actionId" } } }, "DescribeActionResponse":{ "type":"structure", "required":[ "actionId", "targetResource", "actionDefinitionId", "actionPayload", "executionTime" ], "members":{ "actionId":{ "shape":"ID", "documentation":"The ID of the action.
" }, "targetResource":{ "shape":"TargetResource", "documentation":"The resource the action will be taken on.
" }, "actionDefinitionId":{ "shape":"ID", "documentation":"The ID of the action definition.
" }, "actionPayload":{ "shape":"ActionPayload", "documentation":"The JSON payload of the action.
" }, "executionTime":{ "shape":"Timestamp", "documentation":"The time the action was executed.
" }, "resolveTo":{ "shape":"ResolveTo", "documentation":"The detailed resource this action resolves to.
" } } }, "DescribeApplicationRequest":{ "type":"structure", "required":[ "workspaceName", "id" ], "members":{ "workspaceName":{ "shape":"WorkspaceName", "documentation":"Name of the workspace to associate with the underlying Application
", "location":"uri", "locationName":"workspaceName" }, "id":{ "shape":"ApplicationId", "documentation":"ID of the Application
", "location":"uri", "locationName":"id" } } }, "DescribeApplicationResponse":{ "type":"structure", "required":[ "arn", "createdAt", "dnsSubdomain", "id", "idcApplicationArn", "name", "status", "updatedAt", "workspaceName" ], "members":{ "arn":{ "shape":"ARN", "documentation":"ARN of the application
" }, "createdAt":{ "shape":"Timestamp", "documentation":"Timestamp when the application was created
" }, "dnsSubdomain":{ "shape":"DnsSubdomain", "documentation":"DNS subdomain for the application
" }, "description":{ "shape":"ApplicationDescription", "documentation":"Description of the application
" }, "id":{ "shape":"ApplicationId", "documentation":"Unique identifier of the application
" }, "idcApplicationArn":{ "shape":"ARN", "documentation":"Identity Center Application ARN associated with this application
" }, "name":{ "shape":"ApplicationName", "documentation":"Name of the application
" }, "status":{ "shape":"ApplicationStatus", "documentation":"Current status of the application
" }, "updatedAt":{ "shape":"Timestamp", "documentation":"Timestamp when the application was last updated
" }, "workspaceName":{ "shape":"WorkspaceName", "documentation":"Name of the workspace this application belongs to
" } } }, "DescribeAssetCompositeModelRequest":{ "type":"structure", "required":[ "assetId", "assetCompositeModelId" ], "members":{ "assetId":{ "shape":"CustomID", "documentation":"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.
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.
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":{ "shape":"ID", "documentation":"The ID of a composite model on this asset.
" }, "assetCompositeModelExternalId":{ "shape":"ExternalId", "documentation":"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.
The path to the composite model listing the parent composite models.
" }, "assetCompositeModelName":{ "shape":"Name", "documentation":"The unique, friendly name for the composite model.
" }, "assetCompositeModelDescription":{ "shape":"Description", "documentation":"A description for the composite model.
" }, "assetCompositeModelType":{ "shape":"Name", "documentation":"The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.
The property definitions of the composite model that was used to create the asset.
" }, "assetCompositeModelSummaries":{ "shape":"AssetCompositeModelSummaries", "documentation":"The list of composite model summaries.
" }, "actionDefinitions":{ "shape":"ActionDefinitions", "documentation":"The available actions for a composite model on this asset.
" } } }, "DescribeAssetModelCompositeModelRequest":{ "type":"structure", "required":[ "assetModelId", "assetModelCompositeModelId" ], "members":{ "assetModelId":{ "shape":"CustomID", "documentation":"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.
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.
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.
The ID of the asset model, in UUID format.
" }, "assetModelCompositeModelId":{ "shape":"ID", "documentation":"The ID of a composite model on this asset model.
" }, "assetModelCompositeModelExternalId":{ "shape":"ExternalId", "documentation":"The external ID of a composite model on this asset model.
" }, "assetModelCompositeModelPath":{ "shape":"AssetModelCompositeModelPath", "documentation":"The path to the composite model listing the parent composite models.
" }, "assetModelCompositeModelName":{ "shape":"Name", "documentation":"The unique, friendly name for the composite model.
" }, "assetModelCompositeModelDescription":{ "shape":"Description", "documentation":"The description for the composite model.
" }, "assetModelCompositeModelType":{ "shape":"Name", "documentation":"The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.
The property definitions of the composite model.
" }, "compositionDetails":{ "shape":"CompositionDetails", "documentation":"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.
The list of composite model summaries for the composite model.
" }, "actionDefinitions":{ "shape":"ActionDefinitions", "documentation":"The available actions for a composite model on this asset model.
" } } }, "DescribeAssetModelInterfaceRelationshipRequest":{ "type":"structure", "required":[ "assetModelId", "interfaceAssetModelId" ], "members":{ "assetModelId":{ "shape":"CustomID", "documentation":"The ID of the asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID.
", "location":"uri", "locationName":"assetModelId" }, "interfaceAssetModelId":{ "shape":"CustomID", "documentation":"The ID of the interface asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID.
", "location":"uri", "locationName":"interfaceAssetModelId" } } }, "DescribeAssetModelInterfaceRelationshipResponse":{ "type":"structure", "required":[ "assetModelId", "interfaceAssetModelId", "propertyMappings", "hierarchyMappings" ], "members":{ "assetModelId":{ "shape":"ID", "documentation":"The ID of the asset model.
" }, "interfaceAssetModelId":{ "shape":"ID", "documentation":"The ID of the interface asset model.
" }, "propertyMappings":{ "shape":"PropertyMappings", "documentation":"A list of property mappings between the interface asset model and the asset model where the interface is applied.
" }, "hierarchyMappings":{ "shape":"HierarchyMappings", "documentation":"A list of hierarchy mappings between the interface asset model and the asset model where the interface is applied.
" } } }, "DescribeAssetModelRequest":{ "type":"structure", "required":["assetModelId"], "members":{ "assetModelId":{ "shape":"CustomID", "documentation":"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.
Whether or not to exclude asset model properties from the response.
", "location":"querystring", "locationName":"excludeProperties" }, "assetModelVersion":{ "shape":"AssetModelVersionFilter", "documentation":"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.
The ID of the asset model, in UUID format.
" }, "assetModelExternalId":{ "shape":"ExternalId", "documentation":"The external ID of the asset model, if any.
" }, "assetModelArn":{ "shape":"ARN", "documentation":"The ARN of the asset model, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}
The name of the asset model.
" }, "assetModelType":{ "shape":"AssetModelType", "documentation":"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.
The asset model's description.
" }, "assetModelProperties":{ "shape":"AssetModelProperties", "documentation":"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.
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.
The list of built-in composite models for the asset model, such as those with those of type AWS/ALARMS.
The list of the immediate child custom composite model summaries for the asset model.
" }, "assetModelCreationDate":{ "shape":"Timestamp", "documentation":"The date the asset model was created, in Unix epoch time.
" }, "assetModelLastUpdateDate":{ "shape":"Timestamp", "documentation":"The date the asset model was last updated, in Unix epoch time.
" }, "assetModelStatus":{ "shape":"AssetModelStatus", "documentation":"The current status of the asset model, which contains a state and any error message.
" }, "assetModelVersion":{ "shape":"Version", "documentation":"The version of the asset model. See Asset model versions in the IoT SiteWise User Guide.
" }, "interfaceDetails":{ "shape":"InterfaceDetails", "documentation":"A list of interface details that describe the interfaces implemented by this asset model, including interface asset model IDs and property mappings.
" }, "eTag":{ "shape":"ETag", "documentation":"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.
", "location":"header", "locationName":"ETag" } } }, "DescribeAssetPropertyRequest":{ "type":"structure", "required":[ "assetId", "propertyId" ], "members":{ "assetId":{ "shape":"CustomID", "documentation":"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.
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.
The ID of the asset, in UUID format.
" }, "assetExternalId":{ "shape":"ExternalId", "documentation":"The external ID of the asset. For more information, see Using external IDs in the IoT SiteWise User Guide.
" }, "assetName":{ "shape":"Name", "documentation":"The name of the asset.
" }, "assetModelId":{ "shape":"ID", "documentation":"The ID of the asset model, in UUID format.
" }, "assetProperty":{ "shape":"Property", "documentation":"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.
The composite model that declares this asset property, if this asset property exists in a composite model.
" } } }, "DescribeAssetRequest":{ "type":"structure", "required":["assetId"], "members":{ "assetId":{ "shape":"CustomID", "documentation":"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.
Whether or not to exclude asset properties from the response.
", "location":"querystring", "locationName":"excludeProperties" } } }, "DescribeAssetResponse":{ "type":"structure", "required":[ "assetId", "assetArn", "assetName", "assetModelId", "assetProperties", "assetHierarchies", "assetCreationDate", "assetLastUpdateDate", "assetStatus" ], "members":{ "assetId":{ "shape":"ID", "documentation":"The ID of the asset, in UUID format.
" }, "assetExternalId":{ "shape":"ExternalId", "documentation":"The external ID of the asset, if any.
" }, "assetArn":{ "shape":"ARN", "documentation":"The ARN of the asset, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}
The name of the asset.
" }, "assetModelId":{ "shape":"ID", "documentation":"The ID of the asset model that was used to create the asset.
" }, "assetProperties":{ "shape":"AssetProperties", "documentation":"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.
A list of asset hierarchies that each contain a hierarchyId. A hierarchy specifies allowed parent/child asset relationships.
The composite models for the asset.
" }, "assetCreationDate":{ "shape":"Timestamp", "documentation":"The date the asset was created, in Unix epoch time.
" }, "assetLastUpdateDate":{ "shape":"Timestamp", "documentation":"The date the asset was last updated, in Unix epoch time.
" }, "assetStatus":{ "shape":"AssetStatus", "documentation":"The current status of the asset, which contains a state and any error message.
" }, "assetDescription":{ "shape":"Description", "documentation":"A description for the asset.
" }, "assetCompositeModelSummaries":{ "shape":"AssetCompositeModelSummaries", "documentation":"The list of the immediate child custom composite model summaries for the asset.
" } } }, "DescribeBulkImportJobRequest":{ "type":"structure", "required":["jobId"], "members":{ "jobId":{ "shape":"ID", "documentation":"The ID of the job.
", "location":"uri", "locationName":"jobId" }, "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace.
", "location":"querystring", "locationName":"workspaceName" } } }, "DescribeBulkImportJobResponse":{ "type":"structure", "required":[ "jobId", "jobName", "jobStatus", "jobRoleArn", "files", "errorReportLocation", "jobCreationDate", "jobLastUpdateDate" ], "members":{ "jobId":{ "shape":"ID", "documentation":"The ID of the job.
" }, "jobName":{ "shape":"Name", "documentation":"The unique name that helps identify the job request.
" }, "jobStatus":{ "shape":"JobStatus", "documentation":"The status of the bulk import job can be one of following values:
PENDING – IoT SiteWise is waiting for the current bulk import job to finish.
CANCELLED – The bulk import job has been canceled.
RUNNING – IoT SiteWise is processing your request to import your data from Amazon S3.
COMPLETED – IoT SiteWise successfully completed your request to import data from Amazon S3.
FAILED – IoT SiteWise couldn't process your request to import data from Amazon S3. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.
COMPLETED_WITH_FAILURES – IoT SiteWise completed your request to import data from Amazon S3 with errors. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.
The ARN of the IAM role that allows IoT SiteWise to read Amazon S3 data.
" }, "files":{ "shape":"Files", "documentation":"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.
The Amazon S3 destination where errors associated with the job creation request are saved.
" }, "jobConfiguration":{ "shape":"JobConfiguration", "documentation":"Contains the configuration information of a job, such as the file format used to save data in Amazon S3.
" }, "jobCreationDate":{ "shape":"Timestamp", "documentation":"The date the job was created, in Unix epoch TIME.
" }, "jobLastUpdateDate":{ "shape":"Timestamp", "documentation":"The date the job was last updated, in Unix epoch time.
" }, "adaptiveIngestion":{ "shape":"AdaptiveIngestion", "documentation":"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":{ "shape":"DeleteFilesAfterImport", "documentation":"If set to true, your data files is deleted from S3, after ingestion into IoT SiteWise storage.
" }, "datasetId":{ "shape":"ID", "documentation":"The ID of the dataset.
" }, "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace.
" } } }, "DescribeComputationModelExecutionSummaryRequest":{ "type":"structure", "required":["computationModelId"], "members":{ "computationModelId":{ "shape":"ID", "documentation":"The ID of the computation model.
", "location":"uri", "locationName":"computationModelId" }, "resolveToResourceType":{ "shape":"ResolveToResourceType", "documentation":"The type of the resolved resource.
", "location":"querystring", "locationName":"resolveToResourceType" }, "resolveToResourceId":{ "shape":"ID", "documentation":"The ID of the resolved resource.
", "location":"querystring", "locationName":"resolveToResourceId" } } }, "DescribeComputationModelExecutionSummaryResponse":{ "type":"structure", "required":[ "computationModelId", "computationModelExecutionSummary" ], "members":{ "computationModelId":{ "shape":"ID", "documentation":"The ID of the computation model.
" }, "resolveTo":{ "shape":"ResolveTo", "documentation":"The detailed resource this execution summary resolves to.
" }, "computationModelExecutionSummary":{ "shape":"ComputationModelExecutionSummary", "documentation":"Contains the execution summary of the computation model.
" } } }, "DescribeComputationModelRequest":{ "type":"structure", "required":["computationModelId"], "members":{ "computationModelId":{ "shape":"ID", "documentation":"The ID of the computation model.
", "location":"uri", "locationName":"computationModelId" }, "computationModelVersion":{ "shape":"ComputationModelVersionFilter", "documentation":"The version of the computation model.
", "location":"querystring", "locationName":"computationModelVersion" } } }, "DescribeComputationModelResponse":{ "type":"structure", "required":[ "computationModelId", "computationModelArn", "computationModelName", "computationModelConfiguration", "computationModelDataBinding", "computationModelCreationDate", "computationModelLastUpdateDate", "computationModelStatus", "computationModelVersion", "actionDefinitions" ], "members":{ "computationModelId":{ "shape":"ID", "documentation":"The ID of the computation model.
" }, "computationModelArn":{ "shape":"ARN", "documentation":"The ARN of the computation model, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:computation-model/${ComputationModelId}
The name of the computation model.
" }, "computationModelDescription":{ "shape":"RestrictedDescription", "documentation":"The description of the computation model.
" }, "computationModelConfiguration":{ "shape":"ComputationModelConfiguration", "documentation":"The configuration for the computation model.
" }, "computationModelDataBinding":{ "shape":"ComputationModelDataBinding", "documentation":"The data binding for the computation model. Key is a variable name defined in configuration. Value is a ComputationModelDataBindingValue referenced by the variable.
The model creation date, in Unix epoch time.
" }, "computationModelLastUpdateDate":{ "shape":"Timestamp", "documentation":"The date the model was last updated, in Unix epoch time.
" }, "computationModelStatus":{ "shape":"ComputationModelStatus", "documentation":"The current status of the asset model, which contains a state and an error message if any.
" }, "computationModelVersion":{ "shape":"Version", "documentation":"The version of the computation model.
" }, "actionDefinitions":{ "shape":"ActionDefinitions", "documentation":"The available actions for this computation model.
" } } }, "DescribeDashboardRequest":{ "type":"structure", "required":["dashboardId"], "members":{ "dashboardId":{ "shape":"ID", "documentation":"The ID of the dashboard.
", "location":"uri", "locationName":"dashboardId" } } }, "DescribeDashboardResponse":{ "type":"structure", "required":[ "dashboardId", "dashboardArn", "dashboardName", "projectId", "dashboardDefinition", "dashboardCreationDate", "dashboardLastUpdateDate" ], "members":{ "dashboardId":{ "shape":"ID", "documentation":"The ID of the dashboard.
" }, "dashboardArn":{ "shape":"ARN", "documentation":"The ARN of the dashboard, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}
The name of the dashboard.
" }, "projectId":{ "shape":"ID", "documentation":"The ID of the project that the dashboard is in.
" }, "dashboardDescription":{ "shape":"Description", "documentation":"The dashboard's description.
" }, "dashboardDefinition":{ "shape":"DashboardDefinition", "documentation":"The dashboard's definition JSON literal. For detailed information, see Creating dashboards (CLI) in the IoT SiteWise User Guide.
" }, "dashboardCreationDate":{ "shape":"Timestamp", "documentation":"The date the dashboard was created, in Unix epoch time.
" }, "dashboardLastUpdateDate":{ "shape":"Timestamp", "documentation":"The date the dashboard was last updated, in Unix epoch time.
" } } }, "DescribeDatasetExportJobRequest":{ "type":"structure", "required":[ "workspaceName", "jobId" ], "members":{ "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace that contains the dataset export job.
", "location":"uri", "locationName":"workspaceName" }, "jobId":{ "shape":"DatasetExportJobId", "documentation":"The unique identifier for the dataset export job.
", "location":"uri", "locationName":"jobId" } }, "documentation":"Request to describe a dataset export job.
" }, "DescribeDatasetExportJobResponse":{ "type":"structure", "required":[ "jobId", "workspaceName", "status", "startedAt", "destinationS3Uri", "errorReportLocation", "input" ], "members":{ "jobId":{ "shape":"DatasetExportJobId", "documentation":"The unique identifier for the dataset export job.
" }, "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace that contains the dataset export job.
" }, "status":{ "shape":"DatasetExportJobStatus", "documentation":"The current status of the dataset export job.
" }, "startedAt":{ "shape":"Timestamp", "documentation":"The timestamp when the job started processing.
" }, "completedAt":{ "shape":"Timestamp", "documentation":"The timestamp when the job completed, or null if the job is still running.
" }, "destinationS3Uri":{ "shape":"S3Uri", "documentation":"The S3 URI where output clips are written.
" }, "errorReportLocation":{ "shape":"ExportErrorReportLocation", "documentation":"The location where the error report will be written on failure.
" }, "input":{ "shape":"ProcessingInput", "documentation":"The processing input that was provided in the CreateDatasetExportJob request.
" } }, "documentation":"Response for describe dataset export job request.
" }, "DescribeDatasetRequest":{ "type":"structure", "required":["datasetId"], "members":{ "datasetId":{ "shape":"ID", "documentation":"The ID of the dataset.
", "location":"uri", "locationName":"datasetId" }, "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace that contains the dataset.
", "location":"querystring", "locationName":"workspaceName" }, "datasetVersion":{ "shape":"Version", "documentation":"The version of the dataset.
", "location":"querystring", "locationName":"datasetVersion" } } }, "DescribeDatasetResponse":{ "type":"structure", "required":[ "datasetId", "datasetArn", "datasetName", "datasetDescription", "datasetSource", "datasetStatus", "datasetCreationDate", "datasetLastUpdateDate" ], "members":{ "datasetId":{ "shape":"ID", "documentation":"The ID of the dataset.
" }, "datasetArn":{ "shape":"ARN", "documentation":"The ARN of the dataset. The format is arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId}.
The name of the dataset.
" }, "datasetDescription":{ "shape":"Description", "documentation":"A description about the dataset, and its functionality.
" }, "datasetType":{ "shape":"DatasetTypeEnum", "documentation":"The type of dataset: a session dataset, a curated dataset, or a connection to an external datasource.
" }, "datasetConfig":{ "shape":"DatasetConfig", "documentation":"The configuration for the dataset.
" }, "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace that contains the dataset.
" }, "metadata":{ "shape":"Metadata", "documentation":"The metadata for the dataset.
" }, "datasetSource":{ "shape":"DatasetSource", "documentation":"The data source for the dataset.
" }, "datasetStatus":{ "shape":"DatasetStatus", "documentation":"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.
The dataset creation date, in Unix epoch time.
" }, "datasetLastUpdateDate":{ "shape":"Timestamp", "documentation":"The date the dataset was last updated, in Unix epoch time.
" }, "datasetVersion":{ "shape":"Version", "documentation":"The version of the dataset.
" }, "enrichmentStatus":{ "shape":"DatasetEnrichment", "documentation":"The enrichment status of the dataset.
" } } }, "DescribeDefaultEncryptionConfigurationRequest":{ "type":"structure", "members":{} }, "DescribeDefaultEncryptionConfigurationResponse":{ "type":"structure", "required":[ "encryptionType", "configurationStatus" ], "members":{ "encryptionType":{ "shape":"EncryptionType", "documentation":"The type of encryption used for the encryption configuration.
" }, "kmsKeyArn":{ "shape":"ARN", "documentation":"The key ARN of the customer managed key used for KMS encryption if you use KMS_BASED_ENCRYPTION.
The status of the account configuration. This contains the ConfigurationState. If there's an error, it also contains the ErrorDetails.
The name of the IoT SiteWise workspace containing the enrichment job.
", "location":"uri", "locationName":"workspaceName" }, "jobId":{ "shape":"ID", "documentation":"The unique identifier of the enrichment job to retrieve. This is the jobId returned by CreateEnrichmentJob.
", "location":"uri", "locationName":"jobId" } } }, "DescribeEnrichmentJobResponse":{ "type":"structure", "required":[ "jobId", "status", "workspaceName", "jobType", "jobConfiguration", "createdAt" ], "members":{ "jobId":{ "shape":"ID", "documentation":"The unique identifier of the enrichment job.
" }, "status":{ "shape":"EnrichmentJobStatus", "documentation":"Current status of the enrichment job. Possible values:
The name of the IoT SiteWise workspace containing the job.
" }, "jobType":{ "shape":"JobType", "documentation":"The type of enrichment job, derived from the job configuration. Currently EVENT_DETECTION is the only supported type.
" }, "jobConfiguration":{ "shape":"EnrichmentJobConfiguration", "documentation":"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.
" }, "createdAt":{ "shape":"Timestamp", "documentation":"Timestamp when the enrichment job was created in ISO 8601 format.
" }, "updatedAt":{ "shape":"Timestamp", "documentation":"Timestamp when the job status was last updated in ISO 8601 format. Useful for tracking recent activity.
" }, "completedAt":{ "shape":"Timestamp", "documentation":"Timestamp when the job completed successfully in ISO 8601 format. Only present if status is COMPLETED.
" }, "cancelledAt":{ "shape":"Timestamp", "documentation":"Timestamp when the job was cancelled in ISO 8601 format. Only present if status is CANCELLED.
" }, "failureMessage":{ "shape":"String", "documentation":"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.
" } } }, "DescribeExecutionRequest":{ "type":"structure", "required":["executionId"], "members":{ "executionId":{ "shape":"ID", "documentation":"The ID of the execution.
", "location":"uri", "locationName":"executionId" } } }, "DescribeExecutionResponse":{ "type":"structure", "required":[ "executionId", "targetResource", "targetResourceVersion", "executionStartTime", "executionStatus" ], "members":{ "executionId":{ "shape":"ID", "documentation":"The ID of the execution.
" }, "actionType":{ "shape":"Name", "documentation":"The type of action exectued.
" }, "targetResource":{"shape":"TargetResource"}, "targetResourceVersion":{ "shape":"Version", "documentation":"The version of the target resource.
" }, "resolveTo":{ "shape":"ResolveTo", "documentation":"The detailed resource this execution resolves to.
" }, "executionStartTime":{ "shape":"Timestamp", "documentation":"The time the process started.
" }, "executionEndTime":{ "shape":"Timestamp", "documentation":"The time the process ended.
" }, "executionStatus":{ "shape":"ExecutionStatus", "documentation":"The status of the execution process.
" }, "executionResult":{ "shape":"ExecutionResult", "documentation":"The result of the execution.
" }, "executionDetails":{ "shape":"ExecutionDetails", "documentation":"Provides detailed information about the execution of your anomaly detection models. This includes model metrics and training timestamps for both training and inference actions.
The training action (Amazon Web Services/ANOMALY_DETECTION_TRAINING), includes performance metrics that help you compare different versions of your anomaly detection models. These metrics provide insights into the model's performance during the training process.
The inference action (Amazon Web Services/ANOMALY_DETECTION_INFERENCE), includes information about the results of executing your anomaly detection models. This helps you understand the output of your models and assess their performance.
Entity version used for the execution.
" } } }, "DescribeGatewayCapabilityConfigurationRequest":{ "type":"structure", "required":[ "gatewayId", "capabilityNamespace" ], "members":{ "gatewayId":{ "shape":"ID", "documentation":"The ID of the gateway that defines the capability configuration.
", "location":"uri", "locationName":"gatewayId" }, "capabilityNamespace":{ "shape":"CapabilityNamespace", "documentation":"The namespace of the capability configuration. For example, if you configure OPC UA sources for an MQTT-enabled gateway, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:3.
The ID of the gateway that defines the capability configuration.
" }, "capabilityNamespace":{ "shape":"CapabilityNamespace", "documentation":"The namespace of the gateway capability.
" }, "capabilityConfiguration":{ "shape":"CapabilityConfiguration", "documentation":"The JSON document that defines the gateway capability's configuration. For more information, see Configuring data sources (CLI) in the IoT SiteWise User Guide.
" }, "capabilitySyncStatus":{ "shape":"CapabilitySyncStatus", "documentation":"The synchronization status of the gateway capability configuration. The sync status can be one of the following:
IN_SYNC - The gateway is running with the latest configuration.
OUT_OF_SYNC - The gateway hasn't received the latest configuration.
SYNC_FAILED - The gateway rejected the latest configuration.
UNKNOWN - The gateway hasn't reported its sync status.
NOT_APPLICABLE - The gateway doesn't support this capability. This is most common when integrating partner data sources, because the data integration is handled externally by the partner.
The ID of the gateway device.
", "location":"uri", "locationName":"gatewayId" } } }, "DescribeGatewayResponse":{ "type":"structure", "required":[ "gatewayId", "gatewayName", "gatewayArn", "gatewayCapabilitySummaries", "creationDate", "lastUpdateDate" ], "members":{ "gatewayId":{ "shape":"ID", "documentation":"The ID of the gateway device.
" }, "gatewayName":{ "shape":"GatewayName", "documentation":"The name of the gateway.
" }, "gatewayArn":{ "shape":"ARN", "documentation":"The ARN of the gateway, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}
The gateway's platform.
" }, "gatewayVersion":{ "shape":"GatewayVersion", "documentation":"The version of the gateway. A value of 3 indicates an MQTT-enabled, V3 gateway, while 2 indicates a Classic streams, V2 gateway.
A list of gateway capability summaries that each contain a namespace and status. Each gateway capability defines data sources for the gateway. To retrieve a capability configuration's definition, use DescribeGatewayCapabilityConfiguration.
" }, "creationDate":{ "shape":"Timestamp", "documentation":"The date the gateway was created, in Unix epoch time.
" }, "lastUpdateDate":{ "shape":"Timestamp", "documentation":"The date the gateway was last updated, in Unix epoch time.
" } } }, "DescribeLoggingOptionsRequest":{ "type":"structure", "members":{ "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace.
", "location":"querystring", "locationName":"workspaceName" } } }, "DescribeLoggingOptionsResponse":{ "type":"structure", "required":["loggingOptions"], "members":{ "loggingOptions":{ "shape":"LoggingOptions", "documentation":"The current logging options.
" } } }, "DescribePipelineExecutionRequest":{ "type":"structure", "required":[ "workspaceName", "pipelineName", "pipelineExecutionId" ], "members":{ "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace.
", "location":"uri", "locationName":"workspaceName" }, "pipelineName":{ "shape":"ResourceName", "documentation":"The name of the pipeline.
", "location":"uri", "locationName":"pipelineName" }, "pipelineExecutionId":{ "shape":"ID", "documentation":"The unique identifier of the pipeline execution.
", "location":"uri", "locationName":"pipelineExecutionId" }, "nextToken":{ "shape":"PaginationToken", "documentation":"The token to be used for the next set of paginated results.
", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"DescribePipelineExecutionRequestMaxResultsInteger", "documentation":"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.
", "location":"querystring", "locationName":"maxResults" } }, "documentation":"Request structure for DescribePipelineExecution operation.
" }, "DescribePipelineExecutionRequestMaxResultsInteger":{ "type":"integer", "box":true, "max":250, "min":1 }, "DescribePipelineExecutionResponse":{ "type":"structure", "required":[ "pipelineExecutionId", "pipelineName", "workspaceName", "pipelineVersion", "status", "requestEnvironmentVariables", "computeNodeExecutionDetails" ], "members":{ "pipelineExecutionId":{ "shape":"ID", "documentation":"The unique identifier of the pipeline execution.
" }, "pipelineName":{ "shape":"ResourceName", "documentation":"The name of the pipeline.
" }, "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace.
" }, "pipelineVersion":{ "shape":"Version", "documentation":"The pipeline version this execution ran against.
" }, "status":{ "shape":"PipelineExecutionStatus", "documentation":"The current execution status of the pipeline.
" }, "startTime":{ "shape":"Timestamp", "documentation":"The time the pipeline execution started, in Unix epoch time.
" }, "endTime":{ "shape":"Timestamp", "documentation":"The time the pipeline execution completed, in Unix epoch time.
" }, "requestEnvironmentVariables":{ "shape":"ExecutionEnvironmentVariables", "documentation":"The environment variables provided as input for the pipeline execution.
" }, "executionPriority":{ "shape":"ExecutionPriority", "documentation":"Scheduling priority for the execution. When not specified, defaults to lowest priority.
" }, "computeNodeExecutionDetails":{ "shape":"ComputeNodeExecutionDetailsList", "documentation":"A list of compute node execution details within this pipeline execution.
" }, "nextToken":{ "shape":"PaginationToken", "documentation":"The token to be used for the next set of paginated results.
" } }, "documentation":"Response structure for DescribePipelineExecution operation.
" }, "DescribePipelineRequest":{ "type":"structure", "required":[ "workspaceName", "pipelineName" ], "members":{ "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace.
", "location":"uri", "locationName":"workspaceName" }, "pipelineName":{ "shape":"ResourceName", "documentation":"The name of the pipeline.
", "location":"uri", "locationName":"pipelineName" }, "pipelineVersion":{ "shape":"Version", "documentation":"The version number of the pipeline to retrieve. If not specified, returns the latest version.
", "location":"querystring", "locationName":"version" } }, "documentation":"Request structure for DescribePipeline operation.
" }, "DescribePipelineResponse":{ "type":"structure", "required":[ "pipelineName", "workspaceName", "pipelineArn", "version", "computations", "status", "createdAt", "updatedAt" ], "members":{ "pipelineName":{ "shape":"ResourceName", "documentation":"A unique name of the pipeline within the workspace.
" }, "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace.
" }, "description":{ "shape":"Description", "documentation":"The description of the pipeline.
" }, "pipelineArn":{ "shape":"ARN", "documentation":"The ARN of the pipeline.
" }, "version":{ "shape":"Version", "documentation":"The version of the pipeline.
" }, "environmentVariables":{ "shape":"EnvironmentVariablesMap", "documentation":"The environment variables shared across all compute nodes in the pipeline.
" }, "computations":{ "shape":"ComputeNodeList", "documentation":"The list of compute nodes that form the pipeline DAG.
" }, "status":{ "shape":"ResourceStatus", "documentation":"The current lifecycle status of the pipeline.
" }, "createdAt":{ "shape":"Timestamp", "documentation":"The time the pipeline was created, in Unix epoch time.
" }, "updatedAt":{ "shape":"Timestamp", "documentation":"The time the pipeline was last updated, in Unix epoch time.
" } }, "documentation":"Response structure for DescribePipeline operation.
" }, "DescribePortalRequest":{ "type":"structure", "required":["portalId"], "members":{ "portalId":{ "shape":"ID", "documentation":"The ID of the portal.
", "location":"uri", "locationName":"portalId" } } }, "DescribePortalResponse":{ "type":"structure", "required":[ "portalId", "portalArn", "portalName", "portalClientId", "portalStartUrl", "portalContactEmail", "portalStatus", "portalCreationDate", "portalLastUpdateDate" ], "members":{ "portalId":{ "shape":"ID", "documentation":"The ID of the portal.
" }, "portalArn":{ "shape":"ARN", "documentation":"The ARN of the portal, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}
The name of the portal.
" }, "portalDescription":{ "shape":"Description", "documentation":"The portal's description.
" }, "portalClientId":{ "shape":"PortalClientId", "documentation":"The IAM Identity Center application generated client ID (used with IAM Identity Center API operations). IoT SiteWise includes portalClientId for only portals that use IAM Identity Center to authenticate users.
The URL for the IoT SiteWise Monitor portal. You can use this URL to access portals that use IAM Identity Center for authentication. For portals that use IAM for authentication, you must use the IoT SiteWise console to get a URL that you can use to access the portal.
" }, "portalContactEmail":{ "shape":"Email", "documentation":"The Amazon Web Services administrator's contact email address.
" }, "portalStatus":{ "shape":"PortalStatus", "documentation":"The current status of the portal, which contains a state and any error message.
" }, "portalCreationDate":{ "shape":"Timestamp", "documentation":"The date the portal was created, in Unix epoch time.
" }, "portalLastUpdateDate":{ "shape":"Timestamp", "documentation":"The date the portal was last updated, in Unix epoch time.
" }, "portalLogoImageLocation":{ "shape":"ImageLocation", "documentation":"The portal's logo image, which is available at a URL.
" }, "roleArn":{ "shape":"IamArn", "documentation":"The ARN of the service role that allows the portal's users to access your IoT SiteWise resources on your behalf. For more information, see Using service roles for IoT SiteWise Monitor in the IoT SiteWise User Guide.
" }, "portalAuthMode":{ "shape":"AuthMode", "documentation":"The service to use to authenticate users to the portal.
" }, "notificationSenderEmail":{ "shape":"Email", "documentation":"The email address that sends alarm notifications.
" }, "alarms":{ "shape":"Alarms", "documentation":"Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal.
" }, "portalType":{ "shape":"PortalType", "documentation":"Define the type of portal. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.
The configuration entry associated with the specific portal type. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.
The ID of the project.
", "location":"uri", "locationName":"projectId" } } }, "DescribeProjectResponse":{ "type":"structure", "required":[ "projectId", "projectArn", "projectName", "portalId", "projectCreationDate", "projectLastUpdateDate" ], "members":{ "projectId":{ "shape":"ID", "documentation":"The ID of the project.
" }, "projectArn":{ "shape":"ARN", "documentation":"The ARN of the project, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId}
The name of the project.
" }, "portalId":{ "shape":"ID", "documentation":"The ID of the portal that the project is in.
" }, "projectDescription":{ "shape":"Description", "documentation":"The project's description.
" }, "projectCreationDate":{ "shape":"Timestamp", "documentation":"The date the project was created, in Unix epoch time.
" }, "projectLastUpdateDate":{ "shape":"Timestamp", "documentation":"The date the project was last updated, in Unix epoch time.
" } } }, "DescribeQueryRequest":{ "type":"structure", "required":[ "workspaceName", "queryId" ], "members":{ "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace associated with the query.
", "location":"uri", "locationName":"workspaceName" }, "queryId":{ "shape":"QueryId", "documentation":"The unique identifier for the query execution.
", "location":"uri", "locationName":"queryId" } } }, "DescribeQueryResponse":{ "type":"structure", "required":[ "queryId", "status", "submittedAt" ], "members":{ "queryId":{ "shape":"QueryId", "documentation":"The unique identifier for the query execution.
" }, "status":{ "shape":"QueryStatus", "documentation":"The current query status.
" }, "submittedAt":{ "shape":"Timestamp", "documentation":"The date and time when the query was submitted, in Unix epoch time.
" }, "completedAt":{ "shape":"Timestamp", "documentation":"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":{ "shape":"QueryStatistics", "documentation":"The query execution statistics. This field is present when the query status is COMPLETED.
" }, "errorMessage":{ "shape":"QueryErrorMessage", "documentation":"A human-readable error description. This field is present when the query status is FAILED.
" } }, "documentation":"Contains the response for the DescribeQuery operation.
" }, "DescribeSearchRequest":{ "type":"structure", "required":[ "workspaceName", "searchId" ], "members":{ "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace the search belongs to.
", "location":"uri", "locationName":"workspaceName" }, "searchId":{ "shape":"SearchId", "documentation":"The identifier of the search to describe.
", "location":"uri", "locationName":"searchId" } }, "documentation":"Input for the DescribeSearch operation.
" }, "DescribeSearchResponse":{ "type":"structure", "required":[ "searchId", "workspaceName", "status", "queryStatement", "searchType" ], "members":{ "searchId":{ "shape":"SearchId", "documentation":"The unique identifier of the search.
" }, "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace the search runs against.
" }, "status":{ "shape":"SearchStatus", "documentation":"The current status of the search.
" }, "queryStatement":{ "shape":"SearchQueryStatement", "documentation":"The natural-language query that was submitted for the search.
" }, "searchType":{ "shape":"SearchType", "documentation":"The search strategy used for the search.
" }, "statusReason":{ "shape":"String", "documentation":"A human-readable explanation of the current status. Populated when the search has FAILED.
The time at which the search was started.
" }, "groupId":{ "shape":"GroupId", "documentation":"The group identifier associated with the search, if one was supplied on the request.
" } }, "documentation":"Output of the DescribeSearch operation.
" }, "DescribeStorageConfigurationRequest":{ "type":"structure", "members":{} }, "DescribeStorageConfigurationResponse":{ "type":"structure", "required":[ "storageType", "configurationStatus" ], "members":{ "storageType":{ "shape":"StorageType", "documentation":"The storage tier that you specified for your data. The storageType parameter can be one of the following values:
SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves your data into the hot tier. The hot tier is a service-managed database.
MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold tier and the hot tier. The cold tier is a customer-managed Amazon S3 bucket.
Contains information about the storage destination.
" }, "disassociatedDataStorage":{ "shape":"DisassociatedDataStorageState", "documentation":"Contains the storage configuration for time series (data streams) that aren't associated with asset properties. The disassociatedDataStorage can be one of the following values:
ENABLED – IoT SiteWise accepts time series that aren't associated with asset properties.
After the disassociatedDataStorage is enabled, you can't disable it.
DISABLED – IoT SiteWise doesn't accept time series (data streams) that aren't associated with asset properties.
For more information, see Data streams in the IoT SiteWise User Guide.
" }, "retentionPeriod":{ "shape":"RetentionPeriod", "documentation":"The number of days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.
" }, "configurationStatus":{"shape":"ConfigurationStatus"}, "lastUpdateDate":{ "shape":"Timestamp", "documentation":"The date the storage configuration was last updated, in Unix epoch time.
" }, "warmTier":{ "shape":"WarmTierState", "documentation":"A service managed storage tier optimized for analytical queries. It stores periodically uploaded, buffered and historical data ingested with the CreaeBulkImportJob API.
" }, "warmTierRetentionPeriod":{ "shape":"WarmTierRetentionPeriod", "documentation":"Set this period to specify how long your data is stored in the warm tier before it is deleted. You can set this only if cold tier is enabled.
" }, "disallowIngestNullNaN":{ "shape":"DisallowIngestNullNaN", "documentation":"Describes the configuration for ingesting NULL and NaN data. By default the feature is allowed. The feature is disallowed if the value is true.
The name of the workspace.
", "location":"uri", "locationName":"workspaceName" }, "taskName":{ "shape":"ResourceName", "documentation":"The name of the task.
", "location":"uri", "locationName":"taskName" }, "taskVersion":{ "shape":"Version", "documentation":"The version number of the task to retrieve. If not specified, returns the latest version.
", "location":"querystring", "locationName":"version" } }, "documentation":"Request structure for DescribeTask operation.
" }, "DescribeTaskResponse":{ "type":"structure", "required":[ "workspaceName", "taskName", "taskArn", "version", "taskConfiguration", "status", "createdAt", "updatedAt" ], "members":{ "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace.
" }, "taskName":{ "shape":"ResourceName", "documentation":"The name of the task.
" }, "description":{ "shape":"Description", "documentation":"The description of the task.
" }, "taskArn":{ "shape":"ARN", "documentation":"The ARN of the task.
" }, "version":{ "shape":"Version", "documentation":"The version of the task.
" }, "taskConfiguration":{ "shape":"TaskConfiguration", "documentation":"The task execution configuration. Contains a containerTaskConfiguration for custom container workloads.
" }, "status":{ "shape":"ResourceStatus", "documentation":"The current lifecycle status of the task.
" }, "createdAt":{ "shape":"Timestamp", "documentation":"The time the task was created, in Unix epoch time.
" }, "updatedAt":{ "shape":"Timestamp", "documentation":"The time the task was last updated, in Unix epoch time.
" } }, "documentation":"Response structure for DescribeTask operation.
" }, "DescribeTimeSeriesRequest":{ "type":"structure", "members":{ "alias":{ "shape":"PropertyAlias", "documentation":"The alias that identifies the time series.
", "location":"querystring", "locationName":"alias" }, "assetId":{ "shape":"CustomID", "documentation":"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.
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.
The name of the workspace.
", "location":"querystring", "locationName":"workspaceName" } } }, "DescribeTimeSeriesResponse":{ "type":"structure", "required":[ "timeSeriesId", "dataType", "timeSeriesCreationDate", "timeSeriesLastUpdateDate", "timeSeriesArn" ], "members":{ "assetId":{ "shape":"ID", "documentation":"The ID of the asset in which the asset property was created.
" }, "propertyId":{ "shape":"ID", "documentation":"The ID of the asset property, in UUID format.
" }, "alias":{ "shape":"PropertyAlias", "documentation":"The alias that identifies the time series.
" }, "timeSeriesId":{ "shape":"TimeSeriesId", "documentation":"The ID of the time series.
" }, "dataType":{ "shape":"PropertyDataType", "documentation":"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.
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.
The date that the time series was created, in Unix epoch time.
" }, "timeSeriesLastUpdateDate":{ "shape":"Timestamp", "documentation":"The date that the time series was last updated, in Unix epoch time.
" }, "timeSeriesArn":{ "shape":"ARN", "documentation":"The ARN of the time series, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId}
The name of the workspace.
" } } }, "DescribeWorkspaceRequest":{ "type":"structure", "required":["workspaceName"], "members":{ "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace.
", "location":"uri", "locationName":"workspaceName" } } }, "DescribeWorkspaceResponse":{ "type":"structure", "required":[ "workspaceArn", "workspaceName", "workspaceStatus", "createdAt", "updatedAt" ], "members":{ "workspaceArn":{ "shape":"ARN", "documentation":"The ARN of the workspace.
" }, "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace.
" }, "workspaceDescription":{ "shape":"Description", "documentation":"The description of the workspace.
" }, "workspaceStatus":{ "shape":"WorkspaceStatus", "documentation":"The status of the workspace, which contains the state and any error message.
" }, "encryptionConfiguration":{ "shape":"WorkspaceEncryptionConfigurationInfo", "documentation":"The encryption configuration information for the workspace.
" }, "createdAt":{ "shape":"Timestamp", "documentation":"The date the workspace was created, in Unix epoch time.
" }, "updatedAt":{ "shape":"Timestamp", "documentation":"The date the workspace was last updated, in Unix epoch time.
" } } }, "Description":{ "type":"string", "max":2048, "min":1, "pattern":"[^\\u0000-\\u001F\\u007F]+" }, "DetailedError":{ "type":"structure", "required":[ "code", "message" ], "members":{ "code":{ "shape":"DetailedErrorCode", "documentation":"The error code.
" }, "message":{ "shape":"DetailedErrorMessage", "documentation":"The error message.
" } }, "documentation":"Contains detailed error information.
" }, "DetailedErrorCode":{ "type":"string", "enum":[ "INCOMPATIBLE_COMPUTE_LOCATION", "INCOMPATIBLE_FORWARDING_CONFIGURATION" ] }, "DetailedErrorList":{ "type":"list", "member":{"shape":"DetailedPipelineError"}, "documentation":"A list of detailed pipeline error entries.
" }, "DetailedErrorMessage":{"type":"string"}, "DetailedErrors":{ "type":"list", "member":{"shape":"DetailedError"} }, "DetailedPipelineError":{ "type":"structure", "required":[ "code", "message" ], "members":{ "code":{ "shape":"DetailedPipelineErrorCode", "documentation":"The error code.
" }, "message":{ "shape":"String", "documentation":"The associated error message.
" } }, "documentation":"Contains a detailed error entry for granular troubleshooting of pipeline failures.
" }, "DetailedPipelineErrorCode":{ "type":"string", "documentation":"The error code for a detailed pipeline error entry.
", "enum":[ "VALIDATION_ERROR", "INTERNAL_FAILURE", "EXECUTION_ERROR", "TIMED_OUT" ] }, "DisallowIngestNullNaN":{"type":"boolean"}, "DisassociateAssetsRequest":{ "type":"structure", "required":[ "assetId", "hierarchyId", "childAssetId" ], "members":{ "assetId":{ "shape":"CustomID", "documentation":"The ID of the parent asset from which to disassociate the child 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.
The ID of a hierarchy in the parent asset's 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.) Hierarchies allow different groupings of assets to be formed that all come from the same asset model. You can use the hierarchy ID to identify the correct asset to disassociate. For more information, see Asset hierarchies in the IoT SiteWise User Guide.
The ID of the child asset to disassociate. 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.
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.
", "idempotencyToken":true } } }, "DisassociateDataSegmentEntries":{ "type":"list", "member":{"shape":"DisassociateDataSegmentEntry"} }, "DisassociateDataSegmentEntry":{ "type":"structure", "required":[ "sourceDatasetId", "timeSeriesId", "startTimestamp", "endTimestamp" ], "members":{ "sourceDatasetId":{ "shape":"ID", "documentation":"The ID of the source dataset that contains the data segment.
" }, "timeSeriesId":{ "shape":"TimeSeriesId", "documentation":"The ID of the time series.
" }, "startTimestamp":{ "shape":"TimeInNanos", "documentation":"The nanosecond-precision start time of the data segment to disassociate.
" }, "endTimestamp":{ "shape":"TimeInNanos", "documentation":"The nanosecond-precision end time of the data segment to disassociate.
" } }, "documentation":"Contains information about a data segment entry to disassociate from a dataset.
" }, "DisassociateTimeSeriesFromAssetPropertyRequest":{ "type":"structure", "required":[ "alias", "assetId", "propertyId" ], "members":{ "alias":{ "shape":"PropertyAlias", "documentation":"The alias that identifies the time series.
", "location":"querystring", "locationName":"alias" }, "assetId":{ "shape":"CustomID", "documentation":"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.
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.
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.
", "idempotencyToken":true } } }, "DisassociatedDataStorageState":{ "type":"string", "enum":[ "ENABLED", "DISABLED" ] }, "DnsSubdomain":{ "type":"string", "documentation":"DNS-compliant subdomain label
", "max":63, "min":1, "pattern":"[a-z0-9]([a-z0-9-]*[a-z0-9])?" }, "ETag":{ "type":"string", "pattern":"^[\\w-]{43}$" }, "EcrUri":{ "type":"string", "documentation":"The Amazon ECR image URI for the container.
Supported formats:
{account-id}.dkr.ecr.{region}.amazonaws.com/{repository}:{tag}public.ecr.aws/{registry-alias}/{repository}:{tag}Tags and digests (@sha256:...) are optional. If omitted, latest is used. The image must be accessible from the task execution role.
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.
" } }, "documentation":"Configuration for the enrichment job defining which analysis type to perform on video time-series data. Currently supports event detection enrichment. Exactly one member must be specified.
", "union":true }, "EnrichmentJobStatus":{ "type":"string", "documentation":"<p>Status of an enrichment job throughout its lifecycle.</p> <p>Status progression: PENDING → RUNNING → {COMPLETED, FAILED, TIMED_OUT, CANCELLED}</p> <ul> <li>PENDING: Job has been accepted and is waiting to start processing</li> <li>RUNNING: Job is actively processing video data to generate embeddings</li> <li>COMPLETED: Job finished successfully; embeddings are available in IoT SiteWise</li> <li>FAILED: Job encountered an error during processing</li> <li>TIMED_OUT: Job exceeded the maximum processing time limit</li> <li>CANCELLED: Job was cancelled via CancelEnrichmentJob</li> </ul> <p>Terminal states (job will not change status): COMPLETED, FAILED, TIMED_OUT, CANCELLED</p>", "enum":[ "PENDING", "RUNNING", "COMPLETED", "FAILED", "TIMED_OUT", "CANCELLED" ] }, "EnrichmentJobSummaries":{ "type":"list", "member":{"shape":"EnrichmentJobSummary"} }, "EnrichmentJobSummary":{ "type":"structure", "required":[ "jobId", "status", "workspaceName", "jobType", "datasetId", "createdAt" ], "members":{ "jobId":{ "shape":"ID", "documentation":"Unique identifier for the enrichment job.
" }, "status":{ "shape":"EnrichmentJobStatus", "documentation":"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":{ "shape":"WorkspaceName", "documentation":"The name of the IoT SiteWise workspace containing this job.
" }, "jobType":{ "shape":"JobType", "documentation":"The type of enrichment job. Currently EVENT_DETECTION is the only supported type.
" }, "datasetId":{ "shape":"ID", "documentation":"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":{ "shape":"AssetPropertyAlias", "documentation":"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":{ "shape":"TimeSeriesId", "documentation":"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":{ "shape":"Timestamp", "documentation":"Timestamp when the job was created in ISO 8601 format.
" }, "updatedAt":{ "shape":"Timestamp", "documentation":"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.
" } }, "documentation":"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:
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.
" }, "EnrichmentStatus":{ "type":"string", "enum":[ "ENRICHED", "NOT_ENRICHED" ] }, "EnrichmentTrimSettings":{ "type":"structure", "required":[ "startTime", "endTime" ], "members":{ "startTime":{ "shape":"TimeInNanos", "documentation":"<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>" }, "endTime":{ "shape":"TimeInNanos", "documentation":"<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>" } }, "documentation":"<p>Time range settings for extracting a specific window of video time-series data to process.</p> <p>Trim settings define the time bounds for enrichment and must satisfy:</p> <ul> <li>Start and end times must be within the dataset's time bounds</li> <li>Trim settings retrieve fully contained data segments within the specified time range</li> <li>endTime must be greater than startTime</li> <li>Both times should represent valid data ranges in the dataset</li> </ul> <p>Trim settings are required to:</p> <ul> <li>Prevent accidentally analyzing unbounded datasets</li> <li>Ensure predictable processing time and costs</li> <li>Allow focused analysis on specific time periods of interest</li> </ul>" }, "EntryId":{ "type":"string", "max":64, "min":1, "pattern":"^[a-zA-Z0-9_-]+$" }, "EnvironmentVariableName":{ "type":"string", "documentation":"Environment variable name following POSIX naming rules Must not start with AWS_ prefix (case-insensitive)
", "max":255, "min":1, "pattern":"(?!(?i)AWS_)[a-zA-Z_][a-zA-Z0-9_]*" }, "EnvironmentVariableValue":{ "type":"string", "documentation":"Environment variable value
", "max":1024, "min":0 }, "EnvironmentVariablesMap":{ "type":"map", "key":{"shape":"EnvironmentVariableName"}, "value":{"shape":"EnvironmentVariableValue"}, "documentation":"Map of environment variables for container configuration
", "max":20, "min":0, "sensitive":true }, "ErrorCode":{ "type":"string", "enum":[ "VALIDATION_ERROR", "INTERNAL_FAILURE" ] }, "ErrorDetails":{ "type":"structure", "required":[ "code", "message" ], "members":{ "code":{ "shape":"ErrorCode", "documentation":"The error code.
" }, "message":{ "shape":"ErrorMessage", "documentation":"The error message.
" }, "details":{ "shape":"DetailedErrors", "documentation":"A list of detailed errors.
" } }, "documentation":"Contains the details of an IoT SiteWise error.
" }, "ErrorMessage":{"type":"string"}, "ErrorReportLocation":{ "type":"structure", "required":[ "bucket", "prefix" ], "members":{ "bucket":{ "shape":"Bucket", "documentation":"The name of the Amazon S3 bucket to which errors associated with the bulk import job are sent.
" }, "prefix":{ "shape":"String", "documentation":"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.
" } }, "documentation":"The Amazon S3 destination where errors associated with the job creation request are saved.
" }, "EventDetection":{ "type":"structure", "required":[ "datasetId", "trimSettings" ], "members":{ "datasetId":{ "shape":"ID", "documentation":"<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":{ "shape":"TimeSeriesId", "documentation":"<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":{ "shape":"AssetPropertyAlias", "documentation":"<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":{ "shape":"EnrichmentTrimSettings", "documentation":"<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>" } }, "documentation":"<p>Configuration for event detection enrichment on video time-series data.</p> <p>Event detection generates embeddings from video data enabling natural language similarity search on events. This allows customers to:</p> <ul> <li>Query video events using semantic search after enrichment completes</li> <li>Find relevant video segments through natural language queries</li> <li>Search across video time-series data stored in IoT SiteWise</li> </ul> <p>You must specify the dataset, exactly one time-series identifier (timeSeriesId OR propertyAlias), and trim settings defining the video time window to process.</p>" }, "ExceptionMessage":{"type":"string"}, "ExcludeProperties":{"type":"boolean"}, "ExecuteActionRequest":{ "type":"structure", "required":[ "targetResource", "actionDefinitionId", "actionPayload" ], "members":{ "targetResource":{ "shape":"TargetResource", "documentation":"The resource the action will be taken on.
" }, "actionDefinitionId":{ "shape":"ID", "documentation":"The ID of the action definition.
" }, "actionPayload":{ "shape":"ActionPayload", "documentation":"The JSON payload of the action.
" }, "clientToken":{ "shape":"ClientToken", "documentation":"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.
" }, "resolveTo":{ "shape":"ResolveTo", "documentation":"The detailed resource this action resolves to.
" } } }, "ExecuteActionResponse":{ "type":"structure", "required":["actionId"], "members":{ "actionId":{ "shape":"ID", "documentation":"The ID of the action.
" } } }, "ExecuteQueryMaxResults":{ "type":"integer", "min":1 }, "ExecuteQueryNextToken":{ "type":"string", "max":4096, "min":1 }, "ExecuteQueryRequest":{ "type":"structure", "required":["queryStatement"], "members":{ "queryStatement":{ "shape":"QueryStatement", "documentation":"The IoT SiteWise query statement.
" }, "nextToken":{ "shape":"ExecuteQueryNextToken", "documentation":"The string that specifies the next page of results.
" }, "maxResults":{ "shape":"ExecuteQueryMaxResults", "documentation":"The maximum number of results to return at one time.
Minimum is 1
Maximum is 20000
Default is 20000
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.
", "idempotencyToken":true } } }, "ExecuteQueryResponse":{ "type":"structure", "members":{ "columns":{ "shape":"ColumnsList", "documentation":"Represents a single column in the query results.
" }, "rows":{ "shape":"Rows", "documentation":"Represents a single row in the query results.
" }, "nextToken":{ "shape":"ExecuteQueryNextToken", "documentation":"The string that specifies the next page of results.
" } } }, "ExecutionDetails":{ "type":"map", "key":{"shape":"ExecutionDetailsKey"}, "value":{"shape":"ExecutionDetailsValue"} }, "ExecutionDetailsKey":{ "type":"string", "pattern":"^[a-zA-Z0-9 _\\-#$*!@]+$" }, "ExecutionDetailsValue":{ "type":"string", "pattern":"^[a-zA-Z0-9 _\\-#$*!@]+$" }, "ExecutionEnvironmentVariables":{ "type":"structure", "members":{ "global":{ "shape":"EnvironmentVariablesMap", "documentation":"Global environment variables that apply to all compute nodes in the pipeline execution.
" }, "computeNodes":{ "shape":"ComputeNodeEnvironmentVariablesMap", "documentation":"Per-compute-node environment variable overrides. Each entry maps a compute node name to its environment variable overrides.
" } }, "documentation":"Environment variables provided as input for a pipeline execution.
", "sensitive":true }, "ExecutionEnvironmentVariablesMap":{ "type":"map", "key":{ "shape":"ExecutionEnvironmentVariablesMapKeyString", "documentation":"The environment variable name.
" }, "value":{ "shape":"ExecutionEnvironmentVariablesMapValueString", "documentation":"The environment variable value.
" }, "documentation":"A map of fully resolved environment variable key-value pairs for a compute node execution.
", "max":200, "min":0, "sensitive":true }, "ExecutionEnvironmentVariablesMapKeyString":{ "type":"string", "max":255, "min":1 }, "ExecutionEnvironmentVariablesMapValueString":{ "type":"string", "max":1024, "min":0 }, "ExecutionPriority":{ "type":"integer", "documentation":"Scheduling priority for pipeline execution. Lower values indicate higher priority. When not specified, defaults to lowest priority.
", "box":true, "max":2, "min":0 }, "ExecutionResult":{ "type":"map", "key":{"shape":"ExecutionResultKey"}, "value":{"shape":"ExecutionResultValue"} }, "ExecutionResultKey":{ "type":"string", "pattern":"^[a-zA-Z0-9 _\\-#$*!@]+$" }, "ExecutionResultValue":{ "type":"string", "pattern":"^[a-zA-Z0-9 _\\-#$*!@]+$" }, "ExecutionState":{ "type":"string", "enum":[ "RUNNING", "COMPLETED", "FAILED" ] }, "ExecutionStatus":{ "type":"structure", "required":["state"], "members":{ "state":{ "shape":"ExecutionState", "documentation":"The current state of the computation model.
" } }, "documentation":"The status of the execution.
" }, "ExecutionSummaries":{ "type":"list", "member":{"shape":"ExecutionSummary"} }, "ExecutionSummary":{ "type":"structure", "required":[ "executionId", "targetResource", "targetResourceVersion", "executionStartTime", "executionStatus" ], "members":{ "executionId":{ "shape":"ID", "documentation":"The ID of the execution.
" }, "actionType":{ "shape":"Name", "documentation":"The type of action exectued.
" }, "targetResource":{"shape":"TargetResource"}, "targetResourceVersion":{ "shape":"Version", "documentation":"The version of the target resource.
" }, "resolveTo":{ "shape":"ResolveTo", "documentation":"The detailed resource this execution resolves to.
" }, "executionStartTime":{ "shape":"Timestamp", "documentation":"The time the process started.
" }, "executionEndTime":{ "shape":"Timestamp", "documentation":"The time the process ended.
" }, "executionStatus":{ "shape":"ExecutionStatus", "documentation":"The status of the execution process.
" }, "executionEntityVersion":{ "shape":"Version", "documentation":"The execution entity version associated with the summary.
" } }, "documentation":"Contains the execution summary of the computation model.
" }, "ExportDataType":{ "type":"string", "documentation":"<p>Data types that can be exported from a dataset.</p>", "enum":[ "VIDEO", "TELEMETRY", "ANNOTATION" ] }, "ExportDataTypeList":{ "type":"list", "member":{"shape":"ExportDataType"}, "documentation":"<p>A subset of ExportDataType values to export.</p>", "max":3, "min":1 }, "ExportErrorReportLocation":{ "type":"structure", "required":["s3Uri"], "members":{ "s3Uri":{ "shape":"S3Uri", "documentation":"<p>The S3 URI prefix for the error report.</p>" } }, "documentation":"<p>Contains the location where error reports will be written on failure.</p>" }, "ExportJobSummary":{ "type":"structure", "required":[ "jobId", "status", "startedAt", "destinationS3Uri" ], "members":{ "jobId":{ "shape":"DatasetExportJobId", "documentation":"<p>The unique identifier for the dataset export job.</p>" }, "status":{ "shape":"DatasetExportJobStatus", "documentation":"<p>The current status of the dataset export job.</p>" }, "startedAt":{ "shape":"Timestamp", "documentation":"<p>The timestamp when the job started processing.</p>" }, "completedAt":{ "shape":"Timestamp", "documentation":"<p>The timestamp when the job completed, or null if the job is still running.</p>" }, "destinationS3Uri":{ "shape":"S3Uri", "documentation":"<p>The S3 URI where output clips are written.</p>" } }, "documentation":"<p>Contains summary information about a dataset export job.</p>" }, "ExportJobSummaryList":{ "type":"list", "member":{"shape":"ExportJobSummary"}, "documentation":"<p>A list of dataset export job summaries.</p>" }, "Expression":{ "type":"string", "max":1024, "min":0 }, "ExpressionVariable":{ "type":"structure", "required":[ "name", "value" ], "members":{ "name":{ "shape":"VariableName", "documentation":"The friendly name of the variable to be used in the expression.
" }, "value":{ "shape":"VariableValue", "documentation":"The variable that identifies an asset property from which to use values.
" } }, "documentation":"Contains expression variable information.
" }, "ExpressionVariables":{ "type":"list", "member":{"shape":"ExpressionVariable"} }, "ExternalId":{ "type":"string", "max":128, "min":2, "pattern":"[a-zA-Z0-9_][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9_]+" }, "FailedDataSegmentAssociation":{ "type":"structure", "required":[ "sourceDatasetId", "timeSeriesId", "startTimestamp", "endTimestamp", "errorCode", "errorMessage" ], "members":{ "sourceDatasetId":{ "shape":"ID", "documentation":"The ID of the source dataset.
" }, "timeSeriesId":{ "shape":"TimeSeriesId", "documentation":"The ID of the time series.
" }, "startTimestamp":{ "shape":"TimeInNanos", "documentation":"The nanosecond-precision start time of the data segment.
" }, "endTimestamp":{ "shape":"TimeInNanos", "documentation":"The nanosecond-precision end time of the data segment.
" }, "errorCode":{ "shape":"DataSegmentErrorCode", "documentation":"The error code for the failed association.
" }, "errorMessage":{ "shape":"DataSegmentErrorMessage", "documentation":"The error message for the failed association.
" } }, "documentation":"Contains error information for a data segment association that failed.
" }, "FailedDataSegmentAssociations":{ "type":"list", "member":{"shape":"FailedDataSegmentAssociation"} }, "FailedDataSegmentDeletion":{ "type":"structure", "required":[ "timeSeriesId", "startTimestamp", "endTimestamp", "errorCode", "errorMessage" ], "members":{ "timeSeriesId":{ "shape":"ID", "documentation":"The ID of the time series.
" }, "startTimestamp":{ "shape":"TimeInNanos", "documentation":"The nanosecond-precision start time of the data segment.
" }, "endTimestamp":{ "shape":"TimeInNanos", "documentation":"The nanosecond-precision end time of the data segment.
" }, "errorCode":{ "shape":"DataSegmentErrorCode", "documentation":"The error code for the failed deletion.
" }, "errorMessage":{ "shape":"DataSegmentErrorMessage", "documentation":"The error message for the failed deletion.
" } }, "documentation":"Contains error information for a data segment deletion that failed.
" }, "FailedDataSegmentDeletions":{ "type":"list", "member":{"shape":"FailedDataSegmentDeletion"} }, "FailedDataSegmentDisassociation":{ "type":"structure", "required":[ "sourceDatasetId", "timeSeriesId", "startTimestamp", "endTimestamp", "errorCode", "errorMessage" ], "members":{ "sourceDatasetId":{ "shape":"ID", "documentation":"The ID of the source dataset.
" }, "timeSeriesId":{ "shape":"TimeSeriesId", "documentation":"The ID of the time series.
" }, "startTimestamp":{ "shape":"TimeInNanos", "documentation":"The nanosecond-precision start time of the data segment.
" }, "endTimestamp":{ "shape":"TimeInNanos", "documentation":"The nanosecond-precision end time of the data segment.
" }, "errorCode":{ "shape":"DataSegmentErrorCode", "documentation":"The error code for the failed disassociation.
" }, "errorMessage":{ "shape":"DataSegmentErrorMessage", "documentation":"The error message for the failed disassociation.
" } }, "documentation":"Contains error information for a data segment disassociation that failed.
" }, "FailedDataSegmentDisassociations":{ "type":"list", "member":{"shape":"FailedDataSegmentDisassociation"} }, "File":{ "type":"structure", "required":[ "bucket", "key" ], "members":{ "bucket":{ "shape":"Bucket", "documentation":"The name of the Amazon S3 bucket from which data is imported.
" }, "key":{ "shape":"String", "documentation":"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":{ "shape":"String", "documentation":"The version ID to identify a specific version of the Amazon S3 object that contains your data.
" }, "alias":{ "shape":"AssetPropertyAlias", "documentation":"The alias associated with the file's time series.
" }, "startTime":{ "shape":"TimeInNanos", "documentation":"The nanosecond-precision start time for the file data.
" }, "fileFormat":{ "shape":"FileFormat", "documentation":"The file format of the data in S3.
" } }, "documentation":"The file in Amazon S3 where your data is saved.
" }, "FileFormat":{ "type":"structure", "members":{ "csv":{ "shape":"Csv", "documentation":"The file is in .CSV format.
" }, "parquet":{ "shape":"Parquet", "documentation":"The file is in parquet format.
" }, "mp4":{ "shape":"Mp4", "documentation":"The MP4 format configuration.
" }, "annotation":{ "shape":"Annotation", "documentation":"The annotation format configuration.
" } }, "documentation":"The file format of the data in S3.
" }, "Files":{ "type":"list", "member":{"shape":"File"} }, "Float":{ "type":"float", "box":true }, "FormatSettings":{ "type":"structure", "members":{ "framesPerSecond":{ "shape":"PositiveInteger", "documentation":"<p>The target frame rate for the output.</p>" }, "widthInPixels":{ "shape":"PositiveInteger", "documentation":"<p>The target width of the output, in pixels.</p>" }, "heightInPixels":{ "shape":"PositiveInteger", "documentation":"<p>The target height of the output, in pixels.</p>" } }, "documentation":"<p>Contains the output format configuration for video processing.</p>" }, "ForwardingConfig":{ "type":"structure", "required":["state"], "members":{ "state":{ "shape":"ForwardingConfigState", "documentation":"The forwarding state for the given property.
" } }, "documentation":"The forwarding configuration for a given property.
" }, "ForwardingConfigState":{ "type":"string", "enum":[ "DISABLED", "ENABLED" ] }, "GatewayCapabilitySummaries":{ "type":"list", "member":{"shape":"GatewayCapabilitySummary"} }, "GatewayCapabilitySummary":{ "type":"structure", "required":[ "capabilityNamespace", "capabilitySyncStatus" ], "members":{ "capabilityNamespace":{ "shape":"CapabilityNamespace", "documentation":"The namespace of the capability configuration. For example, if you configure OPC UA sources for an MQTT-enabled gateway, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:3.
The synchronization status of the gateway capability configuration. The sync status can be one of the following:
IN_SYNC - The gateway is running with the latest configuration.
OUT_OF_SYNC - The gateway hasn't received the latest configuration.
SYNC_FAILED - The gateway rejected the latest configuration.
UNKNOWN - The gateway hasn't reported its sync status.
NOT_APPLICABLE - The gateway doesn't support this capability. This is most common when integrating partner data sources, because the data integration is handled externally by the partner.
Contains a summary of a gateway capability configuration.
" }, "GatewayName":{ "type":"string", "max":256, "min":1, "pattern":"[^\\u0000-\\u001F\\u007F]+" }, "GatewayPlatform":{ "type":"structure", "members":{ "greengrass":{ "shape":"Greengrass", "documentation":"A gateway that runs on IoT Greengrass.
" }, "greengrassV2":{ "shape":"GreengrassV2", "documentation":"A gateway that runs on IoT Greengrass V2.
" }, "siemensIE":{ "shape":"SiemensIE", "documentation":"A SiteWise Edge gateway that runs on a Siemens Industrial Edge Device.
" } }, "documentation":"The gateway's platform configuration. You can only specify one platform type in a gateway.
(Legacy only) For Greengrass V1 gateways, specify the greengrass parameter with a valid Greengrass group ARN.
For Greengrass V2 gateways, specify the greengrassV2 parameter with a valid core device thing name. If creating a V3 gateway (gatewayVersion=3), you must also specify the coreDeviceOperatingSystem.
For Siemens Industrial Edge gateways, specify the siemensIE parameter with a valid IoT Core thing name.
The ID of the gateway device.
" }, "gatewayName":{ "shape":"GatewayName", "documentation":"The name of the gateway.
" }, "gatewayPlatform":{"shape":"GatewayPlatform"}, "gatewayVersion":{ "shape":"GatewayVersion", "documentation":"The version of the gateway. A value of 3 indicates an MQTT-enabled, V3 gateway, while 2 indicates a Classic streams, V2 gateway.
A list of gateway capability summaries that each contain a namespace and status. Each gateway capability defines data sources for the gateway. To retrieve a capability configuration's definition, use DescribeGatewayCapabilityConfiguration.
" }, "creationDate":{ "shape":"Timestamp", "documentation":"The date the gateway was created, in Unix epoch time.
" }, "lastUpdateDate":{ "shape":"Timestamp", "documentation":"The date the gateway was last updated, in Unix epoch time.
" } }, "documentation":"Contains a summary of a gateway.
" }, "GatewayVersion":{ "type":"string", "documentation":"The version of the gateway. Options include:
2 - Classic streams, V2 gateway.
3 - MQTT-enabled, V3 gateway.
The ID of the asset, in UUID format.
", "location":"querystring", "locationName":"assetId" }, "propertyId":{ "shape":"ID", "documentation":"The ID of the asset property, in UUID format.
", "location":"querystring", "locationName":"propertyId" }, "propertyAlias":{ "shape":"AssetPropertyAlias", "documentation":"The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.
The data aggregating function.
", "location":"querystring", "locationName":"aggregateTypes" }, "resolution":{ "shape":"Resolution", "documentation":"The time interval over which to aggregate data.
", "location":"querystring", "locationName":"resolution" }, "qualities":{ "shape":"Qualities", "documentation":"The quality by which to filter asset data.
", "location":"querystring", "locationName":"qualities" }, "startDate":{ "shape":"Timestamp", "documentation":"The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.
", "location":"querystring", "locationName":"startDate" }, "endDate":{ "shape":"Timestamp", "documentation":"The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.
", "location":"querystring", "locationName":"endDate" }, "timeOrdering":{ "shape":"TimeOrdering", "documentation":"The chronological sorting order of the requested information.
Default: ASCENDING
The token to be used for the next set of paginated results.
", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"GetAssetPropertyValueAggregatesMaxResults", "documentation":"The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first.
The size of the result set is equal to 1 MB.
The number of data points in the result set is equal to the value of maxResults. The maximum value of maxResults is 2500.
The requested aggregated values.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The token for the next set of results, or null if there are no additional results.
" } } }, "GetAssetPropertyValueAggregatesMaxResults":{ "type":"integer", "min":1 }, "GetAssetPropertyValueHistoryMaxResults":{ "type":"integer", "min":1 }, "GetAssetPropertyValueHistoryRequest":{ "type":"structure", "members":{ "assetId":{ "shape":"ID", "documentation":"The ID of the asset, in UUID format.
", "location":"querystring", "locationName":"assetId" }, "propertyId":{ "shape":"ID", "documentation":"The ID of the asset property, in UUID format.
", "location":"querystring", "locationName":"propertyId" }, "propertyAlias":{ "shape":"AssetPropertyAlias", "documentation":"The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.
The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.
", "location":"querystring", "locationName":"startDate" }, "endDate":{ "shape":"Timestamp", "documentation":"The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.
", "location":"querystring", "locationName":"endDate" }, "qualities":{ "shape":"Qualities", "documentation":"The quality by which to filter asset data.
", "location":"querystring", "locationName":"qualities" }, "timeOrdering":{ "shape":"TimeOrdering", "documentation":"The chronological sorting order of the requested information.
Default: ASCENDING
The token to be used for the next set of paginated results.
", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"GetAssetPropertyValueHistoryMaxResults", "documentation":"The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first.
The size of the result set is equal to 4 MB.
The number of data points in the result set is equal to the value of maxResults. The maximum value of maxResults is 20000.
The asset property's value history.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The token for the next set of results, or null if there are no additional results.
" } } }, "GetAssetPropertyValueRequest":{ "type":"structure", "members":{ "assetId":{ "shape":"ID", "documentation":"The ID of the asset, in UUID format.
", "location":"querystring", "locationName":"assetId" }, "propertyId":{ "shape":"ID", "documentation":"The ID of the asset property, in UUID format.
", "location":"querystring", "locationName":"propertyId" }, "propertyAlias":{ "shape":"AssetPropertyAlias", "documentation":"The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.
The current asset property value.
" } } }, "GetCaptureDataNextToken":{ "type":"string", "documentation":"Pagination token for retrieving the next chunk of video data.
", "max":4096, "min":1 }, "GetCaptureDataRequest":{ "type":"structure", "required":[ "workspaceName", "startTime", "endTime" ], "members":{ "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace that contains the capture source.
", "location":"uri", "locationName":"workspaceName" }, "startTime":{ "shape":"TimeInNanos", "documentation":"The start time for the video data range.
" }, "endTime":{ "shape":"TimeInNanos", "documentation":"The end time for the video data range. Must be greater than startTime.
" }, "timeSeriesId":{ "shape":"TimeSeriesId", "documentation":"The time series ID that identifies the capture source. Mutually exclusive with propertyAlias.
" }, "propertyAlias":{ "shape":"AssetPropertyAlias", "documentation":"The property alias that identifies the capture source. Mutually exclusive with timeSeriesId.
" }, "formatSettings":{ "shape":"FormatSettings", "documentation":"The optional format settings for the output.
" }, "nextToken":{ "shape":"GetCaptureDataNextToken", "documentation":"The token from a previous response used to continue retrieving data.
" } }, "documentation":"Request to retrieve video data for a specific time range. Exactly one of timeSeriesId or propertyAlias must be provided.
" }, "GetCaptureDataResponse":{ "type":"structure", "required":[ "data", "startTime", "endTime", "dataType" ], "members":{ "data":{ "shape":"CaptureBlob", "documentation":"The binary video data.
" }, "startTime":{ "shape":"TimeInNanos", "documentation":"The actual start time of the returned data.
" }, "endTime":{ "shape":"TimeInNanos", "documentation":"The actual end time of the returned data.
" }, "dataType":{ "shape":"VideoDataType", "documentation":"The type of the returned data.
" }, "nextToken":{ "shape":"GetCaptureDataNextToken", "documentation":"The token used to retrieve the next chunk. Absent if no more data is available.
" } }, "documentation":"Response containing the video data.
" }, "GetInterpolatedAssetPropertyValuesRequest":{ "type":"structure", "required":[ "startTimeInSeconds", "endTimeInSeconds", "quality", "intervalInSeconds", "type" ], "members":{ "assetId":{ "shape":"ID", "documentation":"The ID of the asset, in UUID format.
", "location":"querystring", "locationName":"assetId" }, "propertyId":{ "shape":"ID", "documentation":"The ID of the asset property, in UUID format.
", "location":"querystring", "locationName":"propertyId" }, "propertyAlias":{ "shape":"AssetPropertyAlias", "documentation":"The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.
The exclusive start of the range from which to interpolate data, expressed in seconds in Unix epoch time.
", "location":"querystring", "locationName":"startTimeInSeconds" }, "startTimeOffsetInNanos":{ "shape":"OffsetInNanos", "documentation":"The nanosecond offset converted from startTimeInSeconds.
The inclusive end of the range from which to interpolate data, expressed in seconds in Unix epoch time.
", "location":"querystring", "locationName":"endTimeInSeconds" }, "endTimeOffsetInNanos":{ "shape":"OffsetInNanos", "documentation":"The nanosecond offset converted from endTimeInSeconds.
The quality of the asset property value. You can use this parameter as a filter to choose only the asset property values that have a specific quality.
", "location":"querystring", "locationName":"quality" }, "intervalInSeconds":{ "shape":"IntervalInSeconds", "documentation":"The time interval in seconds over which to interpolate data. Each interval starts when the previous one ends.
", "location":"querystring", "locationName":"intervalInSeconds" }, "nextToken":{ "shape":"NextToken", "documentation":"The token to be used for the next set of paginated results.
", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxInterpolatedResults", "documentation":"The maximum number of results to return for each paginated request. If not specified, the default value is 10.
", "location":"querystring", "locationName":"maxResults" }, "type":{ "shape":"InterpolationType", "documentation":"The interpolation type.
Valid values: LINEAR_INTERPOLATION | LOCF_INTERPOLATION
LINEAR_INTERPOLATION – Estimates missing data using linear interpolation.
For example, you can use this operation to return the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days. If the interpolation starts July 1, 2021, at 9 AM, IoT SiteWise returns the first interpolated value on July 2, 2021, at 9 AM, the second interpolated value on July 3, 2021, at 9 AM, and so on.
LOCF_INTERPOLATION – Estimates missing data using last observation carried forward interpolation
If no data point is found for an interval, IoT SiteWise returns the last observed data point for the previous interval and carries forward this interpolated value until a new data point is found.
For example, you can get the state of an on-off valve every 24 hours over a duration of 7 days. If the interpolation starts July 1, 2021, at 9 AM, IoT SiteWise returns the last observed data point between July 1, 2021, at 9 AM and July 2, 2021, at 9 AM as the first interpolated value. If a data point isn't found after 9 AM on July 2, 2021, IoT SiteWise uses the same interpolated value for the rest of the days.
The query interval for the window, in seconds. IoT SiteWise computes each interpolated value by using data points from the timestamp of each interval, minus the window to the timestamp of each interval plus the window. If not specified, the window ranges between the start time minus the interval and the end time plus the interval.
If you specify a value for the intervalWindowInSeconds parameter, the value for the type parameter must be LINEAR_INTERPOLATION.
If a data point isn't found during the specified query window, IoT SiteWise won't return an interpolated value for the interval. This indicates that there's a gap in the ingested data points.
For example, you can get the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days. If the interpolation starts on July 1, 2021, at 9 AM with a window of 2 hours, IoT SiteWise uses the data points from 7 AM (9 AM minus 2 hours) to 11 AM (9 AM plus 2 hours) on July 2, 2021 to compute the first interpolated value. Next, IoT SiteWise uses the data points from 7 AM (9 AM minus 2 hours) to 11 AM (9 AM plus 2 hours) on July 3, 2021 to compute the second interpolated value, and so on.
", "location":"querystring", "locationName":"intervalWindowInSeconds" } } }, "GetInterpolatedAssetPropertyValuesResponse":{ "type":"structure", "required":["interpolatedAssetPropertyValues"], "members":{ "interpolatedAssetPropertyValues":{ "shape":"InterpolatedAssetPropertyValues", "documentation":"The requested interpolated values.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The token for the next set of results, or null if there are no additional results.
" } } }, "GetQueryResultsRequest":{ "type":"structure", "required":[ "workspaceName", "queryId" ], "members":{ "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace associated with the query.
", "location":"uri", "locationName":"workspaceName" }, "queryId":{ "shape":"QueryId", "documentation":"The unique identifier for the query execution.
", "location":"uri", "locationName":"queryId" }, "maxResults":{ "shape":"QueryMaxResults", "documentation":"The maximum number of results to return for each paginated request.
", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"QueryNextToken", "documentation":"The token to be used for the next set of paginated results.
", "location":"querystring", "locationName":"nextToken" } } }, "GetQueryResultsResponse":{ "type":"structure", "members":{ "columnInfo":{ "shape":"ColumnInformationList", "documentation":"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.
" }, "rows":{ "shape":"RowList", "documentation":"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.
" }, "nextToken":{ "shape":"QueryNextToken", "documentation":"The token for the next set of results, or null if there are no additional results.
" } }, "documentation":"Contains the response for the GetQueryResults operation.
" }, "GetSearchResultsRequest":{ "type":"structure", "required":[ "searchId", "workspaceName" ], "members":{ "searchId":{ "shape":"SearchId", "documentation":"The identifier of the search whose results are retrieved.
", "location":"uri", "locationName":"searchId" }, "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace the search belongs to.
", "location":"uri", "locationName":"workspaceName" }, "maxResults":{ "shape":"GetSearchResultsRequestMaxResultsInteger", "documentation":"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.
", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "documentation":"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.
", "location":"querystring", "locationName":"nextToken" } }, "documentation":"Input for the GetSearchResults operation.
" }, "GetSearchResultsRequestMaxResultsInteger":{ "type":"integer", "box":true, "max":10000, "min":1 }, "GetSearchResultsResponse":{ "type":"structure", "required":["searchResults"], "members":{ "searchResults":{ "shape":"SearchResultList", "documentation":"A page of search results, ordered by descending relevance score.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The pagination token to use in a subsequent GetSearchResults call to retrieve the next page. Absent when there are no more results.
" } }, "documentation":"Output of the GetSearchResults operation.
" }, "Greengrass":{ "type":"structure", "required":["groupArn"], "members":{ "groupArn":{ "shape":"ARN", "documentation":"The ARN of the Greengrass group. For more information about how to find a group's ARN, see ListGroups and GetGroup in the IoT Greengrass V1 API Reference.
" } }, "documentation":"Contains details for a gateway that runs on IoT Greengrass. To create a gateway that runs on IoT Greengrass, you must add the IoT SiteWise connector to a Greengrass group and deploy it. Your Greengrass group must also have permissions to upload data to IoT SiteWise. For more information, see Ingesting data using a gateway in the IoT SiteWise User Guide.
" }, "GreengrassV2":{ "type":"structure", "required":["coreDeviceThingName"], "members":{ "coreDeviceThingName":{ "shape":"CoreDeviceThingName", "documentation":"The name of the IoT thing for your IoT Greengrass V2 core device.
" }, "coreDeviceOperatingSystem":{ "shape":"CoreDeviceOperatingSystem", "documentation":"The operating system of the core device in IoT Greengrass V2. Specifying the operating system is required for MQTT-enabled, V3 gateways (gatewayVersion 3) and not applicable for Classic stream, V2 gateways (gatewayVersion 2).
Contains details for a gateway that runs on IoT Greengrass V2. To create a gateway that runs on IoT Greengrass V2, you must deploy the IoT SiteWise Edge component to your gateway device. Your Greengrass device role must use the AWSIoTSiteWiseEdgeAccess policy. For more information, see Using IoT SiteWise at the edge in the IoT SiteWise User Guide.
A caller-supplied identifier used to group related searches together.
", "max":36, "min":2, "pattern":"[a-zA-Z0-9][a-zA-Z0-9-]*" }, "GroupIdFilterList":{ "type":"list", "member":{"shape":"GroupId"}, "documentation":"A filter on group identifier. Matches searches whose groupId is any of the listed values.
The IAM Identity Center ID of the group.
" } }, "documentation":"Contains information for a group identity in an access policy.
" }, "HierarchyMapping":{ "type":"structure", "required":[ "assetModelHierarchyId", "interfaceAssetModelHierarchyId" ], "members":{ "assetModelHierarchyId":{ "shape":"ID", "documentation":"The ID of the hierarchy in the asset model where the interface is applied.
" }, "interfaceAssetModelHierarchyId":{ "shape":"ID", "documentation":"The ID of the hierarchy in the interface asset model.
" } }, "documentation":"Maps a hierarchy from an interface asset model to a hierarchy in the asset model where the interface is applied.
" }, "HierarchyMappings":{ "type":"list", "member":{"shape":"HierarchyMapping"} }, "IAMRoleIdentity":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"IamArn", "documentation":"The ARN of the IAM role. For more information, see IAM ARNs in the IAM User Guide.
" } }, "documentation":"Contains information about an Identity and Access Management role. For more information, see IAM roles in the IAM User Guide.
" }, "IAMUserIdentity":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"IamArn", "documentation":"The ARN of the IAM user. For more information, see IAM ARNs in the IAM User Guide.
If you delete the IAM user, access policies that contain this identity include an empty arn. You can delete the access policy for the IAM user that no longer exists.
Contains information about an Identity and Access Management user.
" }, "ID":{ "type":"string", "max":36, "min":36, "pattern":"^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "IDs":{ "type":"list", "member":{"shape":"ID"}, "max":100, "min":1 }, "IamArn":{ "type":"string", "max":1600, "min":1, "pattern":"^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\\/_\\.\\+=,@]+$" }, "IamRoleArn":{ "type":"string", "documentation":"IAM Role ARN with strict validation requiring a 12-digit account ID. https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html
", "max":2048, "min":20, "pattern":"arn:aws(-cn|-us-gov)?:iam::\\d{12}:role/[\\w+=,.@/-]+", "sensitive":true }, "Identity":{ "type":"structure", "members":{ "user":{ "shape":"UserIdentity", "documentation":"An IAM Identity Center user identity.
" }, "group":{ "shape":"GroupIdentity", "documentation":"An IAM Identity Center group identity.
" }, "iamUser":{ "shape":"IAMUserIdentity", "documentation":"An IAM user identity.
" }, "iamRole":{ "shape":"IAMRoleIdentity", "documentation":"An IAM role identity.
" } }, "documentation":"Contains an identity that can access an IoT SiteWise Monitor resource.
Currently, you can't use Amazon Web Services API operations to retrieve IAM Identity Center identity IDs. You can find the IAM Identity Center identity IDs in the URL of user and group pages in the IAM Identity Center console.
The ID of an existing image. Specify this parameter to keep an existing image.
" }, "file":{"shape":"ImageFile"} }, "documentation":"Contains an image that is one of the following:
An image file. Choose this option to upload a new image.
The ID of an existing image. Choose this option to keep an existing image.
The image file contents, represented as a base64-encoded string. The file size must be less than 1 MB.
" }, "type":{ "shape":"ImageFileType", "documentation":"The file type of the image.
" } }, "documentation":"Contains an image file.
" }, "ImageFileData":{ "type":"blob", "max":1500000, "min":1 }, "ImageFileType":{ "type":"string", "enum":["PNG"] }, "ImageLocation":{ "type":"structure", "required":[ "id", "url" ], "members":{ "id":{ "shape":"ID", "documentation":"The ID of the image.
" }, "url":{ "shape":"Url", "documentation":"The URL where the image is available. The URL is valid for 15 minutes so that you can view and download the image
" } }, "documentation":"Contains an image that is uploaded to IoT SiteWise and available at a URL.
" }, "InputProperties":{ "type":"string", "max":67, "min":4, "pattern":"^\\$\\{[a-z][a-z0-9_]*\\}" }, "InterfaceDetails":{ "type":"list", "member":{"shape":"InterfaceRelationship"} }, "InterfaceRelationship":{ "type":"structure", "required":["id"], "members":{ "id":{ "shape":"ID", "documentation":"The ID of the asset model that has the interface applied to it.
" } }, "documentation":"Contains information about the relationship between an asset model and an interface asset model that is applied to it.
" }, "InterfaceRelationshipSummaries":{ "type":"list", "member":{"shape":"InterfaceRelationshipSummary"} }, "InterfaceRelationshipSummary":{ "type":"structure", "required":["id"], "members":{ "id":{ "shape":"ID", "documentation":"The ID of the asset model that has the interface applied to it.
" } }, "documentation":"Contains summary information about an interface relationship, which defines how an interface is applied to an asset model. This summary provides the essential identifiers needed to retrieve detailed information about the relationship.
" }, "InterfaceSummaries":{ "type":"list", "member":{"shape":"InterfaceSummary"} }, "InterfaceSummary":{ "type":"structure", "required":[ "interfaceAssetModelId", "interfaceAssetModelPropertyId" ], "members":{ "interfaceAssetModelId":{ "shape":"ID", "documentation":"The ID of the interface asset model that contains this property.
" }, "interfaceAssetModelPropertyId":{ "shape":"ID", "documentation":"The ID of the property in the interface asset model that corresponds to this property.
" } }, "documentation":"Contains summary information about an interface that a property belongs to.
" }, "InternalFailureException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"IoT SiteWise can't process your request right now. Try again later.
", "error":{"httpStatusCode":500}, "exception":true, "fault":true }, "InterpolatedAssetPropertyValue":{ "type":"structure", "required":[ "timestamp", "value" ], "members":{ "timestamp":{"shape":"TimeInNanos"}, "value":{"shape":"Variant"} }, "documentation":"Contains information about an interpolated asset property value.
" }, "InterpolatedAssetPropertyValues":{ "type":"list", "member":{"shape":"InterpolatedAssetPropertyValue"} }, "InterpolationType":{ "type":"string", "max":256, "min":1 }, "Interval":{ "type":"string", "max":23, "min":2 }, "IntervalInSeconds":{ "type":"long", "max":320000000, "min":1 }, "IntervalWindowInSeconds":{ "type":"long", "max":320000000, "min":1 }, "InvalidRequestException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
", "error":{"httpStatusCode":400}, "exception":true }, "InvocationOutput":{ "type":"structure", "members":{ "message":{ "shape":"String", "documentation":"The text message of the SiteWise Assistant's response.
" }, "citations":{ "shape":"Citations", "documentation":"A list of citations, and related information for the SiteWise Assistant's response.
" } }, "documentation":"This contains the SiteWise Assistant's response and the corresponding citation.
", "event":true }, "InvokeAssistantRequest":{ "type":"structure", "required":["message"], "members":{ "conversationId":{ "shape":"ConversationId", "documentation":"The ID assigned to a conversation. IoT SiteWise automatically generates a unique ID for you, and this parameter is never required. However, if you prefer to have your own ID, you must specify it here in UUID format. If you specify your own ID, it must be globally unique.
" }, "message":{ "shape":"MessageInput", "documentation":"A text message sent to the SiteWise Assistant by the user.
" }, "enableTrace":{ "shape":"PrimitiveBoolean", "documentation":"Specifies if to turn trace on or not. It is used to track the SiteWise Assistant's reasoning, and data access process.
" } } }, "InvokeAssistantResponse":{ "type":"structure", "required":[ "body", "conversationId" ], "members":{ "body":{"shape":"ResponseStream"}, "conversationId":{ "shape":"ConversationId", "documentation":"The ID of the conversation, in UUID format. This ID uniquely identifies the conversation within IoT SiteWise.
", "location":"header", "locationName":"x-amz-iotsitewise-assistant-conversation-id" } }, "payload":"body" }, "IotCoreThingName":{ "type":"string", "max":128, "min":1, "pattern":"^[a-zA-Z0-9:_-]+$" }, "JobConfiguration":{ "type":"structure", "members":{ "fileFormat":{ "shape":"FileFormat", "documentation":"The file format of the data in S3.
" } }, "documentation":"Contains the configuration information of a job, such as the file format used to save data in Amazon S3.
" }, "JobStatus":{ "type":"string", "enum":[ "PENDING", "CANCELLED", "RUNNING", "COMPLETED", "FAILED", "COMPLETED_WITH_FAILURES" ] }, "JobSummaries":{ "type":"list", "member":{"shape":"JobSummary"} }, "JobSummary":{ "type":"structure", "required":[ "id", "name", "status" ], "members":{ "id":{ "shape":"ID", "documentation":"The ID of the job.
" }, "name":{ "shape":"Name", "documentation":"The unique name that helps identify the job request.
" }, "status":{ "shape":"JobStatus", "documentation":"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.
Contains the job summary information.
" }, "JobType":{ "type":"string", "documentation":"<p>The type of enrichment job, derived from the job configuration union member</p>", "enum":["EVENT_DETECTION"] }, "KendraSourceDetail":{ "type":"structure", "required":[ "knowledgeBaseArn", "roleArn" ], "members":{ "knowledgeBaseArn":{ "shape":"ARN", "documentation":"The knowledgeBaseArn details for the Kendra dataset source.
The roleARN details for the Kendra dataset source.
The source details for the Kendra dataset source.
" }, "KmsKeyId":{ "type":"string", "max":2048, "min":1 }, "LimitExceededException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"You've reached the quota for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.
For more information, see Quotas in the IoT SiteWise User Guide.
", "error":{"httpStatusCode":410}, "exception":true }, "ListAccessPoliciesRequest":{ "type":"structure", "members":{ "identityType":{ "shape":"IdentityType", "documentation":"The type of identity (IAM Identity Center user, IAM Identity Center group, or IAM user). This parameter is required if you specify identityId.
The ID of the identity. This parameter is required if you specify USER or GROUP for identityType.
The type of resource (portal or project). This parameter is required if you specify resourceId.
The ID of the resource. This parameter is required if you specify resourceType.
The ARN of the IAM user. For more information, see IAM ARNs in the IAM User Guide. This parameter is required if you specify IAM for identityType.
The token to be used for the next set of paginated results.
", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return for each paginated request.
Default: 50
", "location":"querystring", "locationName":"maxResults" } } }, "ListAccessPoliciesResponse":{ "type":"structure", "required":["accessPolicySummaries"], "members":{ "accessPolicySummaries":{ "shape":"AccessPolicySummaries", "documentation":"A list that summarizes each access policy.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The token for the next set of results, or null if there are no additional results.
" } } }, "ListActionsRequest":{ "type":"structure", "required":[ "targetResourceType", "targetResourceId" ], "members":{ "targetResourceType":{ "shape":"TargetResourceType", "documentation":"The type of resource.
", "location":"querystring", "locationName":"targetResourceType" }, "targetResourceId":{ "shape":"ID", "documentation":"The ID of the target resource.
", "location":"querystring", "locationName":"targetResourceId" }, "nextToken":{ "shape":"NextToken", "documentation":"The token to be used for the next set of paginated results.
", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return for each paginated request.
", "location":"querystring", "locationName":"maxResults" }, "resolveToResourceType":{ "shape":"ResolveToResourceType", "documentation":"The type of the resolved resource.
", "location":"querystring", "locationName":"resolveToResourceType" }, "resolveToResourceId":{ "shape":"ID", "documentation":"The ID of the resolved resource.
", "location":"querystring", "locationName":"resolveToResourceId" } } }, "ListActionsResponse":{ "type":"structure", "required":[ "actionSummaries", "nextToken" ], "members":{ "actionSummaries":{ "shape":"ActionSummaries", "documentation":"A list that summarizes the actions associated with the specified asset.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The token for the next set of results, or null if there are no additional results.
" } } }, "ListApplicationsRequest":{ "type":"structure", "members":{ "maxResults":{ "shape":"MaxResults", "documentation":"Maximum number of results to return
", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "documentation":"Next Page Token
", "location":"querystring", "locationName":"nextToken" } } }, "ListApplicationsResponse":{ "type":"structure", "required":["applications"], "members":{ "nextToken":{ "shape":"NextToken", "documentation":"Next Page Token
" }, "applications":{ "shape":"ApplicationList", "documentation":"List of applications
" } } }, "ListAssetModelCompositeModelsRequest":{ "type":"structure", "required":["assetModelId"], "members":{ "assetModelId":{ "shape":"CustomID", "documentation":"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.
The token to be used for the next set of paginated results.
", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return for each paginated request.
Default: 50
", "location":"querystring", "locationName":"maxResults" }, "assetModelVersion":{ "shape":"AssetModelVersionFilter", "documentation":"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.
A list that summarizes each composite model.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The token for the next set of results, or null if there are no additional results.
" } } }, "ListAssetModelPropertiesFilter":{ "type":"string", "enum":[ "ALL", "BASE" ] }, "ListAssetModelPropertiesRequest":{ "type":"structure", "required":["assetModelId"], "members":{ "assetModelId":{ "shape":"CustomID", "documentation":"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.
The token to be used for the next set of paginated results.
", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return for each paginated request. If not specified, the default value is 50.
", "location":"querystring", "locationName":"maxResults" }, "filter":{ "shape":"ListAssetModelPropertiesFilter", "documentation":"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
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.
A list that summarizes the properties associated with the specified asset model.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The token for the next set of results, or null if there are no additional results.
" } } }, "ListAssetModelsRequest":{ "type":"structure", "members":{ "assetModelTypes":{ "shape":"ListAssetModelsTypeFilter", "documentation":"The type of asset model. If you don't provide an assetModelTypes, all types of asset models are returned.
ASSET_MODEL – 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.
The token to be used for the next set of paginated results.
", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return for each paginated request.
Default: 50
", "location":"querystring", "locationName":"maxResults" }, "assetModelVersion":{ "shape":"AssetModelVersionFilter", "documentation":"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.
A list that summarizes each asset model.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The token for the next set of results, or null if there are no additional results.
" } } }, "ListAssetModelsTypeFilter":{ "type":"list", "member":{"shape":"AssetModelType"} }, "ListAssetPropertiesFilter":{ "type":"string", "enum":[ "ALL", "BASE" ] }, "ListAssetPropertiesRequest":{ "type":"structure", "required":["assetId"], "members":{ "assetId":{ "shape":"CustomID", "documentation":"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.
The token to be used for the next set of paginated results.
", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return for each paginated request. If not specified, the default value is 50.
", "location":"querystring", "locationName":"maxResults" }, "filter":{ "shape":"ListAssetPropertiesFilter", "documentation":"Filters the requested list of asset properties. You can choose one of the following options:
ALL – The list includes all asset properties for a given asset model ID.
BASE – The list includes only base asset properties for a given asset model ID.
Default: BASE
A list that summarizes the properties associated with the specified asset.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The token for the next set of results, or null if there are no additional results.
" } } }, "ListAssetRelationshipsRequest":{ "type":"structure", "required":[ "assetId", "traversalType" ], "members":{ "assetId":{ "shape":"CustomID", "documentation":"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.
The type of traversal to use to identify asset relationships. Choose the following option:
PATH_TO_ROOT – Identify the asset's parent assets up to the root asset. The asset that you specify in assetId is the first result in the list of assetRelationshipSummaries, and the root asset is the last result.
The token to be used for the next set of paginated results.
", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return for each paginated request.
", "location":"querystring", "locationName":"maxResults" } } }, "ListAssetRelationshipsResponse":{ "type":"structure", "required":["assetRelationshipSummaries"], "members":{ "assetRelationshipSummaries":{ "shape":"AssetRelationshipSummaries", "documentation":"A list that summarizes each asset relationship.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The token for the next set of results, or null if there are no additional results.
" } } }, "ListAssetsFilter":{ "type":"string", "enum":[ "ALL", "TOP_LEVEL" ] }, "ListAssetsRequest":{ "type":"structure", "members":{ "nextToken":{ "shape":"NextToken", "documentation":"The token to be used for the next set of paginated results.
", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return for each paginated request.
Default: 50
", "location":"querystring", "locationName":"maxResults" }, "assetModelId":{ "shape":"CustomID", "documentation":"The ID of the asset model by which to filter the list of assets. This parameter is required if you choose ALL for filter. 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.
The filter for the requested list of assets. Choose one of the following options:
ALL – The list includes all assets for a given asset model ID. The assetModelId parameter is required if you filter by ALL.
TOP_LEVEL – The list includes only top-level assets in the asset hierarchy tree.
Default: ALL
A list that summarizes each asset.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The token for the next set of results, or null if there are no additional results.
" } } }, "ListAssociatedAssetsRequest":{ "type":"structure", "required":["assetId"], "members":{ "assetId":{ "shape":"CustomID", "documentation":"The ID of the asset to query. 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.
(Optional) If you don't provide a hierarchyId, all the immediate assets in the traversalDirection will be returned.
The ID of the hierarchy by which child assets are associated to 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.)
For more information, see Asset hierarchies in the IoT SiteWise User Guide.
", "location":"querystring", "locationName":"hierarchyId" }, "traversalDirection":{ "shape":"TraversalDirection", "documentation":"The direction to list associated assets. Choose one of the following options:
CHILD – The list includes all child assets associated to the asset.
PARENT – The list includes the asset's parent asset.
Default: CHILD
The token to be used for the next set of paginated results.
", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return for each paginated request.
Default: 50
", "location":"querystring", "locationName":"maxResults" } } }, "ListAssociatedAssetsResponse":{ "type":"structure", "required":["assetSummaries"], "members":{ "assetSummaries":{ "shape":"AssociatedAssetsSummaries", "documentation":"A list that summarizes the associated assets.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The token for the next set of results, or null if there are no additional results.
" } } }, "ListBulkImportJobsFilter":{ "type":"string", "enum":[ "ALL", "PENDING", "RUNNING", "CANCELLED", "FAILED", "COMPLETED_WITH_FAILURES", "COMPLETED" ] }, "ListBulkImportJobsRequest":{ "type":"structure", "members":{ "nextToken":{ "shape":"NextToken", "documentation":"The token to be used for the next set of paginated results.
", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return for each paginated request.
", "location":"querystring", "locationName":"maxResults" }, "filter":{ "shape":"ListBulkImportJobsFilter", "documentation":"You can use a filter to select the bulk import jobs that you want to retrieve.
", "location":"querystring", "locationName":"filter" }, "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace.
", "location":"querystring", "locationName":"workspaceName" } } }, "ListBulkImportJobsResponse":{ "type":"structure", "required":["jobSummaries"], "members":{ "jobSummaries":{ "shape":"JobSummaries", "documentation":"One or more job summaries to list.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The token for the next set of results, or null if there are no additional results.
" } } }, "ListCompositionRelationshipsRequest":{ "type":"structure", "required":["assetModelId"], "members":{ "assetModelId":{ "shape":"ID", "documentation":"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.
The token to be used for the next set of paginated results.
", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return for each paginated request.
Default: 50
", "location":"querystring", "locationName":"maxResults" } } }, "ListCompositionRelationshipsResponse":{ "type":"structure", "required":["compositionRelationshipSummaries"], "members":{ "compositionRelationshipSummaries":{ "shape":"CompositionRelationshipSummaries", "documentation":"A list that summarizes each composition relationship.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The token for the next set of results, or null if there are no additional results.
" } } }, "ListComputationModelDataBindingUsagesRequest":{ "type":"structure", "required":["dataBindingValueFilter"], "members":{ "dataBindingValueFilter":{ "shape":"DataBindingValueFilter", "documentation":"A filter used to limit the returned data binding usages based on specific data binding values. You can filter by asset, asset model, asset property, or asset model property to find all computation models using these specific data sources.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The token used for the next set of paginated results.
" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results returned for each paginated request.
" } } }, "ListComputationModelDataBindingUsagesResponse":{ "type":"structure", "required":["dataBindingUsageSummaries"], "members":{ "dataBindingUsageSummaries":{ "shape":"ComputationModelDataBindingUsageSummaries", "documentation":"A list of summaries describing the data binding usages across computation models. Each summary includes the computation model IDs and the matched data binding details.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The token for the next set of paginated results, or null if there are no additional results.
" } } }, "ListComputationModelResolveToResourcesRequest":{ "type":"structure", "required":["computationModelId"], "members":{ "computationModelId":{ "shape":"ID", "documentation":"The ID of the computation model for which to list resolved resources.
", "location":"uri", "locationName":"computationModelId" }, "nextToken":{ "shape":"NextToken", "documentation":"The token used for the next set of paginated results.
", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results returned for each paginated request.
", "location":"querystring", "locationName":"maxResults" } } }, "ListComputationModelResolveToResourcesResponse":{ "type":"structure", "required":["computationModelResolveToResourceSummaries"], "members":{ "computationModelResolveToResourceSummaries":{ "shape":"ComputationModelResolveToResourceSummaries", "documentation":"A list of summaries describing the distinct resources that this computation model resolves to when actions were executed.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The token for the next set of paginated results, or null if there are no additional results.
" } } }, "ListComputationModelsRequest":{ "type":"structure", "members":{ "computationModelType":{ "shape":"ComputationModelType", "documentation":"The type of computation model. If a computationModelType is not provided, all types of computation models are returned.
The token to be used for the next set of paginated results.
", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return for each paginated request.
", "location":"querystring", "locationName":"maxResults" } } }, "ListComputationModelsResponse":{ "type":"structure", "required":["computationModelSummaries"], "members":{ "computationModelSummaries":{ "shape":"ComputationModelSummaries", "documentation":"A list summarizing each computation model.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The token for the next set of results, or null if there are no additional results.
" } } }, "ListDashboardsRequest":{ "type":"structure", "required":["projectId"], "members":{ "projectId":{ "shape":"ID", "documentation":"The ID of the project.
", "location":"querystring", "locationName":"projectId" }, "nextToken":{ "shape":"NextToken", "documentation":"The token to be used for the next set of paginated results.
", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return for each paginated request.
Default: 50
", "location":"querystring", "locationName":"maxResults" } } }, "ListDashboardsResponse":{ "type":"structure", "required":["dashboardSummaries"], "members":{ "dashboardSummaries":{ "shape":"DashboardSummaries", "documentation":"A list that summarizes each dashboard in the project.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The token for the next set of results, or null if there are no additional results.
" } } }, "ListDatasetDataSegmentRelationshipsRequest":{ "type":"structure", "required":[ "datasetId", "workspaceName" ], "members":{ "datasetId":{ "shape":"ID", "documentation":"The ID of the session dataset to list data segment relationships for.
", "location":"uri", "locationName":"datasetId" }, "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace that contains the dataset.
", "location":"querystring", "locationName":"workspaceName" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return for each paginated request. Default: 50.
", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "documentation":"The token to be used for the next set of paginated results.
", "location":"querystring", "locationName":"nextToken" } } }, "ListDatasetDataSegmentRelationshipsResponse":{ "type":"structure", "required":["dataSegmentRelationshipSummaries"], "members":{ "dataSegmentRelationshipSummaries":{ "shape":"DataSegmentRelationshipSummaries", "documentation":"A list that summarizes each data segment relationship.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The token for the next set of results, or null if there are no additional results.
" } } }, "ListDatasetDataSegmentsRequest":{ "type":"structure", "required":[ "datasetId", "workspaceName" ], "members":{ "datasetId":{ "shape":"ID", "documentation":"The ID of the dataset.
", "location":"uri", "locationName":"datasetId" }, "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace that contains the dataset.
", "location":"querystring", "locationName":"workspaceName" }, "datasetVersion":{ "shape":"Version", "documentation":"The version of the dataset to list data segments for.
", "location":"querystring", "locationName":"datasetVersion" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return for each paginated request. Default: 50.
", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "documentation":"The token to be used for the next set of paginated results.
", "location":"querystring", "locationName":"nextToken" } } }, "ListDatasetDataSegmentsResponse":{ "type":"structure", "required":["dataSegments"], "members":{ "dataSegments":{ "shape":"DataSegmentSummaries", "documentation":"A list that summarizes each data segment.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The token for the next set of results, or null if there are no additional results.
" } } }, "ListDatasetExportJobsRequest":{ "type":"structure", "required":["workspaceName"], "members":{ "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace whose dataset export jobs should be listed.
", "location":"uri", "locationName":"workspaceName" }, "filter":{ "shape":"DatasetExportJobFilter", "documentation":"The optional filter that returns only jobs matching the given filter value. Defaults to ALL.
", "location":"querystring", "locationName":"filter" }, "maxResults":{ "shape":"ListExportJobsMaxResults", "documentation":"The maximum number of results to return for each paginated request.
", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"ListExportJobsNextToken", "documentation":"The token to be used for the next set of paginated results.
", "location":"querystring", "locationName":"nextToken" } }, "documentation":"Request to list dataset export jobs for a workspace.
" }, "ListDatasetExportJobsResponse":{ "type":"structure", "required":["jobs"], "members":{ "jobs":{ "shape":"ExportJobSummaryList", "documentation":"A list of dataset export job summaries.
" }, "nextToken":{ "shape":"ListExportJobsNextToken", "documentation":"The token for the next set of results, or null if there are no additional results.
" } }, "documentation":"Response for list dataset export jobs request.
" }, "ListDatasetsRequest":{ "type":"structure", "required":["sourceType"], "members":{ "sourceType":{ "shape":"DatasetSourceType", "documentation":"The type of data source for the dataset.
", "location":"querystring", "locationName":"sourceType" }, "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace to filter datasets by.
", "location":"querystring", "locationName":"workspaceName" }, "datasetType":{ "shape":"DatasetTypeEnum", "documentation":"The type of dataset to filter by: a session dataset, a curated dataset, or a connection to an external datasource.
", "location":"querystring", "locationName":"datasetType" }, "nextToken":{ "shape":"NextToken", "documentation":"The token for the next set of results, or null if there are no additional results.
", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return for each paginated request.
", "location":"querystring", "locationName":"maxResults" } } }, "ListDatasetsResponse":{ "type":"structure", "required":["datasetSummaries"], "members":{ "datasetSummaries":{ "shape":"DatasetSummaries", "documentation":"A list that summarizes the dataset response.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The token for the next set of results, or null if there are no additional results.
" }, "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace.
" } } }, "ListEnrichmentJobsRequest":{ "type":"structure", "required":["workspaceName"], "members":{ "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the IoT SiteWise workspace to list enrichment jobs from.
", "location":"uri", "locationName":"workspaceName" }, "datasetId":{ "shape":"ID", "documentation":"Filter jobs by dataset ID. Returns only jobs analyzing data from the specified dataset.
", "location":"querystring", "locationName":"datasetId" }, "propertyAlias":{ "shape":"AssetPropertyAlias", "documentation":"Filter by property alias (human-readable sensor name). Specify either propertyAlias or timeSeriesId, but not both. Returns only jobs analyzing the specified property alias.
", "location":"querystring", "locationName":"propertyAlias" }, "timeSeriesId":{ "shape":"TimeSeriesId", "documentation":"Filter by time series ID (system identifier). Specify either timeSeriesId or propertyAlias, but not both. Returns only jobs analyzing the specified time series.
", "location":"querystring", "locationName":"timeSeriesId" }, "status":{ "shape":"EnrichmentJobStatus", "documentation":"Filter by job status. Returns only jobs in the specified status. Use RUNNING to find active jobs, or FAILED to identify jobs requiring attention.
", "location":"querystring", "locationName":"status" }, "jobType":{ "shape":"JobType", "documentation":"Filter by enrichment job type. Currently only EVENT_DETECTION is supported. Use this filter to future-proof queries when additional job types are added.
", "location":"querystring", "locationName":"jobType" }, "startDate":{ "shape":"Timestamp", "documentation":"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).
", "location":"querystring", "locationName":"startDate" }, "endDate":{ "shape":"Timestamp", "documentation":"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).
", "location":"querystring", "locationName":"endDate" }, "maxResults":{ "shape":"MaxResults", "documentation":"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.
", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "documentation":"Pagination token from a previous ListEnrichmentJobs response. Include this token to retrieve the next page of results. Omit for the first request.
", "location":"querystring", "locationName":"nextToken" } } }, "ListEnrichmentJobsResponse":{ "type":"structure", "required":["jobs"], "members":{ "jobs":{ "shape":"EnrichmentJobSummaries", "documentation":"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.
" }, "nextToken":{ "shape":"NextToken", "documentation":"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.
" } } }, "ListExecutionsRequest":{ "type":"structure", "required":[ "targetResourceType", "targetResourceId" ], "members":{ "targetResourceType":{ "shape":"TargetResourceType", "documentation":"The type of the target resource.
", "location":"querystring", "locationName":"targetResourceType" }, "targetResourceId":{ "shape":"ID", "documentation":"The ID of the target resource.
", "location":"querystring", "locationName":"targetResourceId" }, "resolveToResourceType":{ "shape":"ResolveToResourceType", "documentation":"The type of the resolved resource.
", "location":"querystring", "locationName":"resolveToResourceType" }, "resolveToResourceId":{ "shape":"ID", "documentation":"The ID of the resolved resource.
", "location":"querystring", "locationName":"resolveToResourceId" }, "nextToken":{ "shape":"NextToken", "documentation":"The token used for the next set of paginated results.
", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results returned for each paginated request.
", "location":"querystring", "locationName":"maxResults" }, "actionType":{ "shape":"Name", "documentation":"The type of action exectued.
", "location":"querystring", "locationName":"actionType" } } }, "ListExecutionsResponse":{ "type":"structure", "required":["executionSummaries"], "members":{ "executionSummaries":{ "shape":"ExecutionSummaries", "documentation":"Contains the list of execution summaries of the computation models.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The token for the next set of results, or null if there are no additional results.
" } } }, "ListExportJobsMaxResults":{ "type":"integer", "documentation":"<p>The maximum number of results to return for each paginated request.</p>", "box":true, "max":250, "min":1 }, "ListExportJobsNextToken":{ "type":"string", "documentation":"<p>The token to be used for the next set of paginated results.</p>", "max":4096, "min":1 }, "ListGatewaysRequest":{ "type":"structure", "members":{ "nextToken":{ "shape":"NextToken", "documentation":"The token to be used for the next set of paginated results.
", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return for each paginated request.
Default: 50
", "location":"querystring", "locationName":"maxResults" } } }, "ListGatewaysResponse":{ "type":"structure", "required":["gatewaySummaries"], "members":{ "gatewaySummaries":{ "shape":"GatewaySummaries", "documentation":"A list that summarizes each gateway.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The token for the next set of results, or null if there are no additional results.
" } } }, "ListInterfaceRelationshipsRequest":{ "type":"structure", "required":["interfaceAssetModelId"], "members":{ "interfaceAssetModelId":{ "shape":"CustomID", "documentation":"The ID of the interface asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID.
", "location":"uri", "locationName":"interfaceAssetModelId" }, "nextToken":{ "shape":"NextToken", "documentation":"The token to be used for the next set of paginated results.
", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return for each paginated request. Default: 50
", "location":"querystring", "locationName":"maxResults" } } }, "ListInterfaceRelationshipsResponse":{ "type":"structure", "required":["interfaceRelationshipSummaries"], "members":{ "interfaceRelationshipSummaries":{ "shape":"InterfaceRelationshipSummaries", "documentation":"A list that summarizes each interface relationship.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The token for the next set of results, or null if there are no additional results.
" } } }, "ListPipelineExecutionsRequest":{ "type":"structure", "required":[ "workspaceName", "pipelineName" ], "members":{ "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace.
", "location":"uri", "locationName":"workspaceName" }, "pipelineName":{ "shape":"ResourceName", "documentation":"The name of the pipeline.
", "location":"uri", "locationName":"pipelineName" }, "nextToken":{ "shape":"PaginationToken", "documentation":"The token to be used for the next set of paginated results.
", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"ListPipelineExecutionsRequestMaxResultsInteger", "documentation":"The maximum number of results to return per request. This is an upper bound; the actual number of results may be less. Default: 50.
", "location":"querystring", "locationName":"maxResults" }, "state":{ "shape":"PipelineExecutionState", "documentation":"Filter by execution state. If not specified, executions in all states are returned.
", "location":"querystring", "locationName":"state" }, "startTimeAfter":{ "shape":"Timestamp", "documentation":"Inclusive lower bound on execution start time (ISO-8601). Only executions with startTime >= startTimeAfter are returned. Cannot be combined with endTimeAfter or endTimeBefore.
", "location":"querystring", "locationName":"startTimeAfter" }, "startTimeBefore":{ "shape":"Timestamp", "documentation":"Exclusive upper bound on execution start time (ISO-8601). Only executions with startTime < startTimeBefore are returned. Cannot be combined with endTimeAfter or endTimeBefore.
", "location":"querystring", "locationName":"startTimeBefore" }, "endTimeAfter":{ "shape":"Timestamp", "documentation":"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.
", "location":"querystring", "locationName":"endTimeAfter" }, "endTimeBefore":{ "shape":"Timestamp", "documentation":"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.
", "location":"querystring", "locationName":"endTimeBefore" } }, "documentation":"Request structure for ListPipelineExecutions operation.
" }, "ListPipelineExecutionsRequestMaxResultsInteger":{ "type":"integer", "box":true, "max":250, "min":1 }, "ListPipelineExecutionsResponse":{ "type":"structure", "required":["pipelineExecutionSummaries"], "members":{ "pipelineExecutionSummaries":{ "shape":"PipelineExecutionSummaryList", "documentation":"A list that summarizes each pipeline execution.
" }, "nextToken":{ "shape":"PaginationToken", "documentation":"The token to be used for the next set of paginated results.
" } }, "documentation":"Response structure for ListPipelineExecutions operation.
" }, "ListPipelinesRequest":{ "type":"structure", "required":["workspaceName"], "members":{ "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace.
", "location":"uri", "locationName":"workspaceName" }, "nextToken":{ "shape":"PaginationToken", "documentation":"The token to be used for the next set of paginated results.
", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"ListPipelinesRequestMaxResultsInteger", "documentation":"The maximum number of results to return for each paginated request. Default: 50.
", "location":"querystring", "locationName":"maxResults" } }, "documentation":"Request structure for ListPipelines operation.
" }, "ListPipelinesRequestMaxResultsInteger":{ "type":"integer", "box":true, "max":250, "min":1 }, "ListPipelinesResponse":{ "type":"structure", "required":["pipelineSummaries"], "members":{ "pipelineSummaries":{ "shape":"PipelineSummaries", "documentation":"A list that summarizes each pipeline in the workspace.
" }, "nextToken":{ "shape":"PaginationToken", "documentation":"The token to be used for the next set of paginated results.
" } }, "documentation":"Response structure for ListPipelines operation.
" }, "ListPortalsRequest":{ "type":"structure", "members":{ "nextToken":{ "shape":"NextToken", "documentation":"The token to be used for the next set of paginated results.
", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return for each paginated request.
Default: 50
", "location":"querystring", "locationName":"maxResults" } } }, "ListPortalsResponse":{ "type":"structure", "members":{ "portalSummaries":{ "shape":"PortalSummaries", "documentation":"A list that summarizes each portal.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The token for the next set of results, or null if there are no additional results.
" } } }, "ListProjectAssetsRequest":{ "type":"structure", "required":["projectId"], "members":{ "projectId":{ "shape":"ID", "documentation":"The ID of the project.
", "location":"uri", "locationName":"projectId" }, "nextToken":{ "shape":"NextToken", "documentation":"The token to be used for the next set of paginated results.
", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return for each paginated request.
Default: 50
", "location":"querystring", "locationName":"maxResults" } } }, "ListProjectAssetsResponse":{ "type":"structure", "required":["assetIds"], "members":{ "assetIds":{ "shape":"AssetIDs", "documentation":"A list that contains the IDs of each asset associated with the project.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The token for the next set of results, or null if there are no additional results.
" } } }, "ListProjectsRequest":{ "type":"structure", "required":["portalId"], "members":{ "portalId":{ "shape":"ID", "documentation":"The ID of the portal.
", "location":"querystring", "locationName":"portalId" }, "nextToken":{ "shape":"NextToken", "documentation":"The token to be used for the next set of paginated results.
", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return for each paginated request.
Default: 50
", "location":"querystring", "locationName":"maxResults" } } }, "ListProjectsResponse":{ "type":"structure", "required":["projectSummaries"], "members":{ "projectSummaries":{ "shape":"ProjectSummaries", "documentation":"A list that summarizes each project in the portal.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The token for the next set of results, or null if there are no additional results.
" } } }, "ListQueriesRequest":{ "type":"structure", "required":["workspaceName"], "members":{ "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace to list queries for.
", "location":"uri", "locationName":"workspaceName" }, "filter":{ "shape":"QueryFilter", "documentation":"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.
", "location":"querystring", "locationName":"filter" }, "maxResults":{ "shape":"QueryMaxResults", "documentation":"The maximum number of results to return for each paginated request.
", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"QueryListNextToken", "documentation":"The token to be used for the next set of paginated results.
", "location":"querystring", "locationName":"nextToken" } } }, "ListQueriesResponse":{ "type":"structure", "required":["queries"], "members":{ "queries":{ "shape":"QuerySummaryList", "documentation":"A list of query summaries for the workspace.
" }, "nextToken":{ "shape":"QueryListNextToken", "documentation":"The token for the next set of results, or null if there are no additional results.
" } }, "documentation":"Contains the response for the ListQueries operation.
" }, "ListSearchesFilters":{ "type":"structure", "members":{ "statusFilter":{ "shape":"SearchStatusFilterList", "documentation":"Returns only searches whose status is one of the listed values.
" }, "startedAfter":{ "shape":"Timestamp", "documentation":"Returns only searches started at or after this time.
" }, "startedBefore":{ "shape":"Timestamp", "documentation":"Returns only searches started at or before this time.
" }, "groupIdFilter":{ "shape":"GroupIdFilterList", "documentation":"Returns only searches whose groupId is one of the listed values.
Returns only searches whose searchType is one of the listed values.
Optional filters for ListSearches. When multiple filters are set, a search must match all of them.
" }, "ListSearchesRequest":{ "type":"structure", "required":["workspaceName"], "members":{ "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace whose searches are listed.
", "location":"uri", "locationName":"workspaceName" }, "maxResults":{ "shape":"ListSearchesRequestMaxResultsInteger", "documentation":"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.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The pagination token returned by a previous ListSearches call. Provide it to retrieve the next page; omit it to retrieve the first page.
" }, "listSearchesFilters":{ "shape":"ListSearchesFilters", "documentation":"Optional filters that restrict which searches are returned.
" } }, "documentation":"Input for the ListSearches operation.
" }, "ListSearchesRequestMaxResultsInteger":{ "type":"integer", "box":true, "max":1000, "min":1 }, "ListSearchesResponse":{ "type":"structure", "required":["searchSummaries"], "members":{ "searchSummaries":{ "shape":"SearchSummaries", "documentation":"A page of search summaries, most recently started first.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The pagination token to use in a subsequent ListSearches call to retrieve the next page. Absent when there are no more searches.
" } }, "documentation":"Output of the ListSearches operation.
" }, "ListTagsForResourceRequest":{ "type":"structure", "required":["resourceArn"], "members":{ "resourceArn":{ "shape":"AmazonResourceName", "documentation":"The ARN of the resource.
", "location":"querystring", "locationName":"resourceArn" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "tags":{ "shape":"TagMap", "documentation":"The list of key-value pairs that contain metadata for the resource. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.
" } } }, "ListTasksRequest":{ "type":"structure", "required":["workspaceName"], "members":{ "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace.
", "location":"uri", "locationName":"workspaceName" }, "nextToken":{ "shape":"PaginationToken", "documentation":"The token to be used for the next set of paginated results.
", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"ListTasksRequestMaxResultsInteger", "documentation":"The maximum number of results to return for each paginated request. Default: 50.
", "location":"querystring", "locationName":"maxResults" } }, "documentation":"Request structure for ListTasks operation.
" }, "ListTasksRequestMaxResultsInteger":{ "type":"integer", "box":true, "max":250, "min":1 }, "ListTasksResponse":{ "type":"structure", "required":["taskSummaries"], "members":{ "taskSummaries":{ "shape":"TaskSummaries", "documentation":"A list that summarizes each task in the workspace.
" }, "nextToken":{ "shape":"PaginationToken", "documentation":"The token to be used for the next set of paginated results.
" } }, "documentation":"Response structure for ListTasks operation.
" }, "ListTimeSeriesRequest":{ "type":"structure", "members":{ "nextToken":{ "shape":"NextToken", "documentation":"The token to be used for the next set of paginated results.
", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return for each paginated request.
", "location":"querystring", "locationName":"maxResults" }, "assetId":{ "shape":"CustomID", "documentation":"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.
The alias prefix of the time series.
", "location":"querystring", "locationName":"aliasPrefix" }, "timeSeriesType":{ "shape":"ListTimeSeriesType", "documentation":"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.
The name of the workspace.
", "location":"querystring", "locationName":"workspaceName" } } }, "ListTimeSeriesResponse":{ "type":"structure", "required":["TimeSeriesSummaries"], "members":{ "TimeSeriesSummaries":{ "shape":"TimeSeriesSummaries", "documentation":"One or more time series summaries to list.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The token for the next set of results, or null if there are no additional results.
" }, "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace.
" } } }, "ListTimeSeriesType":{ "type":"string", "enum":[ "ASSOCIATED", "DISASSOCIATED" ] }, "ListWorkspacesRequest":{ "type":"structure", "members":{ "nextToken":{ "shape":"NextToken", "documentation":"The token to be used for the next set of paginated results.
", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return for each paginated request. Default: 50.
", "location":"querystring", "locationName":"maxResults" } } }, "ListWorkspacesResponse":{ "type":"structure", "required":["workspaceSummaries"], "members":{ "workspaceSummaries":{ "shape":"WorkspaceSummaries", "documentation":"A list that summarizes each workspace.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The token for the next set of results, or null if there are no additional results.
" } } }, "Location":{ "type":"structure", "members":{ "uri":{ "shape":"String", "documentation":"The URI of the location.
" } }, "documentation":"Contains location information about the cited text and where it's stored.
" }, "LoggingLevel":{ "type":"string", "enum":[ "ERROR", "INFO", "OFF" ] }, "LoggingOptions":{ "type":"structure", "required":["level"], "members":{ "level":{ "shape":"LoggingLevel", "documentation":"The IoT SiteWise logging verbosity level.
" } }, "documentation":"Contains logging options.
" }, "Long":{ "type":"long", "box":true }, "Macro":{ "type":"string", "max":256, "min":1, "pattern":"[^\\u0000-\\u001F\\u007F]+" }, "MatchByPropertyName":{"type":"boolean"}, "MatchedDataBinding":{ "type":"structure", "required":["value"], "members":{ "value":{ "shape":"DataBindingValue", "documentation":"The value of the matched data binding.
" } }, "documentation":"Represents a data binding that matches the specified filter criteria.
" }, "MaxInterpolatedResults":{ "type":"integer", "min":1 }, "MaxResults":{ "type":"integer", "max":250, "min":1 }, "Measurement":{ "type":"structure", "members":{ "processingConfig":{ "shape":"MeasurementProcessingConfig", "documentation":"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.
" } }, "documentation":"Contains an asset measurement property. For more information, see Measurements in the IoT SiteWise User Guide.
" }, "MeasurementProcessingConfig":{ "type":"structure", "required":["forwardingConfig"], "members":{ "forwardingConfig":{ "shape":"ForwardingConfig", "documentation":"The forwarding configuration for the given measurement property.
" } }, "documentation":"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.
" }, "MessageInput":{ "type":"string", "max":10000, "min":1, "sensitive":true }, "Metadata":{ "type":"map", "key":{"shape":"MetadataKey"}, "value":{"shape":"MetadataValue"} }, "MetadataKey":{ "type":"string", "max":128, "min":1 }, "MetadataValue":{ "type":"string", "max":2048, "min":0 }, "Metric":{ "type":"structure", "required":["window"], "members":{ "expression":{ "shape":"Expression", "documentation":"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":{ "shape":"ExpressionVariables", "documentation":"The list of variables used in the expression.
" }, "window":{ "shape":"MetricWindow", "documentation":"The window (time interval) over which IoT SiteWise computes the metric's aggregation expression. IoT SiteWise computes one data point per window.
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.
" } }, "documentation":"Contains an asset metric property. With metrics, you can calculate aggregate functions, such as an average, maximum, or minimum, as specified through an expression. A metric maps several values to a single value (such as a sum).
The maximum number of dependent/cascading variables used in any one metric calculation is 10. Therefore, a root metric can have up to 10 cascading metrics in its computational dependency tree. Additionally, a metric can only have a data type of DOUBLE and consume properties with data types of INTEGER or DOUBLE.
For more information, see Metrics in the IoT SiteWise User Guide.
" }, "MetricProcessingConfig":{ "type":"structure", "required":["computeLocation"], "members":{ "computeLocation":{ "shape":"ComputeLocation", "documentation":"The compute location for the given metric property.
" } }, "documentation":"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.
" }, "MetricWindow":{ "type":"structure", "members":{ "tumbling":{ "shape":"TumblingWindow", "documentation":"The tumbling time interval window.
" } }, "documentation":"Contains a time interval window used for data aggregate computations (for example, average, sum, count, and so on).
" }, "MonitorErrorCode":{ "type":"string", "enum":[ "INTERNAL_FAILURE", "VALIDATION_ERROR", "LIMIT_EXCEEDED" ] }, "MonitorErrorDetails":{ "type":"structure", "members":{ "code":{ "shape":"MonitorErrorCode", "documentation":"The error code.
" }, "message":{ "shape":"MonitorErrorMessage", "documentation":"The error message.
" } }, "documentation":"Contains IoT SiteWise Monitor error details.
" }, "MonitorErrorMessage":{"type":"string"}, "Mp4":{ "type":"structure", "members":{}, "documentation":"The MP4 video format configuration for bulk import files.
" }, "MultiLayerStorage":{ "type":"structure", "required":["customerManagedS3Storage"], "members":{ "customerManagedS3Storage":{ "shape":"CustomerManagedS3Storage", "documentation":"Contains information about a customer managed Amazon S3 bucket.
" } }, "documentation":"Contains information about the storage destination.
" }, "Name":{ "type":"string", "max":256, "min":1, "pattern":"[^\\u0000-\\u001F\\u007F]+" }, "NextToken":{ "type":"string", "max":4096, "min":1, "pattern":"[A-Za-z0-9+/=]+" }, "NullableBoolean":{ "type":"boolean", "box":true }, "NumberOfDays":{"type":"integer"}, "Offset":{ "type":"string", "max":25, "min":2 }, "OffsetInNanos":{ "type":"integer", "max":999999999, "min":0 }, "PaginationToken":{ "type":"string", "documentation":"An opaque pagination token. Pass the value returned by a previous request to retrieve the next page of results.
", "max":4096, "min":1 }, "Parquet":{ "type":"structure", "members":{}, "documentation":"A parquet file.
" }, "Permission":{ "type":"string", "enum":[ "ADMINISTRATOR", "VIEWER" ] }, "PipelineErrorCode":{ "type":"string", "documentation":"Classification of a pipeline execution failure.
", "enum":[ "VALIDATION_ERROR", "INTERNAL_FAILURE", "EXECUTION_ERROR", "TIMED_OUT" ] }, "PipelineExecutionState":{ "type":"string", "documentation":"The state of a pipeline execution.
", "enum":[ "NOT_STARTED", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLING", "CANCELLED" ] }, "PipelineExecutionStateDetails":{ "type":"structure", "required":["message"], "members":{ "code":{ "shape":"PipelineErrorCode", "documentation":"Classification of the failure. Present when the execution failed.
" }, "message":{ "shape":"String", "documentation":"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":{ "shape":"DetailedErrorList", "documentation":"Per-step error entries to help diagnose a failed execution. Present when the execution failed.
" } }, "documentation":"Additional information about the current execution status. Populated when the execution has terminated.
" }, "PipelineExecutionStatus":{ "type":"structure", "required":["state"], "members":{ "state":{ "shape":"PipelineExecutionState", "documentation":"Current state of the pipeline execution.
" }, "stateDetails":{ "shape":"PipelineExecutionStateDetails", "documentation":"Additional information about the execution outcome. Populated when the execution has terminated (failed or cancelled).
" } }, "documentation":"Current execution status of a pipeline.
" }, "PipelineExecutionSummary":{ "type":"structure", "required":[ "pipelineExecutionId", "pipelineVersion", "status" ], "members":{ "pipelineExecutionId":{ "shape":"ID", "documentation":"The unique identifier of the pipeline execution.
" }, "pipelineVersion":{ "shape":"Version", "documentation":"The pipeline version this execution ran against.
" }, "status":{ "shape":"PipelineExecutionStatus", "documentation":"The current execution status of the pipeline.
" }, "executionPriority":{ "shape":"ExecutionPriority", "documentation":"Scheduling priority for the execution. When not specified, defaults to lowest priority.
" }, "startTime":{ "shape":"Timestamp", "documentation":"The time the pipeline execution started, in Unix epoch time.
" }, "endTime":{ "shape":"Timestamp", "documentation":"The time the pipeline execution completed, in Unix epoch time.
" } }, "documentation":"Contains summary information about a pipeline execution.
" }, "PipelineExecutionSummaryList":{ "type":"list", "member":{"shape":"PipelineExecutionSummary"}, "documentation":"A list of pipeline execution summaries.
" }, "PipelineSummaries":{ "type":"list", "member":{"shape":"PipelineSummary"}, "documentation":"A list of pipeline summaries.
" }, "PipelineSummary":{ "type":"structure", "required":[ "pipelineName", "pipelineArn", "version", "status", "createdAt", "updatedAt" ], "members":{ "pipelineName":{ "shape":"ResourceName", "documentation":"The name of the pipeline.
" }, "description":{ "shape":"Description", "documentation":"The description of the pipeline.
" }, "pipelineArn":{ "shape":"ARN", "documentation":"The ARN of the pipeline.
" }, "version":{ "shape":"Version", "documentation":"The version of the pipeline.
" }, "status":{ "shape":"ResourceStatus", "documentation":"The current lifecycle status of the pipeline.
" }, "createdAt":{ "shape":"Timestamp", "documentation":"The time the pipeline was created, in Unix epoch time.
" }, "updatedAt":{ "shape":"Timestamp", "documentation":"The time the pipeline was last updated, in Unix epoch time.
" } }, "documentation":"Contains summary information about a pipeline.
" }, "PortalClientId":{ "type":"string", "max":256, "min":1, "pattern":"^[!-~]*" }, "PortalResource":{ "type":"structure", "required":["id"], "members":{ "id":{ "shape":"ID", "documentation":"The ID of the portal.
" } }, "documentation":"Identifies an IoT SiteWise Monitor portal.
" }, "PortalState":{ "type":"string", "enum":[ "CREATING", "PENDING", "UPDATING", "DELETING", "ACTIVE", "FAILED" ] }, "PortalStatus":{ "type":"structure", "required":["state"], "members":{ "state":{ "shape":"PortalState", "documentation":"The current state of the portal.
" }, "error":{ "shape":"MonitorErrorDetails", "documentation":"Contains associated error information, if any.
" } }, "documentation":"Contains information about the current status of a portal.
" }, "PortalSummaries":{ "type":"list", "member":{"shape":"PortalSummary"} }, "PortalSummary":{ "type":"structure", "required":[ "id", "name", "startUrl", "status" ], "members":{ "id":{ "shape":"ID", "documentation":"The ID of the portal.
" }, "name":{ "shape":"Name", "documentation":"The name of the portal.
" }, "description":{ "shape":"Description", "documentation":"The portal's description.
" }, "startUrl":{ "shape":"Url", "documentation":"The URL for the IoT SiteWise Monitor portal. You can use this URL to access portals that use IAM Identity Center for authentication. For portals that use IAM for authentication, you must use the IoT SiteWise console to get a URL that you can use to access the portal.
" }, "creationDate":{ "shape":"Timestamp", "documentation":"The date the portal was created, in Unix epoch time.
" }, "lastUpdateDate":{ "shape":"Timestamp", "documentation":"The date the portal was last updated, in Unix epoch time.
" }, "roleArn":{ "shape":"IamArn", "documentation":"The ARN of the service role that allows the portal's users to access your IoT SiteWise resources on your behalf. For more information, see Using service roles for IoT SiteWise Monitor in the IoT SiteWise User Guide.
" }, "status":{"shape":"PortalStatus"}, "portalType":{ "shape":"PortalType", "documentation":"Define the type of portal. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.
Contains a portal summary.
" }, "PortalTools":{ "type":"list", "member":{"shape":"Name"} }, "PortalType":{ "type":"string", "enum":[ "SITEWISE_PORTAL_V1", "SITEWISE_PORTAL_V2" ] }, "PortalTypeConfiguration":{ "type":"map", "key":{"shape":"PortalTypeKey"}, "value":{"shape":"PortalTypeEntry"} }, "PortalTypeEntry":{ "type":"structure", "members":{ "portalTools":{ "shape":"PortalTools", "documentation":"The array of tools associated with the specified portal type. The possible values are ASSISTANT and DASHBOARD.
The configuration entry associated with the specific portal type. The portalTypeConfiguration is a map of the portalTypeKey to the PortalTypeEntry.
The ID of the resource on which precondition failed with this operation.
" }, "resourceArn":{ "shape":"ResourceArn", "documentation":"The ARN of the resource on which precondition failed with this operation.
" } }, "documentation":"The precondition in one or more of the request-header fields evaluated to FALSE.
The processing type for compute resources. Determines whether the task runs on standard CPU or GPU-accelerated hardware.
", "enum":[ "GENERIC_COMPUTE_PROCESSING", "HARDWARE_ACCELERATED_PROCESSING" ] }, "ProcessingUnit":{ "type":"string", "documentation":"The processing unit allocation that determines the vCPU, memory, and GPU resources assigned to a task. Available units depend on the processing type.
", "enum":[ "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" ] }, "ProjectResource":{ "type":"structure", "required":["id"], "members":{ "id":{ "shape":"ID", "documentation":"The ID of the project.
" } }, "documentation":"Identifies a specific IoT SiteWise Monitor project.
" }, "ProjectSummaries":{ "type":"list", "member":{"shape":"ProjectSummary"} }, "ProjectSummary":{ "type":"structure", "required":[ "id", "name" ], "members":{ "id":{ "shape":"ID", "documentation":"The ID of the project.
" }, "name":{ "shape":"Name", "documentation":"The name of the project.
" }, "description":{ "shape":"Description", "documentation":"The project's description.
" }, "creationDate":{ "shape":"Timestamp", "documentation":"The date the project was created, in Unix epoch time.
" }, "lastUpdateDate":{ "shape":"Timestamp", "documentation":"The date the project was last updated, in Unix epoch time.
" } }, "documentation":"Contains project summary information.
" }, "Property":{ "type":"structure", "required":[ "id", "name", "dataType" ], "members":{ "id":{ "shape":"ID", "documentation":"The ID of the asset property.
" }, "externalId":{ "shape":"ExternalId", "documentation":"The external ID of the asset property. For more information, see Using external IDs in the IoT SiteWise User Guide.
" }, "name":{ "shape":"Name", "documentation":"The name of the property.
" }, "alias":{ "shape":"PropertyAlias", "documentation":"The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.
The asset property's notification topic and state. For more information, see UpdateAssetProperty.
" }, "dataType":{ "shape":"PropertyDataType", "documentation":"The property data type.
" }, "unit":{ "shape":"PropertyUnit", "documentation":"The unit (such as Newtons or RPM) of the asset property.
The property type (see PropertyType). A property contains one type.
The structured path to the property from the root of the asset.
" } }, "documentation":"Contains asset property information.
" }, "PropertyAlias":{ "type":"string", "min":1, "pattern":"[^\\u0000-\\u001F\\u007F]+" }, "PropertyDataType":{ "type":"string", "enum":[ "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "STRUCT", "VIDEO", "ANNOTATION", "JSON" ] }, "PropertyMapping":{ "type":"structure", "required":[ "assetModelPropertyId", "interfaceAssetModelPropertyId" ], "members":{ "assetModelPropertyId":{ "shape":"CustomID", "documentation":"The ID of the property in the asset model where the interface is applied.
" }, "interfaceAssetModelPropertyId":{ "shape":"CustomID", "documentation":"The ID of the property in the interface asset model.
" } }, "documentation":"Maps a property from an interface asset model to a property in the asset model where the interface is applied.
" }, "PropertyMappingConfiguration":{ "type":"structure", "members":{ "matchByPropertyName":{ "shape":"MatchByPropertyName", "documentation":"If true, properties are matched by name between the interface asset model and the asset model where the interface is applied.
" }, "createMissingProperty":{ "shape":"CreateMissingProperty", "documentation":"If true, missing properties from the interface asset model are automatically created in the asset model where the interface is applied.
" }, "overrides":{ "shape":"PropertyMappings", "documentation":"A list of specific property mappings that override the automatic mapping by name when an interface is applied to an asset model.
" } }, "documentation":"Contains configuration options for mapping properties from an interface asset model to an asset model where the interface is applied.
" }, "PropertyMappings":{ "type":"list", "member":{"shape":"PropertyMapping"} }, "PropertyNotification":{ "type":"structure", "required":[ "topic", "state" ], "members":{ "topic":{ "shape":"PropertyNotificationTopic", "documentation":"The MQTT topic to which IoT SiteWise publishes property value update notifications.
" }, "state":{ "shape":"PropertyNotificationState", "documentation":"The current notification state.
" } }, "documentation":"Contains asset property value notification information. When the notification state is enabled, IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see Interacting with other services in the IoT SiteWise User Guide.
" }, "PropertyNotificationState":{ "type":"string", "enum":[ "ENABLED", "DISABLED" ] }, "PropertyNotificationTopic":{"type":"string"}, "PropertyType":{ "type":"structure", "members":{ "attribute":{ "shape":"Attribute", "documentation":"Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an IIoT wind turbine.
" }, "measurement":{ "shape":"Measurement", "documentation":"Specifies an asset measurement property. A measurement represents a device's raw sensor data stream, such as timestamped temperature values or timestamped power values.
" }, "transform":{ "shape":"Transform", "documentation":"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.
" }, "metric":{ "shape":"Metric", "documentation":"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.
" } }, "documentation":"Contains a property type, which can be one of attribute, measurement, metric, or transform.
The type of null asset property data.
" } }, "documentation":"The value type of null asset property data with BAD and UNCERTAIN qualities.
" }, "PropertyValueStringValue":{"type":"string"}, "PutAssetModelInterfaceRelationshipRequest":{ "type":"structure", "required":[ "assetModelId", "interfaceAssetModelId", "propertyMappingConfiguration" ], "members":{ "assetModelId":{ "shape":"CustomID", "documentation":"The ID of the asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID.
", "location":"uri", "locationName":"assetModelId" }, "interfaceAssetModelId":{ "shape":"CustomID", "documentation":"The ID of the interface asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID.
", "location":"uri", "locationName":"interfaceAssetModelId" }, "propertyMappingConfiguration":{ "shape":"PropertyMappingConfiguration", "documentation":"The configuration for mapping properties from the interface asset model to the asset model where the interface is applied. This configuration controls how properties are matched and created during the interface application process.
" }, "clientToken":{ "shape":"ClientToken", "documentation":"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.
", "idempotencyToken":true } } }, "PutAssetModelInterfaceRelationshipResponse":{ "type":"structure", "required":[ "assetModelId", "interfaceAssetModelId", "assetModelArn", "assetModelStatus" ], "members":{ "assetModelId":{ "shape":"ID", "documentation":"The ID of the asset model.
" }, "interfaceAssetModelId":{ "shape":"ID", "documentation":"The ID of the interface asset model.
" }, "assetModelArn":{ "shape":"ARN", "documentation":"The ARN of the asset model, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}
The user specified ID for the entry. You can use this ID to identify which entries failed.
" }, "assetId":{ "shape":"ID", "documentation":"The ID of the asset to update.
" }, "propertyId":{ "shape":"ID", "documentation":"The ID of the asset property for this entry.
" }, "propertyAlias":{ "shape":"AssetPropertyAlias", "documentation":"The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.
The list of property values to upload. You can specify up to 10 propertyValues array elements.
Contains a list of value updates for an asset property in the list of asset entries consumed by the BatchPutAssetPropertyValue API operation.
" }, "PutDefaultEncryptionConfigurationRequest":{ "type":"structure", "required":["encryptionType"], "members":{ "encryptionType":{ "shape":"EncryptionType", "documentation":"The type of encryption used for the encryption configuration.
" }, "kmsKeyId":{ "shape":"KmsKeyId", "documentation":"The Key ID of the customer managed key used for KMS encryption. This is required if you use KMS_BASED_ENCRYPTION.
The type of encryption used for the encryption configuration.
" }, "kmsKeyArn":{ "shape":"ARN", "documentation":"The Key ARN of the KMS key used for KMS encryption if you use KMS_BASED_ENCRYPTION.
The status of the account configuration. This contains the ConfigurationState. If there is an error, it also contains the ErrorDetails.
The logging options to set.
" }, "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace.
" } } }, "PutLoggingOptionsResponse":{ "type":"structure", "members":{} }, "PutStorageConfigurationRequest":{ "type":"structure", "required":["storageType"], "members":{ "storageType":{ "shape":"StorageType", "documentation":"The storage tier that you specified for your data. The storageType parameter can be one of the following values:
SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves your data into the hot tier. The hot tier is a service-managed database.
MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold tier and the hot tier. The cold tier is a customer-managed Amazon S3 bucket.
Identifies a storage destination. If you specified MULTI_LAYER_STORAGE for the storage type, you must specify a MultiLayerStorage object.
Contains the storage configuration for time series (data streams) that aren't associated with asset properties. The disassociatedDataStorage can be one of the following values:
ENABLED – IoT SiteWise accepts time series that aren't associated with asset properties.
After the disassociatedDataStorage is enabled, you can't disable it.
DISABLED – IoT SiteWise doesn't accept time series (data streams) that aren't associated with asset properties.
For more information, see Data streams in the IoT SiteWise User Guide.
" }, "retentionPeriod":{"shape":"RetentionPeriod"}, "warmTier":{ "shape":"WarmTierState", "documentation":"A service managed storage tier optimized for analytical queries. It stores periodically uploaded, buffered and historical data ingested with the CreaeBulkImportJob API.
" }, "warmTierRetentionPeriod":{ "shape":"WarmTierRetentionPeriod", "documentation":"Set this period to specify how long your data is stored in the warm tier before it is deleted. You can set this only if cold tier is enabled.
" }, "disallowIngestNullNaN":{ "shape":"DisallowIngestNullNaN", "documentation":"Describes the configuration for ingesting NULL and NaN data. By default the feature is allowed. The feature is disallowed if the value is true.
The storage tier that you specified for your data. The storageType parameter can be one of the following values:
SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves your data into the hot tier. The hot tier is a service-managed database.
MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold tier and the hot tier. The cold tier is a customer-managed Amazon S3 bucket.
Contains information about the storage destination.
" }, "disassociatedDataStorage":{ "shape":"DisassociatedDataStorageState", "documentation":"Contains the storage configuration for time series (data streams) that aren't associated with asset properties. The disassociatedDataStorage can be one of the following values:
ENABLED – IoT SiteWise accepts time series that aren't associated with asset properties.
After the disassociatedDataStorage is enabled, you can't disable it.
DISABLED – IoT SiteWise doesn't accept time series (data streams) that aren't associated with asset properties.
For more information, see Data streams in the IoT SiteWise User Guide.
" }, "retentionPeriod":{"shape":"RetentionPeriod"}, "configurationStatus":{"shape":"ConfigurationStatus"}, "warmTier":{ "shape":"WarmTierState", "documentation":"A service managed storage tier optimized for analytical queries. It stores periodically uploaded, buffered and historical data ingested with the CreaeBulkImportJob API.
" }, "warmTierRetentionPeriod":{ "shape":"WarmTierRetentionPeriod", "documentation":"Set this period to specify how long your data is stored in the warm tier before it is deleted. You can set this only if cold tier is enabled.
" }, "disallowIngestNullNaN":{ "shape":"DisallowIngestNullNaN", "documentation":"Describes the configuration for ingesting NULL and NaN data. By default the feature is allowed. The feature is disallowed if the value is true.
A human-readable error description for a failed query.
", "max":1024, "min":0 }, "QueryFilter":{ "type":"string", "documentation":"Filter for ListQueries. Returns only queries with the specified status.
", "max":64, "min":1 }, "QueryId":{ "type":"string", "documentation":"The unique identifier for a query execution.
", "max":64, "min":1, "pattern":"[a-zA-Z0-9-]+" }, "QueryListNextToken":{ "type":"string", "documentation":"Pagination token for the query list.
", "max":4096, "min":1 }, "QueryMaxResults":{ "type":"integer", "documentation":"The maximum number of results to return for each paginated request.
", "box":true, "max":10000, "min":1 }, "QueryNextToken":{ "type":"string", "documentation":"Pagination token for query results.
", "max":4096, "min":1 }, "QueryStatement":{ "type":"string", "max":10000, "min":1, "pattern":"^[\\s\\S]+$", "sensitive":true }, "QueryStatistics":{ "type":"structure", "required":[ "rowCount", "bytesScanned", "executionTimeInMillis" ], "members":{ "rowCount":{ "shape":"Long", "documentation":"The total number of rows returned by the query.
" }, "bytesScanned":{ "shape":"Long", "documentation":"The total number of bytes scanned during query execution.
" }, "executionTimeInMillis":{ "shape":"Long", "documentation":"The total query execution time, in milliseconds.
" } }, "documentation":"Contains statistics about a completed query execution.
" }, "QueryStatus":{ "type":"string", "documentation":"The status of a query execution.
", "enum":[ "SUBMITTED", "RUNNING", "COMPLETED", "FAILED", "CANCELED", "CANCELING" ] }, "QueryString":{ "type":"string", "documentation":"The SQL query statement.
", "max":10240, "min":1, "sensitive":true }, "QuerySummary":{ "type":"structure", "required":[ "queryId", "status", "submittedAt" ], "members":{ "queryId":{ "shape":"QueryId", "documentation":"The unique identifier for the query execution.
" }, "status":{ "shape":"QueryStatus", "documentation":"The current query status.
" }, "submittedAt":{ "shape":"Timestamp", "documentation":"The date and time when the query was submitted, in Unix epoch time.
" }, "completedAt":{ "shape":"Timestamp", "documentation":"The date and time when the query reached a terminal state, in Unix epoch time.
" } }, "documentation":"Contains summary information about a query.
" }, "QuerySummaryList":{ "type":"list", "member":{"shape":"QuerySummary"}, "documentation":"A list of query summaries.
" }, "QueryTimeoutException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"The query timed out.
", "error":{"httpStatusCode":400}, "exception":true }, "RawValueType":{ "type":"string", "enum":[ "D", "B", "S", "I", "U" ] }, "Reference":{ "type":"structure", "members":{ "dataset":{ "shape":"DataSetReference", "documentation":"Contains the dataset reference information.
" } }, "documentation":"Contains the reference information.
" }, "Resolution":{ "type":"string", "max":3, "min":2, "pattern":"1m|15m|1h|1d" }, "ResolveTo":{ "type":"structure", "required":["assetId"], "members":{ "assetId":{ "shape":"ID", "documentation":"The ID of the asset that the resource resolves to.
" } }, "documentation":"The detailed resource this execution summary resolves to.
" }, "ResolveToResourceType":{ "type":"string", "enum":["ASSET"] }, "Resource":{ "type":"structure", "members":{ "portal":{ "shape":"PortalResource", "documentation":"A portal resource.
" }, "project":{ "shape":"ProjectResource", "documentation":"A project resource.
" } }, "documentation":"Contains an IoT SiteWise Monitor resource ID for a portal or project.
" }, "ResourceAlreadyExistsException":{ "type":"structure", "required":[ "message", "resourceId", "resourceArn" ], "members":{ "message":{"shape":"ErrorMessage"}, "resourceId":{ "shape":"ResourceId", "documentation":"The ID of the resource that already exists.
" }, "resourceArn":{ "shape":"ResourceArn", "documentation":"The ARN of the resource that already exists.
" } }, "documentation":"The resource already exists.
", "error":{"httpStatusCode":409}, "exception":true }, "ResourceArn":{"type":"string"}, "ResourceError":{ "type":"structure", "members":{ "code":{ "shape":"ResourceErrorCode", "documentation":"The error code.
" }, "message":{ "shape":"String", "documentation":"The error message.
" } }, "documentation":"Contains the details of a resource error.
" }, "ResourceErrorCode":{ "type":"string", "documentation":"The error code.
", "enum":[ "VALIDATION_ERROR", "INTERNAL_FAILURE" ] }, "ResourceId":{"type":"string"}, "ResourceName":{ "type":"string", "documentation":"Reusable resource name with alphanumeric, hyphen, and underscore characters.
", "max":64, "min":1, "pattern":"[a-zA-Z0-9_-]+" }, "ResourceNotFoundException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"The requested resource can't be found.
", "error":{"httpStatusCode":404}, "exception":true }, "ResourceState":{ "type":"string", "documentation":"The lifecycle state of a resource.
", "enum":[ "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED" ] }, "ResourceStatus":{ "type":"structure", "members":{ "error":{ "shape":"ResourceError", "documentation":"Contains associated error information, if any.
" }, "state":{ "shape":"ResourceState", "documentation":"The current status of the resource.
" } }, "documentation":"Contains information about the current status of a resource.
" }, "ResourceType":{ "type":"string", "enum":[ "PORTAL", "PROJECT" ] }, "ResponseStream":{ "type":"structure", "members":{ "trace":{ "shape":"Trace", "documentation":"Contains tracing information of the SiteWise Assistant's reasoning and data access.
" }, "output":{ "shape":"InvocationOutput", "documentation":"Contains the SiteWise Assistant's response.
" }, "accessDeniedException":{"shape":"AccessDeniedException"}, "conflictingOperationException":{"shape":"ConflictingOperationException"}, "internalFailureException":{"shape":"InternalFailureException"}, "invalidRequestException":{"shape":"InvalidRequestException"}, "limitExceededException":{"shape":"LimitExceededException"}, "resourceNotFoundException":{"shape":"ResourceNotFoundException"}, "throttlingException":{"shape":"ThrottlingException"} }, "documentation":"Contains the response, citation, and trace from the SiteWise Assistant.
", "eventstream":true }, "RestrictedDescription":{ "type":"string", "max":2048, "min":1, "pattern":"^[a-zA-Z0-9 _\\-#$*!@]+$" }, "RestrictedName":{ "type":"string", "max":256, "min":1, "pattern":"^[a-zA-Z0-9 _\\-#$*!@.]+$" }, "Result":{ "type":"list", "member":{"shape":"ColumnValue"}, "documentation":"A single row of query results containing column values. Each element is a string-encoded column value, positional to match the columnInfo order.
", "sparse":true }, "ResultProperty":{ "type":"string", "max":67, "min":4, "pattern":"^\\$\\{[a-z][a-z0-9_]*\\}" }, "RetentionPeriod":{ "type":"structure", "members":{ "numberOfDays":{ "shape":"NumberOfDays", "documentation":"The number of days that your data is kept.
If you specified a value for this parameter, the unlimited parameter must be false.
If true, your data is kept indefinitely.
If configured to true, you must not specify a value for the numberOfDays parameter.
The number of days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.
" }, "Row":{ "type":"structure", "required":["data"], "members":{ "data":{ "shape":"DatumList", "documentation":"List of data points in a single row of the result set.
" } }, "documentation":"Represents a single row in the query results.
" }, "RowList":{ "type":"list", "member":{"shape":"Result"}, "documentation":"A list of result rows returned by the query. Each element is a row containing column values.
" }, "Rows":{ "type":"list", "member":{"shape":"Row"} }, "S3Uri":{ "type":"string", "documentation":"<p>An S3 URI identifying an object location, in the form s3://bucket/key.</p>", "max":1024, "min":1, "pattern":"s3://[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]/.+" }, "SSOApplicationId":{ "type":"string", "max":64, "min":1, "pattern":"^[!-~]*" }, "ScalarType":{ "type":"string", "enum":[ "BOOLEAN", "INT", "DOUBLE", "TIMESTAMP", "STRING" ] }, "ScalarValue":{"type":"string"}, "SearchFilters":{ "type":"structure", "members":{ "timeSeriesIds":{ "shape":"TimeSeriesIdList", "documentation":"Restricts the search to these time series.
" }, "datasetIds":{ "shape":"DataSetIdList", "documentation":"Restricts the search to these datasets.
" }, "timeIntervals":{ "shape":"TimeIntervalList", "documentation":"Restricts the search to these time intervals.
" } }, "documentation":"Optional filters that restrict a search to a subset of the workspace's data.
" }, "SearchId":{ "type":"string", "documentation":"The unique identifier of a search, assigned by the service when the search is started.
", "max":36, "min":23, "pattern":"[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*" }, "SearchQueryStatement":{ "type":"string", "documentation":"A natural-language query describing the data to search for. Treated as sensitive and not logged.
", "max":5000, "min":1, "sensitive":true }, "SearchResult":{ "type":"structure", "required":[ "searchId", "workspaceName", "datasetId", "timeSeriesId", "startTimestamp", "endTimestamp", "topTimestamp", "score" ], "members":{ "searchId":{ "shape":"SearchId", "documentation":"The identifier of the search that produced this result.
" }, "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace the search ran against.
" }, "datasetId":{ "shape":"DatasetId", "documentation":"The identifier of the dataset that contains the matching data.
" }, "timeSeriesId":{ "shape":"TimeSeriesId", "documentation":"The identifier of the time series that contains the matching data.
" }, "startTimestamp":{ "shape":"TimeInNanos", "documentation":"The start of the matching time-series segment, in nanoseconds since the Unix epoch.
" }, "endTimestamp":{ "shape":"TimeInNanos", "documentation":"The end of the matching time-series segment, in nanoseconds since the Unix epoch.
" }, "topTimestamp":{ "shape":"TimeInNanos", "documentation":"The timestamp of the most relevant point within the matching segment, in nanoseconds since the Unix epoch.
" }, "score":{ "shape":"Float", "documentation":"The relevance score of this result. Higher scores indicate a stronger match.
" } }, "documentation":"A single matching segment of time-series data returned by a search.
" }, "SearchResultList":{ "type":"list", "member":{"shape":"SearchResult"}, "documentation":"A list of search results, ordered by descending relevance score.
" }, "SearchStatus":{ "type":"string", "documentation":"The lifecycle status of a search.
", "enum":[ "QUEUED", "RUNNING", "SUCCEEDED", "FAILED" ] }, "SearchStatusFilterList":{ "type":"list", "member":{"shape":"SearchStatus"}, "documentation":"A filter on search status. Matches searches whose status is any of the listed values.
", "max":4, "min":1 }, "SearchSummaries":{ "type":"list", "member":{"shape":"SearchSummary"}, "documentation":"A list of search summaries returned by ListSearches.
" }, "SearchSummary":{ "type":"structure", "required":[ "searchId", "workspaceName", "status", "queryStatement", "searchType" ], "members":{ "searchId":{ "shape":"SearchId", "documentation":"The unique identifier of the search.
" }, "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace the search runs against.
" }, "status":{ "shape":"SearchStatus", "documentation":"The current status of the search.
" }, "queryStatement":{ "shape":"SearchQueryStatement", "documentation":"The natural-language query that was submitted for the search.
" }, "searchType":{ "shape":"SearchType", "documentation":"The search strategy used for the search.
" }, "statusReason":{ "shape":"String", "documentation":"A human-readable explanation of the current status. Populated when the search has FAILED.
The time at which the search was started.
" }, "groupId":{ "shape":"GroupId", "documentation":"The group identifier associated with the search, if one was supplied on the request.
" } }, "documentation":"A summary of a single search as returned by ListSearches.
" }, "SearchType":{ "type":"string", "documentation":"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.
A filter on search type. Matches searches whose searchType is any of the listed values.
The requested service is unavailable.
", "error":{"httpStatusCode":503}, "exception":true, "fault":true }, "SessionConfig":{ "type":"structure", "required":[ "sessionStartTimestamp", "sessionEndTimestamp" ], "members":{ "sessionStartTimestamp":{ "shape":"TimeInNanos", "documentation":"The nanosecond-precision start time of the session.
" }, "sessionEndTimestamp":{ "shape":"TimeInNanos", "documentation":"The nanosecond-precision end time of the session.
" } }, "documentation":"Contains the session configuration for a session-type dataset.
" }, "SiemensIE":{ "type":"structure", "required":["iotCoreThingName"], "members":{ "iotCoreThingName":{ "shape":"IotCoreThingName", "documentation":"The name of the IoT Thing for your SiteWise Edge gateway.
" } }, "documentation":"Contains details for a SiteWise Edge gateway that runs on a Siemens Industrial Edge Device.
" }, "Source":{ "type":"structure", "members":{ "arn":{ "shape":"String", "documentation":"Contains the ARN of the dataset. If the source is Kendra, it's the ARN of the Kendra index.
" }, "location":{ "shape":"Location", "documentation":"Contains the location information where the cited text is originally stored. For example, if the data source is Kendra, and the text synchronized is from an S3 bucket, then the location refers to an S3 object.
" } }, "documentation":"The data source for the dataset.
" }, "SourceDetail":{ "type":"structure", "members":{ "kendra":{ "shape":"KendraSourceDetail", "documentation":"Contains details about the Kendra dataset source.
" } }, "documentation":"The details of the dataset source associated with the dataset.
" }, "StartPipelineExecutionRequest":{ "type":"structure", "required":[ "workspaceName", "pipelineName" ], "members":{ "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace containing the pipeline.
", "location":"uri", "locationName":"workspaceName" }, "pipelineName":{ "shape":"ResourceName", "documentation":"The name of the pipeline to execute.
", "location":"uri", "locationName":"pipelineName" }, "executionEnvironmentVariableOverrides":{ "shape":"ExecutionEnvironmentVariables", "documentation":"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.
" }, "executionPriority":{ "shape":"ExecutionPriority", "documentation":"Scheduling priority for the execution. Lower values indicate higher priority. Defaults to 2 when not specified.
" }, "clientToken":{ "shape":"ClientToken", "documentation":"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.
", "idempotencyToken":true } }, "documentation":"Request structure for StartPipelineExecution operation.
" }, "StartPipelineExecutionResponse":{ "type":"structure", "required":["pipelineExecutionId"], "members":{ "pipelineExecutionId":{ "shape":"ID", "documentation":"The unique identifier of the created pipeline execution.
" } }, "documentation":"Response structure for StartPipelineExecution operation.
" }, "StartQueryRequest":{ "type":"structure", "required":[ "workspaceName", "queryStatement" ], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"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.
", "idempotencyToken":true }, "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace to query.
", "location":"uri", "locationName":"workspaceName" }, "queryStatement":{ "shape":"QueryString", "documentation":"The SQL query to execute against the workspace telemetry, annotations, data segment, and dataset data.
" } } }, "StartQueryResponse":{ "type":"structure", "required":[ "queryId", "status" ], "members":{ "queryId":{ "shape":"QueryId", "documentation":"The unique identifier for the query execution.
" }, "status":{ "shape":"QueryStatus", "documentation":"The initial query status. The value is always SUBMITTED upon creation.
" } }, "documentation":"Contains the response for the StartQuery operation.
" }, "StartSearchRequest":{ "type":"structure", "required":[ "workspaceName", "queryStatement" ], "members":{ "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace whose data is searched.
", "location":"uri", "locationName":"workspaceName" }, "queryStatement":{ "shape":"SearchQueryStatement", "documentation":"The natural-language query describing the data to search for.
" }, "clientToken":{ "shape":"ClientToken", "documentation":"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.
The search strategy to use. Defaults to QUICK when omitted.
Optional filters that restrict the search to a subset of the workspace's data.
" }, "groupId":{ "shape":"GroupId", "documentation":"An optional caller-supplied identifier used to group related searches together.
" } }, "documentation":"Input for the StartSearch operation.
" }, "StartSearchResponse":{ "type":"structure", "required":[ "searchId", "workspaceName", "status" ], "members":{ "searchId":{ "shape":"SearchId", "documentation":"The unique identifier assigned to the newly started search.
" }, "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace the search runs against.
" }, "status":{ "shape":"SearchStatus", "documentation":"The initial status of the search. A newly started search is QUEUED.
The group identifier associated with the search, if one was supplied on the request.
" } }, "documentation":"Output of the StartSearch operation.
" }, "StorageType":{ "type":"string", "enum":[ "SITEWISE_DEFAULT_STORAGE", "MULTI_LAYER_STORAGE" ] }, "String":{"type":"string"}, "TagKey":{ "type":"string", "max":128, "min":1 }, "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"}, "max":200, "min":0 }, "TagMap":{ "type":"map", "key":{"shape":"TagKey"}, "value":{"shape":"TagValue"}, "max":50, "min":1 }, "TagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "tags" ], "members":{ "resourceArn":{ "shape":"AmazonResourceName", "documentation":"The ARN of the resource to tag.
", "location":"querystring", "locationName":"resourceArn" }, "tags":{ "shape":"TagMap", "documentation":"A list of key-value pairs that contain metadata for the resource. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.
" } } }, "TagResourceResponse":{ "type":"structure", "members":{} }, "TagValue":{ "type":"string", "max":256, "min":0 }, "TargetResource":{ "type":"structure", "members":{ "assetId":{ "shape":"ID", "documentation":"The ID of the asset, in UUID format.
" }, "computationModelId":{ "shape":"ID", "documentation":"The ID of the computation model.
" } }, "documentation":"The resource the action will be taken on. This can include asset-based resources and computation model resources.
" }, "TargetResourceType":{ "type":"string", "enum":[ "ASSET", "COMPUTATION_MODEL" ] }, "TaskConfiguration":{ "type":"structure", "members":{ "containerTaskConfiguration":{ "shape":"ContainerTaskConfiguration", "documentation":"Configuration for running a custom container image on managed compute.
" } }, "documentation":"The task execution configuration. Specify a containerTaskConfiguration for a custom container workload.
", "union":true }, "TaskSummaries":{ "type":"list", "member":{"shape":"TaskSummary"}, "documentation":"A list of task summaries.
" }, "TaskSummary":{ "type":"structure", "required":[ "taskName", "taskArn", "version", "status", "createdAt", "updatedAt" ], "members":{ "taskName":{ "shape":"ResourceName", "documentation":"The name of the task.
" }, "description":{ "shape":"Description", "documentation":"The description of the task.
" }, "taskArn":{ "shape":"ARN", "documentation":"The ARN of the task.
" }, "version":{ "shape":"Version", "documentation":"The version of the task.
" }, "status":{ "shape":"ResourceStatus", "documentation":"The current lifecycle status of the task.
" }, "createdAt":{ "shape":"Timestamp", "documentation":"The time the task was created, in Unix epoch time.
" }, "updatedAt":{ "shape":"Timestamp", "documentation":"The time the task was last updated, in Unix epoch time.
" } }, "documentation":"Contains summary information about a task.
" }, "ThrottlingException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
", "error":{"httpStatusCode":429}, "exception":true }, "TimeInNanos":{ "type":"structure", "required":["timeInSeconds"], "members":{ "timeInSeconds":{ "shape":"TimeInSeconds", "documentation":"The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.
The nanosecond offset from timeInSeconds.
Contains a timestamp with optional nanosecond granularity.
" }, "TimeInSeconds":{ "type":"long", "max":9223372036854774, "min":1 }, "TimeInterval":{ "type":"structure", "required":[ "startTime", "endTime" ], "members":{ "startTime":{ "shape":"TimeInNanos", "documentation":"The start of the time interval.
" }, "endTime":{ "shape":"TimeInNanos", "documentation":"The end of the time interval.
" } }, "documentation":"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.
" }, "TimeIntervalList":{ "type":"list", "member":{"shape":"TimeInterval"}, "documentation":"A list of time intervals to restrict a search to.
", "max":100, "min":1 }, "TimeOrdering":{ "type":"string", "enum":[ "ASCENDING", "DESCENDING" ] }, "TimeSeriesId":{ "type":"string", "max":73, "min":36 }, "TimeSeriesIdList":{ "type":"list", "member":{"shape":"TimeSeriesId"}, "documentation":"A list of time-series identifiers to restrict a search to.
", "max":100, "min":1 }, "TimeSeriesSummaries":{ "type":"list", "member":{"shape":"TimeSeriesSummary"} }, "TimeSeriesSummary":{ "type":"structure", "required":[ "timeSeriesId", "dataType", "timeSeriesCreationDate", "timeSeriesLastUpdateDate", "timeSeriesArn" ], "members":{ "assetId":{ "shape":"ID", "documentation":"The ID of the asset in which the asset property was created.
" }, "propertyId":{ "shape":"ID", "documentation":"The ID of the asset property, in UUID format.
" }, "alias":{ "shape":"PropertyAlias", "documentation":"The alias that identifies the time series.
" }, "timeSeriesId":{ "shape":"TimeSeriesId", "documentation":"The ID of the time series.
" }, "dataType":{ "shape":"PropertyDataType", "documentation":"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.
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.
The date that the time series was created, in Unix epoch time.
" }, "timeSeriesLastUpdateDate":{ "shape":"Timestamp", "documentation":"The date that the time series was last updated, in Unix epoch time.
" }, "timeSeriesArn":{ "shape":"ARN", "documentation":"The ARN of the time series, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId}
Contains a summary of a time series (data stream).
" }, "TimeoutSeconds":{ "type":"long", "documentation":"The timeout in seconds for task execution. Default: 3600 (1 hour).
", "box":true, "max":86400, "min":60 }, "TimeseriesItem":{ "type":"structure", "members":{ "timeSeriesId":{ "shape":"TimeSeriesId", "documentation":"<p>The unique identifier for the timeseries. Mutually exclusive with propertyAlias.</p>" }, "propertyAlias":{ "shape":"AssetPropertyAlias", "documentation":"<p>The customer-friendly alias for the timeseries. Mutually exclusive with timeSeriesId.</p>" }, "trimSettings":{ "shape":"TrimSettings", "documentation":"<p>The trim settings for the time range to export. Required for VIDEO and TELEMETRY data types; optional for ANNOTATION data types.</p>" }, "formatSettings":{ "shape":"FormatSettings", "documentation":"<p>The optional format settings for the output.</p>" } }, "documentation":"<p>A single timeseries item to process. Exactly one of timeSeriesId or propertyAlias must be provided.</p>" }, "TimeseriesList":{ "type":"list", "member":{"shape":"TimeseriesItem"}, "documentation":"<p>A list of timeseries items to process.</p>", "max":100, "min":1 }, "Timestamp":{"type":"timestamp"}, "Timestamps":{ "type":"list", "member":{"shape":"TimeInNanos"} }, "TooManyTagsException":{ "type":"structure", "members":{ "message":{"shape":"ExceptionMessage"}, "resourceName":{ "shape":"AmazonResourceName", "documentation":"The name of the resource with too many tags.
" } }, "documentation":"You've reached the quota for the number of tags allowed for a resource. For more information, see Tag naming limits and requirements in the Amazon Web Services General Reference.
", "error":{"httpStatusCode":400}, "exception":true }, "Trace":{ "type":"structure", "members":{ "text":{ "shape":"String", "documentation":"The cited text from the data source.
" } }, "documentation":"Contains tracing information of the SiteWise Assistant's reasoning and data access.
", "event":true }, "Transform":{ "type":"structure", "required":[ "expression", "variables" ], "members":{ "expression":{ "shape":"Expression", "documentation":"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":{ "shape":"ExpressionVariables", "documentation":"The list of variables used in the expression.
" }, "processingConfig":{ "shape":"TransformProcessingConfig", "documentation":"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.
" } }, "documentation":"Contains an asset transform property. A transform is a one-to-one mapping of a property's data points from one form to another. For example, you can use a transform to convert a Celsius data stream to Fahrenheit by applying the transformation expression to each data point of the Celsius stream. A transform can only have a data type of DOUBLE and consume properties with data types of INTEGER or DOUBLE.
For more information, see Transforms in the IoT SiteWise User Guide.
" }, "TransformProcessingConfig":{ "type":"structure", "required":["computeLocation"], "members":{ "computeLocation":{ "shape":"ComputeLocation", "documentation":"The compute location for the given transform property.
" }, "forwardingConfig":{"shape":"ForwardingConfig"} }, "documentation":"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.
" }, "TraversalDirection":{ "type":"string", "enum":[ "PARENT", "CHILD" ] }, "TraversalType":{ "type":"string", "enum":["PATH_TO_ROOT"] }, "TrimSettings":{ "type":"structure", "required":[ "startTime", "endTime" ], "members":{ "startTime":{ "shape":"TimeInNanos", "documentation":"<p>The start time for the trim range.</p>" }, "endTime":{ "shape":"TimeInNanos", "documentation":"<p>The end time for the trim range. Must be greater than startTime.</p>" } }, "documentation":"<p>Contains settings for trimming content to a specific time range.</p>" }, "TumblingWindow":{ "type":"structure", "required":["interval"], "members":{ "interval":{ "shape":"Interval", "documentation":"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":{ "shape":"Offset", "documentation":"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.
Contains a tumbling window, which is a repeating fixed-sized, non-overlapping, and contiguous time window. You can use this window in metrics to aggregate data from properties and other assets.
You can use m, h, d, and w when you specify an interval or offset. Note that m represents minutes, h represents hours, d represents days, and w represents weeks. You can also use s to represent seconds in offset.
The interval and offset parameters support the ISO 8601 format. For example, PT5S represents 5 seconds, PT5M represents 5 minutes, and PT5H represents 5 hours.
You are not authorized.
", "error":{"httpStatusCode":401}, "exception":true }, "Unlimited":{"type":"boolean"}, "UntagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "tagKeys" ], "members":{ "resourceArn":{ "shape":"AmazonResourceName", "documentation":"The ARN of the resource to untag.
", "location":"querystring", "locationName":"resourceArn" }, "tagKeys":{ "shape":"TagKeyList", "documentation":"A list of keys for tags to remove from the resource.
", "location":"querystring", "locationName":"tagKeys" } } }, "UntagResourceResponse":{ "type":"structure", "members":{} }, "UpdateAccessPolicyRequest":{ "type":"structure", "required":[ "accessPolicyId", "accessPolicyIdentity", "accessPolicyResource", "accessPolicyPermission" ], "members":{ "accessPolicyId":{ "shape":"ID", "documentation":"The ID of the access policy.
", "location":"uri", "locationName":"accessPolicyId" }, "accessPolicyIdentity":{ "shape":"Identity", "documentation":"The identity for this access policy. Choose an IAM Identity Center user, an IAM Identity Center group, or an IAM user.
" }, "accessPolicyResource":{ "shape":"Resource", "documentation":"The IoT SiteWise Monitor resource for this access policy. Choose either a portal or a project.
" }, "accessPolicyPermission":{ "shape":"Permission", "documentation":"The permission level for this access policy. Note that a project ADMINISTRATOR is also known as a project owner.
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
", "idempotencyToken":true } } }, "UpdateAccessPolicyResponse":{ "type":"structure", "members":{} }, "UpdateAssetModelCompositeModelRequest":{ "type":"structure", "required":[ "assetModelId", "assetModelCompositeModelId", "assetModelCompositeModelName" ], "members":{ "assetModelId":{ "shape":"CustomID", "documentation":"The ID of the asset model, in UUID format.
", "location":"uri", "locationName":"assetModelId" }, "assetModelCompositeModelId":{ "shape":"CustomID", "documentation":"The ID of a composite model on this asset model.
", "location":"uri", "locationName":"assetModelCompositeModelId" }, "assetModelCompositeModelExternalId":{ "shape":"ExternalId", "documentation":"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.
" }, "assetModelCompositeModelDescription":{ "shape":"Description", "documentation":"A description for the composite model.
" }, "assetModelCompositeModelName":{ "shape":"Name", "documentation":"A unique name for the composite model.
" }, "clientToken":{ "shape":"ClientToken", "documentation":"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.
", "idempotencyToken":true }, "assetModelCompositeModelProperties":{ "shape":"AssetModelProperties", "documentation":"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.
" }, "ifMatch":{ "shape":"ETag", "documentation":"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.
Accepts * to reject the update request if an active version (specified using matchForVersionType as ACTIVE) already exists for the asset model.
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.
The path to the composite model listing the parent composite models.
" }, "assetModelStatus":{"shape":"AssetModelStatus"}, "assetModelId":{ "shape":"ID", "documentation":"The ID of the asset model.
" } } }, "UpdateAssetModelRequest":{ "type":"structure", "required":[ "assetModelId", "assetModelName" ], "members":{ "assetModelId":{ "shape":"CustomID", "documentation":"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.
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.
" }, "assetModelName":{ "shape":"Name", "documentation":"A unique name for the asset model.
" }, "assetModelDescription":{ "shape":"Description", "documentation":"A description for the asset model.
" }, "assetModelProperties":{ "shape":"AssetModelProperties", "documentation":"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.
" }, "assetModelHierarchies":{ "shape":"AssetModelHierarchies", "documentation":"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.
" }, "assetModelCompositeModels":{ "shape":"AssetModelCompositeModels", "documentation":"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.
When creating custom composite models, you need to use CreateAssetModelCompositeModel. For more information, see Creating custom composite models (Components) in the IoT SiteWise User Guide.
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
", "idempotencyToken":true }, "ifMatch":{ "shape":"ETag", "documentation":"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.
Accepts * to reject the update request if an active version (specified using matchForVersionType as ACTIVE) already exists for the asset model.
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.
The ID of the asset model.
" }, "assetModelStatus":{ "shape":"AssetModelStatus", "documentation":"The status of the asset model, which contains a state (UPDATING after successfully calling this operation) and any error message.
The ID of the asset to be updated. 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.
The ID of the asset property to be updated. 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.
The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.
If you omit this parameter, the alias is removed from the property.
" }, "propertyNotificationState":{ "shape":"PropertyNotificationState", "documentation":"The MQTT notification state (enabled or disabled) for this asset property. When the notification state is enabled, IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see Interacting with other services in the IoT SiteWise User Guide.
If you omit this parameter, the notification state is set to DISABLED.
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
", "idempotencyToken":true }, "propertyUnit":{ "shape":"PropertyUnit", "documentation":"The unit of measure (such as Newtons or RPM) of the asset property. If you don't specify a value for this parameter, the service uses the value of the assetModelProperty in the asset model.
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.
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.
" }, "assetName":{ "shape":"Name", "documentation":"A friendly name for the asset.
" }, "clientToken":{ "shape":"ClientToken", "documentation":"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.
", "idempotencyToken":true }, "assetDescription":{ "shape":"Description", "documentation":"A description for the asset.
" } } }, "UpdateAssetResponse":{ "type":"structure", "required":["assetStatus"], "members":{ "assetId":{ "shape":"ID", "documentation":"The ID of the asset.
" }, "assetStatus":{ "shape":"AssetStatus", "documentation":"The status of the asset, which contains a state (UPDATING after successfully calling this operation) and any error message.
The ID of the computation model.
", "location":"uri", "locationName":"computationModelId" }, "computationModelName":{ "shape":"RestrictedName", "documentation":"The name of the computation model.
" }, "computationModelDescription":{ "shape":"RestrictedDescription", "documentation":"The description of the computation model.
" }, "computationModelConfiguration":{ "shape":"ComputationModelConfiguration", "documentation":"The configuration for the computation model.
" }, "computationModelDataBinding":{ "shape":"ComputationModelDataBinding", "documentation":"The data binding for the computation model. Key is a variable name defined in configuration. Value is a ComputationModelDataBindingValue referenced by the variable.
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.
", "idempotencyToken":true } } }, "UpdateComputationModelResponse":{ "type":"structure", "required":["computationModelStatus"], "members":{ "computationModelStatus":{ "shape":"ComputationModelStatus", "documentation":"The status of the computation model. It contains a state (UPDATING after successfully calling this operation) and an error message if any.
" } } }, "UpdateDashboardRequest":{ "type":"structure", "required":[ "dashboardId", "dashboardName", "dashboardDefinition" ], "members":{ "dashboardId":{ "shape":"ID", "documentation":"The ID of the dashboard to update.
", "location":"uri", "locationName":"dashboardId" }, "dashboardName":{ "shape":"Name", "documentation":"A new friendly name for the dashboard.
" }, "dashboardDescription":{ "shape":"Description", "documentation":"A new description for the dashboard.
" }, "dashboardDefinition":{ "shape":"DashboardDefinition", "documentation":"The new dashboard definition, as specified in a JSON literal.
IoT SiteWise Monitor (Classic) see Create dashboards (CLI)
IoT SiteWise Monitor (AI-aware) see Create dashboards (CLI)
in the IoT SiteWise User Guide
" }, "clientToken":{ "shape":"ClientToken", "documentation":"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.
", "idempotencyToken":true } } }, "UpdateDashboardResponse":{ "type":"structure", "members":{} }, "UpdateDatasetRequest":{ "type":"structure", "required":[ "datasetId", "datasetName", "datasetSource" ], "members":{ "datasetId":{ "shape":"ID", "documentation":"The ID of the dataset.
", "location":"uri", "locationName":"datasetId" }, "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace that contains the dataset.
" }, "datasetName":{ "shape":"RestrictedName", "documentation":"The name of the dataset.
" }, "datasetDescription":{ "shape":"Description", "documentation":"A description about the dataset, and its functionality.
" }, "datasetConfig":{ "shape":"DatasetConfig", "documentation":"The updated configuration for the dataset.
" }, "metadata":{ "shape":"Metadata", "documentation":"The updated metadata for the dataset.
" }, "datasetSource":{ "shape":"DatasetSource", "documentation":"The data source for the dataset.
" }, "clientToken":{ "shape":"ClientToken", "documentation":"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.
", "idempotencyToken":true } } }, "UpdateDatasetResponse":{ "type":"structure", "members":{ "datasetId":{ "shape":"ID", "documentation":"The ID of the dataset.
" }, "datasetArn":{ "shape":"ARN", "documentation":"The ARN of the dataset. The format is arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId}.
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.
The ID of the gateway to be updated.
", "location":"uri", "locationName":"gatewayId" }, "capabilityNamespace":{ "shape":"CapabilityNamespace", "documentation":"The namespace of the gateway capability configuration to be updated. For example, if you configure OPC UA sources for an MQTT-enabled gateway, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:3.
The JSON document that defines the configuration for the gateway capability. For more information, see Configuring data sources (CLI) in the IoT SiteWise User Guide.
" } } }, "UpdateGatewayCapabilityConfigurationResponse":{ "type":"structure", "required":[ "capabilityNamespace", "capabilitySyncStatus" ], "members":{ "capabilityNamespace":{ "shape":"CapabilityNamespace", "documentation":"The namespace of the gateway capability.
" }, "capabilitySyncStatus":{ "shape":"CapabilitySyncStatus", "documentation":"The synchronization status of the gateway capability configuration. The sync status can be one of the following:
IN_SYNC - The gateway is running with the latest configuration.
OUT_OF_SYNC - The gateway hasn't received the latest configuration.
SYNC_FAILED - The gateway rejected the latest configuration.
UNKNOWN - The gateway hasn't reported its sync status.
NOT_APPLICABLE - The gateway doesn't support this capability. This is most common when integrating partner data sources, because the data integration is handled externally by the partner.
After you update a capability configuration, its sync status is OUT_OF_SYNC until the gateway receives and applies or rejects the updated configuration.
The ID of the gateway to update.
", "location":"uri", "locationName":"gatewayId" }, "gatewayName":{ "shape":"GatewayName", "documentation":"A unique name for the gateway.
" } } }, "UpdatePipelineRequest":{ "type":"structure", "required":[ "workspaceName", "pipelineName" ], "members":{ "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace.
", "location":"uri", "locationName":"workspaceName" }, "pipelineName":{ "shape":"ResourceName", "documentation":"The name of the pipeline to update.
", "location":"uri", "locationName":"pipelineName" }, "description":{ "shape":"Description", "documentation":"A new description for the pipeline.
" }, "environmentVariables":{ "shape":"EnvironmentVariablesMap", "documentation":"Updated environment variables shared across all compute nodes.
" }, "computations":{ "shape":"ComputeNodeList", "documentation":"Updated list of compute nodes forming the pipeline DAG.
" } }, "documentation":"Request structure for UpdatePipeline operation.
" }, "UpdatePipelineResponse":{ "type":"structure", "required":[ "version", "status" ], "members":{ "version":{ "shape":"Version", "documentation":"The new version of the pipeline created by this update.
" }, "status":{ "shape":"ResourceStatus", "documentation":"The current lifecycle status of the pipeline.
" } }, "documentation":"Response structure for UpdatePipeline operation.
" }, "UpdatePortalRequest":{ "type":"structure", "required":[ "portalId", "portalName", "portalContactEmail", "roleArn" ], "members":{ "portalId":{ "shape":"ID", "documentation":"The ID of the portal to update.
", "location":"uri", "locationName":"portalId" }, "portalName":{ "shape":"Name", "documentation":"A new friendly name for the portal.
" }, "portalDescription":{ "shape":"Description", "documentation":"A new description for the portal.
" }, "portalContactEmail":{ "shape":"Email", "documentation":"The Amazon Web Services administrator's contact email address.
" }, "portalLogoImage":{"shape":"Image"}, "roleArn":{ "shape":"IamArn", "documentation":"The ARN of a service role that allows the portal's users to access your IoT SiteWise resources on your behalf. For more information, see Using service roles for IoT SiteWise Monitor in the IoT SiteWise User Guide.
" }, "clientToken":{ "shape":"ClientToken", "documentation":"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.
", "idempotencyToken":true }, "notificationSenderEmail":{ "shape":"Email", "documentation":"The email address that sends alarm notifications.
" }, "alarms":{ "shape":"Alarms", "documentation":"Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range. For more information, see Monitoring with alarms in the IoT SiteWise Application Guide.
" }, "portalType":{ "shape":"PortalType", "documentation":"Define the type of portal. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.
The configuration entry associated with the specific portal type. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.
The status of the portal, which contains a state (UPDATING after successfully calling this operation) and any error message.
The ID of the project to update.
", "location":"uri", "locationName":"projectId" }, "projectName":{ "shape":"Name", "documentation":"A new friendly name for the project.
" }, "projectDescription":{ "shape":"Description", "documentation":"A new description for the project.
" }, "clientToken":{ "shape":"ClientToken", "documentation":"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.
", "idempotencyToken":true } } }, "UpdateProjectResponse":{ "type":"structure", "members":{} }, "UpdateTaskRequest":{ "type":"structure", "required":[ "workspaceName", "taskName" ], "members":{ "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace.
", "location":"uri", "locationName":"workspaceName" }, "taskName":{ "shape":"ResourceName", "documentation":"The name of the task to update.
", "location":"uri", "locationName":"taskName" }, "description":{ "shape":"Description", "documentation":"A new description for the task.
" }, "taskConfiguration":{ "shape":"TaskConfiguration", "documentation":"The updated task execution configuration.
" } }, "documentation":"Request structure for UpdateTask operation.
" }, "UpdateTaskResponse":{ "type":"structure", "required":[ "version", "status" ], "members":{ "version":{ "shape":"Version", "documentation":"The new version of the task created by this update.
" }, "status":{ "shape":"ResourceStatus", "documentation":"The current lifecycle status of the task.
" } }, "documentation":"Response structure for UpdateTask operation.
" }, "UpdateWorkspaceRequest":{ "type":"structure", "required":["workspaceName"], "members":{ "workspaceName":{ "shape":"WorkspaceName", "documentation":"The name of the workspace to update.
", "location":"uri", "locationName":"workspaceName" }, "workspaceDescription":{ "shape":"Description", "documentation":"A new description for the workspace.
" }, "encryptionConfiguration":{ "shape":"WorkspaceEncryptionConfiguration", "documentation":"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.
" }, "clientToken":{ "shape":"ClientToken", "documentation":"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.
", "idempotencyToken":true } } }, "UpdateWorkspaceResponse":{ "type":"structure", "required":["workspaceStatus"], "members":{ "workspaceStatus":{ "shape":"WorkspaceStatus", "documentation":"The status of the workspace after the update, which is UPDATING when the operation returns.
The IAM Identity Center ID of the user.
" } }, "documentation":"Contains information for a user identity in an access policy.
" }, "ValidationException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"The validation failed for this query.
", "error":{"httpStatusCode":400}, "exception":true }, "VariableName":{ "type":"string", "max":64, "min":1, "pattern":"^[a-z][a-z0-9_]*$" }, "VariableValue":{ "type":"structure", "members":{ "propertyId":{ "shape":"Macro", "documentation":"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.
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.
The path of the property.
" } }, "documentation":"Identifies a property value used in an expression.
" }, "Variant":{ "type":"structure", "members":{ "stringValue":{ "shape":"PropertyValueStringValue", "documentation":"Asset property data of type string (sequence of characters). The allowed pattern: \"^$|[^\\u0000-\\u001F\\u007F]+\". The max length is 1024.
" }, "integerValue":{ "shape":"PropertyValueIntegerValue", "documentation":"Asset property data of type integer (whole number).
" }, "doubleValue":{ "shape":"PropertyValueDoubleValue", "documentation":"Asset property data of type double (floating point number). The min value is -10^10. The max value is 10^10. Double.NaN is allowed.
" }, "booleanValue":{ "shape":"PropertyValueBooleanValue", "documentation":"Asset property data of type Boolean (true or false).
" }, "nullValue":{ "shape":"PropertyValueNullValue", "documentation":"The type of null asset property data with BAD and UNCERTAIN qualities.
" } }, "documentation":"Contains an asset property value (of a single type only).
" }, "Version":{ "type":"string", "max":10, "min":1, "pattern":"^(0|([1-9]{1}\\d*))$" }, "VideoDataType":{ "type":"string", "documentation":"The allowed video data types.
", "enum":["VIDEO-MP4"] }, "WarmTierRetentionPeriod":{ "type":"structure", "members":{ "numberOfDays":{ "shape":"NumberOfDays", "documentation":"The number of days the data is stored in the warm tier.
" }, "unlimited":{ "shape":"Unlimited", "documentation":"If set to true, the data is stored indefinitely in the warm tier.
" } }, "documentation":"Set this period to specify how long your data is stored in the warm tier before it is deleted. You can set this only if cold tier is enabled.
" }, "WarmTierState":{ "type":"string", "enum":[ "ENABLED", "DISABLED" ] }, "WorkspaceEncryptionConfiguration":{ "type":"structure", "required":["encryptionType"], "members":{ "encryptionType":{ "shape":"EncryptionType", "documentation":"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.
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.
Contains the encryption configuration for a workspace.
" }, "WorkspaceEncryptionConfigurationInfo":{ "type":"structure", "required":["encryptionType"], "members":{ "encryptionType":{ "shape":"EncryptionType", "documentation":"The type of encryption used for the workspace.
" }, "kmsKeyArn":{ "shape":"ARN", "documentation":"The key ARN of the KMS key used for KMS encryption if encryptionType is KMS_BASED_ENCRYPTION.
Contains the encryption configuration information for a workspace.
" }, "WorkspaceErrorDetails":{ "type":"structure", "required":[ "code", "message" ], "members":{ "code":{ "shape":"ErrorCode", "documentation":"The error code.
" }, "message":{ "shape":"Description", "documentation":"The error message.
" } }, "documentation":"Contains the details of an error associated with a workspace.
" }, "WorkspaceName":{ "type":"string", "max":64, "min":1, "pattern":"^[a-zA-Z0-9_-]+$" }, "WorkspaceState":{ "type":"string", "documentation":"The current state of a workspace. The state changes as the workspace is created, updated, or deleted.
", "enum":[ "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED" ] }, "WorkspaceStatus":{ "type":"structure", "required":["state"], "members":{ "state":{ "shape":"WorkspaceState", "documentation":"The current state of the workspace.
" }, "error":{ "shape":"WorkspaceErrorDetails", "documentation":"Contains associated error information, if any.
" } }, "documentation":"Contains information about the current status of a workspace.
" }, "WorkspaceSummaries":{ "type":"list", "member":{"shape":"WorkspaceSummary"} }, "WorkspaceSummary":{ "type":"structure", "required":[ "name", "arn", "status", "createdAt", "updatedAt" ], "members":{ "name":{ "shape":"WorkspaceName", "documentation":"The name of the workspace.
" }, "arn":{ "shape":"ARN", "documentation":"The ARN of the workspace.
" }, "status":{ "shape":"WorkspaceStatus", "documentation":"The status of the workspace.
" }, "createdAt":{ "shape":"Timestamp", "documentation":"The date the workspace was created, in Unix epoch time.
" }, "updatedAt":{ "shape":"Timestamp", "documentation":"The date the workspace was last updated, in Unix epoch time.
" } }, "documentation":"Contains summary information about a workspace, including its name, ARN, status, and creation and update timestamps.
" } }, "documentation":"Welcome to the IoT SiteWise API Reference. IoT SiteWise is an Amazon Web Services service that connects Industrial Internet of Things (IIoT) devices to the power of the Amazon Web Services Cloud. For more information, see the IoT SiteWise User Guide. For information about IoT SiteWise quotas, see Quotas in the IoT SiteWise User Guide.
" }