# Data Types
<a name="API_Types"></a>

The Amazon IoT TwinMaker API contains several data types that various actions use. This section describes each data type in detail.

**Note**  
The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order.

The following data types are supported:
+  [BatchPutPropertyError](API_BatchPutPropertyError.md) 
+  [BatchPutPropertyErrorEntry](API_BatchPutPropertyErrorEntry.md) 
+  [BundleInformation](API_BundleInformation.md) 
+  [ColumnDescription](API_ColumnDescription.md) 
+  [ComponentPropertyGroupRequest](API_ComponentPropertyGroupRequest.md) 
+  [ComponentPropertyGroupResponse](API_ComponentPropertyGroupResponse.md) 
+  [ComponentRequest](API_ComponentRequest.md) 
+  [ComponentResponse](API_ComponentResponse.md) 
+  [ComponentSummary](API_ComponentSummary.md) 
+  [ComponentTypeSummary](API_ComponentTypeSummary.md) 
+  [ComponentUpdateRequest](API_ComponentUpdateRequest.md) 
+  [CompositeComponentRequest](API_CompositeComponentRequest.md) 
+  [CompositeComponentTypeRequest](API_CompositeComponentTypeRequest.md) 
+  [CompositeComponentTypeResponse](API_CompositeComponentTypeResponse.md) 
+  [CompositeComponentUpdateRequest](API_CompositeComponentUpdateRequest.md) 
+  [DataConnector](API_DataConnector.md) 
+  [DataType](API_DataType.md) 
+  [DataValue](API_DataValue.md) 
+  [DestinationConfiguration](API_DestinationConfiguration.md) 
+  [EntityPropertyReference](API_EntityPropertyReference.md) 
+  [EntitySummary](API_EntitySummary.md) 
+  [ErrorDetails](API_ErrorDetails.md) 
+  [FilterByAsset](API_FilterByAsset.md) 
+  [FilterByAssetModel](API_FilterByAssetModel.md) 
+  [FilterByComponentType](API_FilterByComponentType.md) 
+  [FilterByEntity](API_FilterByEntity.md) 
+  [FunctionRequest](API_FunctionRequest.md) 
+  [FunctionResponse](API_FunctionResponse.md) 
+  [InterpolationParameters](API_InterpolationParameters.md) 
+  [IotSiteWiseSourceConfiguration](API_IotSiteWiseSourceConfiguration.md) 
+  [IotSiteWiseSourceConfigurationFilter](API_IotSiteWiseSourceConfigurationFilter.md) 
+  [IotTwinMakerDestinationConfiguration](API_IotTwinMakerDestinationConfiguration.md) 
+  [IotTwinMakerSourceConfiguration](API_IotTwinMakerSourceConfiguration.md) 
+  [IotTwinMakerSourceConfigurationFilter](API_IotTwinMakerSourceConfigurationFilter.md) 
+  [LambdaFunction](API_LambdaFunction.md) 
+  [ListComponentTypesFilter](API_ListComponentTypesFilter.md) 
+  [ListEntitiesFilter](API_ListEntitiesFilter.md) 
+  [ListMetadataTransferJobsFilter](API_ListMetadataTransferJobsFilter.md) 
+  [MetadataTransferJobProgress](API_MetadataTransferJobProgress.md) 
+  [MetadataTransferJobStatus](API_MetadataTransferJobStatus.md) 
+  [MetadataTransferJobSummary](API_MetadataTransferJobSummary.md) 
+  [OrderBy](API_OrderBy.md) 
+  [ParentEntityUpdateRequest](API_ParentEntityUpdateRequest.md) 
+  [PricingPlan](API_PricingPlan.md) 
+  [PropertyDefinitionRequest](API_PropertyDefinitionRequest.md) 
+  [PropertyDefinitionResponse](API_PropertyDefinitionResponse.md) 
+  [PropertyFilter](API_PropertyFilter.md) 
+  [PropertyGroupRequest](API_PropertyGroupRequest.md) 
+  [PropertyGroupResponse](API_PropertyGroupResponse.md) 
+  [PropertyLatestValue](API_PropertyLatestValue.md) 
+  [PropertyRequest](API_PropertyRequest.md) 
+  [PropertyResponse](API_PropertyResponse.md) 
+  [PropertySummary](API_PropertySummary.md) 
+  [PropertyValue](API_PropertyValue.md) 
+  [PropertyValueEntry](API_PropertyValueEntry.md) 
+  [PropertyValueHistory](API_PropertyValueHistory.md) 
+  [Relationship](API_Relationship.md) 
+  [RelationshipValue](API_RelationshipValue.md) 
+  [Row](API_Row.md) 
+  [S3DestinationConfiguration](API_S3DestinationConfiguration.md) 
+  [S3SourceConfiguration](API_S3SourceConfiguration.md) 
+  [SceneError](API_SceneError.md) 
+  [SceneSummary](API_SceneSummary.md) 
+  [SourceConfiguration](API_SourceConfiguration.md) 
+  [Status](API_Status.md) 
+  [SyncJobStatus](API_SyncJobStatus.md) 
+  [SyncJobSummary](API_SyncJobSummary.md) 
+  [SyncResourceFilter](API_SyncResourceFilter.md) 
+  [SyncResourceStatus](API_SyncResourceStatus.md) 
+  [SyncResourceSummary](API_SyncResourceSummary.md) 
+  [TabularConditions](API_TabularConditions.md) 
+  [WorkspaceSummary](API_WorkspaceSummary.md) 

# BatchPutPropertyError
<a name="API_BatchPutPropertyError"></a>

An error returned by the `BatchPutProperty` action.

## Contents
<a name="API_BatchPutPropertyError_Contents"></a>

 ** entry **   <a name="tm-Type-BatchPutPropertyError-entry"></a>
An object that contains information about errors returned by the `BatchPutProperty` action.  
Type: [PropertyValueEntry](API_PropertyValueEntry.md) object  
Required: Yes

 ** errorCode **   <a name="tm-Type-BatchPutPropertyError-errorCode"></a>
The error code.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `.*`   
Required: Yes

 ** errorMessage **   <a name="tm-Type-BatchPutPropertyError-errorMessage"></a>
The error message.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `.*`   
Required: Yes

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/BatchPutPropertyError) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/BatchPutPropertyError) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/BatchPutPropertyError) 

# BatchPutPropertyErrorEntry
<a name="API_BatchPutPropertyErrorEntry"></a>

An object that contains information about errors returned by the `BatchPutProperty` action.

## Contents
<a name="API_BatchPutPropertyErrorEntry_Contents"></a>

 ** errors **   <a name="tm-Type-BatchPutPropertyErrorEntry-errors"></a>
A list of objects that contain information about errors returned by the `BatchPutProperty` action.  
Type: Array of [BatchPutPropertyError](API_BatchPutPropertyError.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Required: Yes

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/BatchPutPropertyErrorEntry) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/BatchPutPropertyErrorEntry) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/BatchPutPropertyErrorEntry) 

# BundleInformation
<a name="API_BundleInformation"></a>

Information about the pricing bundle.

## Contents
<a name="API_BundleInformation_Contents"></a>

 ** bundleNames **   <a name="tm-Type-BundleInformation-bundleNames"></a>
The bundle names.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `.*`   
Required: Yes

 ** pricingTier **   <a name="tm-Type-BundleInformation-pricingTier"></a>
The pricing tier.  
Type: String  
Valid Values: `TIER_1 | TIER_2 | TIER_3 | TIER_4`   
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/BundleInformation) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/BundleInformation) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/BundleInformation) 

# ColumnDescription
<a name="API_ColumnDescription"></a>

A description of the column in the query results.

## Contents
<a name="API_ColumnDescription_Contents"></a>

 ** name **   <a name="tm-Type-ColumnDescription-name"></a>
The name of the column description.  
Type: String  
Pattern: `.*`   
Required: No

 ** type **   <a name="tm-Type-ColumnDescription-type"></a>
The type of the column description.  
Type: String  
Valid Values: `NODE | EDGE | VALUE`   
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/ColumnDescription) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/ColumnDescription) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/ColumnDescription) 

# ComponentPropertyGroupRequest
<a name="API_ComponentPropertyGroupRequest"></a>

The component property group request.

## Contents
<a name="API_ComponentPropertyGroupRequest_Contents"></a>

 ** groupType **   <a name="tm-Type-ComponentPropertyGroupRequest-groupType"></a>
The group type.  
Type: String  
Valid Values: `TABULAR`   
Required: No

 ** propertyNames **   <a name="tm-Type-ComponentPropertyGroupRequest-propertyNames"></a>
The property names.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z_\-0-9]+`   
Required: No

 ** updateType **   <a name="tm-Type-ComponentPropertyGroupRequest-updateType"></a>
The update type.  
Type: String  
Valid Values: `UPDATE | DELETE | CREATE`   
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/ComponentPropertyGroupRequest) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/ComponentPropertyGroupRequest) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/ComponentPropertyGroupRequest) 

# ComponentPropertyGroupResponse
<a name="API_ComponentPropertyGroupResponse"></a>

The component property group response.

## Contents
<a name="API_ComponentPropertyGroupResponse_Contents"></a>

 ** groupType **   <a name="tm-Type-ComponentPropertyGroupResponse-groupType"></a>
The group type.  
Type: String  
Valid Values: `TABULAR`   
Required: Yes

 ** isInherited **   <a name="tm-Type-ComponentPropertyGroupResponse-isInherited"></a>
A Boolean value that specifies whether the property group is inherited from a parent entity  
Type: Boolean  
Required: Yes

 ** propertyNames **   <a name="tm-Type-ComponentPropertyGroupResponse-propertyNames"></a>
The names of properties  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z_\-0-9]+`   
Required: Yes

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/ComponentPropertyGroupResponse) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/ComponentPropertyGroupResponse) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/ComponentPropertyGroupResponse) 

# ComponentRequest
<a name="API_ComponentRequest"></a>

An object that sets information about a component type create or update request.

## Contents
<a name="API_ComponentRequest_Contents"></a>

 ** componentTypeId **   <a name="tm-Type-ComponentRequest-componentTypeId"></a>
The ID of the component type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z_\.\-0-9:]+`   
Required: No

 ** description **   <a name="tm-Type-ComponentRequest-description"></a>
The description of the component request.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `.*`   
Required: No

 ** properties **   <a name="tm-Type-ComponentRequest-properties"></a>
An object that maps strings to the properties to set in the component type. Each string in the mapping must be unique to this object.  
Type: String to [PropertyRequest](API_PropertyRequest.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 256.  
Key Pattern: `[a-zA-Z_\-0-9]+`   
Required: No

 ** propertyGroups **   <a name="tm-Type-ComponentRequest-propertyGroups"></a>
The property groups.  
Type: String to [ComponentPropertyGroupRequest](API_ComponentPropertyGroupRequest.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 256.  
Key Pattern: `[a-zA-Z_\-0-9]+`   
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/ComponentRequest) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/ComponentRequest) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/ComponentRequest) 

# ComponentResponse
<a name="API_ComponentResponse"></a>

An object that returns information about a component type create or update request.

## Contents
<a name="API_ComponentResponse_Contents"></a>

 ** areAllCompositeComponentsReturned **   <a name="tm-Type-ComponentResponse-areAllCompositeComponentsReturned"></a>
This flag notes whether all `compositeComponents` are returned in the API response.  
Type: Boolean  
Required: No

 ** areAllPropertiesReturned **   <a name="tm-Type-ComponentResponse-areAllPropertiesReturned"></a>
This flag notes whether all properties of the component are returned in the API response. The maximum number of properties returned is 800.  
Type: Boolean  
Required: No

 ** componentName **   <a name="tm-Type-ComponentResponse-componentName"></a>
The name of the component.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z_\-0-9]+`   
Required: No

 ** componentTypeId **   <a name="tm-Type-ComponentResponse-componentTypeId"></a>
The ID of the component type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z_\.\-0-9:]+`   
Required: No

 ** compositeComponents **   <a name="tm-Type-ComponentResponse-compositeComponents"></a>
This lists objects that contain information about the `compositeComponents`.  
Type: String to [ComponentSummary](API_ComponentSummary.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 256.  
Key Pattern: `[a-zA-Z_\-0-9]+`   
Required: No

 ** definedIn **   <a name="tm-Type-ComponentResponse-definedIn"></a>
The name of the property definition set in the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `.*`   
Required: No

 ** description **   <a name="tm-Type-ComponentResponse-description"></a>
The description of the component type.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `.*`   
Required: No

 ** properties **   <a name="tm-Type-ComponentResponse-properties"></a>
An object that maps strings to the properties to set in the component type. Each string in the mapping must be unique to this object.  
Type: String to [PropertyResponse](API_PropertyResponse.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 256.  
Key Pattern: `[a-zA-Z_\-0-9]+`   
Required: No

 ** propertyGroups **   <a name="tm-Type-ComponentResponse-propertyGroups"></a>
The property groups.  
Type: String to [ComponentPropertyGroupResponse](API_ComponentPropertyGroupResponse.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 256.  
Key Pattern: `[a-zA-Z_\-0-9]+`   
Required: No

 ** status **   <a name="tm-Type-ComponentResponse-status"></a>
The status of the component type.  
Type: [Status](API_Status.md) object  
Required: No

 ** syncSource **   <a name="tm-Type-ComponentResponse-syncSource"></a>
The syncSource of the sync job, if this entity was created by a sync job.  
Type: String  
Pattern: `[a-zA-Z_0-9]+`   
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/ComponentResponse) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/ComponentResponse) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/ComponentResponse) 

# ComponentSummary
<a name="API_ComponentSummary"></a>

An object that returns information about a component summary.

## Contents
<a name="API_ComponentSummary_Contents"></a>

 ** componentName **   <a name="tm-Type-ComponentSummary-componentName"></a>
The name of the component.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z_\-0-9]+`   
Required: Yes

 ** componentTypeId **   <a name="tm-Type-ComponentSummary-componentTypeId"></a>
The ID of the component type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z_\.\-0-9:]+`   
Required: Yes

 ** status **   <a name="tm-Type-ComponentSummary-status"></a>
The status of the component type.  
Type: [Status](API_Status.md) object  
Required: Yes

 ** componentPath **   <a name="tm-Type-ComponentSummary-componentPath"></a>
This string specifies the path to the composite component, starting from the top-level component.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[a-zA-Z_\-0-9/]+`   
Required: No

 ** definedIn **   <a name="tm-Type-ComponentSummary-definedIn"></a>
The name of the property definition set in the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `.*`   
Required: No

 ** description **   <a name="tm-Type-ComponentSummary-description"></a>
The description of the component request.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `.*`   
Required: No

 ** propertyGroups **   <a name="tm-Type-ComponentSummary-propertyGroups"></a>
The property groups.  
Type: String to [ComponentPropertyGroupResponse](API_ComponentPropertyGroupResponse.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 256.  
Key Pattern: `[a-zA-Z_\-0-9]+`   
Required: No

 ** syncSource **   <a name="tm-Type-ComponentSummary-syncSource"></a>
The `syncSource` of the sync job, if this entity was created by a sync job.  
Type: String  
Pattern: `[a-zA-Z_0-9]+`   
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/ComponentSummary) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/ComponentSummary) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/ComponentSummary) 

# ComponentTypeSummary
<a name="API_ComponentTypeSummary"></a>

An object that contains information about a component type.

## Contents
<a name="API_ComponentTypeSummary_Contents"></a>

 ** arn **   <a name="tm-Type-ComponentTypeSummary-arn"></a>
The ARN of the component type.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:((aws)|(aws-cn)|(aws-us-gov)):iottwinmaker:[a-z0-9-]+:[0-9]{12}:[\/a-zA-Z0-9_\-\.:]+`   
Required: Yes

 ** componentTypeId **   <a name="tm-Type-ComponentTypeSummary-componentTypeId"></a>
The ID of the component type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z_\.\-0-9:]+`   
Required: Yes

 ** creationDateTime **   <a name="tm-Type-ComponentTypeSummary-creationDateTime"></a>
The date and time when the component type was created.  
Type: Timestamp  
Required: Yes

 ** updateDateTime **   <a name="tm-Type-ComponentTypeSummary-updateDateTime"></a>
The date and time when the component type was last updated.  
Type: Timestamp  
Required: Yes

 ** componentTypeName **   <a name="tm-Type-ComponentTypeSummary-componentTypeName"></a>
The component type name.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `.*[^\u0000-\u001F\u007F]*.*`   
Required: No

 ** description **   <a name="tm-Type-ComponentTypeSummary-description"></a>
The description of the component type.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `.*`   
Required: No

 ** status **   <a name="tm-Type-ComponentTypeSummary-status"></a>
The current status of the component type.  
Type: [Status](API_Status.md) object  
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/ComponentTypeSummary) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/ComponentTypeSummary) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/ComponentTypeSummary) 

# ComponentUpdateRequest
<a name="API_ComponentUpdateRequest"></a>

The component update request.

## Contents
<a name="API_ComponentUpdateRequest_Contents"></a>

 ** componentTypeId **   <a name="tm-Type-ComponentUpdateRequest-componentTypeId"></a>
The ID of the component type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z_\.\-0-9:]+`   
Required: No

 ** description **   <a name="tm-Type-ComponentUpdateRequest-description"></a>
The description of the component type.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `.*`   
Required: No

 ** propertyGroupUpdates **   <a name="tm-Type-ComponentUpdateRequest-propertyGroupUpdates"></a>
The property group updates.  
Type: String to [ComponentPropertyGroupRequest](API_ComponentPropertyGroupRequest.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 256.  
Key Pattern: `[a-zA-Z_\-0-9]+`   
Required: No

 ** propertyUpdates **   <a name="tm-Type-ComponentUpdateRequest-propertyUpdates"></a>
An object that maps strings to the properties to set in the component type update. Each string in the mapping must be unique to this object.  
Type: String to [PropertyRequest](API_PropertyRequest.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 256.  
Key Pattern: `[a-zA-Z_\-0-9]+`   
Required: No

 ** updateType **   <a name="tm-Type-ComponentUpdateRequest-updateType"></a>
The update type of the component update request.  
Type: String  
Valid Values: `CREATE | UPDATE | DELETE`   
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/ComponentUpdateRequest) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/ComponentUpdateRequest) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/ComponentUpdateRequest) 

# CompositeComponentRequest
<a name="API_CompositeComponentRequest"></a>

An object that sets information about the composite component update request.

## Contents
<a name="API_CompositeComponentRequest_Contents"></a>

 ** description **   <a name="tm-Type-CompositeComponentRequest-description"></a>
The description of the component type.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `.*`   
Required: No

 ** properties **   <a name="tm-Type-CompositeComponentRequest-properties"></a>
This is an object that maps strings to the properties to set in the component type. Each string in the mapping must be unique to this object.  
Type: String to [PropertyRequest](API_PropertyRequest.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 256.  
Key Pattern: `[a-zA-Z_\-0-9]+`   
Required: No

 ** propertyGroups **   <a name="tm-Type-CompositeComponentRequest-propertyGroups"></a>
The property groups.  
Type: String to [ComponentPropertyGroupRequest](API_ComponentPropertyGroupRequest.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 256.  
Key Pattern: `[a-zA-Z_\-0-9]+`   
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/CompositeComponentRequest) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/CompositeComponentRequest) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/CompositeComponentRequest) 

# CompositeComponentTypeRequest
<a name="API_CompositeComponentTypeRequest"></a>

An object that sets information about the composite component types of a component type.

## Contents
<a name="API_CompositeComponentTypeRequest_Contents"></a>

 ** componentTypeId **   <a name="tm-Type-CompositeComponentTypeRequest-componentTypeId"></a>
This is the `componentTypeId` that the `compositeComponentType` refers to.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z_\.\-0-9:]+`   
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/CompositeComponentTypeRequest) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/CompositeComponentTypeRequest) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/CompositeComponentTypeRequest) 

