{ "version":"2.0", "metadata":{ "apiVersion":"2019-12-02", "endpointPrefix":"iotsitewise", "jsonVersion":"1.1", "protocol":"rest-json", "serviceFullName":"AWS IoT SiteWise", "serviceId":"IoTSiteWise", "signatureVersion":"v4", "signingName":"iotsitewise", "uid":"iotsitewise-2019-12-02" }, "operations":{ "AssociateAssets":{ "name":"AssociateAssets", "http":{ "method":"POST", "requestUri":"/assets/{assetId}/associate" }, "input":{"shape":"AssociateAssetsRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceAlreadyExistsException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"LimitExceededException"}, {"shape":"ThrottlingException"}, {"shape":"ConflictingOperationException"} ], "documentation":"

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."} }, "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":"

Associates a group (batch) of assets with an IoT SiteWise Monitor project.

", "endpoint":{"hostPrefix":"monitor."} }, "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.

", "endpoint":{"hostPrefix":"data."} }, "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":"

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.

", "endpoint":{"hostPrefix":"monitor."} }, "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 two types of asset models, `ASSET_MODEL` or `COMPONENT_MODEL`.

- ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.

- COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.

", "endpoint":{"hostPrefix":"api."} }, "CreateAssetModelCompositeModel":{ "name":"CreateAssetModelCompositeModel", "http":{ "method":"POST", "requestUri":"/asset-models/{assetModelId}/composite-models", "responseCode":202 }, "input":{"shape":"CreateAssetModelCompositeModelRequest"}, "output":{"shape":"CreateAssetModelCompositeModelResponse"}, "errors":[ {"shape":"ConflictingOperationException"}, {"shape":"InternalFailureException"}, {"shape":"InvalidRequestException"}, {"shape":"ResourceAlreadyExistsException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"LimitExceededException"} ], "documentation":"

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`.

", "endpoint":{"hostPrefix":"api."} }, "CreateBulkImportJob":{ "name":"CreateBulkImportJob", "http":{ "method":"POST", "requestUri":"/jobs", "responseCode":202 }, "input":{"shape":"CreateBulkImportJobRequest"}, "output":{"shape":"CreateBulkImportJobResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceAlreadyExistsException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"}, {"shape":"LimitExceededException"}, {"shape":"ConflictingOperationException"} ], "documentation":"

Defines a job to ingest data to IoT SiteWise from Amazon S3. For more information, see Create a bulk import job (CLI) in the Amazon Simple Storage Service User Guide.

Before you create a bulk import job, you must enable IoT SiteWise warm tier or IoT SiteWise cold tier. For more information about how to configure storage settings, see PutStorageConfiguration.

Bulk import is designed to store historical data to IoT SiteWise. It does not trigger computations or notifications on IoT SiteWise warm or cold tier storage.

", "endpoint":{"hostPrefix":"data."} }, "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":"

Creates a dashboard in an IoT SiteWise Monitor project.

", "endpoint":{"hostPrefix":"monitor."} }, "CreateGateway":{ "name":"CreateGateway", "http":{ "method":"POST", "requestUri":"/20200301/gateways", "responseCode":201 }, "input":{"shape":"CreateGatewayRequest"}, "output":{"shape":"CreateGatewayResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceAlreadyExistsException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"}, {"shape":"LimitExceededException"} ], "documentation":"

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."} }, "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":"

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.

", "endpoint":{"hostPrefix":"monitor."} }, "CreateProject":{ "name":"CreateProject", "http":{ "method":"POST", "requestUri":"/projects", "responseCode":201 }, "input":{"shape":"CreateProjectRequest"}, "output":{"shape":"CreateProjectResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"}, {"shape":"LimitExceededException"} ], "documentation":"

Creates a project in the specified portal.

Make sure that the project name and description don't contain confidential information.

", "endpoint":{"hostPrefix":"monitor."} }, "DeleteAccessPolicy":{ "name":"DeleteAccessPolicy", "http":{ "method":"DELETE", "requestUri":"/access-policies/{accessPolicyId}", "responseCode":204 }, "input":{"shape":"DeleteAccessPolicyRequest"}, "output":{"shape":"DeleteAccessPolicyResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"} ], "documentation":"

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."} }, "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.

", "endpoint":{"hostPrefix":"api."} }, "DeleteAssetModel":{ "name":"DeleteAssetModel", "http":{ "method":"DELETE", "requestUri":"/asset-models/{assetModelId}", "responseCode":202 }, "input":{"shape":"DeleteAssetModelRequest"}, "output":{"shape":"DeleteAssetModelResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"}, {"shape":"ConflictingOperationException"} ], "documentation":"

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"} ], "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."} }, "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."} }, "DeleteGateway":{ "name":"DeleteGateway", "http":{ "method":"DELETE", "requestUri":"/20200301/gateways/{gatewayId}" }, "input":{"shape":"DeleteGatewayRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"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."} }, "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."} }, "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.

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.

", "endpoint":{"hostPrefix":"api."} }, "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."} }, "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.

", "endpoint":{"hostPrefix":"api."} }, "DescribeAssetModel":{ "name":"DescribeAssetModel", "http":{ "method":"GET", "requestUri":"/asset-models/{assetModelId}" }, "input":{"shape":"DescribeAssetModelRequest"}, "output":{"shape":"DescribeAssetModelResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"} ], "documentation":"

Retrieves information about an asset model.

", "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."} }, "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."} }, "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."} }, "DescribeDefaultEncryptionConfiguration":{ "name":"DescribeDefaultEncryptionConfiguration", "http":{ "method":"GET", "requestUri":"/configuration/account/encryption" }, "input":{"shape":"DescribeDefaultEncryptionConfigurationRequest"}, "output":{"shape":"DescribeDefaultEncryptionConfigurationResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"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."} }, "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":"

Retrieves information about a gateway capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway.

", "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."} }, "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."} }, "DescribeStorageConfiguration":{ "name":"DescribeStorageConfiguration", "http":{ "method":"GET", "requestUri":"/configuration/account/storage" }, "input":{"shape":"DescribeStorageConfigurationRequest"}, "output":{"shape":"DescribeStorageConfigurationResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"}, {"shape":"LimitExceededException"}, {"shape":"ConflictingOperationException"} ], "documentation":"

Retrieves information about the storage configuration for IoT SiteWise.

", "endpoint":{"hostPrefix":"api."} }, "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.

", "endpoint":{"hostPrefix":"api."} }, "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.

", "endpoint":{"hostPrefix":"data."} }, "GetAssetPropertyValue":{ "name":"GetAssetPropertyValue", "http":{ "method":"GET", "requestUri":"/properties/latest" }, "input":{"shape":"GetAssetPropertyValueRequest"}, "output":{"shape":"GetAssetPropertyValueResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

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.

", "endpoint":{"hostPrefix":"data."} }, "GetAssetPropertyValueHistory":{ "name":"GetAssetPropertyValueHistory", "http":{ "method":"GET", "requestUri":"/properties/history" }, "input":{"shape":"GetAssetPropertyValueHistoryRequest"}, "output":{"shape":"GetAssetPropertyValueHistoryResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

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.

", "endpoint":{"hostPrefix":"data."} }, "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.

", "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."} }, "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":"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:

- List child assets associated to a parent asset by a hierarchy that you specify.

- List an asset's parent asset.

", "endpoint":{"hostPrefix":"api."} }, "ListBulkImportJobs":{ "name":"ListBulkImportJobs", "http":{ "method":"GET", "requestUri":"/jobs" }, "input":{"shape":"ListBulkImportJobsRequest"}, "output":{"shape":"ListBulkImportJobsResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InternalFailureException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"

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`.

", "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."} }, "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."} }, "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."} }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"GET", "requestUri":"/tags" }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictingOperationException"}, {"shape":"LimitExceededException"}, {"shape":"UnauthorizedException"} ], "documentation":"

