View a markdown version of this page

SystemSummary - Next generation Resilience Hub

SystemSummary

Contains summary information about a system.

Contents

name

Resource name (used in ARN — no spaces allowed).

Type: String

Length Constraints: Minimum length of 2. Maximum length of 60.

Pattern: [A-Za-z0-9][A-Za-z0-9_\-]{1,59}

Required: Yes

systemId

System ID for cross-account use without exposing account structure.

Type: String

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

Pattern: \S{1,255}

Required: Yes

createdAt

The timestamp when the system was created.

Type: Timestamp

Required: No

organizationId

Displayed only if caller has access.

Type: String

Length Constraints: Minimum length of 12. Maximum length of 34.

Pattern: o-[a-z0-9]{10,32}

Required: No

ouId

Displayed only if caller has access.

Type: String

Length Constraints: Minimum length of 16. Maximum length of 68.

Pattern: ou-[a-z0-9]{4,32}-[a-z0-9]{8,32}

Required: No

servicesCount

The number of services in the system.

Type: Integer

Required: No

systemArn

ARN identifier.

Type: String

Length Constraints: Minimum length of 31.

Pattern: arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+.-]{0,1023}

Required: No

updatedAt

The timestamp when the system was last updated.

Type: Timestamp

Required: No

userJourneysCount

The number of user journeys in the system.

Type: Integer

Required: No

See Also

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