Service

Represents a service in Resilience Hub. A service is the primary unit of resilience assessment.

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

The AWS account ID that owns the service.

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 for the service.

Type: DependencyDiscoveryConfig object

Required: No

description

Resource description for services and policies.

Type: String

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

Required: No

effectivePolicyValues

The effective policy values for the service.

Type: EffectivePolicyValues object

Required: No

estimatedAssessmentCost

The estimated cost of running an assessment on the service.

Type: AssessmentCost object

Required: No

kmsKeyId

KMS key identifier — accepts key ID, key ARN, alias name, or alias ARN.

Type: String

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

Required: No

openFindingsCount

The number of open findings for the service.

Type: Integer

Required: No

organizationId

The AWS Organizations identifier for the service.

Type: String

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

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

Required: No

ouId

The organizational unit (OU) identifier for the service.

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

permissionModel

The permission model for the service.

Type: PermissionModel object

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

reportConfiguration

Configuration for automatic report generation on a Service.

Type: ServiceReportConfiguration object

Required: No

rerunAssessment

Indicates whether the assessment should be rerun.

Type: Boolean

Required: No

resolvedFindingsCount

The number of resolved findings for the service.

Type: Integer

Required: No

resourceDiscovery

The resource discovery status for the service.

Type: ResourceDiscoveryStatus object

Required: No

tags

Resource tags.

Type: String to string map

Map Entries: Maximum number of 50 items.

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

Key Pattern: [^\x00-\x1f\x22]+

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Value Pattern: [^\x00-\x1f\x22]*

Required: No

updatedAt

The timestamp when the service was last updated.

Type: Timestamp

Required: No

Service

Contents

See Also