# CompositeComponentTypeResponse
<a name="API_CompositeComponentTypeResponse"></a>

An object that returns information about the composite component types of a component type.

## Contents
<a name="API_CompositeComponentTypeResponse_Contents"></a>

 ** componentTypeId **   <a name="tm-Type-CompositeComponentTypeResponse-componentTypeId"></a>
This is the `componentTypeId` that this `compositeComponentType` refers to.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z_\.\-0-9:]+`   
Required: No

 ** isInherited **   <a name="tm-Type-CompositeComponentTypeResponse-isInherited"></a>
This boolean indicates whether this `compositeComponentType` is inherited from its parent.  
Type: Boolean  
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/CompositeComponentTypeResponse) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/CompositeComponentTypeResponse) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/CompositeComponentTypeResponse) 

# CompositeComponentUpdateRequest
<a name="API_CompositeComponentUpdateRequest"></a>

An object that sets information about the composite component update request.

## Contents
<a name="API_CompositeComponentUpdateRequest_Contents"></a>

 ** description **   <a name="tm-Type-CompositeComponentUpdateRequest-description"></a>
The description of the component type.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `.*`   
Required: No

 ** propertyGroupUpdates **   <a name="tm-Type-CompositeComponentUpdateRequest-propertyGroupUpdates"></a>
The property group updates.  
Type: String to [ComponentPropertyGroupRequest](API_ComponentPropertyGroupRequest.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 256.  
Key Pattern: `[a-zA-Z_\-0-9]+`   
Required: No

 ** propertyUpdates **   <a name="tm-Type-CompositeComponentUpdateRequest-propertyUpdates"></a>
An object that maps strings to the properties to set in the component type update. Each string in the mapping must be unique to this object.  
Type: String to [PropertyRequest](API_PropertyRequest.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 256.  
Key Pattern: `[a-zA-Z_\-0-9]+`   
Required: No

 ** updateType **   <a name="tm-Type-CompositeComponentUpdateRequest-updateType"></a>
The update type of the component update request.  
Type: String  
Valid Values: `CREATE | UPDATE | DELETE`   
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/CompositeComponentUpdateRequest) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/CompositeComponentUpdateRequest) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/CompositeComponentUpdateRequest) 

# DataConnector
<a name="API_DataConnector"></a>

The data connector.

## Contents
<a name="API_DataConnector_Contents"></a>

 ** isNative **   <a name="tm-Type-DataConnector-isNative"></a>
A Boolean value that specifies whether the data connector is native to Amazon IoT TwinMaker.  
Type: Boolean  
Required: No

 ** lambda **   <a name="tm-Type-DataConnector-lambda"></a>
The Lambda function associated with this data connector.  
Type: [LambdaFunction](API_LambdaFunction.md) object  
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/DataConnector) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/DataConnector) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/DataConnector) 

# DataType
<a name="API_DataType"></a>

An object that specifies the data type of a property.

## Contents
<a name="API_DataType_Contents"></a>

 ** type **   <a name="tm-Type-DataType-type"></a>
The underlying type of the data type.  
Type: String  
Valid Values: `RELATIONSHIP | STRING | LONG | BOOLEAN | INTEGER | DOUBLE | LIST | MAP`   
Required: Yes

 ** allowedValues **   <a name="tm-Type-DataType-allowedValues"></a>
The allowed values for this data type.  
Type: Array of [DataValue](API_DataValue.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Required: No

 ** nestedType **   <a name="tm-Type-DataType-nestedType"></a>
The nested type in the data type.  
Type: [DataType](#API_DataType) object  
Required: No

 ** relationship **   <a name="tm-Type-DataType-relationship"></a>
A relationship that associates a component with another component.  
Type: [Relationship](API_Relationship.md) object  
Required: No

 ** unitOfMeasure **   <a name="tm-Type-DataType-unitOfMeasure"></a>
The unit of measure used in this data type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `.*`   
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/DataType) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/DataType) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/DataType) 

# DataValue
<a name="API_DataValue"></a>

An object that specifies a value for a property.

## Contents
<a name="API_DataValue_Contents"></a>

 ** booleanValue **   <a name="tm-Type-DataValue-booleanValue"></a>
A Boolean value.  
Type: Boolean  
Required: No

 ** doubleValue **   <a name="tm-Type-DataValue-doubleValue"></a>
A double value.  
Type: Double  
Required: No

 ** expression **   <a name="tm-Type-DataValue-expression"></a>
An expression that produces the value.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 316.  
Pattern: `(^\$\{Parameters\.[a-zA-z]+([a-zA-z_0-9]*)}$)`   
Required: No

 ** integerValue **   <a name="tm-Type-DataValue-integerValue"></a>
An integer value.  
Type: Integer  
Required: No

 ** listValue **   <a name="tm-Type-DataValue-listValue"></a>
A list of multiple values.  
Type: Array of [DataValue](#API_DataValue) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Required: No

 ** longValue **   <a name="tm-Type-DataValue-longValue"></a>
A long value.  
Type: Long  
Required: No

 ** mapValue **   <a name="tm-Type-DataValue-mapValue"></a>
An object that maps strings to multiple `DataValue` objects.  
Type: String to [DataValue](#API_DataValue) object map  
Map Entries: Minimum number of 0 items. Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 256.  
Key Pattern: `.*`   
Required: No

 ** relationshipValue **   <a name="tm-Type-DataValue-relationshipValue"></a>
A value that relates a component to another component.  
Type: [RelationshipValue](API_RelationshipValue.md) object  
Required: No

 ** stringValue **   <a name="tm-Type-DataValue-stringValue"></a>
A string value.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `.*`   
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/DataValue) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/DataValue) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/DataValue) 

# DestinationConfiguration
<a name="API_DestinationConfiguration"></a>

The [link to action] metadata transfer job destination configuration.

## Contents
<a name="API_DestinationConfiguration_Contents"></a>

 ** type **   <a name="tm-Type-DestinationConfiguration-type"></a>
The destination type.  
Type: String  
Valid Values: `s3 | iotsitewise | iottwinmaker`   
Required: Yes

 ** iotTwinMakerConfiguration **   <a name="tm-Type-DestinationConfiguration-iotTwinMakerConfiguration"></a>
The metadata transfer job Amazon IoT TwinMaker configuration.  
Type: [IotTwinMakerDestinationConfiguration](API_IotTwinMakerDestinationConfiguration.md) object  
Required: No

 ** s3Configuration **   <a name="tm-Type-DestinationConfiguration-s3Configuration"></a>
The metadata transfer job S3 configuration. [need to add S3 entity]  
Type: [S3DestinationConfiguration](API_S3DestinationConfiguration.md) object  
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/DestinationConfiguration) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/DestinationConfiguration) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/DestinationConfiguration) 

# EntityPropertyReference
<a name="API_EntityPropertyReference"></a>

An object that uniquely identifies an entity property.

## Contents
<a name="API_EntityPropertyReference_Contents"></a>

 ** propertyName **   <a name="tm-Type-EntityPropertyReference-propertyName"></a>
The name of the property.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z_\-0-9]+`   
Required: Yes

 ** componentName **   <a name="tm-Type-EntityPropertyReference-componentName"></a>
The name of the component.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z_\-0-9]+`   
Required: No

 ** componentPath **   <a name="tm-Type-EntityPropertyReference-componentPath"></a>
This string specifies the path to the composite component, starting from the top-level component.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[a-zA-Z_\-0-9/]+`   
Required: No

 ** entityId **   <a name="tm-Type-EntityPropertyReference-entityId"></a>
The ID of the entity.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|^[a-zA-Z0-9][a-zA-Z_\-0-9.:]*[a-zA-Z0-9]+`   
Required: No

 ** externalIdProperty **   <a name="tm-Type-EntityPropertyReference-externalIdProperty"></a>
A mapping of external IDs to property names. External IDs uniquely identify properties from external data stores.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 256.  
Key Pattern: `.*`   
Value Length Constraints: Minimum length of 1. Maximum length of 256.  
Value Pattern: `.*`   
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/EntityPropertyReference) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/EntityPropertyReference) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/EntityPropertyReference) 

# EntitySummary
<a name="API_EntitySummary"></a>

An object that contains information about an entity.

## Contents
<a name="API_EntitySummary_Contents"></a>

 ** arn **   <a name="tm-Type-EntitySummary-arn"></a>
The ARN of the entity.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:((aws)|(aws-cn)|(aws-us-gov)):iottwinmaker:[a-z0-9-]+:[0-9]{12}:[\/a-zA-Z0-9_\-\.:]+`   
Required: Yes

 ** creationDateTime **   <a name="tm-Type-EntitySummary-creationDateTime"></a>