Retrieves the list of tags for an IoT SiteWise resource.

", "endpoint":{"hostPrefix":"api."} }, "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."} }, "PutDefaultEncryptionConfiguration":{ "name":"PutDefaultEncryptionConfiguration", "http":{ "method":"POST", "requestUri":"/configuration/account/encryption" }, "input":{"shape":"PutDefaultEncryptionConfigurationRequest"}, "output":{"shape":"PutDefaultEncryptionConfigurationResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"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."} }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/tags" }, "input":{"shape":"TagResourceRequest"}, "output":{"shape":"TagResourceResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictingOperationException"}, {"shape":"LimitExceededException"}, {"shape":"UnauthorizedException"}, {"shape":"TooManyTagsException"} ], "documentation":"

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":"

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"} ], "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.

This operation overwrites the existing model with the provided model. To avoid deleting your asset model's properties or hierarchies, you must include their IDs and definitions in the updated asset model payload. For more information, see DescribeAssetModel.

If you remove a property from an asset model, IoT SiteWise deletes all previous data for that property. If you remove a hierarchy definition from an asset model, IoT SiteWise disassociates every asset associated with that hierarchy. You can't change the type or data type of an existing property.

", "endpoint":{"hostPrefix":"api."} }, "UpdateAssetModelCompositeModel":{ "name":"UpdateAssetModelCompositeModel", "http":{ "method":"PUT", "requestUri":"/asset-models/{assetModelId}/composite-models/{assetModelCompositeModelId}", "responseCode":202 }, "input":{"shape":"UpdateAssetModelCompositeModelRequest"}, "output":{"shape":"UpdateAssetModelCompositeModelResponse"}, "errors":[ {"shape":"ConflictingOperationException"}, {"shape":"InternalFailureException"}, {"shape":"InvalidRequestException"}, {"shape":"ResourceAlreadyExistsException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"LimitExceededException"} ], "documentation":"

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:

1. Submit an `UpdateAssetModelCompositeModel` request with the entire existing property removed.

2. 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`.

", "endpoint":{"hostPrefix":"api."} }, "UpdateAssetProperty":{ "name":"UpdateAssetProperty", "http":{ "method":"PUT", "requestUri":"/assets/{assetId}/properties/{propertyId}" }, "input":{"shape":"UpdateAssetPropertyRequest"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"}, {"shape":"ConflictingOperationException"} ], "documentation":"

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.

", "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":"

Updates an IoT SiteWise Monitor dashboard.

", "endpoint":{"hostPrefix":"monitor."} }, "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. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway.

", "endpoint":{"hostPrefix":"api."} }, "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":"

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":"

Updates an IoT SiteWise Monitor project.

", "endpoint":{"hostPrefix":"monitor."} } }, "shapes":{ "ARN":{ "type":"string", "max":1600, "min":1, "pattern":"^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\\/_\\.]+$" }, "AccessDeniedException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

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.

" }, "creationDate":{ "shape":"Timestamp", "documentation":"

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.

" } }, "documentation":"

Contains the summary of the actions.

" }, "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":"ARN", "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 }, "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`.

" }, "properties":{ "shape":"AssetProperties", "documentation":"

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.

" }, "name":{ "shape":"Name", "documentation":"

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.

" }, "description":{ "shape":"Description", "documentation":"

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`.

" }, "name":{ "shape":"Name", "documentation":"

The hierarchy name provided in the CreateAssetModel or UpdateAssetModel API operation.

" }, "externalId":{ "shape":"ExternalId", "documentation":"

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.

" } }, "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"} }, "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`.

" }, "properties":{ "shape":"AssetModelProperties", "documentation":"

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":{ "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`.

" }, "properties":{ "shape":"AssetModelPropertyDefinitions", "documentation":"

The asset property definitions for this composite model.

" }, "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.

" } }, "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 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 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.

" }, "description":{ "shape":"Description", "documentation":"

The description of the 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.

" }, "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.

" }, "externalId":{ "shape":"ExternalId", "documentation":"

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.

" } }, "documentation":"

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":{ "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.

" }, "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.

" } }, "documentation":"

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.

" }, "name":{ "shape":"Name", "documentation":"

The name of the asset model property.

" }, "dataType":{ "shape":"PropertyDataType", "documentation":"

The data type of the asset model 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.

" }, "unit":{ "shape":"PropertyUnit", "documentation":"

The unit of the asset model property, such as `Newtons` or `RPM`.

" }, "type":{ "shape":"PropertyType", "documentation":"

The property type (see `PropertyType`).

" }, "path":{ "shape":"AssetModelPropertyPath", "documentation":"

The structured path to the property from the root of the asset model.

" }, "externalId":{ "shape":"ExternalId", "documentation":"

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.

" } }, "documentation":"

Contains information about an asset model property.

" }, "AssetModelPropertyDefinition":{ "type":"structure", "required":[ "name", "dataType", "type" ], "members":{ "name":{ "shape":"Name", "documentation":"

The name of the property definition.

" }, "dataType":{ "shape":"PropertyDataType", "documentation":"

The data type of the property definition.

If you specify `STRUCT`, you must also specify `dataTypeSpec` to identify the type of the structure for this property.

" }, "dataTypeSpec":{ "shape":"Name", "documentation":"

The data type of the structure for this property. This parameter is required on properties that have the `STRUCT` data type.

The options for this parameter depend on the type of the composite model in which you define this property. Use `AWS/ALARM_STATE` for alarm state in alarm composite models.

" }, "unit":{ "shape":"PropertyUnit", "documentation":"

The unit of the property definition, such as `Newtons` or `RPM`.

" }, "type":{ "shape":"PropertyType", "documentation":"

The property definition type (see `PropertyType`). You can only specify one type in a property definition.

" }, "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.

" } }, "documentation":"

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.

" }, "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.

" }, "unit":{ "shape":"PropertyUnit", "documentation":"

The unit (such as `Newtons` or `RPM`) of the property.

" }, "type":{"shape":"PropertyType"}, "assetModelCompositeModelId":{ "shape":"ID", "documentation":"

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.

" }, "externalId":{ "shape":"ExternalId", "documentation":"

The external ID of the property. For more information, see Using external IDs in the IoT SiteWise User Guide.

" } }, "documentation":"

Contains a summary of a property associated with a model.

" }, "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).

" }, "arn":{ "shape":"ARN", "documentation":"

The ARN of the asset model, which has the following format.

`arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}`

" }, "name":{ "shape":"Name", "documentation":"

The name of the asset model.

" }, "description":{ "shape":"Description", "documentation":"

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.

" }, "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.

" }, "externalId":{ "shape":"ExternalId", "documentation":"

The external ID of the asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.

" } }, "documentation":"

Contains a summary of an asset model.

" }, "AssetModelType":{ "type":"string", "enum":[ "ASSET_MODEL", "COMPONENT_MODEL" ] }, "AssetProperties":{ "type":"list", "member":{"shape":"AssetProperty"} }, "AssetProperty":{ "type":"structure", "required":[ "id", "name", "dataType" ], "members":{ "id":{ "shape":"ID", "documentation":"

The ID of the asset property.

" }, "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.

" }, "notification":{ "shape":"PropertyNotification", "documentation":"

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.

" }, "unit":{ "shape":"PropertyUnit", "documentation":"

The unit (such as `Newtons` or `RPM`) of the asset property.

" }, "path":{ "shape":"AssetPropertyPath", "documentation":"

The structured path to the property from the root of the asset.

" }, "externalId":{ "shape":"ExternalId", "documentation":"

The external ID of the asset property. For more information, see Using external IDs in the IoT SiteWise User Guide.

" } }, "documentation":"

Contains asset property information.

" }, "AssetPropertyAlias":{ "type":"string", "max":2048, "min":1, "pattern":"[^\\u0000-\\u001F\\u007F]+" }, "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.

" }, "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.

" }, "unit":{ "shape":"PropertyUnit", "documentation":"

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.

" }, "externalId":{ "shape":"ExternalId", "documentation":"

The external ID of the property. For more information, see Using external IDs in the IoT SiteWise User Guide.

" } }, "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`).

