PropertySummary - Amazon IoT TwinMaker
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

PropertySummary

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

Contents

propertyName

This is the name of the property.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [a-zA-Z_\-0-9]+

Required: Yes

areAllPropertyValuesReturned

This flag notes whether all values of a list or map type property are returned in the API response. The maximum number of values per property returned is 50.

Type: Boolean

Required: No

definition

This is the schema for the property.

Type: PropertyDefinitionResponse object

Required: No

value

This is the value for the property.

Type: DataValue object

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: