ComponentResponse - AWS IoT TwinMaker

ComponentResponse

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

Contents

areAllCompositeComponentsReturned

This flag notes whether all compositeComponents are returned in the API response.

Type: Boolean

Required: No

areAllPropertiesReturned

This flag notes whether all properties of the component are returned in the API response. The maximum number of properties returned is 800.

Type: Boolean

Required: No

componentName

The name of the component.

Type: String

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

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

Required: No

componentTypeId

The ID of the component type.

Type: String

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

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

Required: No

compositeComponents

This lists objects that contain information about the compositeComponents.

Type: String to ComponentSummary object map

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

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

Required: No

definedIn

The name of the property definition set in the request.

Type: String

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

Pattern: .*

Required: No

description

The description of the component type.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

Required: No

properties

An object that maps strings to the properties to set in the component type. Each string in the mapping must be unique to this object.

Type: String to PropertyResponse object map

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

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

Required: No

propertyGroups

The property groups.

Type: String to ComponentPropertyGroupResponse object map

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

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

Required: No

status

The status of the component type.

Type: Status object

Required: No

syncSource

The syncSource of the sync job, if this entity was created by a sync job.

Type: String

Pattern: [a-zA-Z_0-9]+

Required: No

See Also

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