" }, "timestamp":{ "shape":"TimeInNanos", "documentation":"

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`.

" }, "relationshipType":{ "shape":"AssetRelationshipType", "documentation":"

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.

" } }, "documentation":"

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.

" }, "arn":{ "shape":"ARN", "documentation":"

The ARN of the asset, which has the following format.

`arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}`

" }, "name":{ "shape":"Name", "documentation":"

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.

" }, "description":{ "shape":"Description", "documentation":"

A description for the asset.

" }, "externalId":{ "shape":"ExternalId", "documentation":"

The external ID of the asset. For more information, see Using external IDs in the IoT SiteWise User Guide.

" } }, "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.

", "location":"uri", "locationName":"assetId" }, "hierarchyId":{ "shape":"CustomID", "documentation":"

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.

" }, "childAssetId":{ "shape":"CustomID", "documentation":"

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.

" }, "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 } } }, "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.

", "location":"querystring", "locationName":"assetId" }, "propertyId":{ "shape":"CustomID", "documentation":"

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.

", "location":"querystring", "locationName":"propertyId" }, "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 } } }, "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.

" }, "arn":{ "shape":"ARN", "documentation":"

The ARN of the asset, which has the following format.

`arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}`

" }, "name":{ "shape":"Name", "documentation":"

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.

" }, "description":{ "shape":"Description", "documentation":"

A description for the asset.

" }, "externalId":{ "shape":"ExternalId", "documentation":"

The external ID of the asset. For more information, see Using external IDs in the IoT SiteWise User Guide.

" } }, "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" ] }, "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.

" } } }, "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.

" }, "aggregateTypes":{ "shape":"AggregateTypes", "documentation":"

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`

" } }, "documentation":"

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.

" }, "BatchGetAssetPropertyAggregatesErrorCode":{ "type":"string", "enum":[ "ResourceNotFoundException", "InvalidRequestException", "AccessDeniedException" ] }, "BatchGetAssetPropertyAggregatesErrorEntries":{ "type":"list", "member":{"shape":"BatchGetAssetPropertyAggregatesErrorEntry"} }, "BatchGetAssetPropertyAggregatesErrorEntry":{ "type":"structure", "required":[ "errorCode", "errorMessage", "entryId" ], "members":{ "errorCode":{ "shape":"BatchGetAssetPropertyAggregatesErrorCode", "documentation":"

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.

" } } }, "BatchGetAssetPropertyAggregatesResponse":{ "type":"structure", "required":[ "errorEntries", "successEntries", "skippedEntries" ], "members":{ "errorEntries":{ "shape":"BatchGetAssetPropertyAggregatesErrorEntries", "documentation":"

A list of the errors (if any) associated with the batch request. Each error entry contains the `entryId` of the entry that failed.

" }, "successEntries":{ "shape":"BatchGetAssetPropertyAggregatesSuccessEntries", "documentation":"

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.

" }, "skippedEntries":{ "shape":"BatchGetAssetPropertyAggregatesSkippedEntries", "documentation":"

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.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

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.

" } }, "documentation":"

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.

" }, "BatchGetAssetPropertyValueErrorCode":{ "type":"string", "enum":[ "ResourceNotFoundException", "InvalidRequestException", "AccessDeniedException" ] }, "BatchGetAssetPropertyValueErrorEntries":{ "type":"list", "member":{"shape":"BatchGetAssetPropertyValueErrorEntry"} }, "BatchGetAssetPropertyValueErrorEntry":{ "type":"structure", "required":[ "errorCode", "errorMessage", "entryId" ], "members":{ "errorCode":{ "shape":"BatchGetAssetPropertyValueErrorCode", "documentation":"

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.

" }, "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`

" } }, "documentation":"

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.

" }, "BatchGetAssetPropertyValueHistoryErrorCode":{ "type":"string", "enum":[ "ResourceNotFoundException", "InvalidRequestException", "AccessDeniedException" ] }, "BatchGetAssetPropertyValueHistoryErrorEntries":{ "type":"list", "member":{"shape":"BatchGetAssetPropertyValueHistoryErrorEntry"} }, "BatchGetAssetPropertyValueHistoryErrorEntry":{ "type":"structure", "required":[ "errorCode", "errorMessage", "entryId" ], "members":{ "errorCode":{ "shape":"BatchGetAssetPropertyValueHistoryErrorCode", "documentation":"

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.

" }, "BatchGetAssetPropertyValueHistoryErrorInfo":{ "type":"structure", "required":[ "errorCode", "errorTimestamp" ], "members":{ "errorCode":{ "shape":"BatchGetAssetPropertyValueHistoryErrorCode", "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.

" }, "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.

" } } }, "BatchGetAssetPropertyValueHistoryResponse":{ "type":"structure", "required":[ "errorEntries", "successEntries", "skippedEntries" ], "members":{ "errorEntries":{ "shape":"BatchGetAssetPropertyValueHistoryErrorEntries", "documentation":"

A list of the errors (if any) associated with the batch request. Each error entry contains the `entryId` of the entry that failed.

" }, "successEntries":{ "shape":"BatchGetAssetPropertyValueHistorySuccessEntries", "documentation":"

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.

" }, "skippedEntries":{ "shape":"BatchGetAssetPropertyValueHistorySkippedEntries", "documentation":"

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.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

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.

" }, "successEntries":{ "shape":"BatchGetAssetPropertyValueSuccessEntries", "documentation":"

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.

" }, "skippedEntries":{ "shape":"BatchGetAssetPropertyValueSkippedEntries", "documentation":"

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.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

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":{ "entries":{ "shape":"PutAssetPropertyValueEntries", "documentation":"

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.

" } } }, "Bucket":{ "type":"string", "max":63, "min":3 }, "CapabilityConfiguration":{ "type":"string", "max":104857600, "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" ] }, "ClientToken":{ "type":"string", "max":64, "min":36, "pattern":"\\S{36,64}" }, "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.

" }, "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.

" }, "ColumnsList":{ "type":"list", "member":{"shape":"ColumnInfo"} }, "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` .

" }, "CompositionRelationship":{ "type":"list", "member":{"shape":"CompositionRelationshipItem"} }, "CompositionRelationshipItem":{ "type":"structure", "members":{ "id":{ "shape":"ID", "documentation":"

The ID of the component.

" } }, "documentation":"

