ComponentSummary - AWS IoT TwinMaker

ComponentSummary

An object that returns information about a component summary.

Contents

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: Yes

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: Yes

status

The status of the component type.

Type: Status object

Required: Yes

componentPath

This string specifies the path to the composite component, starting from the top-level component.

Type: String

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

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

Required: No

definedIn

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 request.

Type: String

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

Pattern: .*

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

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: