View a markdown version of this page

ServiceSummary - Next generation Resilience Hub

ServiceSummary

Contains summary information about a service.

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

serviceArn

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

accountId

Displayed only if caller has access.

Type: String

Length Constraints: Fixed length of 12.

Pattern: [0-9]{12}

Required: No

achievability

The achievability status of the service's resilience targets.

Type: Achievability object

Required: No

assessmentStatus

The current assessment status of the service.

Type: String

Valid Values: NOT_STARTED | PENDING | IN_PROGRESS | FAILED | SUCCESS

Required: No

associatedSystems

The systems associated with the service.

Type: Array of AssociatedSystem objects

Array Members: Minimum number of 0 items. Maximum number of 20 items.

Required: No

createdAt

The timestamp when the service was created.

Type: Timestamp

Required: No

dependencyDiscovery

The dependency discovery configuration.

Type: DependencyDiscoveryConfig object

Required: No

openFindingsCount

The number of open findings.

Type: Integer

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

policyArn

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

regions

The AWS Regions where the service operates.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 5 items.

Length Constraints: Minimum length of 6.

Pattern: [a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]

Required: No

resolvedFindingsCount

The number of resolved findings.

Type: Integer

Required: No

updatedAt

The timestamp when the service was last updated.

Type: Timestamp

Required: No

See Also

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