Represents a composite model that composed an asset model of type `COMPONENT_MODEL`.

" }, "CompositionRelationshipSummaries":{ "type":"list", "member":{"shape":"CompositionRelationshipSummary"} }, "CompositionRelationshipSummary":{ "type":"structure", "required":[ "assetModelId", "assetModelCompositeModelId", "assetModelCompositeModelType" ], "members":{ "assetModelId":{ "shape":"ID", "documentation":"

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`.

" } }, "documentation":"

Contains a summary of the components of the composite model.

" }, "ComputeLocation":{ "type":"string", "enum":[ "EDGE", "CLOUD" ] }, "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 }, "CoreDeviceThingName":{ "type":"string", "max":128, "min":1 }, "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.

" }, "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.

" } } }, "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}`

" } } }, "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" }, "parentAssetModelCompositeModelId":{ "shape":"CustomID", "documentation":"

The ID of the parent composite model in this asset model relationship.

" }, "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.

" }, "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, friendly name for the composite model.

" }, "assetModelCompositeModelType":{ "shape":"Name", "documentation":"

The composite model type. Valid values are `AWS/ALARM`, `CUSTOM`, or `AWS/L4E_ANOMALY`.

" }, "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 }, "composedAssetModelId":{ "shape":"CustomID", "documentation":"

The ID of a composite model on this asset.

" }, "assetModelCompositeModelProperties":{ "shape":"AssetModelPropertyDefinitions", "documentation":"

The property definitions of the composite model. For more information, see <LINK>.

You can specify up to 200 properties per composite model. For more information, see Quotas in the IoT SiteWise User Guide.

" } } }, "CreateAssetModelCompositeModelResponse":{ "type":"structure", "required":[ "assetModelCompositeModelId", "assetModelCompositeModelPath", "assetModelStatus" ], "members":{ "assetModelCompositeModelId":{ "shape":"ID", "documentation":"

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"} } }, "CreateAssetModelRequest":{ "type":"structure", "required":["assetModelName"], "members":{ "assetModelName":{ "shape":"Name", "documentation":"

A unique, friendly name for the asset model.

" }, "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 <LINK>.

" }, "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 model. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.

" }, "assetModelId":{ "shape":"ID", "documentation":"

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.

" }, "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.

" } } }, "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}`

" }, "assetModelStatus":{ "shape":"AssetModelStatus", "documentation":"

The status of the asset model, which contains a state (`CREATING` after successfully calling this operation) and any error message.

" } } }, "CreateAssetRequest":{ "type":"structure", "required":[ "assetName", "assetModelId" ], "members":{ "assetName":{ "shape":"Name", "documentation":"

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.

" }, "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.

" }, "assetId":{ "shape":"ID", "documentation":"

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.

" } } }, "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}`

" }, "assetStatus":{ "shape":"AssetStatus", "documentation":"

The status of the asset, which contains a state (`CREATING` after successfully calling this operation) and any error message.

" } } }, "CreateBulkImportJobRequest":{ "type":"structure", "required":[ "jobName", "jobRoleArn", "files", "errorReportLocation", "jobConfiguration" ], "members":{ "jobName":{ "shape":"Name", "documentation":"

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.

" }, "errorReportLocation":{ "shape":"ErrorReportLocation", "documentation":"

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.

" } } }, "CreateBulkImportJobResponse":{ "type":"structure", "required":[ "jobId", "jobName", "jobStatus" ], "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.

" } } }, "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. For detailed information, see Creating 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}`

" } } }, "CreateGatewayRequest":{ "type":"structure", "required":[ "gatewayName", "gatewayPlatform" ], "members":{ "gatewayName":{ "shape":"Name", "documentation":"

A unique, friendly name for the gateway.

" }, "gatewayPlatform":{ "shape":"GatewayPlatform", "documentation":"

The gateway's platform. You can only specify one platform in a gateway.

" }, "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}`

" } } }, "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":"ARN", "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`

" }, "notificationSenderEmail":{ "shape":"Email", "documentation":"

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.

" }, "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.

" } } }, "CreatePortalResponse":{ "type":"structure", "required":[ "portalId", "portalArn", "portalStartUrl", "portalStatus", "ssoApplicationId" ], "members":{ "portalId":{ "shape":"ID", "documentation":"

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}`

" }, "portalStartUrl":{ "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.

" }, "portalStatus":{ "shape":"PortalStatus", "documentation":"

The status of the portal, which contains a state (`CREATING` after successfully calling this operation) and any error message.

" }, "ssoApplicationId":{ "shape":"SSOApplicationId", "documentation":"

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}`

" } } }, "Csv":{ "type":"structure", "required":["columnNames"], "members":{ "columnNames":{ "shape":"ColumnNames", "documentation":"

The column names specified in the .csv file.

" } }, "documentation":"

A .CSV file.

" }, "CustomID":{ "type":"string", "max":139, "min":13, "pattern":"^[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.

" }, "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":{ } }, "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" } } }, "DeleteAssetModelCompositeModelResponse":{ "type":"structure", "required":["assetModelStatus"], "members":{ "assetModelStatus":{"shape":"AssetModelStatus"} } }, "DeleteAssetModelRequest":{ "type":"structure", "required":["assetModelId"], "members":{ "assetModelId":{ "shape":"CustomID", "documentation":"

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.

", "location":"uri", "locationName":"assetModelId" }, "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" } } }, "DeleteAssetModelResponse":{ "type":"structure", "required":["assetModelStatus"], "members":{ "assetModelStatus":{ "shape":"AssetModelStatus", "documentation":"

The status of the asset model, which contains a state (`DELETING` after successfully calling this operation) and any error message.

" } } }, "DeleteAssetRequest":{ "type":"structure", "required":["assetId"], "members":{ "assetId":{ "shape":"CustomID", "documentation":"

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.

", "location":"uri", "locationName":"assetId" }, "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" } } }, "DeleteAssetResponse":{ "type":"structure", "required":["assetStatus"], "members":{ "assetStatus":{ "shape":"AssetStatus", "documentation":"

The status of the asset, which contains a state (`DELETING` after successfully calling this operation) and any error message.

" } } }, "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":{ } }, "DeleteFilesAfterImport":{"type":"boolean"}, "DeleteGatewayRequest":{ "type":"structure", "required":["gatewayId"], "members":{ "gatewayId":{ "shape":"ID", "documentation":"

The ID of the gateway to delete.

", "location":"uri", "locationName":"gatewayId" } } }, "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.

" } } }, "DeleteProjectRequest":{ "type":"structure", "required":["projectId"], "members":{ "projectId":{ "shape":"ID", "documentation":"

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":{ } }, "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.

", "location":"querystring", "locationName":"assetId" }, "propertyId":{ "shape":"CustomID", "documentation":"

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.

", "location":"querystring", "locationName":"propertyId" }, "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 } } }, "DescribeAccessPolicyRequest":{ "type":"structure", "required":["accessPolicyId"], "members":{ "accessPolicyId":{ "shape":"ID", "documentation":"

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}`

" }, "accessPolicyIdentity":{ "shape":"Identity", "documentation":"

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.

" }, "accessPolicyCreationDate":{ "shape":"Timestamp", "documentation":"

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.

" } } }, "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.

", "location":"uri", "locationName":"assetId" }, "assetCompositeModelId":{ "shape":"CustomID", "documentation":"

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.