The date and time when the entity was created.  
Type: Timestamp  
Required: Yes

 ** entityId **   <a name="tm-Type-EntitySummary-entityId"></a>
The ID of the entity.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|^[a-zA-Z0-9][a-zA-Z_\-0-9.:]*[a-zA-Z0-9]+`   
Required: Yes

 ** entityName **   <a name="tm-Type-EntitySummary-entityName"></a>
The name of the entity.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[^\u0000-\u001F\u007F]+`   
Required: Yes

 ** status **   <a name="tm-Type-EntitySummary-status"></a>
The current status of the entity.  
Type: [Status](API_Status.md) object  
Required: Yes

 ** updateDateTime **   <a name="tm-Type-EntitySummary-updateDateTime"></a>
The last date and time when the entity was updated.  
Type: Timestamp  
Required: Yes

 ** description **   <a name="tm-Type-EntitySummary-description"></a>
The description of the entity.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `.*`   
Required: No

 ** hasChildEntities **   <a name="tm-Type-EntitySummary-hasChildEntities"></a>
An **eventual** Boolean value that specifies whether the entity has child entities or not.  
Type: Boolean  
Required: No

 ** parentEntityId **   <a name="tm-Type-EntitySummary-parentEntityId"></a>
The ID of the parent entity.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `\$ROOT|^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|^[a-zA-Z0-9][a-zA-Z_\-0-9.:]*[a-zA-Z0-9]+`   
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/EntitySummary) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/EntitySummary) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/EntitySummary) 

# ErrorDetails
<a name="API_ErrorDetails"></a>

The error details.

## Contents
<a name="API_ErrorDetails_Contents"></a>

 ** code **   <a name="tm-Type-ErrorDetails-code"></a>
The error code.  
Type: String  
Valid Values: `VALIDATION_ERROR | INTERNAL_FAILURE | SYNC_INITIALIZING_ERROR | SYNC_CREATING_ERROR | SYNC_PROCESSING_ERROR | SYNC_DELETING_ERROR | PROCESSING_ERROR | COMPOSITE_COMPONENT_FAILURE`   
Required: No

 ** message **   <a name="tm-Type-ErrorDetails-message"></a>
The error message.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/ErrorDetails) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/ErrorDetails) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/ErrorDetails) 

# FilterByAsset
<a name="API_FilterByAsset"></a>

Filter by asset. You can include multiple filters when you export your Amazon IoT SiteWise content. See [Export metadata examples](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/bulk-operations-export-filter-examples.html) in the Amazon IoT SiteWise User Guide.

## Contents
<a name="API_FilterByAsset_Contents"></a>

 ** assetExternalId **   <a name="tm-Type-FilterByAsset-assetExternalId"></a>
The external-Id property of an asset.   
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 **   <a name="tm-Type-FilterByAsset-assetId"></a>
Filter by asset Id.  
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

 ** includeAssetModel **   <a name="tm-Type-FilterByAsset-includeAssetModel"></a>
Set to true to include the asset model that the specified asset uses.  
Type: Boolean  
Required: No

 ** includeOffspring **   <a name="tm-Type-FilterByAsset-includeOffspring"></a>
Set to true to include all associated asset models in the hierarchy of the specified asset model.  
Type: Boolean  
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/FilterByAsset) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/FilterByAsset) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/FilterByAsset) 

# FilterByAssetModel
<a name="API_FilterByAssetModel"></a>

Filter by asset model.

## Contents
<a name="API_FilterByAssetModel_Contents"></a>

 ** assetModelExternalId **   <a name="tm-Type-FilterByAssetModel-assetModelExternalId"></a>
The external-Id property of an 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_]+.*`   
Required: No

 ** assetModelId **   <a name="tm-Type-FilterByAssetModel-assetModelId"></a>
The asset model Id.  
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

 ** includeAssets **   <a name="tm-Type-FilterByAssetModel-includeAssets"></a>
Set to true to include all assets that use the specified asset model.  
Type: Boolean  
Required: No

 ** includeOffspring **   <a name="tm-Type-FilterByAssetModel-includeOffspring"></a>
Set to true to include all associated asset models in the hierarchy of the specified asset model.  
Type: Boolean  
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/FilterByAssetModel) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/FilterByAssetModel) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/FilterByAssetModel) 

# FilterByComponentType
<a name="API_FilterByComponentType"></a>

Filter by component type.

## Contents
<a name="API_FilterByComponentType_Contents"></a>

 ** componentTypeId **   <a name="tm-Type-FilterByComponentType-componentTypeId"></a>
The component type Id.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z_\.\-0-9:]+`   
Required: Yes

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/FilterByComponentType) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/FilterByComponentType) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/FilterByComponentType) 

# FilterByEntity
<a name="API_FilterByEntity"></a>

Filter by entity.

## Contents
<a name="API_FilterByEntity_Contents"></a>

 ** entityId **   <a name="tm-Type-FilterByEntity-entityId"></a>
The entity Id.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|^[a-zA-Z0-9][a-zA-Z_\-0-9.:]*[a-zA-Z0-9]+`   
Required: Yes

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/FilterByEntity) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/FilterByEntity) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/FilterByEntity) 

# FunctionRequest
<a name="API_FunctionRequest"></a>

The function request body.

## Contents
<a name="API_FunctionRequest_Contents"></a>

 ** implementedBy **   <a name="tm-Type-FunctionRequest-implementedBy"></a>
The data connector.  
Type: [DataConnector](API_DataConnector.md) object  
Required: No

 ** requiredProperties **   <a name="tm-Type-FunctionRequest-requiredProperties"></a>
The required properties of the function.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z_\-0-9]+`   
Required: No

 ** scope **   <a name="tm-Type-FunctionRequest-scope"></a>
The scope of the function.  
Type: String  
Valid Values: `ENTITY | WORKSPACE`   
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/FunctionRequest) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/FunctionRequest) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/FunctionRequest) 

# FunctionResponse
<a name="API_FunctionResponse"></a>

The function response.

## Contents
<a name="API_FunctionResponse_Contents"></a>

 ** implementedBy **   <a name="tm-Type-FunctionResponse-implementedBy"></a>
The data connector.  
Type: [DataConnector](API_DataConnector.md) object  
Required: No

 ** isInherited **   <a name="tm-Type-FunctionResponse-isInherited"></a>
Indicates whether this function is inherited.  
Type: Boolean  
Required: No

 ** requiredProperties **   <a name="tm-Type-FunctionResponse-requiredProperties"></a>
The required properties of the function.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z_\-0-9]+`   
Required: No

 ** scope **   <a name="tm-Type-FunctionResponse-scope"></a>
The scope of the function.  
Type: String  
Valid Values: `ENTITY | WORKSPACE`   
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/FunctionResponse) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/FunctionResponse) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/FunctionResponse) 

# InterpolationParameters
<a name="API_InterpolationParameters"></a>

An object that specifies how to interpolate data in a list.

## Contents
<a name="API_InterpolationParameters_Contents"></a>

 ** interpolationType **   <a name="tm-Type-InterpolationParameters-interpolationType"></a>
The interpolation type.  
Type: String  
Valid Values: `LINEAR`   
Required: No

 ** intervalInSeconds **   <a name="tm-Type-InterpolationParameters-intervalInSeconds"></a>
The interpolation time interval in seconds.  
Type: Long  
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/InterpolationParameters) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/InterpolationParameters) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/InterpolationParameters) 

# IotSiteWiseSourceConfiguration
<a name="API_IotSiteWiseSourceConfiguration"></a>

The metadata transfer job Amazon IoT SiteWise source configuration.

## Contents
<a name="API_IotSiteWiseSourceConfiguration_Contents"></a>

 ** filters **   <a name="tm-Type-IotSiteWiseSourceConfiguration-filters"></a>
The Amazon IoT SiteWise source configuration filters.  
Type: Array of [IotSiteWiseSourceConfigurationFilter](API_IotSiteWiseSourceConfigurationFilter.md) objects  
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/IotSiteWiseSourceConfiguration) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/IotSiteWiseSourceConfiguration) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/IotSiteWiseSourceConfiguration) 

# IotSiteWiseSourceConfigurationFilter
<a name="API_IotSiteWiseSourceConfigurationFilter"></a>

The Amazon IoT SiteWise source configuration filter.

## Contents
<a name="API_IotSiteWiseSourceConfigurationFilter_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** filterByAsset **   <a name="tm-Type-IotSiteWiseSourceConfigurationFilter-filterByAsset"></a>
Filter by asset.  
Type: [FilterByAsset](API_FilterByAsset.md) object  
Required: No

 ** filterByAssetModel **   <a name="tm-Type-IotSiteWiseSourceConfigurationFilter-filterByAssetModel"></a>
Filter by asset model.  
Type: [FilterByAssetModel](API_FilterByAssetModel.md) object  
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/IotSiteWiseSourceConfigurationFilter) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/IotSiteWiseSourceConfigurationFilter) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/IotSiteWiseSourceConfigurationFilter) 

# IotTwinMakerDestinationConfiguration
<a name="API_IotTwinMakerDestinationConfiguration"></a>

The metadata transfer job Amazon IoT TwinMaker destination configuration.

## Contents
<a name="API_IotTwinMakerDestinationConfiguration_Contents"></a>

 ** workspace **   <a name="tm-Type-IotTwinMakerDestinationConfiguration-workspace"></a>
The IoT TwinMaker workspace.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:((aws)|(aws-cn)|(aws-us-gov)):iottwinmaker:[a-z0-9-]+:[0-9]{12}:[\/a-zA-Z0-9_\-\.:]+`   
Required: Yes

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/IotTwinMakerDestinationConfiguration) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/IotTwinMakerDestinationConfiguration) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/IotTwinMakerDestinationConfiguration) 

