# Data Types The Amazon IoT SiteWise 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: + [AccessPolicySummary](API_AccessPolicySummary.md) + [ActionDefinition](API_ActionDefinition.md) + [ActionPayload](API_ActionPayload.md) + [ActionSummary](API_ActionSummary.md) + [AggregatedValue](API_AggregatedValue.md) + [Aggregates](API_Aggregates.md) + [Alarms](API_Alarms.md) + [AssetBindingValueFilter](API_AssetBindingValueFilter.md) + [AssetCompositeModel](API_AssetCompositeModel.md) + [AssetCompositeModelPathSegment](API_AssetCompositeModelPathSegment.md) + [AssetCompositeModelSummary](API_AssetCompositeModelSummary.md) + [AssetErrorDetails](API_AssetErrorDetails.md) + [AssetHierarchy](API_AssetHierarchy.md) + [AssetHierarchyInfo](API_AssetHierarchyInfo.md) + [AssetModelBindingValueFilter](API_AssetModelBindingValueFilter.md) + [AssetModelCompositeModel](API_AssetModelCompositeModel.md) + [AssetModelCompositeModelDefinition](API_AssetModelCompositeModelDefinition.md) + [AssetModelCompositeModelPathSegment](API_AssetModelCompositeModelPathSegment.md) + [AssetModelCompositeModelSummary](API_AssetModelCompositeModelSummary.md) + [AssetModelHierarchy](API_AssetModelHierarchy.md) + [AssetModelHierarchyDefinition](API_AssetModelHierarchyDefinition.md) + [AssetModelProperty](API_AssetModelProperty.md) + [AssetModelPropertyBindingValue](API_AssetModelPropertyBindingValue.md) + [AssetModelPropertyBindingValueFilter](API_AssetModelPropertyBindingValueFilter.md) + [AssetModelPropertyDefinition](API_AssetModelPropertyDefinition.md) + [AssetModelPropertyPathSegment](API_AssetModelPropertyPathSegment.md) + [AssetModelPropertySummary](API_AssetModelPropertySummary.md) + [AssetModelStatus](API_AssetModelStatus.md) + [AssetModelSummary](API_AssetModelSummary.md) + [AssetProperty](API_AssetProperty.md) + [AssetPropertyBindingValue](API_AssetPropertyBindingValue.md) + [AssetPropertyBindingValueFilter](API_AssetPropertyBindingValueFilter.md) + [AssetPropertyPathSegment](API_AssetPropertyPathSegment.md) + [AssetPropertySummary](API_AssetPropertySummary.md) + [AssetPropertyValue](API_AssetPropertyValue.md) + [AssetRelationshipSummary](API_AssetRelationshipSummary.md) + [AssetStatus](API_AssetStatus.md) + [AssetSummary](API_AssetSummary.md) + [AssociatedAssetsSummary](API_AssociatedAssetsSummary.md) + [Attribute](API_Attribute.md) + [BatchGetAssetPropertyAggregatesEntry](API_BatchGetAssetPropertyAggregatesEntry.md) + [BatchGetAssetPropertyAggregatesErrorEntry](API_BatchGetAssetPropertyAggregatesErrorEntry.md) + [BatchGetAssetPropertyAggregatesErrorInfo](API_BatchGetAssetPropertyAggregatesErrorInfo.md) + [BatchGetAssetPropertyAggregatesSkippedEntry](API_BatchGetAssetPropertyAggregatesSkippedEntry.md) + [BatchGetAssetPropertyAggregatesSuccessEntry](API_BatchGetAssetPropertyAggregatesSuccessEntry.md) + [BatchGetAssetPropertyValueEntry](API_BatchGetAssetPropertyValueEntry.md) + [BatchGetAssetPropertyValueErrorEntry](API_BatchGetAssetPropertyValueErrorEntry.md) + [BatchGetAssetPropertyValueErrorInfo](API_BatchGetAssetPropertyValueErrorInfo.md) + [BatchGetAssetPropertyValueHistoryEntry](API_BatchGetAssetPropertyValueHistoryEntry.md) + [BatchGetAssetPropertyValueHistoryErrorEntry](API_BatchGetAssetPropertyValueHistoryErrorEntry.md) + [BatchGetAssetPropertyValueHistoryErrorInfo](API_BatchGetAssetPropertyValueHistoryErrorInfo.md) + [BatchGetAssetPropertyValueHistorySkippedEntry](API_BatchGetAssetPropertyValueHistorySkippedEntry.md) + [BatchGetAssetPropertyValueHistorySuccessEntry](API_BatchGetAssetPropertyValueHistorySuccessEntry.md) + [BatchGetAssetPropertyValueSkippedEntry](API_BatchGetAssetPropertyValueSkippedEntry.md) + [BatchGetAssetPropertyValueSuccessEntry](API_BatchGetAssetPropertyValueSuccessEntry.md) + [BatchPutAssetPropertyError](API_BatchPutAssetPropertyError.md) + [BatchPutAssetPropertyErrorEntry](API_BatchPutAssetPropertyErrorEntry.md) + [Citation](API_Citation.md) + [ColumnInfo](API_ColumnInfo.md) + [ColumnType](API_ColumnType.md) + [CompositeModelProperty](API_CompositeModelProperty.md) + [CompositionDetails](API_CompositionDetails.md) + [CompositionRelationshipItem](API_CompositionRelationshipItem.md) + [CompositionRelationshipSummary](API_CompositionRelationshipSummary.md) + [ComputationModelAnomalyDetectionConfiguration](API_ComputationModelAnomalyDetectionConfiguration.md) + [ComputationModelConfiguration](API_ComputationModelConfiguration.md) + [ComputationModelDataBindingUsageSummary](API_ComputationModelDataBindingUsageSummary.md) + [ComputationModelDataBindingValue](API_ComputationModelDataBindingValue.md) + [ComputationModelResolveToResourceSummary](API_ComputationModelResolveToResourceSummary.md) + [ComputationModelStatus](API_ComputationModelStatus.md) + [ComputationModelSummary](API_ComputationModelSummary.md) + [ConfigurationErrorDetails](API_ConfigurationErrorDetails.md) + [ConfigurationStatus](API_ConfigurationStatus.md) + [Content](API_Content.md) + [Csv](API_Csv.md) + [CustomerManagedS3Storage](API_CustomerManagedS3Storage.md) + [DashboardSummary](API_DashboardSummary.md) + [DataBindingValue](API_DataBindingValue.md) + [DataBindingValueFilter](API_DataBindingValueFilter.md) + [DataSetReference](API_DataSetReference.md) + [DatasetSource](API_DatasetSource.md) + [DatasetStatus](API_DatasetStatus.md) + [DatasetSummary](API_DatasetSummary.md) + [Datum](API_Datum.md) + [DetailedError](API_DetailedError.md) + [ErrorDetails](API_ErrorDetails.md) + [ErrorReportLocation](API_ErrorReportLocation.md) + [ExecutionStatus](API_ExecutionStatus.md) + [ExecutionSummary](API_ExecutionSummary.md) + [ExpressionVariable](API_ExpressionVariable.md) + [File](API_File.md) + [FileFormat](API_FileFormat.md) + [ForwardingConfig](API_ForwardingConfig.md) + [GatewayCapabilitySummary](API_GatewayCapabilitySummary.md) + [GatewayPlatform](API_GatewayPlatform.md) + [GatewaySummary](API_GatewaySummary.md) + [Greengrass](API_Greengrass.md) + [GreengrassV2](API_GreengrassV2.md) + [GroupIdentity](API_GroupIdentity.md) + [HierarchyMapping](API_HierarchyMapping.md) + [IAMRoleIdentity](API_IAMRoleIdentity.md) + [IAMUserIdentity](API_IAMUserIdentity.md) + [Identity](API_Identity.md) + [Image](API_Image.md) + [ImageFile](API_ImageFile.md) + [ImageLocation](API_ImageLocation.md) + [InterfaceRelationship](API_InterfaceRelationship.md) + [InterfaceRelationshipSummary](API_InterfaceRelationshipSummary.md) + [InterfaceSummary](API_InterfaceSummary.md) + [InterpolatedAssetPropertyValue](API_InterpolatedAssetPropertyValue.md) + [InvocationOutput](API_InvocationOutput.md) + [JobConfiguration](API_JobConfiguration.md) + [JobSummary](API_JobSummary.md) + [KendraSourceDetail](API_KendraSourceDetail.md) + [Location](API_Location.md) + [LoggingOptions](API_LoggingOptions.md) + [MatchedDataBinding](API_MatchedDataBinding.md) + [Measurement](API_Measurement.md) + [MeasurementProcessingConfig](API_MeasurementProcessingConfig.md) + [Metric](API_Metric.md) + [MetricProcessingConfig](API_MetricProcessingConfig.md) + [MetricWindow](API_MetricWindow.md) + [MonitorErrorDetails](API_MonitorErrorDetails.md) + [MultiLayerStorage](API_MultiLayerStorage.md) + [Parquet](API_Parquet.md) + [PortalResource](API_PortalResource.md) + [PortalStatus](API_PortalStatus.md) + [PortalSummary](API_PortalSummary.md) + [PortalTypeEntry](API_PortalTypeEntry.md) + [ProjectResource](API_ProjectResource.md) + [ProjectSummary](API_ProjectSummary.md) + [Property](API_Property.md) + [PropertyMapping](API_PropertyMapping.md) + [PropertyMappingConfiguration](API_PropertyMappingConfiguration.md) + [PropertyNotification](API_PropertyNotification.md) + [PropertyType](API_PropertyType.md) + [PropertyValueNullValue](API_PropertyValueNullValue.md) + [PutAssetPropertyValueEntry](API_PutAssetPropertyValueEntry.md) + [Reference](API_Reference.md) + [ResolveTo](API_ResolveTo.md) + [Resource](API_Resource.md) + [ResponseStream](API_ResponseStream.md) + [RetentionPeriod](API_RetentionPeriod.md) + [Row](API_Row.md) + [SiemensIE](API_SiemensIE.md) + [Source](API_Source.md) + [SourceDetail](API_SourceDetail.md) + [TargetResource](API_TargetResource.md) + [TimeInNanos](API_TimeInNanos.md) + [TimeSeriesSummary](API_TimeSeriesSummary.md) + [Trace](API_Trace.md) + [Transform](API_Transform.md) + [TransformProcessingConfig](API_TransformProcessingConfig.md) + [TumblingWindow](API_TumblingWindow.md) + [UserIdentity](API_UserIdentity.md) + [VariableValue](API_VariableValue.md) + [Variant](API_Variant.md) + [WarmTierRetentionPeriod](API_WarmTierRetentionPeriod.md) # AccessPolicySummary Contains an access policy that defines an identity's access to an Amazon IoT SiteWise Monitor resource. ## Contents ** id ** The ID of the access policy. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: Yes ** identity ** The identity (an IAM Identity Center user, an IAM Identity Center group, or an IAM user). Type: [Identity](API_Identity.md) object Required: Yes ** permission ** The permissions for the access policy. Note that a project `ADMINISTRATOR` is also known as a project owner. Type: String Valid Values: `ADMINISTRATOR | VIEWER` Required: Yes ** resource ** The Amazon IoT SiteWise Monitor resource (a portal or project). Type: [Resource](API_Resource.md) object Required: Yes ** creationDate ** The date the access policy was created, in Unix epoch time. Type: Timestamp Required: No ** lastUpdateDate ** The date the access policy was last updated, in Unix epoch time. Type: Timestamp Required: No ## See Also 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/iotsitewise-2019-12-02/AccessPolicySummary) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/AccessPolicySummary) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/AccessPolicySummary) # ActionDefinition Contains a definition for an action. ## Contents ** actionDefinitionId ** The ID of the action definition. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: Yes ** actionName ** The name of the action definition. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[^\u0000-\u001F\u007F]+` Required: Yes ** actionType ** The type of the action definition. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[^\u0000-\u001F\u007F]+` Required: Yes ## See Also 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/iotsitewise-2019-12-02/ActionDefinition) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/ActionDefinition) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/ActionDefinition) # ActionPayload The JSON payload of the action. ## Contents ** stringValue ** The payload of the action in a JSON string. Type: String Pattern: `[^\u0000-\u001F\u007F]+` Required: Yes ## See Also 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/iotsitewise-2019-12-02/ActionPayload) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/ActionPayload) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/ActionPayload) # ActionSummary Contains the summary of the actions, including information about where the action resolves to. ## Contents ** actionDefinitionId ** The ID of the action definition. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: No ** actionId ** The ID of the action. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: No ** resolveTo ** The detailed resource this action resolves to. Type: [ResolveTo](API_ResolveTo.md) object Required: No ** targetResource ** The resource the action will be taken on. Type: [TargetResource](API_TargetResource.md) object Required: No ## See Also 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/iotsitewise-2019-12-02/ActionSummary) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/ActionSummary) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/ActionSummary) # AggregatedValue Contains aggregated asset property values (for example, average, minimum, and maximum). ## Contents ** timestamp ** The date the aggregating computations occurred, in Unix epoch time. Type: Timestamp Required: Yes ** value ** The value of the aggregates. Type: [Aggregates](API_Aggregates.md) object Required: Yes ** quality ** The quality of the aggregated data. Type: String Valid Values: `GOOD | BAD | UNCERTAIN` Required: No ## See Also 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/iotsitewise-2019-12-02/AggregatedValue) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/AggregatedValue) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/AggregatedValue) # Aggregates Contains the (pre-calculated) aggregate values for an asset property. ## Contents ** average ** The average (mean) value of the time series over a time interval window. Type: Double Required: No ** count ** The count of data points in the time series over a time interval window. Type: Double Required: No ** maximum ** The maximum value of the time series over a time interval window. Type: Double Required: No ** minimum ** The minimum value of the time series over a time interval window. Type: Double Required: No ** standardDeviation ** The standard deviation of the time series over a time interval window. Type: Double Required: No ** sum ** The sum of the time series over a time interval window. Type: Double Required: No ## See Also 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/iotsitewise-2019-12-02/Aggregates) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/Aggregates) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/Aggregates) # Alarms Contains the configuration information of an alarm created in an Amazon IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range. For more information, see [Monitoring with alarms](https://docs.amazonaws.cn/iot-sitewise/latest/appguide/monitor-alarms.html) in the * Amazon IoT SiteWise Application Guide*. ## Contents ** alarmRoleArn ** The [ARN](https://docs.amazonaws.cn/general/latest/gr/aws-arns-and-namespaces.html) of the IAM role that allows the alarm to perform actions and access Amazon resources and services, such as Amazon IoT Events. Type: String Length Constraints: Minimum length of 1. Maximum length of 1600. Pattern: `^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.\+=,@]+$` Required: Yes ** notificationLambdaArn ** The [ARN](https://docs.amazonaws.cn/general/latest/gr/aws-arns-and-namespaces.html) of the Lambda function that manages alarm notifications. For more information, see [Managing alarm notifications](https://docs.amazonaws.cn/iotevents/latest/developerguide/lambda-support.html) in the * Amazon IoT Events Developer Guide*. Type: String Length Constraints: Minimum length of 1. Maximum length of 1600. Pattern: `^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$` Required: No ## See Also 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/iotsitewise-2019-12-02/Alarms) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/Alarms) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/Alarms) # AssetBindingValueFilter A filter used to match data bindings based on a specific asset. This filter identifies all computation models referencing a particular asset in their data bindings. ## Contents ** assetId ** The ID of the asset to filter data bindings by. Only data bindings referencing this specific asset are matched. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: Yes ## See Also 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/iotsitewise-2019-12-02/AssetBindingValueFilter) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/AssetBindingValueFilter) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/AssetBindingValueFilter) # AssetCompositeModel Contains information about a composite model in an asset. This object contains the asset's properties that you define in the composite model. ## Contents ** name ** The name of the composite model. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[^\u0000-\u001F\u007F]+` Required: Yes ** properties ** The asset properties that this composite model defines. Type: Array of [AssetProperty](API_AssetProperty.md) objects Required: Yes ** type ** The type of the composite model. For alarm composite models, this type is `AWS/ALARM`. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[^\u0000-\u001F\u007F]+` Required: Yes ** description ** The description of the composite model. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `[^\u0000-\u001F\u007F]+` Required: No ** externalId ** The external ID of the asset composite model. For more information, see [Using external IDs](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/object-ids.html#external-ids) in the * Amazon IoT SiteWise User Guide*. Type: String Length Constraints: Minimum length of 2. Maximum length of 128. Pattern: `[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+` Required: No ** id ** The ID of the asset composite model. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: No ## See Also 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/iotsitewise-2019-12-02/AssetCompositeModel) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/AssetCompositeModel) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/AssetCompositeModel) # AssetCompositeModelPathSegment Represents one level between a composite model and the root of the asset. ## Contents ** id ** The ID of the path segment. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: No ** name ** The name of the path segment. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[^\u0000-\u001F\u007F]+` Required: No ## See Also 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/iotsitewise-2019-12-02/AssetCompositeModelPathSegment) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/AssetCompositeModelPathSegment) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/AssetCompositeModelPathSegment) # AssetCompositeModelSummary Contains a summary of the composite model for a specific asset. ## Contents ** description ** A description of the composite model that this summary describes. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `[^\u0000-\u001F\u007F]+` Required: Yes ** id ** The ID of the composite model that this summary describes. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: Yes ** name ** The name of the composite model that this summary describes. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[^\u0000-\u001F\u007F]+` Required: Yes ** path ** The path that includes all the components of the asset model for the asset. Type: Array of [AssetCompositeModelPathSegment](API_AssetCompositeModelPathSegment.md) objects Required: Yes ** type ** The type of asset model. + **ASSET\$1MODEL** – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model. + **COMPONENT\$1MODEL** – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[^\u0000-\u001F\u007F]+` Required: Yes ** externalId ** An external ID to assign to the asset model. If the composite model is a derived composite model, or one nested inside a component model, you can only set the external ID using `UpdateAssetModelCompositeModel` and specifying the derived ID of the model or property from the created model it's a part of. 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 ## See Also 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/iotsitewise-2019-12-02/AssetCompositeModelSummary) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/AssetCompositeModelSummary) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/AssetCompositeModelSummary) # AssetErrorDetails Contains error details for the requested associate project asset action. ## Contents ** assetId ** The ID of the asset, in UUID format. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: Yes ** code ** The error code. Type: String Valid Values: `INTERNAL_FAILURE` Required: Yes ** message ** The error message. Type: String Required: Yes ## See Also 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/iotsitewise-2019-12-02/AssetErrorDetails) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/AssetErrorDetails) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/AssetErrorDetails) # AssetHierarchy Describes an asset hierarchy that contains a hierarchy's name and ID. ## Contents ** name ** The hierarchy name provided in the [CreateAssetModel](https://docs.amazonaws.cn/iot-sitewise/latest/APIReference/API_CreateAssetModel.html) or [UpdateAssetModel](https://docs.amazonaws.cn/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html) API operation. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[^\u0000-\u001F\u007F]+` Required: Yes ** externalId ** The external ID of the hierarchy, if it has one. When you update an asset hierarchy, you may assign an external ID if it doesn't already have one. You can't change the external ID of an asset hierarchy that already has one. For more information, see [Using external IDs](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/object-ids.html#external-ids) in the * Amazon IoT SiteWise User Guide*. Type: String Length Constraints: Minimum length of 2. Maximum length of 128. Pattern: `[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+` Required: No ** id ** The ID of the hierarchy. This ID is a `hierarchyId`. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: No ## See Also 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/iotsitewise-2019-12-02/AssetHierarchy) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/AssetHierarchy) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/AssetHierarchy) # AssetHierarchyInfo Contains information about a parent asset and a child asset that are related through an asset hierarchy. ## Contents ** childAssetId ** The ID of the child asset in this asset relationship. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: No ** parentAssetId ** The ID of the parent asset in this asset relationship. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: No ## See Also 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/iotsitewise-2019-12-02/AssetHierarchyInfo) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/AssetHierarchyInfo) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/AssetHierarchyInfo) # AssetModelBindingValueFilter A filter used to match data bindings based on a specific asset model. This filter identifies all computation models referencing a particular asset model in their data bindings. ## Contents ** assetModelId ** The ID of the asset model to filter data bindings by. Only data bindings referemncing this specific asset model are matched. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: Yes ## See Also 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/iotsitewise-2019-12-02/AssetModelBindingValueFilter) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/AssetModelBindingValueFilter) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/AssetModelBindingValueFilter) # AssetModelCompositeModel Contains information about a composite model in an asset model. This object contains the asset property definitions that you define in the composite model. ## Contents ** name ** The name of the composite model. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[^\u0000-\u001F\u007F]+` Required: Yes ** type ** The type of the composite model. For alarm composite models, this type is `AWS/ALARM`. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[^\u0000-\u001F\u007F]+` Required: Yes ** description ** The description of the composite model. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `[^\u0000-\u001F\u007F]+` Required: No ** externalId ** The external ID of the asset model composite model. For more information, see [Using external IDs](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/object-ids.html#external-ids) in the * Amazon IoT SiteWise User Guide*. Type: String Length Constraints: Minimum length of 2. Maximum length of 128. Pattern: `[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+` Required: No ** id ** The ID of the asset model composite model. Type: String Length Constraints: Minimum length of 13. Maximum length of 139. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+` Required: No ** properties ** The asset property definitions for this composite model. Type: Array of [AssetModelProperty](API_AssetModelProperty.md) objects Required: No ## See Also 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/iotsitewise-2019-12-02/AssetModelCompositeModel) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/AssetModelCompositeModel) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/AssetModelCompositeModel) # AssetModelCompositeModelDefinition Contains a composite model definition in an asset model. This composite model definition is applied to all assets created from the asset model. ## Contents ** name ** The name of the composite model. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[^\u0000-\u001F\u007F]+` Required: Yes ** type ** The type of the composite model. For alarm composite models, this type is `AWS/ALARM`. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[^\u0000-\u001F\u007F]+` Required: Yes ** description ** The description of the composite model. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `[^\u0000-\u001F\u007F]+` Required: No ** externalId ** An external ID to assign to the composite model. The external ID must be unique among composite models within this asset model. For more information, see [Using external IDs](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/object-ids.html#external-ids) in the * Amazon IoT SiteWise User Guide*. Type: String Length Constraints: Minimum length of 2. Maximum length of 128. Pattern: `[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+` Required: No ** id ** The ID to assign to the composite model, if desired. Amazon IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: No ** properties ** The asset property definitions for this composite model. Type: Array of [AssetModelPropertyDefinition](API_AssetModelPropertyDefinition.md) objects Required: No ## See Also 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/iotsitewise-2019-12-02/AssetModelCompositeModelDefinition) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/AssetModelCompositeModelDefinition) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/AssetModelCompositeModelDefinition) # AssetModelCompositeModelPathSegment Represents one level between a composite model and the root of the asset model. ## Contents ** id ** The ID of the path segment. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: No ** name ** The name of the path segment. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[^\u0000-\u001F\u007F]+` Required: No ## See Also 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/iotsitewise-2019-12-02/AssetModelCompositeModelPathSegment) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/AssetModelCompositeModelPathSegment) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/AssetModelCompositeModelPathSegment) # AssetModelCompositeModelSummary Contains a summary of the composite model. ## Contents ** id ** The ID of the composite model that this summary describes.. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: Yes ** name ** The name of the composite model that this summary describes.. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[^\u0000-\u001F\u007F]+` Required: Yes ** type ** The composite model type. Valid values are `AWS/ALARM`, `CUSTOM`, or ` AWS/L4E_ANOMALY`. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[^\u0000-\u001F\u007F]+` Required: Yes ** description ** The description of the composite model that this summary describes.. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `[^\u0000-\u001F\u007F]+` Required: No ** externalId ** The external ID of a composite model on this asset model. For more information, see [Using external IDs](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/object-ids.html#external-ids) in the * Amazon IoT SiteWise User Guide*. Type: String Length Constraints: Minimum length of 2. Maximum length of 128. Pattern: `[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+` Required: No ** path ** The path that includes all the pieces that make up the composite model. Type: Array of [AssetModelCompositeModelPathSegment](API_AssetModelCompositeModelPathSegment.md) objects Required: No ## See Also 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/iotsitewise-2019-12-02/AssetModelCompositeModelSummary) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/AssetModelCompositeModelSummary) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/AssetModelCompositeModelSummary) # AssetModelHierarchy Describes an asset hierarchy that contains a hierarchy's name, ID, and child asset model ID that specifies the type of asset that can be in this hierarchy. ## Contents ** childAssetModelId ** The ID of the asset model, in UUID format. All assets in this hierarchy must be instances of the `childAssetModelId` asset model. Amazon IoT SiteWise will always return the actual asset model ID for this value. However, when you are specifying this value as part of a call to [UpdateAssetModel](https://docs.amazonaws.cn/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html), you may provide either the asset model ID or else `externalId:` followed by the asset model's external ID. For more information, see [Using external IDs](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/object-ids.html#external-ids) in the * Amazon IoT SiteWise User Guide*. Type: String Length Constraints: Minimum length of 13. Maximum length of 139. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+` Required: Yes ** name ** The name of the asset model hierarchy that you specify by using the [CreateAssetModel](https://docs.amazonaws.cn/iot-sitewise/latest/APIReference/API_CreateAssetModel.html) or [UpdateAssetModel](https://docs.amazonaws.cn/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html) API operation. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[^\u0000-\u001F\u007F]+` Required: Yes ** externalId ** The external ID (if any) provided in the [CreateAssetModel](https://docs.amazonaws.cn/iot-sitewise/latest/APIReference/API_CreateAssetModel.html) or [UpdateAssetModel](https://docs.amazonaws.cn/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html) operation. You can assign an external ID by specifying this value as part of a call to [UpdateAssetModel](https://docs.amazonaws.cn/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html). However, you can't change the external ID if one is already assigned. For more information, see [Using external IDs](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/object-ids.html#external-ids) in the * Amazon IoT SiteWise User Guide*. Type: String Length Constraints: Minimum length of 2. Maximum length of 128. Pattern: `[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+` Required: No ** id ** The ID of the asset model hierarchy. This ID is a `hierarchyId`. + If you are callling [UpdateAssetModel](https://docs.amazonaws.cn/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html) to create a *new* hierarchy: You can specify its ID here, if desired. Amazon IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique. + If you are calling UpdateAssetModel to modify an *existing* hierarchy: This can be either the actual ID in UUID format, or else `externalId:` followed by the external ID, if it has one. For more information, see [Referencing objects with external IDs](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/object-ids.html#external-id-references) in the * Amazon IoT SiteWise User Guide*. Type: String Length Constraints: Minimum length of 13. Maximum length of 139. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+` Required: No ## See Also 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/iotsitewise-2019-12-02/AssetModelHierarchy) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/AssetModelHierarchy) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/AssetModelHierarchy) # AssetModelHierarchyDefinition Contains an asset model hierarchy used in asset model creation. An asset model hierarchy determines the kind (or type) of asset that can belong to a hierarchy. ## Contents ** childAssetModelId ** The ID of an asset model for this hierarchy. This can be either the actual ID in UUID format, or else `externalId:` followed by the external ID, if it has one. For more information, see [Referencing objects with external IDs](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/object-ids.html#external-id-references) in the * Amazon IoT SiteWise User Guide*. Type: String Length Constraints: Minimum length of 13. Maximum length of 139. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+` Required: Yes ** name ** The name of the asset model hierarchy definition (as specified in the [CreateAssetModel](https://docs.amazonaws.cn/iot-sitewise/latest/APIReference/API_CreateAssetModel.html) or [UpdateAssetModel](https://docs.amazonaws.cn/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html) API operation). Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[^\u0000-\u001F\u007F]+` Required: Yes ** externalId ** An external ID to assign to the asset model hierarchy. The external ID must be unique among asset model hierarchies within this asset model. For more information, see [Using external IDs](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/object-ids.html#external-ids) in the * Amazon IoT SiteWise User Guide*. Type: String Length Constraints: Minimum length of 2. Maximum length of 128. Pattern: `[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+` Required: No ** id ** The ID to assign to the asset model hierarchy, if desired. Amazon IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: No ## See Also 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/iotsitewise-2019-12-02/AssetModelHierarchyDefinition) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/AssetModelHierarchyDefinition) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/AssetModelHierarchyDefinition) # AssetModelProperty Contains information about an asset model property. ## Contents ** dataType ** The data type of the asset model property. If you specify `STRUCT`, you must also specify `dataTypeSpec` to identify the type of the structure for this property. Type: String Valid Values: `STRING | INTEGER | DOUBLE | BOOLEAN | STRUCT` Required: Yes ** name ** The name of the asset model property. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[^\u0000-\u001F\u007F]+` Required: Yes ** type ** The property type (see `PropertyType`). Type: [PropertyType](API_PropertyType.md) object Required: Yes ** dataTypeSpec ** The data type of the structure for this property. This parameter exists on properties that have the `STRUCT` data type. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[^\u0000-\u001F\u007F]+` Required: No ** externalId ** The external ID (if any) provided in the [CreateAssetModel](https://docs.amazonaws.cn/iot-sitewise/latest/APIReference/API_CreateAssetModel.html) or [UpdateAssetModel](https://docs.amazonaws.cn/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html) operation. You can assign an external ID by specifying this value as part of a call to [UpdateAssetModel](https://docs.amazonaws.cn/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html). However, you can't change the external ID if one is already assigned. For more information, see [Using external IDs](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/object-ids.html#external-ids) in the * Amazon IoT SiteWise User Guide*. Type: String Length Constraints: Minimum length of 2. Maximum length of 128. Pattern: `[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+` Required: No ** id ** The ID of the asset model property. + If you are callling [UpdateAssetModel](https://docs.amazonaws.cn/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html) to create a *new* property: You can specify its ID here, if desired. Amazon IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique. + If you are calling UpdateAssetModel to modify an *existing* property: This can be either the actual ID in UUID format, or else `externalId:` followed by the external ID, if it has one. For more information, see [Referencing objects with external IDs](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/object-ids.html#external-id-references) in the * Amazon IoT SiteWise User Guide*. Type: String Length Constraints: Minimum length of 13. Maximum length of 139. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+` Required: No ** path ** The structured path to the property from the root of the asset model. Type: Array of [AssetModelPropertyPathSegment](API_AssetModelPropertyPathSegment.md) objects Required: No ** unit ** The unit of the asset model property, such as `Newtons` or `RPM`. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[^\u0000-\u001F\u007F]+` Required: No ## See Also 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/iotsitewise-2019-12-02/AssetModelProperty) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/AssetModelProperty) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/AssetModelProperty) # AssetModelPropertyBindingValue Contains information about an `assetModelProperty` binding value. ## Contents ** assetModelId ** The ID of the asset model, in UUID format. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: Yes ** propertyId ** The ID of the asset model property used in data binding value. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: Yes ## See Also 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/iotsitewise-2019-12-02/AssetModelPropertyBindingValue) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/AssetModelPropertyBindingValue) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/AssetModelPropertyBindingValue) # AssetModelPropertyBindingValueFilter A filter used to match data bindings based on a specific asset model property. This filter identifies all computation models that reference a particular property of an asset model in their data bindings. ## Contents ** assetModelId ** The ID of the asset model containing the filter property. This identifies the specific asset model that contains the property of interest. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: Yes ** propertyId ** The ID of the property within the asset model to filter by. Only data bindings referencing this specific property of the specified asset model are matched. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: Yes ## See Also 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/iotsitewise-2019-12-02/AssetModelPropertyBindingValueFilter) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/AssetModelPropertyBindingValueFilter) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/AssetModelPropertyBindingValueFilter) # AssetModelPropertyDefinition Contains an asset model property definition. This property definition is applied to all assets created from the asset model. ## Contents ** dataType ** The data type of the property definition. If you specify `STRUCT`, you must also specify `dataTypeSpec` to identify the type of the structure for this property. Type: String Valid Values: `STRING | INTEGER | DOUBLE | BOOLEAN | STRUCT` Required: Yes ** name ** The name of the property definition. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[^\u0000-\u001F\u007F]+` Required: Yes ** type ** The property definition type (see `PropertyType`). You can only specify one type in a property definition. Type: [PropertyType](API_PropertyType.md) object Required: Yes ** dataTypeSpec ** The data type of the structure for this property. This parameter is required on properties that have the `STRUCT` data type. The options for this parameter depend on the type of the composite model in which you define this property. Use `AWS/ALARM_STATE` for alarm state in alarm composite models. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[^\u0000-\u001F\u007F]+` Required: No ** externalId ** An external ID to assign to the property definition. The external ID must be unique among property definitions within this asset model. For more information, see [Using external IDs](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/object-ids.html#external-ids) in the * Amazon IoT SiteWise User Guide*. Type: String Length Constraints: Minimum length of 2. Maximum length of 128. Pattern: `[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+` Required: No ** id ** The ID to assign to the asset model property, if desired. Amazon IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: No ** unit ** The unit of the property definition, such as `Newtons` or `RPM`. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[^\u0000-\u001F\u007F]+` Required: No ## See Also 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/iotsitewise-2019-12-02/AssetModelPropertyDefinition) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/AssetModelPropertyDefinition) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/AssetModelPropertyDefinition) # AssetModelPropertyPathSegment Represents one level between a property and the root of the asset model. ## Contents ** id ** The ID of the path segment. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: No ** name ** The name of the path segment. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[^\u0000-\u001F\u007F]+` Required: No ## See Also 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/iotsitewise-2019-12-02/AssetModelPropertyPathSegment) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/AssetModelPropertyPathSegment) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/AssetModelPropertyPathSegment) # AssetModelPropertySummary Contains a summary of a property associated with a model. This includes information about which interfaces the property belongs to, if any. ## Contents ** dataType ** The data type of the property. Type: String Valid Values: `STRING | INTEGER | DOUBLE | BOOLEAN | STRUCT` Required: Yes ** name ** The name of the property. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[^\u0000-\u001F\u007F]+` Required: Yes ** type ** Contains a property type, which can be one of `attribute`, `measurement`, `metric`, or `transform`. Type: [PropertyType](API_PropertyType.md) object Required: Yes ** assetModelCompositeModelId ** The ID of the composite model that contains the asset model property. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: No ** dataTypeSpec ** The data type of the structure for this property. This parameter exists on properties that have the `STRUCT` data type. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[^\u0000-\u001F\u007F]+` Required: No ** externalId ** The external ID of the property. For more information, see [Using external IDs](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/object-ids.html#external-ids) in the * Amazon IoT SiteWise User Guide*. Type: String Length Constraints: Minimum length of 2. Maximum length of 128. Pattern: `[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+` Required: No ** id ** The ID of the property. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: No ** interfaceSummaries ** A list of interface summaries that describe which interfaces this property belongs to, including the interface asset model ID and the corresponding property ID in the interface. Type: Array of [InterfaceSummary](API_InterfaceSummary.md) objects Required: No ** path ** The structured path to the property from the root of the asset model. Type: Array of [AssetModelPropertyPathSegment](API_AssetModelPropertyPathSegment.md) objects Required: No ** unit ** The unit (such as `Newtons` or `RPM`) of the property. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[^\u0000-\u001F\u007F]+` Required: No ## See Also 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/iotsitewise-2019-12-02/AssetModelPropertySummary) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/AssetModelPropertySummary) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/AssetModelPropertySummary) # AssetModelStatus Contains current status information for an asset model. For more information, see [Asset and model states](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/asset-and-model-states.html) in the * Amazon IoT SiteWise User Guide*. ## Contents ** state ** The current state of the asset model. Type: String Valid Values: `CREATING | ACTIVE | UPDATING | PROPAGATING | DELETING | FAILED` Required: Yes ** error ** Contains associated error information, if any. Type: [ErrorDetails](API_ErrorDetails.md) object Required: No ## See Also 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/iotsitewise-2019-12-02/AssetModelStatus) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/AssetModelStatus) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/AssetModelStatus) # AssetModelSummary Contains a summary of an asset model. ## Contents ** arn ** The [ARN](https://docs.amazonaws.cn/general/latest/gr/aws-arns-and-namespaces.html) of the asset model, which has the following format. `arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}` Type: String Length Constraints: Minimum length of 1. Maximum length of 1600. Pattern: `^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$` Required: Yes ** creationDate ** The date the asset model was created, in Unix epoch time. Type: Timestamp Required: Yes ** description ** The asset model description. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `[^\u0000-\u001F\u007F]+` Required: Yes ** id ** The ID of the asset model (used with Amazon IoT SiteWise API operations). Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: Yes ** lastUpdateDate ** The date the asset model was last updated, in Unix epoch time. Type: Timestamp Required: Yes ** name ** The name of the asset model. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[^\u0000-\u001F\u007F]+` Required: Yes ** status ** The current status of the asset model. Type: [AssetModelStatus](API_AssetModelStatus.md) object Required: Yes ** assetModelType ** The type of asset model. + **ASSET\$1MODEL** – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model. + **COMPONENT\$1MODEL** – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model. Type: String Valid Values: `ASSET_MODEL | COMPONENT_MODEL | INTERFACE` Required: No ** externalId ** The external ID of the asset model. For more information, see [Using external IDs](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/object-ids.html#external-ids) in the * Amazon IoT SiteWise User Guide*. Type: String Length Constraints: Minimum length of 2. Maximum length of 128. Pattern: `[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+` Required: No ** version ** The version number of the asset model. Type: String Length Constraints: Minimum length of 1. Maximum length of 10. Pattern: `^(0|([1-9]{1}\d*))$` Required: No ## See Also 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/iotsitewise-2019-12-02/AssetModelSummary) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/AssetModelSummary) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/AssetModelSummary) # AssetProperty Contains asset property information. ## Contents ** dataType ** The data type of the asset property. Type: String Valid Values: `STRING | INTEGER | DOUBLE | BOOLEAN | STRUCT` Required: Yes ** id ** The ID of the asset property. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: Yes ** name ** The name of the property. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[^\u0000-\u001F\u007F]+` Required: Yes ** alias ** The alias that identifies the property, such as an OPC-UA server data stream path (for example, `/company/windfarm/3/turbine/7/temperature`). For more information, see [Mapping industrial data streams to asset properties](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/connect-data-streams.html) in the * Amazon IoT SiteWise User Guide*. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: `[^\u0000-\u001F\u007F]+` Required: No ** dataTypeSpec ** The data type of the structure for this property. This parameter exists on properties that have the `STRUCT` data type. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[^\u0000-\u001F\u007F]+` Required: No ** externalId ** The external ID of the asset property. For more information, see [Using external IDs](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/object-ids.html#external-ids) in the * Amazon IoT SiteWise User Guide*. Type: String Length Constraints: Minimum length of 2. Maximum length of 128. Pattern: `[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+` Required: No ** notification ** The asset property's notification topic and state. For more information, see [UpdateAssetProperty](https://docs.amazonaws.cn/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html). Type: [PropertyNotification](API_PropertyNotification.md) object Required: No ** path ** The structured path to the property from the root of the asset. Type: Array of [AssetPropertyPathSegment](API_AssetPropertyPathSegment.md) objects Required: No ** unit ** The unit (such as `Newtons` or `RPM`) of the asset property. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[^\u0000-\u001F\u007F]+` Required: No ## See Also 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/iotsitewise-2019-12-02/AssetProperty) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/AssetProperty) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/AssetProperty) # AssetPropertyBindingValue Represents a data binding value referencing a specific asset property. It's used to bind computation model variables to actual asset property values for processing. ## Contents ** assetId ** The ID of the asset containing the property. This identifies the specific asset instance's property value used in the computation model. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: Yes ** propertyId ** The ID of the property within the asset. This identifies the specific property's value used in the computation model. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: Yes ## See Also 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/iotsitewise-2019-12-02/AssetPropertyBindingValue) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/AssetPropertyBindingValue) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/AssetPropertyBindingValue) # AssetPropertyBindingValueFilter A filter used to match data bindings based on a specific asset property. This filter helps identify all computation models referencing a particular property of an asset in their data bindings. ## Contents ** assetId ** The ID of the asset containing the property to filter by. This identifies the specific asset instance containing the property of interest. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: Yes ** propertyId ** The ID of the property within the asset to filter by. Only data bindings referencing this specific property of the specified asset are matched. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: Yes ## See Also 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/iotsitewise-2019-12-02/AssetPropertyBindingValueFilter) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/AssetPropertyBindingValueFilter) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/AssetPropertyBindingValueFilter) # AssetPropertyPathSegment Represents one level between a property and the root of the asset. ## Contents ** id ** The ID of the path segment. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: No ** name ** The name of the path segment. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[^\u0000-\u001F\u007F]+` Required: No ## See Also 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/iotsitewise-2019-12-02/AssetPropertyPathSegment) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/AssetPropertyPathSegment) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/AssetPropertyPathSegment) # AssetPropertySummary Contains a summary of a property associated with an asset. ## Contents ** id ** The ID of the property. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: Yes ** alias ** The alias that identifies the property, such as an OPC-UA server data stream path (for example, `/company/windfarm/3/turbine/7/temperature`). For more information, see [Mapping industrial data streams to asset properties](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/connect-data-streams.html) in the * Amazon IoT SiteWise User Guide*. Type: String Length Constraints: Minimum length of 1. Pattern: `[^\u0000-\u001F\u007F]+` Required: No ** assetCompositeModelId ** The ID of the composite model that contains the asset property. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: No ** externalId ** The external ID of the property. For more information, see [Using external IDs](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/object-ids.html#external-ids) in the * Amazon IoT SiteWise User Guide*. Type: String Length Constraints: Minimum length of 2. Maximum length of 128. Pattern: `[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+` Required: No ** notification ** Contains asset property value notification information. When the notification state is enabled, Amazon IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see [Interacting with other services](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/interact-with-other-services.html) in the * Amazon IoT SiteWise User Guide*. Type: [PropertyNotification](API_PropertyNotification.md) object Required: No ** path ** The structured path to the property from the root of the asset. Type: Array of [AssetPropertyPathSegment](API_AssetPropertyPathSegment.md) objects Required: No ** unit ** The unit of measure (such as Newtons or RPM) of the asset property. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[^\u0000-\u001F\u007F]+` Required: No ## See Also 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/iotsitewise-2019-12-02/AssetPropertySummary) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/AssetPropertySummary) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/AssetPropertySummary) # AssetPropertyValue Contains asset property value information. ## Contents ** timestamp ** The timestamp of the asset property value. Type: [TimeInNanos](API_TimeInNanos.md) object Required: Yes ** value ** The value of the asset property (see `Variant`). Type: [Variant](API_Variant.md) object Required: Yes ** quality ** The quality of the asset property value. Type: String Valid Values: `GOOD | BAD | UNCERTAIN` Required: No ## See Also 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/iotsitewise-2019-12-02/AssetPropertyValue) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/AssetPropertyValue) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/AssetPropertyValue) # AssetRelationshipSummary Contains information about assets that are related to one another. ## Contents ** relationshipType ** The relationship type of the assets in this relationship. This value is one of the following: + `HIERARCHY` – The assets are related through an asset hierarchy. If you specify this relationship type, this asset relationship includes the `hierarchyInfo` object. Type: String Valid Values: `HIERARCHY` Required: Yes ** hierarchyInfo ** The assets that are related through an asset hierarchy. This object is present if the `relationshipType` is `HIERARCHY`. Type: [AssetHierarchyInfo](API_AssetHierarchyInfo.md) object Required: No ## See Also 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/iotsitewise-2019-12-02/AssetRelationshipSummary) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/AssetRelationshipSummary) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/AssetRelationshipSummary) # AssetStatus Contains information about the current status of an asset. For more information, see [Asset and model states](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/asset-and-model-states.html) in the * Amazon IoT SiteWise User Guide*. ## Contents ** state ** The current status of the asset. Type: String Valid Values: `CREATING | ACTIVE | UPDATING | DELETING | FAILED` Required: Yes ** error ** Contains associated error information, if any. Type: [ErrorDetails](API_ErrorDetails.md) object Required: No ## See Also 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/iotsitewise-2019-12-02/AssetStatus) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/AssetStatus) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/AssetStatus) # AssetSummary Contains a summary of an asset. ## Contents ** arn ** The [ARN](https://docs.amazonaws.cn/general/latest/gr/aws-arns-and-namespaces.html) of the asset, which has the following format. `arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}` Type: String Length Constraints: Minimum length of 1. Maximum length of 1600. Pattern: `^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$` Required: Yes ** assetModelId ** The ID of the asset model used to create this asset. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: Yes ** creationDate ** The date the asset was created, in Unix epoch time. Type: Timestamp Required: Yes ** hierarchies ** A list of asset hierarchies that each contain a `hierarchyId`. A hierarchy specifies allowed parent/child asset relationships. Type: Array of [AssetHierarchy](API_AssetHierarchy.md) objects Required: Yes ** id ** The ID of the asset, in UUID format. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: Yes ** lastUpdateDate ** The date the asset was last updated, in Unix epoch time. Type: Timestamp Required: Yes ** name ** The name of the asset. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[^\u0000-\u001F\u007F]+` Required: Yes ** status ** The current status of the asset. Type: [AssetStatus](API_AssetStatus.md) object Required: Yes ** description ** A description for the asset. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `[^\u0000-\u001F\u007F]+` Required: No ** externalId ** The external ID of the asset. For more information, see [Using external IDs](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/object-ids.html#external-ids) in the * Amazon IoT SiteWise User Guide*. Type: String Length Constraints: Minimum length of 2. Maximum length of 128. Pattern: `[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+` Required: No ## See Also 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/iotsitewise-2019-12-02/AssetSummary) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/AssetSummary) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/AssetSummary) # AssociatedAssetsSummary Contains a summary of an associated asset. ## Contents ** arn ** The [ARN](https://docs.amazonaws.cn/general/latest/gr/aws-arns-and-namespaces.html) of the asset, which has the following format. `arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}` Type: String Length Constraints: Minimum length of 1. Maximum length of 1600. Pattern: `^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$` Required: Yes ** assetModelId ** The ID of the asset model used to create the asset. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: Yes ** creationDate ** The date the asset was created, in Unix epoch time. Type: Timestamp Required: Yes ** hierarchies ** A list of asset hierarchies that each contain a `hierarchyId`. A hierarchy specifies allowed parent/child asset relationships. Type: Array of [AssetHierarchy](API_AssetHierarchy.md) objects Required: Yes ** id ** The ID of the asset, in UUID format. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: Yes ** lastUpdateDate ** The date the asset was last updated, in Unix epoch time. Type: Timestamp Required: Yes ** name ** The name of the asset. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[^\u0000-\u001F\u007F]+` Required: Yes ** status ** The current status of the asset. Type: [AssetStatus](API_AssetStatus.md) object Required: Yes ** description ** A description for the asset. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `[^\u0000-\u001F\u007F]+` Required: No ** externalId ** The external ID of the asset. For more information, see [Using external IDs](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/object-ids.html#external-ids) in the * Amazon IoT SiteWise User Guide*. Type: String Length Constraints: Minimum length of 2. Maximum length of 128. Pattern: `[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+` Required: No ## See Also 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/iotsitewise-2019-12-02/AssociatedAssetsSummary) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/AssociatedAssetsSummary) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/AssociatedAssetsSummary) # Attribute Contains an asset attribute property. For more information, see [Attributes](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/asset-properties.html#attributes) in the * Amazon IoT SiteWise User Guide*. ## Contents ** defaultValue ** The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see [Updating attribute values](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/update-attribute-values.html) in the * Amazon IoT SiteWise User Guide*. Type: String Pattern: `[^\u0000-\u001F\u007F]+` Required: No ## See Also 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/iotsitewise-2019-12-02/Attribute) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/Attribute) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/Attribute) # BatchGetAssetPropertyAggregatesEntry Contains information for an asset property aggregate entry that is associated with the [BatchGetAssetPropertyAggregates](https://docs.amazonaws.cn/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html) API. To identify an asset property, you must specify one of the following: + The `assetId` and `propertyId` of an asset property. + A `propertyAlias`, which is a data stream alias (for example, `/company/windfarm/3/turbine/7/temperature`). To define an asset property's alias, see [UpdateAssetProperty](https://docs.amazonaws.cn/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html). ## Contents ** aggregateTypes ** The data aggregating function. Type: Array of strings Array Members: Minimum number of 1 item. Valid Values: `AVERAGE | COUNT | MAXIMUM | MINIMUM | SUM | STANDARD_DEVIATION` Required: Yes ** endDate ** The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time. Type: Timestamp Required: Yes ** entryId ** The ID of the entry. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** resolution ** The time interval over which to aggregate data. Type: String Length Constraints: Minimum length of 2. Maximum length of 3. Pattern: `1m|15m|1h|1d` Required: Yes ** startDate ** The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time. Type: Timestamp Required: Yes ** assetId ** The ID of the asset in which the asset property was created. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: No ** propertyAlias ** The alias that identifies the property, such as an OPC-UA server data stream path (for example, `/company/windfarm/3/turbine/7/temperature`). For more information, see [Mapping industrial data streams to asset properties](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/connect-data-streams.html) in the * Amazon IoT SiteWise User Guide*. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `[^\u0000-\u001F\u007F]+` Required: No ** propertyId ** The ID of the asset property, in UUID format. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: No ** qualities ** The quality by which to filter asset data. Type: Array of strings Array Members: Fixed number of 1 item. Valid Values: `GOOD | BAD | UNCERTAIN` Required: No ** timeOrdering ** The chronological sorting order of the requested information. Default: `ASCENDING` Type: String Valid Values: `ASCENDING | DESCENDING` Required: No ## See Also 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/iotsitewise-2019-12-02/BatchGetAssetPropertyAggregatesEntry) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/BatchGetAssetPropertyAggregatesEntry) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/BatchGetAssetPropertyAggregatesEntry) # BatchGetAssetPropertyAggregatesErrorEntry Contains error information for an asset property aggregate entry that is associated with the [BatchGetAssetPropertyAggregates](https://docs.amazonaws.cn/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html) API. ## Contents ** entryId ** The ID of the entry. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** errorCode ** The error code. Type: String Valid Values: `ResourceNotFoundException | InvalidRequestException | AccessDeniedException` Required: Yes ** errorMessage ** The associated error message. Type: String Required: Yes ## See Also 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/iotsitewise-2019-12-02/BatchGetAssetPropertyAggregatesErrorEntry) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/BatchGetAssetPropertyAggregatesErrorEntry) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/BatchGetAssetPropertyAggregatesErrorEntry) # BatchGetAssetPropertyAggregatesErrorInfo Contains the error code and the timestamp for an asset property aggregate entry that is associated with the [BatchGetAssetPropertyAggregates](https://docs.amazonaws.cn/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html) API. ## Contents ** errorCode ** The error code. Type: String Valid Values: `ResourceNotFoundException | InvalidRequestException | AccessDeniedException` Required: Yes ** errorTimestamp ** The date the error occurred, in Unix epoch time. Type: Timestamp Required: Yes ## See Also 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/iotsitewise-2019-12-02/BatchGetAssetPropertyAggregatesErrorInfo) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/BatchGetAssetPropertyAggregatesErrorInfo) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/BatchGetAssetPropertyAggregatesErrorInfo) # BatchGetAssetPropertyAggregatesSkippedEntry Contains information for an entry that has been processed by the previous [BatchGetAssetPropertyAggregates](https://docs.amazonaws.cn/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html) request. ## Contents ** completionStatus ** The completion status of each entry that is associated with the [BatchGetAssetPropertyAggregates](https://docs.amazonaws.cn/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html) API. Type: String Valid Values: `SUCCESS | ERROR` Required: Yes ** entryId ** The ID of the entry. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** errorInfo ** The error information, such as the error code and the timestamp. Type: [BatchGetAssetPropertyAggregatesErrorInfo](API_BatchGetAssetPropertyAggregatesErrorInfo.md) object Required: No ## See Also 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/iotsitewise-2019-12-02/BatchGetAssetPropertyAggregatesSkippedEntry) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/BatchGetAssetPropertyAggregatesSkippedEntry) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/BatchGetAssetPropertyAggregatesSkippedEntry) # BatchGetAssetPropertyAggregatesSuccessEntry Contains success information for an entry that is associated with the [BatchGetAssetPropertyAggregates](https://docs.amazonaws.cn/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html) API. ## Contents ** aggregatedValues ** The requested aggregated asset property values (for example, average, minimum, and maximum). Type: Array of [AggregatedValue](API_AggregatedValue.md) objects Required: Yes ** entryId ** The ID of the entry. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## See Also 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/iotsitewise-2019-12-02/BatchGetAssetPropertyAggregatesSuccessEntry) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/BatchGetAssetPropertyAggregatesSuccessEntry) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/BatchGetAssetPropertyAggregatesSuccessEntry) # BatchGetAssetPropertyValueEntry Contains information for an asset property value entry that is associated with the [BatchGetAssetPropertyValue](https://docs.amazonaws.cn/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html) API. To identify an asset property, you must specify one of the following: + The `assetId` and `propertyId` of an asset property. + A `propertyAlias`, which is a data stream alias (for example, `/company/windfarm/3/turbine/7/temperature`). To define an asset property's alias, see [UpdateAssetProperty](https://docs.amazonaws.cn/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html). ## Contents ** entryId ** The ID of the entry. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** assetId ** The ID of the asset in which the asset property was created. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: No ** propertyAlias ** The alias that identifies the property, such as an OPC-UA server data stream path (for example, `/company/windfarm/3/turbine/7/temperature`). For more information, see [Mapping industrial data streams to asset properties](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/connect-data-streams.html) in the * Amazon IoT SiteWise User Guide*. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `[^\u0000-\u001F\u007F]+` Required: No ** propertyId ** The ID of the asset property, in UUID format. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: No ## See Also 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/iotsitewise-2019-12-02/BatchGetAssetPropertyValueEntry) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/BatchGetAssetPropertyValueEntry) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/BatchGetAssetPropertyValueEntry) # BatchGetAssetPropertyValueErrorEntry Contains error information for an asset property value entry that is associated with the [BatchGetAssetPropertyValue](https://docs.amazonaws.cn/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html) API. ## Contents ** entryId ** The ID of the entry. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** errorCode ** The error code. Type: String Valid Values: `ResourceNotFoundException | InvalidRequestException | AccessDeniedException` Required: Yes ** errorMessage ** The associated error message. Type: String Required: Yes ## See Also 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/iotsitewise-2019-12-02/BatchGetAssetPropertyValueErrorEntry) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/BatchGetAssetPropertyValueErrorEntry) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/BatchGetAssetPropertyValueErrorEntry) # BatchGetAssetPropertyValueErrorInfo The error information, such as the error code and the timestamp. ## Contents ** errorCode ** The error code. Type: String Valid Values: `ResourceNotFoundException | InvalidRequestException | AccessDeniedException` Required: Yes ** errorTimestamp ** The date the error occurred, in Unix epoch time. Type: Timestamp Required: Yes ## See Also 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/iotsitewise-2019-12-02/BatchGetAssetPropertyValueErrorInfo) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/BatchGetAssetPropertyValueErrorInfo) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/BatchGetAssetPropertyValueErrorInfo) # BatchGetAssetPropertyValueHistoryEntry Contains information for an asset property historical value entry that is associated with the [BatchGetAssetPropertyValueHistory](https://docs.amazonaws.cn/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html) API. To identify an asset property, you must specify one of the following: + The `assetId` and `propertyId` of an asset property. + A `propertyAlias`, which is a data stream alias (for example, `/company/windfarm/3/turbine/7/temperature`). To define an asset property's alias, see [UpdateAssetProperty](https://docs.amazonaws.cn/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html). ## Contents ** entryId ** The ID of the entry. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** assetId ** The ID of the asset in which the asset property was created. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: No ** endDate ** The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time. Type: Timestamp Required: No ** propertyAlias ** The alias that identifies the property, such as an OPC-UA server data stream path (for example, `/company/windfarm/3/turbine/7/temperature`). For more information, see [Mapping industrial data streams to asset properties](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/connect-data-streams.html) in the * Amazon IoT SiteWise User Guide*. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `[^\u0000-\u001F\u007F]+` Required: No ** propertyId ** The ID of the asset property, in UUID format. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: No ** qualities ** The quality by which to filter asset data. Type: Array of strings Array Members: Fixed number of 1 item. Valid Values: `GOOD | BAD | UNCERTAIN` Required: No ** startDate ** The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time. Type: Timestamp Required: No ** timeOrdering ** The chronological sorting order of the requested information. Default: `ASCENDING` Type: String Valid Values: `ASCENDING | DESCENDING` Required: No ## See Also 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/iotsitewise-2019-12-02/BatchGetAssetPropertyValueHistoryEntry) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/BatchGetAssetPropertyValueHistoryEntry) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/BatchGetAssetPropertyValueHistoryEntry) # BatchGetAssetPropertyValueHistoryErrorEntry A list of the errors (if any) associated with the batch request. Each error entry contains the `entryId` of the entry that failed. ## Contents ** entryId ** The ID of the entry. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** errorCode ** The error code. Type: String Valid Values: `ResourceNotFoundException | InvalidRequestException | AccessDeniedException` Required: Yes ** errorMessage ** The associated error message. Type: String Required: Yes ## See Also 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/iotsitewise-2019-12-02/BatchGetAssetPropertyValueHistoryErrorEntry) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/BatchGetAssetPropertyValueHistoryErrorEntry) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/BatchGetAssetPropertyValueHistoryErrorEntry) # BatchGetAssetPropertyValueHistoryErrorInfo The error information, such as the error code and the timestamp. ## Contents ** errorCode ** The error code. Type: String Valid Values: `ResourceNotFoundException | InvalidRequestException | AccessDeniedException` Required: Yes ** errorTimestamp ** The date the error occurred, in Unix epoch time. Type: Timestamp Required: Yes ## See Also 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/iotsitewise-2019-12-02/BatchGetAssetPropertyValueHistoryErrorInfo) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/BatchGetAssetPropertyValueHistoryErrorInfo) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/BatchGetAssetPropertyValueHistoryErrorInfo) # BatchGetAssetPropertyValueHistorySkippedEntry Contains information for an entry that has been processed by the previous [BatchGetAssetPropertyValueHistory](https://docs.amazonaws.cn/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html) request. ## Contents ** completionStatus ** The completion status of each entry that is associated with the [BatchGetAssetPropertyValueHistory](https://docs.amazonaws.cn/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValueHistory.html) API. Type: String Valid Values: `SUCCESS | ERROR` Required: Yes ** entryId ** The ID of the entry. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** errorInfo ** The error information, such as the error code and the timestamp. Type: [BatchGetAssetPropertyValueHistoryErrorInfo](API_BatchGetAssetPropertyValueHistoryErrorInfo.md) object Required: No ## See Also 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/iotsitewise-2019-12-02/BatchGetAssetPropertyValueHistorySkippedEntry) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/BatchGetAssetPropertyValueHistorySkippedEntry) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/BatchGetAssetPropertyValueHistorySkippedEntry) # BatchGetAssetPropertyValueHistorySuccessEntry Contains success information for an entry that is associated with the [BatchGetAssetPropertyValueHistory](https://docs.amazonaws.cn/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html) API. ## Contents ** assetPropertyValueHistory ** The requested historical values for the specified asset property. Type: Array of [AssetPropertyValue](API_AssetPropertyValue.md) objects Required: Yes ** entryId ** The ID of the entry. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## See Also 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/iotsitewise-2019-12-02/BatchGetAssetPropertyValueHistorySuccessEntry) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/BatchGetAssetPropertyValueHistorySuccessEntry) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/BatchGetAssetPropertyValueHistorySuccessEntry) # BatchGetAssetPropertyValueSkippedEntry Contains information for an entry that has been processed by the previous [BatchGetAssetPropertyValue](https://docs.amazonaws.cn/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html) request. ## Contents ** completionStatus ** The completion status of each entry that is associated with the [BatchGetAssetPropertyValue](https://docs.amazonaws.cn/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html) request. Type: String Valid Values: `SUCCESS | ERROR` Required: Yes ** entryId ** The ID of the entry. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** errorInfo ** The error information, such as the error code and the timestamp. Type: [BatchGetAssetPropertyValueErrorInfo](API_BatchGetAssetPropertyValueErrorInfo.md) object Required: No ## See Also 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/iotsitewise-2019-12-02/BatchGetAssetPropertyValueSkippedEntry) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/BatchGetAssetPropertyValueSkippedEntry) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/BatchGetAssetPropertyValueSkippedEntry) # BatchGetAssetPropertyValueSuccessEntry Contains success information for an entry that is associated with the [BatchGetAssetPropertyValue](https://docs.amazonaws.cn/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html) API. ## Contents ** entryId ** The ID of the entry. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** assetPropertyValue ** Contains asset property value information. Type: [AssetPropertyValue](API_AssetPropertyValue.md) object Required: No ## See Also 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/iotsitewise-2019-12-02/BatchGetAssetPropertyValueSuccessEntry) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/BatchGetAssetPropertyValueSuccessEntry) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/BatchGetAssetPropertyValueSuccessEntry) # BatchPutAssetPropertyError Contains error information from updating a batch of asset property values. ## Contents ** errorCode ** The error code. Type: String Valid Values: `ResourceNotFoundException | InvalidRequestException | InternalFailureException | ServiceUnavailableException | ThrottlingException | LimitExceededException | ConflictingOperationException | TimestampOutOfRangeException | AccessDeniedException` Required: Yes ** errorMessage ** The associated error message. Type: String Required: Yes ** timestamps ** A list of timestamps for each error, if any. Type: Array of [TimeInNanos](API_TimeInNanos.md) objects Required: Yes ## See Also 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/iotsitewise-2019-12-02/BatchPutAssetPropertyError) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/BatchPutAssetPropertyError) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/BatchPutAssetPropertyError) # BatchPutAssetPropertyErrorEntry Contains error information for asset property value entries that are associated with the [BatchPutAssetPropertyValue](https://docs.amazonaws.cn/iot-sitewise/latest/APIReference/API_BatchPutAssetPropertyValue.html) API. ## Contents ** entryId ** The ID of the failed entry. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** errors ** The list of update property value errors. Type: Array of [BatchPutAssetPropertyError](API_BatchPutAssetPropertyError.md) objects Required: Yes ## See Also 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/iotsitewise-2019-12-02/BatchPutAssetPropertyErrorEntry) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/BatchPutAssetPropertyErrorEntry) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/BatchPutAssetPropertyErrorEntry) # Citation Contains text content to which the SiteWise Assistant refers to, and generate the final response. It also contains information about the source. ## Contents ** content ** Contains the cited text from the data source. Type: [Content](API_Content.md) object Required: No ** reference ** Contains information about the data source. Type: [Reference](API_Reference.md) object Required: No ## See Also 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/iotsitewise-2019-12-02/Citation) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/Citation) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/Citation) # ColumnInfo A description of the column in the query results. ## Contents ** name ** The name of the column description. Type: String Required: No ** type ** The type of the column description. Type: [ColumnType](API_ColumnType.md) object Required: No ## See Also 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/iotsitewise-2019-12-02/ColumnInfo) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/ColumnInfo) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/ColumnInfo) # ColumnType The data type of the column. ## Contents ** scalarType ** The allowed data types that the column has as it's value. Type: String Valid Values: `BOOLEAN | INT | DOUBLE | TIMESTAMP | STRING` Required: No ## See Also 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/iotsitewise-2019-12-02/ColumnType) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/ColumnType) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/ColumnType) # CompositeModelProperty Contains information about a composite model property on an asset. ## Contents ** assetProperty ** Contains asset property information. Type: [Property](API_Property.md) object Required: Yes ** name ** The name of the property. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[^\u0000-\u001F\u007F]+` Required: Yes ** type ** The type of the composite model that defines this property. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[^\u0000-\u001F\u007F]+` Required: Yes ** externalId ** The external ID of the composite model that contains the property. For more information, see [Using external IDs](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/object-ids.html#external-ids) in the * Amazon IoT SiteWise User Guide*. Type: String Length Constraints: Minimum length of 2. Maximum length of 128. Pattern: `[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+` Required: No ** id ** The ID of the composite model that contains the property. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: No ## See Also 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/iotsitewise-2019-12-02/CompositeModelProperty) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/CompositeModelProperty) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/CompositeModelProperty) # CompositionDetails Metadata for the composition relationship established by using `composedAssetModelId` in [https://docs.amazonaws.cn/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html](https://docs.amazonaws.cn/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html). ## Contents ** compositionRelationship ** An array detailing the composition relationship for this composite model. Type: Array of [CompositionRelationshipItem](API_CompositionRelationshipItem.md) objects Required: No ## See Also 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/iotsitewise-2019-12-02/CompositionDetails) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/CompositionDetails) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/CompositionDetails) # CompositionRelationshipItem Represents a composite model that composed an asset model of type `COMPONENT_MODEL`. ## Contents ** id ** The ID of the component. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: No ## See Also 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/iotsitewise-2019-12-02/CompositionRelationshipItem) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/CompositionRelationshipItem) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/CompositionRelationshipItem) # CompositionRelationshipSummary Contains a summary of the components of the composite model. ## Contents ** assetModelCompositeModelId ** The ID of a composite model on this asset model. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: Yes ** assetModelCompositeModelType ** The composite model type. Valid values are `AWS/ALARM`, `CUSTOM`, or ` AWS/L4E_ANOMALY`. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[^\u0000-\u001F\u007F]+` Required: Yes ** assetModelId ** The ID of the asset model, in UUID format. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: Yes ## See Also 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/iotsitewise-2019-12-02/CompositionRelationshipSummary) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/CompositionRelationshipSummary) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/CompositionRelationshipSummary) # ComputationModelAnomalyDetectionConfiguration Contains the configuration of the type of anomaly detection computation model. ## Contents ** inputProperties ** Define the variable name associated with input properties, with the following format `${VariableName}`. Type: String Length Constraints: Minimum length of 4. Maximum length of 67. Pattern: `^\$\{[a-z][a-z0-9_]*\}` Required: Yes ** resultProperty ** Define the variable name associated with the result property, and the following format `${VariableName}`. Type: String Length Constraints: Minimum length of 4. Maximum length of 67. Pattern: `^\$\{[a-z][a-z0-9_]*\}` Required: Yes ## See Also 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/iotsitewise-2019-12-02/ComputationModelAnomalyDetectionConfiguration) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/ComputationModelAnomalyDetectionConfiguration) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/ComputationModelAnomalyDetectionConfiguration) # ComputationModelConfiguration The configuration for the computation model. ## Contents ** anomalyDetection ** The configuration for the anomaly detection type of computation model. Type: [ComputationModelAnomalyDetectionConfiguration](API_ComputationModelAnomalyDetectionConfiguration.md) object Required: No ## See Also 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/iotsitewise-2019-12-02/ComputationModelConfiguration) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/ComputationModelConfiguration) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/ComputationModelConfiguration) # ComputationModelDataBindingUsageSummary A summary of how a specific data binding is used across computation models. This tracks dependencies between data sources and computation models, allowing you to understand the impact of changes to data sources. ## Contents ** computationModelIds ** The list of computation model IDs that use this data binding. This allows identification of all computation models affected by changes to the referenced data source. Type: Array of strings Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: Yes ** matchedDataBinding ** The data binding matched by the filter criteria. Contains details about specific data binding values used by the computation models. Type: [MatchedDataBinding](API_MatchedDataBinding.md) object Required: Yes ## See Also 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/iotsitewise-2019-12-02/ComputationModelDataBindingUsageSummary) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/ComputationModelDataBindingUsageSummary) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/ComputationModelDataBindingUsageSummary) # ComputationModelDataBindingValue Contains computation model data binding value information, which can be one of `assetModelProperty`, `list`. ## Contents ** assetModelProperty ** Specifies an asset model property data binding value. Type: [AssetModelPropertyBindingValue](API_AssetModelPropertyBindingValue.md) object Required: No ** assetProperty ** The asset property value used for computation model data binding. Type: [AssetPropertyBindingValue](API_AssetPropertyBindingValue.md) object Required: No ** list ** Specifies a list of data binding value. Type: Array of [ComputationModelDataBindingValue](#API_ComputationModelDataBindingValue) objects Required: No ## See Also 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/iotsitewise-2019-12-02/ComputationModelDataBindingValue) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/ComputationModelDataBindingValue) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/ComputationModelDataBindingValue) # ComputationModelResolveToResourceSummary A summary of the resource that a computation model resolves to. ## Contents ** resolveTo ** The detailed resource this execution summary resolves to. Type: [ResolveTo](API_ResolveTo.md) object Required: No ## See Also 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/iotsitewise-2019-12-02/ComputationModelResolveToResourceSummary) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/ComputationModelResolveToResourceSummary) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/ComputationModelResolveToResourceSummary) # ComputationModelStatus Contains current status information for a computation model. ## Contents ** state ** The current state of the computation model. Type: String Valid Values: `CREATING | ACTIVE | UPDATING | DELETING | FAILED` Required: Yes ** error ** Contains the details of an Amazon IoT SiteWise error. Type: [ErrorDetails](API_ErrorDetails.md) object Required: No ## See Also 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/iotsitewise-2019-12-02/ComputationModelStatus) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/ComputationModelStatus) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/ComputationModelStatus) # ComputationModelSummary Contains a summary of a computation model. ## Contents ** arn ** The [ARN](https://docs.amazonaws.cn/general/latest/gr/aws-arns-and-namespaces.html) of the computation model, which has the following format. `arn:${Partition}:iotsitewise:${Region}:${Account}:computation-model/${ComputationModelId}` Type: String Length Constraints: Minimum length of 1. Maximum length of 1600. Pattern: `^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$` Required: Yes ** creationDate ** The model creation date, in Unix epoch time. Type: Timestamp Required: Yes ** id ** The ID of the computation model. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: Yes ** lastUpdateDate ** The time the model was last updated, in Unix epoch time. Type: Timestamp Required: Yes ** name ** The name of the computation model. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `^[a-zA-Z0-9 _\-#$*!@]+$` Required: Yes ** status ** The current status of the computation model. Type: [ComputationModelStatus](API_ComputationModelStatus.md) object Required: Yes ** type ** The type of the computation model. Type: String Valid Values: `ANOMALY_DETECTION` Required: Yes ** version ** The version of the computation model. Type: String Length Constraints: Minimum length of 1. Maximum length of 10. Pattern: `^(0|([1-9]{1}\d*))$` Required: Yes ** description ** The description of the computation model. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `^[a-zA-Z0-9 _\-#$*!@]+$` Required: No ## See Also 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/iotsitewise-2019-12-02/ComputationModelSummary) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/ComputationModelSummary) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/ComputationModelSummary) # ConfigurationErrorDetails Contains the details of an Amazon IoT SiteWise configuration error. ## Contents ** code ** The error code. Type: String Valid Values: `VALIDATION_ERROR | INTERNAL_FAILURE` Required: Yes ** message ** The error message. Type: String Required: Yes ## See Also 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/iotsitewise-2019-12-02/ConfigurationErrorDetails) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/ConfigurationErrorDetails) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/ConfigurationErrorDetails) # ConfigurationStatus Contains current status information for the configuration. ## Contents ** state ** The current state of the configuration. Type: String Valid Values: `ACTIVE | UPDATE_IN_PROGRESS | UPDATE_FAILED` Required: Yes ** error ** Contains associated error information, if any. Type: [ConfigurationErrorDetails](API_ConfigurationErrorDetails.md) object Required: No ## See Also 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/iotsitewise-2019-12-02/ConfigurationStatus) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/ConfigurationStatus) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/ConfigurationStatus) # Content Contains the cited text from the data source. ## Contents ** text ** The cited text from the data source. Type: String Required: No ## See Also 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/iotsitewise-2019-12-02/Content) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/Content) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/Content) # Csv A .CSV file. ## Contents ** columnNames ** The column names specified in the .csv file. Type: Array of strings Valid Values: `ALIAS | ASSET_ID | PROPERTY_ID | DATA_TYPE | TIMESTAMP_SECONDS | TIMESTAMP_NANO_OFFSET | QUALITY | VALUE` Required: Yes ## See Also 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/iotsitewise-2019-12-02/Csv) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/Csv) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/Csv) # CustomerManagedS3Storage Contains information about a customer managed Amazon S3 bucket. ## Contents ** roleArn ** The [ARN](https://docs.amazonaws.cn/general/latest/gr/aws-arns-and-namespaces.html) of the Amazon Identity and Access Management role that allows Amazon IoT SiteWise to send data to Amazon S3. Type: String Length Constraints: Minimum length of 1. Maximum length of 1600. Pattern: `^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$` Required: Yes ** s3ResourceArn ** The [ARN](https://docs.amazonaws.cn/general/latest/gr/aws-arns-and-namespaces.html) of the Amazon S3 object. For more information about how to find the ARN for an Amazon S3 object, see [Amazon S3 resources](https://docs.amazonaws.cn/AmazonS3/latest/userguide/s3-arn-format.html) in the *Amazon Simple Storage Service User Guide*. Type: String Length Constraints: Minimum length of 1. Maximum length of 1600. Pattern: `^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$` Required: Yes ## See Also 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/iotsitewise-2019-12-02/CustomerManagedS3Storage) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/CustomerManagedS3Storage) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/CustomerManagedS3Storage) # DashboardSummary Contains a dashboard summary. ## Contents ** id ** The ID of the dashboard. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: Yes ** name ** The name of the dashboard Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[^\u0000-\u001F\u007F]+` Required: Yes ** creationDate ** The date the dashboard was created, in Unix epoch time. Type: Timestamp Required: No ** description ** The dashboard's description. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `[^\u0000-\u001F\u007F]+` Required: No ** lastUpdateDate ** The date the dashboard was last updated, in Unix epoch time. Type: Timestamp Required: No ## See Also 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/iotsitewise-2019-12-02/DashboardSummary) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/DashboardSummary) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/DashboardSummary) # DataBindingValue Represents a value used in a data binding. It can be an asset property or an asset model property. ## Contents ** assetModelProperty ** Contains information about an `assetModelProperty` binding value. Type: [AssetModelPropertyBindingValue](API_AssetModelPropertyBindingValue.md) object Required: No ** assetProperty ** The asset property value used in the data binding. Type: [AssetPropertyBindingValue](API_AssetPropertyBindingValue.md) object Required: No ## See Also 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/iotsitewise-2019-12-02/DataBindingValue) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/DataBindingValue) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/DataBindingValue) # DataBindingValueFilter A filter used to match specific data binding values based on criteria. This filter allows searching for data bindings by asset, asset model, asset property, or asset model property. ## Contents ** asset ** Filter criteria for matching data bindings based on a specific asset. Used to list all data bindings referencing a particular asset or its properties. Type: [AssetBindingValueFilter](API_AssetBindingValueFilter.md) object Required: No ** assetModel ** Filter criteria for matching data bindings based on a specific asset model. Used to list all data bindings referencing a particular asset model or its properties. Type: [AssetModelBindingValueFilter](API_AssetModelBindingValueFilter.md) object Required: No ** assetModelProperty ** Filter criteria for matching data bindings based on a specific asset model property. Used to list all data bindings referencing a particular property of an asset model. Type: [AssetModelPropertyBindingValueFilter](API_AssetModelPropertyBindingValueFilter.md) object Required: No ** assetProperty ** Filter criteria for matching data bindings based on a specific asset property. Used to list all data bindings referencing a particular property of an asset. Type: [AssetPropertyBindingValueFilter](API_AssetPropertyBindingValueFilter.md) object Required: No ## See Also 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/iotsitewise-2019-12-02/DataBindingValueFilter) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/DataBindingValueFilter) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/DataBindingValueFilter) # DataSetReference Contains information about the dataset use and it's source. ## Contents ** datasetArn ** The [ARN](https://docs.amazonaws.cn/IAM/latest/UserGuide/reference-arns.html) of the dataset. The format is `arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId}`. Type: String Required: No ** source ** The data source for the dataset. Type: [Source](API_Source.md) object Required: No ## See Also 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/iotsitewise-2019-12-02/DataSetReference) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/DataSetReference) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/DataSetReference) # DatasetSource The data source for the dataset. ## Contents ** sourceFormat ** The format of the dataset source associated with the dataset. Type: String Valid Values: `KNOWLEDGE_BASE` Required: Yes ** sourceType ** The type of data source for the dataset. Type: String Valid Values: `KENDRA` Required: Yes ** sourceDetail ** The details of the dataset source associated with the dataset. Type: [SourceDetail](API_SourceDetail.md) object Required: No ## See Also 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/iotsitewise-2019-12-02/DatasetSource) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/DatasetSource) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/DatasetSource) # DatasetStatus The status of the dataset. This contains the state and any error messages. The state is `ACTIVE` when ready to use. ## Contents ** state ** The current status of the dataset. Type: String Valid Values: `CREATING | ACTIVE | UPDATING | DELETING | FAILED` Required: Yes ** error ** Contains the details of an Amazon IoT SiteWise error. Type: [ErrorDetails](API_ErrorDetails.md) object Required: No ## See Also 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/iotsitewise-2019-12-02/DatasetStatus) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/DatasetStatus) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/DatasetStatus) # DatasetSummary The summary details for the dataset. ## Contents ** arn ** The [ARN](https://docs.amazonaws.cn/IAM/latest/UserGuide/reference-arns.html) of the dataset. The format is `arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId}`. Type: String Length Constraints: Minimum length of 1. Maximum length of 1600. Pattern: `^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$` Required: Yes ** creationDate ** The dataset creation date, in Unix epoch time. Type: Timestamp Required: Yes ** description ** A description about the dataset, and its functionality. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `^[a-zA-Z0-9 _\-#$*!@]+$` Required: Yes ** id ** The ID of the dataset. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: Yes ** lastUpdateDate ** The date the dataset was last updated, in Unix epoch time. Type: Timestamp Required: Yes ** name ** The name of the dataset. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `^[a-zA-Z0-9 _\-#$*!@]+$` Required: Yes ** status ** The status of the dataset. This contains the state and any error messages. The state is `ACTIVE` when ready to use. Type: [DatasetStatus](API_DatasetStatus.md) object Required: Yes ## See Also 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/iotsitewise-2019-12-02/DatasetSummary) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/DatasetSummary) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/DatasetSummary) # Datum Represents a single data point in a query result. ## Contents ** arrayValue ** Indicates if the data point is an array. Type: Array of [Datum](#API_Datum) objects Required: No ** nullValue ** Indicates if the data point is null. Type: Boolean Required: No ** rowValue ** Indicates if the data point is a row. Type: [Row](API_Row.md) object Required: No ** scalarValue ** Indicates if the data point is a scalar value such as integer, string, double, or Boolean. Type: String Required: No ## See Also 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/iotsitewise-2019-12-02/Datum) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/Datum) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/Datum) # DetailedError Contains detailed error information. ## Contents ** code ** The error code. Type: String Valid Values: `INCOMPATIBLE_COMPUTE_LOCATION | INCOMPATIBLE_FORWARDING_CONFIGURATION` Required: Yes ** message ** The error message. Type: String Required: Yes ## See Also 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/iotsitewise-2019-12-02/DetailedError) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/DetailedError) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/DetailedError) # ErrorDetails Contains the details of an Amazon IoT SiteWise error. ## Contents ** code ** The error code. Type: String Valid Values: `VALIDATION_ERROR | INTERNAL_FAILURE` Required: Yes ** message ** The error message. Type: String Required: Yes ** details ** A list of detailed errors. Type: Array of [DetailedError](API_DetailedError.md) objects Required: No ## See Also 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/iotsitewise-2019-12-02/ErrorDetails) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/ErrorDetails) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/ErrorDetails) # ErrorReportLocation The Amazon S3 destination where errors associated with the job creation request are saved. ## Contents ** bucket ** The name of the Amazon S3 bucket to which errors associated with the bulk import job are sent. Type: String Length Constraints: Minimum length of 3. Maximum length of 63. Required: Yes ** prefix ** Amazon S3 uses the prefix as a folder name to organize data in the bucket. Each Amazon S3 object has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/). For more information, see [Organizing objects using prefixes](https://docs.amazonaws.cn/AmazonS3/latest/userguide/using-prefixes.html) in the *Amazon Simple Storage Service User Guide*. Type: String Required: Yes ## See Also 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/iotsitewise-2019-12-02/ErrorReportLocation) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/ErrorReportLocation) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/ErrorReportLocation) # ExecutionStatus The status of the execution. ## Contents ** state ** The current state of the computation model. Type: String Valid Values: `RUNNING | COMPLETED | FAILED` Required: Yes ## See Also 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/iotsitewise-2019-12-02/ExecutionStatus) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/ExecutionStatus) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/ExecutionStatus) # ExecutionSummary Contains the execution summary of the computation model. ## Contents ** executionId ** The ID of the execution. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: Yes ** executionStartTime ** The time the process started. Type: Timestamp Required: Yes ** executionStatus ** The status of the execution process. Type: [ExecutionStatus](API_ExecutionStatus.md) object Required: Yes ** targetResource ** The resource the action will be taken on. This can include asset-based resources and computation model resources. Type: [TargetResource](API_TargetResource.md) object Required: Yes ** targetResourceVersion ** The version of the target resource. Type: String Length Constraints: Minimum length of 1. Maximum length of 10. Pattern: `^(0|([1-9]{1}\d*))$` Required: Yes ** actionType ** The type of action exectued. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[^\u0000-\u001F\u007F]+` Required: No ** executionEndTime ** The time the process ended. Type: Timestamp Required: No ** executionEntityVersion ** The execution entity version associated with the summary. Type: String Length Constraints: Minimum length of 1. Maximum length of 10. Pattern: `^(0|([1-9]{1}\d*))$` Required: No ** resolveTo ** The detailed resource this execution resolves to. Type: [ResolveTo](API_ResolveTo.md) object Required: No ## See Also 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/iotsitewise-2019-12-02/ExecutionSummary) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/ExecutionSummary) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/ExecutionSummary) # ExpressionVariable Contains expression variable information. ## Contents ** name ** The friendly name of the variable to be used in the expression. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-z][a-z0-9_]*$` Required: Yes ** value ** The variable that identifies an asset property from which to use values. Type: [VariableValue](API_VariableValue.md) object Required: Yes ## See Also 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/iotsitewise-2019-12-02/ExpressionVariable) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/ExpressionVariable) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/ExpressionVariable) # File The file in Amazon S3 where your data is saved. ## Contents ** bucket ** The name of the Amazon S3 bucket from which data is imported. Type: String Length Constraints: Minimum length of 3. Maximum length of 63. Required: Yes ** key ** The key of the Amazon S3 object that contains your data. Each object has a key that is a unique identifier. Each object has exactly one key. Type: String Required: Yes ** versionId ** The version ID to identify a specific version of the Amazon S3 object that contains your data. Type: String Required: No ## See Also 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/iotsitewise-2019-12-02/File) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/File) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/File) # FileFormat The file format of the data in S3. ## Contents ** csv ** The file is in .CSV format. Type: [Csv](API_Csv.md) object Required: No ** parquet ** The file is in parquet format. Type: [Parquet](API_Parquet.md) object Required: No ## See Also 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/iotsitewise-2019-12-02/FileFormat) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/FileFormat) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/FileFormat) # ForwardingConfig The forwarding configuration for a given property. ## Contents ** state ** The forwarding state for the given property. Type: String Valid Values: `DISABLED | ENABLED` Required: Yes ## See Also 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/iotsitewise-2019-12-02/ForwardingConfig) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/ForwardingConfig) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/ForwardingConfig) # GatewayCapabilitySummary Contains a summary of a gateway capability configuration. ## Contents ** capabilityNamespace ** The namespace of the capability configuration. For example, if you configure OPC UA sources for an MQTT-enabled gateway, your OPC-UA capability configuration has the namespace `iotsitewise:opcuacollector:3`. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Pattern: `^[a-zA-Z]+:[a-zA-Z]+:[0-9]+$` Required: Yes ** capabilitySyncStatus ** The synchronization status of the gateway capability configuration. The sync status can be one of the following: + `IN_SYNC` - The gateway is running with the latest configuration. + `OUT_OF_SYNC` - The gateway hasn't received the latest configuration. + `SYNC_FAILED` - The gateway rejected the latest configuration. + `UNKNOWN` - The gateway hasn't reported its sync status. + `NOT_APPLICABLE` - The gateway doesn't support this capability. This is most common when integrating partner data sources, because the data integration is handled externally by the partner. Type: String Valid Values: `IN_SYNC | OUT_OF_SYNC | SYNC_FAILED | UNKNOWN | NOT_APPLICABLE` Required: Yes ## See Also 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/iotsitewise-2019-12-02/GatewayCapabilitySummary) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/GatewayCapabilitySummary) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/GatewayCapabilitySummary) # GatewayPlatform The gateway's platform configuration. You can only specify one platform type in a gateway. (Legacy only) For Greengrass V1 gateways, specify the `greengrass` parameter with a valid Greengrass group ARN. For Greengrass V2 gateways, specify the `greengrassV2` parameter with a valid core device thing name. If creating a V3 gateway (`gatewayVersion=3`), you must also specify the `coreDeviceOperatingSystem`. For Siemens Industrial Edge gateways, specify the `siemensIE` parameter with a valid IoT Core thing name. ## Contents ** greengrass ** A gateway that runs on Amazon IoT Greengrass. Type: [Greengrass](API_Greengrass.md) object Required: No ** greengrassV2 ** A gateway that runs on Amazon IoT Greengrass V2. Type: [GreengrassV2](API_GreengrassV2.md) object Required: No ** siemensIE ** A SiteWise Edge gateway that runs on a Siemens Industrial Edge Device. Type: [SiemensIE](API_SiemensIE.md) object Required: No ## See Also 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/iotsitewise-2019-12-02/GatewayPlatform) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/GatewayPlatform) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/GatewayPlatform) # GatewaySummary Contains a summary of a gateway. ## Contents ** creationDate ** The date the gateway was created, in Unix epoch time. Type: Timestamp Required: Yes ** gatewayId ** The ID of the gateway device. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: Yes ** gatewayName ** The name of the gateway. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[^\u0000-\u001F\u007F]+` Required: Yes ** lastUpdateDate ** The date the gateway was last updated, in Unix epoch time. Type: Timestamp Required: Yes ** gatewayCapabilitySummaries ** A list of gateway capability summaries that each contain a namespace and status. Each gateway capability defines data sources for the gateway. To retrieve a capability configuration's definition, use [DescribeGatewayCapabilityConfiguration](https://docs.amazonaws.cn/iot-sitewise/latest/APIReference/API_DescribeGatewayCapabilityConfiguration.html). Type: Array of [GatewayCapabilitySummary](API_GatewayCapabilitySummary.md) objects Required: No ** gatewayPlatform ** The gateway's platform configuration. You can only specify one platform type in a gateway. (Legacy only) For Greengrass V1 gateways, specify the `greengrass` parameter with a valid Greengrass group ARN. For Greengrass V2 gateways, specify the `greengrassV2` parameter with a valid core device thing name. If creating a V3 gateway (`gatewayVersion=3`), you must also specify the `coreDeviceOperatingSystem`. For Siemens Industrial Edge gateways, specify the `siemensIE` parameter with a valid IoT Core thing name. Type: [GatewayPlatform](API_GatewayPlatform.md) object Required: No ** gatewayVersion ** The version of the gateway. A value of `3` indicates an MQTT-enabled, V3 gateway, while `2` indicates a Classic streams, V2 gateway. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `^[0-9]+$` Required: No ## See Also 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/iotsitewise-2019-12-02/GatewaySummary) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/GatewaySummary) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/GatewaySummary) # Greengrass Contains details for a gateway that runs on Amazon IoT Greengrass. To create a gateway that runs on Amazon IoT Greengrass, you must add the IoT SiteWise connector to a Greengrass group and deploy it. Your Greengrass group must also have permissions to upload data to Amazon IoT SiteWise. For more information, see [Ingesting data using a gateway](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/gateway-connector.html) in the * Amazon IoT SiteWise User Guide*. ## Contents ** groupArn ** The [ARN](https://docs.amazonaws.cn/general/latest/gr/aws-arns-and-namespaces.html) of the Greengrass group. For more information about how to find a group's ARN, see [ListGroups](https://docs.amazonaws.cn/greengrass/v1/apireference/listgroups-get.html) and [GetGroup](https://docs.amazonaws.cn/greengrass/v1/apireference/getgroup-get.html) in the * Amazon IoT Greengrass V1 API Reference*. Type: String Length Constraints: Minimum length of 1. Maximum length of 1600. Pattern: `^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$` Required: Yes ## See Also 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/iotsitewise-2019-12-02/Greengrass) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/Greengrass) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/Greengrass) # GreengrassV2 Contains details for a gateway that runs on Amazon IoT Greengrass V2. To create a gateway that runs on Amazon IoT Greengrass V2, you must deploy the IoT SiteWise Edge component to your gateway device. Your [Greengrass device role](https://docs.amazonaws.cn/greengrass/v2/developerguide/device-service-role.html) must use the `AWSIoTSiteWiseEdgeAccess` policy. For more information, see [Using Amazon IoT SiteWise at the edge](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/sw-gateways.html) in the * Amazon IoT SiteWise User Guide*. ## Contents ** coreDeviceThingName ** The name of the Amazon IoT thing for your Amazon IoT Greengrass V2 core device. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `^[a-zA-Z0-9:_-]+$` Required: Yes ** coreDeviceOperatingSystem ** The operating system of the core device in Amazon IoT Greengrass V2. Specifying the operating system is required for MQTT-enabled, V3 gateways (`gatewayVersion` `3`) and not applicable for Classic stream, V2 gateways (`gatewayVersion` `2`). Type: String Valid Values: `LINUX_AARCH64 | LINUX_AMD64 | WINDOWS_AMD64` Required: No ## See Also 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/iotsitewise-2019-12-02/GreengrassV2) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/GreengrassV2) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/GreengrassV2) # GroupIdentity Contains information for a group identity in an access policy. ## Contents ** id ** The IAM Identity Center ID of the group. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `\S+` Required: Yes ## See Also 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/iotsitewise-2019-12-02/GroupIdentity) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/GroupIdentity) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/GroupIdentity) # HierarchyMapping Maps a hierarchy from an interface asset model to a hierarchy in the asset model where the interface is applied. ## Contents ** assetModelHierarchyId ** The ID of the hierarchy in the asset model where the interface is applied. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: Yes ** interfaceAssetModelHierarchyId ** The ID of the hierarchy in the interface asset model. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: Yes ## See Also 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/iotsitewise-2019-12-02/HierarchyMapping) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/HierarchyMapping) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/HierarchyMapping) # IAMRoleIdentity Contains information about an Amazon Identity and Access Management role. For more information, see [IAM roles](https://docs.amazonaws.cn/IAM/latest/UserGuide/id_roles.html) in the *IAM User Guide*. ## Contents ** arn ** The ARN of the IAM role. For more information, see [IAM ARNs](https://docs.amazonaws.cn/IAM/latest/UserGuide/reference_identifiers.html) in the *IAM User Guide*. Type: String Length Constraints: Minimum length of 1. Maximum length of 1600. Pattern: `^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.\+=,@]+$` Required: Yes ## See Also 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/iotsitewise-2019-12-02/IAMRoleIdentity) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/IAMRoleIdentity) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/IAMRoleIdentity) # IAMUserIdentity Contains information about an Amazon Identity and Access Management user. ## Contents ** arn ** The ARN of the IAM user. For more information, see [IAM ARNs](https://docs.amazonaws.cn/IAM/latest/UserGuide/reference_identifiers.html) in the *IAM User Guide*. If you delete the IAM user, access policies that contain this identity include an empty `arn`. You can delete the access policy for the IAM user that no longer exists. Type: String Length Constraints: Minimum length of 1. Maximum length of 1600. Pattern: `^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.\+=,@]+$` Required: Yes ## See Also 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/iotsitewise-2019-12-02/IAMUserIdentity) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/IAMUserIdentity) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/IAMUserIdentity) # Identity Contains an identity that can access an Amazon IoT SiteWise Monitor resource. **Note** Currently, you can't use Amazon API operations to retrieve IAM Identity Center identity IDs. You can find the IAM Identity Center identity IDs in the URL of user and group pages in the [IAM Identity Center console](https://console.amazonaws.cn/singlesignon). ## Contents ** group ** An IAM Identity Center group identity. Type: [GroupIdentity](API_GroupIdentity.md) object Required: No ** iamRole ** An IAM role identity. Type: [IAMRoleIdentity](API_IAMRoleIdentity.md) object Required: No ** iamUser ** An IAM user identity. Type: [IAMUserIdentity](API_IAMUserIdentity.md) object Required: No ** user ** An IAM Identity Center user identity. Type: [UserIdentity](API_UserIdentity.md) object Required: No ## See Also 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/iotsitewise-2019-12-02/Identity) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/Identity) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/Identity) # Image Contains an image that is one of the following: + An image file. Choose this option to upload a new image. + The ID of an existing image. Choose this option to keep an existing image. ## Contents ** file ** Contains an image file. Type: [ImageFile](API_ImageFile.md) object Required: No ** id ** The ID of an existing image. Specify this parameter to keep an existing image. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: No ## See Also 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/iotsitewise-2019-12-02/Image) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/Image) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/Image) # ImageFile Contains an image file. ## Contents ** data ** The image file contents, represented as a base64-encoded string. The file size must be less than 1 MB. Type: Base64-encoded binary data object Length Constraints: Minimum length of 1. Maximum length of 1500000. Required: Yes ** type ** The file type of the image. Type: String Valid Values: `PNG` Required: Yes ## See Also 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/iotsitewise-2019-12-02/ImageFile) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/ImageFile) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/ImageFile) # ImageLocation Contains an image that is uploaded to Amazon IoT SiteWise and available at a URL. ## Contents ** id ** The ID of the image. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: Yes ** url ** The URL where the image is available. The URL is valid for 15 minutes so that you can view and download the image Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `^(http|https)\://\S+` Required: Yes ## See Also 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/iotsitewise-2019-12-02/ImageLocation) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/ImageLocation) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/ImageLocation) # InterfaceRelationship Contains information about the relationship between an asset model and an interface asset model that is applied to it. ## Contents ** id ** The ID of the asset model that has the interface applied to it. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: Yes ## See Also 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/iotsitewise-2019-12-02/InterfaceRelationship) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/InterfaceRelationship) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/InterfaceRelationship) # InterfaceRelationshipSummary Contains summary information about an interface relationship, which defines how an interface is applied to an asset model. This summary provides the essential identifiers needed to retrieve detailed information about the relationship. ## Contents ** id ** The ID of the asset model that has the interface applied to it. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: Yes ## See Also 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/iotsitewise-2019-12-02/InterfaceRelationshipSummary) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/InterfaceRelationshipSummary) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/InterfaceRelationshipSummary) # InterfaceSummary Contains summary information about an interface that a property belongs to. ## Contents ** interfaceAssetModelId ** The ID of the interface asset model that contains this property. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: Yes ** interfaceAssetModelPropertyId ** The ID of the property in the interface asset model that corresponds to this property. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: Yes ## See Also 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/iotsitewise-2019-12-02/InterfaceSummary) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/InterfaceSummary) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/InterfaceSummary) # InterpolatedAssetPropertyValue Contains information about an interpolated asset property value. ## Contents ** timestamp ** Contains a timestamp with optional nanosecond granularity. Type: [TimeInNanos](API_TimeInNanos.md) object Required: Yes ** value ** Contains an asset property value (of a single type only). Type: [Variant](API_Variant.md) object Required: Yes ## See Also 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/iotsitewise-2019-12-02/InterpolatedAssetPropertyValue) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/InterpolatedAssetPropertyValue) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/InterpolatedAssetPropertyValue) # InvocationOutput This contains the SiteWise Assistant's response and the corresponding citation. ## Contents ** citations ** A list of citations, and related information for the SiteWise Assistant's response. Type: Array of [Citation](API_Citation.md) objects Required: No ** message ** The text message of the SiteWise Assistant's response. Type: String Required: No ## See Also 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/iotsitewise-2019-12-02/InvocationOutput) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/InvocationOutput) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/InvocationOutput) # JobConfiguration Contains the configuration information of a job, such as the file format used to save data in Amazon S3. ## Contents ** fileFormat ** The file format of the data in S3. Type: [FileFormat](API_FileFormat.md) object Required: Yes ## See Also 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/iotsitewise-2019-12-02/JobConfiguration) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/JobConfiguration) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/JobConfiguration) # JobSummary Contains the job summary information. ## Contents ** id ** The ID of the job. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: Yes ** name ** The unique name that helps identify the job request. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[^\u0000-\u001F\u007F]+` Required: Yes ** status ** The status of the bulk import job can be one of following values: + `PENDING` – Amazon IoT SiteWise is waiting for the current bulk import job to finish. + `CANCELLED` – The bulk import job has been canceled. + `RUNNING` – Amazon IoT SiteWise is processing your request to import your data from Amazon S3. + `COMPLETED` – Amazon IoT SiteWise successfully completed your request to import data from Amazon S3. + `FAILED` – Amazon IoT SiteWise couldn't process your request to import data from Amazon S3. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues. + `COMPLETED_WITH_FAILURES` – Amazon IoT SiteWise completed your request to import data from Amazon S3 with errors. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues. Type: String Valid Values: `PENDING | CANCELLED | RUNNING | COMPLETED | FAILED | COMPLETED_WITH_FAILURES` Required: Yes ## See Also 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/iotsitewise-2019-12-02/JobSummary) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/JobSummary) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/JobSummary) # KendraSourceDetail The source details for the Kendra dataset source. ## Contents ** knowledgeBaseArn ** The `knowledgeBaseArn` details for the Kendra dataset source. Type: String Length Constraints: Minimum length of 1. Maximum length of 1600. Pattern: `^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$` Required: Yes ** roleArn ** The `roleARN` details for the Kendra dataset source. Type: String Length Constraints: Minimum length of 1. Maximum length of 1600. Pattern: `^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$` Required: Yes ## See Also 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/iotsitewise-2019-12-02/KendraSourceDetail) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/KendraSourceDetail) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/KendraSourceDetail) # Location Contains location information about the cited text and where it's stored. ## Contents ** uri ** The URI of the location. Type: String Required: No ## See Also 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/iotsitewise-2019-12-02/Location) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/Location) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/Location) # LoggingOptions Contains logging options. ## Contents ** level ** The Amazon IoT SiteWise logging verbosity level. Type: String Valid Values: `ERROR | INFO | OFF` Required: Yes ## See Also 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/iotsitewise-2019-12-02/LoggingOptions) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/LoggingOptions) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/LoggingOptions) # MatchedDataBinding Represents a data binding that matches the specified filter criteria. ## Contents ** value ** The value of the matched data binding. Type: [DataBindingValue](API_DataBindingValue.md) object Required: Yes ## See Also 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/iotsitewise-2019-12-02/MatchedDataBinding) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/MatchedDataBinding) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/MatchedDataBinding) # Measurement Contains an asset measurement property. For more information, see [Measurements](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/asset-properties.html#measurements) in the * Amazon IoT SiteWise User Guide*. ## Contents ** processingConfig ** The processing configuration for the given measurement property. You can configure measurements to be kept at the edge or forwarded to the Amazon Cloud. By default, measurements are forwarded to the cloud. Type: [MeasurementProcessingConfig](API_MeasurementProcessingConfig.md) object Required: No ## See Also 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/iotsitewise-2019-12-02/Measurement) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/Measurement) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/Measurement) # MeasurementProcessingConfig The processing configuration for the given measurement property. You can configure measurements to be kept at the edge or forwarded to the Amazon Cloud. By default, measurements are forwarded to the cloud. ## Contents ** forwardingConfig ** The forwarding configuration for the given measurement property. Type: [ForwardingConfig](API_ForwardingConfig.md) object Required: Yes ## See Also 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/iotsitewise-2019-12-02/MeasurementProcessingConfig) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/MeasurementProcessingConfig) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/MeasurementProcessingConfig) # Metric Contains an asset metric property. With metrics, you can calculate aggregate functions, such as an average, maximum, or minimum, as specified through an expression. A metric maps several values to a single value (such as a sum). The maximum number of dependent/cascading variables used in any one metric calculation is 10. Therefore, a *root* metric can have up to 10 cascading metrics in its computational dependency tree. Additionally, a metric can only have a data type of `DOUBLE` and consume properties with data types of `INTEGER` or `DOUBLE`. For more information, see [Metrics](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/asset-properties.html#metrics) in the * Amazon IoT SiteWise User Guide*. ## Contents ** window ** The window (time interval) over which Amazon IoT SiteWise computes the metric's aggregation expression. Amazon IoT SiteWise computes one data point per `window`. Type: [MetricWindow](API_MetricWindow.md) object Required: Yes ** expression ** The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression. For more information, see [Quotas](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/quotas.html) in the * Amazon IoT SiteWise User Guide*. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Required: No ** processingConfig ** The processing configuration for the given metric property. You can configure metrics to be computed at the edge or in the Amazon Cloud. By default, metrics are forwarded to the cloud. Type: [MetricProcessingConfig](API_MetricProcessingConfig.md) object Required: No ** variables ** The list of variables used in the expression. Type: Array of [ExpressionVariable](API_ExpressionVariable.md) objects Required: No ## See Also 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/iotsitewise-2019-12-02/Metric) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/Metric) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/Metric) # MetricProcessingConfig The processing configuration for the given metric property. You can configure metrics to be computed at the edge or in the Amazon Cloud. By default, metrics are forwarded to the cloud. ## Contents ** computeLocation ** The compute location for the given metric property. Type: String Valid Values: `EDGE | CLOUD` Required: Yes ## See Also 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/iotsitewise-2019-12-02/MetricProcessingConfig) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/MetricProcessingConfig) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/MetricProcessingConfig) # MetricWindow Contains a time interval window used for data aggregate computations (for example, average, sum, count, and so on). ## Contents ** tumbling ** The tumbling time interval window. Type: [TumblingWindow](API_TumblingWindow.md) object Required: No ## See Also 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/iotsitewise-2019-12-02/MetricWindow) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/MetricWindow) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/MetricWindow) # MonitorErrorDetails Contains Amazon IoT SiteWise Monitor error details. ## Contents ** code ** The error code. Type: String Valid Values: `INTERNAL_FAILURE | VALIDATION_ERROR | LIMIT_EXCEEDED` Required: No ** message ** The error message. Type: String Required: No ## See Also 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/iotsitewise-2019-12-02/MonitorErrorDetails) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/MonitorErrorDetails) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/MonitorErrorDetails) # MultiLayerStorage Contains information about the storage destination. ## Contents ** customerManagedS3Storage ** Contains information about a customer managed Amazon S3 bucket. Type: [CustomerManagedS3Storage](API_CustomerManagedS3Storage.md) object Required: Yes ## See Also 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/iotsitewise-2019-12-02/MultiLayerStorage) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/MultiLayerStorage) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/MultiLayerStorage) # Parquet A parquet file. ## Contents The members of this exception structure are context-dependent. ## See Also 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/iotsitewise-2019-12-02/Parquet) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/Parquet) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/Parquet) # PortalResource Identifies an Amazon IoT SiteWise Monitor portal. ## Contents ** id ** The ID of the portal. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: Yes ## See Also 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/iotsitewise-2019-12-02/PortalResource) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/PortalResource) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/PortalResource) # PortalStatus Contains information about the current status of a portal. ## Contents ** state ** The current state of the portal. Type: String Valid Values: `CREATING | PENDING | UPDATING | DELETING | ACTIVE | FAILED` Required: Yes ** error ** Contains associated error information, if any. Type: [MonitorErrorDetails](API_MonitorErrorDetails.md) object Required: No ## See Also 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/iotsitewise-2019-12-02/PortalStatus) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/PortalStatus) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/PortalStatus) # PortalSummary Contains a portal summary. ## Contents ** id ** The ID of the portal. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: Yes ** name ** The name of the portal. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[^\u0000-\u001F\u007F]+` Required: Yes ** startUrl ** The URL for the Amazon IoT SiteWise Monitor portal. You can use this URL to access portals that use IAM Identity Center for authentication. For portals that use IAM for authentication, you must use the Amazon IoT SiteWise console to get a URL that you can use to access the portal. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `^(http|https)\://\S+` Required: Yes ** status ** Contains information about the current status of a portal. Type: [PortalStatus](API_PortalStatus.md) object Required: Yes ** creationDate ** The date the portal was created, in Unix epoch time. Type: Timestamp Required: No ** description ** The portal's description. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `[^\u0000-\u001F\u007F]+` Required: No ** lastUpdateDate ** The date the portal was last updated, in Unix epoch time. Type: Timestamp Required: No ** portalType ** Define the type of portal. The value for Amazon IoT SiteWise Monitor (Classic) is `SITEWISE_PORTAL_V1`. The value for Amazon IoT SiteWise Monitor (AI-aware) is `SITEWISE_PORTAL_V2`. Type: String Valid Values: `SITEWISE_PORTAL_V1 | SITEWISE_PORTAL_V2` Required: No ** roleArn ** The [ARN](https://docs.amazonaws.cn/general/latest/gr/aws-arns-and-namespaces.html) of the service role that allows the portal's users to access your Amazon IoT SiteWise resources on your behalf. For more information, see [Using service roles for Amazon IoT SiteWise Monitor](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/monitor-service-role.html) in the * Amazon IoT SiteWise User Guide*. Type: String Length Constraints: Minimum length of 1. Maximum length of 1600. Pattern: `^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.\+=,@]+$` Required: No ## See Also 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/iotsitewise-2019-12-02/PortalSummary) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/PortalSummary) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/PortalSummary) # PortalTypeEntry The configuration entry associated with the specific portal type. The `portalTypeConfiguration` is a map of the `portalTypeKey` to the `PortalTypeEntry`. ## Contents ** portalTools ** The array of tools associated with the specified portal type. The possible values are `ASSISTANT` and `DASHBOARD`. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[^\u0000-\u001F\u007F]+` Required: No ## See Also 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/iotsitewise-2019-12-02/PortalTypeEntry) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/PortalTypeEntry) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/PortalTypeEntry) # ProjectResource Identifies a specific Amazon IoT SiteWise Monitor project. ## Contents ** id ** The ID of the project. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: Yes ## See Also 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/iotsitewise-2019-12-02/ProjectResource) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/ProjectResource) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/ProjectResource) # ProjectSummary Contains project summary information. ## Contents ** id ** The ID of the project. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: Yes ** name ** The name of the project. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[^\u0000-\u001F\u007F]+` Required: Yes ** creationDate ** The date the project was created, in Unix epoch time. Type: Timestamp Required: No ** description ** The project's description. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `[^\u0000-\u001F\u007F]+` Required: No ** lastUpdateDate ** The date the project was last updated, in Unix epoch time. Type: Timestamp Required: No ## See Also 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/iotsitewise-2019-12-02/ProjectSummary) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/ProjectSummary) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/ProjectSummary) # Property Contains asset property information. ## Contents ** dataType ** The property data type. Type: String Valid Values: `STRING | INTEGER | DOUBLE | BOOLEAN | STRUCT` Required: Yes ** id ** The ID of the asset property. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: Yes ** name ** The name of the property. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[^\u0000-\u001F\u007F]+` Required: Yes ** alias ** The alias that identifies the property, such as an OPC-UA server data stream path (for example, `/company/windfarm/3/turbine/7/temperature`). For more information, see [Mapping industrial data streams to asset properties](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/connect-data-streams.html) in the * Amazon IoT SiteWise User Guide*. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: `[^\u0000-\u001F\u007F]+` Required: No ** externalId ** The external ID of the asset property. For more information, see [Using external IDs](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/object-ids.html#external-ids) in the * Amazon IoT SiteWise User Guide*. Type: String Length Constraints: Minimum length of 2. Maximum length of 128. Pattern: `[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+` Required: No ** notification ** The asset property's notification topic and state. For more information, see [UpdateAssetProperty](https://docs.amazonaws.cn/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html). Type: [PropertyNotification](API_PropertyNotification.md) object Required: No ** path ** The structured path to the property from the root of the asset. Type: Array of [AssetPropertyPathSegment](API_AssetPropertyPathSegment.md) objects Required: No ** type ** The property type (see `PropertyType`). A property contains one type. Type: [PropertyType](API_PropertyType.md) object Required: No ** unit ** The unit (such as `Newtons` or `RPM`) of the asset property. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[^\u0000-\u001F\u007F]+` Required: No ## See Also 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/iotsitewise-2019-12-02/Property) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/Property) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/Property) # PropertyMapping Maps a property from an interface asset model to a property in the asset model where the interface is applied. ## Contents ** assetModelPropertyId ** The ID of the property in the asset model where the interface is applied. Type: String Length Constraints: Minimum length of 13. Maximum length of 139. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+` Required: Yes ** interfaceAssetModelPropertyId ** The ID of the property in the interface asset model. Type: String Length Constraints: Minimum length of 13. Maximum length of 139. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+` Required: Yes ## See Also 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/iotsitewise-2019-12-02/PropertyMapping) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/PropertyMapping) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/PropertyMapping) # PropertyMappingConfiguration Contains configuration options for mapping properties from an interface asset model to an asset model where the interface is applied. ## Contents ** createMissingProperty ** If true, missing properties from the interface asset model are automatically created in the asset model where the interface is applied. Type: Boolean Required: No ** matchByPropertyName ** If true, properties are matched by name between the interface asset model and the asset model where the interface is applied. Type: Boolean Required: No ** overrides ** A list of specific property mappings that override the automatic mapping by name when an interface is applied to an asset model. Type: Array of [PropertyMapping](API_PropertyMapping.md) objects Required: No ## See Also 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/iotsitewise-2019-12-02/PropertyMappingConfiguration) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/PropertyMappingConfiguration) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/PropertyMappingConfiguration) # PropertyNotification Contains asset property value notification information. When the notification state is enabled, Amazon IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see [Interacting with other services](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/interact-with-other-services.html) in the * Amazon IoT SiteWise User Guide*. ## Contents ** state ** The current notification state. Type: String Valid Values: `ENABLED | DISABLED` Required: Yes ** topic ** The MQTT topic to which Amazon IoT SiteWise publishes property value update notifications. Type: String Required: Yes ## See Also 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/iotsitewise-2019-12-02/PropertyNotification) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/PropertyNotification) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/PropertyNotification) # PropertyType Contains a property type, which can be one of `attribute`, `measurement`, `metric`, or `transform`. ## Contents ** attribute ** Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an [IIoT](https://en.wikipedia.org/wiki/Internet_of_things#Industrial_applications) wind turbine. Type: [Attribute](API_Attribute.md) object Required: No ** measurement ** Specifies an asset measurement property. A measurement represents a device's raw sensor data stream, such as timestamped temperature values or timestamped power values. Type: [Measurement](API_Measurement.md) object Required: No ** metric ** Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature. Type: [Metric](API_Metric.md) object Required: No ** transform ** Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit. Type: [Transform](API_Transform.md) object Required: No ## See Also 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/iotsitewise-2019-12-02/PropertyType) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/PropertyType) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/PropertyType) # PropertyValueNullValue The value type of null asset property data with BAD and UNCERTAIN qualities. ## Contents ** valueType ** The type of null asset property data. Type: String Valid Values: `D | B | S | I | U` Required: Yes ## See Also 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/iotsitewise-2019-12-02/PropertyValueNullValue) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/PropertyValueNullValue) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/PropertyValueNullValue) # PutAssetPropertyValueEntry Contains a list of value updates for an asset property in the list of asset entries consumed by the [BatchPutAssetPropertyValue](https://docs.amazonaws.cn/iot-sitewise/latest/APIReference/API_BatchPutAssetPropertyValue.html) API operation. ## Contents ** entryId ** The user specified ID for the entry. You can use this ID to identify which entries failed. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** propertyValues ** The list of property values to upload. You can specify up to 10 `propertyValues` array elements. Type: Array of [AssetPropertyValue](API_AssetPropertyValue.md) objects Required: Yes ** assetId ** The ID of the asset to update. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: No ** propertyAlias ** The alias that identifies the property, such as an OPC-UA server data stream path (for example, `/company/windfarm/3/turbine/7/temperature`). For more information, see [Mapping industrial data streams to asset properties](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/connect-data-streams.html) in the * Amazon IoT SiteWise User Guide*. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: `[^\u0000-\u001F\u007F]+` Required: No ** propertyId ** The ID of the asset property for this entry. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: No ## See Also 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/iotsitewise-2019-12-02/PutAssetPropertyValueEntry) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/PutAssetPropertyValueEntry) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/PutAssetPropertyValueEntry) # Reference Contains the reference information. ## Contents ** dataset ** Contains the dataset reference information. Type: [DataSetReference](API_DataSetReference.md) object Required: No ## See Also 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/iotsitewise-2019-12-02/Reference) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/Reference) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/Reference) # ResolveTo The detailed resource this execution summary resolves to. ## Contents ** assetId ** The ID of the asset that the resource resolves to. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: Yes ## See Also 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/iotsitewise-2019-12-02/ResolveTo) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/ResolveTo) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/ResolveTo) # Resource Contains an Amazon IoT SiteWise Monitor resource ID for a portal or project. ## Contents ** portal ** A portal resource. Type: [PortalResource](API_PortalResource.md) object Required: No ** project ** A project resource. Type: [ProjectResource](API_ProjectResource.md) object Required: No ## See Also 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/iotsitewise-2019-12-02/Resource) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/Resource) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/Resource) # ResponseStream Contains the response, citation, and trace from the SiteWise Assistant. ## Contents ** accessDeniedException ** Access is denied. Type: Exception HTTP Status Code: 403 Required: No ** conflictingOperationException ** Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time. Type: Exception HTTP Status Code: 409 Required: No ** internalFailureException ** Amazon IoT SiteWise can't process your request right now. Try again later. Type: Exception HTTP Status Code: 500 Required: No ** invalidRequestException ** The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again. Type: Exception HTTP Status Code: 400 Required: No ** limitExceededException ** You've reached the quota for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model. For more information, see [Quotas](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/quotas.html) in the * Amazon IoT SiteWise User Guide*. Type: Exception HTTP Status Code: 410 Required: No ** output ** Contains the SiteWise Assistant's response. Type: [InvocationOutput](API_InvocationOutput.md) object Required: No ** resourceNotFoundException ** The requested resource can't be found. Type: Exception HTTP Status Code: 404 Required: No ** throttlingException ** Your request exceeded a rate limit. For example, you might have exceeded the number of Amazon IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on. For more information, see [Quotas](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/quotas.html) in the * Amazon IoT SiteWise User Guide*. Type: Exception HTTP Status Code: 429 Required: No ** trace ** Contains tracing information of the SiteWise Assistant's reasoning and data access. Type: [Trace](API_Trace.md) object Required: No ## See Also 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/iotsitewise-2019-12-02/ResponseStream) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/ResponseStream) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/ResponseStream) # RetentionPeriod The number of days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier. ## Contents ** numberOfDays ** The number of days that your data is kept. If you specified a value for this parameter, the `unlimited` parameter must be `false`. Type: Integer Required: No ** unlimited ** If true, your data is kept indefinitely. If configured to `true`, you must not specify a value for the `numberOfDays` parameter. Type: Boolean Required: No ## See Also 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/iotsitewise-2019-12-02/RetentionPeriod) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/RetentionPeriod) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/RetentionPeriod) # Row Represents a single row in the query results. ## Contents ** data ** List of data points in a single row of the result set. Type: Array of [Datum](API_Datum.md) objects Required: Yes ## See Also 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/iotsitewise-2019-12-02/Row) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/Row) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/Row) # SiemensIE Contains details for a SiteWise Edge gateway that runs on a Siemens Industrial Edge Device. ## Contents ** iotCoreThingName ** The name of the Amazon IoT Thing for your SiteWise Edge gateway. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `^[a-zA-Z0-9:_-]+$` Required: Yes ## See Also 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/iotsitewise-2019-12-02/SiemensIE) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/SiemensIE) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/SiemensIE) # Source The data source for the dataset. ## Contents ** arn ** Contains the ARN of the dataset. If the source is Kendra, it's the ARN of the Kendra index. Type: String Required: No ** location ** Contains the location information where the cited text is originally stored. For example, if the data source is Kendra, and the text synchronized is from an S3 bucket, then the location refers to an S3 object. Type: [Location](API_Location.md) object Required: No ## See Also 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/iotsitewise-2019-12-02/Source) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/Source) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/Source) # SourceDetail The details of the dataset source associated with the dataset. ## Contents ** kendra ** Contains details about the Kendra dataset source. Type: [KendraSourceDetail](API_KendraSourceDetail.md) object Required: No ## See Also 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/iotsitewise-2019-12-02/SourceDetail) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/SourceDetail) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/SourceDetail) # TargetResource The resource the action will be taken on. This can include asset-based resources and computation model resources. ## Contents ** assetId ** The ID of the asset, in UUID format. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: No ** computationModelId ** The ID of the computation model. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: No ## See Also 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/iotsitewise-2019-12-02/TargetResource) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/TargetResource) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/TargetResource) # TimeInNanos Contains a timestamp with optional nanosecond granularity. ## Contents ** timeInSeconds ** The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by `offsetInNanos`. Type: Long Valid Range: Minimum value of 1. Maximum value of 9223372036854774. Required: Yes ** offsetInNanos ** The nanosecond offset from `timeInSeconds`. Type: Integer Valid Range: Minimum value of 0. Maximum value of 999999999. Required: No ## See Also 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/iotsitewise-2019-12-02/TimeInNanos) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/TimeInNanos) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/TimeInNanos) # TimeSeriesSummary Contains a summary of a time series (data stream). ## Contents ** dataType ** The data type of the time series. If you specify `STRUCT`, you must also specify `dataTypeSpec` to identify the type of the structure for this time series. Type: String Valid Values: `STRING | INTEGER | DOUBLE | BOOLEAN | STRUCT` Required: Yes ** timeSeriesArn ** The [ARN](https://docs.amazonaws.cn/general/latest/gr/aws-arns-and-namespaces.html) of the time series, which has the following format. `arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId}` Type: String Length Constraints: Minimum length of 1. Maximum length of 1600. Pattern: `^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$` Required: Yes ** timeSeriesCreationDate ** The date that the time series was created, in Unix epoch time. Type: Timestamp Required: Yes ** timeSeriesId ** The ID of the time series. Type: String Length Constraints: Minimum length of 36. Maximum length of 73. Required: Yes ** timeSeriesLastUpdateDate ** The date that the time series was last updated, in Unix epoch time. Type: Timestamp Required: Yes ** alias ** The alias that identifies the time series. Type: String Length Constraints: Minimum length of 1. Pattern: `[^\u0000-\u001F\u007F]+` Required: No ** assetId ** The ID of the asset in which the asset property was created. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: No ** dataTypeSpec ** The data type of the structure for this time series. This parameter is required for time series that have the `STRUCT` data type. The options for this parameter depend on the type of the composite model in which you created the asset property that is associated with your time series. Use `AWS/ALARM_STATE` for alarm state in alarm composite models. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[^\u0000-\u001F\u007F]+` Required: No ** propertyId ** The ID of the asset property, in UUID format. Type: String Length Constraints: Fixed length of 36. Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` Required: No ## See Also 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/iotsitewise-2019-12-02/TimeSeriesSummary) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/TimeSeriesSummary) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/TimeSeriesSummary) # Trace Contains tracing information of the SiteWise Assistant's reasoning and data access. ## Contents ** text ** The cited text from the data source. Type: String Required: No ## See Also 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/iotsitewise-2019-12-02/Trace) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/Trace) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/Trace) # Transform Contains an asset transform property. A transform is a one-to-one mapping of a property's data points from one form to another. For example, you can use a transform to convert a Celsius data stream to Fahrenheit by applying the transformation expression to each data point of the Celsius stream. A transform can only have a data type of `DOUBLE` and consume properties with data types of `INTEGER` or `DOUBLE`. For more information, see [Transforms](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/asset-properties.html#transforms) in the * Amazon IoT SiteWise User Guide*. ## Contents ** expression ** The mathematical expression that defines the transformation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression. For more information, see [Quotas](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/quotas.html) in the * Amazon IoT SiteWise User Guide*. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Required: Yes ** variables ** The list of variables used in the expression. Type: Array of [ExpressionVariable](API_ExpressionVariable.md) objects Required: Yes ** processingConfig ** The processing configuration for the given transform property. You can configure transforms to be kept at the edge or forwarded to the Amazon Cloud. You can also configure transforms to be computed at the edge or in the cloud. Type: [TransformProcessingConfig](API_TransformProcessingConfig.md) object Required: No ## See Also 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/iotsitewise-2019-12-02/Transform) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/Transform) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/Transform) # TransformProcessingConfig The processing configuration for the given transform property. You can configure transforms to be kept at the edge or forwarded to the Amazon Cloud. You can also configure transforms to be computed at the edge or in the cloud. ## Contents ** computeLocation ** The compute location for the given transform property. Type: String Valid Values: `EDGE | CLOUD` Required: Yes ** forwardingConfig ** The forwarding configuration for a given property. Type: [ForwardingConfig](API_ForwardingConfig.md) object Required: No ## See Also 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/iotsitewise-2019-12-02/TransformProcessingConfig) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/TransformProcessingConfig) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/TransformProcessingConfig) # TumblingWindow Contains a tumbling window, which is a repeating fixed-sized, non-overlapping, and contiguous time window. You can use this window in metrics to aggregate data from properties and other assets. You can use `m`, `h`, `d`, and `w` when you specify an interval or offset. Note that `m` represents minutes, `h` represents hours, `d` represents days, and `w` represents weeks. You can also use `s` to represent seconds in `offset`. The `interval` and `offset` parameters support the [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601). For example, `PT5S` represents 5 seconds, `PT5M` represents 5 minutes, and `PT5H` represents 5 hours. ## Contents ** interval ** The time interval for the tumbling window. The interval time must be between 1 minute and 1 week. Amazon IoT SiteWise computes the `1w` interval the end of Sunday at midnight each week (UTC), the `1d` interval at the end of each day at midnight (UTC), the `1h` interval at the end of each hour, and so on. When Amazon IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. Amazon IoT SiteWise places the computed data point at the end of the interval. Type: String Length Constraints: Minimum length of 2. Maximum length of 23. Required: Yes ** offset ** The offset for the tumbling window. The `offset` parameter accepts the following: + The offset time. For example, if you specify `18h` for `offset` and `1d` for `interval`, Amazon IoT SiteWise aggregates data in one of the following ways: + If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric. + If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day. + The ISO 8601 format. For example, if you specify `PT18H` for `offset` and `1d` for `interval`, Amazon IoT SiteWise aggregates data in one of the following ways: + If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric. + If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day. + The 24-hour clock. For example, if you specify `00:03:00` for `offset`, `5m` for `interval`, and you create the metric at 2 PM (UTC), you get the first aggregation result at 2:03 PM (UTC). You get the second aggregation result at 2:08 PM (UTC). + The offset time zone. For example, if you specify `2021-07-23T18:00-08` for `offset` and `1d` for `interval`, Amazon IoT SiteWise aggregates data in one of the following ways: + If you create the metric before or at 6 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric. + If you create the metric after 6 PM (PST), you get the first aggregation result at 6 PM (PST) the next day. Type: String Length Constraints: Minimum length of 2. Maximum length of 25. Required: No ## See Also 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/iotsitewise-2019-12-02/TumblingWindow) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/TumblingWindow) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/TumblingWindow) # UserIdentity Contains information for a user identity in an access policy. ## Contents ** id ** The IAM Identity Center ID of the user. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `\S+` Required: Yes ## See Also 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/iotsitewise-2019-12-02/UserIdentity) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/UserIdentity) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/UserIdentity) # VariableValue Identifies a property value used in an expression. ## Contents ** hierarchyId ** The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID. If the hierarchy has an external ID, you can specify `externalId:` followed by the external ID. For more information, see [Using external IDs](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/object-ids.html#external-ids) in the * Amazon IoT SiteWise User Guide*. You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same `propertyId`. For example, you might have separately grouped assets that come from the same asset model. For more information, see [Asset hierarchies](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/asset-hierarchies.html) in the * Amazon IoT SiteWise User Guide*. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[^\u0000-\u001F\u007F]+` Required: No ** propertyId ** The ID of the property to use as the variable. You can use the property `name` if it's from the same asset model. If the property has an external ID, you can specify `externalId:` followed by the external ID. For more information, see [Using external IDs](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/object-ids.html#external-ids) in the * Amazon IoT SiteWise User Guide*. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[^\u0000-\u001F\u007F]+` Required: No ** propertyPath ** The path of the property. Type: Array of [AssetModelPropertyPathSegment](API_AssetModelPropertyPathSegment.md) objects Required: No ## See Also 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/iotsitewise-2019-12-02/VariableValue) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/VariableValue) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/VariableValue) # Variant Contains an asset property value (of a single type only). ## Contents ** booleanValue ** Asset property data of type Boolean (true or false). Type: Boolean Required: No ** doubleValue ** Asset property data of type double (floating point number). The min value is -10^10. The max value is 10^10. Double.NaN is allowed. Type: Double Required: No ** integerValue ** Asset property data of type integer (whole number). Type: Integer Required: No ** nullValue ** The type of null asset property data with BAD and UNCERTAIN qualities. Type: [PropertyValueNullValue](API_PropertyValueNullValue.md) object Required: No ** stringValue ** Asset property data of type string (sequence of characters). The allowed pattern: "^\$1\$1[^\$1u0000-\$1u001F\$1u007F]\$1". The max length is 1024. Type: String Required: No ## See Also 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/iotsitewise-2019-12-02/Variant) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/Variant) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/Variant) # WarmTierRetentionPeriod Set this period to specify how long your data is stored in the warm tier before it is deleted. You can set this only if cold tier is enabled. ## Contents ** numberOfDays ** The number of days the data is stored in the warm tier. Type: Integer Required: No ** unlimited ** If set to true, the data is stored indefinitely in the warm tier. Type: Boolean Required: No ## See Also 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/iotsitewise-2019-12-02/WarmTierRetentionPeriod) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iotsitewise-2019-12-02/WarmTierRetentionPeriod) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iotsitewise-2019-12-02/WarmTierRetentionPeriod)