", "location":"uri", "locationName":"assetCompositeModelId" } } }, "DescribeAssetCompositeModelResponse":{ "type":"structure", "required":[ "assetId", "assetCompositeModelId", "assetCompositeModelPath", "assetCompositeModelName", "assetCompositeModelDescription", "assetCompositeModelType", "assetCompositeModelProperties", "assetCompositeModelSummaries" ], "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 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.

" }, "assetCompositeModelPath":{ "shape":"AssetCompositeModelPath", "documentation":"

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`.

" }, "assetCompositeModelProperties":{ "shape":"AssetProperties", "documentation":"

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.

", "location":"uri", "locationName":"assetModelId" }, "assetModelCompositeModelId":{ "shape":"CustomID", "documentation":"

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.

", "location":"uri", "locationName":"assetModelCompositeModelId" } } }, "DescribeAssetModelCompositeModelResponse":{ "type":"structure", "required":[ "assetModelId", "assetModelCompositeModelId", "assetModelCompositeModelPath", "assetModelCompositeModelName", "assetModelCompositeModelDescription", "assetModelCompositeModelType", "assetModelCompositeModelProperties", "assetModelCompositeModelSummaries" ], "members":{ "assetModelId":{ "shape":"ID", "documentation":"

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`.

" }, "assetModelCompositeModelProperties":{ "shape":"AssetModelProperties", "documentation":"

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.

" }, "assetModelCompositeModelSummaries":{ "shape":"AssetModelCompositeModelSummaries", "documentation":"

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.

" } } }, "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.

", "location":"uri", "locationName":"assetModelId" }, "excludeProperties":{ "shape":"ExcludeProperties", "documentation":"

Whether or not to exclude asset model properties from the response.

", "location":"querystring", "locationName":"excludeProperties" } } }, "DescribeAssetModelResponse":{ "type":"structure", "required":[ "assetModelId", "assetModelArn", "assetModelName", "assetModelDescription", "assetModelProperties", "assetModelHierarchies", "assetModelCreationDate", "assetModelLastUpdateDate", "assetModelStatus" ], "members":{ "assetModelId":{ "shape":"ID", "documentation":"

The ID of the asset model, in UUID format.

" }, "assetModelArn":{ "shape":"ARN", "documentation":"

The ARN of the asset model, which has the following format.

`arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}`

" }, "assetModelName":{ "shape":"Name", "documentation":"

The name of the asset model.

" }, "assetModelDescription":{ "shape":"Description", "documentation":"

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.

" }, "assetModelHierarchies":{ "shape":"AssetModelHierarchies", "documentation":"

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.

" }, "assetModelCompositeModels":{ "shape":"AssetModelCompositeModels", "documentation":"

The list of built-in composite models for the asset model, such as those with those of type `AWS/ALARMS`.

" }, "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.

" }, "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.

" }, "assetModelCompositeModelSummaries":{ "shape":"AssetModelCompositeModelSummaries", "documentation":"

The list of the immediate child custom composite model summaries for the asset model.

" }, "assetModelExternalId":{ "shape":"ExternalId", "documentation":"

The external ID of the asset model, if any.

" } } }, "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.

", "location":"uri", "locationName":"assetId" }, "propertyId":{ "shape":"CustomID", "documentation":"

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.

", "location":"uri", "locationName":"propertyId" } } }, "DescribeAssetPropertyResponse":{ "type":"structure", "required":[ "assetId", "assetName", "assetModelId" ], "members":{ "assetId":{ "shape":"ID", "documentation":"

The ID of the asset, in UUID format.

" }, "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`.

" }, "compositeModel":{ "shape":"CompositeModelProperty", "documentation":"

The composite model that declares this asset property, if this asset property exists in a composite model.

" }, "assetExternalId":{ "shape":"ExternalId", "documentation":"

The external ID of the asset. For more information, see Using external IDs in the IoT SiteWise User Guide.

" } } }, "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.

", "location":"uri", "locationName":"assetId" }, "excludeProperties":{ "shape":"ExcludeProperties", "documentation":"

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.

" }, "assetArn":{ "shape":"ARN", "documentation":"

The ARN of the asset, which has the following format.

`arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}`

" }, "assetName":{ "shape":"Name", "documentation":"

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.

" }, "assetHierarchies":{ "shape":"AssetHierarchies", "documentation":"

A list of asset hierarchies that each contain a `hierarchyId`. A hierarchy specifies allowed parent/child asset relationships.

" }, "assetCompositeModels":{ "shape":"AssetCompositeModels", "documentation":"

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.

" }, "assetExternalId":{ "shape":"ExternalId", "documentation":"

The external ID of the asset, if any.

" } } }, "DescribeBulkImportJobRequest":{ "type":"structure", "required":["jobId"], "members":{ "jobId":{ "shape":"ID", "documentation":"

The ID of the job.

", "location":"uri", "locationName":"jobId" } } }, "DescribeBulkImportJobResponse":{ "type":"structure", "required":[ "jobId", "jobName", "jobStatus", "jobRoleArn", "files", "errorReportLocation", "jobConfiguration", "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.

" }, "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.

" }, "errorReportLocation":{ "shape":"ErrorReportLocation", "documentation":"

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.

" } } }, "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}`

" }, "dashboardName":{ "shape":"Name", "documentation":"

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.

" } } }, "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`.

" }, "configurationStatus":{ "shape":"ConfigurationStatus", "documentation":"

The status of the account configuration. This contains the `ConfigurationState`. If there's an error, it also contains the `ErrorDetails`.

" } } }, "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 from the IoT SiteWise console, your OPC-UA capability configuration has the namespace `iotsitewise:opcuacollector:version`, where `version` is a number such as `1`.

", "location":"uri", "locationName":"capabilityNamespace" } } }, "DescribeGatewayCapabilityConfigurationResponse":{ "type":"structure", "required":[ "gatewayId", "capabilityNamespace", "capabilityConfiguration", "capabilitySyncStatus" ], "members":{ "gatewayId":{ "shape":"ID", "documentation":"

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 capability configuration. The sync status can be one of the following:

- `IN_SYNC` – The gateway is running the capability configuration.

- `OUT_OF_SYNC` – The gateway hasn't received the capability configuration.

- `SYNC_FAILED` – The gateway rejected the capability configuration.

" } } }, "DescribeGatewayRequest":{ "type":"structure", "required":["gatewayId"], "members":{ "gatewayId":{ "shape":"ID", "documentation":"

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":"Name", "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}`

" }, "gatewayPlatform":{ "shape":"GatewayPlatform", "documentation":"

The gateway's platform.

" }, "gatewayCapabilitySummaries":{ "shape":"GatewayCapabilitySummaries", "documentation":"

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":{ } }, "DescribeLoggingOptionsResponse":{ "type":"structure", "required":["loggingOptions"], "members":{ "loggingOptions":{ "shape":"LoggingOptions", "documentation":"

The current logging options.

" } } }, "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}`

" }, "portalName":{ "shape":"Name", "documentation":"

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.

" }, "portalStartUrl":{ "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.

" }, "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":"ARN", "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.

" } } }, "DescribeProjectRequest":{ "type":"structure", "required":["projectId"], "members":{ "projectId":{ "shape":"ID", "documentation":"

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}`

" }, "projectName":{ "shape":"Name", "documentation":"

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.

" } } }, "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.

" }, "multiLayerStorage":{ "shape":"MultiLayerStorage", "documentation":"

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.

" } } }, "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.

", "location":"querystring", "locationName":"assetId" }, "propertyId":{ "shape":"CustomID", "documentation":"

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.