# IotTwinMakerSourceConfiguration
<a name="API_IotTwinMakerSourceConfiguration"></a>

The metadata transfer job Amazon IoT TwinMaker source configuration.

## Contents
<a name="API_IotTwinMakerSourceConfiguration_Contents"></a>

 ** workspace **   <a name="tm-Type-IotTwinMakerSourceConfiguration-workspace"></a>
The IoT TwinMaker workspace.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:((aws)|(aws-cn)|(aws-us-gov)):iottwinmaker:[a-z0-9-]+:[0-9]{12}:[\/a-zA-Z0-9_\-\.:]+`   
Required: Yes

 ** filters **   <a name="tm-Type-IotTwinMakerSourceConfiguration-filters"></a>
The metadata transfer job Amazon IoT TwinMaker source configuration filters.  
Type: Array of [IotTwinMakerSourceConfigurationFilter](API_IotTwinMakerSourceConfigurationFilter.md) objects  
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/IotTwinMakerSourceConfiguration) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/IotTwinMakerSourceConfiguration) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/IotTwinMakerSourceConfiguration) 

# IotTwinMakerSourceConfigurationFilter
<a name="API_IotTwinMakerSourceConfigurationFilter"></a>

The metadata transfer job Amazon IoT TwinMaker source configuration filter.

## Contents
<a name="API_IotTwinMakerSourceConfigurationFilter_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** filterByComponentType **   <a name="tm-Type-IotTwinMakerSourceConfigurationFilter-filterByComponentType"></a>
Filter by component type.  
Type: [FilterByComponentType](API_FilterByComponentType.md) object  
Required: No

 ** filterByEntity **   <a name="tm-Type-IotTwinMakerSourceConfigurationFilter-filterByEntity"></a>
Filter by entity.  
Type: [FilterByEntity](API_FilterByEntity.md) object  
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/IotTwinMakerSourceConfigurationFilter) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/IotTwinMakerSourceConfigurationFilter) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/IotTwinMakerSourceConfigurationFilter) 

# LambdaFunction
<a name="API_LambdaFunction"></a>

The Lambda function.

## Contents
<a name="API_LambdaFunction_Contents"></a>

 ** arn **   <a name="tm-Type-LambdaFunction-arn"></a>
The ARN of the Lambda function.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:((aws)|(aws-cn)|(aws-us-gov)):lambda:[a-z0-9-]+:[0-9]{12}:function:[\/a-zA-Z0-9_-]+`   
Required: Yes

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/LambdaFunction) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/LambdaFunction) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/LambdaFunction) 

# ListComponentTypesFilter
<a name="API_ListComponentTypesFilter"></a>

An object that filters items in a list of component types.

**Note**  
Only one object is accepted as a valid input.

## Contents
<a name="API_ListComponentTypesFilter_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** extendsFrom **   <a name="tm-Type-ListComponentTypesFilter-extendsFrom"></a>
The component type that the component types in the list extend.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z_\.\-0-9:]+`   
Required: No

 ** isAbstract **   <a name="tm-Type-ListComponentTypesFilter-isAbstract"></a>
A Boolean value that specifies whether the component types in the list are abstract.  
Type: Boolean  
Required: No

 ** namespace **   <a name="tm-Type-ListComponentTypesFilter-namespace"></a>
The namespace to which the component types in the list belong.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `.*`   
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/ListComponentTypesFilter) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/ListComponentTypesFilter) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/ListComponentTypesFilter) 

# ListEntitiesFilter
<a name="API_ListEntitiesFilter"></a>

An object that filters items in a list of entities.

## Contents
<a name="API_ListEntitiesFilter_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** componentTypeId **   <a name="tm-Type-ListEntitiesFilter-componentTypeId"></a>
The ID of the component type in the entities in the list.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z_\.\-0-9:]+`   
Required: No

 ** externalId **   <a name="tm-Type-ListEntitiesFilter-externalId"></a>
The external-Id property of a component. The external-Id property is the primary key of an external storage system.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `.*`   
Required: No

 ** parentEntityId **   <a name="tm-Type-ListEntitiesFilter-parentEntityId"></a>
The parent of the entities in the list.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `\$ROOT|^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|^[a-zA-Z0-9][a-zA-Z_\-0-9.:]*[a-zA-Z0-9]+`   
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/ListEntitiesFilter) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/ListEntitiesFilter) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/ListEntitiesFilter) 

# ListMetadataTransferJobsFilter
<a name="API_ListMetadataTransferJobsFilter"></a>

The ListMetadataTransferJobs filter.

## Contents
<a name="API_ListMetadataTransferJobsFilter_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** state **   <a name="tm-Type-ListMetadataTransferJobsFilter-state"></a>
The filter state.  
Type: String  
Valid Values: `VALIDATING | PENDING | RUNNING | CANCELLING | ERROR | COMPLETED | CANCELLED`   
Required: No

 ** workspaceId **   <a name="tm-Type-ListMetadataTransferJobsFilter-workspaceId"></a>
The workspace Id.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+`   
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/ListMetadataTransferJobsFilter) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/ListMetadataTransferJobsFilter) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/ListMetadataTransferJobsFilter) 

# MetadataTransferJobProgress
<a name="API_MetadataTransferJobProgress"></a>

The metadata transfer job's progress.

## Contents
<a name="API_MetadataTransferJobProgress_Contents"></a>

 ** failedCount **   <a name="tm-Type-MetadataTransferJobProgress-failedCount"></a>
The count of assets that failed during the process.  
Type: Integer  
Required: No

 ** skippedCount **   <a name="tm-Type-MetadataTransferJobProgress-skippedCount"></a>
The count of assets that were skipped during the process.  
Type: Integer  
Required: No

 ** succeededCount **   <a name="tm-Type-MetadataTransferJobProgress-succeededCount"></a>
The count of assets successfully transferred.  
Type: Integer  
Required: No

 ** totalCount **   <a name="tm-Type-MetadataTransferJobProgress-totalCount"></a>
The total count of assets in the transfer process.  
Type: Integer  
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/MetadataTransferJobProgress) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/MetadataTransferJobProgress) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/MetadataTransferJobProgress) 

# MetadataTransferJobStatus
<a name="API_MetadataTransferJobStatus"></a>

The metadata transfer job status.

## Contents
<a name="API_MetadataTransferJobStatus_Contents"></a>

 ** error **   <a name="tm-Type-MetadataTransferJobStatus-error"></a>
The metadata transfer job error.  
Type: [ErrorDetails](API_ErrorDetails.md) object  
Required: No

 ** queuedPosition **   <a name="tm-Type-MetadataTransferJobStatus-queuedPosition"></a>
The queued position.  
Type: Integer  
Required: No

 ** state **   <a name="tm-Type-MetadataTransferJobStatus-state"></a>
The metadata transfer job state.  
Type: String  
Valid Values: `VALIDATING | PENDING | RUNNING | CANCELLING | ERROR | COMPLETED | CANCELLED`   
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/MetadataTransferJobStatus) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/MetadataTransferJobStatus) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/MetadataTransferJobStatus) 

# MetadataTransferJobSummary
<a name="API_MetadataTransferJobSummary"></a>

The metadata transfer job summary.

## Contents
<a name="API_MetadataTransferJobSummary_Contents"></a>

 ** arn **   <a name="tm-Type-MetadataTransferJobSummary-arn"></a>
The metadata transfer job summary ARN.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:((aws)|(aws-cn)|(aws-us-gov)):iottwinmaker:[a-z0-9-]+:[0-9]{12}:[\/a-zA-Z0-9_\-\.:]+`   
Required: Yes

 ** creationDateTime **   <a name="tm-Type-MetadataTransferJobSummary-creationDateTime"></a>
The metadata transfer job summary creation DateTime object.  
Type: Timestamp  
Required: Yes

 ** metadataTransferJobId **   <a name="tm-Type-MetadataTransferJobSummary-metadataTransferJobId"></a>
