# Actions
<a name="API_Operations"></a>

The following actions are supported:
+  [AssociateAssets](API_AssociateAssets.md) 
+  [AssociateTimeSeriesToAssetProperty](API_AssociateTimeSeriesToAssetProperty.md) 
+  [BatchAssociateProjectAssets](API_BatchAssociateProjectAssets.md) 
+  [BatchDisassociateProjectAssets](API_BatchDisassociateProjectAssets.md) 
+  [BatchGetAssetPropertyAggregates](API_BatchGetAssetPropertyAggregates.md) 
+  [BatchGetAssetPropertyValue](API_BatchGetAssetPropertyValue.md) 
+  [BatchGetAssetPropertyValueHistory](API_BatchGetAssetPropertyValueHistory.md) 
+  [BatchPutAssetPropertyValue](API_BatchPutAssetPropertyValue.md) 
+  [CreateAccessPolicy](API_CreateAccessPolicy.md) 
+  [CreateAsset](API_CreateAsset.md) 
+  [CreateAssetModel](API_CreateAssetModel.md) 
+  [CreateAssetModelCompositeModel](API_CreateAssetModelCompositeModel.md) 
+  [CreateBulkImportJob](API_CreateBulkImportJob.md) 
+  [CreateComputationModel](API_CreateComputationModel.md) 
+  [CreateDashboard](API_CreateDashboard.md) 
+  [CreateDataset](API_CreateDataset.md) 
+  [CreateGateway](API_CreateGateway.md) 
+  [CreatePortal](API_CreatePortal.md) 
+  [CreateProject](API_CreateProject.md) 
+  [DeleteAccessPolicy](API_DeleteAccessPolicy.md) 
+  [DeleteAsset](API_DeleteAsset.md) 
+  [DeleteAssetModel](API_DeleteAssetModel.md) 
+  [DeleteAssetModelCompositeModel](API_DeleteAssetModelCompositeModel.md) 
+  [DeleteAssetModelInterfaceRelationship](API_DeleteAssetModelInterfaceRelationship.md) 
+  [DeleteComputationModel](API_DeleteComputationModel.md) 
+  [DeleteDashboard](API_DeleteDashboard.md) 
+  [DeleteDataset](API_DeleteDataset.md) 
+  [DeleteGateway](API_DeleteGateway.md) 
+  [DeletePortal](API_DeletePortal.md) 
+  [DeleteProject](API_DeleteProject.md) 
+  [DeleteTimeSeries](API_DeleteTimeSeries.md) 
+  [DescribeAccessPolicy](API_DescribeAccessPolicy.md) 
+  [DescribeAction](API_DescribeAction.md) 
+  [DescribeAsset](API_DescribeAsset.md) 
+  [DescribeAssetCompositeModel](API_DescribeAssetCompositeModel.md) 
+  [DescribeAssetModel](API_DescribeAssetModel.md) 
+  [DescribeAssetModelCompositeModel](API_DescribeAssetModelCompositeModel.md) 
+  [DescribeAssetModelInterfaceRelationship](API_DescribeAssetModelInterfaceRelationship.md) 
+  [DescribeAssetProperty](API_DescribeAssetProperty.md) 
+  [DescribeBulkImportJob](API_DescribeBulkImportJob.md) 
+  [DescribeComputationModel](API_DescribeComputationModel.md) 
+  [DescribeComputationModelExecutionSummary](API_DescribeComputationModelExecutionSummary.md) 
+  [DescribeDashboard](API_DescribeDashboard.md) 
+  [DescribeDataset](API_DescribeDataset.md) 
+  [DescribeDefaultEncryptionConfiguration](API_DescribeDefaultEncryptionConfiguration.md) 
+  [DescribeExecution](API_DescribeExecution.md) 
+  [DescribeGateway](API_DescribeGateway.md) 
+  [DescribeGatewayCapabilityConfiguration](API_DescribeGatewayCapabilityConfiguration.md) 
+  [DescribeLoggingOptions](API_DescribeLoggingOptions.md) 
+  [DescribePortal](API_DescribePortal.md) 
+  [DescribeProject](API_DescribeProject.md) 
+  [DescribeStorageConfiguration](API_DescribeStorageConfiguration.md) 
+  [DescribeTimeSeries](API_DescribeTimeSeries.md) 
+  [DisassociateAssets](API_DisassociateAssets.md) 
+  [DisassociateTimeSeriesFromAssetProperty](API_DisassociateTimeSeriesFromAssetProperty.md) 
+  [ExecuteAction](API_ExecuteAction.md) 
+  [ExecuteQuery](API_ExecuteQuery.md) 
+  [GetAssetPropertyAggregates](API_GetAssetPropertyAggregates.md) 
+  [GetAssetPropertyValue](API_GetAssetPropertyValue.md) 
+  [GetAssetPropertyValueHistory](API_GetAssetPropertyValueHistory.md) 
+  [GetInterpolatedAssetPropertyValues](API_GetInterpolatedAssetPropertyValues.md) 
+  [InvokeAssistant](API_InvokeAssistant.md) 
+  [ListAccessPolicies](API_ListAccessPolicies.md) 
+  [ListActions](API_ListActions.md) 
+  [ListAssetModelCompositeModels](API_ListAssetModelCompositeModels.md) 
+  [ListAssetModelProperties](API_ListAssetModelProperties.md) 
+  [ListAssetModels](API_ListAssetModels.md) 
+  [ListAssetProperties](API_ListAssetProperties.md) 
+  [ListAssetRelationships](API_ListAssetRelationships.md) 
+  [ListAssets](API_ListAssets.md) 
+  [ListAssociatedAssets](API_ListAssociatedAssets.md) 
+  [ListBulkImportJobs](API_ListBulkImportJobs.md) 
+  [ListCompositionRelationships](API_ListCompositionRelationships.md) 
+  [ListComputationModelDataBindingUsages](API_ListComputationModelDataBindingUsages.md) 
+  [ListComputationModelResolveToResources](API_ListComputationModelResolveToResources.md) 
+  [ListComputationModels](API_ListComputationModels.md) 
+  [ListDashboards](API_ListDashboards.md) 
+  [ListDatasets](API_ListDatasets.md) 
+  [ListExecutions](API_ListExecutions.md) 
+  [ListGateways](API_ListGateways.md) 
+  [ListInterfaceRelationships](API_ListInterfaceRelationships.md) 
+  [ListPortals](API_ListPortals.md) 
+  [ListProjectAssets](API_ListProjectAssets.md) 
+  [ListProjects](API_ListProjects.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [ListTimeSeries](API_ListTimeSeries.md) 
+  [PutAssetModelInterfaceRelationship](API_PutAssetModelInterfaceRelationship.md) 
+  [PutDefaultEncryptionConfiguration](API_PutDefaultEncryptionConfiguration.md) 
+  [PutLoggingOptions](API_PutLoggingOptions.md) 
+  [PutStorageConfiguration](API_PutStorageConfiguration.md) 
+  [TagResource](API_TagResource.md) 
+  [UntagResource](API_UntagResource.md) 
+  [UpdateAccessPolicy](API_UpdateAccessPolicy.md) 
+  [UpdateAsset](API_UpdateAsset.md) 
+  [UpdateAssetModel](API_UpdateAssetModel.md) 
+  [UpdateAssetModelCompositeModel](API_UpdateAssetModelCompositeModel.md) 
+  [UpdateAssetProperty](API_UpdateAssetProperty.md) 
+  [UpdateComputationModel](API_UpdateComputationModel.md) 
+  [UpdateDashboard](API_UpdateDashboard.md) 
+  [UpdateDataset](API_UpdateDataset.md) 
+  [UpdateGateway](API_UpdateGateway.md) 
+  [UpdateGatewayCapabilityConfiguration](API_UpdateGatewayCapabilityConfiguration.md) 
+  [UpdatePortal](API_UpdatePortal.md) 
+  [UpdateProject](API_UpdateProject.md) 

# AssociateAssets
<a name="API_AssociateAssets"></a>

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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/add-associated-assets.html) in the * AWS IoT SiteWise User Guide*.

## Request Syntax
<a name="API_AssociateAssets_RequestSyntax"></a>

```
POST /assets/assetId/associate HTTP/1.1
Content-type: application/json

{
   "childAssetId": "string",
   "clientToken": "string",
   "hierarchyId": "string"
}
```

## URI Request Parameters
<a name="API_AssociateAssets_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assetId](#API_AssociateAssets_RequestSyntax) **   <a name="iotsitewise-AssociateAssets-request-uri-assetId"></a>
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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) in the * AWS IoT SiteWise User Guide*.  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+`   
Required: Yes

## Request Body
<a name="API_AssociateAssets_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [childAssetId](#API_AssociateAssets_RequestSyntax) **   <a name="iotsitewise-AssociateAssets-request-childAssetId"></a>
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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) in the * AWS IoT SiteWise User Guide*.  
Type: String  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+`   
Required: Yes

 ** [clientToken](#API_AssociateAssets_RequestSyntax) **   <a name="iotsitewise-AssociateAssets-request-clientToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 36. Maximum length of 64.  
Pattern: `\S{36,64}`   
Required: No

 ** [hierarchyId](#API_AssociateAssets_RequestSyntax) **   <a name="iotsitewise-AssociateAssets-request-hierarchyId"></a>
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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) in the * AWS 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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html) in the * AWS IoT SiteWise User Guide*.  
Type: String  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+`   
Required: Yes

## Response Syntax
<a name="API_AssociateAssets_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_AssociateAssets_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_AssociateAssets_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictingOperationException **   
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.    
 ** resourceArn **   
The ARN of the resource that conflicts with this operation.  
 ** resourceId **   
The ID of the resource that conflicts with this operation.
HTTP Status Code: 409

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** LimitExceededException **   
You've reached the quota for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 410

 ** ResourceAlreadyExistsException **   
The resource already exists.    
 ** resourceArn **   
The ARN of the resource that already exists.  
 ** resourceId **   
The ID of the resource that already exists.
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_AssociateAssets_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/AssociateAssets) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/AssociateAssets) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/AssociateAssets) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/AssociateAssets) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/AssociateAssets) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/AssociateAssets) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/AssociateAssets) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/AssociateAssets) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/AssociateAssets) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/AssociateAssets) 

# AssociateTimeSeriesToAssetProperty
<a name="API_AssociateTimeSeriesToAssetProperty"></a>

Associates a time series (data stream) with an asset property.

## Request Syntax
<a name="API_AssociateTimeSeriesToAssetProperty_RequestSyntax"></a>

```
POST /timeseries/associate/?alias=alias&assetId=assetId&propertyId=propertyId HTTP/1.1
Content-type: application/json

{
   "clientToken": "string"
}
```

## URI Request Parameters
<a name="API_AssociateTimeSeriesToAssetProperty_RequestParameters"></a>

The request uses the following URI parameters.

 ** [alias](#API_AssociateTimeSeriesToAssetProperty_RequestSyntax) **   <a name="iotsitewise-AssociateTimeSeriesToAssetProperty-request-uri-alias"></a>
The alias that identifies the time series.  
Length Constraints: Minimum length of 1.  
Pattern: `[^\u0000-\u001F\u007F]+`   
Required: Yes

 ** [assetId](#API_AssociateTimeSeriesToAssetProperty_RequestSyntax) **   <a name="iotsitewise-AssociateTimeSeriesToAssetProperty-request-uri-assetId"></a>
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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) in the * AWS IoT SiteWise User Guide*.  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+`   
Required: Yes

 ** [propertyId](#API_AssociateTimeSeriesToAssetProperty_RequestSyntax) **   <a name="iotsitewise-AssociateTimeSeriesToAssetProperty-request-uri-propertyId"></a>
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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) in the * AWS IoT SiteWise User Guide*.  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+`   
Required: Yes

## Request Body
<a name="API_AssociateTimeSeriesToAssetProperty_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_AssociateTimeSeriesToAssetProperty_RequestSyntax) **   <a name="iotsitewise-AssociateTimeSeriesToAssetProperty-request-clientToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 36. Maximum length of 64.  
Pattern: `\S{36,64}`   
Required: No

## Response Syntax
<a name="API_AssociateTimeSeriesToAssetProperty_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_AssociateTimeSeriesToAssetProperty_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_AssociateTimeSeriesToAssetProperty_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictingOperationException **   
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.    
 ** resourceArn **   
The ARN of the resource that conflicts with this operation.  
 ** resourceId **   
The ID of the resource that conflicts with this operation.
HTTP Status Code: 409

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_AssociateTimeSeriesToAssetProperty_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/AssociateTimeSeriesToAssetProperty) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/AssociateTimeSeriesToAssetProperty) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/AssociateTimeSeriesToAssetProperty) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/AssociateTimeSeriesToAssetProperty) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/AssociateTimeSeriesToAssetProperty) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/AssociateTimeSeriesToAssetProperty) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/AssociateTimeSeriesToAssetProperty) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/AssociateTimeSeriesToAssetProperty) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/AssociateTimeSeriesToAssetProperty) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/AssociateTimeSeriesToAssetProperty) 

# BatchAssociateProjectAssets
<a name="API_BatchAssociateProjectAssets"></a>

**Important**  
The AWS IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025 . If you would like to use the AWS IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS IoT SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).

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

## Request Syntax
<a name="API_BatchAssociateProjectAssets_RequestSyntax"></a>

```
POST /projects/projectId/assets/associate HTTP/1.1
Content-type: application/json

{
   "assetIds": [ "string" ],
   "clientToken": "string"
}
```

## URI Request Parameters
<a name="API_BatchAssociateProjectAssets_RequestParameters"></a>

The request uses the following URI parameters.

 ** [projectId](#API_BatchAssociateProjectAssets_RequestSyntax) **   <a name="iotsitewise-BatchAssociateProjectAssets-request-uri-projectId"></a>
The ID of the project to which to associate the assets.  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`   
Required: Yes

## Request Body
<a name="API_BatchAssociateProjectAssets_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [assetIds](#API_BatchAssociateProjectAssets_RequestSyntax) **   <a name="iotsitewise-BatchAssociateProjectAssets-request-assetIds"></a>
The IDs of the assets to be associated to the project.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 100 items.  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`   
Required: Yes

 ** [clientToken](#API_BatchAssociateProjectAssets_RequestSyntax) **   <a name="iotsitewise-BatchAssociateProjectAssets-request-clientToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 36. Maximum length of 64.  
Pattern: `\S{36,64}`   
Required: No

## Response Syntax
<a name="API_BatchAssociateProjectAssets_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "errors": [ 
      { 
         "assetId": "string",
         "code": "string",
         "message": "string"
      }
   ]
}
```

## Response Elements
<a name="API_BatchAssociateProjectAssets_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [errors](#API_BatchAssociateProjectAssets_ResponseSyntax) **   <a name="iotsitewise-BatchAssociateProjectAssets-response-errors"></a>
A list of associated error information, if any.  
Type: Array of [AssetErrorDetails](API_AssetErrorDetails.md) objects

## Errors
<a name="API_BatchAssociateProjectAssets_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** LimitExceededException **   
You've reached the quota for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 410

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_BatchAssociateProjectAssets_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/BatchAssociateProjectAssets) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/BatchAssociateProjectAssets) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/BatchAssociateProjectAssets) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/BatchAssociateProjectAssets) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/BatchAssociateProjectAssets) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/BatchAssociateProjectAssets) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/BatchAssociateProjectAssets) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/BatchAssociateProjectAssets) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/BatchAssociateProjectAssets) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/BatchAssociateProjectAssets) 

# BatchDisassociateProjectAssets
<a name="API_BatchDisassociateProjectAssets"></a>

Disassociates a group (batch) of assets from an AWS IoT SiteWise Monitor project.

## Request Syntax
<a name="API_BatchDisassociateProjectAssets_RequestSyntax"></a>

```
POST /projects/projectId/assets/disassociate HTTP/1.1
Content-type: application/json

{
   "assetIds": [ "string" ],
   "clientToken": "string"
}
```

## URI Request Parameters
<a name="API_BatchDisassociateProjectAssets_RequestParameters"></a>

The request uses the following URI parameters.

 ** [projectId](#API_BatchDisassociateProjectAssets_RequestSyntax) **   <a name="iotsitewise-BatchDisassociateProjectAssets-request-uri-projectId"></a>
The ID of the project from which to disassociate the assets.  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`   
Required: Yes

## Request Body
<a name="API_BatchDisassociateProjectAssets_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [assetIds](#API_BatchDisassociateProjectAssets_RequestSyntax) **   <a name="iotsitewise-BatchDisassociateProjectAssets-request-assetIds"></a>
The IDs of the assets to be disassociated from the project.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 100 items.  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`   
Required: Yes

 ** [clientToken](#API_BatchDisassociateProjectAssets_RequestSyntax) **   <a name="iotsitewise-BatchDisassociateProjectAssets-request-clientToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 36. Maximum length of 64.  
Pattern: `\S{36,64}`   
Required: No

## Response Syntax
<a name="API_BatchDisassociateProjectAssets_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "errors": [ 
      { 
         "assetId": "string",
         "code": "string",
         "message": "string"
      }
   ]
}
```

## Response Elements
<a name="API_BatchDisassociateProjectAssets_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [errors](#API_BatchDisassociateProjectAssets_ResponseSyntax) **   <a name="iotsitewise-BatchDisassociateProjectAssets-response-errors"></a>
A list of associated error information, if any.  
Type: Array of [AssetErrorDetails](API_AssetErrorDetails.md) objects

## Errors
<a name="API_BatchDisassociateProjectAssets_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_BatchDisassociateProjectAssets_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/BatchDisassociateProjectAssets) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/BatchDisassociateProjectAssets) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/BatchDisassociateProjectAssets) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/BatchDisassociateProjectAssets) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/BatchDisassociateProjectAssets) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/BatchDisassociateProjectAssets) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/BatchDisassociateProjectAssets) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/BatchDisassociateProjectAssets) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/BatchDisassociateProjectAssets) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/BatchDisassociateProjectAssets) 

# BatchGetAssetPropertyAggregates
<a name="API_BatchGetAssetPropertyAggregates"></a>

Gets aggregated values (for example, average, minimum, and maximum) for one or more asset properties. For more information, see [Querying aggregates](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#aggregates) in the * AWS IoT SiteWise User Guide*.

## Request Syntax
<a name="API_BatchGetAssetPropertyAggregates_RequestSyntax"></a>

```
POST /properties/batch/aggregates HTTP/1.1
Content-type: application/json

{
   "entries": [ 
      { 
         "aggregateTypes": [ "string" ],
         "assetId": "string",
         "endDate": number,
         "entryId": "string",
         "propertyAlias": "string",
         "propertyId": "string",
         "qualities": [ "string" ],
         "resolution": "string",
         "startDate": number,
         "timeOrdering": "string"
      }
   ],
   "maxResults": number,
   "nextToken": "string"
}
```

## URI Request Parameters
<a name="API_BatchGetAssetPropertyAggregates_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_BatchGetAssetPropertyAggregates_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [entries](#API_BatchGetAssetPropertyAggregates_RequestSyntax) **   <a name="iotsitewise-BatchGetAssetPropertyAggregates-request-entries"></a>
The list of asset property aggregate entries for the batch get request. You can specify up to 16 entries per request.  
Type: Array of [BatchGetAssetPropertyAggregatesEntry](API_BatchGetAssetPropertyAggregatesEntry.md) objects  
Required: Yes

 ** [maxResults](#API_BatchGetAssetPropertyAggregates_RequestSyntax) **   <a name="iotsitewise-BatchGetAssetPropertyAggregates-request-maxResults"></a>
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.
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** [nextToken](#API_BatchGetAssetPropertyAggregates_RequestSyntax) **   <a name="iotsitewise-BatchGetAssetPropertyAggregates-request-nextToken"></a>
The token to be used for the next set of paginated results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+`   
Required: No

## Response Syntax
<a name="API_BatchGetAssetPropertyAggregates_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "errorEntries": [ 
      { 
         "entryId": "string",
         "errorCode": "string",
         "errorMessage": "string"
      }
   ],
   "nextToken": "string",
   "skippedEntries": [ 
      { 
         "completionStatus": "string",
         "entryId": "string",
         "errorInfo": { 
            "errorCode": "string",
            "errorTimestamp": number
         }
      }
   ],
   "successEntries": [ 
      { 
         "aggregatedValues": [ 
            { 
               "quality": "string",
               "timestamp": number,
               "value": { 
                  "average": number,
                  "count": number,
                  "maximum": number,
                  "minimum": number,
                  "standardDeviation": number,
                  "sum": number
               }
            }
         ],
         "entryId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_BatchGetAssetPropertyAggregates_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [errorEntries](#API_BatchGetAssetPropertyAggregates_ResponseSyntax) **   <a name="iotsitewise-BatchGetAssetPropertyAggregates-response-errorEntries"></a>
A list of the errors (if any) associated with the batch request. Each error entry contains the `entryId` of the entry that failed.  
Type: Array of [BatchGetAssetPropertyAggregatesErrorEntry](API_BatchGetAssetPropertyAggregatesErrorEntry.md) objects

 ** [nextToken](#API_BatchGetAssetPropertyAggregates_ResponseSyntax) **   <a name="iotsitewise-BatchGetAssetPropertyAggregates-response-nextToken"></a>
The token for the next set of results, or null if there are no additional results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

 ** [skippedEntries](#API_BatchGetAssetPropertyAggregates_ResponseSyntax) **   <a name="iotsitewise-BatchGetAssetPropertyAggregates-response-skippedEntries"></a>
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.  
Type: Array of [BatchGetAssetPropertyAggregatesSkippedEntry](API_BatchGetAssetPropertyAggregatesSkippedEntry.md) objects

 ** [successEntries](#API_BatchGetAssetPropertyAggregates_ResponseSyntax) **   <a name="iotsitewise-BatchGetAssetPropertyAggregates-response-successEntries"></a>
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.  
Type: Array of [BatchGetAssetPropertyAggregatesSuccessEntry](API_BatchGetAssetPropertyAggregatesSuccessEntry.md) objects

## Errors
<a name="API_BatchGetAssetPropertyAggregates_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ServiceUnavailableException **   
The requested service is unavailable.  
HTTP Status Code: 503

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## Examples
<a name="API_BatchGetAssetPropertyAggregates_Examples"></a>

### Example
<a name="API_BatchGetAssetPropertyAggregates_Example_1"></a>

The following example uses the AWS Command Line Interface (AWS CLI) to retrieve the average temperature value for two wind turbines between April 26, 2021 at midnight and May 3, 2021 at midnight in Pacific Time (PT). The following also shows the contents of the `batch-get-asset-property-aggregates.json` file.

#### Sample Request
<a name="API_BatchGetAssetPropertyAggregates_Example_1_Request"></a>

```
aws iotsitewise batch-get-asset-property-aggregates --cli-input-json file://batch-get-asset-property-aggregates.json
```

```
{
   "entries":[
      {
         "entryId":"1",
         "aggregateTypes":[
            "AVERAGE"
         ],
         "assetId":"a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
         "propertyId":"a1b2c3d4-5678-90ab-cdef-22222EXAMPLE",
         "startDate":1619420400,
         "endDate":1620025200,
         "qualities":[
            "GOOD"
         ],
         "resolution":"1h"
      },
      {
         "entryId":"2",
         "aggregateTypes":[
            "AVERAGE"
         ],
         "assetId":"a1b2c3d4-5678-90ab-cdef-33333EXAMPLE",
         "propertyId":"a1b2c3d4-5678-90ab-cdef-44444EXAMPLE",
         "startDate":1619420400,
         "endDate":1620025200,
         "qualities":[
            "GOOD"
         ],
         "resolution":"1h"
      }
   ]
}
```

#### Sample Response
<a name="API_BatchGetAssetPropertyAggregates_Example_1_Response"></a>

```
{
   "errorEntries" :[ ],
   "successEntries" :[
      {
         "entryId" :"1",
         "aggregatedValues" :[
            {
               "timestamp" :1649348973.0,
               "quality" :"GOOD",
               "value" :{
                  "average" :1430.7175
               }
            }
         ]
      },
      {
         "entryId" :"2",
         "aggregatedValues" :[
            {
               "timestamp" :1649348973.0,
               "quality" :"GOOD",
               "value" :{
                  "average" :1425.9525
               }
            }
         ]
      }
   ],
   "skippedEntries" :[ ]
}
```

## See Also
<a name="API_BatchGetAssetPropertyAggregates_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/BatchGetAssetPropertyAggregates) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/BatchGetAssetPropertyAggregates) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/BatchGetAssetPropertyAggregates) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/BatchGetAssetPropertyAggregates) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/BatchGetAssetPropertyAggregates) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/BatchGetAssetPropertyAggregates) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/BatchGetAssetPropertyAggregates) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/BatchGetAssetPropertyAggregates) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/BatchGetAssetPropertyAggregates) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/BatchGetAssetPropertyAggregates) 

# BatchGetAssetPropertyValue
<a name="API_BatchGetAssetPropertyValue"></a>

Gets the current value for one or more asset properties. For more information, see [Querying current values](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#current-values) in the * AWS IoT SiteWise User Guide*.

## Request Syntax
<a name="API_BatchGetAssetPropertyValue_RequestSyntax"></a>

```
POST /properties/batch/latest HTTP/1.1
Content-type: application/json

{
   "entries": [ 
      { 
         "assetId": "string",
         "entryId": "string",
         "propertyAlias": "string",
         "propertyId": "string"
      }
   ],
   "nextToken": "string"
}
```

## URI Request Parameters
<a name="API_BatchGetAssetPropertyValue_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_BatchGetAssetPropertyValue_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [entries](#API_BatchGetAssetPropertyValue_RequestSyntax) **   <a name="iotsitewise-BatchGetAssetPropertyValue-request-entries"></a>
The list of asset property value entries for the batch get request. You can specify up to 128 entries per request.  
Type: Array of [BatchGetAssetPropertyValueEntry](API_BatchGetAssetPropertyValueEntry.md) objects  
Required: Yes

 ** [nextToken](#API_BatchGetAssetPropertyValue_RequestSyntax) **   <a name="iotsitewise-BatchGetAssetPropertyValue-request-nextToken"></a>
The token to be used for the next set of paginated results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+`   
Required: No

## Response Syntax
<a name="API_BatchGetAssetPropertyValue_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "errorEntries": [ 
      { 
         "entryId": "string",
         "errorCode": "string",
         "errorMessage": "string"
      }
   ],
   "nextToken": "string",
   "skippedEntries": [ 
      { 
         "completionStatus": "string",
         "entryId": "string",
         "errorInfo": { 
            "errorCode": "string",
            "errorTimestamp": number
         }
      }
   ],
   "successEntries": [ 
      { 
         "assetPropertyValue": { 
            "quality": "string",
            "timestamp": { 
               "offsetInNanos": number,
               "timeInSeconds": number
            },
            "value": { 
               "booleanValue": boolean,
               "doubleValue": number,
               "integerValue": number,
               "nullValue": { 
                  "valueType": "string"
               },
               "stringValue": "string"
            }
         },
         "entryId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_BatchGetAssetPropertyValue_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [errorEntries](#API_BatchGetAssetPropertyValue_ResponseSyntax) **   <a name="iotsitewise-BatchGetAssetPropertyValue-response-errorEntries"></a>
A list of the errors (if any) associated with the batch request. Each error entry contains the `entryId` of the entry that failed.  
Type: Array of [BatchGetAssetPropertyValueErrorEntry](API_BatchGetAssetPropertyValueErrorEntry.md) objects

 ** [nextToken](#API_BatchGetAssetPropertyValue_ResponseSyntax) **   <a name="iotsitewise-BatchGetAssetPropertyValue-response-nextToken"></a>
The token for the next set of results, or null if there are no additional results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

 ** [skippedEntries](#API_BatchGetAssetPropertyValue_ResponseSyntax) **   <a name="iotsitewise-BatchGetAssetPropertyValue-response-skippedEntries"></a>
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.  
Type: Array of [BatchGetAssetPropertyValueSkippedEntry](API_BatchGetAssetPropertyValueSkippedEntry.md) objects

 ** [successEntries](#API_BatchGetAssetPropertyValue_ResponseSyntax) **   <a name="iotsitewise-BatchGetAssetPropertyValue-response-successEntries"></a>
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.  
Type: Array of [BatchGetAssetPropertyValueSuccessEntry](API_BatchGetAssetPropertyValueSuccessEntry.md) objects

## Errors
<a name="API_BatchGetAssetPropertyValue_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ServiceUnavailableException **   
The requested service is unavailable.  
HTTP Status Code: 503

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## Examples
<a name="API_BatchGetAssetPropertyValue_Examples"></a>

### Example
<a name="API_BatchGetAssetPropertyValue_Example_1"></a>

The following example uses the AWS Command Line Interface (AWS CLI) to retrieve the current temperature value for two wind turbines. The following also shows the contents of the `batch-get-asset-property-value.json` file.

#### Sample Request
<a name="API_BatchGetAssetPropertyValue_Example_1_Request"></a>

```
aws iotsitewise batch-get-asset-property-value --cli-input-json file://batch-get-asset-property-value.json
```

```
{
   "entries":[
      {
         "entryId":"1",
         "assetId":"a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
         "propertyId":"a1b2c3d4-5678-90ab-cdef-22222EXAMPLE"
      },
      {
         "entryId":"2",
         "assetId":"a1b2c3d4-5678-90ab-cdef-33333EXAMPLE",
         "propertyId":"a1b2c3d4-5678-90ab-cdef-44444EXAMPLE"
      }
   ]
}
```

#### Sample Response
<a name="API_BatchGetAssetPropertyValue_Example_1_Response"></a>

```
{
   "errorEntries":[

   ],
   "successEntries":[
      {
         "entryId":"1",
         "propertyValue":{
            "value":{
               "doubleValue":1426.66
            },
            "timestamp":{
               "timeInSeconds":1580853000,
               "offsetInNanos":0
            },
            "quality":"GOOD"
         }
      },
      {
         "entryId":"2",
         "propertyValue":{
            "value":{
               "doubleValue":1429.44
            },
            "timestamp":{
               "timeInSeconds":1580853000,
               "offsetInNanos":0
            },
            "quality":"GOOD"
         }
      }
   ]
}
```

## See Also
<a name="API_BatchGetAssetPropertyValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/BatchGetAssetPropertyValue) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/BatchGetAssetPropertyValue) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/BatchGetAssetPropertyValue) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/BatchGetAssetPropertyValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/BatchGetAssetPropertyValue) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/BatchGetAssetPropertyValue) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/BatchGetAssetPropertyValue) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/BatchGetAssetPropertyValue) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/BatchGetAssetPropertyValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/BatchGetAssetPropertyValue) 

# BatchGetAssetPropertyValueHistory
<a name="API_BatchGetAssetPropertyValueHistory"></a>

Gets the historical values for one or more asset properties. For more information, see [Querying historical values](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#historical-values) in the * AWS IoT SiteWise User Guide*.

## Request Syntax
<a name="API_BatchGetAssetPropertyValueHistory_RequestSyntax"></a>

```
POST /properties/batch/history HTTP/1.1
Content-type: application/json

{
   "entries": [ 
      { 
         "assetId": "string",
         "endDate": number,
         "entryId": "string",
         "propertyAlias": "string",
         "propertyId": "string",
         "qualities": [ "string" ],
         "startDate": number,
         "timeOrdering": "string"
      }
   ],
   "maxResults": number,
   "nextToken": "string"
}
```

## URI Request Parameters
<a name="API_BatchGetAssetPropertyValueHistory_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_BatchGetAssetPropertyValueHistory_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [entries](#API_BatchGetAssetPropertyValueHistory_RequestSyntax) **   <a name="iotsitewise-BatchGetAssetPropertyValueHistory-request-entries"></a>
The list of asset property historical value entries for the batch get request. You can specify up to 16 entries per request.  
Type: Array of [BatchGetAssetPropertyValueHistoryEntry](API_BatchGetAssetPropertyValueHistoryEntry.md) objects  
Required: Yes

 ** [maxResults](#API_BatchGetAssetPropertyValueHistory_RequestSyntax) **   <a name="iotsitewise-BatchGetAssetPropertyValueHistory-request-maxResults"></a>
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.
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** [nextToken](#API_BatchGetAssetPropertyValueHistory_RequestSyntax) **   <a name="iotsitewise-BatchGetAssetPropertyValueHistory-request-nextToken"></a>
The token to be used for the next set of paginated results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+`   
Required: No

## Response Syntax
<a name="API_BatchGetAssetPropertyValueHistory_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "errorEntries": [ 
      { 
         "entryId": "string",
         "errorCode": "string",
         "errorMessage": "string"
      }
   ],
   "nextToken": "string",
   "skippedEntries": [ 
      { 
         "completionStatus": "string",
         "entryId": "string",
         "errorInfo": { 
            "errorCode": "string",
            "errorTimestamp": number
         }
      }
   ],
   "successEntries": [ 
      { 
         "assetPropertyValueHistory": [ 
            { 
               "quality": "string",
               "timestamp": { 
                  "offsetInNanos": number,
                  "timeInSeconds": number
               },
               "value": { 
                  "booleanValue": boolean,
                  "doubleValue": number,
                  "integerValue": number,
                  "nullValue": { 
                     "valueType": "string"
                  },
                  "stringValue": "string"
               }
            }
         ],
         "entryId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_BatchGetAssetPropertyValueHistory_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [errorEntries](#API_BatchGetAssetPropertyValueHistory_ResponseSyntax) **   <a name="iotsitewise-BatchGetAssetPropertyValueHistory-response-errorEntries"></a>
A list of the errors (if any) associated with the batch request. Each error entry contains the `entryId` of the entry that failed.  
Type: Array of [BatchGetAssetPropertyValueHistoryErrorEntry](API_BatchGetAssetPropertyValueHistoryErrorEntry.md) objects

 ** [nextToken](#API_BatchGetAssetPropertyValueHistory_ResponseSyntax) **   <a name="iotsitewise-BatchGetAssetPropertyValueHistory-response-nextToken"></a>
The token for the next set of results, or null if there are no additional results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

 ** [skippedEntries](#API_BatchGetAssetPropertyValueHistory_ResponseSyntax) **   <a name="iotsitewise-BatchGetAssetPropertyValueHistory-response-skippedEntries"></a>
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.  
Type: Array of [BatchGetAssetPropertyValueHistorySkippedEntry](API_BatchGetAssetPropertyValueHistorySkippedEntry.md) objects

 ** [successEntries](#API_BatchGetAssetPropertyValueHistory_ResponseSyntax) **   <a name="iotsitewise-BatchGetAssetPropertyValueHistory-response-successEntries"></a>
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.  
Type: Array of [BatchGetAssetPropertyValueHistorySuccessEntry](API_BatchGetAssetPropertyValueHistorySuccessEntry.md) objects

## Errors
<a name="API_BatchGetAssetPropertyValueHistory_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ServiceUnavailableException **   
The requested service is unavailable.  
HTTP Status Code: 503

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## Examples
<a name="API_BatchGetAssetPropertyValueHistory_Examples"></a>

### Example
<a name="API_BatchGetAssetPropertyValueHistory_Example_1"></a>

The following example uses the AWS Command Line Interface (AWS CLI) to retrieve the historical temperature values for two wind turbines between April 26, 2021 at midnight and May 3, 2021 at midnight in Pacific Time (PT). The following also shows the contents of the `batch-get-asset-property-value-history.json` file.

#### Sample Request
<a name="API_BatchGetAssetPropertyValueHistory_Example_1_Request"></a>

```
aws iotsitewise batch-get-asset-property-value-history --cli-input-json file://batch-get-asset-property-value-history.json
```

```
{
   "entries":[
      {
         "entryId":"1",
         "assetId":"a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
         "propertyId":"a1b2c3d4-5678-90ab-cdef-22222EXAMPLE",
         "startDate":1619420400,
         "endDate":1620025200
      },
      {
         "entryId":"2",
         "assetId":"a1b2c3d4-5678-90ab-cdef-33333EXAMPLE",
         "propertyId":"a1b2c3d4-5678-90ab-cdef-44444EXAMPLE",
         "startDate":1619420400,
         "endDate":1620025200
      }
   ]
}
```

#### Sample Response
<a name="API_BatchGetAssetPropertyValueHistory_Example_1_Response"></a>

```
{
   "errorEntries":[],
   "successEntries":[
      {
         "entryId":"1",
         "assetPropertyValueHistory":[
            {
               "value":{
                  "doubleValue":1426.55
               },
               "timestamp":{
                  "timeInSeconds":1619420400,
                  "offsetInNanos":0
               },
               "quality":"GOOD"
            },
            {
               "value":{
                  "doubleValue":1429.23
               },
               "timestamp":{
                  "timeInSeconds":1619620700,
                  "offsetInNanos":0
               },
               "quality":"GOOD"
            },
            {
               "value":{
                  "doubleValue":1431.43
               },
               "timestamp":{
                  "timeInSeconds":1619820400,
                  "offsetInNanos":0
               },
               "quality":"GOOD"
            },
            {
               "value":{
                  "doubleValue":1435.66
               },
               "timestamp":{
                  "timeInSeconds":1620025200,
                  "offsetInNanos":0
               },
               "quality":"GOOD"
            }
         ]
      },
      {
         "entryId":"2",
         "assetPropertyValueHistory":[
            {
               "value":{
                  "doubleValue":1424.17
               },
               "timestamp":{
                  "timeInSeconds":1619420400,
                  "offsetInNanos":0
               },
               "quality":"GOOD"
            },
            {
               "value":{
                  "doubleValue":1424.23
               },
               "timestamp":{
                  "timeInSeconds":1619620700,
                  "offsetInNanos":0
               },
               "quality":"GOOD"
            },
            {
               "value":{
                  "doubleValue":1425.24
               },
               "timestamp":{
                  "timeInSeconds":1619820400,
                  "offsetInNanos":0
               },
               "quality":"GOOD"
            },
            {
               "value":{
                  "doubleValue":1430.17
               },
               "timestamp":{
                  "timeInSeconds":1620025200,
                  "offsetInNanos":0
               },
               "quality":"GOOD"
            }
         ]
      }
   ],
   "skippedEntries":[]
}
```

## See Also
<a name="API_BatchGetAssetPropertyValueHistory_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/BatchGetAssetPropertyValueHistory) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/BatchGetAssetPropertyValueHistory) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/BatchGetAssetPropertyValueHistory) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/BatchGetAssetPropertyValueHistory) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/BatchGetAssetPropertyValueHistory) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/BatchGetAssetPropertyValueHistory) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/BatchGetAssetPropertyValueHistory) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/BatchGetAssetPropertyValueHistory) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/BatchGetAssetPropertyValueHistory) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/BatchGetAssetPropertyValueHistory) 

# BatchPutAssetPropertyValue
<a name="API_BatchPutAssetPropertyValue"></a>

Sends a list of asset property values to AWS IoT SiteWise. Each value is a timestamp-quality-value (TQV) data point. For more information, see [Ingesting data using the API](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/ingest-api.html) in the * AWS 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](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html).

**Important**  
With respect to Unix epoch time, AWS 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. AWS IoT SiteWise rejects timestamps outside of the inclusive range of [-7 days, \$110 minutes] and returns a `TimestampOutOfRangeException` error.  
For each asset property, AWS 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.

 AWS IoT SiteWise authorizes access to each `BatchPutAssetPropertyValue` entry individually. For more information, see [BatchPutAssetPropertyValue authorization](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/security_iam_service-with-iam.html#security_iam_service-with-iam-id-based-policies-batchputassetpropertyvalue-action) in the * AWS IoT SiteWise User Guide*.

## Request Syntax
<a name="API_BatchPutAssetPropertyValue_RequestSyntax"></a>

```
POST /properties HTTP/1.1
Content-type: application/json

{
   "enablePartialEntryProcessing": boolean,
   "entries": [ 
      { 
         "assetId": "string",
         "entryId": "string",
         "propertyAlias": "string",
         "propertyId": "string",
         "propertyValues": [ 
            { 
               "quality": "string",
               "timestamp": { 
                  "offsetInNanos": number,
                  "timeInSeconds": number
               },
               "value": { 
                  "booleanValue": boolean,
                  "doubleValue": number,
                  "integerValue": number,
                  "nullValue": { 
                     "valueType": "string"
                  },
                  "stringValue": "string"
               }
            }
         ]
      }
   ]
}
```

## URI Request Parameters
<a name="API_BatchPutAssetPropertyValue_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_BatchPutAssetPropertyValue_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [enablePartialEntryProcessing](#API_BatchPutAssetPropertyValue_RequestSyntax) **   <a name="iotsitewise-BatchPutAssetPropertyValue-request-enablePartialEntryProcessing"></a>
This setting enables partial ingestion at entry-level. If set to `true`, we ingest all TQVs not resulting in an error. If set to `false`, an invalid TQV fails ingestion of the entire entry that contains it.  
Type: Boolean  
Required: No

 ** [entries](#API_BatchPutAssetPropertyValue_RequestSyntax) **   <a name="iotsitewise-BatchPutAssetPropertyValue-request-entries"></a>
The list of asset property value entries for the batch put request. You can specify up to 10 entries per request.  
Type: Array of [PutAssetPropertyValueEntry](API_PutAssetPropertyValueEntry.md) objects  
Required: Yes

## Response Syntax
<a name="API_BatchPutAssetPropertyValue_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "errorEntries": [ 
      { 
         "entryId": "string",
         "errors": [ 
            { 
               "errorCode": "string",
               "errorMessage": "string",
               "timestamps": [ 
                  { 
                     "offsetInNanos": number,
                     "timeInSeconds": number
                  }
               ]
            }
         ]
      }
   ]
}
```

## Response Elements
<a name="API_BatchPutAssetPropertyValue_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [errorEntries](#API_BatchPutAssetPropertyValue_ResponseSyntax) **   <a name="iotsitewise-BatchPutAssetPropertyValue-response-errorEntries"></a>
A list of the errors (if any) associated with the batch put request. Each error entry contains the `entryId` of the entry that failed.  
Type: Array of [BatchPutAssetPropertyErrorEntry](API_BatchPutAssetPropertyErrorEntry.md) objects

## Errors
<a name="API_BatchPutAssetPropertyValue_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictingOperationException **   
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.    
 ** resourceArn **   
The ARN of the resource that conflicts with this operation.  
 ** resourceId **   
The ID of the resource that conflicts with this operation.
HTTP Status Code: 409

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** LimitExceededException **   
You've reached the quota for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 410

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ServiceUnavailableException **   
The requested service is unavailable.  
HTTP Status Code: 503

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_BatchPutAssetPropertyValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/BatchPutAssetPropertyValue) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/BatchPutAssetPropertyValue) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/BatchPutAssetPropertyValue) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/BatchPutAssetPropertyValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/BatchPutAssetPropertyValue) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/BatchPutAssetPropertyValue) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/BatchPutAssetPropertyValue) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/BatchPutAssetPropertyValue) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/BatchPutAssetPropertyValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/BatchPutAssetPropertyValue) 

# CreateAccessPolicy
<a name="API_CreateAccessPolicy"></a>

**Important**  
The AWS IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025 . If you would like to use the AWS IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS IoT SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).

Creates an access policy that grants the specified identity (IAM Identity Center user, IAM Identity Center group, or IAM user) access to the specified AWS IoT SiteWise Monitor portal or project resource.

**Note**  
Support for access policies that use an SSO Group as the identity is not supported at this time.

## Request Syntax
<a name="API_CreateAccessPolicy_RequestSyntax"></a>

```
POST /access-policies HTTP/1.1
Content-type: application/json

{
   "accessPolicyIdentity": { 
      "group": { 
         "id": "string"
      },
      "iamRole": { 
         "arn": "string"
      },
      "iamUser": { 
         "arn": "string"
      },
      "user": { 
         "id": "string"
      }
   },
   "accessPolicyPermission": "string",
   "accessPolicyResource": { 
      "portal": { 
         "id": "string"
      },
      "project": { 
         "id": "string"
      }
   },
   "clientToken": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateAccessPolicy_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateAccessPolicy_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [accessPolicyIdentity](#API_CreateAccessPolicy_RequestSyntax) **   <a name="iotsitewise-CreateAccessPolicy-request-accessPolicyIdentity"></a>
The identity for this access policy. Choose an IAM Identity Center user, an IAM Identity Center group, or an IAM user.  
Type: [Identity](API_Identity.md) object  
Required: Yes

 ** [accessPolicyPermission](#API_CreateAccessPolicy_RequestSyntax) **   <a name="iotsitewise-CreateAccessPolicy-request-accessPolicyPermission"></a>
The permission level for this access policy. Note that a project `ADMINISTRATOR` is also known as a project owner.  
Type: String  
Valid Values: `ADMINISTRATOR | VIEWER`   
Required: Yes

 ** [accessPolicyResource](#API_CreateAccessPolicy_RequestSyntax) **   <a name="iotsitewise-CreateAccessPolicy-request-accessPolicyResource"></a>
The AWS IoT SiteWise Monitor resource for this access policy. Choose either a portal or a project.  
Type: [Resource](API_Resource.md) object  
Required: Yes

 ** [clientToken](#API_CreateAccessPolicy_RequestSyntax) **   <a name="iotsitewise-CreateAccessPolicy-request-clientToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 36. Maximum length of 64.  
Pattern: `\S{36,64}`   
Required: No

 ** [tags](#API_CreateAccessPolicy_RequestSyntax) **   <a name="iotsitewise-CreateAccessPolicy-request-tags"></a>
A list of key-value pairs that contain metadata for the access policy. For more information, see [Tagging your AWS IoT SiteWise resources](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) in the * AWS IoT SiteWise User Guide*.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_CreateAccessPolicy_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "accessPolicyArn": "string",
   "accessPolicyId": "string"
}
```

## Response Elements
<a name="API_CreateAccessPolicy_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [accessPolicyArn](#API_CreateAccessPolicy_ResponseSyntax) **   <a name="iotsitewise-CreateAccessPolicy-response-accessPolicyArn"></a>
The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the access policy, which has the following format.  
 `arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId}`   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$` 

 ** [accessPolicyId](#API_CreateAccessPolicy_ResponseSyntax) **   <a name="iotsitewise-CreateAccessPolicy-response-accessPolicyId"></a>
The ID of the access policy.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

## Errors
<a name="API_CreateAccessPolicy_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** LimitExceededException **   
You've reached the quota for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 410

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_CreateAccessPolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/CreateAccessPolicy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/CreateAccessPolicy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/CreateAccessPolicy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/CreateAccessPolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/CreateAccessPolicy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/CreateAccessPolicy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/CreateAccessPolicy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/CreateAccessPolicy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/CreateAccessPolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/CreateAccessPolicy) 

# CreateAsset
<a name="API_CreateAsset"></a>

Creates an asset from an existing asset model. For more information, see [Creating assets](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-assets.html) in the * AWS IoT SiteWise User Guide*.

## Request Syntax
<a name="API_CreateAsset_RequestSyntax"></a>

```
POST /assets HTTP/1.1
Content-type: application/json

{
   "assetDescription": "string",
   "assetExternalId": "string",
   "assetId": "string",
   "assetModelId": "string",
   "assetName": "string",
   "clientToken": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateAsset_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateAsset_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [assetDescription](#API_CreateAsset_RequestSyntax) **   <a name="iotsitewise-CreateAsset-request-assetDescription"></a>
A description for the asset.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[^\u0000-\u001F\u007F]+`   
Required: No

 ** [assetExternalId](#API_CreateAsset_RequestSyntax) **   <a name="iotsitewise-CreateAsset-request-assetExternalId"></a>
An external ID to assign to the asset. The external ID must be unique within your AWS account. For more information, see [Using external IDs](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) in the * AWS IoT SiteWise User Guide*.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+`   
Required: No

 ** [assetId](#API_CreateAsset_RequestSyntax) **   <a name="iotsitewise-CreateAsset-request-assetId"></a>
The ID to assign to the asset, if desired. AWS 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.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`   
Required: No

 ** [assetModelId](#API_CreateAsset_RequestSyntax) **   <a name="iotsitewise-CreateAsset-request-assetModelId"></a>
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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) in the * AWS IoT SiteWise User Guide*.  
Type: String  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+`   
Required: Yes

 ** [assetName](#API_CreateAsset_RequestSyntax) **   <a name="iotsitewise-CreateAsset-request-assetName"></a>
A friendly name for the asset.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[^\u0000-\u001F\u007F]+`   
Required: Yes

 ** [clientToken](#API_CreateAsset_RequestSyntax) **   <a name="iotsitewise-CreateAsset-request-clientToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 36. Maximum length of 64.  
Pattern: `\S{36,64}`   
Required: No

 ** [tags](#API_CreateAsset_RequestSyntax) **   <a name="iotsitewise-CreateAsset-request-tags"></a>
A list of key-value pairs that contain metadata for the asset. For more information, see [Tagging your AWS IoT SiteWise resources](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) in the * AWS IoT SiteWise User Guide*.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_CreateAsset_ResponseSyntax"></a>

```
HTTP/1.1 202
Content-type: application/json

{
   "assetArn": "string",
   "assetId": "string",
   "assetStatus": { 
      "error": { 
         "code": "string",
         "details": [ 
            { 
               "code": "string",
               "message": "string"
            }
         ],
         "message": "string"
      },
      "state": "string"
   }
}
```

## Response Elements
<a name="API_CreateAsset_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

 ** [assetArn](#API_CreateAsset_ResponseSyntax) **   <a name="iotsitewise-CreateAsset-response-assetArn"></a>
The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the asset, which has the following format.  
 `arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}`   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$` 

 ** [assetId](#API_CreateAsset_ResponseSyntax) **   <a name="iotsitewise-CreateAsset-response-assetId"></a>
The ID of the asset, in UUID format. This ID uniquely identifies the asset within AWS IoT SiteWise and can be used with other AWS IoT SiteWise API operations.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

 ** [assetStatus](#API_CreateAsset_ResponseSyntax) **   <a name="iotsitewise-CreateAsset-response-assetStatus"></a>
The status of the asset, which contains a state (`CREATING` after successfully calling this operation) and any error message.  
Type: [AssetStatus](API_AssetStatus.md) object

## Errors
<a name="API_CreateAsset_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictingOperationException **   
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.    
 ** resourceArn **   
The ARN of the resource that conflicts with this operation.  
 ** resourceId **   
The ID of the resource that conflicts with this operation.
HTTP Status Code: 409

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** LimitExceededException **   
You've reached the quota for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 410

 ** ResourceAlreadyExistsException **   
The resource already exists.    
 ** resourceArn **   
The ARN of the resource that already exists.  
 ** resourceId **   
The ID of the resource that already exists.
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_CreateAsset_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/CreateAsset) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/CreateAsset) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/CreateAsset) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/CreateAsset) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/CreateAsset) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/CreateAsset) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/CreateAsset) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/CreateAsset) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/CreateAsset) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/CreateAsset) 

# CreateAssetModel
<a name="API_CreateAssetModel"></a>

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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/define-models.html) in the * AWS IoT SiteWise User Guide*.

You can create three types of asset models, `ASSET_MODEL`, `COMPONENT_MODEL`, or an `INTERFACE`.
+  **ASSET\$1MODEL** – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.
+  **COMPONENT\$1MODEL** – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model. 
+  **INTERFACE** – An interface is a type of model that defines a standard structure that can be applied to different asset models.

## Request Syntax
<a name="API_CreateAssetModel_RequestSyntax"></a>

```
POST /asset-models HTTP/1.1
Content-type: application/json

{
   "assetModelCompositeModels": [ 
      { 
         "description": "string",
         "externalId": "string",
         "id": "string",
         "name": "string",
         "properties": [ 
            { 
               "dataType": "string",
               "dataTypeSpec": "string",
               "externalId": "string",
               "id": "string",
               "name": "string",
               "type": { 
                  "attribute": { 
                     "defaultValue": "string"
                  },
                  "measurement": { 
                     "processingConfig": { 
                        "forwardingConfig": { 
                           "state": "string"
                        }
                     }
                  },
                  "metric": { 
                     "expression": "string",
                     "processingConfig": { 
                        "computeLocation": "string"
                     },
                     "variables": [ 
                        { 
                           "name": "string",
                           "value": { 
                              "hierarchyId": "string",
                              "propertyId": "string",
                              "propertyPath": [ 
                                 { 
                                    "id": "string",
                                    "name": "string"
                                 }
                              ]
                           }
                        }
                     ],
                     "window": { 
                        "tumbling": { 
                           "interval": "string",
                           "offset": "string"
                        }
                     }
                  },
                  "transform": { 
                     "expression": "string",
                     "processingConfig": { 
                        "computeLocation": "string",
                        "forwardingConfig": { 
                           "state": "string"
                        }
                     },
                     "variables": [ 
                        { 
                           "name": "string",
                           "value": { 
                              "hierarchyId": "string",
                              "propertyId": "string",
                              "propertyPath": [ 
                                 { 
                                    "id": "string",
                                    "name": "string"
                                 }
                              ]
                           }
                        }
                     ]
                  }
               },
               "unit": "string"
            }
         ],
         "type": "string"
      }
   ],
   "assetModelDescription": "string",
   "assetModelExternalId": "string",
   "assetModelHierarchies": [ 
      { 
         "childAssetModelId": "string",
         "externalId": "string",
         "id": "string",
         "name": "string"
      }
   ],
   "assetModelId": "string",
   "assetModelName": "string",
   "assetModelProperties": [ 
      { 
         "dataType": "string",
         "dataTypeSpec": "string",
         "externalId": "string",
         "id": "string",
         "name": "string",
         "type": { 
            "attribute": { 
               "defaultValue": "string"
            },
            "measurement": { 
               "processingConfig": { 
                  "forwardingConfig": { 
                     "state": "string"
                  }
               }
            },
            "metric": { 
               "expression": "string",
               "processingConfig": { 
                  "computeLocation": "string"
               },
               "variables": [ 
                  { 
                     "name": "string",
                     "value": { 
                        "hierarchyId": "string",
                        "propertyId": "string",
                        "propertyPath": [ 
                           { 
                              "id": "string",
                              "name": "string"
                           }
                        ]
                     }
                  }
               ],
               "window": { 
                  "tumbling": { 
                     "interval": "string",
                     "offset": "string"
                  }
               }
            },
            "transform": { 
               "expression": "string",
               "processingConfig": { 
                  "computeLocation": "string",
                  "forwardingConfig": { 
                     "state": "string"
                  }
               },
               "variables": [ 
                  { 
                     "name": "string",
                     "value": { 
                        "hierarchyId": "string",
                        "propertyId": "string",
                        "propertyPath": [ 
                           { 
                              "id": "string",
                              "name": "string"
                           }
                        ]
                     }
                  }
               ]
            }
         },
         "unit": "string"
      }
   ],
   "assetModelType": "string",
   "clientToken": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateAssetModel_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateAssetModel_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [assetModelCompositeModels](#API_CreateAssetModel_RequestSyntax) **   <a name="iotsitewise-CreateAssetModel-request-assetModelCompositeModels"></a>
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](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html). For more information, see [Creating custom composite models (Components)](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-custom-composite-models.html) in the * AWS IoT SiteWise User Guide*.
Type: Array of [AssetModelCompositeModelDefinition](API_AssetModelCompositeModelDefinition.md) objects  
Required: No

 ** [assetModelDescription](#API_CreateAssetModel_RequestSyntax) **   <a name="iotsitewise-CreateAssetModel-request-assetModelDescription"></a>
A description for the asset model.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[^\u0000-\u001F\u007F]+`   
Required: No

 ** [assetModelExternalId](#API_CreateAssetModel_RequestSyntax) **   <a name="iotsitewise-CreateAssetModel-request-assetModelExternalId"></a>
An external ID to assign to the asset model. The external ID must be unique within your AWS account. For more information, see [Using external IDs](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) in the * AWS IoT SiteWise User Guide*.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+`   
Required: No

 ** [assetModelHierarchies](#API_CreateAssetModel_RequestSyntax) **   <a name="iotsitewise-CreateAssetModel-request-assetModelHierarchies"></a>
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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html) in the * AWS IoT SiteWise User Guide*.  
You can specify up to 10 hierarchies per asset model. For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
Type: Array of [AssetModelHierarchyDefinition](API_AssetModelHierarchyDefinition.md) objects  
Required: No

 ** [assetModelId](#API_CreateAssetModel_RequestSyntax) **   <a name="iotsitewise-CreateAssetModel-request-assetModelId"></a>
The ID to assign to the asset model, if desired. AWS 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.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`   
Required: No

 ** [assetModelName](#API_CreateAssetModel_RequestSyntax) **   <a name="iotsitewise-CreateAssetModel-request-assetModelName"></a>
A unique name for the asset model.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[^\u0000-\u001F\u007F]+`   
Required: Yes

 ** [assetModelProperties](#API_CreateAssetModel_RequestSyntax) **   <a name="iotsitewise-CreateAssetModel-request-assetModelProperties"></a>
The property definitions of the asset model. For more information, see [Asset properties](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html) in the * AWS IoT SiteWise User Guide*.  
You can specify up to 200 properties per asset model. For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
Type: Array of [AssetModelPropertyDefinition](API_AssetModelPropertyDefinition.md) objects  
Required: No

 ** [assetModelType](#API_CreateAssetModel_RequestSyntax) **   <a name="iotsitewise-CreateAssetModel-request-assetModelType"></a>
The type of asset model.  
+  **ASSET\$1MODEL** – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.
+  **COMPONENT\$1MODEL** – 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. 
Type: String  
Valid Values: `ASSET_MODEL | COMPONENT_MODEL | INTERFACE`   
Required: No

 ** [clientToken](#API_CreateAssetModel_RequestSyntax) **   <a name="iotsitewise-CreateAssetModel-request-clientToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 36. Maximum length of 64.  
Pattern: `\S{36,64}`   
Required: No

 ** [tags](#API_CreateAssetModel_RequestSyntax) **   <a name="iotsitewise-CreateAssetModel-request-tags"></a>
A list of key-value pairs that contain metadata for the asset model. For more information, see [Tagging your AWS IoT SiteWise resources](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) in the * AWS IoT SiteWise User Guide*.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_CreateAssetModel_ResponseSyntax"></a>

```
HTTP/1.1 202
Content-type: application/json

{
   "assetModelArn": "string",
   "assetModelId": "string",
   "assetModelStatus": { 
      "error": { 
         "code": "string",
         "details": [ 
            { 
               "code": "string",
               "message": "string"
            }
         ],
         "message": "string"
      },
      "state": "string"
   }
}
```

## Response Elements
<a name="API_CreateAssetModel_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

 ** [assetModelArn](#API_CreateAssetModel_ResponseSyntax) **   <a name="iotsitewise-CreateAssetModel-response-assetModelArn"></a>
The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the asset model, which has the following format.  
 `arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}`   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$` 

 ** [assetModelId](#API_CreateAssetModel_ResponseSyntax) **   <a name="iotsitewise-CreateAssetModel-response-assetModelId"></a>
The ID of the asset model, in UUID format. You can use this ID when you call other AWS IoT SiteWise API operations.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

 ** [assetModelStatus](#API_CreateAssetModel_ResponseSyntax) **   <a name="iotsitewise-CreateAssetModel-response-assetModelStatus"></a>
The status of the asset model, which contains a state (`CREATING` after successfully calling this operation) and any error message.  
Type: [AssetModelStatus](API_AssetModelStatus.md) object

## Errors
<a name="API_CreateAssetModel_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictingOperationException **   
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.    
 ** resourceArn **   
The ARN of the resource that conflicts with this operation.  
 ** resourceId **   
The ID of the resource that conflicts with this operation.
HTTP Status Code: 409

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** LimitExceededException **   
You've reached the quota for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 410

 ** ResourceAlreadyExistsException **   
The resource already exists.    
 ** resourceArn **   
The ARN of the resource that already exists.  
 ** resourceId **   
The ID of the resource that already exists.
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_CreateAssetModel_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/CreateAssetModel) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/CreateAssetModel) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/CreateAssetModel) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/CreateAssetModel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/CreateAssetModel) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/CreateAssetModel) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/CreateAssetModel) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/CreateAssetModel) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/CreateAssetModel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/CreateAssetModel) 

# CreateAssetModelCompositeModel
<a name="API_CreateAssetModelCompositeModel"></a>

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)](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/custom-composite-models.html) in the * AWS 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`.

## Request Syntax
<a name="API_CreateAssetModelCompositeModel_RequestSyntax"></a>

```
POST /asset-models/assetModelId/composite-models HTTP/1.1
If-Match: ifMatch
If-None-Match: ifNoneMatch
Match-For-Version-Type: matchForVersionType
Content-type: application/json

{
   "assetModelCompositeModelDescription": "string",
   "assetModelCompositeModelExternalId": "string",
   "assetModelCompositeModelId": "string",
   "assetModelCompositeModelName": "string",
   "assetModelCompositeModelProperties": [ 
      { 
         "dataType": "string",
         "dataTypeSpec": "string",
         "externalId": "string",
         "id": "string",
         "name": "string",
         "type": { 
            "attribute": { 
               "defaultValue": "string"
            },
            "measurement": { 
               "processingConfig": { 
                  "forwardingConfig": { 
                     "state": "string"
                  }
               }
            },
            "metric": { 
               "expression": "string",
               "processingConfig": { 
                  "computeLocation": "string"
               },
               "variables": [ 
                  { 
                     "name": "string",
                     "value": { 
                        "hierarchyId": "string",
                        "propertyId": "string",
                        "propertyPath": [ 
                           { 
                              "id": "string",
                              "name": "string"
                           }
                        ]
                     }
                  }
               ],
               "window": { 
                  "tumbling": { 
                     "interval": "string",
                     "offset": "string"
                  }
               }
            },
            "transform": { 
               "expression": "string",
               "processingConfig": { 
                  "computeLocation": "string",
                  "forwardingConfig": { 
                     "state": "string"
                  }
               },
               "variables": [ 
                  { 
                     "name": "string",
                     "value": { 
                        "hierarchyId": "string",
                        "propertyId": "string",
                        "propertyPath": [ 
                           { 
                              "id": "string",
                              "name": "string"
                           }
                        ]
                     }
                  }
               ]
            }
         },
         "unit": "string"
      }
   ],
   "assetModelCompositeModelType": "string",
   "clientToken": "string",
   "composedAssetModelId": "string",
   "parentAssetModelCompositeModelId": "string"
}
```

## URI Request Parameters
<a name="API_CreateAssetModelCompositeModel_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assetModelId](#API_CreateAssetModelCompositeModel_RequestSyntax) **   <a name="iotsitewise-CreateAssetModelCompositeModel-request-uri-assetModelId"></a>
The ID of the asset model this composite model is a part of.  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+`   
Required: Yes

 ** [ifMatch](#API_CreateAssetModelCompositeModel_RequestSyntax) **   <a name="iotsitewise-CreateAssetModelCompositeModel-request-ifMatch"></a>
The expected current entity tag (ETag) for the asset model’s latest or active version (specified using `matchForVersionType`). The create request is rejected if the tag does not match the latest or active version's current entity tag. See [Optimistic locking for asset model writes](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/opt-locking-for-model.html) in the * AWS IoT SiteWise User Guide*.  
Pattern: `^[\w-]{43}$` 

 ** [ifNoneMatch](#API_CreateAssetModelCompositeModel_RequestSyntax) **   <a name="iotsitewise-CreateAssetModelCompositeModel-request-ifNoneMatch"></a>
Accepts **\$1** to reject the create request if an active version (specified using `matchForVersionType` as `ACTIVE`) already exists for the asset model.  
Pattern: `\*` 

 ** [matchForVersionType](#API_CreateAssetModelCompositeModel_RequestSyntax) **   <a name="iotsitewise-CreateAssetModelCompositeModel-request-matchForVersionType"></a>
Specifies the asset model version type (`LATEST` or `ACTIVE`) used in conjunction with `If-Match` or `If-None-Match` headers to determine the target ETag for the create operation.  
Valid Values: `LATEST | ACTIVE` 

## Request Body
<a name="API_CreateAssetModelCompositeModel_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [assetModelCompositeModelDescription](#API_CreateAssetModelCompositeModel_RequestSyntax) **   <a name="iotsitewise-CreateAssetModelCompositeModel-request-assetModelCompositeModelDescription"></a>
A description for the composite model.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[^\u0000-\u001F\u007F]+`   
Required: No

 ** [assetModelCompositeModelExternalId](#API_CreateAssetModelCompositeModel_RequestSyntax) **   <a name="iotsitewise-CreateAssetModelCompositeModel-request-assetModelCompositeModelExternalId"></a>
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.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+`   
Required: No

 ** [assetModelCompositeModelId](#API_CreateAssetModelCompositeModel_RequestSyntax) **   <a name="iotsitewise-CreateAssetModelCompositeModel-request-assetModelCompositeModelId"></a>
The ID of the composite model. AWS 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.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`   
Required: No

 ** [assetModelCompositeModelName](#API_CreateAssetModelCompositeModel_RequestSyntax) **   <a name="iotsitewise-CreateAssetModelCompositeModel-request-assetModelCompositeModelName"></a>
A unique name for the composite model.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[^\u0000-\u001F\u007F]+`   
Required: Yes

 ** [assetModelCompositeModelProperties](#API_CreateAssetModelCompositeModel_RequestSyntax) **   <a name="iotsitewise-CreateAssetModelCompositeModel-request-assetModelCompositeModelProperties"></a>
The property definitions of the composite model. For more information, see [ Inline custom composite models](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/custom-composite-models.html#inline-composite-models) in the * AWS IoT SiteWise User Guide*.  
You can specify up to 200 properties per composite model. For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
Type: Array of [AssetModelPropertyDefinition](API_AssetModelPropertyDefinition.md) objects  
Required: No

 ** [assetModelCompositeModelType](#API_CreateAssetModelCompositeModel_RequestSyntax) **   <a name="iotsitewise-CreateAssetModelCompositeModel-request-assetModelCompositeModelType"></a>
The composite model type. Valid values are `AWS/ALARM`, `CUSTOM`, or ` AWS/L4E_ANOMALY`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[^\u0000-\u001F\u007F]+`   
Required: Yes

 ** [clientToken](#API_CreateAssetModelCompositeModel_RequestSyntax) **   <a name="iotsitewise-CreateAssetModelCompositeModel-request-clientToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 36. Maximum length of 64.  
Pattern: `\S{36,64}`   
Required: No

 ** [composedAssetModelId](#API_CreateAssetModelCompositeModel_RequestSyntax) **   <a name="iotsitewise-CreateAssetModelCompositeModel-request-composedAssetModelId"></a>
The ID of a component model which is reused to create this composite model.  
Type: String  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+`   
Required: No

 ** [parentAssetModelCompositeModelId](#API_CreateAssetModelCompositeModel_RequestSyntax) **   <a name="iotsitewise-CreateAssetModelCompositeModel-request-parentAssetModelCompositeModelId"></a>
The ID of the parent composite model in this asset model relationship.  
Type: String  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+`   
Required: No

## Response Syntax
<a name="API_CreateAssetModelCompositeModel_ResponseSyntax"></a>

```
HTTP/1.1 202
Content-type: application/json

{
   "assetModelCompositeModelId": "string",
   "assetModelCompositeModelPath": [ 
      { 
         "id": "string",
         "name": "string"
      }
   ],
   "assetModelStatus": { 
      "error": { 
         "code": "string",
         "details": [ 
            { 
               "code": "string",
               "message": "string"
            }
         ],
         "message": "string"
      },
      "state": "string"
   }
}
```

## Response Elements
<a name="API_CreateAssetModelCompositeModel_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

 ** [assetModelCompositeModelId](#API_CreateAssetModelCompositeModel_ResponseSyntax) **   <a name="iotsitewise-CreateAssetModelCompositeModel-response-assetModelCompositeModelId"></a>
The ID of the composed asset model. You can use this ID when you call other AWS IoT SiteWise APIs.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

 ** [assetModelCompositeModelPath](#API_CreateAssetModelCompositeModel_ResponseSyntax) **   <a name="iotsitewise-CreateAssetModelCompositeModel-response-assetModelCompositeModelPath"></a>
The path to the composite model listing the parent composite models.  
Type: Array of [AssetModelCompositeModelPathSegment](API_AssetModelCompositeModelPathSegment.md) objects

 ** [assetModelStatus](#API_CreateAssetModelCompositeModel_ResponseSyntax) **   <a name="iotsitewise-CreateAssetModelCompositeModel-response-assetModelStatus"></a>
Contains current status information for an asset model. For more information, see [Asset and model states](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-and-model-states.html) in the * AWS IoT SiteWise User Guide*.  
Type: [AssetModelStatus](API_AssetModelStatus.md) object

## Errors
<a name="API_CreateAssetModelCompositeModel_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictingOperationException **   
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.    
 ** resourceArn **   
The ARN of the resource that conflicts with this operation.  
 ** resourceId **   
The ID of the resource that conflicts with this operation.
HTTP Status Code: 409

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** LimitExceededException **   
You've reached the quota for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 410

 ** PreconditionFailedException **   
The precondition in one or more of the request-header fields evaluated to `FALSE`.    
 ** resourceArn **   
The ARN of the resource on which precondition failed with this operation.  
 ** resourceId **   
The ID of the resource on which precondition failed with this operation.
HTTP Status Code: 412

 ** ResourceAlreadyExistsException **   
The resource already exists.    
 ** resourceArn **   
The ARN of the resource that already exists.  
 ** resourceId **   
The ID of the resource that already exists.
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_CreateAssetModelCompositeModel_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/CreateAssetModelCompositeModel) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/CreateAssetModelCompositeModel) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/CreateAssetModelCompositeModel) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/CreateAssetModelCompositeModel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/CreateAssetModelCompositeModel) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/CreateAssetModelCompositeModel) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/CreateAssetModelCompositeModel) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/CreateAssetModelCompositeModel) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/CreateAssetModelCompositeModel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/CreateAssetModelCompositeModel) 

# CreateBulkImportJob
<a name="API_CreateBulkImportJob"></a>

Defines a job to ingest data to AWS IoT SiteWise from Amazon S3. For more information, see [Create a bulk import job (AWS CLI)](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/CreateBulkImportJob.html) in the *Amazon Simple Storage Service User Guide*.

**Important**  
Before you create a bulk import job, you must enable AWS IoT SiteWise warm tier or AWS IoT SiteWise cold tier. For more information about how to configure storage settings, see [PutStorageConfiguration](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_PutStorageConfiguration.html).  
Bulk import is designed to store historical data to AWS IoT SiteWise.  
Newly ingested data in the hot tier triggers notifications and computations.
After data moves from the hot tier to the warm or cold tier based on retention settings, it does not trigger computations or notifications.
Data older than 7 days does not trigger computations or notifications.

## Request Syntax
<a name="API_CreateBulkImportJob_RequestSyntax"></a>

```
POST /jobs HTTP/1.1
Content-type: application/json

{
   "adaptiveIngestion": boolean,
   "deleteFilesAfterImport": boolean,
   "errorReportLocation": { 
      "bucket": "string",
      "prefix": "string"
   },
   "files": [ 
      { 
         "bucket": "string",
         "key": "string",
         "versionId": "string"
      }
   ],
   "jobConfiguration": { 
      "fileFormat": { 
         "csv": { 
            "columnNames": [ "string" ]
         },
         "parquet": { 
         }
      }
   },
   "jobName": "string",
   "jobRoleArn": "string"
}
```

## URI Request Parameters
<a name="API_CreateBulkImportJob_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateBulkImportJob_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [adaptiveIngestion](#API_CreateBulkImportJob_RequestSyntax) **   <a name="iotsitewise-CreateBulkImportJob-request-adaptiveIngestion"></a>
If set to true, ingest new data into AWS IoT SiteWise storage. Measurements with notifications, metrics and transforms are computed. If set to false, historical data is ingested into AWS IoT SiteWise as is.  
Type: Boolean  
Required: No

 ** [deleteFilesAfterImport](#API_CreateBulkImportJob_RequestSyntax) **   <a name="iotsitewise-CreateBulkImportJob-request-deleteFilesAfterImport"></a>
If set to true, your data files is deleted from S3, after ingestion into AWS IoT SiteWise storage.  
Type: Boolean  
Required: No

 ** [errorReportLocation](#API_CreateBulkImportJob_RequestSyntax) **   <a name="iotsitewise-CreateBulkImportJob-request-errorReportLocation"></a>
The Amazon S3 destination where errors associated with the job creation request are saved.  
Type: [ErrorReportLocation](API_ErrorReportLocation.md) object  
Required: Yes

 ** [files](#API_CreateBulkImportJob_RequestSyntax) **   <a name="iotsitewise-CreateBulkImportJob-request-files"></a>
The files in the specified Amazon S3 bucket that contain your data.  
Type: Array of [File](API_File.md) objects  
Required: Yes

 ** [jobConfiguration](#API_CreateBulkImportJob_RequestSyntax) **   <a name="iotsitewise-CreateBulkImportJob-request-jobConfiguration"></a>
Contains the configuration information of a job, such as the file format used to save data in Amazon S3.  
Type: [JobConfiguration](API_JobConfiguration.md) object  
Required: Yes

 ** [jobName](#API_CreateBulkImportJob_RequestSyntax) **   <a name="iotsitewise-CreateBulkImportJob-request-jobName"></a>
The unique name that helps identify the job request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[^\u0000-\u001F\u007F]+`   
Required: Yes

 ** [jobRoleArn](#API_CreateBulkImportJob_RequestSyntax) **   <a name="iotsitewise-CreateBulkImportJob-request-jobRoleArn"></a>
The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the IAM role that allows AWS IoT SiteWise to read Amazon S3 data.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$`   
Required: Yes

## Response Syntax
<a name="API_CreateBulkImportJob_ResponseSyntax"></a>

```
HTTP/1.1 202
Content-type: application/json

{
   "jobId": "string",
   "jobName": "string",
   "jobStatus": "string"
}
```

## Response Elements
<a name="API_CreateBulkImportJob_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

 ** [jobId](#API_CreateBulkImportJob_ResponseSyntax) **   <a name="iotsitewise-CreateBulkImportJob-response-jobId"></a>
The ID of the job.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

 ** [jobName](#API_CreateBulkImportJob_ResponseSyntax) **   <a name="iotsitewise-CreateBulkImportJob-response-jobName"></a>
The unique name that helps identify the job request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[^\u0000-\u001F\u007F]+` 

 ** [jobStatus](#API_CreateBulkImportJob_ResponseSyntax) **   <a name="iotsitewise-CreateBulkImportJob-response-jobStatus"></a>
The status of the bulk import job can be one of following values:  
+  `PENDING` – AWS IoT SiteWise is waiting for the current bulk import job to finish.
+  `CANCELLED` – The bulk import job has been canceled.
+  `RUNNING` – AWS IoT SiteWise is processing your request to import your data from Amazon S3.
+  `COMPLETED` – AWS IoT SiteWise successfully completed your request to import data from Amazon S3.
+  `FAILED` – AWS 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` – AWS 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.
Type: String  
Valid Values: `PENDING | CANCELLED | RUNNING | COMPLETED | FAILED | COMPLETED_WITH_FAILURES` 

## Errors
<a name="API_CreateBulkImportJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictingOperationException **   
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.    
 ** resourceArn **   
The ARN of the resource that conflicts with this operation.  
 ** resourceId **   
The ID of the resource that conflicts with this operation.
HTTP Status Code: 409

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** LimitExceededException **   
You've reached the quota for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 410

 ** ResourceAlreadyExistsException **   
The resource already exists.    
 ** resourceArn **   
The ARN of the resource that already exists.  
 ** resourceId **   
The ID of the resource that already exists.
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_CreateBulkImportJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/CreateBulkImportJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/CreateBulkImportJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/CreateBulkImportJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/CreateBulkImportJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/CreateBulkImportJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/CreateBulkImportJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/CreateBulkImportJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/CreateBulkImportJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/CreateBulkImportJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/CreateBulkImportJob) 

# CreateComputationModel
<a name="API_CreateComputationModel"></a>

Create a computation model with a configuration and data binding.

## Request Syntax
<a name="API_CreateComputationModel_RequestSyntax"></a>

```
POST /computation-models HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "computationModelConfiguration": { 
      "anomalyDetection": { 
         "inputProperties": "string",
         "resultProperty": "string"
      }
   },
   "computationModelDataBinding": { 
      "string" : { 
         "assetModelProperty": { 
            "assetModelId": "string",
            "propertyId": "string"
         },
         "assetProperty": { 
            "assetId": "string",
            "propertyId": "string"
         },
         "list": [ 
            "ComputationModelDataBindingValue"
         ]
      }
   },
   "computationModelDescription": "string",
   "computationModelName": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateComputationModel_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateComputationModel_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_CreateComputationModel_RequestSyntax) **   <a name="iotsitewise-CreateComputationModel-request-clientToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 36. Maximum length of 64.  
Pattern: `\S{36,64}`   
Required: No

 ** [computationModelConfiguration](#API_CreateComputationModel_RequestSyntax) **   <a name="iotsitewise-CreateComputationModel-request-computationModelConfiguration"></a>
The configuration for the computation model.  
Type: [ComputationModelConfiguration](API_ComputationModelConfiguration.md) object  
Required: Yes

 ** [computationModelDataBinding](#API_CreateComputationModel_RequestSyntax) **   <a name="iotsitewise-CreateComputationModel-request-computationModelDataBinding"></a>
The data binding for the computation model. Key is a variable name defined in configuration. Value is a `ComputationModelDataBindingValue` referenced by the variable.  
Type: String to [ComputationModelDataBindingValue](API_ComputationModelDataBindingValue.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 64.  
Key Pattern: `^[a-z][a-z0-9_]*$`   
Required: Yes

 ** [computationModelDescription](#API_CreateComputationModel_RequestSyntax) **   <a name="iotsitewise-CreateComputationModel-request-computationModelDescription"></a>
The description of the computation model.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^[a-zA-Z0-9 _\-#$*!@]+$`   
Required: No

 ** [computationModelName](#API_CreateComputationModel_RequestSyntax) **   <a name="iotsitewise-CreateComputationModel-request-computationModelName"></a>
The name of the computation model.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^[a-zA-Z0-9 _\-#$*!@]+$`   
Required: Yes

 ** [tags](#API_CreateComputationModel_RequestSyntax) **   <a name="iotsitewise-CreateComputationModel-request-tags"></a>
A list of key-value pairs that contain metadata for the asset. For more information, see [Tagging your AWS IoT SiteWise resources](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) in the * AWS IoT SiteWise User Guide*.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_CreateComputationModel_ResponseSyntax"></a>

```
HTTP/1.1 202
Content-type: application/json

{
   "computationModelArn": "string",
   "computationModelId": "string",
   "computationModelStatus": { 
      "error": { 
         "code": "string",
         "details": [ 
            { 
               "code": "string",
               "message": "string"
            }
         ],
         "message": "string"
      },
      "state": "string"
   }
}
```

## Response Elements
<a name="API_CreateComputationModel_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

 ** [computationModelArn](#API_CreateComputationModel_ResponseSyntax) **   <a name="iotsitewise-CreateComputationModel-response-computationModelArn"></a>
The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the computation model, which has the following format.  
 `arn:${Partition}:iotsitewise:${Region}:${Account}:computation-model/${ComputationModelId}`   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$` 

 ** [computationModelId](#API_CreateComputationModel_ResponseSyntax) **   <a name="iotsitewise-CreateComputationModel-response-computationModelId"></a>
The ID of the computation model.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

 ** [computationModelStatus](#API_CreateComputationModel_ResponseSyntax) **   <a name="iotsitewise-CreateComputationModel-response-computationModelStatus"></a>
The status of the computation model, containing a state (CREATING after successfully calling this operation) and any error messages.  
Type: [ComputationModelStatus](API_ComputationModelStatus.md) object

## Errors
<a name="API_CreateComputationModel_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictingOperationException **   
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.    
 ** resourceArn **   
The ARN of the resource that conflicts with this operation.  
 ** resourceId **   
The ID of the resource that conflicts with this operation.
HTTP Status Code: 409

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** LimitExceededException **   
You've reached the quota for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 410

 ** ResourceAlreadyExistsException **   
The resource already exists.    
 ** resourceArn **   
The ARN of the resource that already exists.  
 ** resourceId **   
The ID of the resource that already exists.
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_CreateComputationModel_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/CreateComputationModel) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/CreateComputationModel) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/CreateComputationModel) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/CreateComputationModel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/CreateComputationModel) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/CreateComputationModel) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/CreateComputationModel) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/CreateComputationModel) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/CreateComputationModel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/CreateComputationModel) 

# CreateDashboard
<a name="API_CreateDashboard"></a>

**Important**  
The AWS IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025 . If you would like to use the AWS IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS IoT SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).

Creates a dashboard in an AWS IoT SiteWise Monitor project.

## Request Syntax
<a name="API_CreateDashboard_RequestSyntax"></a>

```
POST /dashboards HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "dashboardDefinition": "string",
   "dashboardDescription": "string",
   "dashboardName": "string",
   "projectId": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateDashboard_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateDashboard_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_CreateDashboard_RequestSyntax) **   <a name="iotsitewise-CreateDashboard-request-clientToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 36. Maximum length of 64.  
Pattern: `\S{36,64}`   
Required: No

 ** [dashboardDefinition](#API_CreateDashboard_RequestSyntax) **   <a name="iotsitewise-CreateDashboard-request-dashboardDefinition"></a>
The dashboard definition specified in a JSON literal.  
+  AWS IoT SiteWise Monitor (Classic) see [Create dashboards (AWS CLI)](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html) 
+  AWS IoT SiteWise Monitor (AI-aware) see [Create dashboards (AWS CLI)](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-ai-dashboard-cli.html) 
in the * AWS IoT SiteWise User Guide*   
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 204800.  
Pattern: `.+`   
Required: Yes

 ** [dashboardDescription](#API_CreateDashboard_RequestSyntax) **   <a name="iotsitewise-CreateDashboard-request-dashboardDescription"></a>
A description for the dashboard.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[^\u0000-\u001F\u007F]+`   
Required: No

 ** [dashboardName](#API_CreateDashboard_RequestSyntax) **   <a name="iotsitewise-CreateDashboard-request-dashboardName"></a>
A friendly name for the dashboard.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[^\u0000-\u001F\u007F]+`   
Required: Yes

 ** [projectId](#API_CreateDashboard_RequestSyntax) **   <a name="iotsitewise-CreateDashboard-request-projectId"></a>
The ID of the project in which to create the dashboard.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`   
Required: Yes

 ** [tags](#API_CreateDashboard_RequestSyntax) **   <a name="iotsitewise-CreateDashboard-request-tags"></a>
A list of key-value pairs that contain metadata for the dashboard. For more information, see [Tagging your AWS IoT SiteWise resources](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) in the * AWS IoT SiteWise User Guide*.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_CreateDashboard_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "dashboardArn": "string",
   "dashboardId": "string"
}
```

## Response Elements
<a name="API_CreateDashboard_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [dashboardArn](#API_CreateDashboard_ResponseSyntax) **   <a name="iotsitewise-CreateDashboard-response-dashboardArn"></a>
The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the dashboard, which has the following format.  
 `arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}`   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$` 

 ** [dashboardId](#API_CreateDashboard_ResponseSyntax) **   <a name="iotsitewise-CreateDashboard-response-dashboardId"></a>
The ID of the dashboard.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

## Errors
<a name="API_CreateDashboard_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** LimitExceededException **   
You've reached the quota for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 410

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_CreateDashboard_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/CreateDashboard) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/CreateDashboard) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/CreateDashboard) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/CreateDashboard) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/CreateDashboard) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/CreateDashboard) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/CreateDashboard) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/CreateDashboard) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/CreateDashboard) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/CreateDashboard) 

# CreateDataset
<a name="API_CreateDataset"></a>

Creates a dataset to connect an external datasource.

## Request Syntax
<a name="API_CreateDataset_RequestSyntax"></a>

```
POST /datasets HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "datasetDescription": "string",
   "datasetId": "string",
   "datasetName": "string",
   "datasetSource": { 
      "sourceDetail": { 
         "kendra": { 
            "knowledgeBaseArn": "string",
            "roleArn": "string"
         }
      },
      "sourceFormat": "string",
      "sourceType": "string"
   },
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateDataset_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateDataset_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_CreateDataset_RequestSyntax) **   <a name="iotsitewise-CreateDataset-request-clientToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 36. Maximum length of 64.  
Pattern: `\S{36,64}`   
Required: No

 ** [datasetDescription](#API_CreateDataset_RequestSyntax) **   <a name="iotsitewise-CreateDataset-request-datasetDescription"></a>
A description about the dataset, and its functionality.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^[a-zA-Z0-9 _\-#$*!@]+$`   
Required: No

 ** [datasetId](#API_CreateDataset_RequestSyntax) **   <a name="iotsitewise-CreateDataset-request-datasetId"></a>
The ID of the dataset.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`   
Required: No

 ** [datasetName](#API_CreateDataset_RequestSyntax) **   <a name="iotsitewise-CreateDataset-request-datasetName"></a>
The name of the dataset.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^[a-zA-Z0-9 _\-#$*!@]+$`   
Required: Yes

 ** [datasetSource](#API_CreateDataset_RequestSyntax) **   <a name="iotsitewise-CreateDataset-request-datasetSource"></a>
The data source for the dataset.  
Type: [DatasetSource](API_DatasetSource.md) object  
Required: Yes

 ** [tags](#API_CreateDataset_RequestSyntax) **   <a name="iotsitewise-CreateDataset-request-tags"></a>
A list of key-value pairs that contain metadata for the access policy. For more information, see [Tagging your AWS IoT SiteWise resources](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) in the * AWS IoT SiteWise User Guide*.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_CreateDataset_ResponseSyntax"></a>

```
HTTP/1.1 202
Content-type: application/json

{
   "datasetArn": "string",
   "datasetId": "string",
   "datasetStatus": { 
      "error": { 
         "code": "string",
         "details": [ 
            { 
               "code": "string",
               "message": "string"
            }
         ],
         "message": "string"
      },
      "state": "string"
   }
}
```

## Response Elements
<a name="API_CreateDataset_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

 ** [datasetArn](#API_CreateDataset_ResponseSyntax) **   <a name="iotsitewise-CreateDataset-response-datasetArn"></a>
The [ARN](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html) of the dataset. The format is `arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId}`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$` 

 ** [datasetId](#API_CreateDataset_ResponseSyntax) **   <a name="iotsitewise-CreateDataset-response-datasetId"></a>
The ID of the dataset.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

 ** [datasetStatus](#API_CreateDataset_ResponseSyntax) **   <a name="iotsitewise-CreateDataset-response-datasetStatus"></a>
The status of the dataset. This contains the state and any error messages. State is `CREATING` after a successfull call to this API, and any associated error message. The state is `ACTIVE` when ready to use.  
Type: [DatasetStatus](API_DatasetStatus.md) object

## Errors
<a name="API_CreateDataset_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictingOperationException **   
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.    
 ** resourceArn **   
The ARN of the resource that conflicts with this operation.  
 ** resourceId **   
The ID of the resource that conflicts with this operation.
HTTP Status Code: 409

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** LimitExceededException **   
You've reached the quota for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 410

 ** ResourceAlreadyExistsException **   
The resource already exists.    
 ** resourceArn **   
The ARN of the resource that already exists.  
 ** resourceId **   
The ID of the resource that already exists.
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_CreateDataset_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/CreateDataset) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/CreateDataset) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/CreateDataset) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/CreateDataset) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/CreateDataset) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/CreateDataset) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/CreateDataset) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/CreateDataset) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/CreateDataset) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/CreateDataset) 

# CreateGateway
<a name="API_CreateGateway"></a>

Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to AWS IoT SiteWise. For more information, see [Ingesting data using a gateway](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateway-connector.html) in the * AWS IoT SiteWise User Guide*.

## Request Syntax
<a name="API_CreateGateway_RequestSyntax"></a>

```
POST /20200301/gateways HTTP/1.1
Content-type: application/json

{
   "gatewayName": "string",
   "gatewayPlatform": { 
      "greengrass": { 
         "groupArn": "string"
      },
      "greengrassV2": { 
         "coreDeviceOperatingSystem": "string",
         "coreDeviceThingName": "string"
      },
      "siemensIE": { 
         "iotCoreThingName": "string"
      }
   },
   "gatewayVersion": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateGateway_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateGateway_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [gatewayName](#API_CreateGateway_RequestSyntax) **   <a name="iotsitewise-CreateGateway-request-gatewayName"></a>
A unique name for the gateway.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[^\u0000-\u001F\u007F]+`   
Required: Yes

 ** [gatewayPlatform](#API_CreateGateway_RequestSyntax) **   <a name="iotsitewise-CreateGateway-request-gatewayPlatform"></a>
The gateway's platform. You can only specify one platform in a gateway.  
Type: [GatewayPlatform](API_GatewayPlatform.md) object  
Required: Yes

 ** [gatewayVersion](#API_CreateGateway_RequestSyntax) **   <a name="iotsitewise-CreateGateway-request-gatewayVersion"></a>
The version of the gateway to create. Specify `3` to create an MQTT-enabled, V3 gateway and `2` to create a Classic streams, V2 gateway. If not specified, the default is `2` (Classic streams, V2 gateway).  
When creating a V3 gateway (`gatewayVersion=3`) with the `GreengrassV2` platform, you must also specify the `coreDeviceOperatingSystem` parameter.
 We recommend creating an MQTT-enabled gateway for self-hosted gateways and Siemens Industrial Edge gateways. For more information on gateway versions, see [Use AWS IoT SiteWise Edge Edge gateways](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateways.html).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^[0-9]+$`   
Required: No

 ** [tags](#API_CreateGateway_RequestSyntax) **   <a name="iotsitewise-CreateGateway-request-tags"></a>
A list of key-value pairs that contain metadata for the gateway. For more information, see [Tagging your AWS IoT SiteWise resources](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) in the * AWS IoT SiteWise User Guide*.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_CreateGateway_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "gatewayArn": "string",
   "gatewayId": "string"
}
```

## Response Elements
<a name="API_CreateGateway_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [gatewayArn](#API_CreateGateway_ResponseSyntax) **   <a name="iotsitewise-CreateGateway-response-gatewayArn"></a>
The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the gateway, which has the following format.  
 `arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}`   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$` 

 ** [gatewayId](#API_CreateGateway_ResponseSyntax) **   <a name="iotsitewise-CreateGateway-response-gatewayId"></a>
The ID of the gateway device. You can use this ID when you call other AWS IoT SiteWise API operations.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

## Errors
<a name="API_CreateGateway_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** LimitExceededException **   
You've reached the quota for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 410

 ** ResourceAlreadyExistsException **   
The resource already exists.    
 ** resourceArn **   
The ARN of the resource that already exists.  
 ** resourceId **   
The ID of the resource that already exists.
HTTP Status Code: 409

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_CreateGateway_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/CreateGateway) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/CreateGateway) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/CreateGateway) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/CreateGateway) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/CreateGateway) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/CreateGateway) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/CreateGateway) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/CreateGateway) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/CreateGateway) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/CreateGateway) 

# CreatePortal
<a name="API_CreatePortal"></a>

**Important**  
The AWS IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025 . If you would like to use the AWS IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS IoT SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).

Creates a portal, which can contain projects and dashboards. AWS IoT SiteWise Monitor uses IAM Identity Center or IAM to authenticate portal users and manage user permissions.

**Note**  
Before you can sign in to a new portal, you must add at least one identity to that portal. For more information, see [Adding or removing portal administrators](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html#portal-change-admins) in the * AWS IoT SiteWise User Guide*.

## Request Syntax
<a name="API_CreatePortal_RequestSyntax"></a>

```
POST /portals HTTP/1.1
Content-type: application/json

{
   "alarms": { 
      "alarmRoleArn": "string",
      "notificationLambdaArn": "string"
   },
   "clientToken": "string",
   "notificationSenderEmail": "string",
   "portalAuthMode": "string",
   "portalContactEmail": "string",
   "portalDescription": "string",
   "portalLogoImageFile": { 
      "data": blob,
      "type": "string"
   },
   "portalName": "string",
   "portalType": "string",
   "portalTypeConfiguration": { 
      "string" : { 
         "portalTools": [ "string" ]
      }
   },
   "roleArn": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreatePortal_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreatePortal_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [alarms](#API_CreatePortal_RequestSyntax) **   <a name="iotsitewise-CreatePortal-request-alarms"></a>
Contains the configuration information of an alarm created in an AWS 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](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html) in the * AWS IoT SiteWise Application Guide*.  
Type: [Alarms](API_Alarms.md) object  
Required: No

 ** [clientToken](#API_CreatePortal_RequestSyntax) **   <a name="iotsitewise-CreatePortal-request-clientToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 36. Maximum length of 64.  
Pattern: `\S{36,64}`   
Required: No

 ** [notificationSenderEmail](#API_CreatePortal_RequestSyntax) **   <a name="iotsitewise-CreatePortal-request-notificationSenderEmail"></a>
The email address that sends alarm notifications.  
If you use the [AWS IoT Events managed Lambda function](https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html) to manage your emails, you must [verify the sender email address in Amazon SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html).
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z0-9_\-\.\+]+@[a-zA-Z0-9_\-\.\+]+\.[a-zA-Z]{2,}$`   
Required: No

 ** [portalAuthMode](#API_CreatePortal_RequestSyntax) **   <a name="iotsitewise-CreatePortal-request-portalAuthMode"></a>
The service to use to authenticate users to the portal. Choose from the following options:  
+  `SSO` – The portal uses AWS 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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-get-started.html#mon-gs-sso) in the * AWS IoT SiteWise User Guide*. This option is only available in AWS Regions other than the China Regions.
+  `IAM` – The portal uses AWS Identity and Access Management to authenticate users and manage user permissions.
You can't change this value after you create a portal.  
Default: `SSO`   
Type: String  
Valid Values: `IAM | SSO`   
Required: No

 ** [portalContactEmail](#API_CreatePortal_RequestSyntax) **   <a name="iotsitewise-CreatePortal-request-portalContactEmail"></a>
The AWS administrator's contact email address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z0-9_\-\.\+]+@[a-zA-Z0-9_\-\.\+]+\.[a-zA-Z]{2,}$`   
Required: Yes

 ** [portalDescription](#API_CreatePortal_RequestSyntax) **   <a name="iotsitewise-CreatePortal-request-portalDescription"></a>
A description for the portal.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[^\u0000-\u001F\u007F]+`   
Required: No

 ** [portalLogoImageFile](#API_CreatePortal_RequestSyntax) **   <a name="iotsitewise-CreatePortal-request-portalLogoImageFile"></a>
A logo image to display in the portal. Upload a square, high-resolution image. The image is displayed on a dark background.  
Type: [ImageFile](API_ImageFile.md) object  
Required: No

 ** [portalName](#API_CreatePortal_RequestSyntax) **   <a name="iotsitewise-CreatePortal-request-portalName"></a>
A friendly name for the portal.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[^\u0000-\u001F\u007F]+`   
Required: Yes

 ** [portalType](#API_CreatePortal_RequestSyntax) **   <a name="iotsitewise-CreatePortal-request-portalType"></a>
Define the type of portal. The value for AWS IoT SiteWise Monitor (Classic) is `SITEWISE_PORTAL_V1`. The value for AWS IoT SiteWise Monitor (AI-aware) is `SITEWISE_PORTAL_V2`.  
Type: String  
Valid Values: `SITEWISE_PORTAL_V1 | SITEWISE_PORTAL_V2`   
Required: No

 ** [portalTypeConfiguration](#API_CreatePortal_RequestSyntax) **   <a name="iotsitewise-CreatePortal-request-portalTypeConfiguration"></a>
The configuration entry associated with the specific portal type. The value for AWS IoT SiteWise Monitor (Classic) is `SITEWISE_PORTAL_V1`. The value for AWS IoT SiteWise Monitor (AI-aware) is `SITEWISE_PORTAL_V2`.  
Type: String to [PortalTypeEntry](API_PortalTypeEntry.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: No

 ** [roleArn](#API_CreatePortal_RequestSyntax) **   <a name="iotsitewise-CreatePortal-request-roleArn"></a>
The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf. For more information, see [Using service roles for AWS IoT SiteWise Monitor](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html) in the * AWS IoT SiteWise User Guide*.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.\+=,@]+$`   
Required: Yes

 ** [tags](#API_CreatePortal_RequestSyntax) **   <a name="iotsitewise-CreatePortal-request-tags"></a>
A list of key-value pairs that contain metadata for the portal. For more information, see [Tagging your AWS IoT SiteWise resources](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) in the * AWS IoT SiteWise User Guide*.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_CreatePortal_ResponseSyntax"></a>

```
HTTP/1.1 202
Content-type: application/json

{
   "portalArn": "string",
   "portalId": "string",
   "portalStartUrl": "string",
   "portalStatus": { 
      "error": { 
         "code": "string",
         "message": "string"
      },
      "state": "string"
   },
   "ssoApplicationId": "string"
}
```

## Response Elements
<a name="API_CreatePortal_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

 ** [portalArn](#API_CreatePortal_ResponseSyntax) **   <a name="iotsitewise-CreatePortal-response-portalArn"></a>
The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the portal, which has the following format.  
 `arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}`   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$` 

 ** [portalId](#API_CreatePortal_ResponseSyntax) **   <a name="iotsitewise-CreatePortal-response-portalId"></a>
The ID of the created portal.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

 ** [portalStartUrl](#API_CreatePortal_ResponseSyntax) **   <a name="iotsitewise-CreatePortal-response-portalStartUrl"></a>
The URL for the AWS 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 AWS IoT SiteWise console to get a URL that you can use to access the portal.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^(http|https)\://\S+` 

 ** [portalStatus](#API_CreatePortal_ResponseSyntax) **   <a name="iotsitewise-CreatePortal-response-portalStatus"></a>
The status of the portal, which contains a state (`CREATING` after successfully calling this operation) and any error message.  
Type: [PortalStatus](API_PortalStatus.md) object

 ** [ssoApplicationId](#API_CreatePortal_ResponseSyntax) **   <a name="iotsitewise-CreatePortal-response-ssoApplicationId"></a>
The associated IAM Identity Center application ID, if the portal uses IAM Identity Center.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[!-~]*` 

## Errors
<a name="API_CreatePortal_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** LimitExceededException **   
You've reached the quota for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 410

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_CreatePortal_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/CreatePortal) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/CreatePortal) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/CreatePortal) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/CreatePortal) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/CreatePortal) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/CreatePortal) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/CreatePortal) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/CreatePortal) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/CreatePortal) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/CreatePortal) 

# CreateProject
<a name="API_CreateProject"></a>

**Important**  
The AWS IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025 . If you would like to use the AWS IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS IoT SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).

Creates a project in the specified portal.

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

## Request Syntax
<a name="API_CreateProject_RequestSyntax"></a>

```
POST /projects HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "portalId": "string",
   "projectDescription": "string",
   "projectName": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateProject_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateProject_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_CreateProject_RequestSyntax) **   <a name="iotsitewise-CreateProject-request-clientToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 36. Maximum length of 64.  
Pattern: `\S{36,64}`   
Required: No

 ** [portalId](#API_CreateProject_RequestSyntax) **   <a name="iotsitewise-CreateProject-request-portalId"></a>
The ID of the portal in which to create the project.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`   
Required: Yes

 ** [projectDescription](#API_CreateProject_RequestSyntax) **   <a name="iotsitewise-CreateProject-request-projectDescription"></a>
A description for the project.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[^\u0000-\u001F\u007F]+`   
Required: No

 ** [projectName](#API_CreateProject_RequestSyntax) **   <a name="iotsitewise-CreateProject-request-projectName"></a>
A friendly name for the project.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[^\u0000-\u001F\u007F]+`   
Required: Yes

 ** [tags](#API_CreateProject_RequestSyntax) **   <a name="iotsitewise-CreateProject-request-tags"></a>
A list of key-value pairs that contain metadata for the project. For more information, see [Tagging your AWS IoT SiteWise resources](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) in the * AWS IoT SiteWise User Guide*.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_CreateProject_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "projectArn": "string",
   "projectId": "string"
}
```

## Response Elements
<a name="API_CreateProject_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [projectArn](#API_CreateProject_ResponseSyntax) **   <a name="iotsitewise-CreateProject-response-projectArn"></a>
The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the project, which has the following format.  
 `arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId}`   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$` 

 ** [projectId](#API_CreateProject_ResponseSyntax) **   <a name="iotsitewise-CreateProject-response-projectId"></a>
The ID of the project.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

## Errors
<a name="API_CreateProject_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** LimitExceededException **   
You've reached the quota for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 410

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_CreateProject_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/CreateProject) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/CreateProject) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/CreateProject) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/CreateProject) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/CreateProject) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/CreateProject) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/CreateProject) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/CreateProject) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/CreateProject) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/CreateProject) 

# DeleteAccessPolicy
<a name="API_DeleteAccessPolicy"></a>

Deletes an access policy that grants the specified identity access to the specified AWS IoT SiteWise Monitor resource. You can use this operation to revoke access to an AWS IoT SiteWise Monitor resource.

## Request Syntax
<a name="API_DeleteAccessPolicy_RequestSyntax"></a>

```
DELETE /access-policies/accessPolicyId?clientToken=clientToken HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteAccessPolicy_RequestParameters"></a>

The request uses the following URI parameters.

 ** [accessPolicyId](#API_DeleteAccessPolicy_RequestSyntax) **   <a name="iotsitewise-DeleteAccessPolicy-request-uri-accessPolicyId"></a>
The ID of the access policy to be deleted.  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`   
Required: Yes

 ** [clientToken](#API_DeleteAccessPolicy_RequestSyntax) **   <a name="iotsitewise-DeleteAccessPolicy-request-uri-clientToken"></a>
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.  
Length Constraints: Minimum length of 36. Maximum length of 64.  
Pattern: `\S{36,64}` 

## Request Body
<a name="API_DeleteAccessPolicy_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteAccessPolicy_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeleteAccessPolicy_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_DeleteAccessPolicy_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_DeleteAccessPolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/DeleteAccessPolicy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/DeleteAccessPolicy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/DeleteAccessPolicy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/DeleteAccessPolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DeleteAccessPolicy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/DeleteAccessPolicy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/DeleteAccessPolicy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/DeleteAccessPolicy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/DeleteAccessPolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/DeleteAccessPolicy) 

# DeleteAsset
<a name="API_DeleteAsset"></a>

Deletes an asset. This action can't be undone. For more information, see [Deleting assets and models](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/delete-assets-and-models.html) in the * AWS IoT SiteWise User Guide*.

**Note**  
You can't delete an asset that's associated to another asset. For more information, see [DisassociateAssets](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DisassociateAssets.html).

## Request Syntax
<a name="API_DeleteAsset_RequestSyntax"></a>

```
DELETE /assets/assetId?clientToken=clientToken HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteAsset_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assetId](#API_DeleteAsset_RequestSyntax) **   <a name="iotsitewise-DeleteAsset-request-uri-assetId"></a>
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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) in the * AWS IoT SiteWise User Guide*.  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+`   
Required: Yes

 ** [clientToken](#API_DeleteAsset_RequestSyntax) **   <a name="iotsitewise-DeleteAsset-request-uri-clientToken"></a>
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.  
Length Constraints: Minimum length of 36. Maximum length of 64.  
Pattern: `\S{36,64}` 

## Request Body
<a name="API_DeleteAsset_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteAsset_ResponseSyntax"></a>

```
HTTP/1.1 202
Content-type: application/json

{
   "assetStatus": { 
      "error": { 
         "code": "string",
         "details": [ 
            { 
               "code": "string",
               "message": "string"
            }
         ],
         "message": "string"
      },
      "state": "string"
   }
}
```

## Response Elements
<a name="API_DeleteAsset_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

 ** [assetStatus](#API_DeleteAsset_ResponseSyntax) **   <a name="iotsitewise-DeleteAsset-response-assetStatus"></a>
The status of the asset, which contains a state (`DELETING` after successfully calling this operation) and any error message.  
Type: [AssetStatus](API_AssetStatus.md) object

## Errors
<a name="API_DeleteAsset_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictingOperationException **   
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.    
 ** resourceArn **   
The ARN of the resource that conflicts with this operation.  
 ** resourceId **   
The ID of the resource that conflicts with this operation.
HTTP Status Code: 409

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_DeleteAsset_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/DeleteAsset) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/DeleteAsset) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/DeleteAsset) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/DeleteAsset) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DeleteAsset) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/DeleteAsset) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/DeleteAsset) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/DeleteAsset) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/DeleteAsset) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/DeleteAsset) 

# DeleteAssetModel
<a name="API_DeleteAssetModel"></a>

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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/delete-assets-and-models.html) in the * AWS IoT SiteWise User Guide*.

## Request Syntax
<a name="API_DeleteAssetModel_RequestSyntax"></a>

```
DELETE /asset-models/assetModelId?clientToken=clientToken HTTP/1.1
If-Match: ifMatch
If-None-Match: ifNoneMatch
Match-For-Version-Type: matchForVersionType
```

## URI Request Parameters
<a name="API_DeleteAssetModel_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assetModelId](#API_DeleteAssetModel_RequestSyntax) **   <a name="iotsitewise-DeleteAssetModel-request-uri-assetModelId"></a>
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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) in the * AWS IoT SiteWise User Guide*.  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+`   
Required: Yes

 ** [clientToken](#API_DeleteAssetModel_RequestSyntax) **   <a name="iotsitewise-DeleteAssetModel-request-uri-clientToken"></a>
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.  
Length Constraints: Minimum length of 36. Maximum length of 64.  
Pattern: `\S{36,64}` 

 ** [ifMatch](#API_DeleteAssetModel_RequestSyntax) **   <a name="iotsitewise-DeleteAssetModel-request-ifMatch"></a>
The expected current entity tag (ETag) for the asset model’s latest or active version (specified using `matchForVersionType`). The delete request is rejected if the tag does not match the latest or active version's current entity tag. See [Optimistic locking for asset model writes](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/opt-locking-for-model.html) in the * AWS IoT SiteWise User Guide*.  
Pattern: `^[\w-]{43}$` 

 ** [ifNoneMatch](#API_DeleteAssetModel_RequestSyntax) **   <a name="iotsitewise-DeleteAssetModel-request-ifNoneMatch"></a>
Accepts **\$1** to reject the delete request if an active version (specified using `matchForVersionType` as `ACTIVE`) already exists for the asset model.  
Pattern: `\*` 

 ** [matchForVersionType](#API_DeleteAssetModel_RequestSyntax) **   <a name="iotsitewise-DeleteAssetModel-request-matchForVersionType"></a>
Specifies the asset model version type (`LATEST` or `ACTIVE`) used in conjunction with `If-Match` or `If-None-Match` headers to determine the target ETag for the delete operation.  
Valid Values: `LATEST | ACTIVE` 

## Request Body
<a name="API_DeleteAssetModel_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteAssetModel_ResponseSyntax"></a>

```
HTTP/1.1 202
Content-type: application/json

{
   "assetModelStatus": { 
      "error": { 
         "code": "string",
         "details": [ 
            { 
               "code": "string",
               "message": "string"
            }
         ],
         "message": "string"
      },
      "state": "string"
   }
}
```

## Response Elements
<a name="API_DeleteAssetModel_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

 ** [assetModelStatus](#API_DeleteAssetModel_ResponseSyntax) **   <a name="iotsitewise-DeleteAssetModel-response-assetModelStatus"></a>
The status of the asset model, which contains a state (`DELETING` after successfully calling this operation) and any error message.  
Type: [AssetModelStatus](API_AssetModelStatus.md) object

## Errors
<a name="API_DeleteAssetModel_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictingOperationException **   
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.    
 ** resourceArn **   
The ARN of the resource that conflicts with this operation.  
 ** resourceId **   
The ID of the resource that conflicts with this operation.
HTTP Status Code: 409

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** PreconditionFailedException **   
The precondition in one or more of the request-header fields evaluated to `FALSE`.    
 ** resourceArn **   
The ARN of the resource on which precondition failed with this operation.  
 ** resourceId **   
The ID of the resource on which precondition failed with this operation.
HTTP Status Code: 412

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_DeleteAssetModel_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/DeleteAssetModel) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/DeleteAssetModel) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/DeleteAssetModel) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/DeleteAssetModel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DeleteAssetModel) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/DeleteAssetModel) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/DeleteAssetModel) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/DeleteAssetModel) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/DeleteAssetModel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/DeleteAssetModel) 

# DeleteAssetModelCompositeModel
<a name="API_DeleteAssetModelCompositeModel"></a>

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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/delete-assets-and-models.html) in the * AWS IoT SiteWise User Guide*.

## Request Syntax
<a name="API_DeleteAssetModelCompositeModel_RequestSyntax"></a>

```
DELETE /asset-models/assetModelId/composite-models/assetModelCompositeModelId?clientToken=clientToken HTTP/1.1
If-Match: ifMatch
If-None-Match: ifNoneMatch
Match-For-Version-Type: matchForVersionType
```

## URI Request Parameters
<a name="API_DeleteAssetModelCompositeModel_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assetModelCompositeModelId](#API_DeleteAssetModelCompositeModel_RequestSyntax) **   <a name="iotsitewise-DeleteAssetModelCompositeModel-request-uri-assetModelCompositeModelId"></a>
The ID of a composite model on this asset model.  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+`   
Required: Yes

 ** [assetModelId](#API_DeleteAssetModelCompositeModel_RequestSyntax) **   <a name="iotsitewise-DeleteAssetModelCompositeModel-request-uri-assetModelId"></a>
The ID of the asset model, in UUID format.  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+`   
Required: Yes

 ** [clientToken](#API_DeleteAssetModelCompositeModel_RequestSyntax) **   <a name="iotsitewise-DeleteAssetModelCompositeModel-request-uri-clientToken"></a>
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.  
Length Constraints: Minimum length of 36. Maximum length of 64.  
Pattern: `\S{36,64}` 

 ** [ifMatch](#API_DeleteAssetModelCompositeModel_RequestSyntax) **   <a name="iotsitewise-DeleteAssetModelCompositeModel-request-ifMatch"></a>
The expected current entity tag (ETag) for the asset model’s latest or active version (specified using `matchForVersionType`). The delete request is rejected if the tag does not match the latest or active version's current entity tag. See [Optimistic locking for asset model writes](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/opt-locking-for-model.html) in the * AWS IoT SiteWise User Guide*.  
Pattern: `^[\w-]{43}$` 

 ** [ifNoneMatch](#API_DeleteAssetModelCompositeModel_RequestSyntax) **   <a name="iotsitewise-DeleteAssetModelCompositeModel-request-ifNoneMatch"></a>
Accepts **\$1** to reject the delete request if an active version (specified using `matchForVersionType` as `ACTIVE`) already exists for the asset model.  
Pattern: `\*` 

 ** [matchForVersionType](#API_DeleteAssetModelCompositeModel_RequestSyntax) **   <a name="iotsitewise-DeleteAssetModelCompositeModel-request-matchForVersionType"></a>
Specifies the asset model version type (`LATEST` or `ACTIVE`) used in conjunction with `If-Match` or `If-None-Match` headers to determine the target ETag for the delete operation.  
Valid Values: `LATEST | ACTIVE` 

## Request Body
<a name="API_DeleteAssetModelCompositeModel_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteAssetModelCompositeModel_ResponseSyntax"></a>

```
HTTP/1.1 202
Content-type: application/json

{
   "assetModelStatus": { 
      "error": { 
         "code": "string",
         "details": [ 
            { 
               "code": "string",
               "message": "string"
            }
         ],
         "message": "string"
      },
      "state": "string"
   }
}
```

## Response Elements
<a name="API_DeleteAssetModelCompositeModel_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

 ** [assetModelStatus](#API_DeleteAssetModelCompositeModel_ResponseSyntax) **   <a name="iotsitewise-DeleteAssetModelCompositeModel-response-assetModelStatus"></a>
Contains current status information for an asset model. For more information, see [Asset and model states](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-and-model-states.html) in the * AWS IoT SiteWise User Guide*.  
Type: [AssetModelStatus](API_AssetModelStatus.md) object

## Errors
<a name="API_DeleteAssetModelCompositeModel_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictingOperationException **   
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.    
 ** resourceArn **   
The ARN of the resource that conflicts with this operation.  
 ** resourceId **   
The ID of the resource that conflicts with this operation.
HTTP Status Code: 409

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** PreconditionFailedException **   
The precondition in one or more of the request-header fields evaluated to `FALSE`.    
 ** resourceArn **   
The ARN of the resource on which precondition failed with this operation.  
 ** resourceId **   
The ID of the resource on which precondition failed with this operation.
HTTP Status Code: 412

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_DeleteAssetModelCompositeModel_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/DeleteAssetModelCompositeModel) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/DeleteAssetModelCompositeModel) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/DeleteAssetModelCompositeModel) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/DeleteAssetModelCompositeModel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DeleteAssetModelCompositeModel) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/DeleteAssetModelCompositeModel) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/DeleteAssetModelCompositeModel) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/DeleteAssetModelCompositeModel) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/DeleteAssetModelCompositeModel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/DeleteAssetModelCompositeModel) 

# DeleteAssetModelInterfaceRelationship
<a name="API_DeleteAssetModelInterfaceRelationship"></a>

Deletes an interface relationship between an asset model and an interface asset model.

## Request Syntax
<a name="API_DeleteAssetModelInterfaceRelationship_RequestSyntax"></a>

```
DELETE /asset-models/assetModelId/interface/interfaceAssetModelId/asset-model-interface-relationship?clientToken=clientToken HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteAssetModelInterfaceRelationship_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assetModelId](#API_DeleteAssetModelInterfaceRelationship_RequestSyntax) **   <a name="iotsitewise-DeleteAssetModelInterfaceRelationship-request-uri-assetModelId"></a>
The ID of the asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID.  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+`   
Required: Yes

 ** [clientToken](#API_DeleteAssetModelInterfaceRelationship_RequestSyntax) **   <a name="iotsitewise-DeleteAssetModelInterfaceRelationship-request-uri-clientToken"></a>
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.  
Length Constraints: Minimum length of 36. Maximum length of 64.  
Pattern: `\S{36,64}` 

 ** [interfaceAssetModelId](#API_DeleteAssetModelInterfaceRelationship_RequestSyntax) **   <a name="iotsitewise-DeleteAssetModelInterfaceRelationship-request-uri-interfaceAssetModelId"></a>
The ID of the interface asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID.  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+`   
Required: Yes

## Request Body
<a name="API_DeleteAssetModelInterfaceRelationship_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteAssetModelInterfaceRelationship_ResponseSyntax"></a>

```
HTTP/1.1 202
Content-type: application/json

{
   "assetModelArn": "string",
   "assetModelId": "string",
   "assetModelStatus": { 
      "error": { 
         "code": "string",
         "details": [ 
            { 
               "code": "string",
               "message": "string"
            }
         ],
         "message": "string"
      },
      "state": "string"
   },
   "interfaceAssetModelId": "string"
}
```

## Response Elements
<a name="API_DeleteAssetModelInterfaceRelationship_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

 ** [assetModelArn](#API_DeleteAssetModelInterfaceRelationship_ResponseSyntax) **   <a name="iotsitewise-DeleteAssetModelInterfaceRelationship-response-assetModelArn"></a>
The ARN of the asset model, which has the following format. `arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}`   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$` 

 ** [assetModelId](#API_DeleteAssetModelInterfaceRelationship_ResponseSyntax) **   <a name="iotsitewise-DeleteAssetModelInterfaceRelationship-response-assetModelId"></a>
The ID of the asset model.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

 ** [assetModelStatus](#API_DeleteAssetModelInterfaceRelationship_ResponseSyntax) **   <a name="iotsitewise-DeleteAssetModelInterfaceRelationship-response-assetModelStatus"></a>
Contains current status information for an asset model. For more information, see [Asset and model states](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-and-model-states.html) in the * AWS IoT SiteWise User Guide*.  
Type: [AssetModelStatus](API_AssetModelStatus.md) object

 ** [interfaceAssetModelId](#API_DeleteAssetModelInterfaceRelationship_ResponseSyntax) **   <a name="iotsitewise-DeleteAssetModelInterfaceRelationship-response-interfaceAssetModelId"></a>
The ID of the interface asset model.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

## Errors
<a name="API_DeleteAssetModelInterfaceRelationship_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictingOperationException **   
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.    
 ** resourceArn **   
The ARN of the resource that conflicts with this operation.  
 ** resourceId **   
The ID of the resource that conflicts with this operation.
HTTP Status Code: 409

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_DeleteAssetModelInterfaceRelationship_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/DeleteAssetModelInterfaceRelationship) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/DeleteAssetModelInterfaceRelationship) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/DeleteAssetModelInterfaceRelationship) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/DeleteAssetModelInterfaceRelationship) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DeleteAssetModelInterfaceRelationship) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/DeleteAssetModelInterfaceRelationship) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/DeleteAssetModelInterfaceRelationship) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/DeleteAssetModelInterfaceRelationship) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/DeleteAssetModelInterfaceRelationship) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/DeleteAssetModelInterfaceRelationship) 

# DeleteComputationModel
<a name="API_DeleteComputationModel"></a>

Deletes a computation model. This action can't be undone.

## Request Syntax
<a name="API_DeleteComputationModel_RequestSyntax"></a>

```
DELETE /computation-models/computationModelId?clientToken=clientToken HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteComputationModel_RequestParameters"></a>

The request uses the following URI parameters.

 ** [clientToken](#API_DeleteComputationModel_RequestSyntax) **   <a name="iotsitewise-DeleteComputationModel-request-uri-clientToken"></a>
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.  
Length Constraints: Minimum length of 36. Maximum length of 64.  
Pattern: `\S{36,64}` 

 ** [computationModelId](#API_DeleteComputationModel_RequestSyntax) **   <a name="iotsitewise-DeleteComputationModel-request-uri-computationModelId"></a>
The ID of the computation model.  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`   
Required: Yes

## Request Body
<a name="API_DeleteComputationModel_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteComputationModel_ResponseSyntax"></a>

```
HTTP/1.1 202
Content-type: application/json

{
   "computationModelStatus": { 
      "error": { 
         "code": "string",
         "details": [ 
            { 
               "code": "string",
               "message": "string"
            }
         ],
         "message": "string"
      },
      "state": "string"
   }
}
```

## Response Elements
<a name="API_DeleteComputationModel_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

 ** [computationModelStatus](#API_DeleteComputationModel_ResponseSyntax) **   <a name="iotsitewise-DeleteComputationModel-response-computationModelStatus"></a>
The status of the computation model. It contains a state (DELETING after successfully calling this operation) and any error messages.  
Type: [ComputationModelStatus](API_ComputationModelStatus.md) object

## Errors
<a name="API_DeleteComputationModel_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictingOperationException **   
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.    
 ** resourceArn **   
The ARN of the resource that conflicts with this operation.  
 ** resourceId **   
The ID of the resource that conflicts with this operation.
HTTP Status Code: 409

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_DeleteComputationModel_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/DeleteComputationModel) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/DeleteComputationModel) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/DeleteComputationModel) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/DeleteComputationModel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DeleteComputationModel) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/DeleteComputationModel) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/DeleteComputationModel) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/DeleteComputationModel) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/DeleteComputationModel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/DeleteComputationModel) 

# DeleteDashboard
<a name="API_DeleteDashboard"></a>

Deletes a dashboard from AWS IoT SiteWise Monitor.

## Request Syntax
<a name="API_DeleteDashboard_RequestSyntax"></a>

```
DELETE /dashboards/dashboardId?clientToken=clientToken HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteDashboard_RequestParameters"></a>

The request uses the following URI parameters.

 ** [clientToken](#API_DeleteDashboard_RequestSyntax) **   <a name="iotsitewise-DeleteDashboard-request-uri-clientToken"></a>
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.  
Length Constraints: Minimum length of 36. Maximum length of 64.  
Pattern: `\S{36,64}` 

 ** [dashboardId](#API_DeleteDashboard_RequestSyntax) **   <a name="iotsitewise-DeleteDashboard-request-uri-dashboardId"></a>
The ID of the dashboard to delete.  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`   
Required: Yes

## Request Body
<a name="API_DeleteDashboard_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteDashboard_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeleteDashboard_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_DeleteDashboard_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_DeleteDashboard_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/DeleteDashboard) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/DeleteDashboard) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/DeleteDashboard) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/DeleteDashboard) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DeleteDashboard) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/DeleteDashboard) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/DeleteDashboard) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/DeleteDashboard) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/DeleteDashboard) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/DeleteDashboard) 

# DeleteDataset
<a name="API_DeleteDataset"></a>

Deletes a dataset. This cannot be undone.

## Request Syntax
<a name="API_DeleteDataset_RequestSyntax"></a>

```
DELETE /datasets/datasetId?clientToken=clientToken HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteDataset_RequestParameters"></a>

The request uses the following URI parameters.

 ** [clientToken](#API_DeleteDataset_RequestSyntax) **   <a name="iotsitewise-DeleteDataset-request-uri-clientToken"></a>
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.  
Length Constraints: Minimum length of 36. Maximum length of 64.  
Pattern: `\S{36,64}` 

 ** [datasetId](#API_DeleteDataset_RequestSyntax) **   <a name="iotsitewise-DeleteDataset-request-uri-datasetId"></a>
The ID of the dataset.  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`   
Required: Yes

## Request Body
<a name="API_DeleteDataset_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteDataset_ResponseSyntax"></a>

```
HTTP/1.1 202
Content-type: application/json

{
   "datasetStatus": { 
      "error": { 
         "code": "string",
         "details": [ 
            { 
               "code": "string",
               "message": "string"
            }
         ],
         "message": "string"
      },
      "state": "string"
   }
}
```

## Response Elements
<a name="API_DeleteDataset_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

 ** [datasetStatus](#API_DeleteDataset_ResponseSyntax) **   <a name="iotsitewise-DeleteDataset-response-datasetStatus"></a>
The status of the dataset. This contains the state and any error messages. State is `DELETING` after a successfull call to this API, and any associated error message.  
Type: [DatasetStatus](API_DatasetStatus.md) object

## Errors
<a name="API_DeleteDataset_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictingOperationException **   
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.    
 ** resourceArn **   
The ARN of the resource that conflicts with this operation.  
 ** resourceId **   
The ID of the resource that conflicts with this operation.
HTTP Status Code: 409

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_DeleteDataset_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/DeleteDataset) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/DeleteDataset) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/DeleteDataset) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/DeleteDataset) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DeleteDataset) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/DeleteDataset) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/DeleteDataset) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/DeleteDataset) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/DeleteDataset) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/DeleteDataset) 

# DeleteGateway
<a name="API_DeleteGateway"></a>

Deletes a gateway from AWS IoT SiteWise. When you delete a gateway, some of the gateway's files remain in your gateway's file system.

## Request Syntax
<a name="API_DeleteGateway_RequestSyntax"></a>

```
DELETE /20200301/gateways/gatewayId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteGateway_RequestParameters"></a>

The request uses the following URI parameters.

 ** [gatewayId](#API_DeleteGateway_RequestSyntax) **   <a name="iotsitewise-DeleteGateway-request-uri-gatewayId"></a>
The ID of the gateway to delete.  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`   
Required: Yes

## Request Body
<a name="API_DeleteGateway_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteGateway_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteGateway_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteGateway_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictingOperationException **   
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.    
 ** resourceArn **   
The ARN of the resource that conflicts with this operation.  
 ** resourceId **   
The ID of the resource that conflicts with this operation.
HTTP Status Code: 409

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_DeleteGateway_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/DeleteGateway) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/DeleteGateway) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/DeleteGateway) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/DeleteGateway) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DeleteGateway) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/DeleteGateway) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/DeleteGateway) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/DeleteGateway) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/DeleteGateway) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/DeleteGateway) 

# DeletePortal
<a name="API_DeletePortal"></a>

Deletes a portal from AWS IoT SiteWise Monitor.

## Request Syntax
<a name="API_DeletePortal_RequestSyntax"></a>

```
DELETE /portals/portalId?clientToken=clientToken HTTP/1.1
```

## URI Request Parameters
<a name="API_DeletePortal_RequestParameters"></a>

The request uses the following URI parameters.

 ** [clientToken](#API_DeletePortal_RequestSyntax) **   <a name="iotsitewise-DeletePortal-request-uri-clientToken"></a>
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.  
Length Constraints: Minimum length of 36. Maximum length of 64.  
Pattern: `\S{36,64}` 

 ** [portalId](#API_DeletePortal_RequestSyntax) **   <a name="iotsitewise-DeletePortal-request-uri-portalId"></a>
The ID of the portal to delete.  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`   
Required: Yes

## Request Body
<a name="API_DeletePortal_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeletePortal_ResponseSyntax"></a>

```
HTTP/1.1 202
Content-type: application/json

{
   "portalStatus": { 
      "error": { 
         "code": "string",
         "message": "string"
      },
      "state": "string"
   }
}
```

## Response Elements
<a name="API_DeletePortal_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

 ** [portalStatus](#API_DeletePortal_ResponseSyntax) **   <a name="iotsitewise-DeletePortal-response-portalStatus"></a>
The status of the portal, which contains a state (`DELETING` after successfully calling this operation) and any error message.  
Type: [PortalStatus](API_PortalStatus.md) object

## Errors
<a name="API_DeletePortal_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictingOperationException **   
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.    
 ** resourceArn **   
The ARN of the resource that conflicts with this operation.  
 ** resourceId **   
The ID of the resource that conflicts with this operation.
HTTP Status Code: 409

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_DeletePortal_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/DeletePortal) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/DeletePortal) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/DeletePortal) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/DeletePortal) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DeletePortal) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/DeletePortal) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/DeletePortal) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/DeletePortal) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/DeletePortal) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/DeletePortal) 

# DeleteProject
<a name="API_DeleteProject"></a>

Deletes a project from AWS IoT SiteWise Monitor.

## Request Syntax
<a name="API_DeleteProject_RequestSyntax"></a>

```
DELETE /projects/projectId?clientToken=clientToken HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteProject_RequestParameters"></a>

The request uses the following URI parameters.

 ** [clientToken](#API_DeleteProject_RequestSyntax) **   <a name="iotsitewise-DeleteProject-request-uri-clientToken"></a>
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.  
Length Constraints: Minimum length of 36. Maximum length of 64.  
Pattern: `\S{36,64}` 

 ** [projectId](#API_DeleteProject_RequestSyntax) **   <a name="iotsitewise-DeleteProject-request-uri-projectId"></a>
The ID of the project.  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`   
Required: Yes

## Request Body
<a name="API_DeleteProject_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteProject_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeleteProject_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_DeleteProject_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_DeleteProject_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/DeleteProject) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/DeleteProject) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/DeleteProject) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/DeleteProject) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DeleteProject) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/DeleteProject) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/DeleteProject) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/DeleteProject) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/DeleteProject) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/DeleteProject) 

# DeleteTimeSeries
<a name="API_DeleteTimeSeries"></a>

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.

## Request Syntax
<a name="API_DeleteTimeSeries_RequestSyntax"></a>

```
POST /timeseries/delete/?alias=alias&assetId=assetId&propertyId=propertyId HTTP/1.1
Content-type: application/json

{
   "clientToken": "string"
}
```

## URI Request Parameters
<a name="API_DeleteTimeSeries_RequestParameters"></a>

The request uses the following URI parameters.

 ** [alias](#API_DeleteTimeSeries_RequestSyntax) **   <a name="iotsitewise-DeleteTimeSeries-request-uri-alias"></a>
The alias that identifies the time series.  
Length Constraints: Minimum length of 1.  
Pattern: `[^\u0000-\u001F\u007F]+` 

 ** [assetId](#API_DeleteTimeSeries_RequestSyntax) **   <a name="iotsitewise-DeleteTimeSeries-request-uri-assetId"></a>
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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) in the * AWS IoT SiteWise User Guide*.  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+` 

 ** [propertyId](#API_DeleteTimeSeries_RequestSyntax) **   <a name="iotsitewise-DeleteTimeSeries-request-uri-propertyId"></a>
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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) in the * AWS IoT SiteWise User Guide*.  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+` 

## Request Body
<a name="API_DeleteTimeSeries_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_DeleteTimeSeries_RequestSyntax) **   <a name="iotsitewise-DeleteTimeSeries-request-clientToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 36. Maximum length of 64.  
Pattern: `\S{36,64}`   
Required: No

## Response Syntax
<a name="API_DeleteTimeSeries_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteTimeSeries_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteTimeSeries_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictingOperationException **   
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.    
 ** resourceArn **   
The ARN of the resource that conflicts with this operation.  
 ** resourceId **   
The ID of the resource that conflicts with this operation.
HTTP Status Code: 409

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_DeleteTimeSeries_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/DeleteTimeSeries) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/DeleteTimeSeries) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/DeleteTimeSeries) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/DeleteTimeSeries) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DeleteTimeSeries) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/DeleteTimeSeries) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/DeleteTimeSeries) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/DeleteTimeSeries) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/DeleteTimeSeries) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/DeleteTimeSeries) 

# DescribeAccessPolicy
<a name="API_DescribeAccessPolicy"></a>

Describes an access policy, which specifies an identity's access to an AWS IoT SiteWise Monitor portal or project.

## Request Syntax
<a name="API_DescribeAccessPolicy_RequestSyntax"></a>

```
GET /access-policies/accessPolicyId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeAccessPolicy_RequestParameters"></a>

The request uses the following URI parameters.

 ** [accessPolicyId](#API_DescribeAccessPolicy_RequestSyntax) **   <a name="iotsitewise-DescribeAccessPolicy-request-uri-accessPolicyId"></a>
The ID of the access policy.  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`   
Required: Yes

## Request Body
<a name="API_DescribeAccessPolicy_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeAccessPolicy_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "accessPolicyArn": "string",
   "accessPolicyCreationDate": number,
   "accessPolicyId": "string",
   "accessPolicyIdentity": { 
      "group": { 
         "id": "string"
      },
      "iamRole": { 
         "arn": "string"
      },
      "iamUser": { 
         "arn": "string"
      },
      "user": { 
         "id": "string"
      }
   },
   "accessPolicyLastUpdateDate": number,
   "accessPolicyPermission": "string",
   "accessPolicyResource": { 
      "portal": { 
         "id": "string"
      },
      "project": { 
         "id": "string"
      }
   }
}
```

## Response Elements
<a name="API_DescribeAccessPolicy_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [accessPolicyArn](#API_DescribeAccessPolicy_ResponseSyntax) **   <a name="iotsitewise-DescribeAccessPolicy-response-accessPolicyArn"></a>
The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the access policy, which has the following format.  
 `arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId}`   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$` 

 ** [accessPolicyCreationDate](#API_DescribeAccessPolicy_ResponseSyntax) **   <a name="iotsitewise-DescribeAccessPolicy-response-accessPolicyCreationDate"></a>
The date the access policy was created, in Unix epoch time.  
Type: Timestamp

 ** [accessPolicyId](#API_DescribeAccessPolicy_ResponseSyntax) **   <a name="iotsitewise-DescribeAccessPolicy-response-accessPolicyId"></a>
The ID of the access policy.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

 ** [accessPolicyIdentity](#API_DescribeAccessPolicy_ResponseSyntax) **   <a name="iotsitewise-DescribeAccessPolicy-response-accessPolicyIdentity"></a>
The identity (IAM Identity Center user, IAM Identity Center group, or IAM user) to which this access policy applies.  
Type: [Identity](API_Identity.md) object

 ** [accessPolicyLastUpdateDate](#API_DescribeAccessPolicy_ResponseSyntax) **   <a name="iotsitewise-DescribeAccessPolicy-response-accessPolicyLastUpdateDate"></a>
The date the access policy was last updated, in Unix epoch time.  
Type: Timestamp

 ** [accessPolicyPermission](#API_DescribeAccessPolicy_ResponseSyntax) **   <a name="iotsitewise-DescribeAccessPolicy-response-accessPolicyPermission"></a>
The access policy permission. Note that a project `ADMINISTRATOR` is also known as a project owner.  
Type: String  
Valid Values: `ADMINISTRATOR | VIEWER` 

 ** [accessPolicyResource](#API_DescribeAccessPolicy_ResponseSyntax) **   <a name="iotsitewise-DescribeAccessPolicy-response-accessPolicyResource"></a>
The AWS IoT SiteWise Monitor resource (portal or project) to which this access policy provides access.  
Type: [Resource](API_Resource.md) object

## Errors
<a name="API_DescribeAccessPolicy_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_DescribeAccessPolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/DescribeAccessPolicy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/DescribeAccessPolicy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/DescribeAccessPolicy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/DescribeAccessPolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DescribeAccessPolicy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/DescribeAccessPolicy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/DescribeAccessPolicy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/DescribeAccessPolicy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/DescribeAccessPolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/DescribeAccessPolicy) 

# DescribeAction
<a name="API_DescribeAction"></a>

Retrieves information about an action.

## Request Syntax
<a name="API_DescribeAction_RequestSyntax"></a>

```
GET /actions/actionId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeAction_RequestParameters"></a>

The request uses the following URI parameters.

 ** [actionId](#API_DescribeAction_RequestSyntax) **   <a name="iotsitewise-DescribeAction-request-uri-actionId"></a>
The ID of the action.  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`   
Required: Yes

## Request Body
<a name="API_DescribeAction_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeAction_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "actionDefinitionId": "string",
   "actionId": "string",
   "actionPayload": { 
      "stringValue": "string"
   },
   "executionTime": number,
   "resolveTo": { 
      "assetId": "string"
   },
   "targetResource": { 
      "assetId": "string",
      "computationModelId": "string"
   }
}
```

## Response Elements
<a name="API_DescribeAction_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [actionDefinitionId](#API_DescribeAction_ResponseSyntax) **   <a name="iotsitewise-DescribeAction-response-actionDefinitionId"></a>
The ID of the action definition.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

 ** [actionId](#API_DescribeAction_ResponseSyntax) **   <a name="iotsitewise-DescribeAction-response-actionId"></a>
The ID of the action.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

 ** [actionPayload](#API_DescribeAction_ResponseSyntax) **   <a name="iotsitewise-DescribeAction-response-actionPayload"></a>
The JSON payload of the action.  
Type: [ActionPayload](API_ActionPayload.md) object

 ** [executionTime](#API_DescribeAction_ResponseSyntax) **   <a name="iotsitewise-DescribeAction-response-executionTime"></a>
The time the action was executed.  
Type: Timestamp

 ** [resolveTo](#API_DescribeAction_ResponseSyntax) **   <a name="iotsitewise-DescribeAction-response-resolveTo"></a>
The detailed resource this action resolves to.  
Type: [ResolveTo](API_ResolveTo.md) object

 ** [targetResource](#API_DescribeAction_ResponseSyntax) **   <a name="iotsitewise-DescribeAction-response-targetResource"></a>
The resource the action will be taken on.  
Type: [TargetResource](API_TargetResource.md) object

## Errors
<a name="API_DescribeAction_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_DescribeAction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/DescribeAction) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/DescribeAction) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/DescribeAction) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/DescribeAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DescribeAction) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/DescribeAction) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/DescribeAction) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/DescribeAction) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/DescribeAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/DescribeAction) 

# DescribeAsset
<a name="API_DescribeAsset"></a>

Retrieves information about an asset.

## Request Syntax
<a name="API_DescribeAsset_RequestSyntax"></a>

```
GET /assets/assetId?excludeProperties=excludeProperties HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeAsset_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assetId](#API_DescribeAsset_RequestSyntax) **   <a name="iotsitewise-DescribeAsset-request-uri-assetId"></a>
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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) in the * AWS IoT SiteWise User Guide*.  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+`   
Required: Yes

 ** [excludeProperties](#API_DescribeAsset_RequestSyntax) **   <a name="iotsitewise-DescribeAsset-request-uri-excludeProperties"></a>
 Whether or not to exclude asset properties from the response. 

## Request Body
<a name="API_DescribeAsset_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeAsset_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "assetArn": "string",
   "assetCompositeModels": [ 
      { 
         "description": "string",
         "externalId": "string",
         "id": "string",
         "name": "string",
         "properties": [ 
            { 
               "alias": "string",
               "dataType": "string",
               "dataTypeSpec": "string",
               "externalId": "string",
               "id": "string",
               "name": "string",
               "notification": { 
                  "state": "string",
                  "topic": "string"
               },
               "path": [ 
                  { 
                     "id": "string",
                     "name": "string"
                  }
               ],
               "unit": "string"
            }
         ],
         "type": "string"
      }
   ],
   "assetCompositeModelSummaries": [ 
      { 
         "description": "string",
         "externalId": "string",
         "id": "string",
         "name": "string",
         "path": [ 
            { 
               "id": "string",
               "name": "string"
            }
         ],
         "type": "string"
      }
   ],
   "assetCreationDate": number,
   "assetDescription": "string",
   "assetExternalId": "string",
   "assetHierarchies": [ 
      { 
         "externalId": "string",
         "id": "string",
         "name": "string"
      }
   ],
   "assetId": "string",
   "assetLastUpdateDate": number,
   "assetModelId": "string",
   "assetName": "string",
   "assetProperties": [ 
      { 
         "alias": "string",
         "dataType": "string",
         "dataTypeSpec": "string",
         "externalId": "string",
         "id": "string",
         "name": "string",
         "notification": { 
            "state": "string",
            "topic": "string"
         },
         "path": [ 
            { 
               "id": "string",
               "name": "string"
            }
         ],
         "unit": "string"
      }
   ],
   "assetStatus": { 
      "error": { 
         "code": "string",
         "details": [ 
            { 
               "code": "string",
               "message": "string"
            }
         ],
         "message": "string"
      },
      "state": "string"
   }
}
```

## Response Elements
<a name="API_DescribeAsset_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [assetArn](#API_DescribeAsset_ResponseSyntax) **   <a name="iotsitewise-DescribeAsset-response-assetArn"></a>
The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the asset, which has the following format.  
 `arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}`   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$` 

 ** [assetCompositeModels](#API_DescribeAsset_ResponseSyntax) **   <a name="iotsitewise-DescribeAsset-response-assetCompositeModels"></a>
The composite models for the asset.  
Type: Array of [AssetCompositeModel](API_AssetCompositeModel.md) objects

 ** [assetCompositeModelSummaries](#API_DescribeAsset_ResponseSyntax) **   <a name="iotsitewise-DescribeAsset-response-assetCompositeModelSummaries"></a>
The list of the immediate child custom composite model summaries for the asset.  
Type: Array of [AssetCompositeModelSummary](API_AssetCompositeModelSummary.md) objects

 ** [assetCreationDate](#API_DescribeAsset_ResponseSyntax) **   <a name="iotsitewise-DescribeAsset-response-assetCreationDate"></a>
The date the asset was created, in Unix epoch time.  
Type: Timestamp

 ** [assetDescription](#API_DescribeAsset_ResponseSyntax) **   <a name="iotsitewise-DescribeAsset-response-assetDescription"></a>
A description for the asset.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[^\u0000-\u001F\u007F]+` 

 ** [assetExternalId](#API_DescribeAsset_ResponseSyntax) **   <a name="iotsitewise-DescribeAsset-response-assetExternalId"></a>
The external ID of the asset, if any.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+` 

 ** [assetHierarchies](#API_DescribeAsset_ResponseSyntax) **   <a name="iotsitewise-DescribeAsset-response-assetHierarchies"></a>
A list of asset hierarchies that each contain a `hierarchyId`. A hierarchy specifies allowed parent/child asset relationships.  
Type: Array of [AssetHierarchy](API_AssetHierarchy.md) objects

 ** [assetId](#API_DescribeAsset_ResponseSyntax) **   <a name="iotsitewise-DescribeAsset-response-assetId"></a>
The ID of the asset, in UUID format.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

 ** [assetLastUpdateDate](#API_DescribeAsset_ResponseSyntax) **   <a name="iotsitewise-DescribeAsset-response-assetLastUpdateDate"></a>
The date the asset was last updated, in Unix epoch time.  
Type: Timestamp

 ** [assetModelId](#API_DescribeAsset_ResponseSyntax) **   <a name="iotsitewise-DescribeAsset-response-assetModelId"></a>
The ID of the asset model that was used to create the asset.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

 ** [assetName](#API_DescribeAsset_ResponseSyntax) **   <a name="iotsitewise-DescribeAsset-response-assetName"></a>
The name of the asset.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[^\u0000-\u001F\u007F]+` 

 ** [assetProperties](#API_DescribeAsset_ResponseSyntax) **   <a name="iotsitewise-DescribeAsset-response-assetProperties"></a>
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.  
Type: Array of [AssetProperty](API_AssetProperty.md) objects

 ** [assetStatus](#API_DescribeAsset_ResponseSyntax) **   <a name="iotsitewise-DescribeAsset-response-assetStatus"></a>
The current status of the asset, which contains a state and any error message.  
Type: [AssetStatus](API_AssetStatus.md) object

## Errors
<a name="API_DescribeAsset_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_DescribeAsset_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/DescribeAsset) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/DescribeAsset) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/DescribeAsset) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/DescribeAsset) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DescribeAsset) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/DescribeAsset) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/DescribeAsset) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/DescribeAsset) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/DescribeAsset) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/DescribeAsset) 

# DescribeAssetCompositeModel
<a name="API_DescribeAssetCompositeModel"></a>

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](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModelCompositeModel.html).

## Request Syntax
<a name="API_DescribeAssetCompositeModel_RequestSyntax"></a>

```
GET /assets/assetId/composite-models/assetCompositeModelId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeAssetCompositeModel_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assetCompositeModelId](#API_DescribeAssetCompositeModel_RequestSyntax) **   <a name="iotsitewise-DescribeAssetCompositeModel-request-uri-assetCompositeModelId"></a>
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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) in the * AWS IoT SiteWise User Guide*.  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+`   
Required: Yes

 ** [assetId](#API_DescribeAssetCompositeModel_RequestSyntax) **   <a name="iotsitewise-DescribeAssetCompositeModel-request-uri-assetId"></a>
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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) in the * AWS IoT SiteWise User Guide*.  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+`   
Required: Yes

## Request Body
<a name="API_DescribeAssetCompositeModel_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeAssetCompositeModel_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "actionDefinitions": [ 
      { 
         "actionDefinitionId": "string",
         "actionName": "string",
         "actionType": "string"
      }
   ],
   "assetCompositeModelDescription": "string",
   "assetCompositeModelExternalId": "string",
   "assetCompositeModelId": "string",
   "assetCompositeModelName": "string",
   "assetCompositeModelPath": [ 
      { 
         "id": "string",
         "name": "string"
      }
   ],
   "assetCompositeModelProperties": [ 
      { 
         "alias": "string",
         "dataType": "string",
         "dataTypeSpec": "string",
         "externalId": "string",
         "id": "string",
         "name": "string",
         "notification": { 
            "state": "string",
            "topic": "string"
         },
         "path": [ 
            { 
               "id": "string",
               "name": "string"
            }
         ],
         "unit": "string"
      }
   ],
   "assetCompositeModelSummaries": [ 
      { 
         "description": "string",
         "externalId": "string",
         "id": "string",
         "name": "string",
         "path": [ 
            { 
               "id": "string",
               "name": "string"
            }
         ],
         "type": "string"
      }
   ],
   "assetCompositeModelType": "string",
   "assetId": "string"
}
```

## Response Elements
<a name="API_DescribeAssetCompositeModel_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [actionDefinitions](#API_DescribeAssetCompositeModel_ResponseSyntax) **   <a name="iotsitewise-DescribeAssetCompositeModel-response-actionDefinitions"></a>
The available actions for a composite model on this asset.  
Type: Array of [ActionDefinition](API_ActionDefinition.md) objects

 ** [assetCompositeModelDescription](#API_DescribeAssetCompositeModel_ResponseSyntax) **   <a name="iotsitewise-DescribeAssetCompositeModel-response-assetCompositeModelDescription"></a>
A description for the composite model.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[^\u0000-\u001F\u007F]+` 

 ** [assetCompositeModelExternalId](#API_DescribeAssetCompositeModel_ResponseSyntax) **   <a name="iotsitewise-DescribeAssetCompositeModel-response-assetCompositeModelExternalId"></a>
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.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+` 

 ** [assetCompositeModelId](#API_DescribeAssetCompositeModel_ResponseSyntax) **   <a name="iotsitewise-DescribeAssetCompositeModel-response-assetCompositeModelId"></a>
The ID of a composite model on this asset.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

 ** [assetCompositeModelName](#API_DescribeAssetCompositeModel_ResponseSyntax) **   <a name="iotsitewise-DescribeAssetCompositeModel-response-assetCompositeModelName"></a>
The unique, friendly name for the composite model.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[^\u0000-\u001F\u007F]+` 

 ** [assetCompositeModelPath](#API_DescribeAssetCompositeModel_ResponseSyntax) **   <a name="iotsitewise-DescribeAssetCompositeModel-response-assetCompositeModelPath"></a>
The path to the composite model listing the parent composite models.  
Type: Array of [AssetCompositeModelPathSegment](API_AssetCompositeModelPathSegment.md) objects

 ** [assetCompositeModelProperties](#API_DescribeAssetCompositeModel_ResponseSyntax) **   <a name="iotsitewise-DescribeAssetCompositeModel-response-assetCompositeModelProperties"></a>
The property definitions of the composite model that was used to create the asset.  
Type: Array of [AssetProperty](API_AssetProperty.md) objects

 ** [assetCompositeModelSummaries](#API_DescribeAssetCompositeModel_ResponseSyntax) **   <a name="iotsitewise-DescribeAssetCompositeModel-response-assetCompositeModelSummaries"></a>
The list of composite model summaries.  
Type: Array of [AssetCompositeModelSummary](API_AssetCompositeModelSummary.md) objects

 ** [assetCompositeModelType](#API_DescribeAssetCompositeModel_ResponseSyntax) **   <a name="iotsitewise-DescribeAssetCompositeModel-response-assetCompositeModelType"></a>
The composite model type. Valid values are `AWS/ALARM`, `CUSTOM`, or ` AWS/L4E_ANOMALY`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[^\u0000-\u001F\u007F]+` 

 ** [assetId](#API_DescribeAssetCompositeModel_ResponseSyntax) **   <a name="iotsitewise-DescribeAssetCompositeModel-response-assetId"></a>
The ID of the asset, in UUID format. This ID uniquely identifies the asset within AWS IoT SiteWise and can be used with other AWS IoT SiteWise APIs.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

## Errors
<a name="API_DescribeAssetCompositeModel_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_DescribeAssetCompositeModel_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/DescribeAssetCompositeModel) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/DescribeAssetCompositeModel) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/DescribeAssetCompositeModel) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/DescribeAssetCompositeModel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DescribeAssetCompositeModel) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/DescribeAssetCompositeModel) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/DescribeAssetCompositeModel) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/DescribeAssetCompositeModel) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/DescribeAssetCompositeModel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/DescribeAssetCompositeModel) 

# DescribeAssetModel
<a name="API_DescribeAssetModel"></a>

Retrieves information about an asset model. This includes details about the asset model's properties, hierarchies, composite models, and any interface relationships if the asset model implements interfaces.

## Request Syntax
<a name="API_DescribeAssetModel_RequestSyntax"></a>

```
GET /asset-models/assetModelId?assetModelVersion=assetModelVersion&excludeProperties=excludeProperties HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeAssetModel_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assetModelId](#API_DescribeAssetModel_RequestSyntax) **   <a name="iotsitewise-DescribeAssetModel-request-uri-assetModelId"></a>
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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) in the * AWS IoT SiteWise User Guide*.  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+`   
Required: Yes

 ** [assetModelVersion](#API_DescribeAssetModel_RequestSyntax) **   <a name="iotsitewise-DescribeAssetModel-request-uri-assetModelVersion"></a>
The version alias that specifies the latest or active version of the asset model. The details are returned in the response. The default value is `LATEST`. See [ Asset model versions](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/model-active-version.html) in the * AWS IoT SiteWise User Guide*.  
Pattern: `^(LATEST|ACTIVE)$` 

 ** [excludeProperties](#API_DescribeAssetModel_RequestSyntax) **   <a name="iotsitewise-DescribeAssetModel-request-uri-excludeProperties"></a>
 Whether or not to exclude asset model properties from the response. 

## Request Body
<a name="API_DescribeAssetModel_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeAssetModel_ResponseSyntax"></a>

```
HTTP/1.1 200
ETag: eTag
Content-type: application/json

{
   "assetModelArn": "string",
   "assetModelCompositeModels": [ 
      { 
         "description": "string",
         "externalId": "string",
         "id": "string",
         "name": "string",
         "properties": [ 
            { 
               "dataType": "string",
               "dataTypeSpec": "string",
               "externalId": "string",
               "id": "string",
               "name": "string",
               "path": [ 
                  { 
                     "id": "string",
                     "name": "string"
                  }
               ],
               "type": { 
                  "attribute": { 
                     "defaultValue": "string"
                  },
                  "measurement": { 
                     "processingConfig": { 
                        "forwardingConfig": { 
                           "state": "string"
                        }
                     }
                  },
                  "metric": { 
                     "expression": "string",
                     "processingConfig": { 
                        "computeLocation": "string"
                     },
                     "variables": [ 
                        { 
                           "name": "string",
                           "value": { 
                              "hierarchyId": "string",
                              "propertyId": "string",
                              "propertyPath": [ 
                                 { 
                                    "id": "string",
                                    "name": "string"
                                 }
                              ]
                           }
                        }
                     ],
                     "window": { 
                        "tumbling": { 
                           "interval": "string",
                           "offset": "string"
                        }
                     }
                  },
                  "transform": { 
                     "expression": "string",
                     "processingConfig": { 
                        "computeLocation": "string",
                        "forwardingConfig": { 
                           "state": "string"
                        }
                     },
                     "variables": [ 
                        { 
                           "name": "string",
                           "value": { 
                              "hierarchyId": "string",
                              "propertyId": "string",
                              "propertyPath": [ 
                                 { 
                                    "id": "string",
                                    "name": "string"
                                 }
                              ]
                           }
                        }
                     ]
                  }
               },
               "unit": "string"
            }
         ],
         "type": "string"
      }
   ],
   "assetModelCompositeModelSummaries": [ 
      { 
         "description": "string",
         "externalId": "string",
         "id": "string",
         "name": "string",
         "path": [ 
            { 
               "id": "string",
               "name": "string"
            }
         ],
         "type": "string"
      }
   ],
   "assetModelCreationDate": number,
   "assetModelDescription": "string",
   "assetModelExternalId": "string",
   "assetModelHierarchies": [ 
      { 
         "childAssetModelId": "string",
         "externalId": "string",
         "id": "string",
         "name": "string"
      }
   ],
   "assetModelId": "string",
   "assetModelLastUpdateDate": number,
   "assetModelName": "string",
   "assetModelProperties": [ 
      { 
         "dataType": "string",
         "dataTypeSpec": "string",
         "externalId": "string",
         "id": "string",
         "name": "string",
         "path": [ 
            { 
               "id": "string",
               "name": "string"
            }
         ],
         "type": { 
            "attribute": { 
               "defaultValue": "string"
            },
            "measurement": { 
               "processingConfig": { 
                  "forwardingConfig": { 
                     "state": "string"
                  }
               }
            },
            "metric": { 
               "expression": "string",
               "processingConfig": { 
                  "computeLocation": "string"
               },
               "variables": [ 
                  { 
                     "name": "string",
                     "value": { 
                        "hierarchyId": "string",
                        "propertyId": "string",
                        "propertyPath": [ 
                           { 
                              "id": "string",
                              "name": "string"
                           }
                        ]
                     }
                  }
               ],
               "window": { 
                  "tumbling": { 
                     "interval": "string",
                     "offset": "string"
                  }
               }
            },
            "transform": { 
               "expression": "string",
               "processingConfig": { 
                  "computeLocation": "string",
                  "forwardingConfig": { 
                     "state": "string"
                  }
               },
               "variables": [ 
                  { 
                     "name": "string",
                     "value": { 
                        "hierarchyId": "string",
                        "propertyId": "string",
                        "propertyPath": [ 
                           { 
                              "id": "string",
                              "name": "string"
                           }
                        ]
                     }
                  }
               ]
            }
         },
         "unit": "string"
      }
   ],
   "assetModelStatus": { 
      "error": { 
         "code": "string",
         "details": [ 
            { 
               "code": "string",
               "message": "string"
            }
         ],
         "message": "string"
      },
      "state": "string"
   },
   "assetModelType": "string",
   "assetModelVersion": "string",
   "interfaceDetails": [ 
      { 
         "id": "string"
      }
   ]
}
```

## Response Elements
<a name="API_DescribeAssetModel_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The response returns the following HTTP headers.

 ** [eTag](#API_DescribeAssetModel_ResponseSyntax) **   <a name="iotsitewise-DescribeAssetModel-response-eTag"></a>
The entity tag (ETag) is a hash of the retrieved version of the asset model. It's used to make concurrent updates safely to the resource. See [Optimistic locking for asset model writes](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/opt-locking-for-model.html) in the * AWS IoT SiteWise User Guide*.   
See [ Optimistic locking for asset model writes](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/opt-locking-for-model.html) in the * AWS IoT SiteWise User Guide*.  
Pattern: `^[\w-]{43}$` 

The following data is returned in JSON format by the service.

 ** [assetModelArn](#API_DescribeAssetModel_ResponseSyntax) **   <a name="iotsitewise-DescribeAssetModel-response-assetModelArn"></a>
The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the asset model, which has the following format.  
 `arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}`   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$` 

 ** [assetModelCompositeModels](#API_DescribeAssetModel_ResponseSyntax) **   <a name="iotsitewise-DescribeAssetModel-response-assetModelCompositeModels"></a>
The list of built-in composite models for the asset model, such as those with those of type `AWS/ALARMS`.  
Type: Array of [AssetModelCompositeModel](API_AssetModelCompositeModel.md) objects

 ** [assetModelCompositeModelSummaries](#API_DescribeAssetModel_ResponseSyntax) **   <a name="iotsitewise-DescribeAssetModel-response-assetModelCompositeModelSummaries"></a>
The list of the immediate child custom composite model summaries for the asset model.  
Type: Array of [AssetModelCompositeModelSummary](API_AssetModelCompositeModelSummary.md) objects

 ** [assetModelCreationDate](#API_DescribeAssetModel_ResponseSyntax) **   <a name="iotsitewise-DescribeAssetModel-response-assetModelCreationDate"></a>
The date the asset model was created, in Unix epoch time.  
Type: Timestamp

 ** [assetModelDescription](#API_DescribeAssetModel_ResponseSyntax) **   <a name="iotsitewise-DescribeAssetModel-response-assetModelDescription"></a>
The asset model's description.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[^\u0000-\u001F\u007F]+` 

 ** [assetModelExternalId](#API_DescribeAssetModel_ResponseSyntax) **   <a name="iotsitewise-DescribeAssetModel-response-assetModelExternalId"></a>
The external ID of the asset model, if any.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+` 

 ** [assetModelHierarchies](#API_DescribeAssetModel_ResponseSyntax) **   <a name="iotsitewise-DescribeAssetModel-response-assetModelHierarchies"></a>
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.  
Type: Array of [AssetModelHierarchy](API_AssetModelHierarchy.md) objects

 ** [assetModelId](#API_DescribeAssetModel_ResponseSyntax) **   <a name="iotsitewise-DescribeAssetModel-response-assetModelId"></a>
The ID of the asset model, in UUID format.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

 ** [assetModelLastUpdateDate](#API_DescribeAssetModel_ResponseSyntax) **   <a name="iotsitewise-DescribeAssetModel-response-assetModelLastUpdateDate"></a>
The date the asset model was last updated, in Unix epoch time.  
Type: Timestamp

 ** [assetModelName](#API_DescribeAssetModel_ResponseSyntax) **   <a name="iotsitewise-DescribeAssetModel-response-assetModelName"></a>
The name of the asset model.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[^\u0000-\u001F\u007F]+` 

 ** [assetModelProperties](#API_DescribeAssetModel_ResponseSyntax) **   <a name="iotsitewise-DescribeAssetModel-response-assetModelProperties"></a>
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.  
Type: Array of [AssetModelProperty](API_AssetModelProperty.md) objects

 ** [assetModelStatus](#API_DescribeAssetModel_ResponseSyntax) **   <a name="iotsitewise-DescribeAssetModel-response-assetModelStatus"></a>
The current status of the asset model, which contains a state and any error message.  
Type: [AssetModelStatus](API_AssetModelStatus.md) object

 ** [assetModelType](#API_DescribeAssetModel_ResponseSyntax) **   <a name="iotsitewise-DescribeAssetModel-response-assetModelType"></a>
The type of asset model.  
+  **ASSET\$1MODEL** – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.
+  **COMPONENT\$1MODEL** – 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. 
Type: String  
Valid Values: `ASSET_MODEL | COMPONENT_MODEL | INTERFACE` 

 ** [assetModelVersion](#API_DescribeAssetModel_ResponseSyntax) **   <a name="iotsitewise-DescribeAssetModel-response-assetModelVersion"></a>
The version of the asset model. See [ Asset model versions](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/model-active-version.html) in the * AWS IoT SiteWise User Guide*.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 10.  
Pattern: `^(0|([1-9]{1}\d*))$` 

 ** [interfaceDetails](#API_DescribeAssetModel_ResponseSyntax) **   <a name="iotsitewise-DescribeAssetModel-response-interfaceDetails"></a>
A list of interface details that describe the interfaces implemented by this asset model, including interface asset model IDs and property mappings.  
Type: Array of [InterfaceRelationship](API_InterfaceRelationship.md) objects

## Errors
<a name="API_DescribeAssetModel_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_DescribeAssetModel_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/DescribeAssetModel) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/DescribeAssetModel) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/DescribeAssetModel) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/DescribeAssetModel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DescribeAssetModel) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/DescribeAssetModel) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/DescribeAssetModel) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/DescribeAssetModel) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/DescribeAssetModel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/DescribeAssetModel) 

# DescribeAssetModelCompositeModel
<a name="API_DescribeAssetModelCompositeModel"></a>

Retrieves information about an asset model composite model (also known as an asset model component). For more information, see [Custom composite models (Components)](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/custom-composite-models.html) in the * AWS IoT SiteWise User Guide*.

## Request Syntax
<a name="API_DescribeAssetModelCompositeModel_RequestSyntax"></a>

```
GET /asset-models/assetModelId/composite-models/assetModelCompositeModelId?assetModelVersion=assetModelVersion HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeAssetModelCompositeModel_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assetModelCompositeModelId](#API_DescribeAssetModelCompositeModel_RequestSyntax) **   <a name="iotsitewise-DescribeAssetModelCompositeModel-request-uri-assetModelCompositeModelId"></a>
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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) in the * AWS IoT SiteWise User Guide*.  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+`   
Required: Yes

 ** [assetModelId](#API_DescribeAssetModelCompositeModel_RequestSyntax) **   <a name="iotsitewise-DescribeAssetModelCompositeModel-request-uri-assetModelId"></a>
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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) in the * AWS IoT SiteWise User Guide*.  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+`   
Required: Yes

 ** [assetModelVersion](#API_DescribeAssetModelCompositeModel_RequestSyntax) **   <a name="iotsitewise-DescribeAssetModelCompositeModel-request-uri-assetModelVersion"></a>
The version alias that specifies the latest or active version of the asset model. The details are returned in the response. The default value is `LATEST`. See [ Asset model versions](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/model-active-version.html) in the * AWS IoT SiteWise User Guide*.  
Pattern: `^(LATEST|ACTIVE)$` 

## Request Body
<a name="API_DescribeAssetModelCompositeModel_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeAssetModelCompositeModel_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "actionDefinitions": [ 
      { 
         "actionDefinitionId": "string",
         "actionName": "string",
         "actionType": "string"
      }
   ],
   "assetModelCompositeModelDescription": "string",
   "assetModelCompositeModelExternalId": "string",
   "assetModelCompositeModelId": "string",
   "assetModelCompositeModelName": "string",
   "assetModelCompositeModelPath": [ 
      { 
         "id": "string",
         "name": "string"
      }
   ],
   "assetModelCompositeModelProperties": [ 
      { 
         "dataType": "string",
         "dataTypeSpec": "string",
         "externalId": "string",
         "id": "string",
         "name": "string",
         "path": [ 
            { 
               "id": "string",
               "name": "string"
            }
         ],
         "type": { 
            "attribute": { 
               "defaultValue": "string"
            },
            "measurement": { 
               "processingConfig": { 
                  "forwardingConfig": { 
                     "state": "string"
                  }
               }
            },
            "metric": { 
               "expression": "string",
               "processingConfig": { 
                  "computeLocation": "string"
               },
               "variables": [ 
                  { 
                     "name": "string",
                     "value": { 
                        "hierarchyId": "string",
                        "propertyId": "string",
                        "propertyPath": [ 
                           { 
                              "id": "string",
                              "name": "string"
                           }
                        ]
                     }
                  }
               ],
               "window": { 
                  "tumbling": { 
                     "interval": "string",
                     "offset": "string"
                  }
               }
            },
            "transform": { 
               "expression": "string",
               "processingConfig": { 
                  "computeLocation": "string",
                  "forwardingConfig": { 
                     "state": "string"
                  }
               },
               "variables": [ 
                  { 
                     "name": "string",
                     "value": { 
                        "hierarchyId": "string",
                        "propertyId": "string",
                        "propertyPath": [ 
                           { 
                              "id": "string",
                              "name": "string"
                           }
                        ]
                     }
                  }
               ]
            }
         },
         "unit": "string"
      }
   ],
   "assetModelCompositeModelSummaries": [ 
      { 
         "description": "string",
         "externalId": "string",
         "id": "string",
         "name": "string",
         "path": [ 
            { 
               "id": "string",
               "name": "string"
            }
         ],
         "type": "string"
      }
   ],
   "assetModelCompositeModelType": "string",
   "assetModelId": "string",
   "compositionDetails": { 
      "compositionRelationship": [ 
         { 
            "id": "string"
         }
      ]
   }
}
```

## Response Elements
<a name="API_DescribeAssetModelCompositeModel_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [actionDefinitions](#API_DescribeAssetModelCompositeModel_ResponseSyntax) **   <a name="iotsitewise-DescribeAssetModelCompositeModel-response-actionDefinitions"></a>
The available actions for a composite model on this asset model.  
Type: Array of [ActionDefinition](API_ActionDefinition.md) objects

 ** [assetModelCompositeModelDescription](#API_DescribeAssetModelCompositeModel_ResponseSyntax) **   <a name="iotsitewise-DescribeAssetModelCompositeModel-response-assetModelCompositeModelDescription"></a>
The description for the composite model.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[^\u0000-\u001F\u007F]+` 

 ** [assetModelCompositeModelExternalId](#API_DescribeAssetModelCompositeModel_ResponseSyntax) **   <a name="iotsitewise-DescribeAssetModelCompositeModel-response-assetModelCompositeModelExternalId"></a>
The external ID of a composite model on this asset model.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+` 

 ** [assetModelCompositeModelId](#API_DescribeAssetModelCompositeModel_ResponseSyntax) **   <a name="iotsitewise-DescribeAssetModelCompositeModel-response-assetModelCompositeModelId"></a>
The ID of a composite model on this asset model.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

 ** [assetModelCompositeModelName](#API_DescribeAssetModelCompositeModel_ResponseSyntax) **   <a name="iotsitewise-DescribeAssetModelCompositeModel-response-assetModelCompositeModelName"></a>
The unique, friendly name for the composite model.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[^\u0000-\u001F\u007F]+` 

 ** [assetModelCompositeModelPath](#API_DescribeAssetModelCompositeModel_ResponseSyntax) **   <a name="iotsitewise-DescribeAssetModelCompositeModel-response-assetModelCompositeModelPath"></a>
The path to the composite model listing the parent composite models.  
Type: Array of [AssetModelCompositeModelPathSegment](API_AssetModelCompositeModelPathSegment.md) objects

 ** [assetModelCompositeModelProperties](#API_DescribeAssetModelCompositeModel_ResponseSyntax) **   <a name="iotsitewise-DescribeAssetModelCompositeModel-response-assetModelCompositeModelProperties"></a>
The property definitions of the composite model.  
Type: Array of [AssetModelProperty](API_AssetModelProperty.md) objects

 ** [assetModelCompositeModelSummaries](#API_DescribeAssetModelCompositeModel_ResponseSyntax) **   <a name="iotsitewise-DescribeAssetModelCompositeModel-response-assetModelCompositeModelSummaries"></a>
The list of composite model summaries for the composite model.  
Type: Array of [AssetModelCompositeModelSummary](API_AssetModelCompositeModelSummary.md) objects

 ** [assetModelCompositeModelType](#API_DescribeAssetModelCompositeModel_ResponseSyntax) **   <a name="iotsitewise-DescribeAssetModelCompositeModel-response-assetModelCompositeModelType"></a>
The composite model type. Valid values are `AWS/ALARM`, `CUSTOM`, or ` AWS/L4E_ANOMALY`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[^\u0000-\u001F\u007F]+` 

 ** [assetModelId](#API_DescribeAssetModelCompositeModel_ResponseSyntax) **   <a name="iotsitewise-DescribeAssetModelCompositeModel-response-assetModelId"></a>
The ID of the asset model, in UUID format.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

 ** [compositionDetails](#API_DescribeAssetModelCompositeModel_ResponseSyntax) **   <a name="iotsitewise-DescribeAssetModelCompositeModel-response-compositionDetails"></a>
Metadata for the composition relationship established by using `composedAssetModelId` in [https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html). For instance, an array detailing the path of the composition relationship for this composite model.  
Type: [CompositionDetails](API_CompositionDetails.md) object

## Errors
<a name="API_DescribeAssetModelCompositeModel_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_DescribeAssetModelCompositeModel_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/DescribeAssetModelCompositeModel) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/DescribeAssetModelCompositeModel) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/DescribeAssetModelCompositeModel) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/DescribeAssetModelCompositeModel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DescribeAssetModelCompositeModel) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/DescribeAssetModelCompositeModel) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/DescribeAssetModelCompositeModel) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/DescribeAssetModelCompositeModel) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/DescribeAssetModelCompositeModel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/DescribeAssetModelCompositeModel) 

# DescribeAssetModelInterfaceRelationship
<a name="API_DescribeAssetModelInterfaceRelationship"></a>

Retrieves information about an interface relationship between an asset model and an interface asset model.

## Request Syntax
<a name="API_DescribeAssetModelInterfaceRelationship_RequestSyntax"></a>

```
GET /asset-models/assetModelId/interface/interfaceAssetModelId/asset-model-interface-relationship HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeAssetModelInterfaceRelationship_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assetModelId](#API_DescribeAssetModelInterfaceRelationship_RequestSyntax) **   <a name="iotsitewise-DescribeAssetModelInterfaceRelationship-request-uri-assetModelId"></a>
The ID of the asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID.  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+`   
Required: Yes

 ** [interfaceAssetModelId](#API_DescribeAssetModelInterfaceRelationship_RequestSyntax) **   <a name="iotsitewise-DescribeAssetModelInterfaceRelationship-request-uri-interfaceAssetModelId"></a>
The ID of the interface asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID.  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+`   
Required: Yes

## Request Body
<a name="API_DescribeAssetModelInterfaceRelationship_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeAssetModelInterfaceRelationship_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "assetModelId": "string",
   "hierarchyMappings": [ 
      { 
         "assetModelHierarchyId": "string",
         "interfaceAssetModelHierarchyId": "string"
      }
   ],
   "interfaceAssetModelId": "string",
   "propertyMappings": [ 
      { 
         "assetModelPropertyId": "string",
         "interfaceAssetModelPropertyId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_DescribeAssetModelInterfaceRelationship_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [assetModelId](#API_DescribeAssetModelInterfaceRelationship_ResponseSyntax) **   <a name="iotsitewise-DescribeAssetModelInterfaceRelationship-response-assetModelId"></a>
The ID of the asset model.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

 ** [hierarchyMappings](#API_DescribeAssetModelInterfaceRelationship_ResponseSyntax) **   <a name="iotsitewise-DescribeAssetModelInterfaceRelationship-response-hierarchyMappings"></a>
A list of hierarchy mappings between the interface asset model and the asset model where the interface is applied.  
Type: Array of [HierarchyMapping](API_HierarchyMapping.md) objects

 ** [interfaceAssetModelId](#API_DescribeAssetModelInterfaceRelationship_ResponseSyntax) **   <a name="iotsitewise-DescribeAssetModelInterfaceRelationship-response-interfaceAssetModelId"></a>
The ID of the interface asset model.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

 ** [propertyMappings](#API_DescribeAssetModelInterfaceRelationship_ResponseSyntax) **   <a name="iotsitewise-DescribeAssetModelInterfaceRelationship-response-propertyMappings"></a>
A list of property mappings between the interface asset model and the asset model where the interface is applied.  
Type: Array of [PropertyMapping](API_PropertyMapping.md) objects

## Errors
<a name="API_DescribeAssetModelInterfaceRelationship_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_DescribeAssetModelInterfaceRelationship_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/DescribeAssetModelInterfaceRelationship) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/DescribeAssetModelInterfaceRelationship) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/DescribeAssetModelInterfaceRelationship) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/DescribeAssetModelInterfaceRelationship) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DescribeAssetModelInterfaceRelationship) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/DescribeAssetModelInterfaceRelationship) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/DescribeAssetModelInterfaceRelationship) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/DescribeAssetModelInterfaceRelationship) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/DescribeAssetModelInterfaceRelationship) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/DescribeAssetModelInterfaceRelationship) 

# DescribeAssetProperty
<a name="API_DescribeAssetProperty"></a>

Retrieves information about an asset property.

**Note**  
When you call this operation for an attribute property, this response includes the default attribute value that you define in the asset model. If you update the default value in the model, this operation's response includes the new default value.

This operation doesn't return the value of the asset property. To get the value of an asset property, use [GetAssetPropertyValue](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_GetAssetPropertyValue.html).

## Request Syntax
<a name="API_DescribeAssetProperty_RequestSyntax"></a>

```
GET /assets/assetId/properties/propertyId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeAssetProperty_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assetId](#API_DescribeAssetProperty_RequestSyntax) **   <a name="iotsitewise-DescribeAssetProperty-request-uri-assetId"></a>
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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) in the * AWS IoT SiteWise User Guide*.  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+`   
Required: Yes

 ** [propertyId](#API_DescribeAssetProperty_RequestSyntax) **   <a name="iotsitewise-DescribeAssetProperty-request-uri-propertyId"></a>
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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) in the * AWS IoT SiteWise User Guide*.  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+`   
Required: Yes

## Request Body
<a name="API_DescribeAssetProperty_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeAssetProperty_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "assetExternalId": "string",
   "assetId": "string",
   "assetModelId": "string",
   "assetName": "string",
   "assetProperty": { 
      "alias": "string",
      "dataType": "string",
      "externalId": "string",
      "id": "string",
      "name": "string",
      "notification": { 
         "state": "string",
         "topic": "string"
      },
      "path": [ 
         { 
            "id": "string",
            "name": "string"
         }
      ],
      "type": { 
         "attribute": { 
            "defaultValue": "string"
         },
         "measurement": { 
            "processingConfig": { 
               "forwardingConfig": { 
                  "state": "string"
               }
            }
         },
         "metric": { 
            "expression": "string",
            "processingConfig": { 
               "computeLocation": "string"
            },
            "variables": [ 
               { 
                  "name": "string",
                  "value": { 
                     "hierarchyId": "string",
                     "propertyId": "string",
                     "propertyPath": [ 
                        { 
                           "id": "string",
                           "name": "string"
                        }
                     ]
                  }
               }
            ],
            "window": { 
               "tumbling": { 
                  "interval": "string",
                  "offset": "string"
               }
            }
         },
         "transform": { 
            "expression": "string",
            "processingConfig": { 
               "computeLocation": "string",
               "forwardingConfig": { 
                  "state": "string"
               }
            },
            "variables": [ 
               { 
                  "name": "string",
                  "value": { 
                     "hierarchyId": "string",
                     "propertyId": "string",
                     "propertyPath": [ 
                        { 
                           "id": "string",
                           "name": "string"
                        }
                     ]
                  }
               }
            ]
         }
      },
      "unit": "string"
   },
   "compositeModel": { 
      "assetProperty": { 
         "alias": "string",
         "dataType": "string",
         "externalId": "string",
         "id": "string",
         "name": "string",
         "notification": { 
            "state": "string",
            "topic": "string"
         },
         "path": [ 
            { 
               "id": "string",
               "name": "string"
            }
         ],
         "type": { 
            "attribute": { 
               "defaultValue": "string"
            },
            "measurement": { 
               "processingConfig": { 
                  "forwardingConfig": { 
                     "state": "string"
                  }
               }
            },
            "metric": { 
               "expression": "string",
               "processingConfig": { 
                  "computeLocation": "string"
               },
               "variables": [ 
                  { 
                     "name": "string",
                     "value": { 
                        "hierarchyId": "string",
                        "propertyId": "string",
                        "propertyPath": [ 
                           { 
                              "id": "string",
                              "name": "string"
                           }
                        ]
                     }
                  }
               ],
               "window": { 
                  "tumbling": { 
                     "interval": "string",
                     "offset": "string"
                  }
               }
            },
            "transform": { 
               "expression": "string",
               "processingConfig": { 
                  "computeLocation": "string",
                  "forwardingConfig": { 
                     "state": "string"
                  }
               },
               "variables": [ 
                  { 
                     "name": "string",
                     "value": { 
                        "hierarchyId": "string",
                        "propertyId": "string",
                        "propertyPath": [ 
                           { 
                              "id": "string",
                              "name": "string"
                           }
                        ]
                     }
                  }
               ]
            }
         },
         "unit": "string"
      },
      "externalId": "string",
      "id": "string",
      "name": "string",
      "type": "string"
   }
}
```

## Response Elements
<a name="API_DescribeAssetProperty_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [assetExternalId](#API_DescribeAssetProperty_ResponseSyntax) **   <a name="iotsitewise-DescribeAssetProperty-response-assetExternalId"></a>
The external ID of the asset. For more information, see [Using external IDs](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) in the * AWS IoT SiteWise User Guide*.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+` 

 ** [assetId](#API_DescribeAssetProperty_ResponseSyntax) **   <a name="iotsitewise-DescribeAssetProperty-response-assetId"></a>
The ID of the asset, in UUID format.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

 ** [assetModelId](#API_DescribeAssetProperty_ResponseSyntax) **   <a name="iotsitewise-DescribeAssetProperty-response-assetModelId"></a>
The ID of the asset model, in UUID format.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

 ** [assetName](#API_DescribeAssetProperty_ResponseSyntax) **   <a name="iotsitewise-DescribeAssetProperty-response-assetName"></a>
The name of the asset.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[^\u0000-\u001F\u007F]+` 

 ** [assetProperty](#API_DescribeAssetProperty_ResponseSyntax) **   <a name="iotsitewise-DescribeAssetProperty-response-assetProperty"></a>
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`.  
Type: [Property](API_Property.md) object

 ** [compositeModel](#API_DescribeAssetProperty_ResponseSyntax) **   <a name="iotsitewise-DescribeAssetProperty-response-compositeModel"></a>
The composite model that declares this asset property, if this asset property exists in a composite model.  
Type: [CompositeModelProperty](API_CompositeModelProperty.md) object

## Errors
<a name="API_DescribeAssetProperty_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_DescribeAssetProperty_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/DescribeAssetProperty) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/DescribeAssetProperty) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/DescribeAssetProperty) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/DescribeAssetProperty) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DescribeAssetProperty) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/DescribeAssetProperty) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/DescribeAssetProperty) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/DescribeAssetProperty) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/DescribeAssetProperty) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/DescribeAssetProperty) 

# DescribeBulkImportJob
<a name="API_DescribeBulkImportJob"></a>

Retrieves information about a bulk import job request. For more information, see [Describe a bulk import job (AWS CLI)](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/DescribeBulkImportJob.html) in the *Amazon Simple Storage Service User Guide*.

## Request Syntax
<a name="API_DescribeBulkImportJob_RequestSyntax"></a>

```
GET /jobs/jobId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeBulkImportJob_RequestParameters"></a>

The request uses the following URI parameters.

 ** [jobId](#API_DescribeBulkImportJob_RequestSyntax) **   <a name="iotsitewise-DescribeBulkImportJob-request-uri-jobId"></a>
The ID of the job.  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`   
Required: Yes

## Request Body
<a name="API_DescribeBulkImportJob_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeBulkImportJob_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "adaptiveIngestion": boolean,
   "deleteFilesAfterImport": boolean,
   "errorReportLocation": { 
      "bucket": "string",
      "prefix": "string"
   },
   "files": [ 
      { 
         "bucket": "string",
         "key": "string",
         "versionId": "string"
      }
   ],
   "jobConfiguration": { 
      "fileFormat": { 
         "csv": { 
            "columnNames": [ "string" ]
         },
         "parquet": { 
         }
      }
   },
   "jobCreationDate": number,
   "jobId": "string",
   "jobLastUpdateDate": number,
   "jobName": "string",
   "jobRoleArn": "string",
   "jobStatus": "string"
}
```

## Response Elements
<a name="API_DescribeBulkImportJob_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [adaptiveIngestion](#API_DescribeBulkImportJob_ResponseSyntax) **   <a name="iotsitewise-DescribeBulkImportJob-response-adaptiveIngestion"></a>
If set to true, ingest new data into AWS IoT SiteWise storage. Measurements with notifications, metrics and transforms are computed. If set to false, historical data is ingested into AWS IoT SiteWise as is.  
Type: Boolean

 ** [deleteFilesAfterImport](#API_DescribeBulkImportJob_ResponseSyntax) **   <a name="iotsitewise-DescribeBulkImportJob-response-deleteFilesAfterImport"></a>
If set to true, your data files is deleted from S3, after ingestion into AWS IoT SiteWise storage.  
Type: Boolean

 ** [errorReportLocation](#API_DescribeBulkImportJob_ResponseSyntax) **   <a name="iotsitewise-DescribeBulkImportJob-response-errorReportLocation"></a>
The Amazon S3 destination where errors associated with the job creation request are saved.  
Type: [ErrorReportLocation](API_ErrorReportLocation.md) object

 ** [files](#API_DescribeBulkImportJob_ResponseSyntax) **   <a name="iotsitewise-DescribeBulkImportJob-response-files"></a>
The files in the specified Amazon S3 bucket that contain your data.  
Type: Array of [File](API_File.md) objects

 ** [jobConfiguration](#API_DescribeBulkImportJob_ResponseSyntax) **   <a name="iotsitewise-DescribeBulkImportJob-response-jobConfiguration"></a>
Contains the configuration information of a job, such as the file format used to save data in Amazon S3.  
Type: [JobConfiguration](API_JobConfiguration.md) object

 ** [jobCreationDate](#API_DescribeBulkImportJob_ResponseSyntax) **   <a name="iotsitewise-DescribeBulkImportJob-response-jobCreationDate"></a>
The date the job was created, in Unix epoch TIME.  
Type: Timestamp

 ** [jobId](#API_DescribeBulkImportJob_ResponseSyntax) **   <a name="iotsitewise-DescribeBulkImportJob-response-jobId"></a>
The ID of the job.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

 ** [jobLastUpdateDate](#API_DescribeBulkImportJob_ResponseSyntax) **   <a name="iotsitewise-DescribeBulkImportJob-response-jobLastUpdateDate"></a>
The date the job was last updated, in Unix epoch time.  
Type: Timestamp

 ** [jobName](#API_DescribeBulkImportJob_ResponseSyntax) **   <a name="iotsitewise-DescribeBulkImportJob-response-jobName"></a>
The unique name that helps identify the job request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[^\u0000-\u001F\u007F]+` 

 ** [jobRoleArn](#API_DescribeBulkImportJob_ResponseSyntax) **   <a name="iotsitewise-DescribeBulkImportJob-response-jobRoleArn"></a>
The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the IAM role that allows AWS IoT SiteWise to read Amazon S3 data.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$` 

 ** [jobStatus](#API_DescribeBulkImportJob_ResponseSyntax) **   <a name="iotsitewise-DescribeBulkImportJob-response-jobStatus"></a>
The status of the bulk import job can be one of following values:  
+  `PENDING` – AWS IoT SiteWise is waiting for the current bulk import job to finish.
+  `CANCELLED` – The bulk import job has been canceled.
+  `RUNNING` – AWS IoT SiteWise is processing your request to import your data from Amazon S3.
+  `COMPLETED` – AWS IoT SiteWise successfully completed your request to import data from Amazon S3.
+  `FAILED` – AWS 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` – AWS 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.
Type: String  
Valid Values: `PENDING | CANCELLED | RUNNING | COMPLETED | FAILED | COMPLETED_WITH_FAILURES` 

## Errors
<a name="API_DescribeBulkImportJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_DescribeBulkImportJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/DescribeBulkImportJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/DescribeBulkImportJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/DescribeBulkImportJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/DescribeBulkImportJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DescribeBulkImportJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/DescribeBulkImportJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/DescribeBulkImportJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/DescribeBulkImportJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/DescribeBulkImportJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/DescribeBulkImportJob) 

# DescribeComputationModel
<a name="API_DescribeComputationModel"></a>

Retrieves information about a computation model.

## Request Syntax
<a name="API_DescribeComputationModel_RequestSyntax"></a>

```
GET /computation-models/computationModelId?computationModelVersion=computationModelVersion HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeComputationModel_RequestParameters"></a>

The request uses the following URI parameters.

 ** [computationModelId](#API_DescribeComputationModel_RequestSyntax) **   <a name="iotsitewise-DescribeComputationModel-request-uri-computationModelId"></a>
The ID of the computation model.  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`   
Required: Yes

 ** [computationModelVersion](#API_DescribeComputationModel_RequestSyntax) **   <a name="iotsitewise-DescribeComputationModel-request-uri-computationModelVersion"></a>
The version of the computation model.  
Pattern: `^(LATEST|ACTIVE|[1-9]{1}\d{0,9})$` 

## Request Body
<a name="API_DescribeComputationModel_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeComputationModel_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "actionDefinitions": [ 
      { 
         "actionDefinitionId": "string",
         "actionName": "string",
         "actionType": "string"
      }
   ],
   "computationModelArn": "string",
   "computationModelConfiguration": { 
      "anomalyDetection": { 
         "inputProperties": "string",
         "resultProperty": "string"
      }
   },
   "computationModelCreationDate": number,
   "computationModelDataBinding": { 
      "string" : { 
         "assetModelProperty": { 
            "assetModelId": "string",
            "propertyId": "string"
         },
         "assetProperty": { 
            "assetId": "string",
            "propertyId": "string"
         },
         "list": [ 
            "ComputationModelDataBindingValue"
         ]
      }
   },
   "computationModelDescription": "string",
   "computationModelId": "string",
   "computationModelLastUpdateDate": number,
   "computationModelName": "string",
   "computationModelStatus": { 
      "error": { 
         "code": "string",
         "details": [ 
            { 
               "code": "string",
               "message": "string"
            }
         ],
         "message": "string"
      },
      "state": "string"
   },
   "computationModelVersion": "string"
}
```

## Response Elements
<a name="API_DescribeComputationModel_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [actionDefinitions](#API_DescribeComputationModel_ResponseSyntax) **   <a name="iotsitewise-DescribeComputationModel-response-actionDefinitions"></a>
The available actions for this computation model.  
Type: Array of [ActionDefinition](API_ActionDefinition.md) objects

 ** [computationModelArn](#API_DescribeComputationModel_ResponseSyntax) **   <a name="iotsitewise-DescribeComputationModel-response-computationModelArn"></a>
The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the computation model, which has the following format.  
 `arn:${Partition}:iotsitewise:${Region}:${Account}:computation-model/${ComputationModelId}`   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$` 

 ** [computationModelConfiguration](#API_DescribeComputationModel_ResponseSyntax) **   <a name="iotsitewise-DescribeComputationModel-response-computationModelConfiguration"></a>
The configuration for the computation model.  
Type: [ComputationModelConfiguration](API_ComputationModelConfiguration.md) object

 ** [computationModelCreationDate](#API_DescribeComputationModel_ResponseSyntax) **   <a name="iotsitewise-DescribeComputationModel-response-computationModelCreationDate"></a>
The model creation date, in Unix epoch time.  
Type: Timestamp

 ** [computationModelDataBinding](#API_DescribeComputationModel_ResponseSyntax) **   <a name="iotsitewise-DescribeComputationModel-response-computationModelDataBinding"></a>
The data binding for the computation model. Key is a variable name defined in configuration. Value is a `ComputationModelDataBindingValue` referenced by the variable.  
Type: String to [ComputationModelDataBindingValue](API_ComputationModelDataBindingValue.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 64.  
Key Pattern: `^[a-z][a-z0-9_]*$` 

 ** [computationModelDescription](#API_DescribeComputationModel_ResponseSyntax) **   <a name="iotsitewise-DescribeComputationModel-response-computationModelDescription"></a>
The description of the computation model.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^[a-zA-Z0-9 _\-#$*!@]+$` 

 ** [computationModelId](#API_DescribeComputationModel_ResponseSyntax) **   <a name="iotsitewise-DescribeComputationModel-response-computationModelId"></a>
The ID of the computation model.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

 ** [computationModelLastUpdateDate](#API_DescribeComputationModel_ResponseSyntax) **   <a name="iotsitewise-DescribeComputationModel-response-computationModelLastUpdateDate"></a>
The date the model was last updated, in Unix epoch time.  
Type: Timestamp

 ** [computationModelName](#API_DescribeComputationModel_ResponseSyntax) **   <a name="iotsitewise-DescribeComputationModel-response-computationModelName"></a>
The name of the computation model.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^[a-zA-Z0-9 _\-#$*!@]+$` 

 ** [computationModelStatus](#API_DescribeComputationModel_ResponseSyntax) **   <a name="iotsitewise-DescribeComputationModel-response-computationModelStatus"></a>
The current status of the asset model, which contains a state and an error message if any.  
Type: [ComputationModelStatus](API_ComputationModelStatus.md) object

 ** [computationModelVersion](#API_DescribeComputationModel_ResponseSyntax) **   <a name="iotsitewise-DescribeComputationModel-response-computationModelVersion"></a>
The version of the computation model.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 10.  
Pattern: `^(0|([1-9]{1}\d*))$` 

## Errors
<a name="API_DescribeComputationModel_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_DescribeComputationModel_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/DescribeComputationModel) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/DescribeComputationModel) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/DescribeComputationModel) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/DescribeComputationModel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DescribeComputationModel) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/DescribeComputationModel) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/DescribeComputationModel) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/DescribeComputationModel) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/DescribeComputationModel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/DescribeComputationModel) 

# DescribeComputationModelExecutionSummary
<a name="API_DescribeComputationModelExecutionSummary"></a>

Retrieves information about the execution summary of a computation model.

## Request Syntax
<a name="API_DescribeComputationModelExecutionSummary_RequestSyntax"></a>

```
GET /computation-models/computationModelId/execution-summary?resolveToResourceId=resolveToResourceId&resolveToResourceType=resolveToResourceType HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeComputationModelExecutionSummary_RequestParameters"></a>

The request uses the following URI parameters.

 ** [computationModelId](#API_DescribeComputationModelExecutionSummary_RequestSyntax) **   <a name="iotsitewise-DescribeComputationModelExecutionSummary-request-uri-computationModelId"></a>
The ID of the computation model.  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`   
Required: Yes

 ** [resolveToResourceId](#API_DescribeComputationModelExecutionSummary_RequestSyntax) **   <a name="iotsitewise-DescribeComputationModelExecutionSummary-request-uri-resolveToResourceId"></a>
The ID of the resolved resource.  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

 ** [resolveToResourceType](#API_DescribeComputationModelExecutionSummary_RequestSyntax) **   <a name="iotsitewise-DescribeComputationModelExecutionSummary-request-uri-resolveToResourceType"></a>
The type of the resolved resource.  
Valid Values: `ASSET` 

## Request Body
<a name="API_DescribeComputationModelExecutionSummary_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeComputationModelExecutionSummary_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "computationModelExecutionSummary": { 
      "string" : "string" 
   },
   "computationModelId": "string",
   "resolveTo": { 
      "assetId": "string"
   }
}
```

## Response Elements
<a name="API_DescribeComputationModelExecutionSummary_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [computationModelExecutionSummary](#API_DescribeComputationModelExecutionSummary_ResponseSyntax) **   <a name="iotsitewise-DescribeComputationModelExecutionSummary-response-computationModelExecutionSummary"></a>
Contains the execution summary of the computation model.  
Type: String to string map  
Key Pattern: `^[a-zA-Z0-9 _\-#$*!@]+$`   
Value Pattern: `^[a-zA-Z0-9 _\-#$*!@]+$` 

 ** [computationModelId](#API_DescribeComputationModelExecutionSummary_ResponseSyntax) **   <a name="iotsitewise-DescribeComputationModelExecutionSummary-response-computationModelId"></a>
The ID of the computation model.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

 ** [resolveTo](#API_DescribeComputationModelExecutionSummary_ResponseSyntax) **   <a name="iotsitewise-DescribeComputationModelExecutionSummary-response-resolveTo"></a>
The detailed resource this execution summary resolves to.  
Type: [ResolveTo](API_ResolveTo.md) object

## Errors
<a name="API_DescribeComputationModelExecutionSummary_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_DescribeComputationModelExecutionSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/DescribeComputationModelExecutionSummary) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/DescribeComputationModelExecutionSummary) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/DescribeComputationModelExecutionSummary) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/DescribeComputationModelExecutionSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DescribeComputationModelExecutionSummary) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/DescribeComputationModelExecutionSummary) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/DescribeComputationModelExecutionSummary) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/DescribeComputationModelExecutionSummary) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/DescribeComputationModelExecutionSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/DescribeComputationModelExecutionSummary) 

# DescribeDashboard
<a name="API_DescribeDashboard"></a>

Retrieves information about a dashboard.

## Request Syntax
<a name="API_DescribeDashboard_RequestSyntax"></a>

```
GET /dashboards/dashboardId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeDashboard_RequestParameters"></a>

The request uses the following URI parameters.

 ** [dashboardId](#API_DescribeDashboard_RequestSyntax) **   <a name="iotsitewise-DescribeDashboard-request-uri-dashboardId"></a>
The ID of the dashboard.  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`   
Required: Yes

## Request Body
<a name="API_DescribeDashboard_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeDashboard_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "dashboardArn": "string",
   "dashboardCreationDate": number,
   "dashboardDefinition": "string",
   "dashboardDescription": "string",
   "dashboardId": "string",
   "dashboardLastUpdateDate": number,
   "dashboardName": "string",
   "projectId": "string"
}
```

## Response Elements
<a name="API_DescribeDashboard_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [dashboardArn](#API_DescribeDashboard_ResponseSyntax) **   <a name="iotsitewise-DescribeDashboard-response-dashboardArn"></a>
The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the dashboard, which has the following format.  
 `arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}`   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$` 

 ** [dashboardCreationDate](#API_DescribeDashboard_ResponseSyntax) **   <a name="iotsitewise-DescribeDashboard-response-dashboardCreationDate"></a>
The date the dashboard was created, in Unix epoch time.  
Type: Timestamp

 ** [dashboardDefinition](#API_DescribeDashboard_ResponseSyntax) **   <a name="iotsitewise-DescribeDashboard-response-dashboardDefinition"></a>
The dashboard's definition JSON literal. For detailed information, see [Creating dashboards (CLI)](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html) in the * AWS IoT SiteWise User Guide*.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 204800.  
Pattern: `.+` 

 ** [dashboardDescription](#API_DescribeDashboard_ResponseSyntax) **   <a name="iotsitewise-DescribeDashboard-response-dashboardDescription"></a>
The dashboard's description.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[^\u0000-\u001F\u007F]+` 

 ** [dashboardId](#API_DescribeDashboard_ResponseSyntax) **   <a name="iotsitewise-DescribeDashboard-response-dashboardId"></a>
The ID of the dashboard.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

 ** [dashboardLastUpdateDate](#API_DescribeDashboard_ResponseSyntax) **   <a name="iotsitewise-DescribeDashboard-response-dashboardLastUpdateDate"></a>
The date the dashboard was last updated, in Unix epoch time.  
Type: Timestamp

 ** [dashboardName](#API_DescribeDashboard_ResponseSyntax) **   <a name="iotsitewise-DescribeDashboard-response-dashboardName"></a>
The name of the dashboard.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[^\u0000-\u001F\u007F]+` 

 ** [projectId](#API_DescribeDashboard_ResponseSyntax) **   <a name="iotsitewise-DescribeDashboard-response-projectId"></a>
The ID of the project that the dashboard is in.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

## Errors
<a name="API_DescribeDashboard_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_DescribeDashboard_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/DescribeDashboard) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/DescribeDashboard) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/DescribeDashboard) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/DescribeDashboard) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DescribeDashboard) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/DescribeDashboard) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/DescribeDashboard) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/DescribeDashboard) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/DescribeDashboard) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/DescribeDashboard) 

# DescribeDataset
<a name="API_DescribeDataset"></a>

Retrieves information about a dataset.

## Request Syntax
<a name="API_DescribeDataset_RequestSyntax"></a>

```
GET /datasets/datasetId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeDataset_RequestParameters"></a>

The request uses the following URI parameters.

 ** [datasetId](#API_DescribeDataset_RequestSyntax) **   <a name="iotsitewise-DescribeDataset-request-uri-datasetId"></a>
The ID of the dataset.  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`   
Required: Yes

## Request Body
<a name="API_DescribeDataset_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeDataset_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "datasetArn": "string",
   "datasetCreationDate": number,
   "datasetDescription": "string",
   "datasetId": "string",
   "datasetLastUpdateDate": number,
   "datasetName": "string",
   "datasetSource": { 
      "sourceDetail": { 
         "kendra": { 
            "knowledgeBaseArn": "string",
            "roleArn": "string"
         }
      },
      "sourceFormat": "string",
      "sourceType": "string"
   },
   "datasetStatus": { 
      "error": { 
         "code": "string",
         "details": [ 
            { 
               "code": "string",
               "message": "string"
            }
         ],
         "message": "string"
      },
      "state": "string"
   },
   "datasetVersion": "string"
}
```

## Response Elements
<a name="API_DescribeDataset_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [datasetArn](#API_DescribeDataset_ResponseSyntax) **   <a name="iotsitewise-DescribeDataset-response-datasetArn"></a>
The [ARN](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html) of the dataset. The format is `arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId}`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$` 

 ** [datasetCreationDate](#API_DescribeDataset_ResponseSyntax) **   <a name="iotsitewise-DescribeDataset-response-datasetCreationDate"></a>
The dataset creation date, in Unix epoch time.  
Type: Timestamp

 ** [datasetDescription](#API_DescribeDataset_ResponseSyntax) **   <a name="iotsitewise-DescribeDataset-response-datasetDescription"></a>
A description about the dataset, and its functionality.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^[a-zA-Z0-9 _\-#$*!@]+$` 

 ** [datasetId](#API_DescribeDataset_ResponseSyntax) **   <a name="iotsitewise-DescribeDataset-response-datasetId"></a>
The ID of the dataset.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

 ** [datasetLastUpdateDate](#API_DescribeDataset_ResponseSyntax) **   <a name="iotsitewise-DescribeDataset-response-datasetLastUpdateDate"></a>
The date the dataset was last updated, in Unix epoch time.  
Type: Timestamp

 ** [datasetName](#API_DescribeDataset_ResponseSyntax) **   <a name="iotsitewise-DescribeDataset-response-datasetName"></a>
The name of the dataset.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^[a-zA-Z0-9 _\-#$*!@]+$` 

 ** [datasetSource](#API_DescribeDataset_ResponseSyntax) **   <a name="iotsitewise-DescribeDataset-response-datasetSource"></a>
The data source for the dataset.  
Type: [DatasetSource](API_DatasetSource.md) object

 ** [datasetStatus](#API_DescribeDataset_ResponseSyntax) **   <a name="iotsitewise-DescribeDataset-response-datasetStatus"></a>
The status of the dataset. This contains the state and any error messages. State is `CREATING` after a successfull call to this API, and any associated error message. The state is `ACTIVE` when ready to use.  
Type: [DatasetStatus](API_DatasetStatus.md) object

 ** [datasetVersion](#API_DescribeDataset_ResponseSyntax) **   <a name="iotsitewise-DescribeDataset-response-datasetVersion"></a>
The version of the dataset.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 10.  
Pattern: `^(0|([1-9]{1}\d*))$` 

## Errors
<a name="API_DescribeDataset_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_DescribeDataset_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/DescribeDataset) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/DescribeDataset) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/DescribeDataset) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/DescribeDataset) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DescribeDataset) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/DescribeDataset) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/DescribeDataset) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/DescribeDataset) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/DescribeDataset) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/DescribeDataset) 

# DescribeDefaultEncryptionConfiguration
<a name="API_DescribeDefaultEncryptionConfiguration"></a>

Retrieves information about the default encryption configuration for the AWS account in the default or specified Region. For more information, see [Key management](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/key-management.html) in the * AWS IoT SiteWise User Guide*.

## Request Syntax
<a name="API_DescribeDefaultEncryptionConfiguration_RequestSyntax"></a>

```
GET /configuration/account/encryption HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeDefaultEncryptionConfiguration_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_DescribeDefaultEncryptionConfiguration_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeDefaultEncryptionConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "configurationStatus": { 
      "error": { 
         "code": "string",
         "message": "string"
      },
      "state": "string"
   },
   "encryptionType": "string",
   "kmsKeyArn": "string"
}
```

## Response Elements
<a name="API_DescribeDefaultEncryptionConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [configurationStatus](#API_DescribeDefaultEncryptionConfiguration_ResponseSyntax) **   <a name="iotsitewise-DescribeDefaultEncryptionConfiguration-response-configurationStatus"></a>
The status of the account configuration. This contains the `ConfigurationState`. If there's an error, it also contains the `ErrorDetails`.  
Type: [ConfigurationStatus](API_ConfigurationStatus.md) object

 ** [encryptionType](#API_DescribeDefaultEncryptionConfiguration_ResponseSyntax) **   <a name="iotsitewise-DescribeDefaultEncryptionConfiguration-response-encryptionType"></a>
The type of encryption used for the encryption configuration.  
Type: String  
Valid Values: `SITEWISE_DEFAULT_ENCRYPTION | KMS_BASED_ENCRYPTION` 

 ** [kmsKeyArn](#API_DescribeDefaultEncryptionConfiguration_ResponseSyntax) **   <a name="iotsitewise-DescribeDefaultEncryptionConfiguration-response-kmsKeyArn"></a>
The key ARN of the customer managed key used for AWS KMS encryption if you use `KMS_BASED_ENCRYPTION`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$` 

## Errors
<a name="API_DescribeDefaultEncryptionConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_DescribeDefaultEncryptionConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/DescribeDefaultEncryptionConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/DescribeDefaultEncryptionConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/DescribeDefaultEncryptionConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/DescribeDefaultEncryptionConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DescribeDefaultEncryptionConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/DescribeDefaultEncryptionConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/DescribeDefaultEncryptionConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/DescribeDefaultEncryptionConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/DescribeDefaultEncryptionConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/DescribeDefaultEncryptionConfiguration) 

# DescribeExecution
<a name="API_DescribeExecution"></a>

Retrieves information about the execution.

## Request Syntax
<a name="API_DescribeExecution_RequestSyntax"></a>

```
GET /executions/executionId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeExecution_RequestParameters"></a>

The request uses the following URI parameters.

 ** [executionId](#API_DescribeExecution_RequestSyntax) **   <a name="iotsitewise-DescribeExecution-request-uri-executionId"></a>
The ID of the execution.  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`   
Required: Yes

## Request Body
<a name="API_DescribeExecution_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeExecution_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "actionType": "string",
   "executionDetails": { 
      "string" : "string" 
   },
   "executionEndTime": number,
   "executionEntityVersion": "string",
   "executionId": "string",
   "executionResult": { 
      "string" : "string" 
   },
   "executionStartTime": number,
   "executionStatus": { 
      "state": "string"
   },
   "resolveTo": { 
      "assetId": "string"
   },
   "targetResource": { 
      "assetId": "string",
      "computationModelId": "string"
   },
   "targetResourceVersion": "string"
}
```

## Response Elements
<a name="API_DescribeExecution_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [actionType](#API_DescribeExecution_ResponseSyntax) **   <a name="iotsitewise-DescribeExecution-response-actionType"></a>
The type of action exectued.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[^\u0000-\u001F\u007F]+` 

 ** [executionDetails](#API_DescribeExecution_ResponseSyntax) **   <a name="iotsitewise-DescribeExecution-response-executionDetails"></a>
Provides detailed information about the execution of your anomaly detection models. This includes model metrics and training timestamps for both training and inference actions.  
+  The training action (AWS/ANOMALY\$1DETECTION\$1TRAINING), includes performance metrics that help you compare different versions of your anomaly detection models. These metrics provide insights into the model's performance during the training process. 
+  The inference action (AWS/ANOMALY\$1DETECTION\$1INFERENCE), includes information about the results of executing your anomaly detection models. This helps you understand the output of your models and assess their performance. 
Type: String to string map  
Key Pattern: `^[a-zA-Z0-9 _\-#$*!@]+$`   
Value Pattern: `^[a-zA-Z0-9 _\-#$*!@]+$` 

 ** [executionEndTime](#API_DescribeExecution_ResponseSyntax) **   <a name="iotsitewise-DescribeExecution-response-executionEndTime"></a>
The time the process ended.  
Type: Timestamp

 ** [executionEntityVersion](#API_DescribeExecution_ResponseSyntax) **   <a name="iotsitewise-DescribeExecution-response-executionEntityVersion"></a>
Entity version used for the execution.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 10.  
Pattern: `^(0|([1-9]{1}\d*))$` 

 ** [executionId](#API_DescribeExecution_ResponseSyntax) **   <a name="iotsitewise-DescribeExecution-response-executionId"></a>
The ID of the execution.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

 ** [executionResult](#API_DescribeExecution_ResponseSyntax) **   <a name="iotsitewise-DescribeExecution-response-executionResult"></a>
The result of the execution.  
Type: String to string map  
Key Pattern: `^[a-zA-Z0-9 _\-#$*!@]+$`   
Value Pattern: `^[a-zA-Z0-9 _\-#$*!@]+$` 

 ** [executionStartTime](#API_DescribeExecution_ResponseSyntax) **   <a name="iotsitewise-DescribeExecution-response-executionStartTime"></a>
The time the process started.  
Type: Timestamp

 ** [executionStatus](#API_DescribeExecution_ResponseSyntax) **   <a name="iotsitewise-DescribeExecution-response-executionStatus"></a>
The status of the execution process.  
Type: [ExecutionStatus](API_ExecutionStatus.md) object

 ** [resolveTo](#API_DescribeExecution_ResponseSyntax) **   <a name="iotsitewise-DescribeExecution-response-resolveTo"></a>
The detailed resource this execution resolves to.  
Type: [ResolveTo](API_ResolveTo.md) object

 ** [targetResource](#API_DescribeExecution_ResponseSyntax) **   <a name="iotsitewise-DescribeExecution-response-targetResource"></a>
The resource the action will be taken on. This can include asset-based resources and computation model resources.  
Type: [TargetResource](API_TargetResource.md) object

 ** [targetResourceVersion](#API_DescribeExecution_ResponseSyntax) **   <a name="iotsitewise-DescribeExecution-response-targetResourceVersion"></a>
The version of the target resource.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 10.  
Pattern: `^(0|([1-9]{1}\d*))$` 

## Errors
<a name="API_DescribeExecution_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_DescribeExecution_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/DescribeExecution) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/DescribeExecution) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/DescribeExecution) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/DescribeExecution) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DescribeExecution) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/DescribeExecution) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/DescribeExecution) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/DescribeExecution) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/DescribeExecution) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/DescribeExecution) 

# DescribeGateway
<a name="API_DescribeGateway"></a>

Retrieves information about a gateway.

## Request Syntax
<a name="API_DescribeGateway_RequestSyntax"></a>

```
GET /20200301/gateways/gatewayId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeGateway_RequestParameters"></a>

The request uses the following URI parameters.

 ** [gatewayId](#API_DescribeGateway_RequestSyntax) **   <a name="iotsitewise-DescribeGateway-request-uri-gatewayId"></a>
The ID of the gateway device.  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`   
Required: Yes

## Request Body
<a name="API_DescribeGateway_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeGateway_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "creationDate": number,
   "gatewayArn": "string",
   "gatewayCapabilitySummaries": [ 
      { 
         "capabilityNamespace": "string",
         "capabilitySyncStatus": "string"
      }
   ],
   "gatewayId": "string",
   "gatewayName": "string",
   "gatewayPlatform": { 
      "greengrass": { 
         "groupArn": "string"
      },
      "greengrassV2": { 
         "coreDeviceOperatingSystem": "string",
         "coreDeviceThingName": "string"
      },
      "siemensIE": { 
         "iotCoreThingName": "string"
      }
   },
   "gatewayVersion": "string",
   "lastUpdateDate": number
}
```

## Response Elements
<a name="API_DescribeGateway_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [creationDate](#API_DescribeGateway_ResponseSyntax) **   <a name="iotsitewise-DescribeGateway-response-creationDate"></a>
The date the gateway was created, in Unix epoch time.  
Type: Timestamp

 ** [gatewayArn](#API_DescribeGateway_ResponseSyntax) **   <a name="iotsitewise-DescribeGateway-response-gatewayArn"></a>
The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the gateway, which has the following format.  
 `arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}`   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$` 

 ** [gatewayCapabilitySummaries](#API_DescribeGateway_ResponseSyntax) **   <a name="iotsitewise-DescribeGateway-response-gatewayCapabilitySummaries"></a>
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](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGatewayCapabilityConfiguration.html).  
Type: Array of [GatewayCapabilitySummary](API_GatewayCapabilitySummary.md) objects

 ** [gatewayId](#API_DescribeGateway_ResponseSyntax) **   <a name="iotsitewise-DescribeGateway-response-gatewayId"></a>
The ID of the gateway device.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

 ** [gatewayName](#API_DescribeGateway_ResponseSyntax) **   <a name="iotsitewise-DescribeGateway-response-gatewayName"></a>
The name of the gateway.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[^\u0000-\u001F\u007F]+` 

 ** [gatewayPlatform](#API_DescribeGateway_ResponseSyntax) **   <a name="iotsitewise-DescribeGateway-response-gatewayPlatform"></a>
The gateway's platform.  
Type: [GatewayPlatform](API_GatewayPlatform.md) object

 ** [gatewayVersion](#API_DescribeGateway_ResponseSyntax) **   <a name="iotsitewise-DescribeGateway-response-gatewayVersion"></a>
The version of the gateway. A value of `3` indicates an MQTT-enabled, V3 gateway, while `2` indicates a Classic streams, V2 gateway.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^[0-9]+$` 

 ** [lastUpdateDate](#API_DescribeGateway_ResponseSyntax) **   <a name="iotsitewise-DescribeGateway-response-lastUpdateDate"></a>
The date the gateway was last updated, in Unix epoch time.  
Type: Timestamp

## Errors
<a name="API_DescribeGateway_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_DescribeGateway_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/DescribeGateway) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/DescribeGateway) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/DescribeGateway) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/DescribeGateway) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DescribeGateway) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/DescribeGateway) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/DescribeGateway) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/DescribeGateway) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/DescribeGateway) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/DescribeGateway) 

# DescribeGatewayCapabilityConfiguration
<a name="API_DescribeGatewayCapabilityConfiguration"></a>

Each gateway capability defines data sources for a gateway. This is the namespace of the gateway capability.

. The namespace follows the format `service:capability:version`, where:
+  `service` - The service providing the capability, or `iotsitewise`.
+  `capability` - The specific capability type. Options include: `opcuacollector` for the OPC UA data source collector, or `publisher` for data publisher capability.
+  `version` - The version number of the capability. Option include `2` for Classic streams, V2 gateways, and `3` for MQTT-enabled, V3 gateways.

After updating a capability configuration, the sync status becomes `OUT_OF_SYNC` until the gateway processes the configuration.Use `DescribeGatewayCapabilityConfiguration` to check the sync status and verify the configuration was applied.

A gateway can have multiple capability configurations with different namespaces.

## Request Syntax
<a name="API_DescribeGatewayCapabilityConfiguration_RequestSyntax"></a>

```
GET /20200301/gateways/gatewayId/capability/capabilityNamespace HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeGatewayCapabilityConfiguration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [capabilityNamespace](#API_DescribeGatewayCapabilityConfiguration_RequestSyntax) **   <a name="iotsitewise-DescribeGatewayCapabilityConfiguration-request-uri-capabilityNamespace"></a>
The namespace of the capability configuration. For example, if you configure OPC UA sources for an MQTT-enabled gateway, your OPC-UA capability configuration has the namespace `iotsitewise:opcuacollector:3`.  
Length Constraints: Minimum length of 1. Maximum length of 512.  
Pattern: `^[a-zA-Z]+:[a-zA-Z]+:[0-9]+$`   
Required: Yes

 ** [gatewayId](#API_DescribeGatewayCapabilityConfiguration_RequestSyntax) **   <a name="iotsitewise-DescribeGatewayCapabilityConfiguration-request-uri-gatewayId"></a>
The ID of the gateway that defines the capability configuration.  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`   
Required: Yes

## Request Body
<a name="API_DescribeGatewayCapabilityConfiguration_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeGatewayCapabilityConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "capabilityConfiguration": "string",
   "capabilityNamespace": "string",
   "capabilitySyncStatus": "string",
   "gatewayId": "string"
}
```

## Response Elements
<a name="API_DescribeGatewayCapabilityConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [capabilityConfiguration](#API_DescribeGatewayCapabilityConfiguration_ResponseSyntax) **   <a name="iotsitewise-DescribeGatewayCapabilityConfiguration-response-capabilityConfiguration"></a>
The JSON document that defines the gateway capability's configuration. For more information, see [Configuring data sources (CLI)](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-sources.html#configure-source-cli) in the * AWS IoT SiteWise User Guide*.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 10000000.

 ** [capabilityNamespace](#API_DescribeGatewayCapabilityConfiguration_ResponseSyntax) **   <a name="iotsitewise-DescribeGatewayCapabilityConfiguration-response-capabilityNamespace"></a>
The namespace of the gateway capability.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 512.  
Pattern: `^[a-zA-Z]+:[a-zA-Z]+:[0-9]+$` 

 ** [capabilitySyncStatus](#API_DescribeGatewayCapabilityConfiguration_ResponseSyntax) **   <a name="iotsitewise-DescribeGatewayCapabilityConfiguration-response-capabilitySyncStatus"></a>
The synchronization status of the gateway capability configuration. The sync status can be one of the following:  
+  `IN_SYNC` - The gateway is running with the latest configuration.
+  `OUT_OF_SYNC` - The gateway hasn't received the latest configuration.
+  `SYNC_FAILED` - The gateway rejected the latest configuration.
+  `UNKNOWN` - The gateway hasn't reported its sync status.
+  `NOT_APPLICABLE` - The gateway doesn't support this capability. This is most common when integrating partner data sources, because the data integration is handled externally by the partner.
Type: String  
Valid Values: `IN_SYNC | OUT_OF_SYNC | SYNC_FAILED | UNKNOWN | NOT_APPLICABLE` 

 ** [gatewayId](#API_DescribeGatewayCapabilityConfiguration_ResponseSyntax) **   <a name="iotsitewise-DescribeGatewayCapabilityConfiguration-response-gatewayId"></a>
The ID of the gateway that defines the capability configuration.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

## Errors
<a name="API_DescribeGatewayCapabilityConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_DescribeGatewayCapabilityConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/DescribeGatewayCapabilityConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/DescribeGatewayCapabilityConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/DescribeGatewayCapabilityConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/DescribeGatewayCapabilityConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DescribeGatewayCapabilityConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/DescribeGatewayCapabilityConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/DescribeGatewayCapabilityConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/DescribeGatewayCapabilityConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/DescribeGatewayCapabilityConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/DescribeGatewayCapabilityConfiguration) 

# DescribeLoggingOptions
<a name="API_DescribeLoggingOptions"></a>

Retrieves the current AWS IoT SiteWise logging options.

## Request Syntax
<a name="API_DescribeLoggingOptions_RequestSyntax"></a>

```
GET /logging HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeLoggingOptions_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_DescribeLoggingOptions_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeLoggingOptions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "loggingOptions": { 
      "level": "string"
   }
}
```

## Response Elements
<a name="API_DescribeLoggingOptions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [loggingOptions](#API_DescribeLoggingOptions_ResponseSyntax) **   <a name="iotsitewise-DescribeLoggingOptions-response-loggingOptions"></a>
The current logging options.  
Type: [LoggingOptions](API_LoggingOptions.md) object

## Errors
<a name="API_DescribeLoggingOptions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_DescribeLoggingOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/DescribeLoggingOptions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/DescribeLoggingOptions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/DescribeLoggingOptions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/DescribeLoggingOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DescribeLoggingOptions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/DescribeLoggingOptions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/DescribeLoggingOptions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/DescribeLoggingOptions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/DescribeLoggingOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/DescribeLoggingOptions) 

# DescribePortal
<a name="API_DescribePortal"></a>

Retrieves information about a portal.

## Request Syntax
<a name="API_DescribePortal_RequestSyntax"></a>

```
GET /portals/portalId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribePortal_RequestParameters"></a>

The request uses the following URI parameters.

 ** [portalId](#API_DescribePortal_RequestSyntax) **   <a name="iotsitewise-DescribePortal-request-uri-portalId"></a>
The ID of the portal.  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`   
Required: Yes

## Request Body
<a name="API_DescribePortal_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribePortal_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "alarms": { 
      "alarmRoleArn": "string",
      "notificationLambdaArn": "string"
   },
   "notificationSenderEmail": "string",
   "portalArn": "string",
   "portalAuthMode": "string",
   "portalClientId": "string",
   "portalContactEmail": "string",
   "portalCreationDate": number,
   "portalDescription": "string",
   "portalId": "string",
   "portalLastUpdateDate": number,
   "portalLogoImageLocation": { 
      "id": "string",
      "url": "string"
   },
   "portalName": "string",
   "portalStartUrl": "string",
   "portalStatus": { 
      "error": { 
         "code": "string",
         "message": "string"
      },
      "state": "string"
   },
   "portalType": "string",
   "portalTypeConfiguration": { 
      "string" : { 
         "portalTools": [ "string" ]
      }
   },
   "roleArn": "string"
}
```

## Response Elements
<a name="API_DescribePortal_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [alarms](#API_DescribePortal_ResponseSyntax) **   <a name="iotsitewise-DescribePortal-response-alarms"></a>
Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal.  
Type: [Alarms](API_Alarms.md) object

 ** [notificationSenderEmail](#API_DescribePortal_ResponseSyntax) **   <a name="iotsitewise-DescribePortal-response-notificationSenderEmail"></a>
The email address that sends alarm notifications.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z0-9_\-\.\+]+@[a-zA-Z0-9_\-\.\+]+\.[a-zA-Z]{2,}$` 

 ** [portalArn](#API_DescribePortal_ResponseSyntax) **   <a name="iotsitewise-DescribePortal-response-portalArn"></a>
The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the portal, which has the following format.  
 `arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}`   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$` 

 ** [portalAuthMode](#API_DescribePortal_ResponseSyntax) **   <a name="iotsitewise-DescribePortal-response-portalAuthMode"></a>
The service to use to authenticate users to the portal.  
Type: String  
Valid Values: `IAM | SSO` 

 ** [portalClientId](#API_DescribePortal_ResponseSyntax) **   <a name="iotsitewise-DescribePortal-response-portalClientId"></a>
The IAM Identity Center application generated client ID (used with IAM Identity Center API operations). AWS IoT SiteWise includes `portalClientId` for only portals that use IAM Identity Center to authenticate users.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^[!-~]*` 

 ** [portalContactEmail](#API_DescribePortal_ResponseSyntax) **   <a name="iotsitewise-DescribePortal-response-portalContactEmail"></a>
The AWS administrator's contact email address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z0-9_\-\.\+]+@[a-zA-Z0-9_\-\.\+]+\.[a-zA-Z]{2,}$` 

 ** [portalCreationDate](#API_DescribePortal_ResponseSyntax) **   <a name="iotsitewise-DescribePortal-response-portalCreationDate"></a>
The date the portal was created, in Unix epoch time.  
Type: Timestamp

 ** [portalDescription](#API_DescribePortal_ResponseSyntax) **   <a name="iotsitewise-DescribePortal-response-portalDescription"></a>
The portal's description.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[^\u0000-\u001F\u007F]+` 

 ** [portalId](#API_DescribePortal_ResponseSyntax) **   <a name="iotsitewise-DescribePortal-response-portalId"></a>
The ID of the portal.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

 ** [portalLastUpdateDate](#API_DescribePortal_ResponseSyntax) **   <a name="iotsitewise-DescribePortal-response-portalLastUpdateDate"></a>
The date the portal was last updated, in Unix epoch time.  
Type: Timestamp

 ** [portalLogoImageLocation](#API_DescribePortal_ResponseSyntax) **   <a name="iotsitewise-DescribePortal-response-portalLogoImageLocation"></a>
The portal's logo image, which is available at a URL.  
Type: [ImageLocation](API_ImageLocation.md) object

 ** [portalName](#API_DescribePortal_ResponseSyntax) **   <a name="iotsitewise-DescribePortal-response-portalName"></a>
The name of the portal.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[^\u0000-\u001F\u007F]+` 

 ** [portalStartUrl](#API_DescribePortal_ResponseSyntax) **   <a name="iotsitewise-DescribePortal-response-portalStartUrl"></a>
The URL for the AWS 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 AWS IoT SiteWise console to get a URL that you can use to access the portal.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^(http|https)\://\S+` 

 ** [portalStatus](#API_DescribePortal_ResponseSyntax) **   <a name="iotsitewise-DescribePortal-response-portalStatus"></a>
The current status of the portal, which contains a state and any error message.  
Type: [PortalStatus](API_PortalStatus.md) object

 ** [portalType](#API_DescribePortal_ResponseSyntax) **   <a name="iotsitewise-DescribePortal-response-portalType"></a>
Define the type of portal. The value for AWS IoT SiteWise Monitor (Classic) is `SITEWISE_PORTAL_V1`. The value for AWS IoT SiteWise Monitor (AI-aware) is `SITEWISE_PORTAL_V2`.  
Type: String  
Valid Values: `SITEWISE_PORTAL_V1 | SITEWISE_PORTAL_V2` 

 ** [portalTypeConfiguration](#API_DescribePortal_ResponseSyntax) **   <a name="iotsitewise-DescribePortal-response-portalTypeConfiguration"></a>
The configuration entry associated with the specific portal type. The value for AWS IoT SiteWise Monitor (Classic) is `SITEWISE_PORTAL_V1`. The value for AWS IoT SiteWise Monitor (AI-aware) is `SITEWISE_PORTAL_V2`.  
Type: String to [PortalTypeEntry](API_PortalTypeEntry.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.

 ** [roleArn](#API_DescribePortal_ResponseSyntax) **   <a name="iotsitewise-DescribePortal-response-roleArn"></a>
The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf. For more information, see [Using service roles for AWS IoT SiteWise Monitor](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html) in the * AWS IoT SiteWise User Guide*.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.\+=,@]+$` 

## Errors
<a name="API_DescribePortal_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_DescribePortal_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/DescribePortal) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/DescribePortal) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/DescribePortal) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/DescribePortal) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DescribePortal) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/DescribePortal) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/DescribePortal) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/DescribePortal) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/DescribePortal) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/DescribePortal) 

# DescribeProject
<a name="API_DescribeProject"></a>

Retrieves information about a project.

## Request Syntax
<a name="API_DescribeProject_RequestSyntax"></a>

```
GET /projects/projectId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeProject_RequestParameters"></a>

The request uses the following URI parameters.

 ** [projectId](#API_DescribeProject_RequestSyntax) **   <a name="iotsitewise-DescribeProject-request-uri-projectId"></a>
The ID of the project.  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`   
Required: Yes

## Request Body
<a name="API_DescribeProject_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeProject_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "portalId": "string",
   "projectArn": "string",
   "projectCreationDate": number,
   "projectDescription": "string",
   "projectId": "string",
   "projectLastUpdateDate": number,
   "projectName": "string"
}
```

## Response Elements
<a name="API_DescribeProject_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [portalId](#API_DescribeProject_ResponseSyntax) **   <a name="iotsitewise-DescribeProject-response-portalId"></a>
The ID of the portal that the project is in.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

 ** [projectArn](#API_DescribeProject_ResponseSyntax) **   <a name="iotsitewise-DescribeProject-response-projectArn"></a>
The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the project, which has the following format.  
 `arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId}`   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$` 

 ** [projectCreationDate](#API_DescribeProject_ResponseSyntax) **   <a name="iotsitewise-DescribeProject-response-projectCreationDate"></a>
The date the project was created, in Unix epoch time.  
Type: Timestamp

 ** [projectDescription](#API_DescribeProject_ResponseSyntax) **   <a name="iotsitewise-DescribeProject-response-projectDescription"></a>
The project's description.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[^\u0000-\u001F\u007F]+` 

 ** [projectId](#API_DescribeProject_ResponseSyntax) **   <a name="iotsitewise-DescribeProject-response-projectId"></a>
The ID of the project.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

 ** [projectLastUpdateDate](#API_DescribeProject_ResponseSyntax) **   <a name="iotsitewise-DescribeProject-response-projectLastUpdateDate"></a>
The date the project was last updated, in Unix epoch time.  
Type: Timestamp

 ** [projectName](#API_DescribeProject_ResponseSyntax) **   <a name="iotsitewise-DescribeProject-response-projectName"></a>
The name of the project.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[^\u0000-\u001F\u007F]+` 

## Errors
<a name="API_DescribeProject_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_DescribeProject_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/DescribeProject) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/DescribeProject) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/DescribeProject) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/DescribeProject) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DescribeProject) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/DescribeProject) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/DescribeProject) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/DescribeProject) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/DescribeProject) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/DescribeProject) 

# DescribeStorageConfiguration
<a name="API_DescribeStorageConfiguration"></a>

Retrieves information about the storage configuration for AWS IoT SiteWise.

## Request Syntax
<a name="API_DescribeStorageConfiguration_RequestSyntax"></a>

```
GET /configuration/account/storage HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeStorageConfiguration_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_DescribeStorageConfiguration_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeStorageConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "configurationStatus": { 
      "error": { 
         "code": "string",
         "message": "string"
      },
      "state": "string"
   },
   "disallowIngestNullNaN": boolean,
   "disassociatedDataStorage": "string",
   "lastUpdateDate": number,
   "multiLayerStorage": { 
      "customerManagedS3Storage": { 
         "roleArn": "string",
         "s3ResourceArn": "string"
      }
   },
   "retentionPeriod": { 
      "numberOfDays": number,
      "unlimited": boolean
   },
   "storageType": "string",
   "warmTier": "string",
   "warmTierRetentionPeriod": { 
      "numberOfDays": number,
      "unlimited": boolean
   }
}
```

## Response Elements
<a name="API_DescribeStorageConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [configurationStatus](#API_DescribeStorageConfiguration_ResponseSyntax) **   <a name="iotsitewise-DescribeStorageConfiguration-response-configurationStatus"></a>
Contains current status information for the configuration.  
Type: [ConfigurationStatus](API_ConfigurationStatus.md) object

 ** [disallowIngestNullNaN](#API_DescribeStorageConfiguration_ResponseSyntax) **   <a name="iotsitewise-DescribeStorageConfiguration-response-disallowIngestNullNaN"></a>
Describes the configuration for ingesting NULL and NaN data. By default the feature is allowed. The feature is disallowed if the value is `true`.  
Type: Boolean

 ** [disassociatedDataStorage](#API_DescribeStorageConfiguration_ResponseSyntax) **   <a name="iotsitewise-DescribeStorageConfiguration-response-disassociatedDataStorage"></a>
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` – AWS IoT SiteWise accepts time series that aren't associated with asset properties.
**Important**  
After the `disassociatedDataStorage` is enabled, you can't disable it.
+  `DISABLED` – AWS IoT SiteWise doesn't accept time series (data streams) that aren't associated with asset properties.
For more information, see [Data streams](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/data-streams.html) in the * AWS IoT SiteWise User Guide*.  
Type: String  
Valid Values: `ENABLED | DISABLED` 

 ** [lastUpdateDate](#API_DescribeStorageConfiguration_ResponseSyntax) **   <a name="iotsitewise-DescribeStorageConfiguration-response-lastUpdateDate"></a>
The date the storage configuration was last updated, in Unix epoch time.  
Type: Timestamp

 ** [multiLayerStorage](#API_DescribeStorageConfiguration_ResponseSyntax) **   <a name="iotsitewise-DescribeStorageConfiguration-response-multiLayerStorage"></a>
Contains information about the storage destination.  
Type: [MultiLayerStorage](API_MultiLayerStorage.md) object

 ** [retentionPeriod](#API_DescribeStorageConfiguration_ResponseSyntax) **   <a name="iotsitewise-DescribeStorageConfiguration-response-retentionPeriod"></a>
The number of days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.  
Type: [RetentionPeriod](API_RetentionPeriod.md) object

 ** [storageType](#API_DescribeStorageConfiguration_ResponseSyntax) **   <a name="iotsitewise-DescribeStorageConfiguration-response-storageType"></a>
The storage tier that you specified for your data. The `storageType` parameter can be one of the following values:  
+  `SITEWISE_DEFAULT_STORAGE` – AWS IoT SiteWise saves your data into the hot tier. The hot tier is a service-managed database.
+  `MULTI_LAYER_STORAGE` – AWS IoT SiteWise saves your data in both the cold tier and the hot tier. The cold tier is a customer-managed Amazon S3 bucket.
Type: String  
Valid Values: `SITEWISE_DEFAULT_STORAGE | MULTI_LAYER_STORAGE` 

 ** [warmTier](#API_DescribeStorageConfiguration_ResponseSyntax) **   <a name="iotsitewise-DescribeStorageConfiguration-response-warmTier"></a>
A service managed storage tier optimized for analytical queries. It stores periodically uploaded, buffered and historical data ingested with the CreaeBulkImportJob API.  
Type: String  
Valid Values: `ENABLED | DISABLED` 

 ** [warmTierRetentionPeriod](#API_DescribeStorageConfiguration_ResponseSyntax) **   <a name="iotsitewise-DescribeStorageConfiguration-response-warmTierRetentionPeriod"></a>
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.  
Type: [WarmTierRetentionPeriod](API_WarmTierRetentionPeriod.md) object

## Errors
<a name="API_DescribeStorageConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictingOperationException **   
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.    
 ** resourceArn **   
The ARN of the resource that conflicts with this operation.  
 ** resourceId **   
The ID of the resource that conflicts with this operation.
HTTP Status Code: 409

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** LimitExceededException **   
You've reached the quota for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 410

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_DescribeStorageConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/DescribeStorageConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/DescribeStorageConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/DescribeStorageConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/DescribeStorageConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DescribeStorageConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/DescribeStorageConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/DescribeStorageConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/DescribeStorageConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/DescribeStorageConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/DescribeStorageConfiguration) 

# DescribeTimeSeries
<a name="API_DescribeTimeSeries"></a>

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.

## Request Syntax
<a name="API_DescribeTimeSeries_RequestSyntax"></a>

```
GET /timeseries/describe/?alias=alias&assetId=assetId&propertyId=propertyId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeTimeSeries_RequestParameters"></a>

The request uses the following URI parameters.

 ** [alias](#API_DescribeTimeSeries_RequestSyntax) **   <a name="iotsitewise-DescribeTimeSeries-request-uri-alias"></a>
The alias that identifies the time series.  
Length Constraints: Minimum length of 1.  
Pattern: `[^\u0000-\u001F\u007F]+` 

 ** [assetId](#API_DescribeTimeSeries_RequestSyntax) **   <a name="iotsitewise-DescribeTimeSeries-request-uri-assetId"></a>
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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) in the * AWS IoT SiteWise User Guide*.  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+` 

 ** [propertyId](#API_DescribeTimeSeries_RequestSyntax) **   <a name="iotsitewise-DescribeTimeSeries-request-uri-propertyId"></a>
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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) in the * AWS IoT SiteWise User Guide*.  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+` 

## Request Body
<a name="API_DescribeTimeSeries_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeTimeSeries_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "alias": "string",
   "assetId": "string",
   "dataType": "string",
   "dataTypeSpec": "string",
   "propertyId": "string",
   "timeSeriesArn": "string",
   "timeSeriesCreationDate": number,
   "timeSeriesId": "string",
   "timeSeriesLastUpdateDate": number
}
```

## Response Elements
<a name="API_DescribeTimeSeries_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [alias](#API_DescribeTimeSeries_ResponseSyntax) **   <a name="iotsitewise-DescribeTimeSeries-response-alias"></a>
The alias that identifies the time series.  
Type: String  
Length Constraints: Minimum length of 1.  
Pattern: `[^\u0000-\u001F\u007F]+` 

 ** [assetId](#API_DescribeTimeSeries_ResponseSyntax) **   <a name="iotsitewise-DescribeTimeSeries-response-assetId"></a>
The ID of the asset in which the asset property was created.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

 ** [dataType](#API_DescribeTimeSeries_ResponseSyntax) **   <a name="iotsitewise-DescribeTimeSeries-response-dataType"></a>
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.  
Type: String  
Valid Values: `STRING | INTEGER | DOUBLE | BOOLEAN | STRUCT` 

 ** [dataTypeSpec](#API_DescribeTimeSeries_ResponseSyntax) **   <a name="iotsitewise-DescribeTimeSeries-response-dataTypeSpec"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[^\u0000-\u001F\u007F]+` 

 ** [propertyId](#API_DescribeTimeSeries_ResponseSyntax) **   <a name="iotsitewise-DescribeTimeSeries-response-propertyId"></a>
The ID of the asset property, in UUID format.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

 ** [timeSeriesArn](#API_DescribeTimeSeries_ResponseSyntax) **   <a name="iotsitewise-DescribeTimeSeries-response-timeSeriesArn"></a>
The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the time series, which has the following format.  
 `arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId}`   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$` 

 ** [timeSeriesCreationDate](#API_DescribeTimeSeries_ResponseSyntax) **   <a name="iotsitewise-DescribeTimeSeries-response-timeSeriesCreationDate"></a>
The date that the time series was created, in Unix epoch time.  
Type: Timestamp

 ** [timeSeriesId](#API_DescribeTimeSeries_ResponseSyntax) **   <a name="iotsitewise-DescribeTimeSeries-response-timeSeriesId"></a>
The ID of the time series.  
Type: String  
Length Constraints: Minimum length of 36. Maximum length of 73.

 ** [timeSeriesLastUpdateDate](#API_DescribeTimeSeries_ResponseSyntax) **   <a name="iotsitewise-DescribeTimeSeries-response-timeSeriesLastUpdateDate"></a>
The date that the time series was last updated, in Unix epoch time.  
Type: Timestamp

## Errors
<a name="API_DescribeTimeSeries_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_DescribeTimeSeries_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/DescribeTimeSeries) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/DescribeTimeSeries) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/DescribeTimeSeries) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/DescribeTimeSeries) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DescribeTimeSeries) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/DescribeTimeSeries) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/DescribeTimeSeries) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/DescribeTimeSeries) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/DescribeTimeSeries) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/DescribeTimeSeries) 

# DisassociateAssets
<a name="API_DisassociateAssets"></a>

Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model.

## Request Syntax
<a name="API_DisassociateAssets_RequestSyntax"></a>

```
POST /assets/assetId/disassociate HTTP/1.1
Content-type: application/json

{
   "childAssetId": "string",
   "clientToken": "string",
   "hierarchyId": "string"
}
```

## URI Request Parameters
<a name="API_DisassociateAssets_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assetId](#API_DisassociateAssets_RequestSyntax) **   <a name="iotsitewise-DisassociateAssets-request-uri-assetId"></a>
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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) in the * AWS IoT SiteWise User Guide*.  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+`   
Required: Yes

## Request Body
<a name="API_DisassociateAssets_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [childAssetId](#API_DisassociateAssets_RequestSyntax) **   <a name="iotsitewise-DisassociateAssets-request-childAssetId"></a>
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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) in the * AWS IoT SiteWise User Guide*.  
Type: String  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+`   
Required: Yes

 ** [clientToken](#API_DisassociateAssets_RequestSyntax) **   <a name="iotsitewise-DisassociateAssets-request-clientToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 36. Maximum length of 64.  
Pattern: `\S{36,64}`   
Required: No

 ** [hierarchyId](#API_DisassociateAssets_RequestSyntax) **   <a name="iotsitewise-DisassociateAssets-request-hierarchyId"></a>
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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) in the * AWS 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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html) in the * AWS IoT SiteWise User Guide*.  
Type: String  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+`   
Required: Yes

## Response Syntax
<a name="API_DisassociateAssets_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DisassociateAssets_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DisassociateAssets_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictingOperationException **   
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.    
 ** resourceArn **   
The ARN of the resource that conflicts with this operation.  
 ** resourceId **   
The ID of the resource that conflicts with this operation.
HTTP Status Code: 409

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_DisassociateAssets_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/DisassociateAssets) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/DisassociateAssets) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/DisassociateAssets) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/DisassociateAssets) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DisassociateAssets) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/DisassociateAssets) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/DisassociateAssets) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/DisassociateAssets) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/DisassociateAssets) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/DisassociateAssets) 

# DisassociateTimeSeriesFromAssetProperty
<a name="API_DisassociateTimeSeriesFromAssetProperty"></a>

Disassociates a time series (data stream) from an asset property.

## Request Syntax
<a name="API_DisassociateTimeSeriesFromAssetProperty_RequestSyntax"></a>

```
POST /timeseries/disassociate/?alias=alias&assetId=assetId&propertyId=propertyId HTTP/1.1
Content-type: application/json

{
   "clientToken": "string"
}
```

## URI Request Parameters
<a name="API_DisassociateTimeSeriesFromAssetProperty_RequestParameters"></a>

The request uses the following URI parameters.

 ** [alias](#API_DisassociateTimeSeriesFromAssetProperty_RequestSyntax) **   <a name="iotsitewise-DisassociateTimeSeriesFromAssetProperty-request-uri-alias"></a>
The alias that identifies the time series.  
Length Constraints: Minimum length of 1.  
Pattern: `[^\u0000-\u001F\u007F]+`   
Required: Yes

 ** [assetId](#API_DisassociateTimeSeriesFromAssetProperty_RequestSyntax) **   <a name="iotsitewise-DisassociateTimeSeriesFromAssetProperty-request-uri-assetId"></a>
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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) in the * AWS IoT SiteWise User Guide*.  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+`   
Required: Yes

 ** [propertyId](#API_DisassociateTimeSeriesFromAssetProperty_RequestSyntax) **   <a name="iotsitewise-DisassociateTimeSeriesFromAssetProperty-request-uri-propertyId"></a>
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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) in the * AWS IoT SiteWise User Guide*.  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+`   
Required: Yes

## Request Body
<a name="API_DisassociateTimeSeriesFromAssetProperty_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_DisassociateTimeSeriesFromAssetProperty_RequestSyntax) **   <a name="iotsitewise-DisassociateTimeSeriesFromAssetProperty-request-clientToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 36. Maximum length of 64.  
Pattern: `\S{36,64}`   
Required: No

## Response Syntax
<a name="API_DisassociateTimeSeriesFromAssetProperty_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DisassociateTimeSeriesFromAssetProperty_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DisassociateTimeSeriesFromAssetProperty_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictingOperationException **   
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.    
 ** resourceArn **   
The ARN of the resource that conflicts with this operation.  
 ** resourceId **   
The ID of the resource that conflicts with this operation.
HTTP Status Code: 409

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_DisassociateTimeSeriesFromAssetProperty_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/DisassociateTimeSeriesFromAssetProperty) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/DisassociateTimeSeriesFromAssetProperty) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/DisassociateTimeSeriesFromAssetProperty) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/DisassociateTimeSeriesFromAssetProperty) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DisassociateTimeSeriesFromAssetProperty) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/DisassociateTimeSeriesFromAssetProperty) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/DisassociateTimeSeriesFromAssetProperty) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/DisassociateTimeSeriesFromAssetProperty) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/DisassociateTimeSeriesFromAssetProperty) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/DisassociateTimeSeriesFromAssetProperty) 

# ExecuteAction
<a name="API_ExecuteAction"></a>

Executes an action on a target resource.

## Request Syntax
<a name="API_ExecuteAction_RequestSyntax"></a>

```
POST /actions HTTP/1.1
Content-type: application/json

{
   "actionDefinitionId": "string",
   "actionPayload": { 
      "stringValue": "string"
   },
   "clientToken": "string",
   "resolveTo": { 
      "assetId": "string"
   },
   "targetResource": { 
      "assetId": "string",
      "computationModelId": "string"
   }
}
```

## URI Request Parameters
<a name="API_ExecuteAction_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_ExecuteAction_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [actionDefinitionId](#API_ExecuteAction_RequestSyntax) **   <a name="iotsitewise-ExecuteAction-request-actionDefinitionId"></a>
The ID of the action definition.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`   
Required: Yes

 ** [actionPayload](#API_ExecuteAction_RequestSyntax) **   <a name="iotsitewise-ExecuteAction-request-actionPayload"></a>
The JSON payload of the action.  
Type: [ActionPayload](API_ActionPayload.md) object  
Required: Yes

 ** [clientToken](#API_ExecuteAction_RequestSyntax) **   <a name="iotsitewise-ExecuteAction-request-clientToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 36. Maximum length of 64.  
Pattern: `\S{36,64}`   
Required: No

 ** [resolveTo](#API_ExecuteAction_RequestSyntax) **   <a name="iotsitewise-ExecuteAction-request-resolveTo"></a>
The detailed resource this action resolves to.  
Type: [ResolveTo](API_ResolveTo.md) object  
Required: No

 ** [targetResource](#API_ExecuteAction_RequestSyntax) **   <a name="iotsitewise-ExecuteAction-request-targetResource"></a>
The resource the action will be taken on.  
Type: [TargetResource](API_TargetResource.md) object  
Required: Yes

## Response Syntax
<a name="API_ExecuteAction_ResponseSyntax"></a>

```
HTTP/1.1 202
Content-type: application/json

{
   "actionId": "string"
}
```

## Response Elements
<a name="API_ExecuteAction_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

 ** [actionId](#API_ExecuteAction_ResponseSyntax) **   <a name="iotsitewise-ExecuteAction-response-actionId"></a>
The ID of the action.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

## Errors
<a name="API_ExecuteAction_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictingOperationException **   
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.    
 ** resourceArn **   
The ARN of the resource that conflicts with this operation.  
 ** resourceId **   
The ID of the resource that conflicts with this operation.
HTTP Status Code: 409

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** LimitExceededException **   
You've reached the quota for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 410

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_ExecuteAction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/ExecuteAction) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/ExecuteAction) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/ExecuteAction) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/ExecuteAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/ExecuteAction) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/ExecuteAction) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/ExecuteAction) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/ExecuteAction) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/ExecuteAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/ExecuteAction) 

# ExecuteQuery
<a name="API_ExecuteQuery"></a>

Run SQL queries to retrieve metadata and time-series data from asset models, assets, measurements, metrics, transforms, and aggregates.

## Request Syntax
<a name="API_ExecuteQuery_RequestSyntax"></a>

```
POST /queries/execution HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "maxResults": number,
   "nextToken": "string",
   "queryStatement": "string"
}
```

## URI Request Parameters
<a name="API_ExecuteQuery_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_ExecuteQuery_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_ExecuteQuery_RequestSyntax) **   <a name="iotsitewise-ExecuteQuery-request-clientToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 36. Maximum length of 64.  
Pattern: `\S{36,64}`   
Required: No

 ** [maxResults](#API_ExecuteQuery_RequestSyntax) **   <a name="iotsitewise-ExecuteQuery-request-maxResults"></a>
The maximum number of results to return at one time.  
+ Minimum is 1
+ Maximum is 20000
+ Default is 20000
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** [nextToken](#API_ExecuteQuery_RequestSyntax) **   <a name="iotsitewise-ExecuteQuery-request-nextToken"></a>
The string that specifies the next page of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** [queryStatement](#API_ExecuteQuery_RequestSyntax) **   <a name="iotsitewise-ExecuteQuery-request-queryStatement"></a>
The AWS IoT SiteWise query statement.  
Type: String  
Length Constraints: Minimum length of 1.  
Pattern: `^[\s\S]+$`   
Required: Yes

## Response Syntax
<a name="API_ExecuteQuery_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "columns": [ 
      { 
         "name": "string",
         "type": { 
            "scalarType": "string"
         }
      }
   ],
   "nextToken": "string",
   "rows": [ 
      { 
         "data": [ 
            { 
               "arrayValue": [ 
                  "Datum"
               ],
               "nullValue": boolean,
               "rowValue": "Row",
               "scalarValue": "string"
            }
         ]
      }
   ]
}
```

## Response Elements
<a name="API_ExecuteQuery_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [columns](#API_ExecuteQuery_ResponseSyntax) **   <a name="iotsitewise-ExecuteQuery-response-columns"></a>
Represents a single column in the query results.  
Type: Array of [ColumnInfo](API_ColumnInfo.md) objects

 ** [nextToken](#API_ExecuteQuery_ResponseSyntax) **   <a name="iotsitewise-ExecuteQuery-response-nextToken"></a>
The string that specifies the next page of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.

 ** [rows](#API_ExecuteQuery_ResponseSyntax) **   <a name="iotsitewise-ExecuteQuery-response-rows"></a>
Represents a single row in the query results.  
Type: Array of [Row](API_Row.md) objects

## Errors
<a name="API_ExecuteQuery_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
Access is denied.  
HTTP Status Code: 403

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** QueryTimeoutException **   
The query timed out.  
HTTP Status Code: 400

 ** ServiceUnavailableException **   
The requested service is unavailable.  
HTTP Status Code: 503

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

 ** ValidationException **   
The validation failed for this query.  
HTTP Status Code: 400

## See Also
<a name="API_ExecuteQuery_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/ExecuteQuery) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/ExecuteQuery) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/ExecuteQuery) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/ExecuteQuery) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/ExecuteQuery) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/ExecuteQuery) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/ExecuteQuery) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/ExecuteQuery) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/ExecuteQuery) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/ExecuteQuery) 

# GetAssetPropertyAggregates
<a name="API_GetAssetPropertyAggregates"></a>

Gets aggregated values for an asset property. For more information, see [Querying aggregates](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#aggregates) in the * AWS 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](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html).

## Request Syntax
<a name="API_GetAssetPropertyAggregates_RequestSyntax"></a>

```
GET /properties/aggregates?aggregateTypes=aggregateTypes&assetId=assetId&endDate=endDate&maxResults=maxResults&nextToken=nextToken&propertyAlias=propertyAlias&propertyId=propertyId&qualities=qualities&resolution=resolution&startDate=startDate&timeOrdering=timeOrdering HTTP/1.1
```

## URI Request Parameters
<a name="API_GetAssetPropertyAggregates_RequestParameters"></a>

The request uses the following URI parameters.

 ** [aggregateTypes](#API_GetAssetPropertyAggregates_RequestSyntax) **   <a name="iotsitewise-GetAssetPropertyAggregates-request-uri-aggregateTypes"></a>
The data aggregating function.  
Array Members: Minimum number of 1 item.  
Valid Values: `AVERAGE | COUNT | MAXIMUM | MINIMUM | SUM | STANDARD_DEVIATION`   
Required: Yes

 ** [assetId](#API_GetAssetPropertyAggregates_RequestSyntax) **   <a name="iotsitewise-GetAssetPropertyAggregates-request-uri-assetId"></a>
The ID of the asset, in UUID format.  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

 ** [endDate](#API_GetAssetPropertyAggregates_RequestSyntax) **   <a name="iotsitewise-GetAssetPropertyAggregates-request-uri-endDate"></a>
The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.  
Required: Yes

 ** [maxResults](#API_GetAssetPropertyAggregates_RequestSyntax) **   <a name="iotsitewise-GetAssetPropertyAggregates-request-uri-maxResults"></a>
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.
Valid Range: Minimum value of 1.

 ** [nextToken](#API_GetAssetPropertyAggregates_RequestSyntax) **   <a name="iotsitewise-GetAssetPropertyAggregates-request-uri-nextToken"></a>
The token to be used for the next set of paginated results.  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

 ** [propertyAlias](#API_GetAssetPropertyAggregates_RequestSyntax) **   <a name="iotsitewise-GetAssetPropertyAggregates-request-uri-propertyAlias"></a>
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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) in the * AWS IoT SiteWise User Guide*.  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Pattern: `[^\u0000-\u001F\u007F]+` 

 ** [propertyId](#API_GetAssetPropertyAggregates_RequestSyntax) **   <a name="iotsitewise-GetAssetPropertyAggregates-request-uri-propertyId"></a>
The ID of the asset property, in UUID format.  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

 ** [qualities](#API_GetAssetPropertyAggregates_RequestSyntax) **   <a name="iotsitewise-GetAssetPropertyAggregates-request-uri-qualities"></a>
The quality by which to filter asset data.  
Array Members: Fixed number of 1 item.  
Valid Values: `GOOD | BAD | UNCERTAIN` 

 ** [resolution](#API_GetAssetPropertyAggregates_RequestSyntax) **   <a name="iotsitewise-GetAssetPropertyAggregates-request-uri-resolution"></a>
The time interval over which to aggregate data.  
Length Constraints: Minimum length of 2. Maximum length of 3.  
Pattern: `1m|15m|1h|1d`   
Required: Yes

 ** [startDate](#API_GetAssetPropertyAggregates_RequestSyntax) **   <a name="iotsitewise-GetAssetPropertyAggregates-request-uri-startDate"></a>
The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.  
Required: Yes

 ** [timeOrdering](#API_GetAssetPropertyAggregates_RequestSyntax) **   <a name="iotsitewise-GetAssetPropertyAggregates-request-uri-timeOrdering"></a>
The chronological sorting order of the requested information.  
Default: `ASCENDING`   
Valid Values: `ASCENDING | DESCENDING` 

## Request Body
<a name="API_GetAssetPropertyAggregates_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetAssetPropertyAggregates_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "aggregatedValues": [ 
      { 
         "quality": "string",
         "timestamp": number,
         "value": { 
            "average": number,
            "count": number,
            "maximum": number,
            "minimum": number,
            "standardDeviation": number,
            "sum": number
         }
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_GetAssetPropertyAggregates_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [aggregatedValues](#API_GetAssetPropertyAggregates_ResponseSyntax) **   <a name="iotsitewise-GetAssetPropertyAggregates-response-aggregatedValues"></a>
The requested aggregated values.  
Type: Array of [AggregatedValue](API_AggregatedValue.md) objects

 ** [nextToken](#API_GetAssetPropertyAggregates_ResponseSyntax) **   <a name="iotsitewise-GetAssetPropertyAggregates-response-nextToken"></a>
The token for the next set of results, or null if there are no additional results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

## Errors
<a name="API_GetAssetPropertyAggregates_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ServiceUnavailableException **   
The requested service is unavailable.  
HTTP Status Code: 503

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_GetAssetPropertyAggregates_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/GetAssetPropertyAggregates) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/GetAssetPropertyAggregates) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/GetAssetPropertyAggregates) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/GetAssetPropertyAggregates) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/GetAssetPropertyAggregates) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/GetAssetPropertyAggregates) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/GetAssetPropertyAggregates) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/GetAssetPropertyAggregates) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/GetAssetPropertyAggregates) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/GetAssetPropertyAggregates) 

# GetAssetPropertyValue
<a name="API_GetAssetPropertyValue"></a>

Gets an asset property's current value. For more information, see [Querying current values](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#current-values) in the * AWS 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](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html).

## Request Syntax
<a name="API_GetAssetPropertyValue_RequestSyntax"></a>

```
GET /properties/latest?assetId=assetId&propertyAlias=propertyAlias&propertyId=propertyId HTTP/1.1
```

## URI Request Parameters
<a name="API_GetAssetPropertyValue_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assetId](#API_GetAssetPropertyValue_RequestSyntax) **   <a name="iotsitewise-GetAssetPropertyValue-request-uri-assetId"></a>
The ID of the asset, in UUID format.  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

 ** [propertyAlias](#API_GetAssetPropertyValue_RequestSyntax) **   <a name="iotsitewise-GetAssetPropertyValue-request-uri-propertyAlias"></a>
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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) in the * AWS IoT SiteWise User Guide*.  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Pattern: `[^\u0000-\u001F\u007F]+` 

 ** [propertyId](#API_GetAssetPropertyValue_RequestSyntax) **   <a name="iotsitewise-GetAssetPropertyValue-request-uri-propertyId"></a>
The ID of the asset property, in UUID format.  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

## Request Body
<a name="API_GetAssetPropertyValue_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetAssetPropertyValue_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "propertyValue": { 
      "quality": "string",
      "timestamp": { 
         "offsetInNanos": number,
         "timeInSeconds": number
      },
      "value": { 
         "booleanValue": boolean,
         "doubleValue": number,
         "integerValue": number,
         "nullValue": { 
            "valueType": "string"
         },
         "stringValue": "string"
      }
   }
}
```

## Response Elements
<a name="API_GetAssetPropertyValue_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [propertyValue](#API_GetAssetPropertyValue_ResponseSyntax) **   <a name="iotsitewise-GetAssetPropertyValue-response-propertyValue"></a>
The current asset property value.  
Type: [AssetPropertyValue](API_AssetPropertyValue.md) object

## Errors
<a name="API_GetAssetPropertyValue_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ServiceUnavailableException **   
The requested service is unavailable.  
HTTP Status Code: 503

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_GetAssetPropertyValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/GetAssetPropertyValue) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/GetAssetPropertyValue) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/GetAssetPropertyValue) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/GetAssetPropertyValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/GetAssetPropertyValue) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/GetAssetPropertyValue) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/GetAssetPropertyValue) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/GetAssetPropertyValue) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/GetAssetPropertyValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/GetAssetPropertyValue) 

# GetAssetPropertyValueHistory
<a name="API_GetAssetPropertyValueHistory"></a>

Gets the history of an asset property's values. For more information, see [Querying historical values](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#historical-values) in the * AWS 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](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html).

## Request Syntax
<a name="API_GetAssetPropertyValueHistory_RequestSyntax"></a>

```
GET /properties/history?assetId=assetId&endDate=endDate&maxResults=maxResults&nextToken=nextToken&propertyAlias=propertyAlias&propertyId=propertyId&qualities=qualities&startDate=startDate&timeOrdering=timeOrdering HTTP/1.1
```

## URI Request Parameters
<a name="API_GetAssetPropertyValueHistory_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assetId](#API_GetAssetPropertyValueHistory_RequestSyntax) **   <a name="iotsitewise-GetAssetPropertyValueHistory-request-uri-assetId"></a>
The ID of the asset, in UUID format.  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

 ** [endDate](#API_GetAssetPropertyValueHistory_RequestSyntax) **   <a name="iotsitewise-GetAssetPropertyValueHistory-request-uri-endDate"></a>
The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.

 ** [maxResults](#API_GetAssetPropertyValueHistory_RequestSyntax) **   <a name="iotsitewise-GetAssetPropertyValueHistory-request-uri-maxResults"></a>
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.
Valid Range: Minimum value of 1.

 ** [nextToken](#API_GetAssetPropertyValueHistory_RequestSyntax) **   <a name="iotsitewise-GetAssetPropertyValueHistory-request-uri-nextToken"></a>
The token to be used for the next set of paginated results.  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

 ** [propertyAlias](#API_GetAssetPropertyValueHistory_RequestSyntax) **   <a name="iotsitewise-GetAssetPropertyValueHistory-request-uri-propertyAlias"></a>
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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) in the * AWS IoT SiteWise User Guide*.  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Pattern: `[^\u0000-\u001F\u007F]+` 

 ** [propertyId](#API_GetAssetPropertyValueHistory_RequestSyntax) **   <a name="iotsitewise-GetAssetPropertyValueHistory-request-uri-propertyId"></a>
The ID of the asset property, in UUID format.  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

 ** [qualities](#API_GetAssetPropertyValueHistory_RequestSyntax) **   <a name="iotsitewise-GetAssetPropertyValueHistory-request-uri-qualities"></a>
The quality by which to filter asset data.  
Array Members: Fixed number of 1 item.  
Valid Values: `GOOD | BAD | UNCERTAIN` 

 ** [startDate](#API_GetAssetPropertyValueHistory_RequestSyntax) **   <a name="iotsitewise-GetAssetPropertyValueHistory-request-uri-startDate"></a>
The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.

 ** [timeOrdering](#API_GetAssetPropertyValueHistory_RequestSyntax) **   <a name="iotsitewise-GetAssetPropertyValueHistory-request-uri-timeOrdering"></a>
The chronological sorting order of the requested information.  
Default: `ASCENDING`   
Valid Values: `ASCENDING | DESCENDING` 

## Request Body
<a name="API_GetAssetPropertyValueHistory_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetAssetPropertyValueHistory_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "assetPropertyValueHistory": [ 
      { 
         "quality": "string",
         "timestamp": { 
            "offsetInNanos": number,
            "timeInSeconds": number
         },
         "value": { 
            "booleanValue": boolean,
            "doubleValue": number,
            "integerValue": number,
            "nullValue": { 
               "valueType": "string"
            },
            "stringValue": "string"
         }
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_GetAssetPropertyValueHistory_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [assetPropertyValueHistory](#API_GetAssetPropertyValueHistory_ResponseSyntax) **   <a name="iotsitewise-GetAssetPropertyValueHistory-response-assetPropertyValueHistory"></a>
The asset property's value history.  
Type: Array of [AssetPropertyValue](API_AssetPropertyValue.md) objects

 ** [nextToken](#API_GetAssetPropertyValueHistory_ResponseSyntax) **   <a name="iotsitewise-GetAssetPropertyValueHistory-response-nextToken"></a>
The token for the next set of results, or null if there are no additional results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

## Errors
<a name="API_GetAssetPropertyValueHistory_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ServiceUnavailableException **   
The requested service is unavailable.  
HTTP Status Code: 503

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_GetAssetPropertyValueHistory_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/GetAssetPropertyValueHistory) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/GetAssetPropertyValueHistory) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/GetAssetPropertyValueHistory) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/GetAssetPropertyValueHistory) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/GetAssetPropertyValueHistory) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/GetAssetPropertyValueHistory) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/GetAssetPropertyValueHistory) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/GetAssetPropertyValueHistory) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/GetAssetPropertyValueHistory) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/GetAssetPropertyValueHistory) 

# GetInterpolatedAssetPropertyValues
<a name="API_GetInterpolatedAssetPropertyValues"></a>

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](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html).

## Request Syntax
<a name="API_GetInterpolatedAssetPropertyValues_RequestSyntax"></a>

```
GET /properties/interpolated?assetId=assetId&endTimeInSeconds=endTimeInSeconds&endTimeOffsetInNanos=endTimeOffsetInNanos&intervalInSeconds=intervalInSeconds&intervalWindowInSeconds=intervalWindowInSeconds&maxResults=maxResults&nextToken=nextToken&propertyAlias=propertyAlias&propertyId=propertyId&quality=quality&startTimeInSeconds=startTimeInSeconds&startTimeOffsetInNanos=startTimeOffsetInNanos&type=type HTTP/1.1
```

## URI Request Parameters
<a name="API_GetInterpolatedAssetPropertyValues_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assetId](#API_GetInterpolatedAssetPropertyValues_RequestSyntax) **   <a name="iotsitewise-GetInterpolatedAssetPropertyValues-request-uri-assetId"></a>
The ID of the asset, in UUID format.  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

 ** [endTimeInSeconds](#API_GetInterpolatedAssetPropertyValues_RequestSyntax) **   <a name="iotsitewise-GetInterpolatedAssetPropertyValues-request-uri-endTimeInSeconds"></a>
The inclusive end of the range from which to interpolate data, expressed in seconds in Unix epoch time.  
Valid Range: Minimum value of 1. Maximum value of 9223372036854774.  
Required: Yes

 ** [endTimeOffsetInNanos](#API_GetInterpolatedAssetPropertyValues_RequestSyntax) **   <a name="iotsitewise-GetInterpolatedAssetPropertyValues-request-uri-endTimeOffsetInNanos"></a>
The nanosecond offset converted from `endTimeInSeconds`.  
Valid Range: Minimum value of 0. Maximum value of 999999999.

 ** [intervalInSeconds](#API_GetInterpolatedAssetPropertyValues_RequestSyntax) **   <a name="iotsitewise-GetInterpolatedAssetPropertyValues-request-uri-intervalInSeconds"></a>
The time interval in seconds over which to interpolate data. Each interval starts when the previous one ends.  
Valid Range: Minimum value of 1. Maximum value of 320000000.  
Required: Yes

 ** [intervalWindowInSeconds](#API_GetInterpolatedAssetPropertyValues_RequestSyntax) **   <a name="iotsitewise-GetInterpolatedAssetPropertyValues-request-uri-intervalWindowInSeconds"></a>
The query interval for the window, in seconds. AWS 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, AWS 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, AWS 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, AWS 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.   
Valid Range: Minimum value of 1. Maximum value of 320000000.

 ** [maxResults](#API_GetInterpolatedAssetPropertyValues_RequestSyntax) **   <a name="iotsitewise-GetInterpolatedAssetPropertyValues-request-uri-maxResults"></a>
The maximum number of results to return for each paginated request. If not specified, the default value is 10.  
Valid Range: Minimum value of 1.

 ** [nextToken](#API_GetInterpolatedAssetPropertyValues_RequestSyntax) **   <a name="iotsitewise-GetInterpolatedAssetPropertyValues-request-uri-nextToken"></a>
The token to be used for the next set of paginated results.  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

 ** [propertyAlias](#API_GetInterpolatedAssetPropertyValues_RequestSyntax) **   <a name="iotsitewise-GetInterpolatedAssetPropertyValues-request-uri-propertyAlias"></a>
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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) in the * AWS IoT SiteWise User Guide*.  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Pattern: `[^\u0000-\u001F\u007F]+` 

 ** [propertyId](#API_GetInterpolatedAssetPropertyValues_RequestSyntax) **   <a name="iotsitewise-GetInterpolatedAssetPropertyValues-request-uri-propertyId"></a>
The ID of the asset property, in UUID format.  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

 ** [quality](#API_GetInterpolatedAssetPropertyValues_RequestSyntax) **   <a name="iotsitewise-GetInterpolatedAssetPropertyValues-request-uri-quality"></a>
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.  
Valid Values: `GOOD | BAD | UNCERTAIN`   
Required: Yes

 ** [startTimeInSeconds](#API_GetInterpolatedAssetPropertyValues_RequestSyntax) **   <a name="iotsitewise-GetInterpolatedAssetPropertyValues-request-uri-startTimeInSeconds"></a>
The exclusive start of the range from which to interpolate data, expressed in seconds in Unix epoch time.  
Valid Range: Minimum value of 1. Maximum value of 9223372036854774.  
Required: Yes

 ** [startTimeOffsetInNanos](#API_GetInterpolatedAssetPropertyValues_RequestSyntax) **   <a name="iotsitewise-GetInterpolatedAssetPropertyValues-request-uri-startTimeOffsetInNanos"></a>
The nanosecond offset converted from `startTimeInSeconds`.  
Valid Range: Minimum value of 0. Maximum value of 999999999.

 ** [type](#API_GetInterpolatedAssetPropertyValues_RequestSyntax) **   <a name="iotsitewise-GetInterpolatedAssetPropertyValues-request-uri-type"></a>
The interpolation type.  
Valid values: `LINEAR_INTERPOLATION | LOCF_INTERPOLATION`   
+  `LINEAR_INTERPOLATION` – Estimates missing data using [linear interpolation](https://en.wikipedia.org/wiki/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, AWS 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, AWS 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, AWS 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, AWS IoT SiteWise uses the same interpolated value for the rest of the days.
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

## Request Body
<a name="API_GetInterpolatedAssetPropertyValues_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetInterpolatedAssetPropertyValues_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "interpolatedAssetPropertyValues": [ 
      { 
         "timestamp": { 
            "offsetInNanos": number,
            "timeInSeconds": number
         },
         "value": { 
            "booleanValue": boolean,
            "doubleValue": number,
            "integerValue": number,
            "nullValue": { 
               "valueType": "string"
            },
            "stringValue": "string"
         }
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_GetInterpolatedAssetPropertyValues_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [interpolatedAssetPropertyValues](#API_GetInterpolatedAssetPropertyValues_ResponseSyntax) **   <a name="iotsitewise-GetInterpolatedAssetPropertyValues-response-interpolatedAssetPropertyValues"></a>
The requested interpolated values.  
Type: Array of [InterpolatedAssetPropertyValue](API_InterpolatedAssetPropertyValue.md) objects

 ** [nextToken](#API_GetInterpolatedAssetPropertyValues_ResponseSyntax) **   <a name="iotsitewise-GetInterpolatedAssetPropertyValues-response-nextToken"></a>
The token for the next set of results, or null if there are no additional results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

## Errors
<a name="API_GetInterpolatedAssetPropertyValues_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ServiceUnavailableException **   
The requested service is unavailable.  
HTTP Status Code: 503

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## Examples
<a name="API_GetInterpolatedAssetPropertyValues_Examples"></a>

### Example
<a name="API_GetInterpolatedAssetPropertyValues_Example_1"></a>

The following example uses the AWS Command Line Interface (AWS CLI) to retrieve the interpolated temperature values for a wind turbine every 24 hours between April 26, 2021 at midnight and May 3, 2021 at midnight in Pacific Time (PT). 

**Note**  
Replace `<asset-ID>` and `<property-ID>` with your asset ID and property ID.
The `--start-time-offset-in-nanos` and `--end-time-offset-in-nanos` parameters are optional. You can use these parameters to specify the nanosecond offsets for `startTimeInSeconds` and `startTimeInSeconds`.

#### Sample Request
<a name="API_GetInterpolatedAssetPropertyValues_Example_1_Request"></a>

```
aws iotsitewise get-interpolated-asset-property-values --asset-id <asset-ID> --property-id <property-ID> --start-time-in-seconds 1619420400 --start-time-offset-in-nanos 0 --end-time-in-seconds 1620025200
          --end-time-offset-in-nanos 0 --end-time-offset-in-nanos 1 --quality GOOD  --interval-in-seconds 3600 --type LINEAR_INTERPOLATION
```

#### Sample Response
<a name="API_GetInterpolatedAssetPropertyValues_Example_1_Response"></a>

```
{
    "interpolatedAssetPropertyValues": [
        {
            "timestamp": {
                "timeInSeconds": 1619420400,
                "offsetInNanos": 0
            },
            "value": {
                "doubleValue": 30.0
            }
        },
        {
            "timestamp": {
                "timeInSeconds": 1619424000,
                "offsetInNanos": 0
            },
            "value": {
                "doubleValue": 41.25
            }
        },
        {
            "timestamp": {
                "timeInSeconds": 1619427600,
                "offsetInNanos": 0
            },
            "value": {
                "doubleValue": 35.85
            }
        },
        ...
    ],
    ...
}
```

## See Also
<a name="API_GetInterpolatedAssetPropertyValues_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/GetInterpolatedAssetPropertyValues) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/GetInterpolatedAssetPropertyValues) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/GetInterpolatedAssetPropertyValues) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/GetInterpolatedAssetPropertyValues) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/GetInterpolatedAssetPropertyValues) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/GetInterpolatedAssetPropertyValues) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/GetInterpolatedAssetPropertyValues) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/GetInterpolatedAssetPropertyValues) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/GetInterpolatedAssetPropertyValues) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/GetInterpolatedAssetPropertyValues) 

# InvokeAssistant
<a name="API_InvokeAssistant"></a>

Invokes SiteWise Assistant to start or continue a conversation.

## Request Syntax
<a name="API_InvokeAssistant_RequestSyntax"></a>

```
POST /assistant/invocation HTTP/1.1
Content-type: application/json

{
   "conversationId": "string",
   "enableTrace": boolean,
   "message": "string"
}
```

## URI Request Parameters
<a name="API_InvokeAssistant_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_InvokeAssistant_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [conversationId](#API_InvokeAssistant_RequestSyntax) **   <a name="iotsitewise-InvokeAssistant-request-conversationId"></a>
The ID assigned to a conversation. AWS IoT SiteWise automatically generates a unique ID for you, and this parameter is never required. However, if you prefer to have your own ID, you must specify it here in UUID format. If you specify your own ID, it must be globally unique.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: No

 ** [enableTrace](#API_InvokeAssistant_RequestSyntax) **   <a name="iotsitewise-InvokeAssistant-request-enableTrace"></a>
Specifies if to turn trace on or not. It is used to track the SiteWise Assistant's reasoning, and data access process.  
Type: Boolean  
Required: No

 ** [message](#API_InvokeAssistant_RequestSyntax) **   <a name="iotsitewise-InvokeAssistant-request-message"></a>
A text message sent to the SiteWise Assistant by the user.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 10000.  
Required: Yes

## Response Syntax
<a name="API_InvokeAssistant_ResponseSyntax"></a>

```
HTTP/1.1 200
x-amz-iotsitewise-assistant-conversation-id: conversationId
Content-type: application/json

{
   "accessDeniedException": { 
   },
   "conflictingOperationException": { 
   },
   "internalFailureException": { 
   },
   "invalidRequestException": { 
   },
   "limitExceededException": { 
   },
   "output": { 
      "citations": [ 
         { 
            "content": { 
               "text": "string"
            },
            "reference": { 
               "dataset": { 
                  "datasetArn": "string",
                  "source": { 
                     "arn": "string",
                     "location": { 
                        "uri": "string"
                     }
                  }
               }
            }
         }
      ],
      "message": "string"
   },
   "resourceNotFoundException": { 
   },
   "throttlingException": { 
   },
   "trace": { 
      "text": "string"
   }
}
```

## Response Elements
<a name="API_InvokeAssistant_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The response returns the following HTTP headers.

 ** [conversationId](#API_InvokeAssistant_ResponseSyntax) **   <a name="iotsitewise-InvokeAssistant-response-conversationId"></a>
The ID of the conversation, in UUID format. This ID uniquely identifies the conversation within AWS IoT SiteWise.  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` 

The following data is returned in JSON format by the service.

 ** [accessDeniedException](#API_InvokeAssistant_ResponseSyntax) **   <a name="iotsitewise-InvokeAssistant-response-accessDeniedException"></a>
Access is denied.  
Type: Exception  
HTTP Status Code: 403

 ** [conflictingOperationException](#API_InvokeAssistant_ResponseSyntax) **   <a name="iotsitewise-InvokeAssistant-response-conflictingOperationException"></a>
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.  
Type: Exception  
HTTP Status Code: 409

 ** [internalFailureException](#API_InvokeAssistant_ResponseSyntax) **   <a name="iotsitewise-InvokeAssistant-response-internalFailureException"></a>
 AWS IoT SiteWise can't process your request right now. Try again later.  
Type: Exception  
HTTP Status Code: 500

 ** [invalidRequestException](#API_InvokeAssistant_ResponseSyntax) **   <a name="iotsitewise-InvokeAssistant-response-invalidRequestException"></a>
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
Type: Exception  
HTTP Status Code: 400

 ** [limitExceededException](#API_InvokeAssistant_ResponseSyntax) **   <a name="iotsitewise-InvokeAssistant-response-limitExceededException"></a>
You've reached the quota for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
Type: Exception  
HTTP Status Code: 410

 ** [output](#API_InvokeAssistant_ResponseSyntax) **   <a name="iotsitewise-InvokeAssistant-response-output"></a>
Contains the SiteWise Assistant's response.  
Type: [InvocationOutput](API_InvocationOutput.md) object

 ** [resourceNotFoundException](#API_InvokeAssistant_ResponseSyntax) **   <a name="iotsitewise-InvokeAssistant-response-resourceNotFoundException"></a>
The requested resource can't be found.  
Type: Exception  
HTTP Status Code: 404

 ** [throttlingException](#API_InvokeAssistant_ResponseSyntax) **   <a name="iotsitewise-InvokeAssistant-response-throttlingException"></a>
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
Type: Exception  
HTTP Status Code: 429

 ** [trace](#API_InvokeAssistant_ResponseSyntax) **   <a name="iotsitewise-InvokeAssistant-response-trace"></a>
Contains tracing information of the SiteWise Assistant's reasoning and data access.  
Type: [Trace](API_Trace.md) object

## Errors
<a name="API_InvokeAssistant_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
Access is denied.  
HTTP Status Code: 403

 ** ConflictingOperationException **   
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.    
 ** resourceArn **   
The ARN of the resource that conflicts with this operation.  
 ** resourceId **   
The ID of the resource that conflicts with this operation.
HTTP Status Code: 409

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** LimitExceededException **   
You've reached the quota for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 410

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_InvokeAssistant_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/InvokeAssistant) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/InvokeAssistant) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/InvokeAssistant) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/InvokeAssistant) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/InvokeAssistant) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/InvokeAssistant) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/InvokeAssistant) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/InvokeAssistant) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/InvokeAssistant) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/InvokeAssistant) 

# ListAccessPolicies
<a name="API_ListAccessPolicies"></a>

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 AWS IoT SiteWise Monitor resource (a portal or project).

## Request Syntax
<a name="API_ListAccessPolicies_RequestSyntax"></a>

```
GET /access-policies?iamArn=iamArn&identityId=identityId&identityType=identityType&maxResults=maxResults&nextToken=nextToken&resourceId=resourceId&resourceType=resourceType HTTP/1.1
```

## URI Request Parameters
<a name="API_ListAccessPolicies_RequestParameters"></a>

The request uses the following URI parameters.

 ** [iamArn](#API_ListAccessPolicies_RequestSyntax) **   <a name="iotsitewise-ListAccessPolicies-request-uri-iamArn"></a>
The ARN of the IAM user. For more information, see [IAM ARNs](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) in the *IAM User Guide*. This parameter is required if you specify `IAM` for `identityType`.  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.\+=,@]+$` 

 ** [identityId](#API_ListAccessPolicies_RequestSyntax) **   <a name="iotsitewise-ListAccessPolicies-request-uri-identityId"></a>
The ID of the identity. This parameter is required if you specify `USER` or `GROUP` for `identityType`.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `\S+` 

 ** [identityType](#API_ListAccessPolicies_RequestSyntax) **   <a name="iotsitewise-ListAccessPolicies-request-uri-identityType"></a>
The type of identity (IAM Identity Center user, IAM Identity Center group, or IAM user). This parameter is required if you specify `identityId`.  
Valid Values: `USER | GROUP | IAM` 

 ** [maxResults](#API_ListAccessPolicies_RequestSyntax) **   <a name="iotsitewise-ListAccessPolicies-request-uri-maxResults"></a>
The maximum number of results to return for each paginated request.  
Default: 50  
Valid Range: Minimum value of 1. Maximum value of 250.

 ** [nextToken](#API_ListAccessPolicies_RequestSyntax) **   <a name="iotsitewise-ListAccessPolicies-request-uri-nextToken"></a>
The token to be used for the next set of paginated results.  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

 ** [resourceId](#API_ListAccessPolicies_RequestSyntax) **   <a name="iotsitewise-ListAccessPolicies-request-uri-resourceId"></a>
The ID of the resource. This parameter is required if you specify `resourceType`.  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

 ** [resourceType](#API_ListAccessPolicies_RequestSyntax) **   <a name="iotsitewise-ListAccessPolicies-request-uri-resourceType"></a>
The type of resource (portal or project). This parameter is required if you specify `resourceId`.  
Valid Values: `PORTAL | PROJECT` 

## Request Body
<a name="API_ListAccessPolicies_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListAccessPolicies_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "accessPolicySummaries": [ 
      { 
         "creationDate": number,
         "id": "string",
         "identity": { 
            "group": { 
               "id": "string"
            },
            "iamRole": { 
               "arn": "string"
            },
            "iamUser": { 
               "arn": "string"
            },
            "user": { 
               "id": "string"
            }
         },
         "lastUpdateDate": number,
         "permission": "string",
         "resource": { 
            "portal": { 
               "id": "string"
            },
            "project": { 
               "id": "string"
            }
         }
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListAccessPolicies_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [accessPolicySummaries](#API_ListAccessPolicies_ResponseSyntax) **   <a name="iotsitewise-ListAccessPolicies-response-accessPolicySummaries"></a>
A list that summarizes each access policy.  
Type: Array of [AccessPolicySummary](API_AccessPolicySummary.md) objects

 ** [nextToken](#API_ListAccessPolicies_ResponseSyntax) **   <a name="iotsitewise-ListAccessPolicies-response-nextToken"></a>
The token for the next set of results, or null if there are no additional results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

## Errors
<a name="API_ListAccessPolicies_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_ListAccessPolicies_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/ListAccessPolicies) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/ListAccessPolicies) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/ListAccessPolicies) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/ListAccessPolicies) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/ListAccessPolicies) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/ListAccessPolicies) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/ListAccessPolicies) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/ListAccessPolicies) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/ListAccessPolicies) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/ListAccessPolicies) 

# ListActions
<a name="API_ListActions"></a>

Retrieves a paginated list of actions for a specific target resource.

## Request Syntax
<a name="API_ListActions_RequestSyntax"></a>

```
GET /actions?maxResults=maxResults&nextToken=nextToken&resolveToResourceId=resolveToResourceId&resolveToResourceType=resolveToResourceType&targetResourceId=targetResourceId&targetResourceType=targetResourceType HTTP/1.1
```

## URI Request Parameters
<a name="API_ListActions_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_ListActions_RequestSyntax) **   <a name="iotsitewise-ListActions-request-uri-maxResults"></a>
The maximum number of results to return for each paginated request.  
Valid Range: Minimum value of 1. Maximum value of 250.

 ** [nextToken](#API_ListActions_RequestSyntax) **   <a name="iotsitewise-ListActions-request-uri-nextToken"></a>
The token to be used for the next set of paginated results.  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

 ** [resolveToResourceId](#API_ListActions_RequestSyntax) **   <a name="iotsitewise-ListActions-request-uri-resolveToResourceId"></a>
The ID of the resolved resource.  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

 ** [resolveToResourceType](#API_ListActions_RequestSyntax) **   <a name="iotsitewise-ListActions-request-uri-resolveToResourceType"></a>
The type of the resolved resource.  
Valid Values: `ASSET` 

 ** [targetResourceId](#API_ListActions_RequestSyntax) **   <a name="iotsitewise-ListActions-request-uri-targetResourceId"></a>
The ID of the target resource.  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`   
Required: Yes

 ** [targetResourceType](#API_ListActions_RequestSyntax) **   <a name="iotsitewise-ListActions-request-uri-targetResourceType"></a>
The type of resource.  
Valid Values: `ASSET | COMPUTATION_MODEL`   
Required: Yes

## Request Body
<a name="API_ListActions_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListActions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "actionSummaries": [ 
      { 
         "actionDefinitionId": "string",
         "actionId": "string",
         "resolveTo": { 
            "assetId": "string"
         },
         "targetResource": { 
            "assetId": "string",
            "computationModelId": "string"
         }
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListActions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [actionSummaries](#API_ListActions_ResponseSyntax) **   <a name="iotsitewise-ListActions-response-actionSummaries"></a>
A list that summarizes the actions associated with the specified asset.  
Type: Array of [ActionSummary](API_ActionSummary.md) objects

 ** [nextToken](#API_ListActions_ResponseSyntax) **   <a name="iotsitewise-ListActions-response-nextToken"></a>
The token for the next set of results, or null if there are no additional results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

## Errors
<a name="API_ListActions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_ListActions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/ListActions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/ListActions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/ListActions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/ListActions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/ListActions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/ListActions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/ListActions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/ListActions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/ListActions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/ListActions) 

# ListAssetModelCompositeModels
<a name="API_ListAssetModelCompositeModels"></a>

Retrieves a paginated list of composite models associated with the asset model

## Request Syntax
<a name="API_ListAssetModelCompositeModels_RequestSyntax"></a>

```
GET /asset-models/assetModelId/composite-models?assetModelVersion=assetModelVersion&maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListAssetModelCompositeModels_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assetModelId](#API_ListAssetModelCompositeModels_RequestSyntax) **   <a name="iotsitewise-ListAssetModelCompositeModels-request-uri-assetModelId"></a>
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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) in the * AWS IoT SiteWise User Guide*.  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+`   
Required: Yes

 ** [assetModelVersion](#API_ListAssetModelCompositeModels_RequestSyntax) **   <a name="iotsitewise-ListAssetModelCompositeModels-request-uri-assetModelVersion"></a>
The version alias that specifies the latest or active version of the asset model. The details are returned in the response. The default value is `LATEST`. See [ Asset model versions](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/model-active-version.html) in the * AWS IoT SiteWise User Guide*.  
Pattern: `^(LATEST|ACTIVE)$` 

 ** [maxResults](#API_ListAssetModelCompositeModels_RequestSyntax) **   <a name="iotsitewise-ListAssetModelCompositeModels-request-uri-maxResults"></a>
The maximum number of results to return for each paginated request.  
Default: 50  
Valid Range: Minimum value of 1. Maximum value of 250.

 ** [nextToken](#API_ListAssetModelCompositeModels_RequestSyntax) **   <a name="iotsitewise-ListAssetModelCompositeModels-request-uri-nextToken"></a>
The token to be used for the next set of paginated results.  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

## Request Body
<a name="API_ListAssetModelCompositeModels_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListAssetModelCompositeModels_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "assetModelCompositeModelSummaries": [ 
      { 
         "description": "string",
         "externalId": "string",
         "id": "string",
         "name": "string",
         "path": [ 
            { 
               "id": "string",
               "name": "string"
            }
         ],
         "type": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListAssetModelCompositeModels_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [assetModelCompositeModelSummaries](#API_ListAssetModelCompositeModels_ResponseSyntax) **   <a name="iotsitewise-ListAssetModelCompositeModels-response-assetModelCompositeModelSummaries"></a>
A list that summarizes each composite model.  
Type: Array of [AssetModelCompositeModelSummary](API_AssetModelCompositeModelSummary.md) objects

 ** [nextToken](#API_ListAssetModelCompositeModels_ResponseSyntax) **   <a name="iotsitewise-ListAssetModelCompositeModels-response-nextToken"></a>
The token for the next set of results, or null if there are no additional results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

## Errors
<a name="API_ListAssetModelCompositeModels_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_ListAssetModelCompositeModels_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/ListAssetModelCompositeModels) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/ListAssetModelCompositeModels) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/ListAssetModelCompositeModels) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/ListAssetModelCompositeModels) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/ListAssetModelCompositeModels) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/ListAssetModelCompositeModels) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/ListAssetModelCompositeModels) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/ListAssetModelCompositeModels) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/ListAssetModelCompositeModels) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/ListAssetModelCompositeModels) 

# ListAssetModelProperties
<a name="API_ListAssetModelProperties"></a>

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.

## Request Syntax
<a name="API_ListAssetModelProperties_RequestSyntax"></a>

```
GET /asset-models/assetModelId/properties?assetModelVersion=assetModelVersion&filter=filter&maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListAssetModelProperties_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assetModelId](#API_ListAssetModelProperties_RequestSyntax) **   <a name="iotsitewise-ListAssetModelProperties-request-uri-assetModelId"></a>
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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) in the * AWS IoT SiteWise User Guide*.  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+`   
Required: Yes

 ** [assetModelVersion](#API_ListAssetModelProperties_RequestSyntax) **   <a name="iotsitewise-ListAssetModelProperties-request-uri-assetModelVersion"></a>
The version alias that specifies the latest or active version of the asset model. The details are returned in the response. The default value is `LATEST`. See [ Asset model versions](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/model-active-version.html) in the * AWS IoT SiteWise User Guide*.  
Pattern: `^(LATEST|ACTIVE)$` 

 ** [filter](#API_ListAssetModelProperties_RequestSyntax) **   <a name="iotsitewise-ListAssetModelProperties-request-uri-filter"></a>
 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`   
Valid Values: `ALL | BASE` 

 ** [maxResults](#API_ListAssetModelProperties_RequestSyntax) **   <a name="iotsitewise-ListAssetModelProperties-request-uri-maxResults"></a>
The maximum number of results to return for each paginated request. If not specified, the default value is 50.  
Valid Range: Minimum value of 1. Maximum value of 250.

 ** [nextToken](#API_ListAssetModelProperties_RequestSyntax) **   <a name="iotsitewise-ListAssetModelProperties-request-uri-nextToken"></a>
The token to be used for the next set of paginated results.  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

## Request Body
<a name="API_ListAssetModelProperties_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListAssetModelProperties_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "assetModelPropertySummaries": [ 
      { 
         "assetModelCompositeModelId": "string",
         "dataType": "string",
         "dataTypeSpec": "string",
         "externalId": "string",
         "id": "string",
         "interfaceSummaries": [ 
            { 
               "interfaceAssetModelId": "string",
               "interfaceAssetModelPropertyId": "string"
            }
         ],
         "name": "string",
         "path": [ 
            { 
               "id": "string",
               "name": "string"
            }
         ],
         "type": { 
            "attribute": { 
               "defaultValue": "string"
            },
            "measurement": { 
               "processingConfig": { 
                  "forwardingConfig": { 
                     "state": "string"
                  }
               }
            },
            "metric": { 
               "expression": "string",
               "processingConfig": { 
                  "computeLocation": "string"
               },
               "variables": [ 
                  { 
                     "name": "string",
                     "value": { 
                        "hierarchyId": "string",
                        "propertyId": "string",
                        "propertyPath": [ 
                           { 
                              "id": "string",
                              "name": "string"
                           }
                        ]
                     }
                  }
               ],
               "window": { 
                  "tumbling": { 
                     "interval": "string",
                     "offset": "string"
                  }
               }
            },
            "transform": { 
               "expression": "string",
               "processingConfig": { 
                  "computeLocation": "string",
                  "forwardingConfig": { 
                     "state": "string"
                  }
               },
               "variables": [ 
                  { 
                     "name": "string",
                     "value": { 
                        "hierarchyId": "string",
                        "propertyId": "string",
                        "propertyPath": [ 
                           { 
                              "id": "string",
                              "name": "string"
                           }
                        ]
                     }
                  }
               ]
            }
         },
         "unit": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListAssetModelProperties_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [assetModelPropertySummaries](#API_ListAssetModelProperties_ResponseSyntax) **   <a name="iotsitewise-ListAssetModelProperties-response-assetModelPropertySummaries"></a>
A list that summarizes the properties associated with the specified asset model.  
Type: Array of [AssetModelPropertySummary](API_AssetModelPropertySummary.md) objects

 ** [nextToken](#API_ListAssetModelProperties_ResponseSyntax) **   <a name="iotsitewise-ListAssetModelProperties-response-nextToken"></a>
The token for the next set of results, or null if there are no additional results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

## Errors
<a name="API_ListAssetModelProperties_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_ListAssetModelProperties_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/ListAssetModelProperties) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/ListAssetModelProperties) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/ListAssetModelProperties) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/ListAssetModelProperties) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/ListAssetModelProperties) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/ListAssetModelProperties) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/ListAssetModelProperties) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/ListAssetModelProperties) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/ListAssetModelProperties) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/ListAssetModelProperties) 

# ListAssetModels
<a name="API_ListAssetModels"></a>

Retrieves a paginated list of summaries of all asset models.

## Request Syntax
<a name="API_ListAssetModels_RequestSyntax"></a>

```
GET /asset-models?assetModelTypes=assetModelTypes&assetModelVersion=assetModelVersion&maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListAssetModels_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assetModelTypes](#API_ListAssetModels_RequestSyntax) **   <a name="iotsitewise-ListAssetModels-request-uri-assetModelTypes"></a>
The type of asset model. If you don't provide an `assetModelTypes`, all types of asset models are returned.  
+  **ASSET\$1MODEL** – An asset model that you can use to create assets. Can't be included as a component in another asset model.
+  **COMPONENT\$1MODEL** – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model. 
+  **INTERFACE** – An interface is a type of model that defines a standard structure that can be applied to different asset models.
Valid Values: `ASSET_MODEL | COMPONENT_MODEL | INTERFACE` 

 ** [assetModelVersion](#API_ListAssetModels_RequestSyntax) **   <a name="iotsitewise-ListAssetModels-request-uri-assetModelVersion"></a>
The version alias that specifies the latest or active version of the asset model. The details are returned in the response. The default value is `LATEST`. See [ Asset model versions](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/model-active-version.html) in the * AWS IoT SiteWise User Guide*.  
Pattern: `^(LATEST|ACTIVE)$` 

 ** [maxResults](#API_ListAssetModels_RequestSyntax) **   <a name="iotsitewise-ListAssetModels-request-uri-maxResults"></a>
The maximum number of results to return for each paginated request.  
Default: 50  
Valid Range: Minimum value of 1. Maximum value of 250.

 ** [nextToken](#API_ListAssetModels_RequestSyntax) **   <a name="iotsitewise-ListAssetModels-request-uri-nextToken"></a>
The token to be used for the next set of paginated results.  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

## Request Body
<a name="API_ListAssetModels_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListAssetModels_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "assetModelSummaries": [ 
      { 
         "arn": "string",
         "assetModelType": "string",
         "creationDate": number,
         "description": "string",
         "externalId": "string",
         "id": "string",
         "lastUpdateDate": number,
         "name": "string",
         "status": { 
            "error": { 
               "code": "string",
               "details": [ 
                  { 
                     "code": "string",
                     "message": "string"
                  }
               ],
               "message": "string"
            },
            "state": "string"
         },
         "version": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListAssetModels_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [assetModelSummaries](#API_ListAssetModels_ResponseSyntax) **   <a name="iotsitewise-ListAssetModels-response-assetModelSummaries"></a>
A list that summarizes each asset model.  
Type: Array of [AssetModelSummary](API_AssetModelSummary.md) objects

 ** [nextToken](#API_ListAssetModels_ResponseSyntax) **   <a name="iotsitewise-ListAssetModels-response-nextToken"></a>
The token for the next set of results, or null if there are no additional results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

## Errors
<a name="API_ListAssetModels_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_ListAssetModels_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/ListAssetModels) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/ListAssetModels) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/ListAssetModels) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/ListAssetModels) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/ListAssetModels) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/ListAssetModels) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/ListAssetModels) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/ListAssetModels) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/ListAssetModels) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/ListAssetModels) 

# ListAssetProperties
<a name="API_ListAssetProperties"></a>

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.

## Request Syntax
<a name="API_ListAssetProperties_RequestSyntax"></a>

```
GET /assets/assetId/properties?filter=filter&maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListAssetProperties_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assetId](#API_ListAssetProperties_RequestSyntax) **   <a name="iotsitewise-ListAssetProperties-request-uri-assetId"></a>
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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) in the * AWS IoT SiteWise User Guide*.  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+`   
Required: Yes

 ** [filter](#API_ListAssetProperties_RequestSyntax) **   <a name="iotsitewise-ListAssetProperties-request-uri-filter"></a>
 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`   
Valid Values: `ALL | BASE` 

 ** [maxResults](#API_ListAssetProperties_RequestSyntax) **   <a name="iotsitewise-ListAssetProperties-request-uri-maxResults"></a>
The maximum number of results to return for each paginated request. If not specified, the default value is 50.  
Valid Range: Minimum value of 1. Maximum value of 250.

 ** [nextToken](#API_ListAssetProperties_RequestSyntax) **   <a name="iotsitewise-ListAssetProperties-request-uri-nextToken"></a>
The token to be used for the next set of paginated results.  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

## Request Body
<a name="API_ListAssetProperties_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListAssetProperties_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "assetPropertySummaries": [ 
      { 
         "alias": "string",
         "assetCompositeModelId": "string",
         "externalId": "string",
         "id": "string",
         "notification": { 
            "state": "string",
            "topic": "string"
         },
         "path": [ 
            { 
               "id": "string",
               "name": "string"
            }
         ],
         "unit": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListAssetProperties_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [assetPropertySummaries](#API_ListAssetProperties_ResponseSyntax) **   <a name="iotsitewise-ListAssetProperties-response-assetPropertySummaries"></a>
A list that summarizes the properties associated with the specified asset.  
Type: Array of [AssetPropertySummary](API_AssetPropertySummary.md) objects

 ** [nextToken](#API_ListAssetProperties_ResponseSyntax) **   <a name="iotsitewise-ListAssetProperties-response-nextToken"></a>
The token for the next set of results, or null if there are no additional results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

## Errors
<a name="API_ListAssetProperties_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_ListAssetProperties_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/ListAssetProperties) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/ListAssetProperties) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/ListAssetProperties) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/ListAssetProperties) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/ListAssetProperties) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/ListAssetProperties) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/ListAssetProperties) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/ListAssetProperties) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/ListAssetProperties) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/ListAssetProperties) 

# ListAssetRelationships
<a name="API_ListAssetRelationships"></a>

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.

## Request Syntax
<a name="API_ListAssetRelationships_RequestSyntax"></a>

```
GET /assets/assetId/assetRelationships?maxResults=maxResults&nextToken=nextToken&traversalType=traversalType HTTP/1.1
```

## URI Request Parameters
<a name="API_ListAssetRelationships_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assetId](#API_ListAssetRelationships_RequestSyntax) **   <a name="iotsitewise-ListAssetRelationships-request-uri-assetId"></a>
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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) in the * AWS IoT SiteWise User Guide*.  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+`   
Required: Yes

 ** [maxResults](#API_ListAssetRelationships_RequestSyntax) **   <a name="iotsitewise-ListAssetRelationships-request-uri-maxResults"></a>
The maximum number of results to return for each paginated request.  
Valid Range: Minimum value of 1. Maximum value of 250.

 ** [nextToken](#API_ListAssetRelationships_RequestSyntax) **   <a name="iotsitewise-ListAssetRelationships-request-uri-nextToken"></a>
The token to be used for the next set of paginated results.  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

 ** [traversalType](#API_ListAssetRelationships_RequestSyntax) **   <a name="iotsitewise-ListAssetRelationships-request-uri-traversalType"></a>
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.
Valid Values: `PATH_TO_ROOT`   
Required: Yes

## Request Body
<a name="API_ListAssetRelationships_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListAssetRelationships_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "assetRelationshipSummaries": [ 
      { 
         "hierarchyInfo": { 
            "childAssetId": "string",
            "parentAssetId": "string"
         },
         "relationshipType": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListAssetRelationships_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [assetRelationshipSummaries](#API_ListAssetRelationships_ResponseSyntax) **   <a name="iotsitewise-ListAssetRelationships-response-assetRelationshipSummaries"></a>
A list that summarizes each asset relationship.  
Type: Array of [AssetRelationshipSummary](API_AssetRelationshipSummary.md) objects

 ** [nextToken](#API_ListAssetRelationships_ResponseSyntax) **   <a name="iotsitewise-ListAssetRelationships-response-nextToken"></a>
The token for the next set of results, or null if there are no additional results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

## Errors
<a name="API_ListAssetRelationships_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_ListAssetRelationships_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/ListAssetRelationships) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/ListAssetRelationships) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/ListAssetRelationships) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/ListAssetRelationships) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/ListAssetRelationships) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/ListAssetRelationships) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/ListAssetRelationships) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/ListAssetRelationships) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/ListAssetRelationships) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/ListAssetRelationships) 

# ListAssets
<a name="API_ListAssets"></a>

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](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_ListAssetModels.html) to get all of your asset model IDs. Then, use ListAssets to get all assets for each asset model.

## Request Syntax
<a name="API_ListAssets_RequestSyntax"></a>

```
GET /assets?assetModelId=assetModelId&filter=filter&maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListAssets_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assetModelId](#API_ListAssets_RequestSyntax) **   <a name="iotsitewise-ListAssets-request-uri-assetModelId"></a>
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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) in the * AWS IoT SiteWise User Guide*.  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+` 

 ** [filter](#API_ListAssets_RequestSyntax) **   <a name="iotsitewise-ListAssets-request-uri-filter"></a>
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`   
Valid Values: `ALL | TOP_LEVEL` 

 ** [maxResults](#API_ListAssets_RequestSyntax) **   <a name="iotsitewise-ListAssets-request-uri-maxResults"></a>
The maximum number of results to return for each paginated request.  
Default: 50  
Valid Range: Minimum value of 1. Maximum value of 250.

 ** [nextToken](#API_ListAssets_RequestSyntax) **   <a name="iotsitewise-ListAssets-request-uri-nextToken"></a>
The token to be used for the next set of paginated results.  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

## Request Body
<a name="API_ListAssets_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListAssets_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "assetSummaries": [ 
      { 
         "arn": "string",
         "assetModelId": "string",
         "creationDate": number,
         "description": "string",
         "externalId": "string",
         "hierarchies": [ 
            { 
               "externalId": "string",
               "id": "string",
               "name": "string"
            }
         ],
         "id": "string",
         "lastUpdateDate": number,
         "name": "string",
         "status": { 
            "error": { 
               "code": "string",
               "details": [ 
                  { 
                     "code": "string",
                     "message": "string"
                  }
               ],
               "message": "string"
            },
            "state": "string"
         }
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListAssets_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [assetSummaries](#API_ListAssets_ResponseSyntax) **   <a name="iotsitewise-ListAssets-response-assetSummaries"></a>
A list that summarizes each asset.  
Type: Array of [AssetSummary](API_AssetSummary.md) objects

 ** [nextToken](#API_ListAssets_ResponseSyntax) **   <a name="iotsitewise-ListAssets-response-nextToken"></a>
The token for the next set of results, or null if there are no additional results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

## Errors
<a name="API_ListAssets_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_ListAssets_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/ListAssets) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/ListAssets) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/ListAssets) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/ListAssets) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/ListAssets) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/ListAssets) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/ListAssets) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/ListAssets) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/ListAssets) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/ListAssets) 

# ListAssociatedAssets
<a name="API_ListAssociatedAssets"></a>

Retrieves a paginated list of associated assets.

You can use this operation to do the following:
+  `CHILD` - List all child assets associated to the asset.
+  `PARENT` - List the asset's parent asset.

## Request Syntax
<a name="API_ListAssociatedAssets_RequestSyntax"></a>

```
GET /assets/assetId/hierarchies?hierarchyId=hierarchyId&maxResults=maxResults&nextToken=nextToken&traversalDirection=traversalDirection HTTP/1.1
```

## URI Request Parameters
<a name="API_ListAssociatedAssets_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assetId](#API_ListAssociatedAssets_RequestSyntax) **   <a name="iotsitewise-ListAssociatedAssets-request-uri-assetId"></a>
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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) in the * AWS IoT SiteWise User Guide*.  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+`   
Required: Yes

 ** [hierarchyId](#API_ListAssociatedAssets_RequestSyntax) **   <a name="iotsitewise-ListAssociatedAssets-request-uri-hierarchyId"></a>
(Optional) If you don't provide a `hierarchyId`, all the immediate assets in the `traversalDirection` will be returned.   
 The ID of the hierarchy by which child assets are associated to the asset. (This can be either the actual ID in UUID format, or else `externalId:` followed by the external ID, if it has one. For more information, see [Referencing objects with external IDs](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) in the * AWS IoT SiteWise User Guide*.)  
For more information, see [Asset hierarchies](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html) in the * AWS IoT SiteWise User Guide*.  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+` 

 ** [maxResults](#API_ListAssociatedAssets_RequestSyntax) **   <a name="iotsitewise-ListAssociatedAssets-request-uri-maxResults"></a>
The maximum number of results to return for each paginated request.  
Default: 50  
Valid Range: Minimum value of 1. Maximum value of 250.

 ** [nextToken](#API_ListAssociatedAssets_RequestSyntax) **   <a name="iotsitewise-ListAssociatedAssets-request-uri-nextToken"></a>
The token to be used for the next set of paginated results.  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

 ** [traversalDirection](#API_ListAssociatedAssets_RequestSyntax) **   <a name="iotsitewise-ListAssociatedAssets-request-uri-traversalDirection"></a>
The direction to list associated assets. Choose one of the following options:  
+  `CHILD` – The list includes all child assets associated to the asset.
+  `PARENT` – The list includes the asset's parent asset.
Default: `CHILD`   
Valid Values: `PARENT | CHILD` 

## Request Body
<a name="API_ListAssociatedAssets_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListAssociatedAssets_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "assetSummaries": [ 
      { 
         "arn": "string",
         "assetModelId": "string",
         "creationDate": number,
         "description": "string",
         "externalId": "string",
         "hierarchies": [ 
            { 
               "externalId": "string",
               "id": "string",
               "name": "string"
            }
         ],
         "id": "string",
         "lastUpdateDate": number,
         "name": "string",
         "status": { 
            "error": { 
               "code": "string",
               "details": [ 
                  { 
                     "code": "string",
                     "message": "string"
                  }
               ],
               "message": "string"
            },
            "state": "string"
         }
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListAssociatedAssets_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [assetSummaries](#API_ListAssociatedAssets_ResponseSyntax) **   <a name="iotsitewise-ListAssociatedAssets-response-assetSummaries"></a>
A list that summarizes the associated assets.  
Type: Array of [AssociatedAssetsSummary](API_AssociatedAssetsSummary.md) objects

 ** [nextToken](#API_ListAssociatedAssets_ResponseSyntax) **   <a name="iotsitewise-ListAssociatedAssets-response-nextToken"></a>
The token for the next set of results, or null if there are no additional results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

## Errors
<a name="API_ListAssociatedAssets_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_ListAssociatedAssets_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/ListAssociatedAssets) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/ListAssociatedAssets) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/ListAssociatedAssets) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/ListAssociatedAssets) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/ListAssociatedAssets) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/ListAssociatedAssets) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/ListAssociatedAssets) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/ListAssociatedAssets) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/ListAssociatedAssets) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/ListAssociatedAssets) 

# ListBulkImportJobs
<a name="API_ListBulkImportJobs"></a>

Retrieves a paginated list of bulk import job requests. For more information, see [List bulk import jobs (AWS CLI)](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/ListBulkImportJobs.html) in the * AWS IoT SiteWise User Guide*.

## Request Syntax
<a name="API_ListBulkImportJobs_RequestSyntax"></a>

```
GET /jobs?filter=filter&maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListBulkImportJobs_RequestParameters"></a>

The request uses the following URI parameters.

 ** [filter](#API_ListBulkImportJobs_RequestSyntax) **   <a name="iotsitewise-ListBulkImportJobs-request-uri-filter"></a>
You can use a filter to select the bulk import jobs that you want to retrieve.  
Valid Values: `ALL | PENDING | RUNNING | CANCELLED | FAILED | COMPLETED_WITH_FAILURES | COMPLETED` 

 ** [maxResults](#API_ListBulkImportJobs_RequestSyntax) **   <a name="iotsitewise-ListBulkImportJobs-request-uri-maxResults"></a>
The maximum number of results to return for each paginated request.  
Valid Range: Minimum value of 1. Maximum value of 250.

 ** [nextToken](#API_ListBulkImportJobs_RequestSyntax) **   <a name="iotsitewise-ListBulkImportJobs-request-uri-nextToken"></a>
The token to be used for the next set of paginated results.  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

## Request Body
<a name="API_ListBulkImportJobs_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListBulkImportJobs_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "jobSummaries": [ 
      { 
         "id": "string",
         "name": "string",
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListBulkImportJobs_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [jobSummaries](#API_ListBulkImportJobs_ResponseSyntax) **   <a name="iotsitewise-ListBulkImportJobs-response-jobSummaries"></a>
One or more job summaries to list.  
Type: Array of [JobSummary](API_JobSummary.md) objects

 ** [nextToken](#API_ListBulkImportJobs_ResponseSyntax) **   <a name="iotsitewise-ListBulkImportJobs-response-nextToken"></a>
The token for the next set of results, or null if there are no additional results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

## Errors
<a name="API_ListBulkImportJobs_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_ListBulkImportJobs_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/ListBulkImportJobs) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/ListBulkImportJobs) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/ListBulkImportJobs) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/ListBulkImportJobs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/ListBulkImportJobs) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/ListBulkImportJobs) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/ListBulkImportJobs) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/ListBulkImportJobs) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/ListBulkImportJobs) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/ListBulkImportJobs) 

# ListCompositionRelationships
<a name="API_ListCompositionRelationships"></a>

Retrieves a paginated list of composition relationships for an asset model of type `COMPONENT_MODEL`.

## Request Syntax
<a name="API_ListCompositionRelationships_RequestSyntax"></a>

```
GET /asset-models/assetModelId/composition-relationships?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListCompositionRelationships_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assetModelId](#API_ListCompositionRelationships_RequestSyntax) **   <a name="iotsitewise-ListCompositionRelationships-request-uri-assetModelId"></a>
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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) in the * AWS IoT SiteWise User Guide*.  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`   
Required: Yes

 ** [maxResults](#API_ListCompositionRelationships_RequestSyntax) **   <a name="iotsitewise-ListCompositionRelationships-request-uri-maxResults"></a>
The maximum number of results to return for each paginated request.  
Default: 50  
Valid Range: Minimum value of 1. Maximum value of 250.

 ** [nextToken](#API_ListCompositionRelationships_RequestSyntax) **   <a name="iotsitewise-ListCompositionRelationships-request-uri-nextToken"></a>
The token to be used for the next set of paginated results.  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

## Request Body
<a name="API_ListCompositionRelationships_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListCompositionRelationships_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "compositionRelationshipSummaries": [ 
      { 
         "assetModelCompositeModelId": "string",
         "assetModelCompositeModelType": "string",
         "assetModelId": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListCompositionRelationships_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [compositionRelationshipSummaries](#API_ListCompositionRelationships_ResponseSyntax) **   <a name="iotsitewise-ListCompositionRelationships-response-compositionRelationshipSummaries"></a>
A list that summarizes each composition relationship.  
Type: Array of [CompositionRelationshipSummary](API_CompositionRelationshipSummary.md) objects

 ** [nextToken](#API_ListCompositionRelationships_ResponseSyntax) **   <a name="iotsitewise-ListCompositionRelationships-response-nextToken"></a>
The token for the next set of results, or null if there are no additional results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

## Errors
<a name="API_ListCompositionRelationships_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_ListCompositionRelationships_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/ListCompositionRelationships) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/ListCompositionRelationships) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/ListCompositionRelationships) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/ListCompositionRelationships) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/ListCompositionRelationships) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/ListCompositionRelationships) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/ListCompositionRelationships) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/ListCompositionRelationships) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/ListCompositionRelationships) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/ListCompositionRelationships) 

# ListComputationModelDataBindingUsages
<a name="API_ListComputationModelDataBindingUsages"></a>

 Lists all data binding usages for computation models. This allows to identify where specific data bindings are being utilized across the computation models. This track dependencies between data sources and computation models. 

## Request Syntax
<a name="API_ListComputationModelDataBindingUsages_RequestSyntax"></a>

```
POST /computation-models/data-binding-usages HTTP/1.1
Content-type: application/json

{
   "dataBindingValueFilter": { 
      "asset": { 
         "assetId": "string"
      },
      "assetModel": { 
         "assetModelId": "string"
      },
      "assetModelProperty": { 
         "assetModelId": "string",
         "propertyId": "string"
      },
      "assetProperty": { 
         "assetId": "string",
         "propertyId": "string"
      }
   },
   "maxResults": number,
   "nextToken": "string"
}
```

## URI Request Parameters
<a name="API_ListComputationModelDataBindingUsages_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_ListComputationModelDataBindingUsages_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [dataBindingValueFilter](#API_ListComputationModelDataBindingUsages_RequestSyntax) **   <a name="iotsitewise-ListComputationModelDataBindingUsages-request-dataBindingValueFilter"></a>
A filter used to limit the returned data binding usages based on specific data binding values. You can filter by asset, asset model, asset property, or asset model property to find all computation models using these specific data sources.  
Type: [DataBindingValueFilter](API_DataBindingValueFilter.md) object  
Required: Yes

 ** [maxResults](#API_ListComputationModelDataBindingUsages_RequestSyntax) **   <a name="iotsitewise-ListComputationModelDataBindingUsages-request-maxResults"></a>
The maximum number of results returned for each paginated request.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 250.  
Required: No

 ** [nextToken](#API_ListComputationModelDataBindingUsages_RequestSyntax) **   <a name="iotsitewise-ListComputationModelDataBindingUsages-request-nextToken"></a>
The token used for the next set of paginated results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+`   
Required: No

## Response Syntax
<a name="API_ListComputationModelDataBindingUsages_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "dataBindingUsageSummaries": [ 
      { 
         "computationModelIds": [ "string" ],
         "matchedDataBinding": { 
            "value": { 
               "assetModelProperty": { 
                  "assetModelId": "string",
                  "propertyId": "string"
               },
               "assetProperty": { 
                  "assetId": "string",
                  "propertyId": "string"
               }
            }
         }
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListComputationModelDataBindingUsages_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [dataBindingUsageSummaries](#API_ListComputationModelDataBindingUsages_ResponseSyntax) **   <a name="iotsitewise-ListComputationModelDataBindingUsages-response-dataBindingUsageSummaries"></a>
A list of summaries describing the data binding usages across computation models. Each summary includes the computation model IDs and the matched data binding details.  
Type: Array of [ComputationModelDataBindingUsageSummary](API_ComputationModelDataBindingUsageSummary.md) objects

 ** [nextToken](#API_ListComputationModelDataBindingUsages_ResponseSyntax) **   <a name="iotsitewise-ListComputationModelDataBindingUsages-response-nextToken"></a>
The token for the next set of paginated results, or null if there are no additional results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

## Errors
<a name="API_ListComputationModelDataBindingUsages_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_ListComputationModelDataBindingUsages_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/ListComputationModelDataBindingUsages) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/ListComputationModelDataBindingUsages) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/ListComputationModelDataBindingUsages) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/ListComputationModelDataBindingUsages) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/ListComputationModelDataBindingUsages) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/ListComputationModelDataBindingUsages) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/ListComputationModelDataBindingUsages) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/ListComputationModelDataBindingUsages) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/ListComputationModelDataBindingUsages) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/ListComputationModelDataBindingUsages) 

# ListComputationModelResolveToResources
<a name="API_ListComputationModelResolveToResources"></a>

Lists all distinct resources that are resolved from the executed actions of the computation model.

## Request Syntax
<a name="API_ListComputationModelResolveToResources_RequestSyntax"></a>

```
GET /computation-models/computationModelId/resolve-to-resources?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListComputationModelResolveToResources_RequestParameters"></a>

The request uses the following URI parameters.

 ** [computationModelId](#API_ListComputationModelResolveToResources_RequestSyntax) **   <a name="iotsitewise-ListComputationModelResolveToResources-request-uri-computationModelId"></a>
The ID of the computation model for which to list resolved resources.  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`   
Required: Yes

 ** [maxResults](#API_ListComputationModelResolveToResources_RequestSyntax) **   <a name="iotsitewise-ListComputationModelResolveToResources-request-uri-maxResults"></a>
The maximum number of results returned for each paginated request.  
Valid Range: Minimum value of 1. Maximum value of 250.

 ** [nextToken](#API_ListComputationModelResolveToResources_RequestSyntax) **   <a name="iotsitewise-ListComputationModelResolveToResources-request-uri-nextToken"></a>
The token used for the next set of paginated results.  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

## Request Body
<a name="API_ListComputationModelResolveToResources_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListComputationModelResolveToResources_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "computationModelResolveToResourceSummaries": [ 
      { 
         "resolveTo": { 
            "assetId": "string"
         }
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListComputationModelResolveToResources_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [computationModelResolveToResourceSummaries](#API_ListComputationModelResolveToResources_ResponseSyntax) **   <a name="iotsitewise-ListComputationModelResolveToResources-response-computationModelResolveToResourceSummaries"></a>
A list of summaries describing the distinct resources that this computation model resolves to when actions were executed.  
Type: Array of [ComputationModelResolveToResourceSummary](API_ComputationModelResolveToResourceSummary.md) objects

 ** [nextToken](#API_ListComputationModelResolveToResources_ResponseSyntax) **   <a name="iotsitewise-ListComputationModelResolveToResources-response-nextToken"></a>
The token for the next set of paginated results, or null if there are no additional results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

## Errors
<a name="API_ListComputationModelResolveToResources_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_ListComputationModelResolveToResources_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/ListComputationModelResolveToResources) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/ListComputationModelResolveToResources) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/ListComputationModelResolveToResources) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/ListComputationModelResolveToResources) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/ListComputationModelResolveToResources) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/ListComputationModelResolveToResources) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/ListComputationModelResolveToResources) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/ListComputationModelResolveToResources) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/ListComputationModelResolveToResources) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/ListComputationModelResolveToResources) 

# ListComputationModels
<a name="API_ListComputationModels"></a>

Retrieves a paginated list of summaries of all computation models.

## Request Syntax
<a name="API_ListComputationModels_RequestSyntax"></a>

```
GET /computation-models?computationModelType=computationModelType&maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListComputationModels_RequestParameters"></a>

The request uses the following URI parameters.

 ** [computationModelType](#API_ListComputationModels_RequestSyntax) **   <a name="iotsitewise-ListComputationModels-request-uri-computationModelType"></a>
The type of computation model. If a `computationModelType` is not provided, all types of computation models are returned.  
Valid Values: `ANOMALY_DETECTION` 

 ** [maxResults](#API_ListComputationModels_RequestSyntax) **   <a name="iotsitewise-ListComputationModels-request-uri-maxResults"></a>
The maximum number of results to return for each paginated request.  
Valid Range: Minimum value of 1. Maximum value of 250.

 ** [nextToken](#API_ListComputationModels_RequestSyntax) **   <a name="iotsitewise-ListComputationModels-request-uri-nextToken"></a>
The token to be used for the next set of paginated results.  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

## Request Body
<a name="API_ListComputationModels_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListComputationModels_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "computationModelSummaries": [ 
      { 
         "arn": "string",
         "creationDate": number,
         "description": "string",
         "id": "string",
         "lastUpdateDate": number,
         "name": "string",
         "status": { 
            "error": { 
               "code": "string",
               "details": [ 
                  { 
                     "code": "string",
                     "message": "string"
                  }
               ],
               "message": "string"
            },
            "state": "string"
         },
         "type": "string",
         "version": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListComputationModels_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [computationModelSummaries](#API_ListComputationModels_ResponseSyntax) **   <a name="iotsitewise-ListComputationModels-response-computationModelSummaries"></a>
A list summarizing each computation model.  
Type: Array of [ComputationModelSummary](API_ComputationModelSummary.md) objects

 ** [nextToken](#API_ListComputationModels_ResponseSyntax) **   <a name="iotsitewise-ListComputationModels-response-nextToken"></a>
The token for the next set of results, or null if there are no additional results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

## Errors
<a name="API_ListComputationModels_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_ListComputationModels_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/ListComputationModels) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/ListComputationModels) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/ListComputationModels) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/ListComputationModels) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/ListComputationModels) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/ListComputationModels) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/ListComputationModels) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/ListComputationModels) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/ListComputationModels) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/ListComputationModels) 

# ListDashboards
<a name="API_ListDashboards"></a>

Retrieves a paginated list of dashboards for an AWS IoT SiteWise Monitor project.

## Request Syntax
<a name="API_ListDashboards_RequestSyntax"></a>

```
GET /dashboards?maxResults=maxResults&nextToken=nextToken&projectId=projectId HTTP/1.1
```

## URI Request Parameters
<a name="API_ListDashboards_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_ListDashboards_RequestSyntax) **   <a name="iotsitewise-ListDashboards-request-uri-maxResults"></a>
The maximum number of results to return for each paginated request.  
Default: 50  
Valid Range: Minimum value of 1. Maximum value of 250.

 ** [nextToken](#API_ListDashboards_RequestSyntax) **   <a name="iotsitewise-ListDashboards-request-uri-nextToken"></a>
The token to be used for the next set of paginated results.  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

 ** [projectId](#API_ListDashboards_RequestSyntax) **   <a name="iotsitewise-ListDashboards-request-uri-projectId"></a>
The ID of the project.  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`   
Required: Yes

## Request Body
<a name="API_ListDashboards_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListDashboards_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "dashboardSummaries": [ 
      { 
         "creationDate": number,
         "description": "string",
         "id": "string",
         "lastUpdateDate": number,
         "name": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListDashboards_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [dashboardSummaries](#API_ListDashboards_ResponseSyntax) **   <a name="iotsitewise-ListDashboards-response-dashboardSummaries"></a>
A list that summarizes each dashboard in the project.  
Type: Array of [DashboardSummary](API_DashboardSummary.md) objects

 ** [nextToken](#API_ListDashboards_ResponseSyntax) **   <a name="iotsitewise-ListDashboards-response-nextToken"></a>
The token for the next set of results, or null if there are no additional results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

## Errors
<a name="API_ListDashboards_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_ListDashboards_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/ListDashboards) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/ListDashboards) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/ListDashboards) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/ListDashboards) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/ListDashboards) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/ListDashboards) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/ListDashboards) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/ListDashboards) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/ListDashboards) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/ListDashboards) 

# ListDatasets
<a name="API_ListDatasets"></a>

Retrieves a paginated list of datasets for a specific target resource.

## Request Syntax
<a name="API_ListDatasets_RequestSyntax"></a>

```
GET /datasets?maxResults=maxResults&nextToken=nextToken&sourceType=sourceType HTTP/1.1
```

## URI Request Parameters
<a name="API_ListDatasets_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_ListDatasets_RequestSyntax) **   <a name="iotsitewise-ListDatasets-request-uri-maxResults"></a>
The maximum number of results to return for each paginated request.  
Valid Range: Minimum value of 1. Maximum value of 250.

 ** [nextToken](#API_ListDatasets_RequestSyntax) **   <a name="iotsitewise-ListDatasets-request-uri-nextToken"></a>
The token for the next set of results, or null if there are no additional results.  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

 ** [sourceType](#API_ListDatasets_RequestSyntax) **   <a name="iotsitewise-ListDatasets-request-uri-sourceType"></a>
The type of data source for the dataset.  
Valid Values: `KENDRA`   
Required: Yes

## Request Body
<a name="API_ListDatasets_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListDatasets_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "datasetSummaries": [ 
      { 
         "arn": "string",
         "creationDate": number,
         "description": "string",
         "id": "string",
         "lastUpdateDate": number,
         "name": "string",
         "status": { 
            "error": { 
               "code": "string",
               "details": [ 
                  { 
                     "code": "string",
                     "message": "string"
                  }
               ],
               "message": "string"
            },
            "state": "string"
         }
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListDatasets_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [datasetSummaries](#API_ListDatasets_ResponseSyntax) **   <a name="iotsitewise-ListDatasets-response-datasetSummaries"></a>
A list that summarizes the dataset response.  
Type: Array of [DatasetSummary](API_DatasetSummary.md) objects

 ** [nextToken](#API_ListDatasets_ResponseSyntax) **   <a name="iotsitewise-ListDatasets-response-nextToken"></a>
The token for the next set of results, or null if there are no additional results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

## Errors
<a name="API_ListDatasets_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_ListDatasets_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/ListDatasets) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/ListDatasets) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/ListDatasets) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/ListDatasets) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/ListDatasets) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/ListDatasets) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/ListDatasets) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/ListDatasets) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/ListDatasets) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/ListDatasets) 

# ListExecutions
<a name="API_ListExecutions"></a>

Retrieves a paginated list of summaries of all executions.

## Request Syntax
<a name="API_ListExecutions_RequestSyntax"></a>

```
GET /executions?actionType=actionType&maxResults=maxResults&nextToken=nextToken&resolveToResourceId=resolveToResourceId&resolveToResourceType=resolveToResourceType&targetResourceId=targetResourceId&targetResourceType=targetResourceType HTTP/1.1
```

## URI Request Parameters
<a name="API_ListExecutions_RequestParameters"></a>

The request uses the following URI parameters.

 ** [actionType](#API_ListExecutions_RequestSyntax) **   <a name="iotsitewise-ListExecutions-request-uri-actionType"></a>
The type of action exectued.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[^\u0000-\u001F\u007F]+` 

 ** [maxResults](#API_ListExecutions_RequestSyntax) **   <a name="iotsitewise-ListExecutions-request-uri-maxResults"></a>
The maximum number of results returned for each paginated request.  
Valid Range: Minimum value of 1. Maximum value of 250.

 ** [nextToken](#API_ListExecutions_RequestSyntax) **   <a name="iotsitewise-ListExecutions-request-uri-nextToken"></a>
The token used for the next set of paginated results.  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

 ** [resolveToResourceId](#API_ListExecutions_RequestSyntax) **   <a name="iotsitewise-ListExecutions-request-uri-resolveToResourceId"></a>
The ID of the resolved resource.  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

 ** [resolveToResourceType](#API_ListExecutions_RequestSyntax) **   <a name="iotsitewise-ListExecutions-request-uri-resolveToResourceType"></a>
The type of the resolved resource.  
Valid Values: `ASSET` 

 ** [targetResourceId](#API_ListExecutions_RequestSyntax) **   <a name="iotsitewise-ListExecutions-request-uri-targetResourceId"></a>
The ID of the target resource.  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`   
Required: Yes

 ** [targetResourceType](#API_ListExecutions_RequestSyntax) **   <a name="iotsitewise-ListExecutions-request-uri-targetResourceType"></a>
The type of the target resource.  
Valid Values: `ASSET | COMPUTATION_MODEL`   
Required: Yes

## Request Body
<a name="API_ListExecutions_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListExecutions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "executionSummaries": [ 
      { 
         "actionType": "string",
         "executionEndTime": number,
         "executionEntityVersion": "string",
         "executionId": "string",
         "executionStartTime": number,
         "executionStatus": { 
            "state": "string"
         },
         "resolveTo": { 
            "assetId": "string"
         },
         "targetResource": { 
            "assetId": "string",
            "computationModelId": "string"
         },
         "targetResourceVersion": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListExecutions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [executionSummaries](#API_ListExecutions_ResponseSyntax) **   <a name="iotsitewise-ListExecutions-response-executionSummaries"></a>
Contains the list of execution summaries of the computation models.  
Type: Array of [ExecutionSummary](API_ExecutionSummary.md) objects

 ** [nextToken](#API_ListExecutions_ResponseSyntax) **   <a name="iotsitewise-ListExecutions-response-nextToken"></a>
The token for the next set of results, or null if there are no additional results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

## Errors
<a name="API_ListExecutions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_ListExecutions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/ListExecutions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/ListExecutions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/ListExecutions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/ListExecutions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/ListExecutions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/ListExecutions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/ListExecutions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/ListExecutions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/ListExecutions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/ListExecutions) 

# ListGateways
<a name="API_ListGateways"></a>

Retrieves a paginated list of gateways.

## Request Syntax
<a name="API_ListGateways_RequestSyntax"></a>

```
GET /20200301/gateways?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListGateways_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_ListGateways_RequestSyntax) **   <a name="iotsitewise-ListGateways-request-uri-maxResults"></a>
The maximum number of results to return for each paginated request.  
Default: 50  
Valid Range: Minimum value of 1. Maximum value of 250.

 ** [nextToken](#API_ListGateways_RequestSyntax) **   <a name="iotsitewise-ListGateways-request-uri-nextToken"></a>
The token to be used for the next set of paginated results.  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

## Request Body
<a name="API_ListGateways_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListGateways_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "gatewaySummaries": [ 
      { 
         "creationDate": number,
         "gatewayCapabilitySummaries": [ 
            { 
               "capabilityNamespace": "string",
               "capabilitySyncStatus": "string"
            }
         ],
         "gatewayId": "string",
         "gatewayName": "string",
         "gatewayPlatform": { 
            "greengrass": { 
               "groupArn": "string"
            },
            "greengrassV2": { 
               "coreDeviceOperatingSystem": "string",
               "coreDeviceThingName": "string"
            },
            "siemensIE": { 
               "iotCoreThingName": "string"
            }
         },
         "gatewayVersion": "string",
         "lastUpdateDate": number
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListGateways_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [gatewaySummaries](#API_ListGateways_ResponseSyntax) **   <a name="iotsitewise-ListGateways-response-gatewaySummaries"></a>
A list that summarizes each gateway.  
Type: Array of [GatewaySummary](API_GatewaySummary.md) objects

 ** [nextToken](#API_ListGateways_ResponseSyntax) **   <a name="iotsitewise-ListGateways-response-nextToken"></a>
The token for the next set of results, or null if there are no additional results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

## Errors
<a name="API_ListGateways_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_ListGateways_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/ListGateways) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/ListGateways) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/ListGateways) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/ListGateways) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/ListGateways) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/ListGateways) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/ListGateways) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/ListGateways) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/ListGateways) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/ListGateways) 

# ListInterfaceRelationships
<a name="API_ListInterfaceRelationships"></a>

Retrieves a paginated list of asset models that have a specific interface asset model applied to them.

## Request Syntax
<a name="API_ListInterfaceRelationships_RequestSyntax"></a>

```
GET /interface/interfaceAssetModelId/asset-models?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListInterfaceRelationships_RequestParameters"></a>

The request uses the following URI parameters.

 ** [interfaceAssetModelId](#API_ListInterfaceRelationships_RequestSyntax) **   <a name="iotsitewise-ListInterfaceRelationships-request-uri-interfaceAssetModelId"></a>
The ID of the interface asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID.  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+`   
Required: Yes

 ** [maxResults](#API_ListInterfaceRelationships_RequestSyntax) **   <a name="iotsitewise-ListInterfaceRelationships-request-uri-maxResults"></a>
The maximum number of results to return for each paginated request. Default: 50  
Valid Range: Minimum value of 1. Maximum value of 250.

 ** [nextToken](#API_ListInterfaceRelationships_RequestSyntax) **   <a name="iotsitewise-ListInterfaceRelationships-request-uri-nextToken"></a>
The token to be used for the next set of paginated results.  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

## Request Body
<a name="API_ListInterfaceRelationships_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListInterfaceRelationships_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "interfaceRelationshipSummaries": [ 
      { 
         "id": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListInterfaceRelationships_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [interfaceRelationshipSummaries](#API_ListInterfaceRelationships_ResponseSyntax) **   <a name="iotsitewise-ListInterfaceRelationships-response-interfaceRelationshipSummaries"></a>
A list that summarizes each interface relationship.  
Type: Array of [InterfaceRelationshipSummary](API_InterfaceRelationshipSummary.md) objects

 ** [nextToken](#API_ListInterfaceRelationships_ResponseSyntax) **   <a name="iotsitewise-ListInterfaceRelationships-response-nextToken"></a>
The token for the next set of results, or null if there are no additional results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

## Errors
<a name="API_ListInterfaceRelationships_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_ListInterfaceRelationships_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/ListInterfaceRelationships) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/ListInterfaceRelationships) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/ListInterfaceRelationships) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/ListInterfaceRelationships) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/ListInterfaceRelationships) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/ListInterfaceRelationships) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/ListInterfaceRelationships) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/ListInterfaceRelationships) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/ListInterfaceRelationships) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/ListInterfaceRelationships) 

# ListPortals
<a name="API_ListPortals"></a>

Retrieves a paginated list of AWS IoT SiteWise Monitor portals.

## Request Syntax
<a name="API_ListPortals_RequestSyntax"></a>

```
GET /portals?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListPortals_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_ListPortals_RequestSyntax) **   <a name="iotsitewise-ListPortals-request-uri-maxResults"></a>
The maximum number of results to return for each paginated request.  
Default: 50  
Valid Range: Minimum value of 1. Maximum value of 250.

 ** [nextToken](#API_ListPortals_RequestSyntax) **   <a name="iotsitewise-ListPortals-request-uri-nextToken"></a>
The token to be used for the next set of paginated results.  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

## Request Body
<a name="API_ListPortals_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListPortals_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "portalSummaries": [ 
      { 
         "creationDate": number,
         "description": "string",
         "id": "string",
         "lastUpdateDate": number,
         "name": "string",
         "portalType": "string",
         "roleArn": "string",
         "startUrl": "string",
         "status": { 
            "error": { 
               "code": "string",
               "message": "string"
            },
            "state": "string"
         }
      }
   ]
}
```

## Response Elements
<a name="API_ListPortals_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListPortals_ResponseSyntax) **   <a name="iotsitewise-ListPortals-response-nextToken"></a>
The token for the next set of results, or null if there are no additional results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

 ** [portalSummaries](#API_ListPortals_ResponseSyntax) **   <a name="iotsitewise-ListPortals-response-portalSummaries"></a>
A list that summarizes each portal.  
Type: Array of [PortalSummary](API_PortalSummary.md) objects

## Errors
<a name="API_ListPortals_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_ListPortals_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/ListPortals) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/ListPortals) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/ListPortals) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/ListPortals) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/ListPortals) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/ListPortals) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/ListPortals) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/ListPortals) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/ListPortals) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/ListPortals) 

# ListProjectAssets
<a name="API_ListProjectAssets"></a>

Retrieves a paginated list of assets associated with an AWS IoT SiteWise Monitor project.

## Request Syntax
<a name="API_ListProjectAssets_RequestSyntax"></a>

```
GET /projects/projectId/assets?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListProjectAssets_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_ListProjectAssets_RequestSyntax) **   <a name="iotsitewise-ListProjectAssets-request-uri-maxResults"></a>
The maximum number of results to return for each paginated request.  
Default: 50  
Valid Range: Minimum value of 1. Maximum value of 250.

 ** [nextToken](#API_ListProjectAssets_RequestSyntax) **   <a name="iotsitewise-ListProjectAssets-request-uri-nextToken"></a>
The token to be used for the next set of paginated results.  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

 ** [projectId](#API_ListProjectAssets_RequestSyntax) **   <a name="iotsitewise-ListProjectAssets-request-uri-projectId"></a>
The ID of the project.  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`   
Required: Yes

## Request Body
<a name="API_ListProjectAssets_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListProjectAssets_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "assetIds": [ "string" ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListProjectAssets_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [assetIds](#API_ListProjectAssets_ResponseSyntax) **   <a name="iotsitewise-ListProjectAssets-response-assetIds"></a>
A list that contains the IDs of each asset associated with the project.  
Type: Array of strings  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

 ** [nextToken](#API_ListProjectAssets_ResponseSyntax) **   <a name="iotsitewise-ListProjectAssets-response-nextToken"></a>
The token for the next set of results, or null if there are no additional results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

## Errors
<a name="API_ListProjectAssets_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_ListProjectAssets_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/ListProjectAssets) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/ListProjectAssets) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/ListProjectAssets) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/ListProjectAssets) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/ListProjectAssets) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/ListProjectAssets) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/ListProjectAssets) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/ListProjectAssets) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/ListProjectAssets) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/ListProjectAssets) 

# ListProjects
<a name="API_ListProjects"></a>

Retrieves a paginated list of projects for an AWS IoT SiteWise Monitor portal.

## Request Syntax
<a name="API_ListProjects_RequestSyntax"></a>

```
GET /projects?maxResults=maxResults&nextToken=nextToken&portalId=portalId HTTP/1.1
```

## URI Request Parameters
<a name="API_ListProjects_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_ListProjects_RequestSyntax) **   <a name="iotsitewise-ListProjects-request-uri-maxResults"></a>
The maximum number of results to return for each paginated request.  
Default: 50  
Valid Range: Minimum value of 1. Maximum value of 250.

 ** [nextToken](#API_ListProjects_RequestSyntax) **   <a name="iotsitewise-ListProjects-request-uri-nextToken"></a>
The token to be used for the next set of paginated results.  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

 ** [portalId](#API_ListProjects_RequestSyntax) **   <a name="iotsitewise-ListProjects-request-uri-portalId"></a>
The ID of the portal.  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`   
Required: Yes

## Request Body
<a name="API_ListProjects_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListProjects_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "projectSummaries": [ 
      { 
         "creationDate": number,
         "description": "string",
         "id": "string",
         "lastUpdateDate": number,
         "name": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListProjects_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListProjects_ResponseSyntax) **   <a name="iotsitewise-ListProjects-response-nextToken"></a>
The token for the next set of results, or null if there are no additional results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

 ** [projectSummaries](#API_ListProjects_ResponseSyntax) **   <a name="iotsitewise-ListProjects-response-projectSummaries"></a>
A list that summarizes each project in the portal.  
Type: Array of [ProjectSummary](API_ProjectSummary.md) objects

## Errors
<a name="API_ListProjects_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_ListProjects_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/ListProjects) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/ListProjects) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/ListProjects) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/ListProjects) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/ListProjects) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/ListProjects) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/ListProjects) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/ListProjects) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/ListProjects) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/ListProjects) 

# ListTagsForResource
<a name="API_ListTagsForResource"></a>

Retrieves the list of tags for an AWS IoT SiteWise resource.

## Request Syntax
<a name="API_ListTagsForResource_RequestSyntax"></a>

```
GET /tags?resourceArn=resourceArn HTTP/1.1
```

## URI Request Parameters
<a name="API_ListTagsForResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resourceArn](#API_ListTagsForResource_RequestSyntax) **   <a name="iotsitewise-ListTagsForResource-request-uri-resourceArn"></a>
The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the resource.  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Required: Yes

## Request Body
<a name="API_ListTagsForResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListTagsForResource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_ListTagsForResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [tags](#API_ListTagsForResource_ResponseSyntax) **   <a name="iotsitewise-ListTagsForResource-response-tags"></a>
The list of key-value pairs that contain metadata for the resource. For more information, see [Tagging your AWS IoT SiteWise resources](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) in the * AWS IoT SiteWise User Guide*.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.

## Errors
<a name="API_ListTagsForResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictingOperationException **   
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.    
 ** resourceArn **   
The ARN of the resource that conflicts with this operation.  
 ** resourceId **   
The ID of the resource that conflicts with this operation.
HTTP Status Code: 409

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** LimitExceededException **   
You've reached the quota for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 410

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You are not authorized.  
HTTP Status Code: 401

## See Also
<a name="API_ListTagsForResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/ListTagsForResource) 

# ListTimeSeries
<a name="API_ListTimeSeries"></a>

Retrieves a paginated list of time series (data streams).

## Request Syntax
<a name="API_ListTimeSeries_RequestSyntax"></a>

```
GET /timeseries/?aliasPrefix=aliasPrefix&assetId=assetId&maxResults=maxResults&nextToken=nextToken&timeSeriesType=timeSeriesType HTTP/1.1
```

## URI Request Parameters
<a name="API_ListTimeSeries_RequestParameters"></a>

The request uses the following URI parameters.

 ** [aliasPrefix](#API_ListTimeSeries_RequestSyntax) **   <a name="iotsitewise-ListTimeSeries-request-uri-aliasPrefix"></a>
The alias prefix of the time series.  
Length Constraints: Minimum length of 1.  
Pattern: `[^\u0000-\u001F\u007F]+` 

 ** [assetId](#API_ListTimeSeries_RequestSyntax) **   <a name="iotsitewise-ListTimeSeries-request-uri-assetId"></a>
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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) in the * AWS IoT SiteWise User Guide*.  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+` 

 ** [maxResults](#API_ListTimeSeries_RequestSyntax) **   <a name="iotsitewise-ListTimeSeries-request-uri-maxResults"></a>
The maximum number of results to return for each paginated request.  
Valid Range: Minimum value of 1. Maximum value of 250.

 ** [nextToken](#API_ListTimeSeries_RequestSyntax) **   <a name="iotsitewise-ListTimeSeries-request-uri-nextToken"></a>
The token to be used for the next set of paginated results.  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

 ** [timeSeriesType](#API_ListTimeSeries_RequestSyntax) **   <a name="iotsitewise-ListTimeSeries-request-uri-timeSeriesType"></a>
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.
Valid Values: `ASSOCIATED | DISASSOCIATED` 

## Request Body
<a name="API_ListTimeSeries_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListTimeSeries_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "TimeSeriesSummaries": [ 
      { 
         "alias": "string",
         "assetId": "string",
         "dataType": "string",
         "dataTypeSpec": "string",
         "propertyId": "string",
         "timeSeriesArn": "string",
         "timeSeriesCreationDate": number,
         "timeSeriesId": "string",
         "timeSeriesLastUpdateDate": number
      }
   ]
}
```

## Response Elements
<a name="API_ListTimeSeries_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListTimeSeries_ResponseSyntax) **   <a name="iotsitewise-ListTimeSeries-response-nextToken"></a>
The token for the next set of results, or null if there are no additional results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[A-Za-z0-9+/=]+` 

 ** [TimeSeriesSummaries](#API_ListTimeSeries_ResponseSyntax) **   <a name="iotsitewise-ListTimeSeries-response-TimeSeriesSummaries"></a>
One or more time series summaries to list.  
Type: Array of [TimeSeriesSummary](API_TimeSeriesSummary.md) objects

## Errors
<a name="API_ListTimeSeries_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_ListTimeSeries_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/ListTimeSeries) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/ListTimeSeries) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/ListTimeSeries) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/ListTimeSeries) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/ListTimeSeries) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/ListTimeSeries) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/ListTimeSeries) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/ListTimeSeries) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/ListTimeSeries) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/ListTimeSeries) 

# PutAssetModelInterfaceRelationship
<a name="API_PutAssetModelInterfaceRelationship"></a>

Creates or updates an interface relationship between an asset model and an interface asset model. This operation applies an interface to an asset model.

## Request Syntax
<a name="API_PutAssetModelInterfaceRelationship_RequestSyntax"></a>

```
PUT /asset-models/assetModelId/interface/interfaceAssetModelId/asset-model-interface-relationship HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "propertyMappingConfiguration": { 
      "createMissingProperty": boolean,
      "matchByPropertyName": boolean,
      "overrides": [ 
         { 
            "assetModelPropertyId": "string",
            "interfaceAssetModelPropertyId": "string"
         }
      ]
   }
}
```

## URI Request Parameters
<a name="API_PutAssetModelInterfaceRelationship_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assetModelId](#API_PutAssetModelInterfaceRelationship_RequestSyntax) **   <a name="iotsitewise-PutAssetModelInterfaceRelationship-request-uri-assetModelId"></a>
The ID of the asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID.  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+`   
Required: Yes

 ** [interfaceAssetModelId](#API_PutAssetModelInterfaceRelationship_RequestSyntax) **   <a name="iotsitewise-PutAssetModelInterfaceRelationship-request-uri-interfaceAssetModelId"></a>
The ID of the interface asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID.  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+`   
Required: Yes

## Request Body
<a name="API_PutAssetModelInterfaceRelationship_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_PutAssetModelInterfaceRelationship_RequestSyntax) **   <a name="iotsitewise-PutAssetModelInterfaceRelationship-request-clientToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 36. Maximum length of 64.  
Pattern: `\S{36,64}`   
Required: No

 ** [propertyMappingConfiguration](#API_PutAssetModelInterfaceRelationship_RequestSyntax) **   <a name="iotsitewise-PutAssetModelInterfaceRelationship-request-propertyMappingConfiguration"></a>
The configuration for mapping properties from the interface asset model to the asset model where the interface is applied. This configuration controls how properties are matched and created during the interface application process.  
Type: [PropertyMappingConfiguration](API_PropertyMappingConfiguration.md) object  
Required: Yes

## Response Syntax
<a name="API_PutAssetModelInterfaceRelationship_ResponseSyntax"></a>

```
HTTP/1.1 202
Content-type: application/json

{
   "assetModelArn": "string",
   "assetModelId": "string",
   "assetModelStatus": { 
      "error": { 
         "code": "string",
         "details": [ 
            { 
               "code": "string",
               "message": "string"
            }
         ],
         "message": "string"
      },
      "state": "string"
   },
   "interfaceAssetModelId": "string"
}
```

## Response Elements
<a name="API_PutAssetModelInterfaceRelationship_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

 ** [assetModelArn](#API_PutAssetModelInterfaceRelationship_ResponseSyntax) **   <a name="iotsitewise-PutAssetModelInterfaceRelationship-response-assetModelArn"></a>
The ARN of the asset model, which has the following format. `arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}`   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$` 

 ** [assetModelId](#API_PutAssetModelInterfaceRelationship_ResponseSyntax) **   <a name="iotsitewise-PutAssetModelInterfaceRelationship-response-assetModelId"></a>
The ID of the asset model.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

 ** [assetModelStatus](#API_PutAssetModelInterfaceRelationship_ResponseSyntax) **   <a name="iotsitewise-PutAssetModelInterfaceRelationship-response-assetModelStatus"></a>
Contains current status information for an asset model. For more information, see [Asset and model states](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-and-model-states.html) in the * AWS IoT SiteWise User Guide*.  
Type: [AssetModelStatus](API_AssetModelStatus.md) object

 ** [interfaceAssetModelId](#API_PutAssetModelInterfaceRelationship_ResponseSyntax) **   <a name="iotsitewise-PutAssetModelInterfaceRelationship-response-interfaceAssetModelId"></a>
The ID of the interface asset model.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

## Errors
<a name="API_PutAssetModelInterfaceRelationship_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictingOperationException **   
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.    
 ** resourceArn **   
The ARN of the resource that conflicts with this operation.  
 ** resourceId **   
The ID of the resource that conflicts with this operation.
HTTP Status Code: 409

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** LimitExceededException **   
You've reached the quota for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 410

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_PutAssetModelInterfaceRelationship_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/PutAssetModelInterfaceRelationship) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/PutAssetModelInterfaceRelationship) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/PutAssetModelInterfaceRelationship) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/PutAssetModelInterfaceRelationship) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/PutAssetModelInterfaceRelationship) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/PutAssetModelInterfaceRelationship) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/PutAssetModelInterfaceRelationship) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/PutAssetModelInterfaceRelationship) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/PutAssetModelInterfaceRelationship) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/PutAssetModelInterfaceRelationship) 

# PutDefaultEncryptionConfiguration
<a name="API_PutDefaultEncryptionConfiguration"></a>

Sets the default encryption configuration for the AWS account. For more information, see [Key management](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/key-management.html) in the * AWS IoT SiteWise User Guide*.

## Request Syntax
<a name="API_PutDefaultEncryptionConfiguration_RequestSyntax"></a>

```
POST /configuration/account/encryption HTTP/1.1
Content-type: application/json

{
   "encryptionType": "string",
   "kmsKeyId": "string"
}
```

## URI Request Parameters
<a name="API_PutDefaultEncryptionConfiguration_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_PutDefaultEncryptionConfiguration_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [encryptionType](#API_PutDefaultEncryptionConfiguration_RequestSyntax) **   <a name="iotsitewise-PutDefaultEncryptionConfiguration-request-encryptionType"></a>
The type of encryption used for the encryption configuration.  
Type: String  
Valid Values: `SITEWISE_DEFAULT_ENCRYPTION | KMS_BASED_ENCRYPTION`   
Required: Yes

 ** [kmsKeyId](#API_PutDefaultEncryptionConfiguration_RequestSyntax) **   <a name="iotsitewise-PutDefaultEncryptionConfiguration-request-kmsKeyId"></a>
The Key ID of the customer managed key used for AWS KMS encryption. This is required if you use `KMS_BASED_ENCRYPTION`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

## Response Syntax
<a name="API_PutDefaultEncryptionConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "configurationStatus": { 
      "error": { 
         "code": "string",
         "message": "string"
      },
      "state": "string"
   },
   "encryptionType": "string",
   "kmsKeyArn": "string"
}
```

## Response Elements
<a name="API_PutDefaultEncryptionConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [configurationStatus](#API_PutDefaultEncryptionConfiguration_ResponseSyntax) **   <a name="iotsitewise-PutDefaultEncryptionConfiguration-response-configurationStatus"></a>
The status of the account configuration. This contains the `ConfigurationState`. If there is an error, it also contains the `ErrorDetails`.  
Type: [ConfigurationStatus](API_ConfigurationStatus.md) object

 ** [encryptionType](#API_PutDefaultEncryptionConfiguration_ResponseSyntax) **   <a name="iotsitewise-PutDefaultEncryptionConfiguration-response-encryptionType"></a>
The type of encryption used for the encryption configuration.  
Type: String  
Valid Values: `SITEWISE_DEFAULT_ENCRYPTION | KMS_BASED_ENCRYPTION` 

 ** [kmsKeyArn](#API_PutDefaultEncryptionConfiguration_ResponseSyntax) **   <a name="iotsitewise-PutDefaultEncryptionConfiguration-response-kmsKeyArn"></a>
The Key ARN of the AWS KMS key used for AWS KMS encryption if you use `KMS_BASED_ENCRYPTION`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$` 

## Errors
<a name="API_PutDefaultEncryptionConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictingOperationException **   
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.    
 ** resourceArn **   
The ARN of the resource that conflicts with this operation.  
 ** resourceId **   
The ID of the resource that conflicts with this operation.
HTTP Status Code: 409

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** LimitExceededException **   
You've reached the quota for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 410

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_PutDefaultEncryptionConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/PutDefaultEncryptionConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/PutDefaultEncryptionConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/PutDefaultEncryptionConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/PutDefaultEncryptionConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/PutDefaultEncryptionConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/PutDefaultEncryptionConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/PutDefaultEncryptionConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/PutDefaultEncryptionConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/PutDefaultEncryptionConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/PutDefaultEncryptionConfiguration) 

# PutLoggingOptions
<a name="API_PutLoggingOptions"></a>

Sets logging options for AWS IoT SiteWise.

## Request Syntax
<a name="API_PutLoggingOptions_RequestSyntax"></a>

```
PUT /logging HTTP/1.1
Content-type: application/json

{
   "loggingOptions": { 
      "level": "string"
   }
}
```

## URI Request Parameters
<a name="API_PutLoggingOptions_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_PutLoggingOptions_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [loggingOptions](#API_PutLoggingOptions_RequestSyntax) **   <a name="iotsitewise-PutLoggingOptions-request-loggingOptions"></a>
The logging options to set.  
Type: [LoggingOptions](API_LoggingOptions.md) object  
Required: Yes

## Response Syntax
<a name="API_PutLoggingOptions_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_PutLoggingOptions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_PutLoggingOptions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictingOperationException **   
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.    
 ** resourceArn **   
The ARN of the resource that conflicts with this operation.  
 ** resourceId **   
The ID of the resource that conflicts with this operation.
HTTP Status Code: 409

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_PutLoggingOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/PutLoggingOptions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/PutLoggingOptions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/PutLoggingOptions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/PutLoggingOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/PutLoggingOptions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/PutLoggingOptions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/PutLoggingOptions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/PutLoggingOptions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/PutLoggingOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/PutLoggingOptions) 

# PutStorageConfiguration
<a name="API_PutStorageConfiguration"></a>

Configures storage settings for AWS IoT SiteWise.

## Request Syntax
<a name="API_PutStorageConfiguration_RequestSyntax"></a>

```
POST /configuration/account/storage HTTP/1.1
Content-type: application/json

{
   "disallowIngestNullNaN": boolean,
   "disassociatedDataStorage": "string",
   "multiLayerStorage": { 
      "customerManagedS3Storage": { 
         "roleArn": "string",
         "s3ResourceArn": "string"
      }
   },
   "retentionPeriod": { 
      "numberOfDays": number,
      "unlimited": boolean
   },
   "storageType": "string",
   "warmTier": "string",
   "warmTierRetentionPeriod": { 
      "numberOfDays": number,
      "unlimited": boolean
   }
}
```

## URI Request Parameters
<a name="API_PutStorageConfiguration_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_PutStorageConfiguration_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [disallowIngestNullNaN](#API_PutStorageConfiguration_RequestSyntax) **   <a name="iotsitewise-PutStorageConfiguration-request-disallowIngestNullNaN"></a>
Describes the configuration for ingesting NULL and NaN data. By default the feature is allowed. The feature is disallowed if the value is `true`.  
Type: Boolean  
Required: No

 ** [disassociatedDataStorage](#API_PutStorageConfiguration_RequestSyntax) **   <a name="iotsitewise-PutStorageConfiguration-request-disassociatedDataStorage"></a>
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` – AWS IoT SiteWise accepts time series that aren't associated with asset properties.
**Important**  
After the `disassociatedDataStorage` is enabled, you can't disable it.
+  `DISABLED` – AWS IoT SiteWise doesn't accept time series (data streams) that aren't associated with asset properties.
For more information, see [Data streams](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/data-streams.html) in the * AWS IoT SiteWise User Guide*.  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

 ** [multiLayerStorage](#API_PutStorageConfiguration_RequestSyntax) **   <a name="iotsitewise-PutStorageConfiguration-request-multiLayerStorage"></a>
Identifies a storage destination. If you specified `MULTI_LAYER_STORAGE` for the storage type, you must specify a `MultiLayerStorage` object.  
Type: [MultiLayerStorage](API_MultiLayerStorage.md) object  
Required: No

 ** [retentionPeriod](#API_PutStorageConfiguration_RequestSyntax) **   <a name="iotsitewise-PutStorageConfiguration-request-retentionPeriod"></a>
The number of days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.  
Type: [RetentionPeriod](API_RetentionPeriod.md) object  
Required: No

 ** [storageType](#API_PutStorageConfiguration_RequestSyntax) **   <a name="iotsitewise-PutStorageConfiguration-request-storageType"></a>
The storage tier that you specified for your data. The `storageType` parameter can be one of the following values:  
+  `SITEWISE_DEFAULT_STORAGE` – AWS IoT SiteWise saves your data into the hot tier. The hot tier is a service-managed database.
+  `MULTI_LAYER_STORAGE` – AWS IoT SiteWise saves your data in both the cold tier and the hot tier. The cold tier is a customer-managed Amazon S3 bucket.
Type: String  
Valid Values: `SITEWISE_DEFAULT_STORAGE | MULTI_LAYER_STORAGE`   
Required: Yes

 ** [warmTier](#API_PutStorageConfiguration_RequestSyntax) **   <a name="iotsitewise-PutStorageConfiguration-request-warmTier"></a>
A service managed storage tier optimized for analytical queries. It stores periodically uploaded, buffered and historical data ingested with the CreaeBulkImportJob API.  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

 ** [warmTierRetentionPeriod](#API_PutStorageConfiguration_RequestSyntax) **   <a name="iotsitewise-PutStorageConfiguration-request-warmTierRetentionPeriod"></a>
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.  
Type: [WarmTierRetentionPeriod](API_WarmTierRetentionPeriod.md) object  
Required: No

## Response Syntax
<a name="API_PutStorageConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "configurationStatus": { 
      "error": { 
         "code": "string",
         "message": "string"
      },
      "state": "string"
   },
   "disallowIngestNullNaN": boolean,
   "disassociatedDataStorage": "string",
   "multiLayerStorage": { 
      "customerManagedS3Storage": { 
         "roleArn": "string",
         "s3ResourceArn": "string"
      }
   },
   "retentionPeriod": { 
      "numberOfDays": number,
      "unlimited": boolean
   },
   "storageType": "string",
   "warmTier": "string",
   "warmTierRetentionPeriod": { 
      "numberOfDays": number,
      "unlimited": boolean
   }
}
```

## Response Elements
<a name="API_PutStorageConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [configurationStatus](#API_PutStorageConfiguration_ResponseSyntax) **   <a name="iotsitewise-PutStorageConfiguration-response-configurationStatus"></a>
Contains current status information for the configuration.  
Type: [ConfigurationStatus](API_ConfigurationStatus.md) object

 ** [disallowIngestNullNaN](#API_PutStorageConfiguration_ResponseSyntax) **   <a name="iotsitewise-PutStorageConfiguration-response-disallowIngestNullNaN"></a>
Describes the configuration for ingesting NULL and NaN data. By default the feature is allowed. The feature is disallowed if the value is `true`.  
Type: Boolean

 ** [disassociatedDataStorage](#API_PutStorageConfiguration_ResponseSyntax) **   <a name="iotsitewise-PutStorageConfiguration-response-disassociatedDataStorage"></a>
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` – AWS IoT SiteWise accepts time series that aren't associated with asset properties.
**Important**  
After the `disassociatedDataStorage` is enabled, you can't disable it.
+  `DISABLED` – AWS IoT SiteWise doesn't accept time series (data streams) that aren't associated with asset properties.
For more information, see [Data streams](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/data-streams.html) in the * AWS IoT SiteWise User Guide*.  
Type: String  
Valid Values: `ENABLED | DISABLED` 

 ** [multiLayerStorage](#API_PutStorageConfiguration_ResponseSyntax) **   <a name="iotsitewise-PutStorageConfiguration-response-multiLayerStorage"></a>
Contains information about the storage destination.  
Type: [MultiLayerStorage](API_MultiLayerStorage.md) object

 ** [retentionPeriod](#API_PutStorageConfiguration_ResponseSyntax) **   <a name="iotsitewise-PutStorageConfiguration-response-retentionPeriod"></a>
The number of days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.  
Type: [RetentionPeriod](API_RetentionPeriod.md) object

 ** [storageType](#API_PutStorageConfiguration_ResponseSyntax) **   <a name="iotsitewise-PutStorageConfiguration-response-storageType"></a>
The storage tier that you specified for your data. The `storageType` parameter can be one of the following values:  
+  `SITEWISE_DEFAULT_STORAGE` – AWS IoT SiteWise saves your data into the hot tier. The hot tier is a service-managed database.
+  `MULTI_LAYER_STORAGE` – AWS IoT SiteWise saves your data in both the cold tier and the hot tier. The cold tier is a customer-managed Amazon S3 bucket.
Type: String  
Valid Values: `SITEWISE_DEFAULT_STORAGE | MULTI_LAYER_STORAGE` 

 ** [warmTier](#API_PutStorageConfiguration_ResponseSyntax) **   <a name="iotsitewise-PutStorageConfiguration-response-warmTier"></a>
A service managed storage tier optimized for analytical queries. It stores periodically uploaded, buffered and historical data ingested with the CreaeBulkImportJob API.  
Type: String  
Valid Values: `ENABLED | DISABLED` 

 ** [warmTierRetentionPeriod](#API_PutStorageConfiguration_ResponseSyntax) **   <a name="iotsitewise-PutStorageConfiguration-response-warmTierRetentionPeriod"></a>
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.  
Type: [WarmTierRetentionPeriod](API_WarmTierRetentionPeriod.md) object

## Errors
<a name="API_PutStorageConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictingOperationException **   
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.    
 ** resourceArn **   
The ARN of the resource that conflicts with this operation.  
 ** resourceId **   
The ID of the resource that conflicts with this operation.
HTTP Status Code: 409

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** LimitExceededException **   
You've reached the quota for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 410

 ** ResourceAlreadyExistsException **   
The resource already exists.    
 ** resourceArn **   
The ARN of the resource that already exists.  
 ** resourceId **   
The ID of the resource that already exists.
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_PutStorageConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/PutStorageConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/PutStorageConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/PutStorageConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/PutStorageConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/PutStorageConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/PutStorageConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/PutStorageConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/PutStorageConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/PutStorageConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/PutStorageConfiguration) 

# TagResource
<a name="API_TagResource"></a>

Adds tags to an AWS IoT SiteWise resource. If a tag already exists for the resource, this operation updates the tag's value.

## Request Syntax
<a name="API_TagResource_RequestSyntax"></a>

```
POST /tags?resourceArn=resourceArn HTTP/1.1
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_TagResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resourceArn](#API_TagResource_RequestSyntax) **   <a name="iotsitewise-TagResource-request-uri-resourceArn"></a>
The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the resource to tag.  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Required: Yes

## Request Body
<a name="API_TagResource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [tags](#API_TagResource_RequestSyntax) **   <a name="iotsitewise-TagResource-request-tags"></a>
A list of key-value pairs that contain metadata for the resource. For more information, see [Tagging your AWS IoT SiteWise resources](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) in the * AWS IoT SiteWise User Guide*.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: Yes

## Response Syntax
<a name="API_TagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_TagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_TagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictingOperationException **   
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.    
 ** resourceArn **   
The ARN of the resource that conflicts with this operation.  
 ** resourceId **   
The ID of the resource that conflicts with this operation.
HTTP Status Code: 409

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** LimitExceededException **   
You've reached the quota for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 410

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

 ** TooManyTagsException **   
You've reached the quota for the number of tags allowed for a resource. For more information, see [Tag naming limits and requirements](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions) in the * AWS General Reference*.    
 ** resourceName **   
The name of the resource with too many tags.
HTTP Status Code: 400

 ** UnauthorizedException **   
You are not authorized.  
HTTP Status Code: 401

## See Also
<a name="API_TagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/TagResource) 

# UntagResource
<a name="API_UntagResource"></a>

Removes a tag from an AWS IoT SiteWise resource.

## Request Syntax
<a name="API_UntagResource_RequestSyntax"></a>

```
DELETE /tags?resourceArn=resourceArn&tagKeys=tagKeys HTTP/1.1
```

## URI Request Parameters
<a name="API_UntagResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resourceArn](#API_UntagResource_RequestSyntax) **   <a name="iotsitewise-UntagResource-request-uri-resourceArn"></a>
The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the resource to untag.  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Required: Yes

 ** [tagKeys](#API_UntagResource_RequestSyntax) **   <a name="iotsitewise-UntagResource-request-uri-tagKeys"></a>
A list of keys for tags to remove from the resource.  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: Yes

## Request Body
<a name="API_UntagResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_UntagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UntagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UntagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictingOperationException **   
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.    
 ** resourceArn **   
The ARN of the resource that conflicts with this operation.  
 ** resourceId **   
The ID of the resource that conflicts with this operation.
HTTP Status Code: 409

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** LimitExceededException **   
You've reached the quota for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 410

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You are not authorized.  
HTTP Status Code: 401

## See Also
<a name="API_UntagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/UntagResource) 

# UpdateAccessPolicy
<a name="API_UpdateAccessPolicy"></a>

**Important**  
The AWS IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025 . If you would like to use the AWS IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS IoT SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).

Updates an existing access policy that specifies an identity's access to an AWS IoT SiteWise Monitor portal or project resource.

## Request Syntax
<a name="API_UpdateAccessPolicy_RequestSyntax"></a>

```
PUT /access-policies/accessPolicyId HTTP/1.1
Content-type: application/json

{
   "accessPolicyIdentity": { 
      "group": { 
         "id": "string"
      },
      "iamRole": { 
         "arn": "string"
      },
      "iamUser": { 
         "arn": "string"
      },
      "user": { 
         "id": "string"
      }
   },
   "accessPolicyPermission": "string",
   "accessPolicyResource": { 
      "portal": { 
         "id": "string"
      },
      "project": { 
         "id": "string"
      }
   },
   "clientToken": "string"
}
```

## URI Request Parameters
<a name="API_UpdateAccessPolicy_RequestParameters"></a>

The request uses the following URI parameters.

 ** [accessPolicyId](#API_UpdateAccessPolicy_RequestSyntax) **   <a name="iotsitewise-UpdateAccessPolicy-request-uri-accessPolicyId"></a>
The ID of the access policy.  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`   
Required: Yes

## Request Body
<a name="API_UpdateAccessPolicy_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [accessPolicyIdentity](#API_UpdateAccessPolicy_RequestSyntax) **   <a name="iotsitewise-UpdateAccessPolicy-request-accessPolicyIdentity"></a>
The identity for this access policy. Choose an IAM Identity Center user, an IAM Identity Center group, or an IAM user.  
Type: [Identity](API_Identity.md) object  
Required: Yes

 ** [accessPolicyPermission](#API_UpdateAccessPolicy_RequestSyntax) **   <a name="iotsitewise-UpdateAccessPolicy-request-accessPolicyPermission"></a>
The permission level for this access policy. Note that a project `ADMINISTRATOR` is also known as a project owner.  
Type: String  
Valid Values: `ADMINISTRATOR | VIEWER`   
Required: Yes

 ** [accessPolicyResource](#API_UpdateAccessPolicy_RequestSyntax) **   <a name="iotsitewise-UpdateAccessPolicy-request-accessPolicyResource"></a>
The AWS IoT SiteWise Monitor resource for this access policy. Choose either a portal or a project.  
Type: [Resource](API_Resource.md) object  
Required: Yes

 ** [clientToken](#API_UpdateAccessPolicy_RequestSyntax) **   <a name="iotsitewise-UpdateAccessPolicy-request-clientToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 36. Maximum length of 64.  
Pattern: `\S{36,64}`   
Required: No

## Response Syntax
<a name="API_UpdateAccessPolicy_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateAccessPolicy_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateAccessPolicy_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateAccessPolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/UpdateAccessPolicy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/UpdateAccessPolicy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/UpdateAccessPolicy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/UpdateAccessPolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/UpdateAccessPolicy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/UpdateAccessPolicy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/UpdateAccessPolicy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/UpdateAccessPolicy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/UpdateAccessPolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/UpdateAccessPolicy) 

# UpdateAsset
<a name="API_UpdateAsset"></a>

Updates an asset's name. For more information, see [Updating assets and models](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-assets-and-models.html) in the * AWS IoT SiteWise User Guide*.

## Request Syntax
<a name="API_UpdateAsset_RequestSyntax"></a>

```
PUT /assets/assetId HTTP/1.1
Content-type: application/json

{
   "assetDescription": "string",
   "assetExternalId": "string",
   "assetName": "string",
   "clientToken": "string"
}
```

## URI Request Parameters
<a name="API_UpdateAsset_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assetId](#API_UpdateAsset_RequestSyntax) **   <a name="iotsitewise-UpdateAsset-request-uri-assetId"></a>
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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) in the * AWS IoT SiteWise User Guide*.  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+`   
Required: Yes

## Request Body
<a name="API_UpdateAsset_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [assetDescription](#API_UpdateAsset_RequestSyntax) **   <a name="iotsitewise-UpdateAsset-request-assetDescription"></a>
A description for the asset.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[^\u0000-\u001F\u007F]+`   
Required: No

 ** [assetExternalId](#API_UpdateAsset_RequestSyntax) **   <a name="iotsitewise-UpdateAsset-request-assetExternalId"></a>
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 AWS account. For more information, see [Using external IDs](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) in the * AWS IoT SiteWise User Guide*.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+`   
Required: No

 ** [assetName](#API_UpdateAsset_RequestSyntax) **   <a name="iotsitewise-UpdateAsset-request-assetName"></a>
A friendly name for the asset.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[^\u0000-\u001F\u007F]+`   
Required: Yes

 ** [clientToken](#API_UpdateAsset_RequestSyntax) **   <a name="iotsitewise-UpdateAsset-request-clientToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 36. Maximum length of 64.  
Pattern: `\S{36,64}`   
Required: No

## Response Syntax
<a name="API_UpdateAsset_ResponseSyntax"></a>

```
HTTP/1.1 202
Content-type: application/json

{
   "assetStatus": { 
      "error": { 
         "code": "string",
         "details": [ 
            { 
               "code": "string",
               "message": "string"
            }
         ],
         "message": "string"
      },
      "state": "string"
   }
}
```

## Response Elements
<a name="API_UpdateAsset_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

 ** [assetStatus](#API_UpdateAsset_ResponseSyntax) **   <a name="iotsitewise-UpdateAsset-response-assetStatus"></a>
The status of the asset, which contains a state (`UPDATING` after successfully calling this operation) and any error message.  
Type: [AssetStatus](API_AssetStatus.md) object

## Errors
<a name="API_UpdateAsset_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictingOperationException **   
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.    
 ** resourceArn **   
The ARN of the resource that conflicts with this operation.  
 ** resourceId **   
The ID of the resource that conflicts with this operation.
HTTP Status Code: 409

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceAlreadyExistsException **   
The resource already exists.    
 ** resourceArn **   
The ARN of the resource that already exists.  
 ** resourceId **   
The ID of the resource that already exists.
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateAsset_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/UpdateAsset) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/UpdateAsset) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/UpdateAsset) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/UpdateAsset) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/UpdateAsset) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/UpdateAsset) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/UpdateAsset) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/UpdateAsset) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/UpdateAsset) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/UpdateAsset) 

# UpdateAssetModel
<a name="API_UpdateAssetModel"></a>

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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-assets-and-models.html) in the * AWS IoT SiteWise User Guide*.

**Important**  
If you remove a property from an asset model, AWS IoT SiteWise deletes all previous data for that property. You can’t change the type or data type of an existing property.  
To replace an existing asset model property with a new one with the same `name`, do the following:  
Submit an `UpdateAssetModel` request with the entire existing property removed.
Submit a second `UpdateAssetModel` request that includes the new property. The new asset property will have the same `name` as the previous one and AWS IoT SiteWise will generate a new unique `id`.

## Request Syntax
<a name="API_UpdateAssetModel_RequestSyntax"></a>

```
PUT /asset-models/assetModelId HTTP/1.1
If-Match: ifMatch
If-None-Match: ifNoneMatch
Match-For-Version-Type: matchForVersionType
Content-type: application/json

{
   "assetModelCompositeModels": [ 
      { 
         "description": "string",
         "externalId": "string",
         "id": "string",
         "name": "string",
         "properties": [ 
            { 
               "dataType": "string",
               "dataTypeSpec": "string",
               "externalId": "string",
               "id": "string",
               "name": "string",
               "path": [ 
                  { 
                     "id": "string",
                     "name": "string"
                  }
               ],
               "type": { 
                  "attribute": { 
                     "defaultValue": "string"
                  },
                  "measurement": { 
                     "processingConfig": { 
                        "forwardingConfig": { 
                           "state": "string"
                        }
                     }
                  },
                  "metric": { 
                     "expression": "string",
                     "processingConfig": { 
                        "computeLocation": "string"
                     },
                     "variables": [ 
                        { 
                           "name": "string",
                           "value": { 
                              "hierarchyId": "string",
                              "propertyId": "string",
                              "propertyPath": [ 
                                 { 
                                    "id": "string",
                                    "name": "string"
                                 }
                              ]
                           }
                        }
                     ],
                     "window": { 
                        "tumbling": { 
                           "interval": "string",
                           "offset": "string"
                        }
                     }
                  },
                  "transform": { 
                     "expression": "string",
                     "processingConfig": { 
                        "computeLocation": "string",
                        "forwardingConfig": { 
                           "state": "string"
                        }
                     },
                     "variables": [ 
                        { 
                           "name": "string",
                           "value": { 
                              "hierarchyId": "string",
                              "propertyId": "string",
                              "propertyPath": [ 
                                 { 
                                    "id": "string",
                                    "name": "string"
                                 }
                              ]
                           }
                        }
                     ]
                  }
               },
               "unit": "string"
            }
         ],
         "type": "string"
      }
   ],
   "assetModelDescription": "string",
   "assetModelExternalId": "string",
   "assetModelHierarchies": [ 
      { 
         "childAssetModelId": "string",
         "externalId": "string",
         "id": "string",
         "name": "string"
      }
   ],
   "assetModelName": "string",
   "assetModelProperties": [ 
      { 
         "dataType": "string",
         "dataTypeSpec": "string",
         "externalId": "string",
         "id": "string",
         "name": "string",
         "path": [ 
            { 
               "id": "string",
               "name": "string"
            }
         ],
         "type": { 
            "attribute": { 
               "defaultValue": "string"
            },
            "measurement": { 
               "processingConfig": { 
                  "forwardingConfig": { 
                     "state": "string"
                  }
               }
            },
            "metric": { 
               "expression": "string",
               "processingConfig": { 
                  "computeLocation": "string"
               },
               "variables": [ 
                  { 
                     "name": "string",
                     "value": { 
                        "hierarchyId": "string",
                        "propertyId": "string",
                        "propertyPath": [ 
                           { 
                              "id": "string",
                              "name": "string"
                           }
                        ]
                     }
                  }
               ],
               "window": { 
                  "tumbling": { 
                     "interval": "string",
                     "offset": "string"
                  }
               }
            },
            "transform": { 
               "expression": "string",
               "processingConfig": { 
                  "computeLocation": "string",
                  "forwardingConfig": { 
                     "state": "string"
                  }
               },
               "variables": [ 
                  { 
                     "name": "string",
                     "value": { 
                        "hierarchyId": "string",
                        "propertyId": "string",
                        "propertyPath": [ 
                           { 
                              "id": "string",
                              "name": "string"
                           }
                        ]
                     }
                  }
               ]
            }
         },
         "unit": "string"
      }
   ],
   "clientToken": "string"
}
```

## URI Request Parameters
<a name="API_UpdateAssetModel_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assetModelId](#API_UpdateAssetModel_RequestSyntax) **   <a name="iotsitewise-UpdateAssetModel-request-uri-assetModelId"></a>
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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) in the * AWS IoT SiteWise User Guide*.  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+`   
Required: Yes

 ** [ifMatch](#API_UpdateAssetModel_RequestSyntax) **   <a name="iotsitewise-UpdateAssetModel-request-ifMatch"></a>
The expected current entity tag (ETag) for the asset model’s latest or active version (specified using `matchForVersionType`). The update request is rejected if the tag does not match the latest or active version's current entity tag. See [Optimistic locking for asset model writes](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/opt-locking-for-model.html) in the * AWS IoT SiteWise User Guide*.  
Pattern: `^[\w-]{43}$` 

 ** [ifNoneMatch](#API_UpdateAssetModel_RequestSyntax) **   <a name="iotsitewise-UpdateAssetModel-request-ifNoneMatch"></a>
Accepts **\$1** to reject the update request if an active version (specified using `matchForVersionType` as `ACTIVE`) already exists for the asset model.  
Pattern: `\*` 

 ** [matchForVersionType](#API_UpdateAssetModel_RequestSyntax) **   <a name="iotsitewise-UpdateAssetModel-request-matchForVersionType"></a>
Specifies the asset model version type (`LATEST` or `ACTIVE`) used in conjunction with `If-Match` or `If-None-Match` headers to determine the target ETag for the update operation.  
Valid Values: `LATEST | ACTIVE` 

## Request Body
<a name="API_UpdateAssetModel_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [assetModelCompositeModels](#API_UpdateAssetModel_RequestSyntax) **   <a name="iotsitewise-UpdateAssetModel-request-assetModelCompositeModels"></a>
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](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html). For more information, see [Creating custom composite models (Components)](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-custom-composite-models.html) in the * AWS IoT SiteWise User Guide*.
Type: Array of [AssetModelCompositeModel](API_AssetModelCompositeModel.md) objects  
Required: No

 ** [assetModelDescription](#API_UpdateAssetModel_RequestSyntax) **   <a name="iotsitewise-UpdateAssetModel-request-assetModelDescription"></a>
A description for the asset model.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[^\u0000-\u001F\u007F]+`   
Required: No

 ** [assetModelExternalId](#API_UpdateAssetModel_RequestSyntax) **   <a name="iotsitewise-UpdateAssetModel-request-assetModelExternalId"></a>
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 AWS account. For more information, see [Using external IDs](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) in the * AWS IoT SiteWise User Guide*.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+`   
Required: No

 ** [assetModelHierarchies](#API_UpdateAssetModel_RequestSyntax) **   <a name="iotsitewise-UpdateAssetModel-request-assetModelHierarchies"></a>
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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html) in the * AWS IoT SiteWise User Guide*.  
You can specify up to 10 hierarchies per asset model. For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
Type: Array of [AssetModelHierarchy](API_AssetModelHierarchy.md) objects  
Required: No

 ** [assetModelName](#API_UpdateAssetModel_RequestSyntax) **   <a name="iotsitewise-UpdateAssetModel-request-assetModelName"></a>
A unique name for the asset model.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[^\u0000-\u001F\u007F]+`   
Required: Yes

 ** [assetModelProperties](#API_UpdateAssetModel_RequestSyntax) **   <a name="iotsitewise-UpdateAssetModel-request-assetModelProperties"></a>
The updated property definitions of the asset model. For more information, see [Asset properties](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html) in the * AWS IoT SiteWise User Guide*.  
You can specify up to 200 properties per asset model. For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
Type: Array of [AssetModelProperty](API_AssetModelProperty.md) objects  
Required: No

 ** [clientToken](#API_UpdateAssetModel_RequestSyntax) **   <a name="iotsitewise-UpdateAssetModel-request-clientToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 36. Maximum length of 64.  
Pattern: `\S{36,64}`   
Required: No

## Response Syntax
<a name="API_UpdateAssetModel_ResponseSyntax"></a>

```
HTTP/1.1 202
Content-type: application/json

{
   "assetModelStatus": { 
      "error": { 
         "code": "string",
         "details": [ 
            { 
               "code": "string",
               "message": "string"
            }
         ],
         "message": "string"
      },
      "state": "string"
   }
}
```

## Response Elements
<a name="API_UpdateAssetModel_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

 ** [assetModelStatus](#API_UpdateAssetModel_ResponseSyntax) **   <a name="iotsitewise-UpdateAssetModel-response-assetModelStatus"></a>
The status of the asset model, which contains a state (`UPDATING` after successfully calling this operation) and any error message.  
Type: [AssetModelStatus](API_AssetModelStatus.md) object

## Errors
<a name="API_UpdateAssetModel_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictingOperationException **   
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.    
 ** resourceArn **   
The ARN of the resource that conflicts with this operation.  
 ** resourceId **   
The ID of the resource that conflicts with this operation.
HTTP Status Code: 409

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** LimitExceededException **   
You've reached the quota for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 410

 ** PreconditionFailedException **   
The precondition in one or more of the request-header fields evaluated to `FALSE`.    
 ** resourceArn **   
The ARN of the resource on which precondition failed with this operation.  
 ** resourceId **   
The ID of the resource on which precondition failed with this operation.
HTTP Status Code: 412

 ** ResourceAlreadyExistsException **   
The resource already exists.    
 ** resourceArn **   
The ARN of the resource that already exists.  
 ** resourceId **   
The ID of the resource that already exists.
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateAssetModel_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/UpdateAssetModel) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/UpdateAssetModel) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/UpdateAssetModel) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/UpdateAssetModel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/UpdateAssetModel) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/UpdateAssetModel) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/UpdateAssetModel) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/UpdateAssetModel) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/UpdateAssetModel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/UpdateAssetModel) 

# UpdateAssetModelCompositeModel
<a name="API_UpdateAssetModelCompositeModel"></a>

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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-assets-and-models.html) in the * AWS IoT SiteWise User Guide*.

**Important**  
If you remove a property from a composite asset model, AWS IoT SiteWise deletes all previous data for that property. You can’t change the type or data type of an existing property.  
To replace an existing composite asset model property with a new one with the same `name`, do the following:  
Submit an `UpdateAssetModelCompositeModel` request with the entire existing property removed.
Submit a second `UpdateAssetModelCompositeModel` request that includes the new property. The new asset property will have the same `name` as the previous one and AWS IoT SiteWise will generate a new unique `id`.

## Request Syntax
<a name="API_UpdateAssetModelCompositeModel_RequestSyntax"></a>

```
PUT /asset-models/assetModelId/composite-models/assetModelCompositeModelId HTTP/1.1
If-Match: ifMatch
If-None-Match: ifNoneMatch
Match-For-Version-Type: matchForVersionType
Content-type: application/json

{
   "assetModelCompositeModelDescription": "string",
   "assetModelCompositeModelExternalId": "string",
   "assetModelCompositeModelName": "string",
   "assetModelCompositeModelProperties": [ 
      { 
         "dataType": "string",
         "dataTypeSpec": "string",
         "externalId": "string",
         "id": "string",
         "name": "string",
         "path": [ 
            { 
               "id": "string",
               "name": "string"
            }
         ],
         "type": { 
            "attribute": { 
               "defaultValue": "string"
            },
            "measurement": { 
               "processingConfig": { 
                  "forwardingConfig": { 
                     "state": "string"
                  }
               }
            },
            "metric": { 
               "expression": "string",
               "processingConfig": { 
                  "computeLocation": "string"
               },
               "variables": [ 
                  { 
                     "name": "string",
                     "value": { 
                        "hierarchyId": "string",
                        "propertyId": "string",
                        "propertyPath": [ 
                           { 
                              "id": "string",
                              "name": "string"
                           }
                        ]
                     }
                  }
               ],
               "window": { 
                  "tumbling": { 
                     "interval": "string",
                     "offset": "string"
                  }
               }
            },
            "transform": { 
               "expression": "string",
               "processingConfig": { 
                  "computeLocation": "string",
                  "forwardingConfig": { 
                     "state": "string"
                  }
               },
               "variables": [ 
                  { 
                     "name": "string",
                     "value": { 
                        "hierarchyId": "string",
                        "propertyId": "string",
                        "propertyPath": [ 
                           { 
                              "id": "string",
                              "name": "string"
                           }
                        ]
                     }
                  }
               ]
            }
         },
         "unit": "string"
      }
   ],
   "clientToken": "string"
}
```

## URI Request Parameters
<a name="API_UpdateAssetModelCompositeModel_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assetModelCompositeModelId](#API_UpdateAssetModelCompositeModel_RequestSyntax) **   <a name="iotsitewise-UpdateAssetModelCompositeModel-request-uri-assetModelCompositeModelId"></a>
The ID of a composite model on this asset model.  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+`   
Required: Yes

 ** [assetModelId](#API_UpdateAssetModelCompositeModel_RequestSyntax) **   <a name="iotsitewise-UpdateAssetModelCompositeModel-request-uri-assetModelId"></a>
The ID of the asset model, in UUID format.  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+`   
Required: Yes

 ** [ifMatch](#API_UpdateAssetModelCompositeModel_RequestSyntax) **   <a name="iotsitewise-UpdateAssetModelCompositeModel-request-ifMatch"></a>
The expected current entity tag (ETag) for the asset model’s latest or active version (specified using `matchForVersionType`). The update request is rejected if the tag does not match the latest or active version's current entity tag. See [Optimistic locking for asset model writes](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/opt-locking-for-model.html) in the * AWS IoT SiteWise User Guide*.  
Pattern: `^[\w-]{43}$` 

 ** [ifNoneMatch](#API_UpdateAssetModelCompositeModel_RequestSyntax) **   <a name="iotsitewise-UpdateAssetModelCompositeModel-request-ifNoneMatch"></a>
Accepts **\$1** to reject the update request if an active version (specified using `matchForVersionType` as `ACTIVE`) already exists for the asset model.  
Pattern: `\*` 

 ** [matchForVersionType](#API_UpdateAssetModelCompositeModel_RequestSyntax) **   <a name="iotsitewise-UpdateAssetModelCompositeModel-request-matchForVersionType"></a>
Specifies the asset model version type (`LATEST` or `ACTIVE`) used in conjunction with `If-Match` or `If-None-Match` headers to determine the target ETag for the update operation.  
Valid Values: `LATEST | ACTIVE` 

## Request Body
<a name="API_UpdateAssetModelCompositeModel_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [assetModelCompositeModelDescription](#API_UpdateAssetModelCompositeModel_RequestSyntax) **   <a name="iotsitewise-UpdateAssetModelCompositeModel-request-assetModelCompositeModelDescription"></a>
A description for the composite model.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[^\u0000-\u001F\u007F]+`   
Required: No

 ** [assetModelCompositeModelExternalId](#API_UpdateAssetModelCompositeModel_RequestSyntax) **   <a name="iotsitewise-UpdateAssetModelCompositeModel-request-assetModelCompositeModelExternalId"></a>
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.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+`   
Required: No

 ** [assetModelCompositeModelName](#API_UpdateAssetModelCompositeModel_RequestSyntax) **   <a name="iotsitewise-UpdateAssetModelCompositeModel-request-assetModelCompositeModelName"></a>
A unique name for the composite model.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[^\u0000-\u001F\u007F]+`   
Required: Yes

 ** [assetModelCompositeModelProperties](#API_UpdateAssetModelCompositeModel_RequestSyntax) **   <a name="iotsitewise-UpdateAssetModelCompositeModel-request-assetModelCompositeModelProperties"></a>
The property definitions of the composite model. For more information, see [ Inline custom composite models](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/custom-composite-models.html#inline-composite-models) in the * AWS IoT SiteWise User Guide*.  
You can specify up to 200 properties per composite model. For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
Type: Array of [AssetModelProperty](API_AssetModelProperty.md) objects  
Required: No

 ** [clientToken](#API_UpdateAssetModelCompositeModel_RequestSyntax) **   <a name="iotsitewise-UpdateAssetModelCompositeModel-request-clientToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 36. Maximum length of 64.  
Pattern: `\S{36,64}`   
Required: No

## Response Syntax
<a name="API_UpdateAssetModelCompositeModel_ResponseSyntax"></a>

```
HTTP/1.1 202
Content-type: application/json

{
   "assetModelCompositeModelPath": [ 
      { 
         "id": "string",
         "name": "string"
      }
   ],
   "assetModelStatus": { 
      "error": { 
         "code": "string",
         "details": [ 
            { 
               "code": "string",
               "message": "string"
            }
         ],
         "message": "string"
      },
      "state": "string"
   }
}
```

## Response Elements
<a name="API_UpdateAssetModelCompositeModel_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

 ** [assetModelCompositeModelPath](#API_UpdateAssetModelCompositeModel_ResponseSyntax) **   <a name="iotsitewise-UpdateAssetModelCompositeModel-response-assetModelCompositeModelPath"></a>
The path to the composite model listing the parent composite models.  
Type: Array of [AssetModelCompositeModelPathSegment](API_AssetModelCompositeModelPathSegment.md) objects

 ** [assetModelStatus](#API_UpdateAssetModelCompositeModel_ResponseSyntax) **   <a name="iotsitewise-UpdateAssetModelCompositeModel-response-assetModelStatus"></a>
Contains current status information for an asset model. For more information, see [Asset and model states](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-and-model-states.html) in the * AWS IoT SiteWise User Guide*.  
Type: [AssetModelStatus](API_AssetModelStatus.md) object

## Errors
<a name="API_UpdateAssetModelCompositeModel_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictingOperationException **   
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.    
 ** resourceArn **   
The ARN of the resource that conflicts with this operation.  
 ** resourceId **   
The ID of the resource that conflicts with this operation.
HTTP Status Code: 409

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** LimitExceededException **   
You've reached the quota for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 410

 ** PreconditionFailedException **   
The precondition in one or more of the request-header fields evaluated to `FALSE`.    
 ** resourceArn **   
The ARN of the resource on which precondition failed with this operation.  
 ** resourceId **   
The ID of the resource on which precondition failed with this operation.
HTTP Status Code: 412

 ** ResourceAlreadyExistsException **   
The resource already exists.    
 ** resourceArn **   
The ARN of the resource that already exists.  
 ** resourceId **   
The ID of the resource that already exists.
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateAssetModelCompositeModel_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/UpdateAssetModelCompositeModel) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/UpdateAssetModelCompositeModel) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/UpdateAssetModelCompositeModel) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/UpdateAssetModelCompositeModel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/UpdateAssetModelCompositeModel) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/UpdateAssetModelCompositeModel) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/UpdateAssetModelCompositeModel) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/UpdateAssetModelCompositeModel) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/UpdateAssetModelCompositeModel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/UpdateAssetModelCompositeModel) 

# UpdateAssetProperty
<a name="API_UpdateAssetProperty"></a>

Updates an asset property's alias and notification state.

**Important**  
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](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetProperty.html).

## Request Syntax
<a name="API_UpdateAssetProperty_RequestSyntax"></a>

```
PUT /assets/assetId/properties/propertyId HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "propertyAlias": "string",
   "propertyNotificationState": "string",
   "propertyUnit": "string"
}
```

## URI Request Parameters
<a name="API_UpdateAssetProperty_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assetId](#API_UpdateAssetProperty_RequestSyntax) **   <a name="iotsitewise-UpdateAssetProperty-request-uri-assetId"></a>
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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) in the * AWS IoT SiteWise User Guide*.  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+`   
Required: Yes

 ** [propertyId](#API_UpdateAssetProperty_RequestSyntax) **   <a name="iotsitewise-UpdateAssetProperty-request-uri-propertyId"></a>
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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) in the * AWS IoT SiteWise User Guide*.  
Length Constraints: Minimum length of 13. Maximum length of 139.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+`   
Required: Yes

## Request Body
<a name="API_UpdateAssetProperty_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_UpdateAssetProperty_RequestSyntax) **   <a name="iotsitewise-UpdateAssetProperty-request-clientToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 36. Maximum length of 64.  
Pattern: `\S{36,64}`   
Required: No

 ** [propertyAlias](#API_UpdateAssetProperty_RequestSyntax) **   <a name="iotsitewise-UpdateAssetProperty-request-propertyAlias"></a>
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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) in the * AWS IoT SiteWise User Guide*.  
If you omit this parameter, the alias is removed from the property.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Pattern: `[^\u0000-\u001F\u007F]+`   
Required: No

 ** [propertyNotificationState](#API_UpdateAssetProperty_RequestSyntax) **   <a name="iotsitewise-UpdateAssetProperty-request-propertyNotificationState"></a>
The MQTT notification state (enabled or disabled) for this asset property. When the notification state is enabled, AWS IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see [Interacting with other services](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html) in the * AWS IoT SiteWise User Guide*.  
If you omit this parameter, the notification state is set to `DISABLED`.  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

 ** [propertyUnit](#API_UpdateAssetProperty_RequestSyntax) **   <a name="iotsitewise-UpdateAssetProperty-request-propertyUnit"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[^\u0000-\u001F\u007F]+`   
Required: No

## Response Syntax
<a name="API_UpdateAssetProperty_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateAssetProperty_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateAssetProperty_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictingOperationException **   
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.    
 ** resourceArn **   
The ARN of the resource that conflicts with this operation.  
 ** resourceId **   
The ID of the resource that conflicts with this operation.
HTTP Status Code: 409

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateAssetProperty_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/UpdateAssetProperty) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/UpdateAssetProperty) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/UpdateAssetProperty) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/UpdateAssetProperty) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/UpdateAssetProperty) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/UpdateAssetProperty) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/UpdateAssetProperty) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/UpdateAssetProperty) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/UpdateAssetProperty) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/UpdateAssetProperty) 

# UpdateComputationModel
<a name="API_UpdateComputationModel"></a>

Updates the computation model.

## Request Syntax
<a name="API_UpdateComputationModel_RequestSyntax"></a>

```
POST /computation-models/computationModelId HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "computationModelConfiguration": { 
      "anomalyDetection": { 
         "inputProperties": "string",
         "resultProperty": "string"
      }
   },
   "computationModelDataBinding": { 
      "string" : { 
         "assetModelProperty": { 
            "assetModelId": "string",
            "propertyId": "string"
         },
         "assetProperty": { 
            "assetId": "string",
            "propertyId": "string"
         },
         "list": [ 
            "ComputationModelDataBindingValue"
         ]
      }
   },
   "computationModelDescription": "string",
   "computationModelName": "string"
}
```

## URI Request Parameters
<a name="API_UpdateComputationModel_RequestParameters"></a>

The request uses the following URI parameters.

 ** [computationModelId](#API_UpdateComputationModel_RequestSyntax) **   <a name="iotsitewise-UpdateComputationModel-request-uri-computationModelId"></a>
The ID of the computation model.  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`   
Required: Yes

## Request Body
<a name="API_UpdateComputationModel_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_UpdateComputationModel_RequestSyntax) **   <a name="iotsitewise-UpdateComputationModel-request-clientToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 36. Maximum length of 64.  
Pattern: `\S{36,64}`   
Required: No

 ** [computationModelConfiguration](#API_UpdateComputationModel_RequestSyntax) **   <a name="iotsitewise-UpdateComputationModel-request-computationModelConfiguration"></a>
The configuration for the computation model.  
Type: [ComputationModelConfiguration](API_ComputationModelConfiguration.md) object  
Required: Yes

 ** [computationModelDataBinding](#API_UpdateComputationModel_RequestSyntax) **   <a name="iotsitewise-UpdateComputationModel-request-computationModelDataBinding"></a>
The data binding for the computation model. Key is a variable name defined in configuration. Value is a `ComputationModelDataBindingValue` referenced by the variable.  
Type: String to [ComputationModelDataBindingValue](API_ComputationModelDataBindingValue.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 64.  
Key Pattern: `^[a-z][a-z0-9_]*$`   
Required: Yes

 ** [computationModelDescription](#API_UpdateComputationModel_RequestSyntax) **   <a name="iotsitewise-UpdateComputationModel-request-computationModelDescription"></a>
The description of the computation model.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^[a-zA-Z0-9 _\-#$*!@]+$`   
Required: No

 ** [computationModelName](#API_UpdateComputationModel_RequestSyntax) **   <a name="iotsitewise-UpdateComputationModel-request-computationModelName"></a>
The name of the computation model.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^[a-zA-Z0-9 _\-#$*!@]+$`   
Required: Yes

## Response Syntax
<a name="API_UpdateComputationModel_ResponseSyntax"></a>

```
HTTP/1.1 202
Content-type: application/json

{
   "computationModelStatus": { 
      "error": { 
         "code": "string",
         "details": [ 
            { 
               "code": "string",
               "message": "string"
            }
         ],
         "message": "string"
      },
      "state": "string"
   }
}
```

## Response Elements
<a name="API_UpdateComputationModel_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

 ** [computationModelStatus](#API_UpdateComputationModel_ResponseSyntax) **   <a name="iotsitewise-UpdateComputationModel-response-computationModelStatus"></a>
The status of the computation model. It contains a state (UPDATING after successfully calling this operation) and an error message if any.  
Type: [ComputationModelStatus](API_ComputationModelStatus.md) object

## Errors
<a name="API_UpdateComputationModel_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictingOperationException **   
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.    
 ** resourceArn **   
The ARN of the resource that conflicts with this operation.  
 ** resourceId **   
The ID of the resource that conflicts with this operation.
HTTP Status Code: 409

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** LimitExceededException **   
You've reached the quota for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 410

 ** ResourceAlreadyExistsException **   
The resource already exists.    
 ** resourceArn **   
The ARN of the resource that already exists.  
 ** resourceId **   
The ID of the resource that already exists.
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateComputationModel_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/UpdateComputationModel) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/UpdateComputationModel) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/UpdateComputationModel) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/UpdateComputationModel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/UpdateComputationModel) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/UpdateComputationModel) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/UpdateComputationModel) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/UpdateComputationModel) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/UpdateComputationModel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/UpdateComputationModel) 

# UpdateDashboard
<a name="API_UpdateDashboard"></a>

**Important**  
The AWS IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025 . If you would like to use the AWS IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS IoT SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).

Updates an AWS IoT SiteWise Monitor dashboard.

## Request Syntax
<a name="API_UpdateDashboard_RequestSyntax"></a>

```
PUT /dashboards/dashboardId HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "dashboardDefinition": "string",
   "dashboardDescription": "string",
   "dashboardName": "string"
}
```

## URI Request Parameters
<a name="API_UpdateDashboard_RequestParameters"></a>

The request uses the following URI parameters.

 ** [dashboardId](#API_UpdateDashboard_RequestSyntax) **   <a name="iotsitewise-UpdateDashboard-request-uri-dashboardId"></a>
The ID of the dashboard to update.  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`   
Required: Yes

## Request Body
<a name="API_UpdateDashboard_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_UpdateDashboard_RequestSyntax) **   <a name="iotsitewise-UpdateDashboard-request-clientToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 36. Maximum length of 64.  
Pattern: `\S{36,64}`   
Required: No

 ** [dashboardDefinition](#API_UpdateDashboard_RequestSyntax) **   <a name="iotsitewise-UpdateDashboard-request-dashboardDefinition"></a>
The new dashboard definition, as specified in a JSON literal.  
+  AWS IoT SiteWise Monitor (Classic) see [Create dashboards (AWS CLI)](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html) 
+  AWS IoT SiteWise Monitor (AI-aware) see [Create dashboards (AWS CLI)](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-ai-dashboard-cli.html) 
in the * AWS IoT SiteWise User Guide*   
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 204800.  
Pattern: `.+`   
Required: Yes

 ** [dashboardDescription](#API_UpdateDashboard_RequestSyntax) **   <a name="iotsitewise-UpdateDashboard-request-dashboardDescription"></a>
A new description for the dashboard.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[^\u0000-\u001F\u007F]+`   
Required: No

 ** [dashboardName](#API_UpdateDashboard_RequestSyntax) **   <a name="iotsitewise-UpdateDashboard-request-dashboardName"></a>
A new friendly name for the dashboard.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[^\u0000-\u001F\u007F]+`   
Required: Yes

## Response Syntax
<a name="API_UpdateDashboard_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateDashboard_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateDashboard_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateDashboard_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/UpdateDashboard) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/UpdateDashboard) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/UpdateDashboard) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/UpdateDashboard) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/UpdateDashboard) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/UpdateDashboard) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/UpdateDashboard) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/UpdateDashboard) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/UpdateDashboard) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/UpdateDashboard) 

# UpdateDataset
<a name="API_UpdateDataset"></a>

Updates a dataset.

## Request Syntax
<a name="API_UpdateDataset_RequestSyntax"></a>

```
PUT /datasets/datasetId HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "datasetDescription": "string",
   "datasetName": "string",
   "datasetSource": { 
      "sourceDetail": { 
         "kendra": { 
            "knowledgeBaseArn": "string",
            "roleArn": "string"
         }
      },
      "sourceFormat": "string",
      "sourceType": "string"
   }
}
```

## URI Request Parameters
<a name="API_UpdateDataset_RequestParameters"></a>

The request uses the following URI parameters.

 ** [datasetId](#API_UpdateDataset_RequestSyntax) **   <a name="iotsitewise-UpdateDataset-request-uri-datasetId"></a>
The ID of the dataset.  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`   
Required: Yes

## Request Body
<a name="API_UpdateDataset_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_UpdateDataset_RequestSyntax) **   <a name="iotsitewise-UpdateDataset-request-clientToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 36. Maximum length of 64.  
Pattern: `\S{36,64}`   
Required: No

 ** [datasetDescription](#API_UpdateDataset_RequestSyntax) **   <a name="iotsitewise-UpdateDataset-request-datasetDescription"></a>
A description about the dataset, and its functionality.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^[a-zA-Z0-9 _\-#$*!@]+$`   
Required: No

 ** [datasetName](#API_UpdateDataset_RequestSyntax) **   <a name="iotsitewise-UpdateDataset-request-datasetName"></a>
The name of the dataset.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^[a-zA-Z0-9 _\-#$*!@]+$`   
Required: Yes

 ** [datasetSource](#API_UpdateDataset_RequestSyntax) **   <a name="iotsitewise-UpdateDataset-request-datasetSource"></a>
The data source for the dataset.  
Type: [DatasetSource](API_DatasetSource.md) object  
Required: Yes

## Response Syntax
<a name="API_UpdateDataset_ResponseSyntax"></a>

```
HTTP/1.1 202
Content-type: application/json

{
   "datasetArn": "string",
   "datasetId": "string",
   "datasetStatus": { 
      "error": { 
         "code": "string",
         "details": [ 
            { 
               "code": "string",
               "message": "string"
            }
         ],
         "message": "string"
      },
      "state": "string"
   }
}
```

## Response Elements
<a name="API_UpdateDataset_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

 ** [datasetArn](#API_UpdateDataset_ResponseSyntax) **   <a name="iotsitewise-UpdateDataset-response-datasetArn"></a>
The [ARN](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html) of the dataset. The format is `arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId}`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$` 

 ** [datasetId](#API_UpdateDataset_ResponseSyntax) **   <a name="iotsitewise-UpdateDataset-response-datasetId"></a>
The ID of the dataset.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` 

 ** [datasetStatus](#API_UpdateDataset_ResponseSyntax) **   <a name="iotsitewise-UpdateDataset-response-datasetStatus"></a>
The status of the dataset. This contains the state and any error messages. State is `UPDATING` after a successfull call to this API, and any associated error message. The state is `ACTIVE` when ready to use.  
Type: [DatasetStatus](API_DatasetStatus.md) object

## Errors
<a name="API_UpdateDataset_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictingOperationException **   
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.    
 ** resourceArn **   
The ARN of the resource that conflicts with this operation.  
 ** resourceId **   
The ID of the resource that conflicts with this operation.
HTTP Status Code: 409

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** LimitExceededException **   
You've reached the quota for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 410

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateDataset_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/UpdateDataset) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/UpdateDataset) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/UpdateDataset) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/UpdateDataset) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/UpdateDataset) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/UpdateDataset) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/UpdateDataset) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/UpdateDataset) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/UpdateDataset) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/UpdateDataset) 

# UpdateGateway
<a name="API_UpdateGateway"></a>

Updates a gateway's name.

## Request Syntax
<a name="API_UpdateGateway_RequestSyntax"></a>

```
PUT /20200301/gateways/gatewayId HTTP/1.1
Content-type: application/json

{
   "gatewayName": "string"
}
```

## URI Request Parameters
<a name="API_UpdateGateway_RequestParameters"></a>

The request uses the following URI parameters.

 ** [gatewayId](#API_UpdateGateway_RequestSyntax) **   <a name="iotsitewise-UpdateGateway-request-uri-gatewayId"></a>
The ID of the gateway to update.  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`   
Required: Yes

## Request Body
<a name="API_UpdateGateway_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [gatewayName](#API_UpdateGateway_RequestSyntax) **   <a name="iotsitewise-UpdateGateway-request-gatewayName"></a>
A unique name for the gateway.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[^\u0000-\u001F\u007F]+`   
Required: Yes

## Response Syntax
<a name="API_UpdateGateway_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateGateway_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateGateway_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictingOperationException **   
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.    
 ** resourceArn **   
The ARN of the resource that conflicts with this operation.  
 ** resourceId **   
The ID of the resource that conflicts with this operation.
HTTP Status Code: 409

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateGateway_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/UpdateGateway) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/UpdateGateway) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/UpdateGateway) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/UpdateGateway) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/UpdateGateway) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/UpdateGateway) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/UpdateGateway) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/UpdateGateway) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/UpdateGateway) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/UpdateGateway) 

# UpdateGatewayCapabilityConfiguration
<a name="API_UpdateGatewayCapabilityConfiguration"></a>

Updates a gateway capability configuration or defines a new capability configuration. Each gateway capability defines data sources for a gateway.

Important workflow notes:

Each gateway capability defines data sources for a gateway. This is the namespace of the gateway capability.

. The namespace follows the format `service:capability:version`, where:
+  `service` - The service providing the capability, or `iotsitewise`.
+  `capability` - The specific capability type. Options include: `opcuacollector` for the OPC UA data source collector, or `publisher` for data publisher capability.
+  `version` - The version number of the capability. Option include `2` for Classic streams, V2 gateways, and `3` for MQTT-enabled, V3 gateways.

After updating a capability configuration, the sync status becomes `OUT_OF_SYNC` until the gateway processes the configuration.Use `DescribeGatewayCapabilityConfiguration` to check the sync status and verify the configuration was applied.

A gateway can have multiple capability configurations with different namespaces.

## Request Syntax
<a name="API_UpdateGatewayCapabilityConfiguration_RequestSyntax"></a>

```
POST /20200301/gateways/gatewayId/capability HTTP/1.1
Content-type: application/json

{
   "capabilityConfiguration": "string",
   "capabilityNamespace": "string"
}
```

## URI Request Parameters
<a name="API_UpdateGatewayCapabilityConfiguration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [gatewayId](#API_UpdateGatewayCapabilityConfiguration_RequestSyntax) **   <a name="iotsitewise-UpdateGatewayCapabilityConfiguration-request-uri-gatewayId"></a>
The ID of the gateway to be updated.  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`   
Required: Yes

## Request Body
<a name="API_UpdateGatewayCapabilityConfiguration_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [capabilityConfiguration](#API_UpdateGatewayCapabilityConfiguration_RequestSyntax) **   <a name="iotsitewise-UpdateGatewayCapabilityConfiguration-request-capabilityConfiguration"></a>
The JSON document that defines the configuration for the gateway capability. For more information, see [Configuring data sources (CLI)](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-sources.html#configure-source-cli) in the * AWS IoT SiteWise User Guide*.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 10000000.  
Required: Yes

 ** [capabilityNamespace](#API_UpdateGatewayCapabilityConfiguration_RequestSyntax) **   <a name="iotsitewise-UpdateGatewayCapabilityConfiguration-request-capabilityNamespace"></a>
The namespace of the gateway capability configuration to be updated. For example, if you configure OPC UA sources for an MQTT-enabled gateway, your OPC-UA capability configuration has the namespace `iotsitewise:opcuacollector:3`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 512.  
Pattern: `^[a-zA-Z]+:[a-zA-Z]+:[0-9]+$`   
Required: Yes

## Response Syntax
<a name="API_UpdateGatewayCapabilityConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "capabilityNamespace": "string",
   "capabilitySyncStatus": "string"
}
```

## Response Elements
<a name="API_UpdateGatewayCapabilityConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [capabilityNamespace](#API_UpdateGatewayCapabilityConfiguration_ResponseSyntax) **   <a name="iotsitewise-UpdateGatewayCapabilityConfiguration-response-capabilityNamespace"></a>
The namespace of the gateway capability.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 512.  
Pattern: `^[a-zA-Z]+:[a-zA-Z]+:[0-9]+$` 

 ** [capabilitySyncStatus](#API_UpdateGatewayCapabilityConfiguration_ResponseSyntax) **   <a name="iotsitewise-UpdateGatewayCapabilityConfiguration-response-capabilitySyncStatus"></a>
The synchronization status of the gateway capability configuration. The sync status can be one of the following:  
+  `IN_SYNC` - The gateway is running with the latest configuration.
+  `OUT_OF_SYNC` - The gateway hasn't received the latest configuration.
+  `SYNC_FAILED` - The gateway rejected the latest configuration.
+  `UNKNOWN` - The gateway hasn't reported its sync status.
+  `NOT_APPLICABLE` - The gateway doesn't support this capability. This is most common when integrating partner data sources, because the data integration is handled externally by the partner.
After you update a capability configuration, its sync status is `OUT_OF_SYNC` until the gateway receives and applies or rejects the updated configuration.  
Type: String  
Valid Values: `IN_SYNC | OUT_OF_SYNC | SYNC_FAILED | UNKNOWN | NOT_APPLICABLE` 

## Errors
<a name="API_UpdateGatewayCapabilityConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictingOperationException **   
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.    
 ** resourceArn **   
The ARN of the resource that conflicts with this operation.  
 ** resourceId **   
The ID of the resource that conflicts with this operation.
HTTP Status Code: 409

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** LimitExceededException **   
You've reached the quota for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 410

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateGatewayCapabilityConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/UpdateGatewayCapabilityConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/UpdateGatewayCapabilityConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/UpdateGatewayCapabilityConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/UpdateGatewayCapabilityConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/UpdateGatewayCapabilityConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/UpdateGatewayCapabilityConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/UpdateGatewayCapabilityConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/UpdateGatewayCapabilityConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/UpdateGatewayCapabilityConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/UpdateGatewayCapabilityConfiguration) 

# UpdatePortal
<a name="API_UpdatePortal"></a>

**Important**  
The AWS IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025 . If you would like to use the AWS IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS IoT SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).

Updates an AWS IoT SiteWise Monitor portal.

## Request Syntax
<a name="API_UpdatePortal_RequestSyntax"></a>

```
PUT /portals/portalId HTTP/1.1
Content-type: application/json

{
   "alarms": { 
      "alarmRoleArn": "string",
      "notificationLambdaArn": "string"
   },
   "clientToken": "string",
   "notificationSenderEmail": "string",
   "portalContactEmail": "string",
   "portalDescription": "string",
   "portalLogoImage": { 
      "file": { 
         "data": blob,
         "type": "string"
      },
      "id": "string"
   },
   "portalName": "string",
   "portalType": "string",
   "portalTypeConfiguration": { 
      "string" : { 
         "portalTools": [ "string" ]
      }
   },
   "roleArn": "string"
}
```

## URI Request Parameters
<a name="API_UpdatePortal_RequestParameters"></a>

The request uses the following URI parameters.

 ** [portalId](#API_UpdatePortal_RequestSyntax) **   <a name="iotsitewise-UpdatePortal-request-uri-portalId"></a>
The ID of the portal to update.  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`   
Required: Yes

## Request Body
<a name="API_UpdatePortal_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [alarms](#API_UpdatePortal_RequestSyntax) **   <a name="iotsitewise-UpdatePortal-request-alarms"></a>
Contains the configuration information of an alarm created in an AWS 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](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html) in the * AWS IoT SiteWise Application Guide*.  
Type: [Alarms](API_Alarms.md) object  
Required: No

 ** [clientToken](#API_UpdatePortal_RequestSyntax) **   <a name="iotsitewise-UpdatePortal-request-clientToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 36. Maximum length of 64.  
Pattern: `\S{36,64}`   
Required: No

 ** [notificationSenderEmail](#API_UpdatePortal_RequestSyntax) **   <a name="iotsitewise-UpdatePortal-request-notificationSenderEmail"></a>
The email address that sends alarm notifications.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z0-9_\-\.\+]+@[a-zA-Z0-9_\-\.\+]+\.[a-zA-Z]{2,}$`   
Required: No

 ** [portalContactEmail](#API_UpdatePortal_RequestSyntax) **   <a name="iotsitewise-UpdatePortal-request-portalContactEmail"></a>
The AWS administrator's contact email address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z0-9_\-\.\+]+@[a-zA-Z0-9_\-\.\+]+\.[a-zA-Z]{2,}$`   
Required: Yes

 ** [portalDescription](#API_UpdatePortal_RequestSyntax) **   <a name="iotsitewise-UpdatePortal-request-portalDescription"></a>
A new description for the portal.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[^\u0000-\u001F\u007F]+`   
Required: No

 ** [portalLogoImage](#API_UpdatePortal_RequestSyntax) **   <a name="iotsitewise-UpdatePortal-request-portalLogoImage"></a>
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.
Type: [Image](API_Image.md) object  
Required: No

 ** [portalName](#API_UpdatePortal_RequestSyntax) **   <a name="iotsitewise-UpdatePortal-request-portalName"></a>
A new friendly name for the portal.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[^\u0000-\u001F\u007F]+`   
Required: Yes

 ** [portalType](#API_UpdatePortal_RequestSyntax) **   <a name="iotsitewise-UpdatePortal-request-portalType"></a>
Define the type of portal. The value for AWS IoT SiteWise Monitor (Classic) is `SITEWISE_PORTAL_V1`. The value for AWS IoT SiteWise Monitor (AI-aware) is `SITEWISE_PORTAL_V2`.  
Type: String  
Valid Values: `SITEWISE_PORTAL_V1 | SITEWISE_PORTAL_V2`   
Required: No

 ** [portalTypeConfiguration](#API_UpdatePortal_RequestSyntax) **   <a name="iotsitewise-UpdatePortal-request-portalTypeConfiguration"></a>
The configuration entry associated with the specific portal type. The value for AWS IoT SiteWise Monitor (Classic) is `SITEWISE_PORTAL_V1`. The value for AWS IoT SiteWise Monitor (AI-aware) is `SITEWISE_PORTAL_V2`.  
Type: String to [PortalTypeEntry](API_PortalTypeEntry.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: No

 ** [roleArn](#API_UpdatePortal_RequestSyntax) **   <a name="iotsitewise-UpdatePortal-request-roleArn"></a>
The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf. For more information, see [Using service roles for AWS IoT SiteWise Monitor](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html) in the * AWS IoT SiteWise User Guide*.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.\+=,@]+$`   
Required: Yes

## Response Syntax
<a name="API_UpdatePortal_ResponseSyntax"></a>

```
HTTP/1.1 202
Content-type: application/json

{
   "portalStatus": { 
      "error": { 
         "code": "string",
         "message": "string"
      },
      "state": "string"
   }
}
```

## Response Elements
<a name="API_UpdatePortal_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

 ** [portalStatus](#API_UpdatePortal_ResponseSyntax) **   <a name="iotsitewise-UpdatePortal-response-portalStatus"></a>
The status of the portal, which contains a state (`UPDATING` after successfully calling this operation) and any error message.  
Type: [PortalStatus](API_PortalStatus.md) object

## Errors
<a name="API_UpdatePortal_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictingOperationException **   
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.    
 ** resourceArn **   
The ARN of the resource that conflicts with this operation.  
 ** resourceId **   
The ID of the resource that conflicts with this operation.
HTTP Status Code: 409

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_UpdatePortal_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/UpdatePortal) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/UpdatePortal) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/UpdatePortal) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/UpdatePortal) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/UpdatePortal) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/UpdatePortal) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/UpdatePortal) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/UpdatePortal) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/UpdatePortal) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/UpdatePortal) 

# UpdateProject
<a name="API_UpdateProject"></a>

**Important**  
The AWS IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025 . If you would like to use the AWS IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS IoT SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).

Updates an AWS IoT SiteWise Monitor project.

## Request Syntax
<a name="API_UpdateProject_RequestSyntax"></a>

```
PUT /projects/projectId HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "projectDescription": "string",
   "projectName": "string"
}
```

## URI Request Parameters
<a name="API_UpdateProject_RequestParameters"></a>

The request uses the following URI parameters.

 ** [projectId](#API_UpdateProject_RequestSyntax) **   <a name="iotsitewise-UpdateProject-request-uri-projectId"></a>
The ID of the project to update.  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`   
Required: Yes

## Request Body
<a name="API_UpdateProject_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_UpdateProject_RequestSyntax) **   <a name="iotsitewise-UpdateProject-request-clientToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 36. Maximum length of 64.  
Pattern: `\S{36,64}`   
Required: No

 ** [projectDescription](#API_UpdateProject_RequestSyntax) **   <a name="iotsitewise-UpdateProject-request-projectDescription"></a>
A new description for the project.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[^\u0000-\u001F\u007F]+`   
Required: No

 ** [projectName](#API_UpdateProject_RequestSyntax) **   <a name="iotsitewise-UpdateProject-request-projectName"></a>
A new friendly name for the project.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[^\u0000-\u001F\u007F]+`   
Required: Yes

## Response Syntax
<a name="API_UpdateProject_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateProject_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateProject_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
 AWS IoT SiteWise can't process your request right now. Try again later.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource can't be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.  
For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the * AWS IoT SiteWise User Guide*.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateProject_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotsitewise-2019-12-02/UpdateProject) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotsitewise-2019-12-02/UpdateProject) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/UpdateProject) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotsitewise-2019-12-02/UpdateProject) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/UpdateProject) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotsitewise-2019-12-02/UpdateProject) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotsitewise-2019-12-02/UpdateProject) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotsitewise-2019-12-02/UpdateProject) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/UpdateProject) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/UpdateProject)