", "location":"querystring", "locationName":"propertyId" } } }, "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.

" }, "dataTypeSpec":{ "shape":"Name", "documentation":"

The data type of the structure for this time series. This parameter is required for time series that have the `STRUCT` data type.

The options for this parameter depend on the type of the composite model in which you created the asset property that is associated with your time series. Use `AWS/ALARM_STATE` for alarm state in alarm composite models.

" }, "timeSeriesCreationDate":{ "shape":"Timestamp", "documentation":"

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}`

" } } }, "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" ] }, "DetailedErrorMessage":{"type":"string"}, "DetailedErrors":{ "type":"list", "member":{"shape":"DetailedError"} }, "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.

", "location":"uri", "locationName":"assetId" }, "hierarchyId":{ "shape":"CustomID", "documentation":"

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.

" }, "childAssetId":{ "shape":"CustomID", "documentation":"

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.

" }, "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 } } }, "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.

", "location":"querystring", "locationName":"assetId" }, "propertyId":{ "shape":"CustomID", "documentation":"

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.

", "location":"querystring", "locationName":"propertyId" }, "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 } } }, "DisassociatedDataStorageState":{ "type":"string", "enum":[ "ENABLED", "DISABLED" ] }, "Email":{ "type":"string", "max":255, "min":1, "pattern":"[^@]+@[^@]+" }, "EncryptionType":{ "type":"string", "enum":[ "SITEWISE_DEFAULT_ENCRYPTION", "KMS_BASED_ENCRYPTION" ] }, "EntryId":{ "type":"string", "max":64, "min":1, "pattern":"^[a-zA-Z0-9_-]+$" }, "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.

" }, "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.

" } } }, "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. The default is 25.

" } } }, "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.

" } } }, "Expression":{ "type":"string", "max":1024, "min":1 }, "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_]+" }, "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.

" } }, "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.

" } }, "documentation":"

The file format of the data in S3.

" }, "Files":{ "type":"list", "member":{"shape":"File"} }, "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 from the IoT SiteWise console, your OPC-UA capability configuration has the namespace `iotsitewise:opcuacollector:version`, where `version` is a number such as `1`.

" }, "capabilitySyncStatus":{ "shape":"CapabilitySyncStatus", "documentation":"

The synchronization status of the capability configuration. The sync status can be one of the following:

- `IN_SYNC` – The gateway is running the capability configuration.

- `OUT_OF_SYNC` – The gateway hasn't received the capability configuration.

- `SYNC_FAILED` – The gateway rejected the capability configuration.

" } }, "documentation":"

Contains a summary of a gateway capability configuration.

" }, "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.

" } }, "documentation":"

Contains a gateway's platform information.

" }, "GatewaySummaries":{ "type":"list", "member":{"shape":"GatewaySummary"} }, "GatewaySummary":{ "type":"structure", "required":[ "gatewayId", "gatewayName", "creationDate", "lastUpdateDate" ], "members":{ "gatewayId":{ "shape":"ID", "documentation":"

The ID of the gateway device.

" }, "gatewayName":{ "shape":"Name", "documentation":"

The name of the asset.

" }, "gatewayPlatform":{"shape":"GatewayPlatform"}, "gatewayCapabilitySummaries":{ "shape":"GatewayCapabilitySummaries", "documentation":"

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.

" }, "GetAssetPropertyAggregatesRequest":{ "type":"structure", "required":[ "aggregateTypes", "resolution", "startDate", "endDate" ], "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.

", "location":"querystring", "locationName":"propertyAlias" }, "aggregateTypes":{ "shape":"AggregateTypes", "documentation":"

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`

", "location":"querystring", "locationName":"timeOrdering" }, "nextToken":{ "shape":"NextToken", "documentation":"

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.

", "location":"querystring", "locationName":"maxResults" } } }, "GetAssetPropertyAggregatesResponse":{ "type":"structure", "required":["aggregatedValues"], "members":{ "aggregatedValues":{ "shape":"AggregatedValues", "documentation":"

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.

", "location":"querystring", "locationName":"propertyAlias" }, "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" }, "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`

", "location":"querystring", "locationName":"timeOrdering" }, "nextToken":{ "shape":"NextToken", "documentation":"

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.

", "location":"querystring", "locationName":"maxResults" } } }, "GetAssetPropertyValueHistoryResponse":{ "type":"structure", "required":["assetPropertyValueHistory"], "members":{ "assetPropertyValueHistory":{ "shape":"AssetPropertyValueHistory", "documentation":"

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.

", "location":"querystring", "locationName":"propertyAlias" } } }, "GetAssetPropertyValueResponse":{ "type":"structure", "members":{ "propertyValue":{ "shape":"AssetPropertyValue", "documentation":"

The current asset property value.

" } } }, "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.

", "location":"querystring", "locationName":"propertyAlias" }, "startTimeInSeconds":{ "shape":"TimeInSeconds", "documentation":"

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`.

", "location":"querystring", "locationName":"startTimeOffsetInNanos" }, "endTimeInSeconds":{ "shape":"TimeInSeconds", "documentation":"

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`.

", "location":"querystring", "locationName":"endTimeOffsetInNanos" }, "quality":{ "shape":"Quality", "documentation":"

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.

", "location":"querystring", "locationName":"type" }, "intervalWindowInSeconds":{ "shape":"IntervalWindowInSeconds", "documentation":"

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.

" } } }, "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 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.

" } }, "documentation":"

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.

" }, "GroupIdentity":{ "type":"structure", "required":["id"], "members":{ "id":{ "shape":"IdentityId", "documentation":"

The IAM Identity Center ID of the group.

" } }, "documentation":"

Contains information for a group identity in an access policy.

" }, "IAMRoleIdentity":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"ARN", "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":"ARN", "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.

" } }, "documentation":"

Contains information about an Identity and Access Management user.

" }, "ID":{ "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}$" }, "IDs":{ "type":"list", "member":{"shape":"ID"}, "max":100, "min":1 }, "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.

" }, "IdentityId":{ "type":"string", "max":256, "min":1, "pattern":"\\S+" }, "IdentityType":{ "type":"string", "enum":[ "USER", "GROUP", "IAM" ] }, "Image":{ "type":"structure", "members":{ "id":{ "shape":"ID", "documentation":"

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.

" }, "ImageFile":{ "type":"structure", "required":[ "data", "type" ], "members":{ "data":{ "shape":"ImageFileData", "documentation":"

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.

" }, "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 }, "JobConfiguration":{ "type":"structure", "required":["fileFormat"], "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.

" } }, "documentation":"

Contains the job summary information.

" }, "KmsKeyId":{ "type":"string", "max":2048, "min":1 }, "LimitExceededException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

For more information, see Quotas in the IoT SiteWise User Guide.

", "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`.

", "location":"querystring", "locationName":"identityType" }, "identityId":{ "shape":"IdentityId", "documentation":"

The ID of the identity. This parameter is required if you specify `USER` or `GROUP` for `identityType`.

", "location":"querystring", "locationName":"identityId" }, "resourceType":{ "shape":"ResourceType", "documentation":"

The type of resource (portal or project). This parameter is required if you specify `resourceId`.

", "location":"querystring", "locationName":"resourceType" }, "resourceId":{ "shape":"ID", "documentation":"

The ID of the resource. This parameter is required if you specify `resourceType`.