The metadata transfer job summary Id.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+`   
Required: Yes

 ** status **   <a name="tm-Type-MetadataTransferJobSummary-status"></a>
The metadata transfer job summary status.  
Type: [MetadataTransferJobStatus](API_MetadataTransferJobStatus.md) object  
Required: Yes

 ** updateDateTime **   <a name="tm-Type-MetadataTransferJobSummary-updateDateTime"></a>
The metadata transfer job summary update DateTime object  
Type: Timestamp  
Required: Yes

 ** progress **   <a name="tm-Type-MetadataTransferJobSummary-progress"></a>
The metadata transfer job summary progress.  
Type: [MetadataTransferJobProgress](API_MetadataTransferJobProgress.md) object  
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/MetadataTransferJobSummary) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/MetadataTransferJobSummary) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/MetadataTransferJobSummary) 

# OrderBy
<a name="API_OrderBy"></a>

Filter criteria that orders the return output. It can be sorted in ascending or descending order.

## Contents
<a name="API_OrderBy_Contents"></a>

 ** propertyName **   <a name="tm-Type-OrderBy-propertyName"></a>
The property name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `.*`   
Required: Yes

 ** order **   <a name="tm-Type-OrderBy-order"></a>
The set order that filters results.  
Type: String  
Valid Values: `ASCENDING | DESCENDING`   
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/OrderBy) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/OrderBy) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/OrderBy) 

# ParentEntityUpdateRequest
<a name="API_ParentEntityUpdateRequest"></a>

The parent entity update request.

## Contents
<a name="API_ParentEntityUpdateRequest_Contents"></a>

 ** updateType **   <a name="tm-Type-ParentEntityUpdateRequest-updateType"></a>
The type of the update.  
Type: String  
Valid Values: `UPDATE | DELETE`   
Required: Yes

 ** parentEntityId **   <a name="tm-Type-ParentEntityUpdateRequest-parentEntityId"></a>
The ID of the parent entity.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `\$ROOT|^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|^[a-zA-Z0-9][a-zA-Z_\-0-9.:]*[a-zA-Z0-9]+`   
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/ParentEntityUpdateRequest) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/ParentEntityUpdateRequest) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/ParentEntityUpdateRequest) 

# PricingPlan
<a name="API_PricingPlan"></a>

The pricing plan.

## Contents
<a name="API_PricingPlan_Contents"></a>

 ** effectiveDateTime **   <a name="tm-Type-PricingPlan-effectiveDateTime"></a>
The effective date and time of the pricing plan.  
Type: Timestamp  
Required: Yes

 ** pricingMode **   <a name="tm-Type-PricingPlan-pricingMode"></a>
The pricing mode.  
Type: String  
Valid Values: `BASIC | STANDARD | TIERED_BUNDLE`   
Required: Yes

 ** updateDateTime **   <a name="tm-Type-PricingPlan-updateDateTime"></a>
The set date and time for updating a pricing plan.  
Type: Timestamp  
Required: Yes

 ** updateReason **   <a name="tm-Type-PricingPlan-updateReason"></a>
The update reason for changing a pricing plan.  
Type: String  
Valid Values: `DEFAULT | PRICING_TIER_UPDATE | ENTITY_COUNT_UPDATE | PRICING_MODE_UPDATE | OVERWRITTEN`   
Required: Yes

 ** billableEntityCount **   <a name="tm-Type-PricingPlan-billableEntityCount"></a>
The billable entity count.  
Type: Long  
Required: No

 ** bundleInformation **   <a name="tm-Type-PricingPlan-bundleInformation"></a>
The pricing plan's bundle information.  
Type: [BundleInformation](API_BundleInformation.md) object  
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/PricingPlan) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/PricingPlan) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/PricingPlan) 

# PropertyDefinitionRequest
<a name="API_PropertyDefinitionRequest"></a>

An object that sets information about a property.

## Contents
<a name="API_PropertyDefinitionRequest_Contents"></a>

 ** configuration **   <a name="tm-Type-PropertyDefinitionRequest-configuration"></a>
A mapping that specifies configuration information about the property. Use this field to specify information that you read from and write to an external source.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 256.  
Key Pattern: `[a-zA-Z_\-0-9]+`   
Value Pattern: `.*`   
Required: No

 ** dataType **   <a name="tm-Type-PropertyDefinitionRequest-dataType"></a>
An object that contains information about the data type.  
Type: [DataType](API_DataType.md) object  
Required: No

 ** defaultValue **   <a name="tm-Type-PropertyDefinitionRequest-defaultValue"></a>
An object that contains the default value.  
Type: [DataValue](API_DataValue.md) object  
Required: No

 ** displayName **   <a name="tm-Type-PropertyDefinitionRequest-displayName"></a>
A friendly name for the property.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `.*[^\u0000-\u001F\u007F]*.*`   
Required: No

 ** isExternalId **   <a name="tm-Type-PropertyDefinitionRequest-isExternalId"></a>
A Boolean value that specifies whether the property ID comes from an external data store.  
Type: Boolean  
Required: No

 ** isRequiredInEntity **   <a name="tm-Type-PropertyDefinitionRequest-isRequiredInEntity"></a>
A Boolean value that specifies whether the property is required.  
Type: Boolean  
Required: No

 ** isStoredExternally **   <a name="tm-Type-PropertyDefinitionRequest-isStoredExternally"></a>
A Boolean value that specifies whether the property is stored externally.  
Type: Boolean  
Required: No

 ** isTimeSeries **   <a name="tm-Type-PropertyDefinitionRequest-isTimeSeries"></a>
A Boolean value that specifies whether the property consists of time series data.  
Type: Boolean  
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/PropertyDefinitionRequest) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/PropertyDefinitionRequest) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/PropertyDefinitionRequest) 

# PropertyDefinitionResponse
<a name="API_PropertyDefinitionResponse"></a>

An object that contains response data from a property definition request.

## Contents
<a name="API_PropertyDefinitionResponse_Contents"></a>

 ** dataType **   <a name="tm-Type-PropertyDefinitionResponse-dataType"></a>
An object that contains information about the data type.  
Type: [DataType](API_DataType.md) object  
Required: Yes

 ** isExternalId **   <a name="tm-Type-PropertyDefinitionResponse-isExternalId"></a>
A Boolean value that specifies whether the property ID comes from an external data store.  
Type: Boolean  
Required: Yes

 ** isFinal **   <a name="tm-Type-PropertyDefinitionResponse-isFinal"></a>
A Boolean value that specifies whether the property definition can be updated.  
Type: Boolean  
Required: Yes

 ** isImported **   <a name="tm-Type-PropertyDefinitionResponse-isImported"></a>
A Boolean value that specifies whether the property definition is imported from an external data store.  
Type: Boolean  
Required: Yes

 ** isInherited **   <a name="tm-Type-PropertyDefinitionResponse-isInherited"></a>
A Boolean value that specifies whether the property definition is inherited from a parent entity.  
Type: Boolean  
Required: Yes

 ** isRequiredInEntity **   <a name="tm-Type-PropertyDefinitionResponse-isRequiredInEntity"></a>
A Boolean value that specifies whether the property is required in an entity.  
Type: Boolean  
Required: Yes

 ** isStoredExternally **   <a name="tm-Type-PropertyDefinitionResponse-isStoredExternally"></a>
A Boolean value that specifies whether the property is stored externally.  
Type: Boolean  
Required: Yes

 ** isTimeSeries **   <a name="tm-Type-PropertyDefinitionResponse-isTimeSeries"></a>
A Boolean value that specifies whether the property consists of time series data.  
Type: Boolean  
Required: Yes

 ** configuration **   <a name="tm-Type-PropertyDefinitionResponse-configuration"></a>
A mapping that specifies configuration information about the property.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 256.  
Key Pattern: `[a-zA-Z_\-0-9]+`   
Value Pattern: `.*`   
Required: No

 ** defaultValue **   <a name="tm-Type-PropertyDefinitionResponse-defaultValue"></a>
An object that contains the default value.  
Type: [DataValue](API_DataValue.md) object  
Required: No

 ** displayName **   <a name="tm-Type-PropertyDefinitionResponse-displayName"></a>
A friendly name for the property.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `.*[^\u0000-\u001F\u007F]*.*`   
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/PropertyDefinitionResponse) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/PropertyDefinitionResponse) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/PropertyDefinitionResponse) 

# PropertyFilter
<a name="API_PropertyFilter"></a>

An object that filters items returned by a property request.

## Contents
<a name="API_PropertyFilter_Contents"></a>

 ** operator **   <a name="tm-Type-PropertyFilter-operator"></a>
The operator associated with this property filter.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `.*`   
Required: No

 ** propertyName **   <a name="tm-Type-PropertyFilter-propertyName"></a>
The property name associated with this property filter.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `.*`   
Required: No

 ** value **   <a name="tm-Type-PropertyFilter-value"></a>
The value associated with this property filter.  
Type: [DataValue](API_DataValue.md) object  
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/PropertyFilter) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/PropertyFilter) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/PropertyFilter) 

# PropertyGroupRequest
<a name="API_PropertyGroupRequest"></a>



## Contents
<a name="API_PropertyGroupRequest_Contents"></a>

 ** groupType **   <a name="tm-Type-PropertyGroupRequest-groupType"></a>
The group type.  
Type: String  
Valid Values: `TABULAR`   
Required: No

 ** propertyNames **   <a name="tm-Type-PropertyGroupRequest-propertyNames"></a>
The names of properties.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z_\-0-9]+`   
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/PropertyGroupRequest) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/PropertyGroupRequest) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/PropertyGroupRequest) 

# PropertyGroupResponse
<a name="API_PropertyGroupResponse"></a>

The property group response

## Contents
<a name="API_PropertyGroupResponse_Contents"></a>

 ** groupType **   <a name="tm-Type-PropertyGroupResponse-groupType"></a>
The group types.  
Type: String  
Valid Values: `TABULAR`   
Required: Yes

 ** isInherited **   <a name="tm-Type-PropertyGroupResponse-isInherited"></a>
A Boolean value that specifies whether the property group is inherited from a parent entity  
Type: Boolean  
Required: Yes

 ** propertyNames **   <a name="tm-Type-PropertyGroupResponse-propertyNames"></a>
The names of properties.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z_\-0-9]+`   
Required: Yes

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/PropertyGroupResponse) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/PropertyGroupResponse) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/PropertyGroupResponse) 

# PropertyLatestValue
<a name="API_PropertyLatestValue"></a>

The latest value of the property.

## Contents
<a name="API_PropertyLatestValue_Contents"></a>

 ** propertyReference **   <a name="tm-Type-PropertyLatestValue-propertyReference"></a>
An object that specifies information about a property.  
Type: [EntityPropertyReference](API_EntityPropertyReference.md) object  
Required: Yes

 ** propertyValue **   <a name="tm-Type-PropertyLatestValue-propertyValue"></a>
The value of the property.  
Type: [DataValue](API_DataValue.md) object  
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/PropertyLatestValue) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/PropertyLatestValue) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/PropertyLatestValue) 

# PropertyRequest
<a name="API_PropertyRequest"></a>

An object that sets information about a property.

## Contents
<a name="API_PropertyRequest_Contents"></a>

 ** definition **   <a name="tm-Type-PropertyRequest-definition"></a>
An object that specifies information about a property.  
Type: [PropertyDefinitionRequest](API_PropertyDefinitionRequest.md) object  
Required: No

 ** updateType **   <a name="tm-Type-PropertyRequest-updateType"></a>
The update type of the update property request.  
Type: String  
Valid Values: `UPDATE | DELETE | CREATE`   
Required: No

 ** value **   <a name="tm-Type-PropertyRequest-value"></a>
The value of the property.  
Type: [DataValue](API_DataValue.md) object  
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/PropertyRequest) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/PropertyRequest) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/PropertyRequest) 

# PropertyResponse
<a name="API_PropertyResponse"></a>

An object that contains information about a property response.

## Contents
<a name="API_PropertyResponse_Contents"></a>

 ** areAllPropertyValuesReturned **   <a name="tm-Type-PropertyResponse-areAllPropertyValuesReturned"></a>
This flag notes whether all values of a list or map type property are returned in the API response. The maximum number of values per property returned is 50.  
Type: Boolean  
Required: No

 ** definition **   <a name="tm-Type-PropertyResponse-definition"></a>
An object that specifies information about a property.  
Type: [PropertyDefinitionResponse](API_PropertyDefinitionResponse.md) object  
Required: No

 ** value **   <a name="tm-Type-PropertyResponse-value"></a>
The value of the property.  
Type: [DataValue](API_DataValue.md) object  
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/PropertyResponse) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/PropertyResponse) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/PropertyResponse) 

# PropertySummary
<a name="API_PropertySummary"></a>

This is an object that contains the information of a property.

## Contents
<a name="API_PropertySummary_Contents"></a>

 ** propertyName **   <a name="tm-Type-PropertySummary-propertyName"></a>
This is the name of the property.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z_\-0-9]+`   
Required: Yes

 ** areAllPropertyValuesReturned **   <a name="tm-Type-PropertySummary-areAllPropertyValuesReturned"></a>
This flag notes whether all values of a list or map type property are returned in the API response. The maximum number of values per property returned is 50.  
Type: Boolean  
Required: No

 ** definition **   <a name="tm-Type-PropertySummary-definition"></a>
This is the schema for the property.  
Type: [PropertyDefinitionResponse](API_PropertyDefinitionResponse.md) object  
Required: No

 ** value **   <a name="tm-Type-PropertySummary-value"></a>
This is the value for the property.  
Type: [DataValue](API_DataValue.md) object  
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/PropertySummary) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/PropertySummary) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/PropertySummary) 

# PropertyValue
<a name="API_PropertyValue"></a>

An object that contains information about a value for a time series property.

## Contents
<a name="API_PropertyValue_Contents"></a>

 ** value **   <a name="tm-Type-PropertyValue-value"></a>
An object that specifies a value for a time series property.  
Type: [DataValue](API_DataValue.md) object  
Required: Yes

 ** time **   <a name="tm-Type-PropertyValue-time"></a>
ISO8601 DateTime of a value for a time series property.  
The time for when the property value was recorded in ISO 8601 format: *YYYY-MM-DDThh:mm:ss[.SSSSSSSSS][Z/±HH:mm]*.  
+  *[YYYY]*: year
+  *[MM]*: month
+  *[DD]*: day
+  *[hh]*: hour
+  *[mm]*: minute
+  *[ss]*: seconds
+  *[.SSSSSSSSS]*: additional precision, where precedence is maintained. For example: [.573123] is equal to 573123000 nanoseconds.
+  *Z*: default timezone UTC
+  *± HH:mm*: time zone offset in Hours and Minutes.
 *Required sub-fields*: YYYY-MM-DDThh:mm:ss and [Z/±HH:mm]  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 35.  
Required: No

 ** timestamp **   <a name="tm-Type-PropertyValue-timestamp"></a>
 *This member has been deprecated.*   
The timestamp of a value for a time series property.  
Type: Timestamp  
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/PropertyValue) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/PropertyValue) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/PropertyValue) 

# PropertyValueEntry
<a name="API_PropertyValueEntry"></a>

An object that specifies information about time series property values. This object is used and consumed by the [BatchPutPropertyValues](https://docs.amazonaws.cn/iot-twinmaker/latest/apireference/API_BatchPutPropertyValues.html) action.

## Contents
<a name="API_PropertyValueEntry_Contents"></a>

 ** entityPropertyReference **   <a name="tm-Type-PropertyValueEntry-entityPropertyReference"></a>
An object that contains information about the entity that has the property.  
Type: [EntityPropertyReference](API_EntityPropertyReference.md) object  
Required: Yes

 ** propertyValues **   <a name="tm-Type-PropertyValueEntry-propertyValues"></a>
A list of objects that specify time series property values.  
Type: Array of [PropertyValue](API_PropertyValue.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/PropertyValueEntry) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/PropertyValueEntry) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/PropertyValueEntry) 

# PropertyValueHistory
<a name="API_PropertyValueHistory"></a>

The history of values for a time series property.

## Contents
<a name="API_PropertyValueHistory_Contents"></a>

 ** entityPropertyReference **   <a name="tm-Type-PropertyValueHistory-entityPropertyReference"></a>
An object that uniquely identifies an entity property.  
Type: [EntityPropertyReference](API_EntityPropertyReference.md) object  
Required: Yes

 ** values **   <a name="tm-Type-PropertyValueHistory-values"></a>
A list of objects that contain information about the values in the history of a time series property.  
Type: Array of [PropertyValue](API_PropertyValue.md) objects  
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/PropertyValueHistory) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/PropertyValueHistory) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/PropertyValueHistory) 

# Relationship
<a name="API_Relationship"></a>

An object that specifies a relationship with another component type.

## Contents
<a name="API_Relationship_Contents"></a>

 ** relationshipType **   <a name="tm-Type-Relationship-relationshipType"></a>
The type of the relationship.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `.*`   
Required: No

 ** targetComponentTypeId **   <a name="tm-Type-Relationship-targetComponentTypeId"></a>
The ID of the target component type associated with this relationship.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z_\.\-0-9:]+`   
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/Relationship) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/Relationship) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/Relationship) 

# RelationshipValue
<a name="API_RelationshipValue"></a>

A value that associates a component and an entity.

## Contents
<a name="API_RelationshipValue_Contents"></a>

 ** targetComponentName **   <a name="tm-Type-RelationshipValue-targetComponentName"></a>
The name of the target component associated with the relationship value.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z_\-0-9]+`   
Required: No

 ** targetEntityId **   <a name="tm-Type-RelationshipValue-targetEntityId"></a>
The ID of the target entity associated with this relationship value.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|^[a-zA-Z0-9][a-zA-Z_\-0-9.:]*[a-zA-Z0-9]+`   
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/RelationshipValue) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/RelationshipValue) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/RelationshipValue) 

# Row
<a name="API_Row"></a>

Represents a single row in the query results.

## Contents
<a name="API_Row_Contents"></a>

 ** rowData **   <a name="tm-Type-Row-rowData"></a>
The data in a row of query results.  
Type: Array of JSON values  
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/Row) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/Row) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/Row) 

# S3DestinationConfiguration
<a name="API_S3DestinationConfiguration"></a>

The S3 destination configuration.

## Contents
<a name="API_S3DestinationConfiguration_Contents"></a>

 ** location **   <a name="tm-Type-S3DestinationConfiguration-location"></a>
The S3 destination configuration location.  
Type: String  
Pattern: `.*(^arn:((aws)|(aws-cn)|(aws-us-gov)):s3:::)([/a-zA-Z0-9_-]+$).*`   
Required: Yes

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/S3DestinationConfiguration) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/S3DestinationConfiguration) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/S3DestinationConfiguration) 

# S3SourceConfiguration
<a name="API_S3SourceConfiguration"></a>

The S3 destination source configuration.

## Contents
<a name="API_S3SourceConfiguration_Contents"></a>

 ** location **   <a name="tm-Type-S3SourceConfiguration-location"></a>
The S3 destination source configuration location.  
Type: String  
Pattern: `.*(^arn:((aws)|(aws-cn)|(aws-us-gov)):s3:::)([a-zA-Z0-9_-]+)\/([/.a-zA-Z0-9_-]+$).*`   
Required: Yes

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/S3SourceConfiguration) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/S3SourceConfiguration) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/S3SourceConfiguration) 

# SceneError
<a name="API_SceneError"></a>

The scene error.

## Contents
<a name="API_SceneError_Contents"></a>

 ** code **   <a name="tm-Type-SceneError-code"></a>
The SceneError code.  
Type: String  
Valid Values: `MATTERPORT_ERROR`   
Required: No

 ** message **   <a name="tm-Type-SceneError-message"></a>
The SceneError message.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/SceneError) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/SceneError) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/SceneError) 

# SceneSummary
<a name="API_SceneSummary"></a>

An object that contains information about a scene.

## Contents
<a name="API_SceneSummary_Contents"></a>

 ** arn **   <a name="tm-Type-SceneSummary-arn"></a>
The ARN of the scene.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:((aws)|(aws-cn)|(aws-us-gov)):iottwinmaker:[a-z0-9-]+:[0-9]{12}:[\/a-zA-Z0-9_\-\.:]+`   
Required: Yes

 ** contentLocation **   <a name="tm-Type-SceneSummary-contentLocation"></a>