", "location":"querystring", "locationName":"resourceId" }, "iamArn":{ "shape":"ARN", "documentation":"

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`.

", "location":"querystring", "locationName":"iamArn" }, "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" } } }, "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":"CustomID", "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" } } }, "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.

" } } }, "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.

", "location":"uri", "locationName":"assetModelId" }, "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" } } }, "ListAssetModelCompositeModelsResponse":{ "type":"structure", "required":["assetModelCompositeModelSummaries"], "members":{ "assetModelCompositeModelSummaries":{ "shape":"AssetModelCompositeModelSummaries", "documentation":"

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.

", "location":"uri", "locationName":"assetModelId" }, "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. 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`

", "location":"querystring", "locationName":"filter" } } }, "ListAssetModelPropertiesResponse":{ "type":"structure", "required":["assetModelPropertySummaries"], "members":{ "assetModelPropertySummaries":{ "shape":"AssetModelPropertySummaries", "documentation":"

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":{ "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" }, "assetModelTypes":{ "shape":"ListAssetModelsTypeFilter", "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.

", "location":"querystring", "locationName":"assetModelTypes" } } }, "ListAssetModelsResponse":{ "type":"structure", "required":["assetModelSummaries"], "members":{ "assetModelSummaries":{ "shape":"AssetModelSummaries", "documentation":"

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.

", "location":"uri", "locationName":"assetId" }, "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. 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`

", "location":"querystring", "locationName":"filter" } } }, "ListAssetPropertiesResponse":{ "type":"structure", "required":["assetPropertySummaries"], "members":{ "assetPropertySummaries":{ "shape":"AssetPropertySummaries", "documentation":"

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.

", "location":"uri", "locationName":"assetId" }, "traversalType":{ "shape":"TraversalType", "documentation":"

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.

", "location":"querystring", "locationName":"traversalType" }, "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" } } }, "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.

", "location":"querystring", "locationName":"assetModelId" }, "filter":{ "shape":"ListAssetsFilter", "documentation":"

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`

", "location":"querystring", "locationName":"filter" } } }, "ListAssetsResponse":{ "type":"structure", "required":["assetSummaries"], "members":{ "assetSummaries":{ "shape":"AssetSummaries", "documentation":"

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.

", "location":"uri", "locationName":"assetId" }, "hierarchyId":{ "shape":"CustomID", "documentation":"

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.) To find a hierarchy ID, use the DescribeAsset or DescribeAssetModel operations. This parameter is required if you choose `CHILD` for `traversalDirection`.

For more information, see Asset hierarchies in the IoT SiteWise User Guide.

", "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. The `hierarchyId` parameter is required if you choose `CHILD`.

- `PARENT` – The list includes the asset's parent asset.

Default: `CHILD`

", "location":"querystring", "locationName":"traversalDirection" }, "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" } } }, "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" } } }, "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.

", "location":"uri", "locationName":"assetModelId" }, "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" } } }, "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.

" } } }, "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.

" } } }, "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.

" } } }, "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.

" } } }, "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.

" } } }, "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.

", "location":"querystring", "locationName":"assetId" }, "aliasPrefix":{ "shape":"PropertyAlias", "documentation":"

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.

", "location":"querystring", "locationName":"timeSeriesType" } } }, "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.

" } } }, "ListTimeSeriesType":{ "type":"string", "enum":[ "ASSOCIATED", "DISASSOCIATED" ] }, "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.

" }, "Macro":{ "type":"string", "max":256, "min":1, "pattern":"[^\\u0000-\\u001F\\u007F]+" }, "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.

" }, "Metric":{ "type":"structure", "required":[ "expression", "variables", "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`.

" }, "processingConfig":{ "shape":"MetricProcessingConfig", "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.

" } }, "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"}, "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", "min":30 }, "Offset":{ "type":"string", "max":25, "min":2 }, "OffsetInNanos":{ "type":"integer", "max":999999999, "min":0 }, "Parquet":{ "type":"structure", "members":{ }, "documentation":"

A parquet file.

" }, "Permission":{ "type":"string", "enum":[ "ADMINISTRATOR", "VIEWER" ] }, "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", "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":"ARN", "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"} }, "documentation":"

Contains a portal summary.

" }, "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.

" }, "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.

" }, "notification":{ "shape":"PropertyNotification", "documentation":"

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.

" }, "type":{ "shape":"PropertyType", "documentation":"

The property type (see `PropertyType`). A property contains one type.

" }, "path":{ "shape":"AssetPropertyPath", "documentation":"

The structured path to the property from the root of the asset.

" }, "externalId":{ "shape":"ExternalId", "documentation":"

The external ID of the asset property. For more information, see Using external IDs in the IoT SiteWise User Guide.

" } }, "documentation":"

Contains asset property information.

" }, "PropertyAlias":{ "type":"string", "min":1, "pattern":"[^\\u0000-\\u001F\\u007F]+" }, "PropertyDataType":{ "type":"string", "enum":[ "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "STRUCT" ] }, "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`.

" }, "PropertyUnit":{ "type":"string", "max":256, "min":1, "pattern":"[^\\u0000-\\u001F\\u007F]+" }, "PropertyValueBooleanValue":{"type":"boolean"}, "PropertyValueDoubleValue":{"type":"double"}, "PropertyValueIntegerValue":{"type":"integer"}, "PropertyValueStringValue":{"type":"string"}, "PutAssetPropertyValueEntries":{ "type":"list", "member":{"shape":"PutAssetPropertyValueEntry"} }, "PutAssetPropertyValueEntry":{ "type":"structure", "required":[ "entryId", "propertyValues" ], "members":{ "entryId":{ "shape":"EntryId", "documentation":"

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.

" }, "propertyValues":{ "shape":"AssetPropertyValues", "documentation":"

The list of property values to upload. You can specify up to 10 `propertyValues` array elements.

" } }, "documentation":"

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`.

" } } }, "PutDefaultEncryptionConfigurationResponse":{ "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 KMS key used for KMS encryption if you use `KMS_BASED_ENCRYPTION`.

" }, "configurationStatus":{ "shape":"ConfigurationStatus", "documentation":"

The status of the account configuration. This contains the `ConfigurationState`. If there is an error, it also contains the `ErrorDetails`.

" } } }, "PutLoggingOptionsRequest":{ "type":"structure", "required":["loggingOptions"], "members":{ "loggingOptions":{ "shape":"LoggingOptions", "documentation":"

The logging options to set.

" } } }, "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.

" }, "multiLayerStorage":{ "shape":"MultiLayerStorage", "documentation":"

Identifies a storage destination. If you specified `MULTI_LAYER_STORAGE` for the storage type, you must specify a `MultiLayerStorage` object.

" }, "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"}, "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.

" } } }, "PutStorageConfigurationResponse":{ "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.

" }, "multiLayerStorage":{ "shape":"MultiLayerStorage", "documentation":"

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.

" } } }, "Qualities":{ "type":"list", "member":{"shape":"Quality"}, "max":1, "min":1 }, "Quality":{ "type":"string", "enum":[ "GOOD", "BAD", "UNCERTAIN" ] }, "QueryStatement":{ "type":"string", "min":1, "pattern":"^[\\s\\S]+$" }, "QueryTimeoutException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

The query timed out.

", "error":{"httpStatusCode":400}, "exception":true }, "Resolution":{ "type":"string", "max":3, "min":2, "pattern":"1m|15m|1h|1d" }, "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"}, "ResourceId":{"type":"string"}, "ResourceNotFoundException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

The requested resource can't be found.

", "error":{"httpStatusCode":404}, "exception":true }, "ResourceType":{ "type":"string", "enum":[ "PORTAL", "PROJECT" ] }, "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`.