The relative path that specifies the location of the content definition file.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `[sS]3://[A-Za-z0-9._/-]+`   
Required: Yes

 ** creationDateTime **   <a name="tm-Type-SceneSummary-creationDateTime"></a>
The date and time when the scene was created.  
Type: Timestamp  
Required: Yes

 ** sceneId **   <a name="tm-Type-SceneSummary-sceneId"></a>
The ID of the scene.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+`   
Required: Yes

 ** updateDateTime **   <a name="tm-Type-SceneSummary-updateDateTime"></a>
The date and time when the scene was last updated.  
Type: Timestamp  
Required: Yes

 ** description **   <a name="tm-Type-SceneSummary-description"></a>
The scene description.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `.*`   
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/SceneSummary) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/SceneSummary) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/SceneSummary) 

# SourceConfiguration
<a name="API_SourceConfiguration"></a>

The source configuration.

## Contents
<a name="API_SourceConfiguration_Contents"></a>

 ** type **   <a name="tm-Type-SourceConfiguration-type"></a>
The source configuration type.  
Type: String  
Valid Values: `s3 | iotsitewise | iottwinmaker`   
Required: Yes

 ** iotSiteWiseConfiguration **   <a name="tm-Type-SourceConfiguration-iotSiteWiseConfiguration"></a>
The source configuration IoT SiteWise configuration.  
Type: [IotSiteWiseSourceConfiguration](API_IotSiteWiseSourceConfiguration.md) object  
Required: No

 ** iotTwinMakerConfiguration **   <a name="tm-Type-SourceConfiguration-iotTwinMakerConfiguration"></a>
The source configuration IoT TwinMaker configuration.  
Type: [IotTwinMakerSourceConfiguration](API_IotTwinMakerSourceConfiguration.md) object  
Required: No

 ** s3Configuration **   <a name="tm-Type-SourceConfiguration-s3Configuration"></a>
The source configuration S3 configuration.  
Type: [S3SourceConfiguration](API_S3SourceConfiguration.md) object  
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/SourceConfiguration) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/SourceConfiguration) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/SourceConfiguration) 

# Status
<a name="API_Status"></a>

An object that represents the status of an entity, component, component type, or workspace.

## Contents
<a name="API_Status_Contents"></a>

 ** error **   <a name="tm-Type-Status-error"></a>
The error message.  
Type: [ErrorDetails](API_ErrorDetails.md) object  
Required: No

 ** state **   <a name="tm-Type-Status-state"></a>
The current state of the entity, component, component type, or workspace.  
Type: String  
Valid Values: `CREATING | UPDATING | DELETING | ACTIVE | ERROR`   
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/Status) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/Status) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/Status) 

# SyncJobStatus
<a name="API_SyncJobStatus"></a>

The SyncJob status.

## Contents
<a name="API_SyncJobStatus_Contents"></a>

 ** error **   <a name="tm-Type-SyncJobStatus-error"></a>
The SyncJob error.  
Type: [ErrorDetails](API_ErrorDetails.md) object  
Required: No

 ** state **   <a name="tm-Type-SyncJobStatus-state"></a>
The SyncJob status state.  
Type: String  
Valid Values: `CREATING | INITIALIZING | ACTIVE | DELETING | ERROR`   
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/SyncJobStatus) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/SyncJobStatus) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/SyncJobStatus) 

# SyncJobSummary
<a name="API_SyncJobSummary"></a>

The SyncJob summary.

## Contents
<a name="API_SyncJobSummary_Contents"></a>

 ** arn **   <a name="tm-Type-SyncJobSummary-arn"></a>
The SyncJob summary ARN.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:((aws)|(aws-cn)|(aws-us-gov)):iottwinmaker:[a-z0-9-]+:[0-9]{12}:[\/a-zA-Z0-9_\-\.:]+`   
Required: No

 ** creationDateTime **   <a name="tm-Type-SyncJobSummary-creationDateTime"></a>
The creation date and time.  
Type: Timestamp  
Required: No

 ** status **   <a name="tm-Type-SyncJobSummary-status"></a>
The SyncJob summaries status.  
Type: [SyncJobStatus](API_SyncJobStatus.md) object  
Required: No

 ** syncSource **   <a name="tm-Type-SyncJobSummary-syncSource"></a>
The sync source.  
Type: String  
Pattern: `[a-zA-Z_0-9]+`   
Required: No

 ** updateDateTime **   <a name="tm-Type-SyncJobSummary-updateDateTime"></a>
The update date and time.  
Type: Timestamp  
Required: No

 ** workspaceId **   <a name="tm-Type-SyncJobSummary-workspaceId"></a>
The ID of the workspace that contains the sync job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+`   
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/SyncJobSummary) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/SyncJobSummary) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/SyncJobSummary) 

# SyncResourceFilter
<a name="API_SyncResourceFilter"></a>

The sync resource filter.

## Contents
<a name="API_SyncResourceFilter_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** externalId **   <a name="tm-Type-SyncResourceFilter-externalId"></a>
The external ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+`   
Required: No

 ** resourceId **   <a name="tm-Type-SyncResourceFilter-resourceId"></a>
The sync resource filter resource ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+`   
Required: No

 ** resourceType **   <a name="tm-Type-SyncResourceFilter-resourceType"></a>
The sync resource filter resource type  
Type: String  
Valid Values: `ENTITY | COMPONENT_TYPE`   
Required: No

 ** state **   <a name="tm-Type-SyncResourceFilter-state"></a>
The sync resource filter's state.  
Type: String  
Valid Values: `INITIALIZING | PROCESSING | DELETED | IN_SYNC | ERROR`   
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/SyncResourceFilter) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/SyncResourceFilter) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/SyncResourceFilter) 

# SyncResourceStatus
<a name="API_SyncResourceStatus"></a>

The sync resource status.

## Contents
<a name="API_SyncResourceStatus_Contents"></a>

 ** error **   <a name="tm-Type-SyncResourceStatus-error"></a>
The status error.  
Type: [ErrorDetails](API_ErrorDetails.md) object  
Required: No

 ** state **   <a name="tm-Type-SyncResourceStatus-state"></a>
The sync resource status state.  
Type: String  
Valid Values: `INITIALIZING | PROCESSING | DELETED | IN_SYNC | ERROR`   
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/SyncResourceStatus) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/SyncResourceStatus) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/SyncResourceStatus) 

# SyncResourceSummary
<a name="API_SyncResourceSummary"></a>

The sync resource summary.

## Contents
<a name="API_SyncResourceSummary_Contents"></a>

 ** externalId **   <a name="tm-Type-SyncResourceSummary-externalId"></a>
The external ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+`   
Required: No

 ** resourceId **   <a name="tm-Type-SyncResourceSummary-resourceId"></a>
The resource ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+`   
Required: No

 ** resourceType **   <a name="tm-Type-SyncResourceSummary-resourceType"></a>
The resource type.  
Type: String  
Valid Values: `ENTITY | COMPONENT_TYPE`   
Required: No

 ** status **   <a name="tm-Type-SyncResourceSummary-status"></a>
The sync resource summary status.  
Type: [SyncResourceStatus](API_SyncResourceStatus.md) object  
Required: No

 ** updateDateTime **   <a name="tm-Type-SyncResourceSummary-updateDateTime"></a>
The update date and time.  
Type: Timestamp  
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/SyncResourceSummary) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/SyncResourceSummary) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/SyncResourceSummary) 

# TabularConditions
<a name="API_TabularConditions"></a>

The tabular conditions.

## Contents
<a name="API_TabularConditions_Contents"></a>

 ** orderBy **   <a name="tm-Type-TabularConditions-orderBy"></a>
Filter criteria that orders the output. It can be sorted in ascending or descending order.  
Type: Array of [OrderBy](API_OrderBy.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Required: No

 ** propertyFilters **   <a name="tm-Type-TabularConditions-propertyFilters"></a>
You can filter the request using various logical operators and a key-value format. For example:  
 `{"key": "serverType", "value": "webServer"}`   
Type: Array of [PropertyFilter](API_PropertyFilter.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/TabularConditions) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/TabularConditions) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/TabularConditions) 

# WorkspaceSummary
<a name="API_WorkspaceSummary"></a>

An object that contains information about a workspace.

## Contents
<a name="API_WorkspaceSummary_Contents"></a>

 ** arn **   <a name="tm-Type-WorkspaceSummary-arn"></a>
The ARN of the workspace.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:((aws)|(aws-cn)|(aws-us-gov)):iottwinmaker:[a-z0-9-]+:[0-9]{12}:[\/a-zA-Z0-9_\-\.:]+`   
Required: Yes

 ** creationDateTime **   <a name="tm-Type-WorkspaceSummary-creationDateTime"></a>
The date and time when the workspace was created.  
Type: Timestamp  
Required: Yes

 ** updateDateTime **   <a name="tm-Type-WorkspaceSummary-updateDateTime"></a>
The date and time when the workspace was last updated.  
Type: Timestamp  
Required: Yes

 ** workspaceId **   <a name="tm-Type-WorkspaceSummary-workspaceId"></a>
The ID of the workspace.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+`   
Required: Yes

 ** description **   <a name="tm-Type-WorkspaceSummary-description"></a>
The description of the workspace.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `.*`   
Required: No

 ** linkedServices **   <a name="tm-Type-WorkspaceSummary-linkedServices"></a>
A list of services that are linked to the workspace.  
Type: Array of strings  
Pattern: `[a-zA-Z_0-9]+`   
Required: No

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iottwinmaker-2021-11-29/WorkspaceSummary) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iottwinmaker-2021-11-29/WorkspaceSummary) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iottwinmaker-2021-11-29/WorkspaceSummary)