" }, "unlimited":{ "shape":"Unlimited", "documentation":"

If true, your data is kept indefinitely.

If configured to `true`, you must not specify a value for the `numberOfDays` parameter.

" } }, "documentation":"

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.

" }, "Rows":{ "type":"list", "member":{"shape":"Row"} }, "SSOApplicationId":{ "type":"string", "max":64, "min":1, "pattern":"^[!-~]*" }, "ScalarType":{ "type":"string", "enum":[ "BOOLEAN", "INT", "DOUBLE", "TIMESTAMP", "STRING" ] }, "ScalarValue":{"type":"string"}, "ServiceUnavailableException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

The requested service is unavailable.

", "error":{"httpStatusCode":503}, "exception":true, "fault":true }, "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", "required":["assetId"], "members":{ "assetId":{ "shape":"CustomID", "documentation":"

The ID of the asset, in UUID format.

" } }, "documentation":"

The resource the action will be taken on.

" }, "TargetResourceType":{ "type":"string", "enum":["ASSET"] }, "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`.

" }, "offsetInNanos":{ "shape":"OffsetInNanos", "documentation":"

The nanosecond offset from `timeInSeconds`.

" } }, "documentation":"

Contains a timestamp with optional nanosecond granularity.

" }, "TimeInSeconds":{ "type":"long", "max":9223372036854774, "min":1 }, "TimeOrdering":{ "type":"string", "enum":[ "ASCENDING", "DESCENDING" ] }, "TimeSeriesId":{ "type":"string", "max":73, "min":36 }, "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.

" }, "dataTypeSpec":{ "shape":"Name", "documentation":"

The data type of the structure for this time series. This parameter is required for time series that have the `STRUCT` data type.

The options for this parameter depend on the type of the composite model in which you created the asset property that is associated with your time series. Use `AWS/ALARM_STATE` for alarm state in alarm composite models.

" }, "timeSeriesCreationDate":{ "shape":"Timestamp", "documentation":"

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}`

" } }, "documentation":"

Contains a summary of a time series (data stream).

" }, "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 limit for the number of tags allowed for a resource. For more information, see Tag naming limits and requirements in the Amazon Web Services General Reference.

", "error":{"httpStatusCode":400}, "exception":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"] }, "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.

" } }, "documentation":"

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.

" }, "UnauthorizedException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

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.

" }, "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 } } }, "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, friendly 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 <LINK>.

You can specify up to 200 properties per composite model. For more information, see Quotas in the IoT SiteWise User Guide.

" } } }, "UpdateAssetModelCompositeModelResponse":{ "type":"structure", "required":[ "assetModelCompositeModelPath", "assetModelStatus" ], "members":{ "assetModelCompositeModelPath":{ "shape":"AssetModelCompositeModelPath", "documentation":"

The path to the composite model listing the parent composite models.

" }, "assetModelStatus":{"shape":"AssetModelStatus"} } }, "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.

", "location":"uri", "locationName":"assetModelId" }, "assetModelName":{ "shape":"Name", "documentation":"

A unique, friendly 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 <LINK>.

" }, "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 }, "assetModelExternalId":{ "shape":"ExternalId", "documentation":"

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.

" } } }, "UpdateAssetModelResponse":{ "type":"structure", "required":["assetModelStatus"], "members":{ "assetModelStatus":{ "shape":"AssetModelStatus", "documentation":"

The status of the asset model, which contains a state (`UPDATING` after successfully calling this operation) and any error message.

" } } }, "UpdateAssetPropertyRequest":{ "type":"structure", "required":[ "assetId", "propertyId" ], "members":{ "assetId":{ "shape":"CustomID", "documentation":"

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.

", "location":"uri", "locationName":"assetId" }, "propertyId":{ "shape":"CustomID", "documentation":"

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.

", "location":"uri", "locationName":"propertyId" }, "propertyAlias":{ "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.

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`.

" }, "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 }, "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.

" } } }, "UpdateAssetRequest":{ "type":"structure", "required":[ "assetId", "assetName" ], "members":{ "assetId":{ "shape":"CustomID", "documentation":"

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.

", "location":"uri", "locationName":"assetId" }, "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.

" }, "assetExternalId":{ "shape":"ExternalId", "documentation":"

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.

" } } }, "UpdateAssetResponse":{ "type":"structure", "required":["assetStatus"], "members":{ "assetStatus":{ "shape":"AssetStatus", "documentation":"

The status of the asset, which contains a state (`UPDATING` after successfully calling this operation) and any error message.

" } } }, "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. For detailed information, see Creating 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":{ } }, "UpdateGatewayCapabilityConfigurationRequest":{ "type":"structure", "required":[ "gatewayId", "capabilityNamespace", "capabilityConfiguration" ], "members":{ "gatewayId":{ "shape":"ID", "documentation":"

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 from the IoT SiteWise console, your OPC-UA capability configuration has the namespace `iotsitewise:opcuacollector:version`, where `version` is a number such as `1`.

" }, "capabilityConfiguration":{ "shape":"CapabilityConfiguration", "documentation":"

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 capability configuration. The sync status can be one of the following:

- `IN_SYNC` – The gateway is running the capability configuration.

- `OUT_OF_SYNC` – The gateway hasn't received the capability configuration.

- `SYNC_FAILED` – The gateway rejected the capability configuration.

After you update a capability configuration, its sync status is `OUT_OF_SYNC` until the gateway receives and applies or rejects the updated configuration.

" } } }, "UpdateGatewayRequest":{ "type":"structure", "required":[ "gatewayId", "gatewayName" ], "members":{ "gatewayId":{ "shape":"ID", "documentation":"

The ID of the gateway to update.

", "location":"uri", "locationName":"gatewayId" }, "gatewayName":{ "shape":"Name", "documentation":"

A unique, friendly name for the gateway.

" } } }, "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":"ARN", "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.

" } } }, "UpdatePortalResponse":{ "type":"structure", "required":["portalStatus"], "members":{ "portalStatus":{ "shape":"PortalStatus", "documentation":"

The status of the portal, which contains a state (`UPDATING` after successfully calling this operation) and any error message.

" } } }, "UpdateProjectRequest":{ "type":"structure", "required":[ "projectId", "projectName" ], "members":{ "projectId":{ "shape":"ID", "documentation":"

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":{ } }, "Url":{ "type":"string", "max":256, "min":1, "pattern":"^(http|https)\\://\\S+" }, "UserIdentity":{ "type":"structure", "required":["id"], "members":{ "id":{ "shape":"IdentityId", "documentation":"

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.

" }, "hierarchyId":{ "shape":"Macro", "documentation":"

The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID. If the hierarchy has an external ID, you can specify `externalId:` followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.

You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same `propertyId`. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.

" }, "propertyPath":{ "shape":"AssetModelPropertyPath", "documentation":"

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).

" }, "integerValue":{ "shape":"PropertyValueIntegerValue", "documentation":"

Asset property data of type integer (number that's greater than or equal to zero).

" }, "doubleValue":{ "shape":"PropertyValueDoubleValue", "documentation":"

Asset property data of type double (floating point number).

" }, "booleanValue":{ "shape":"PropertyValueBooleanValue", "documentation":"

Asset property data of type Boolean (true or false).

" } }, "documentation":"

Contains an asset property value (of a single type only).

" }, "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" ] }, "errorMessage":{"type":"string"} }, "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.

" }