SDK for PHP V3
AWS Resilience Hub V2 2026-02-17
- Client: Aws\Resiliencehubv2\Resiliencehubv2Client
- Service ID: resiliencehubv2
- Version: 2026-02-17
This page describes the parameters and results for the operations of the AWS Resilience Hub V2 (2026-02-17), and shows how to use the Aws\Resiliencehubv2\Resiliencehubv2Client object to call the described operations. This documentation is specific to the 2026-02-17 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- CreateAssertion ( array $params = [] )
- Creates a resilience assertion for a service.
- CreateInputSource ( array $params = [] )
- Creates an input source for a service.
- CreatePolicy ( array $params = [] )
- Creates a resilience policy that defines availability and disaster recovery requirements.
- CreateReport ( array $params = [] )
- On-demand report creation.
- CreateService ( array $params = [] )
- Creates a service.
- CreateServiceFunction ( array $params = [] )
- Creates a service function within a service.
- CreateServiceFunctionResources ( array $params = [] )
- Associates resources with a service function.
- CreateSystem ( array $params = [] )
- Creates a system that represents a logical grouping of services.
- CreateUserJourney ( array $params = [] )
- Creates a user journey within a system.
- DeleteAssertion ( array $params = [] )
- Deletes a resilience assertion from a service.
- DeleteInputSource ( array $params = [] )
- Deletes an input source.
- DeletePolicy ( array $params = [] )
- Deletes a resilience policy.
- DeleteService ( array $params = [] )
- Deletes a service.
- DeleteServiceFunction ( array $params = [] )
- Deletes a service function.
- DeleteServiceFunctionResources ( array $params = [] )
- Removes resources from a service function.
- DeleteSystem ( array $params = [] )
- Deletes a system.
- DeleteUserJourney ( array $params = [] )
- Deletes a user journey.
- GetFailureModeFinding ( array $params = [] )
- Retrieves a finding by findingId.
- GetPolicy ( array $params = [] )
- Retrieves a resilience policy by ARN.
- GetService ( array $params = [] )
- Retrieves a service by ARN.
- GetSystem ( array $params = [] )
- Retrieves a system by ARN.
- GetUserJourney ( array $params = [] )
- Retrieves a user journey.
- ImportApp ( array $params = [] )
- Imports a V1 app into the V2 resource model, creating a service with the same name.
- ImportPolicy ( array $params = [] )
- Imports a V1 policy into V2, mapping RTO/RPO values from V1 scenarios.
- ListAssertions ( array $params = [] )
- Lists resilience assertions for a service.
- ListDependencies ( array $params = [] )
- Lists dependencies discovered for services.
- ListFailureModeAssessments ( array $params = [] )
- Lists failure mode assessments.
- ListFailureModeFindings ( array $params = [] )
- List findings.
- ListInputSources ( array $params = [] )
- Lists input sources for a service.
- ListPolicies ( array $params = [] )
- Lists resilience policies.
- ListReports ( array $params = [] )
- List reports for a service, or all reports owned by the account if serviceArn is not provided.
- ListResources ( array $params = [] )
- List resources.
- ListServiceEvents ( array $params = [] )
- Lists events for a service.
- ListServiceFunctions ( array $params = [] )
- Lists service functions for a service.
- ListServiceTopologyEdges ( array $params = [] )
- Lists topology edges for a service.
- ListServices ( array $params = [] )
- Lists services.
- ListSystemEvents ( array $params = [] )
- Lists events for a system.
- ListSystems ( array $params = [] )
- Lists systems.
- ListTagsForResource ( array $params = [] )
- Lists the tags for a resource.
- ListUserJourneys ( array $params = [] )
- Lists user journeys for a system.
- StartFailureModeAssessment ( array $params = [] )
- Start a failure mode assessment.
- TagResource ( array $params = [] )
- Adds tags to a resource.
- UntagResource ( array $params = [] )
- Removes tags from a resource.
- UpdateAssertion ( array $params = [] )
- Updates a resilience assertion.
- UpdateDependency ( array $params = [] )
- Updates a dependency classification.
- UpdateFailureModeFinding ( array $params = [] )
- Updates an existing finding.
- UpdatePolicy ( array $params = [] )
- Updates an existing resilience policy.
- UpdateService ( array $params = [] )
- Updates an existing service.
- UpdateServiceFunction ( array $params = [] )
- Updates a service function.
- UpdateSystem ( array $params = [] )
- Updates an existing system.
- UpdateUserJourney ( array $params = [] )
- Updates an existing user journey.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
- ListAssertions
- ListDependencies
- ListFailureModeAssessments
- ListFailureModeFindings
- ListInputSources
- ListPolicies
- ListReports
- ListResources
- ListServiceEvents
- ListServiceFunctions
- ListServiceTopologyEdges
- ListServices
- ListSystemEvents
- ListSystems
- ListUserJourneys
Waiters
Waiters allow you to poll a resource until it enters into a desired state. A waiter has a name used to describe what it does, and is associated with an API operation. When creating a waiter, you can provide the API operation parameters associated with the corresponding operation. Waiters can be accessed using the getWaiter($waiterName, $operationParameters) method of a client object. This client supports the following waiters:
| Waiter name | API Operation | Delay | Max Attempts |
|---|---|---|---|
| FailureModeAssessmentSuccess | ListFailureModeAssessments | 30 | 5 |
| ReportSucceeded | ListReports | 30 | 5 |
| ServiceAssessmentCompleted | GetService | 30 | 5 |
| ServiceResourceDiscoveryCompleted | GetService | 30 | 5 |
Operations
CreateAssertion
$result = $client->createAssertion([/* ... */]); $promise = $client->createAssertionAsync([/* ... */]);
Creates a resilience assertion for a service.
Parameter Syntax
$result = $client->createAssertion([
'clientToken' => '<string>',
'serviceArn' => '<string>', // REQUIRED
'text' => '<string>', // REQUIRED
]);
Parameter Details
Members
- clientToken
-
- Type: string
Idempotency token.
- serviceArn
-
- Required: Yes
- Type: string
ARN identifier.
- text
-
- Required: Yes
- Type: string
The text content of the assertion.
Result Syntax
[
'assertion' => [
'assertionId' => '<string>',
'createdAt' => <DateTime>,
'serviceArn' => '<string>',
'source' => 'AI_GENERATED|USER',
'text' => '<string>',
'updatedAt' => <DateTime>,
],
]
Result Details
Members
- assertion
-
- Required: Yes
- Type: Assertion structure
The created assertion.
Errors
- InternalServerException:
Internal service error.
- ResourceNotFoundException:
Resource not found.
- ValidationException:
Validation error — invalid input parameters.
- ConflictException:
Conflict — resource already exists.
- ServiceQuotaExceededException:
Service quota exceeded.
- AccessDeniedException:
Access denied — caller lacks required permissions.
CreateInputSource
$result = $client->createInputSource([/* ... */]); $promise = $client->createInputSourceAsync([/* ... */]);
Creates an input source for a service.
Parameter Syntax
$result = $client->createInputSource([
'clientToken' => '<string>',
'resourceConfiguration' => [ // REQUIRED
'cfnStackArn' => '<string>',
'designFileS3Url' => '<string>',
'eks' => [
'clusterArn' => '<string>', // REQUIRED
'namespaces' => ['<string>', ...], // REQUIRED
],
'resourceTags' => [
[
'key' => '<string>', // REQUIRED
'values' => ['<string>', ...], // REQUIRED
],
// ...
],
'tfStateFileUrl' => '<string>',
],
'serviceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- clientToken
-
- Type: string
Idempotency token.
- resourceConfiguration
-
- Required: Yes
- Type: ResourceConfiguration structure
Resource configuration for an input source. Provide exactly one field.
- serviceArn
-
- Required: Yes
- Type: string
ARN identifier.
Result Syntax
[
'inputSourceId' => '<string>',
'serviceArn' => '<string>',
]
Result Details
Members
- inputSourceId
-
- Required: Yes
- Type: string
The unique identifier assigned to the created input source.
- serviceArn
-
- Required: Yes
- Type: string
ARN identifier.
Errors
- InternalServerException:
Internal service error.
- ResourceNotFoundException:
Resource not found.
- ValidationException:
Validation error — invalid input parameters.
- ConflictException:
Conflict — resource already exists.
- ServiceQuotaExceededException:
Service quota exceeded.
- AccessDeniedException:
Access denied — caller lacks required permissions.
CreatePolicy
$result = $client->createPolicy([/* ... */]); $promise = $client->createPolicyAsync([/* ... */]);
Creates a resilience policy that defines availability and disaster recovery requirements.
Parameter Syntax
$result = $client->createPolicy([
'availabilitySlo' => [
'target' => <float>,
],
'clientToken' => '<string>',
'dataRecovery' => [
'timeBetweenBackupsInMinutes' => <integer>,
],
'description' => '<string>',
'kmsKeyId' => '<string>',
'multiAz' => [
'disasterRecoveryApproach' => 'ACTIVE_ACTIVE|HOT_STANDBY|WARM_STANDBY|PILOT_LIGHT|BACKUP_AND_RESTORE',
'rpoInMinutes' => <integer>,
'rtoInMinutes' => <integer>,
],
'multiRegion' => [
'disasterRecoveryApproach' => 'ACTIVE_ACTIVE|HOT_STANDBY|WARM_STANDBY|PILOT_LIGHT|BACKUP_AND_RESTORE',
'rpoInMinutes' => <integer>,
'rtoInMinutes' => <integer>,
],
'name' => '<string>', // REQUIRED
'tags' => ['<string>', ...],
]);
Parameter Details
Members
- availabilitySlo
-
- Type: AvailabilitySlo structure
The availability SLO for the resilience policy.
- clientToken
-
- Type: string
Idempotency token.
- dataRecovery
-
- Type: DataRecoveryTargets structure
The data recovery targets for the resilience policy.
- description
-
- Type: string
Resource description for services and policies.
- kmsKeyId
-
- Type: string
KMS key identifier — accepts key ID, key ARN, alias name, or alias ARN.
- multiAz
-
- Type: MultiAzTargets structure
The multi-AZ disaster recovery targets for the resilience policy.
- multiRegion
-
- Type: MultiRegionTargets structure
The multi-Region disaster recovery targets for the resilience policy.
- name
-
- Required: Yes
- Type: string
Resource name (used in ARN — no spaces allowed).
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Resource tags.
Result Syntax
[
'policy' => [
'associatedServiceCount' => <integer>,
'availabilitySlo' => [
'target' => <float>,
],
'createdAt' => <DateTime>,
'dataRecovery' => [
'timeBetweenBackupsInMinutes' => <integer>,
],
'description' => '<string>',
'kmsKeyId' => '<string>',
'multiAz' => [
'disasterRecoveryApproach' => 'ACTIVE_ACTIVE|HOT_STANDBY|WARM_STANDBY|PILOT_LIGHT|BACKUP_AND_RESTORE',
'rpoInMinutes' => <integer>,
'rtoInMinutes' => <integer>,
],
'multiRegion' => [
'disasterRecoveryApproach' => 'ACTIVE_ACTIVE|HOT_STANDBY|WARM_STANDBY|PILOT_LIGHT|BACKUP_AND_RESTORE',
'rpoInMinutes' => <integer>,
'rtoInMinutes' => <integer>,
],
'name' => '<string>',
'policyArn' => '<string>',
'tags' => ['<string>', ...],
'updatedAt' => <DateTime>,
],
]
Result Details
Members
- policy
-
- Required: Yes
- Type: Policy structure
The created resilience policy.
Errors
- InternalServerException:
Internal service error.
- ResourceNotFoundException:
Resource not found.
- ValidationException:
Validation error — invalid input parameters.
- ConflictException:
Conflict — resource already exists.
- ServiceQuotaExceededException:
Service quota exceeded.
- AccessDeniedException:
Access denied — caller lacks required permissions.
CreateReport
$result = $client->createReport([/* ... */]); $promise = $client->createReportAsync([/* ... */]);
On-demand report creation. Idempotent — duplicate requests with same clientToken return existing result.
Parameter Syntax
$result = $client->createReport([
'clientToken' => '<string>',
'reportType' => 'FAILURE_MODE', // REQUIRED
'serviceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- clientToken
-
- Type: string
Idempotency token.
- reportType
-
- Required: Yes
- Type: string
The type of report to generate.
- serviceArn
-
- Required: Yes
- Type: string
ARN identifier.
Result Syntax
[
'reportGenerationResult' => [
'assessmentId' => '<string>',
'createdAt' => <DateTime>,
'reportOutput' => [
'failedReportOutput' => [
'errorCode' => 'INSUFFICIENT_PERMISSIONS|CONFIGURATION_ERROR|INTERNAL_ERROR',
'errorMessage' => '<string>',
],
's3ReportOutput' => [
's3ObjectKey' => '<string>',
],
],
'reportType' => 'FAILURE_MODE',
'serviceArn' => '<string>',
'status' => 'PENDING|SUCCEEDED|FAILED',
],
]
Result Details
Members
- reportGenerationResult
-
- Required: Yes
- Type: ReportGenerationResult structure
The result of the report generation request.
Errors
- InternalServerException:
Internal service error.
- ResourceNotFoundException:
Resource not found.
- ValidationException:
Validation error — invalid input parameters.
- ConflictException:
Conflict — resource already exists.
- ThrottlingException:
Too many requests — rate limit exceeded.
- AccessDeniedException:
Access denied — caller lacks required permissions.
CreateService
$result = $client->createService([/* ... */]); $promise = $client->createServiceAsync([/* ... */]);
Creates a service.
Parameter Syntax
$result = $client->createService([
'associatedSystems' => [
[
'systemArn' => '<string>', // REQUIRED
'systemName' => '<string>',
'userJourneyIds' => ['<string>', ...],
],
// ...
],
'clientToken' => '<string>',
'dependencyDiscovery' => 'ENABLED|DISABLED',
'description' => '<string>',
'kmsKeyId' => '<string>',
'name' => '<string>', // REQUIRED
'permissionModel' => [ // REQUIRED
'crossAccountRoles' => [
[
'crossAccountRoleArn' => '<string>', // REQUIRED
'externalId' => '<string>',
],
// ...
],
'invokerRoleName' => '<string>', // REQUIRED
],
'policyArn' => '<string>',
'regions' => ['<string>', ...], // REQUIRED
'reportConfiguration' => [
'reportOutputs' => [ // REQUIRED
[
's3' => [
'bucketOwner' => '<string>', // REQUIRED
'bucketPath' => '<string>', // REQUIRED
],
],
// ...
],
],
'tags' => ['<string>', ...],
]);
Parameter Details
Members
- associatedSystems
-
- Type: Array of AssociatedSystem structures
The systems to associate with the service.
- clientToken
-
- Type: string
Idempotency token.
- dependencyDiscovery
-
- Type: string
Caller-settable values for dependency discovery. INITIALIZING is system-managed.
- description
-
- Type: string
Resource description for services and policies.
- kmsKeyId
-
- Type: string
KMS key identifier — accepts key ID, key ARN, alias name, or alias ARN.
- name
-
- Required: Yes
- Type: string
Resource name (used in ARN — no spaces allowed).
- permissionModel
-
- Required: Yes
- Type: PermissionModel structure
The permission model for the service.
- policyArn
-
- Type: string
ARN identifier.
- regions
-
- Required: Yes
- Type: Array of strings
The AWS Regions where the service operates.
- reportConfiguration
-
- Type: ServiceReportConfiguration structure
Configuration for automatic report generation on a Service.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Resource tags.
Result Syntax
[
'service' => [
'accountId' => '<string>',
'achievability' => [
'availabilitySlo' => 'ACHIEVABLE|NOT_ACHIEVABLE',
'multiAzRtoRpo' => 'ACHIEVABLE|NOT_ACHIEVABLE',
'multiRegionRtoRpo' => 'ACHIEVABLE|NOT_ACHIEVABLE',
],
'assessmentStatus' => 'NOT_STARTED|PENDING|IN_PROGRESS|FAILED|SUCCESS',
'associatedSystems' => [
[
'systemArn' => '<string>',
'systemName' => '<string>',
'userJourneyIds' => ['<string>', ...],
],
// ...
],
'createdAt' => <DateTime>,
'dependencyDiscovery' => [
'status' => 'ENABLED|INITIALIZING|DISABLED',
'updatedAt' => <DateTime>,
],
'description' => '<string>',
'effectivePolicyValues' => [
'availabilitySlo' => [
'policyName' => '<string>',
'source' => 'SELF|CROSS_ACCOUNT',
'value' => <float>,
],
'dataRecoveryTimeBetweenBackups' => [
'policyName' => '<string>',
'source' => 'SELF|CROSS_ACCOUNT',
'value' => <integer>,
],
'multiAzDrApproach' => [
'policyName' => '<string>',
'source' => 'SELF|CROSS_ACCOUNT',
'value' => '<string>',
],
'multiAzRpo' => [
'policyName' => '<string>',
'source' => 'SELF|CROSS_ACCOUNT',
'value' => <integer>,
],
'multiAzRto' => [
'policyName' => '<string>',
'source' => 'SELF|CROSS_ACCOUNT',
'value' => <integer>,
],
'multiRegionDrApproach' => [
'policyName' => '<string>',
'source' => 'SELF|CROSS_ACCOUNT',
'value' => '<string>',
],
'multiRegionRpo' => [
'policyName' => '<string>',
'source' => 'SELF|CROSS_ACCOUNT',
'value' => <integer>,
],
'multiRegionRto' => [
'policyName' => '<string>',
'source' => 'SELF|CROSS_ACCOUNT',
'value' => <integer>,
],
],
'estimatedAssessmentCost' => [
'amount' => <float>,
'currency' => 'USD',
],
'kmsKeyId' => '<string>',
'name' => '<string>',
'openFindingsCount' => <integer>,
'organizationId' => '<string>',
'ouId' => '<string>',
'permissionModel' => [
'crossAccountRoles' => [
[
'crossAccountRoleArn' => '<string>',
'externalId' => '<string>',
],
// ...
],
'invokerRoleName' => '<string>',
],
'policyArn' => '<string>',
'regions' => ['<string>', ...],
'reportConfiguration' => [
'reportOutputs' => [
[
's3' => [
'bucketOwner' => '<string>',
'bucketPath' => '<string>',
],
],
// ...
],
],
'rerunAssessment' => true || false,
'resolvedFindingsCount' => <integer>,
'resourceDiscovery' => [
'errorCode' => 'INVALID_PERMISSIONS|STACK_NOT_FOUND|CLUSTER_NOT_FOUND|STATE_FILE_NOT_FOUND|ACCESS_DENIED|UNSUPPORTED_CLUSTER|INTERNAL_ERROR',
'errorMessage' => '<string>',
'lastRunAt' => <DateTime>,
'status' => 'RUNNING|SUCCEEDED|FAILED|COMPLETED_WITH_FAILURES|NOT_STARTED',
],
'serviceArn' => '<string>',
'tags' => ['<string>', ...],
'updatedAt' => <DateTime>,
],
]
Result Details
Members
- service
-
- Required: Yes
- Type: Service structure
The created service.
Errors
- InternalServerException:
Internal service error.
- ResourceNotFoundException:
Resource not found.
- ValidationException:
Validation error — invalid input parameters.
- ConflictException:
Conflict — resource already exists.
- ServiceQuotaExceededException:
Service quota exceeded.
- AccessDeniedException:
Access denied — caller lacks required permissions.
CreateServiceFunction
$result = $client->createServiceFunction([/* ... */]); $promise = $client->createServiceFunctionAsync([/* ... */]);
Creates a service function within a service.
Parameter Syntax
$result = $client->createServiceFunction([
'clientToken' => '<string>',
'criticality' => 'PRIMARY|SUPPLEMENTAL', // REQUIRED
'description' => '<string>',
'name' => '<string>', // REQUIRED
'serviceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- clientToken
-
- Type: string
Idempotency token.
- criticality
-
- Required: Yes
- Type: string
The criticality level of the service function.
- description
-
- Type: string
Resource description.
- name
-
- Required: Yes
- Type: string
Entity label (not part of ARN — spaces allowed).
- serviceArn
-
- Required: Yes
- Type: string
ARN identifier.
Result Syntax
[
'serviceFunction' => [
'createdAt' => <DateTime>,
'criticality' => 'PRIMARY|SUPPLEMENTAL',
'description' => '<string>',
'name' => '<string>',
'resourceCount' => <integer>,
'serviceArn' => '<string>',
'serviceFunctionId' => '<string>',
'source' => 'AI_GENERATED|USER',
'updatedAt' => <DateTime>,
],
]
Result Details
Members
- serviceFunction
-
- Required: Yes
- Type: ServiceFunction structure
The created service function.
Errors
- InternalServerException:
Internal service error.
- ResourceNotFoundException:
Resource not found.
- ValidationException:
Validation error — invalid input parameters.
- ConflictException:
Conflict — resource already exists.
- ServiceQuotaExceededException:
Service quota exceeded.
- AccessDeniedException:
Access denied — caller lacks required permissions.
CreateServiceFunctionResources
$result = $client->createServiceFunctionResources([/* ... */]); $promise = $client->createServiceFunctionResourcesAsync([/* ... */]);
Associates resources with a service function.
Parameter Syntax
$result = $client->createServiceFunctionResources([
'resources' => ['<string>', ...], // REQUIRED
'serviceArn' => '<string>', // REQUIRED
'serviceFunctionId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- resources
-
- Required: Yes
- Type: Array of strings
The list of resources to associate with the service function.
- serviceArn
-
- Required: Yes
- Type: string
ARN identifier.
- serviceFunctionId
-
- Required: Yes
- Type: string
The identifier of the service function to associate resources with.
Result Syntax
[
'resources' => ['<string>', ...],
'serviceArn' => '<string>',
'serviceFunctionId' => '<string>',
]
Result Details
Members
- resources
-
- Type: Array of strings
The list of resources that were associated.
- serviceArn
-
- Type: string
ARN identifier.
- serviceFunctionId
-
- Type: string
The identifier of the service function.
Errors
- InternalServerException:
Internal service error.
- ResourceNotFoundException:
Resource not found.
- ValidationException:
Validation error — invalid input parameters.
- ConflictException:
Conflict — resource already exists.
- AccessDeniedException:
Access denied — caller lacks required permissions.
CreateSystem
$result = $client->createSystem([/* ... */]); $promise = $client->createSystemAsync([/* ... */]);
Creates a system that represents a logical grouping of services.
Parameter Syntax
$result = $client->createSystem([
'clientToken' => '<string>',
'description' => '<string>',
'kmsKeyId' => '<string>',
'name' => '<string>', // REQUIRED
'sharingEnabled' => true || false,
'tags' => ['<string>', ...],
]);
Parameter Details
Members
- clientToken
-
- Type: string
Idempotency token.
- description
-
- Type: string
Resource description.
- kmsKeyId
-
- Type: string
KMS key identifier — accepts key ID, key ARN, alias name, or alias ARN.
- name
-
- Required: Yes
- Type: string
Resource name (used in ARN — no spaces allowed).
- sharingEnabled
-
- Type: boolean
Indicates whether cross-account sharing is enabled for the system.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Resource tags.
Result Syntax
[
'system' => [
'createdAt' => <DateTime>,
'description' => '<string>',
'kmsKeyId' => '<string>',
'name' => '<string>',
'organizationId' => '<string>',
'ouId' => '<string>',
'sharingEnabled' => true || false,
'systemArn' => '<string>',
'systemId' => '<string>',
'tags' => ['<string>', ...],
'updatedAt' => <DateTime>,
],
]
Result Details
Members
- system
-
- Required: Yes
- Type: System structure
The created system.
Errors
- InternalServerException:
Internal service error.
- ResourceNotFoundException:
Resource not found.
- ValidationException:
Validation error — invalid input parameters.
- ConflictException:
Conflict — resource already exists.
- ServiceQuotaExceededException:
Service quota exceeded.
- AccessDeniedException:
Access denied — caller lacks required permissions.
CreateUserJourney
$result = $client->createUserJourney([/* ... */]); $promise = $client->createUserJourneyAsync([/* ... */]);
Creates a user journey within a system.
Parameter Syntax
$result = $client->createUserJourney([
'clientToken' => '<string>',
'description' => '<string>',
'name' => '<string>', // REQUIRED
'policyArn' => '<string>',
'systemArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- clientToken
-
- Type: string
Idempotency token.
- description
-
- Type: string
Resource description.
- name
-
- Required: Yes
- Type: string
Entity label (not part of ARN — spaces allowed).
- policyArn
-
- Type: string
ARN identifier.
- systemArn
-
- Required: Yes
- Type: string
ARN identifier.
Result Syntax
[
'userJourney' => [
'createdAt' => <DateTime>,
'description' => '<string>',
'name' => '<string>',
'policyArn' => '<string>',
'updatedAt' => <DateTime>,
'userJourneyId' => '<string>',
],
]
Result Details
Members
- userJourney
-
- Required: Yes
- Type: UserJourney structure
The created user journey.
Errors
- InternalServerException:
Internal service error.
- ResourceNotFoundException:
Resource not found.
- ValidationException:
Validation error — invalid input parameters.
- ConflictException:
Conflict — resource already exists.
- ServiceQuotaExceededException:
Service quota exceeded.
- AccessDeniedException:
Access denied — caller lacks required permissions.
DeleteAssertion
$result = $client->deleteAssertion([/* ... */]); $promise = $client->deleteAssertionAsync([/* ... */]);
Deletes a resilience assertion from a service.
Parameter Syntax
$result = $client->deleteAssertion([
'assertionId' => '<string>', // REQUIRED
'serviceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- assertionId
-
- Required: Yes
- Type: string
The unique identifier of the assertion to delete.
- serviceArn
-
- Required: Yes
- Type: string
ARN identifier.
Result Syntax
[
'assertionId' => '<string>',
]
Result Details
Members
- assertionId
-
- Type: string
The unique identifier of the deleted assertion.
Errors
- InternalServerException:
Internal service error.
- ResourceNotFoundException:
Resource not found.
- ValidationException:
Validation error — invalid input parameters.
- AccessDeniedException:
Access denied — caller lacks required permissions.
DeleteInputSource
$result = $client->deleteInputSource([/* ... */]); $promise = $client->deleteInputSourceAsync([/* ... */]);
Deletes an input source.
Parameter Syntax
$result = $client->deleteInputSource([
'inputSourceId' => '<string>', // REQUIRED
'serviceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- inputSourceId
-
- Required: Yes
- Type: string
The identifier of the input source to delete.
- serviceArn
-
- Required: Yes
- Type: string
ARN identifier.
Result Syntax
[
'inputSourceId' => '<string>',
'serviceArn' => '<string>',
]
Result Details
Members
- inputSourceId
-
- Required: Yes
- Type: string
The identifier of the deleted input source.
- serviceArn
-
- Required: Yes
- Type: string
ARN identifier.
Errors
- InternalServerException:
Internal service error.
- ResourceNotFoundException:
Resource not found.
- ValidationException:
Validation error — invalid input parameters.
- AccessDeniedException:
Access denied — caller lacks required permissions.
DeletePolicy
$result = $client->deletePolicy([/* ... */]); $promise = $client->deletePolicyAsync([/* ... */]);
Deletes a resilience policy.
Parameter Syntax
$result = $client->deletePolicy([
'policyArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- policyArn
-
- Required: Yes
- Type: string
ARN identifier.
Result Syntax
[
'policyArn' => '<string>',
]
Result Details
Members
- policyArn
-
- Required: Yes
- Type: string
ARN identifier.
Errors
- InternalServerException:
Internal service error.
- ResourceNotFoundException:
Resource not found.
- ValidationException:
Validation error — invalid input parameters.
- ConflictException:
Conflict — resource already exists.
- AccessDeniedException:
Access denied — caller lacks required permissions.
DeleteService
$result = $client->deleteService([/* ... */]); $promise = $client->deleteServiceAsync([/* ... */]);
Deletes a service.
Parameter Syntax
$result = $client->deleteService([
'serviceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- serviceArn
-
- Required: Yes
- Type: string
ARN identifier.
Result Syntax
[
'serviceArn' => '<string>',
]
Result Details
Members
- serviceArn
-
- Required: Yes
- Type: string
ARN identifier.
Errors
- InternalServerException:
Internal service error.
- ResourceNotFoundException:
Resource not found.
- ValidationException:
Validation error — invalid input parameters.
- ConflictException:
Conflict — resource already exists.
- AccessDeniedException:
Access denied — caller lacks required permissions.
DeleteServiceFunction
$result = $client->deleteServiceFunction([/* ... */]); $promise = $client->deleteServiceFunctionAsync([/* ... */]);
Deletes a service function.
Parameter Syntax
$result = $client->deleteServiceFunction([
'serviceArn' => '<string>', // REQUIRED
'serviceFunctionId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- serviceArn
-
- Required: Yes
- Type: string
ARN identifier.
- serviceFunctionId
-
- Required: Yes
- Type: string
The identifier of the service function to delete.
Result Syntax
[
'serviceFunctionId' => '<string>',
]
Result Details
Members
- serviceFunctionId
-
- Type: string
The identifier of the deleted service function.
Errors
- InternalServerException:
Internal service error.
- ResourceNotFoundException:
Resource not found.
- ValidationException:
Validation error — invalid input parameters.
- ConflictException:
Conflict — resource already exists.
- AccessDeniedException:
Access denied — caller lacks required permissions.
DeleteServiceFunctionResources
$result = $client->deleteServiceFunctionResources([/* ... */]); $promise = $client->deleteServiceFunctionResourcesAsync([/* ... */]);
Removes resources from a service function.
Parameter Syntax
$result = $client->deleteServiceFunctionResources([
'resources' => ['<string>', ...], // REQUIRED
'serviceArn' => '<string>', // REQUIRED
'serviceFunctionId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- resources
-
- Required: Yes
- Type: Array of strings
The list of resources to remove from the service function.
- serviceArn
-
- Required: Yes
- Type: string
ARN identifier.
- serviceFunctionId
-
- Required: Yes
- Type: string
The identifier of the service function to remove resources from.
Result Syntax
[
'resources' => ['<string>', ...],
'serviceArn' => '<string>',
'serviceFunctionId' => '<string>',
]
Result Details
Members
- resources
-
- Type: Array of strings
The list of resources that were removed.
- serviceArn
-
- Type: string
ARN identifier.
- serviceFunctionId
-
- Type: string
The identifier of the service function.
Errors
- InternalServerException:
Internal service error.
- ResourceNotFoundException:
Resource not found.
- ValidationException:
Validation error — invalid input parameters.
- ConflictException:
Conflict — resource already exists.
- AccessDeniedException:
Access denied — caller lacks required permissions.
DeleteSystem
$result = $client->deleteSystem([/* ... */]); $promise = $client->deleteSystemAsync([/* ... */]);
Deletes a system.
Parameter Syntax
$result = $client->deleteSystem([
'systemArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- systemArn
-
- Required: Yes
- Type: string
ARN identifier.
Result Syntax
[
'systemArn' => '<string>',
]
Result Details
Members
- systemArn
-
- Required: Yes
- Type: string
ARN identifier.
Errors
- InternalServerException:
Internal service error.
- ResourceNotFoundException:
Resource not found.
- ValidationException:
Validation error — invalid input parameters.
- ConflictException:
Conflict — resource already exists.
- AccessDeniedException:
Access denied — caller lacks required permissions.
DeleteUserJourney
$result = $client->deleteUserJourney([/* ... */]); $promise = $client->deleteUserJourneyAsync([/* ... */]);
Deletes a user journey.
Parameter Syntax
$result = $client->deleteUserJourney([
'systemArn' => '<string>', // REQUIRED
'userJourneyId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- systemArn
-
- Required: Yes
- Type: string
ARN identifier.
- userJourneyId
-
- Required: Yes
- Type: string
The identifier of the user journey to delete.
Result Syntax
[
'userJourneyId' => '<string>',
]
Result Details
Members
- userJourneyId
-
- Required: Yes
- Type: string
The identifier of the deleted user journey.
Errors
- InternalServerException:
Internal service error.
- ResourceNotFoundException:
Resource not found.
- ValidationException:
Validation error — invalid input parameters.
- ConflictException:
Conflict — resource already exists.
- AccessDeniedException:
Access denied — caller lacks required permissions.
GetFailureModeFinding
$result = $client->getFailureModeFinding([/* ... */]); $promise = $client->getFailureModeFindingAsync([/* ... */]);
Retrieves a finding by findingId.
Parameter Syntax
$result = $client->getFailureModeFinding([
'findingId' => '<string>', // REQUIRED
'serviceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- findingId
-
- Required: Yes
- Type: string
The unique identifier of the finding to retrieve.
- serviceArn
-
- Required: Yes
- Type: string
ARN identifier.
Result Syntax
[
'finding' => [
'comment' => '<string>',
'description' => '<string>',
'failureCategory' => 'SHARED_FATE|EXCESSIVE_LOAD|EXCESSIVE_LATENCY|MISCONFIGURATION_AND_BUGS|SINGLE_POINT_OF_FAILURE',
'findingId' => '<string>',
'infrastructureAndCodeRecommendations' => [
[
'suggestedChanges' => ['<string>', ...],
],
// ...
],
'name' => '<string>',
'observabilityRecommendations' => [
[
'suggestedChanges' => ['<string>', ...],
],
// ...
],
'policyComponent' => 'AVAILABILITY_SLO|MULTI_AZ_DISASTER_RECOVERY|MULTI_REGION_DISASTER_RECOVERY|DATA_RECOVERY',
'reasoning' => '<string>',
'serviceFunctions' => ['<string>', ...],
'severity' => 'LOW|MEDIUM|HIGH',
'status' => 'OPEN|RESOLVED|IRRELEVANT',
'testingRecommendations' => [
[
'suggestedChanges' => ['<string>', ...],
],
// ...
],
'updatedAt' => <DateTime>,
],
]
Result Details
Members
- finding
-
- Type: Finding structure
The requested finding.
Errors
- InternalServerException:
Internal service error.
- ResourceNotFoundException:
Resource not found.
- ValidationException:
Validation error — invalid input parameters.
- AccessDeniedException:
Access denied — caller lacks required permissions.
GetPolicy
$result = $client->getPolicy([/* ... */]); $promise = $client->getPolicyAsync([/* ... */]);
Retrieves a resilience policy by ARN.
Parameter Syntax
$result = $client->getPolicy([
'policyArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- policyArn
-
- Required: Yes
- Type: string
ARN identifier.
Result Syntax
[
'policy' => [
'associatedServiceCount' => <integer>,
'availabilitySlo' => [
'target' => <float>,
],
'createdAt' => <DateTime>,
'dataRecovery' => [
'timeBetweenBackupsInMinutes' => <integer>,
],
'description' => '<string>',
'kmsKeyId' => '<string>',
'multiAz' => [
'disasterRecoveryApproach' => 'ACTIVE_ACTIVE|HOT_STANDBY|WARM_STANDBY|PILOT_LIGHT|BACKUP_AND_RESTORE',
'rpoInMinutes' => <integer>,
'rtoInMinutes' => <integer>,
],
'multiRegion' => [
'disasterRecoveryApproach' => 'ACTIVE_ACTIVE|HOT_STANDBY|WARM_STANDBY|PILOT_LIGHT|BACKUP_AND_RESTORE',
'rpoInMinutes' => <integer>,
'rtoInMinutes' => <integer>,
],
'name' => '<string>',
'policyArn' => '<string>',
'tags' => ['<string>', ...],
'updatedAt' => <DateTime>,
],
]
Result Details
Members
- policy
-
- Required: Yes
- Type: Policy structure
The requested resilience policy.
Errors
- InternalServerException:
Internal service error.
- ResourceNotFoundException:
Resource not found.
- ValidationException:
Validation error — invalid input parameters.
- AccessDeniedException:
Access denied — caller lacks required permissions.
GetService
$result = $client->getService([/* ... */]); $promise = $client->getServiceAsync([/* ... */]);
Retrieves a service by ARN.
Parameter Syntax
$result = $client->getService([
'serviceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- serviceArn
-
- Required: Yes
- Type: string
ARN identifier.
Result Syntax
[
'service' => [
'accountId' => '<string>',
'achievability' => [
'availabilitySlo' => 'ACHIEVABLE|NOT_ACHIEVABLE',
'multiAzRtoRpo' => 'ACHIEVABLE|NOT_ACHIEVABLE',
'multiRegionRtoRpo' => 'ACHIEVABLE|NOT_ACHIEVABLE',
],
'assessmentStatus' => 'NOT_STARTED|PENDING|IN_PROGRESS|FAILED|SUCCESS',
'associatedSystems' => [
[
'systemArn' => '<string>',
'systemName' => '<string>',
'userJourneyIds' => ['<string>', ...],
],
// ...
],
'createdAt' => <DateTime>,
'dependencyDiscovery' => [
'status' => 'ENABLED|INITIALIZING|DISABLED',
'updatedAt' => <DateTime>,
],
'description' => '<string>',
'effectivePolicyValues' => [
'availabilitySlo' => [
'policyName' => '<string>',
'source' => 'SELF|CROSS_ACCOUNT',
'value' => <float>,
],
'dataRecoveryTimeBetweenBackups' => [
'policyName' => '<string>',
'source' => 'SELF|CROSS_ACCOUNT',
'value' => <integer>,
],
'multiAzDrApproach' => [
'policyName' => '<string>',
'source' => 'SELF|CROSS_ACCOUNT',
'value' => '<string>',
],
'multiAzRpo' => [
'policyName' => '<string>',
'source' => 'SELF|CROSS_ACCOUNT',
'value' => <integer>,
],
'multiAzRto' => [
'policyName' => '<string>',
'source' => 'SELF|CROSS_ACCOUNT',
'value' => <integer>,
],
'multiRegionDrApproach' => [
'policyName' => '<string>',
'source' => 'SELF|CROSS_ACCOUNT',
'value' => '<string>',
],
'multiRegionRpo' => [
'policyName' => '<string>',
'source' => 'SELF|CROSS_ACCOUNT',
'value' => <integer>,
],
'multiRegionRto' => [
'policyName' => '<string>',
'source' => 'SELF|CROSS_ACCOUNT',
'value' => <integer>,
],
],
'estimatedAssessmentCost' => [
'amount' => <float>,
'currency' => 'USD',
],
'kmsKeyId' => '<string>',
'name' => '<string>',
'openFindingsCount' => <integer>,
'organizationId' => '<string>',
'ouId' => '<string>',
'permissionModel' => [
'crossAccountRoles' => [
[
'crossAccountRoleArn' => '<string>',
'externalId' => '<string>',
],
// ...
],
'invokerRoleName' => '<string>',
],
'policyArn' => '<string>',
'regions' => ['<string>', ...],
'reportConfiguration' => [
'reportOutputs' => [
[
's3' => [
'bucketOwner' => '<string>',
'bucketPath' => '<string>',
],
],
// ...
],
],
'rerunAssessment' => true || false,
'resolvedFindingsCount' => <integer>,
'resourceDiscovery' => [
'errorCode' => 'INVALID_PERMISSIONS|STACK_NOT_FOUND|CLUSTER_NOT_FOUND|STATE_FILE_NOT_FOUND|ACCESS_DENIED|UNSUPPORTED_CLUSTER|INTERNAL_ERROR',
'errorMessage' => '<string>',
'lastRunAt' => <DateTime>,
'status' => 'RUNNING|SUCCEEDED|FAILED|COMPLETED_WITH_FAILURES|NOT_STARTED',
],
'serviceArn' => '<string>',
'tags' => ['<string>', ...],
'updatedAt' => <DateTime>,
],
]
Result Details
Members
- service
-
- Required: Yes
- Type: Service structure
The requested service.
Errors
- InternalServerException:
Internal service error.
- ResourceNotFoundException:
Resource not found.
- ValidationException:
Validation error — invalid input parameters.
- AccessDeniedException:
Access denied — caller lacks required permissions.
GetSystem
$result = $client->getSystem([/* ... */]); $promise = $client->getSystemAsync([/* ... */]);
Retrieves a system by ARN.
Parameter Syntax
$result = $client->getSystem([
'systemArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- systemArn
-
- Required: Yes
- Type: string
ARN identifier.
Result Syntax
[
'system' => [
'createdAt' => <DateTime>,
'description' => '<string>',
'kmsKeyId' => '<string>',
'name' => '<string>',
'organizationId' => '<string>',
'ouId' => '<string>',
'sharingEnabled' => true || false,
'systemArn' => '<string>',
'systemId' => '<string>',
'tags' => ['<string>', ...],
'updatedAt' => <DateTime>,
],
]
Result Details
Members
- system
-
- Required: Yes
- Type: System structure
The requested system.
Errors
- InternalServerException:
Internal service error.
- ResourceNotFoundException:
Resource not found.
- ValidationException:
Validation error — invalid input parameters.
- AccessDeniedException:
Access denied — caller lacks required permissions.
GetUserJourney
$result = $client->getUserJourney([/* ... */]); $promise = $client->getUserJourneyAsync([/* ... */]);
Retrieves a user journey.
Parameter Syntax
$result = $client->getUserJourney([
'systemArn' => '<string>', // REQUIRED
'userJourneyId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- systemArn
-
- Required: Yes
- Type: string
ARN identifier.
- userJourneyId
-
- Required: Yes
- Type: string
The identifier of the user journey to retrieve.
Result Syntax
[
'userJourney' => [
'createdAt' => <DateTime>,
'description' => '<string>',
'name' => '<string>',
'policyArn' => '<string>',
'updatedAt' => <DateTime>,
'userJourneyId' => '<string>',
],
]
Result Details
Members
- userJourney
-
- Required: Yes
- Type: UserJourney structure
The requested user journey.
Errors
- InternalServerException:
Internal service error.
- ResourceNotFoundException:
Resource not found.
- ValidationException:
Validation error — invalid input parameters.
- AccessDeniedException:
Access denied — caller lacks required permissions.
ImportApp
$result = $client->importApp([/* ... */]); $promise = $client->importAppAsync([/* ... */]);
Imports a V1 app into the V2 resource model, creating a service with the same name.
Parameter Syntax
$result = $client->importApp([
'associatedSystems' => [
[
'systemArn' => '<string>', // REQUIRED
'systemName' => '<string>',
'userJourneyIds' => ['<string>', ...],
],
// ...
],
'clientToken' => '<string>',
'kmsKeyId' => '<string>',
'policyArn' => '<string>',
'skipManuallyAddedResources' => true || false,
'tags' => ['<string>', ...],
'v1AppArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- associatedSystems
-
- Type: Array of AssociatedSystem structures
The systems to associate with the imported service.
- clientToken
-
- Type: string
Idempotency token.
- kmsKeyId
-
- Type: string
KMS key identifier — accepts key ID, key ARN, alias name, or alias ARN.
- policyArn
-
- Type: string
ARN identifier.
- skipManuallyAddedResources
-
- Type: boolean
Whether to skip manually added resources during import.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Resource tags.
- v1AppArn
-
- Required: Yes
- Type: string
ARN identifier.
Result Syntax
[
'service' => [
'accountId' => '<string>',
'achievability' => [
'availabilitySlo' => 'ACHIEVABLE|NOT_ACHIEVABLE',
'multiAzRtoRpo' => 'ACHIEVABLE|NOT_ACHIEVABLE',
'multiRegionRtoRpo' => 'ACHIEVABLE|NOT_ACHIEVABLE',
],
'assessmentStatus' => 'NOT_STARTED|PENDING|IN_PROGRESS|FAILED|SUCCESS',
'associatedSystems' => [
[
'systemArn' => '<string>',
'systemName' => '<string>',
'userJourneyIds' => ['<string>', ...],
],
// ...
],
'createdAt' => <DateTime>,
'dependencyDiscovery' => [
'status' => 'ENABLED|INITIALIZING|DISABLED',
'updatedAt' => <DateTime>,
],
'description' => '<string>',
'effectivePolicyValues' => [
'availabilitySlo' => [
'policyName' => '<string>',
'source' => 'SELF|CROSS_ACCOUNT',
'value' => <float>,
],
'dataRecoveryTimeBetweenBackups' => [
'policyName' => '<string>',
'source' => 'SELF|CROSS_ACCOUNT',
'value' => <integer>,
],
'multiAzDrApproach' => [
'policyName' => '<string>',
'source' => 'SELF|CROSS_ACCOUNT',
'value' => '<string>',
],
'multiAzRpo' => [
'policyName' => '<string>',
'source' => 'SELF|CROSS_ACCOUNT',
'value' => <integer>,
],
'multiAzRto' => [
'policyName' => '<string>',
'source' => 'SELF|CROSS_ACCOUNT',
'value' => <integer>,
],
'multiRegionDrApproach' => [
'policyName' => '<string>',
'source' => 'SELF|CROSS_ACCOUNT',
'value' => '<string>',
],
'multiRegionRpo' => [
'policyName' => '<string>',
'source' => 'SELF|CROSS_ACCOUNT',
'value' => <integer>,
],
'multiRegionRto' => [
'policyName' => '<string>',
'source' => 'SELF|CROSS_ACCOUNT',
'value' => <integer>,
],
],
'estimatedAssessmentCost' => [
'amount' => <float>,
'currency' => 'USD',
],
'kmsKeyId' => '<string>',
'name' => '<string>',
'openFindingsCount' => <integer>,
'organizationId' => '<string>',
'ouId' => '<string>',
'permissionModel' => [
'crossAccountRoles' => [
[
'crossAccountRoleArn' => '<string>',
'externalId' => '<string>',
],
// ...
],
'invokerRoleName' => '<string>',
],
'policyArn' => '<string>',
'regions' => ['<string>', ...],
'reportConfiguration' => [
'reportOutputs' => [
[
's3' => [
'bucketOwner' => '<string>',
'bucketPath' => '<string>',
],
],
// ...
],
],
'rerunAssessment' => true || false,
'resolvedFindingsCount' => <integer>,
'resourceDiscovery' => [
'errorCode' => 'INVALID_PERMISSIONS|STACK_NOT_FOUND|CLUSTER_NOT_FOUND|STATE_FILE_NOT_FOUND|ACCESS_DENIED|UNSUPPORTED_CLUSTER|INTERNAL_ERROR',
'errorMessage' => '<string>',
'lastRunAt' => <DateTime>,
'status' => 'RUNNING|SUCCEEDED|FAILED|COMPLETED_WITH_FAILURES|NOT_STARTED',
],
'serviceArn' => '<string>',
'tags' => ['<string>', ...],
'updatedAt' => <DateTime>,
],
]
Result Details
Members
- service
-
- Required: Yes
- Type: Service structure
The imported service.
Errors
- InternalServerException:
Internal service error.
- ResourceNotFoundException:
Resource not found.
- ValidationException:
Validation error — invalid input parameters.
- ConflictException:
Conflict — resource already exists.
- AccessDeniedException:
Access denied — caller lacks required permissions.
ImportPolicy
$result = $client->importPolicy([/* ... */]); $promise = $client->importPolicyAsync([/* ... */]);
Imports a V1 policy into V2, mapping RTO/RPO values from V1 scenarios.
Parameter Syntax
$result = $client->importPolicy([
'availabilitySlo' => [
'target' => <float>,
],
'clientToken' => '<string>',
'kmsKeyId' => '<string>',
'multiAzDisasterRecoveryApproach' => 'ACTIVE_ACTIVE|HOT_STANDBY|WARM_STANDBY|PILOT_LIGHT|BACKUP_AND_RESTORE',
'multiRegionDisasterRecoveryApproach' => 'ACTIVE_ACTIVE|HOT_STANDBY|WARM_STANDBY|PILOT_LIGHT|BACKUP_AND_RESTORE',
'tags' => ['<string>', ...],
'v1PolicyArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- availabilitySlo
-
- Type: AvailabilitySlo structure
The availability SLO to set on the imported policy.
- clientToken
-
- Type: string
Idempotency token.
- kmsKeyId
-
- Type: string
KMS key identifier — accepts key ID, key ARN, alias name, or alias ARN.
- multiAzDisasterRecoveryApproach
-
- Type: string
The multi-AZ disaster recovery approach for the imported policy.
- multiRegionDisasterRecoveryApproach
-
- Type: string
The multi-Region disaster recovery approach for the imported policy.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Resource tags.
- v1PolicyArn
-
- Required: Yes
- Type: string
ARN identifier.
Result Syntax
[
'policy' => [
'associatedServiceCount' => <integer>,
'availabilitySlo' => [
'target' => <float>,
],
'createdAt' => <DateTime>,
'dataRecovery' => [
'timeBetweenBackupsInMinutes' => <integer>,
],
'description' => '<string>',
'kmsKeyId' => '<string>',
'multiAz' => [
'disasterRecoveryApproach' => 'ACTIVE_ACTIVE|HOT_STANDBY|WARM_STANDBY|PILOT_LIGHT|BACKUP_AND_RESTORE',
'rpoInMinutes' => <integer>,
'rtoInMinutes' => <integer>,
],
'multiRegion' => [
'disasterRecoveryApproach' => 'ACTIVE_ACTIVE|HOT_STANDBY|WARM_STANDBY|PILOT_LIGHT|BACKUP_AND_RESTORE',
'rpoInMinutes' => <integer>,
'rtoInMinutes' => <integer>,
],
'name' => '<string>',
'policyArn' => '<string>',
'tags' => ['<string>', ...],
'updatedAt' => <DateTime>,
],
]
Result Details
Members
- policy
-
- Required: Yes
- Type: Policy structure
The imported policy.
Errors
- InternalServerException:
Internal service error.
- ResourceNotFoundException:
Resource not found.
- ValidationException:
Validation error — invalid input parameters.
- ConflictException:
Conflict — resource already exists.
- AccessDeniedException:
Access denied — caller lacks required permissions.
ListAssertions
$result = $client->listAssertions([/* ... */]); $promise = $client->listAssertionsAsync([/* ... */]);
Lists resilience assertions for a service.
Parameter Syntax
$result = $client->listAssertions([
'maxResults' => <integer>,
'nextToken' => '<string>',
'serviceArn' => '<string>', // REQUIRED
'source' => 'AI_GENERATED|USER',
]);
Parameter Details
Members
- maxResults
-
- Type: int
Pagination page size.
- nextToken
-
- Type: string
Pagination token.
- serviceArn
-
- Required: Yes
- Type: string
ARN identifier.
- source
-
- Type: string
Filter assertions by source type.
Result Syntax
[
'assertions' => [
[
'assertionId' => '<string>',
'createdAt' => <DateTime>,
'serviceArn' => '<string>',
'source' => 'AI_GENERATED|USER',
'text' => '<string>',
'updatedAt' => <DateTime>,
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- assertions
-
- Required: Yes
- Type: Array of Assertion structures
The list of assertions.
- nextToken
-
- Type: string
Pagination token.
Errors
- InternalServerException:
Internal service error.
- ResourceNotFoundException:
Resource not found.
- ValidationException:
Validation error — invalid input parameters.
- AccessDeniedException:
Access denied — caller lacks required permissions.
ListDependencies
$result = $client->listDependencies([/* ... */]); $promise = $client->listDependenciesAsync([/* ... */]);
Lists dependencies discovered for services.
Parameter Syntax
$result = $client->listDependencies([
'maxResults' => <integer>,
'nextToken' => '<string>',
'queryRangeEndTime' => <integer || string || DateTime>,
'queryRangeGranularity' => 'HOURLY|DAILY',
'queryRangeStartTime' => <integer || string || DateTime>,
'serviceArn' => '<string>',
]);
Parameter Details
Members
- maxResults
-
- Type: int
Pagination page size.
- nextToken
-
- Type: string
Pagination token.
- queryRangeEndTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The end time for the dependency query range.
- queryRangeGranularity
-
- Type: string
The granularity for the dependency query range.
- queryRangeStartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The start time for the dependency query range.
- serviceArn
-
- Type: string
ARN identifier.
Result Syntax
[
'dependencySummaries' => [
[
'comment' => '<string>',
'criticality' => 'HARD|SOFT|UNKNOWN',
'dependencyId' => '<string>',
'dependencyName' => '<string>',
'dnsName' => '<string>',
'lastDetectedTime' => <DateTime>,
'location' => '<string>',
'provider' => '<string>',
'queryRange' => [
'dataPoints' => [
[
'queryCount' => <integer>,
'timestamp' => <DateTime>,
],
// ...
],
'endTime' => <DateTime>,
'granularity' => 'HOURLY|DAILY',
'startTime' => <DateTime>,
],
'serviceArn' => '<string>',
'sourceRegions' => ['<string>', ...],
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- dependencySummaries
-
- Required: Yes
- Type: Array of DependencySummary structures
The list of dependency summaries.
- nextToken
-
- Type: string
Pagination token.
Errors
- InternalServerException:
Internal service error.
- ResourceNotFoundException:
Resource not found.
- ValidationException:
Validation error — invalid input parameters.
- AccessDeniedException:
Access denied — caller lacks required permissions.
ListFailureModeAssessments
$result = $client->listFailureModeAssessments([/* ... */]); $promise = $client->listFailureModeAssessmentsAsync([/* ... */]);
Lists failure mode assessments.
Parameter Syntax
$result = $client->listFailureModeAssessments([
'maxResults' => <integer>,
'nextToken' => '<string>',
'serviceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- maxResults
-
- Type: int
Pagination page size.
- nextToken
-
- Type: string
Pagination token.
- serviceArn
-
- Required: Yes
- Type: string
ARN identifier.
Result Syntax
[
'assessmentSummaries' => [
[
'achievability' => [
'availabilitySlo' => 'ACHIEVABLE|NOT_ACHIEVABLE',
'multiAzRtoRpo' => 'ACHIEVABLE|NOT_ACHIEVABLE',
'multiRegionRtoRpo' => 'ACHIEVABLE|NOT_ACHIEVABLE',
],
'assessmentCost' => [
'amount' => <float>,
'currency' => 'USD',
],
'assessmentId' => '<string>',
'assessmentStatus' => 'NOT_STARTED|PENDING|IN_PROGRESS|FAILED|SUCCESS',
'assessmentStep' => 'TOPOLOGY_ENHANCEMENT|SERVICE_FUNCTION_GENERATION|RESILIENCE_ASSESSMENT',
'billableAssessmentUnitCount' => <integer>,
'endedAt' => <DateTime>,
'errorCode' => 'INVALID_PERMISSIONS|CMK_ACCESS_DENIED|AGENT_ERROR|INTERNAL_ERROR|DESIGN_FILE_ACCESS_DENIED',
'errorMessage' => '<string>',
'serviceArn' => '<string>',
'startedAt' => <DateTime>,
'totalFindings' => <integer>,
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- assessmentSummaries
-
- Required: Yes
- Type: Array of AssessmentSummary structures
The list of assessment summaries.
- nextToken
-
- Type: string
Pagination token.
Errors
- InternalServerException:
Internal service error.
- ResourceNotFoundException:
Resource not found.
- ValidationException:
Validation error — invalid input parameters.
- AccessDeniedException:
Access denied — caller lacks required permissions.
ListFailureModeFindings
$result = $client->listFailureModeFindings([/* ... */]); $promise = $client->listFailureModeFindingsAsync([/* ... */]);
List findings.
Parameter Syntax
$result = $client->listFailureModeFindings([
'failureCategory' => 'SHARED_FATE|EXCESSIVE_LOAD|EXCESSIVE_LATENCY|MISCONFIGURATION_AND_BUGS|SINGLE_POINT_OF_FAILURE',
'maxResults' => <integer>,
'nextToken' => '<string>',
'serviceArn' => '<string>', // REQUIRED
'severity' => 'LOW|MEDIUM|HIGH',
'status' => 'OPEN|RESOLVED|IRRELEVANT',
]);
Parameter Details
Members
- failureCategory
-
- Type: string
Filter findings by failure category.
- maxResults
-
- Type: int
Pagination page size.
- nextToken
-
- Type: string
Pagination token.
- serviceArn
-
- Required: Yes
- Type: string
ARN identifier.
- severity
-
- Type: string
Filter findings by severity.
- status
-
- Type: string
Filter findings by status.
Result Syntax
[
'findingsSummary' => [
[
'description' => '<string>',
'failureCategory' => 'SHARED_FATE|EXCESSIVE_LOAD|EXCESSIVE_LATENCY|MISCONFIGURATION_AND_BUGS|SINGLE_POINT_OF_FAILURE',
'findingId' => '<string>',
'name' => '<string>',
'policyComponent' => 'AVAILABILITY_SLO|MULTI_AZ_DISASTER_RECOVERY|MULTI_REGION_DISASTER_RECOVERY|DATA_RECOVERY',
'serviceArn' => '<string>',
'severity' => 'LOW|MEDIUM|HIGH',
'status' => 'OPEN|RESOLVED|IRRELEVANT',
'updatedAt' => <DateTime>,
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- findingsSummary
-
- Required: Yes
- Type: Array of FindingSummary structures
The list of finding summaries.
- nextToken
-
- Type: string
Pagination token.
Errors
- ResourceNotFoundException:
Resource not found.
- InternalServerException:
Internal service error.
- ValidationException:
Validation error — invalid input parameters.
- AccessDeniedException:
Access denied — caller lacks required permissions.
ListInputSources
$result = $client->listInputSources([/* ... */]); $promise = $client->listInputSourcesAsync([/* ... */]);
Lists input sources for a service.
Parameter Syntax
$result = $client->listInputSources([
'maxResults' => <integer>,
'nextToken' => '<string>',
'serviceArn' => '<string>', // REQUIRED
'type' => 'CFN_STACK|TAGS|EKS|TERRAFORM|DESIGN_FILE|MONITORING',
]);
Parameter Details
Members
- maxResults
-
- Type: int
Pagination page size.
- nextToken
-
- Type: string
Pagination token.
- serviceArn
-
- Required: Yes
- Type: string
ARN identifier.
- type
-
- Type: string
Filter input sources by type.
Result Syntax
[
'inputSourceSummaries' => [
[
'cfnStackArn' => '<string>',
'createdAt' => <DateTime>,
'designFileS3Url' => '<string>',
'eks' => [
'clusterArn' => '<string>',
'namespaces' => ['<string>', ...],
],
'inputSourceId' => '<string>',
'resourceTags' => [
[
'key' => '<string>',
'values' => ['<string>', ...],
],
// ...
],
'tfStateFileUrl' => '<string>',
'type' => 'CFN_STACK|TAGS|EKS|TERRAFORM|DESIGN_FILE|MONITORING',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- inputSourceSummaries
-
- Required: Yes
- Type: Array of InputSourceSummary structures
The list of input source summaries.
- nextToken
-
- Type: string
Pagination token.
Errors
- InternalServerException:
Internal service error.
- ResourceNotFoundException:
Resource not found.
- ValidationException:
Validation error — invalid input parameters.
- AccessDeniedException:
Access denied — caller lacks required permissions.
ListPolicies
$result = $client->listPolicies([/* ... */]); $promise = $client->listPoliciesAsync([/* ... */]);
Lists resilience policies.
Parameter Syntax
$result = $client->listPolicies([
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- maxResults
-
- Type: int
Pagination page size.
- nextToken
-
- Type: string
Pagination token.
Result Syntax
[
'nextToken' => '<string>',
'policySummaries' => [
[
'associatedServiceCount' => <integer>,
'availabilitySlo' => [
'target' => <float>,
],
'createdAt' => <DateTime>,
'dataRecovery' => [
'timeBetweenBackupsInMinutes' => <integer>,
],
'multiAz' => [
'disasterRecoveryApproach' => 'ACTIVE_ACTIVE|HOT_STANDBY|WARM_STANDBY|PILOT_LIGHT|BACKUP_AND_RESTORE',
'rpoInMinutes' => <integer>,
'rtoInMinutes' => <integer>,
],
'multiRegion' => [
'disasterRecoveryApproach' => 'ACTIVE_ACTIVE|HOT_STANDBY|WARM_STANDBY|PILOT_LIGHT|BACKUP_AND_RESTORE',
'rpoInMinutes' => <integer>,
'rtoInMinutes' => <integer>,
],
'name' => '<string>',
'policyArn' => '<string>',
'updatedAt' => <DateTime>,
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
Pagination token.
- policySummaries
-
- Required: Yes
- Type: Array of PolicySummary structures
The list of policy summaries.
Errors
- InternalServerException:
Internal service error.
- ValidationException:
Validation error — invalid input parameters.
- AccessDeniedException:
Access denied — caller lacks required permissions.
ListReports
$result = $client->listReports([/* ... */]); $promise = $client->listReportsAsync([/* ... */]);
List reports for a service, or all reports owned by the account if serviceArn is not provided.
Parameter Syntax
$result = $client->listReports([
'maxResults' => <integer>,
'nextToken' => '<string>',
'reportType' => 'FAILURE_MODE',
'serviceArn' => '<string>',
]);
Parameter Details
Members
- maxResults
-
- Type: int
Pagination page size.
- nextToken
-
- Type: string
Pagination token.
- reportType
-
- Type: string
Filter reports by type.
- serviceArn
-
- Type: string
Optional. If not provided, lists all reports owned by the account.
Result Syntax
[
'nextToken' => '<string>',
'reportGenerationResults' => [
[
'assessmentId' => '<string>',
'createdAt' => <DateTime>,
'reportOutput' => [
'failedReportOutput' => [
'errorCode' => 'INSUFFICIENT_PERMISSIONS|CONFIGURATION_ERROR|INTERNAL_ERROR',
'errorMessage' => '<string>',
],
's3ReportOutput' => [
's3ObjectKey' => '<string>',
],
],
'reportType' => 'FAILURE_MODE',
'serviceArn' => '<string>',
'status' => 'PENDING|SUCCEEDED|FAILED',
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
Pagination token.
- reportGenerationResults
-
- Required: Yes
- Type: Array of ReportGenerationResult structures
The list of report generation results.
Errors
- InternalServerException:
Internal service error.
- ResourceNotFoundException:
Resource not found.
- ValidationException:
Validation error — invalid input parameters.
- ThrottlingException:
Too many requests — rate limit exceeded.
- AccessDeniedException:
Access denied — caller lacks required permissions.
ListResources
$result = $client->listResources([/* ... */]); $promise = $client->listResourcesAsync([/* ... */]);
List resources.
Parameter Syntax
$result = $client->listResources([
'awsRegion' => '<string>',
'maxResults' => <integer>,
'nextToken' => '<string>',
'serviceArn' => '<string>', // REQUIRED
'serviceFunctionId' => '<string>',
]);
Parameter Details
Members
- awsRegion
-
- Type: string
Filter resources by AWS Region.
- maxResults
-
- Type: int
Pagination page size.
- nextToken
-
- Type: string
Pagination token.
- serviceArn
-
- Required: Yes
- Type: string
ARN identifier.
- serviceFunctionId
-
- Type: string
Filter resources by service function identifier.
Result Syntax
[
'nextToken' => '<string>',
'serviceFunctionId' => '<string>',
'serviceResources' => [
[
'inputSource' => [
'identifier' => '<string>',
'type' => 'CFN_STACK|TAGS|EKS|TERRAFORM|DESIGN_FILE|MONITORING',
],
'resource' => [
'awsAccountId' => '<string>',
'awsRegion' => '<string>',
'identifier' => '<string>',
'resourceType' => '<string>',
],
'resourceIdentifier' => '<string>',
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
Pagination token.
- serviceFunctionId
-
- Type: string
The service function identifier for the returned resources.
- serviceResources
-
- Type: Array of ServiceResource structures
The list of service resources.
Errors
- InternalServerException:
Internal service error.
- ResourceNotFoundException:
Resource not found.
- ValidationException:
Validation error — invalid input parameters.
- AccessDeniedException:
Access denied — caller lacks required permissions.
ListServiceEvents
$result = $client->listServiceEvents([/* ... */]); $promise = $client->listServiceEventsAsync([/* ... */]);
Lists events for a service.
Parameter Syntax
$result = $client->listServiceEvents([
'endTime' => <integer || string || DateTime>,
'eventTypes' => ['<string>', ...],
'maxResults' => <integer>,
'nextToken' => '<string>',
'serviceArn' => '<string>', // REQUIRED
'startTime' => <integer || string || DateTime>,
]);
Parameter Details
Members
- endTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The end time for filtering events.
- eventTypes
-
- Type: Array of strings
Filter events by type.
- maxResults
-
- Type: int
Pagination page size.
- nextToken
-
- Type: string
Pagination token.
- serviceArn
-
- Required: Yes
- Type: string
ARN identifier.
- startTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The start time for filtering events.
Result Syntax
[
'events' => [
[
'actor' => [
'accountId' => '<string>',
'principalId' => '<string>',
'type' => 'USER|SYSTEM',
'userName' => '<string>',
],
'eventDetails' => [
'description' => '<string>',
'eventMetadata' => [
'assertionCreated' => [
'assertionId' => '<string>',
'assertionName' => '<string>',
],
'assertionDeleted' => [
'assertionId' => '<string>',
'assertionName' => '<string>',
],
'assertionUpdated' => [
'assertionId' => '<string>',
'assertionName' => '<string>',
],
'serviceAchievabilityUpdated' => [
'assessmentId' => '<string>',
'availabilitySlo' => '<string>',
'multiAzRtoRpo' => '<string>',
'multiRegionRtoRpo' => '<string>',
],
'serviceCreated' => [
],
'serviceDeleted' => [
],
'serviceFunctionCreated' => [
'serviceFunctionId' => '<string>',
'serviceFunctionName' => '<string>',
],
'serviceFunctionDeleted' => [
'serviceFunctionId' => '<string>',
'serviceFunctionName' => '<string>',
],
'serviceFunctionResourcesAdded' => [
'resourcesAdded' => ['<string>', ...],
'serviceFunctionId' => '<string>',
'serviceFunctionName' => '<string>',
],
'serviceFunctionResourcesRemoved' => [
'resourcesRemoved' => ['<string>', ...],
'serviceFunctionId' => '<string>',
'serviceFunctionName' => '<string>',
],
'serviceFunctionUpdated' => [
'resourcesAdded' => ['<string>', ...],
'resourcesRemoved' => ['<string>', ...],
'serviceFunctionId' => '<string>',
'serviceFunctionName' => '<string>',
],
'serviceInputSourcesUpdated' => [
],
'servicePolicyAssociated' => [
'policyArn' => '<string>',
'policyName' => '<string>',
],
'servicePolicyDisassociated' => [
'policyArn' => '<string>',
'policyName' => '<string>',
],
'serviceResourcesAssociated' => [
'resourceCount' => <integer>,
'resourceTypes' => ['<string>', ...],
],
'serviceResourcesDisassociated' => [
'resourceCount' => <integer>,
'resourceTypes' => ['<string>', ...],
],
'serviceSystemAssociated' => [
'systemArn' => '<string>',
'systemName' => '<string>',
],
'serviceSystemDisassociated' => [
'systemArn' => '<string>',
'systemId' => '<string>',
'systemName' => '<string>',
],
'serviceWorkflowUpdated' => [
'serviceFunctionId' => '<string>',
'serviceFunctionName' => '<string>',
],
],
'title' => '<string>',
],
'eventId' => '<string>',
'eventType' => 'SERVICE_CREATED|SERVICE_DELETED|SERVICE_SYSTEM_ASSOCIATED|SERVICE_SYSTEM_DISASSOCIATED|SERVICE_RESOURCES_ASSOCIATED|SERVICE_RESOURCES_DISASSOCIATED|SERVICE_WORKFLOW_UPDATED|SERVICE_INPUT_SOURCES_UPDATED|SERVICE_POLICY_ASSOCIATED|SERVICE_POLICY_DISASSOCIATED|SERVICE_FUNCTION_CREATED|SERVICE_FUNCTION_UPDATED|SERVICE_FUNCTION_DELETED|SERVICE_FUNCTION_RESOURCES_ADDED|SERVICE_FUNCTION_RESOURCES_REMOVED|SERVICE_ACHIEVABILITY_UPDATED|ASSERTION_CREATED|ASSERTION_UPDATED|ASSERTION_DELETED',
'serviceArn' => '<string>',
'timestamp' => <DateTime>,
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- events
-
- Required: Yes
- Type: Array of ServiceEvent structures
The list of service events.
- nextToken
-
- Type: string
Pagination token.
Errors
- InternalServerException:
Internal service error.
- ResourceNotFoundException:
Resource not found.
- ValidationException:
Validation error — invalid input parameters.
- AccessDeniedException:
Access denied — caller lacks required permissions.
ListServiceFunctions
$result = $client->listServiceFunctions([/* ... */]); $promise = $client->listServiceFunctionsAsync([/* ... */]);
Lists service functions for a service.
Parameter Syntax
$result = $client->listServiceFunctions([
'maxResults' => <integer>,
'nextToken' => '<string>',
'serviceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- maxResults
-
- Type: int
Pagination page size.
- nextToken
-
- Type: string
Pagination token.
- serviceArn
-
- Required: Yes
- Type: string
ARN identifier.
Result Syntax
[
'nextToken' => '<string>',
'serviceFunctions' => [
[
'createdAt' => <DateTime>,
'criticality' => 'PRIMARY|SUPPLEMENTAL',
'description' => '<string>',
'name' => '<string>',
'resourceCount' => <integer>,
'serviceArn' => '<string>',
'serviceFunctionId' => '<string>',
'source' => 'AI_GENERATED|USER',
'updatedAt' => <DateTime>,
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
Pagination token.
- serviceFunctions
-
- Required: Yes
- Type: Array of ServiceFunction structures
The list of service functions.
Errors
- InternalServerException:
Internal service error.
- ResourceNotFoundException:
Resource not found.
- ValidationException:
Validation error — invalid input parameters.
- AccessDeniedException:
Access denied — caller lacks required permissions.
ListServiceTopologyEdges
$result = $client->listServiceTopologyEdges([/* ... */]); $promise = $client->listServiceTopologyEdgesAsync([/* ... */]);
Lists topology edges for a service.
Parameter Syntax
$result = $client->listServiceTopologyEdges([
'maxResults' => <integer>,
'nextToken' => '<string>',
'serviceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- maxResults
-
- Type: int
Pagination page size.
- nextToken
-
- Type: string
Pagination token.
- serviceArn
-
- Required: Yes
- Type: string
ARN identifier.
Result Syntax
[
'nextToken' => '<string>',
'serviceTopologyEdgeSummaries' => [
[
'destinationResourceIdentifier' => '<string>',
'properties' => [
[
'label' => '<string>',
'topologyType' => 'CONTAINMENT|DATA_FLOW|OBSERVABILITY|PERMISSIONS',
],
// ...
],
'sourceResourceIdentifier' => '<string>',
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
Pagination token.
- serviceTopologyEdgeSummaries
-
- Type: Array of ServiceTopologyEdgeSummary structures
The list of service topology edge summaries.
Errors
- InternalServerException:
Internal service error.
- ValidationException:
Validation error — invalid input parameters.
- AccessDeniedException:
Access denied — caller lacks required permissions.
ListServices
$result = $client->listServices([/* ... */]); $promise = $client->listServicesAsync([/* ... */]);
Lists services.
Parameter Syntax
$result = $client->listServices([
'accountId' => '<string>',
'assessmentStatus' => 'NOT_STARTED|PENDING|IN_PROGRESS|FAILED|SUCCESS',
'maxResults' => <integer>,
'nextToken' => '<string>',
'ouId' => '<string>',
'policyArn' => '<string>',
'systemArn' => '<string>',
'userJourneyId' => '<string>',
]);
Parameter Details
Members
- accountId
-
- Type: string
Filter services by AWS account ID.
- assessmentStatus
-
- Type: string
Filter services by assessment status.
- maxResults
-
- Type: int
Pagination page size.
- nextToken
-
- Type: string
Pagination token.
- ouId
-
- Type: string
Filter services by organizational unit (OU) identifier.
- policyArn
-
- Type: string
ARN identifier.
- systemArn
-
- Type: string
ARN identifier.
- userJourneyId
-
- Type: string
Filter services by user journey identifier.
Result Syntax
[
'nextToken' => '<string>',
'serviceSummaries' => [
[
'accountId' => '<string>',
'achievability' => [
'availabilitySlo' => 'ACHIEVABLE|NOT_ACHIEVABLE',
'multiAzRtoRpo' => 'ACHIEVABLE|NOT_ACHIEVABLE',
'multiRegionRtoRpo' => 'ACHIEVABLE|NOT_ACHIEVABLE',
],
'assessmentStatus' => 'NOT_STARTED|PENDING|IN_PROGRESS|FAILED|SUCCESS',
'associatedSystems' => [
[
'systemArn' => '<string>',
'systemName' => '<string>',
'userJourneyIds' => ['<string>', ...],
],
// ...
],
'createdAt' => <DateTime>,
'dependencyDiscovery' => [
'status' => 'ENABLED|INITIALIZING|DISABLED',
'updatedAt' => <DateTime>,
],
'name' => '<string>',
'openFindingsCount' => <integer>,
'organizationId' => '<string>',
'ouId' => '<string>',
'policyArn' => '<string>',
'regions' => ['<string>', ...],
'resolvedFindingsCount' => <integer>,
'serviceArn' => '<string>',
'updatedAt' => <DateTime>,
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
Pagination token.
- serviceSummaries
-
- Required: Yes
- Type: Array of ServiceSummary structures
The list of service summaries.
Errors
- InternalServerException:
Internal service error.
- ValidationException:
Validation error — invalid input parameters.
- AccessDeniedException:
Access denied — caller lacks required permissions.
ListSystemEvents
$result = $client->listSystemEvents([/* ... */]); $promise = $client->listSystemEventsAsync([/* ... */]);
Lists events for a system.
Parameter Syntax
$result = $client->listSystemEvents([
'endTime' => <integer || string || DateTime>,
'eventTypes' => ['<string>', ...],
'maxResults' => <integer>,
'nextToken' => '<string>',
'startTime' => <integer || string || DateTime>,
'systemArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- endTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The end time for filtering events.
- eventTypes
-
- Type: Array of strings
Filter events by type.
- maxResults
-
- Type: int
Pagination page size.
- nextToken
-
- Type: string
Pagination token.
- startTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The start time for filtering events.
- systemArn
-
- Required: Yes
- Type: string
ARN identifier.
Result Syntax
[
'events' => [
[
'actor' => [
'accountId' => '<string>',
'principalId' => '<string>',
'type' => 'USER|SYSTEM',
'userName' => '<string>',
],
'eventDetails' => [
'description' => '<string>',
'eventMetadata' => [
'systemCreated' => [
],
'systemDeleted' => [
],
'systemPolicyAssociated' => [
'policyArn' => '<string>',
'policyName' => '<string>',
],
'systemPolicyDisassociated' => [
'policyArn' => '<string>',
'policyName' => '<string>',
],
'systemServiceAssociated' => [
'serviceArn' => '<string>',
'serviceName' => '<string>',
'userJourneys' => ['<string>', ...],
],
'systemServiceDisassociated' => [
'comment' => '<string>',
'serviceArn' => '<string>',
'serviceName' => '<string>',
'userJourneysAffected' => ['<string>', ...],
],
'systemUserJourneyCreated' => [
'associatedServices' => [
[
'serviceId' => '<string>',
'serviceName' => '<string>',
],
// ...
],
'userJourneyName' => '<string>',
],
'systemUserJourneyDeleted' => [
'associatedServicesAtDeletion' => [
[
'serviceId' => '<string>',
'serviceName' => '<string>',
],
// ...
],
'userJourneyName' => '<string>',
],
'systemUserJourneyUpdated' => [
'changes' => [
'associatedServices' => [
'added' => [
[
'serviceId' => '<string>',
'serviceName' => '<string>',
],
// ...
],
'removed' => [
[
'serviceId' => '<string>',
'serviceName' => '<string>',
],
// ...
],
],
'journeyDescription' => [
'newValue' => '<string>',
'oldValue' => '<string>',
],
],
'userJourneyName' => '<string>',
],
],
'title' => '<string>',
],
'eventId' => '<string>',
'eventType' => 'SYSTEM_CREATED|SYSTEM_DELETED|SYSTEM_USER_JOURNEY_CREATED|SYSTEM_USER_JOURNEY_UPDATED|SYSTEM_USER_JOURNEY_DELETED|SYSTEM_SERVICE_ASSOCIATED|SYSTEM_SERVICE_DISASSOCIATED|SYSTEM_POLICY_ASSOCIATED|SYSTEM_POLICY_DISASSOCIATED',
'systemArn' => '<string>',
'timestamp' => <DateTime>,
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- events
-
- Required: Yes
- Type: Array of SystemEvent structures
The list of system events.
- nextToken
-
- Type: string
Pagination token.
Errors
- InternalServerException:
Internal service error.
- ResourceNotFoundException:
Resource not found.
- ValidationException:
Validation error — invalid input parameters.
- AccessDeniedException:
Access denied — caller lacks required permissions.
ListSystems
$result = $client->listSystems([/* ... */]); $promise = $client->listSystemsAsync([/* ... */]);
Lists systems.
Parameter Syntax
$result = $client->listSystems([
'maxResults' => <integer>,
'nextToken' => '<string>',
'ouId' => '<string>',
]);
Parameter Details
Members
- maxResults
-
- Type: int
Pagination page size.
- nextToken
-
- Type: string
Pagination token.
- ouId
-
- Type: string
Filter systems by organizational unit (OU) identifier.
Result Syntax
[
'nextToken' => '<string>',
'systemSummaries' => [
[
'createdAt' => <DateTime>,
'name' => '<string>',
'organizationId' => '<string>',
'ouId' => '<string>',
'servicesCount' => <integer>,
'systemArn' => '<string>',
'systemId' => '<string>',
'updatedAt' => <DateTime>,
'userJourneysCount' => <integer>,
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
Pagination token.
- systemSummaries
-
- Required: Yes
- Type: Array of SystemSummary structures
The list of system summaries.
Errors
- InternalServerException:
Internal service error.
- ValidationException:
Validation error — invalid input parameters.
- AccessDeniedException:
Access denied — caller lacks required permissions.
ListTagsForResource
$result = $client->listTagsForResource([/* ... */]); $promise = $client->listTagsForResourceAsync([/* ... */]);
Lists the tags for a resource.
Parameter Syntax
$result = $client->listTagsForResource([
'resourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
ARN identifier.
Result Syntax
[
'tags' => ['<string>', ...],
]
Result Details
Members
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Resource tags.
Errors
- InternalServerException:
Internal service error.
- ResourceNotFoundException:
Resource not found.
- ValidationException:
Validation error — invalid input parameters.
- ThrottlingException:
Too many requests — rate limit exceeded.
- AccessDeniedException:
Access denied — caller lacks required permissions.
ListUserJourneys
$result = $client->listUserJourneys([/* ... */]); $promise = $client->listUserJourneysAsync([/* ... */]);
Lists user journeys for a system.
Parameter Syntax
$result = $client->listUserJourneys([
'maxResults' => <integer>,
'nextToken' => '<string>',
'systemArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- maxResults
-
- Type: int
Pagination page size.
- nextToken
-
- Type: string
Pagination token.
- systemArn
-
- Required: Yes
- Type: string
ARN identifier.
Result Syntax
[
'nextToken' => '<string>',
'userJourneySummaries' => [
[
'createdAt' => <DateTime>,
'name' => '<string>',
'updatedAt' => <DateTime>,
'userJourneyId' => '<string>',
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
Pagination token.
- userJourneySummaries
-
- Required: Yes
- Type: Array of UserJourneySummary structures
The list of user journey summaries.
Errors
- InternalServerException:
Internal service error.
- ResourceNotFoundException:
Resource not found.
- ValidationException:
Validation error — invalid input parameters.
- AccessDeniedException:
Access denied — caller lacks required permissions.
StartFailureModeAssessment
$result = $client->startFailureModeAssessment([/* ... */]); $promise = $client->startFailureModeAssessmentAsync([/* ... */]);
Start a failure mode assessment.
Parameter Syntax
$result = $client->startFailureModeAssessment([
'clientToken' => '<string>',
'serviceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- clientToken
-
- Type: string
Idempotency token.
- serviceArn
-
- Required: Yes
- Type: string
ARN identifier.
Result Syntax
[
'assessmentId' => '<string>',
'assessmentStatus' => 'NOT_STARTED|PENDING|IN_PROGRESS|FAILED|SUCCESS',
'serviceArn' => '<string>',
'startedAt' => <DateTime>,
]
Result Details
Members
- assessmentId
-
- Type: string
The unique identifier of the started assessment.
- assessmentStatus
-
- Type: string
The status of the started assessment.
- serviceArn
-
- Type: string
ARN identifier.
- startedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the assessment started.
Errors
- InternalServerException:
Internal service error.
- ResourceNotFoundException:
Resource not found.
- ValidationException:
Validation error — invalid input parameters.
- ConflictException:
Conflict — resource already exists.
- ThrottlingException:
Too many requests — rate limit exceeded.
- AccessDeniedException:
Access denied — caller lacks required permissions.
TagResource
$result = $client->tagResource([/* ... */]); $promise = $client->tagResourceAsync([/* ... */]);
Adds tags to a resource.
Parameter Syntax
$result = $client->tagResource([
'resourceArn' => '<string>', // REQUIRED
'tags' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
ARN identifier.
- tags
-
- Required: Yes
- Type: Associative array of custom strings keys (TagKey) to strings
Resource tags.
Result Syntax
[]
Result Details
Errors
- InternalServerException:
Internal service error.
- ResourceNotFoundException:
Resource not found.
- ValidationException:
Validation error — invalid input parameters.
- ThrottlingException:
Too many requests — rate limit exceeded.
- AccessDeniedException:
Access denied — caller lacks required permissions.
UntagResource
$result = $client->untagResource([/* ... */]); $promise = $client->untagResourceAsync([/* ... */]);
Removes tags from a resource.
Parameter Syntax
$result = $client->untagResource([
'resourceArn' => '<string>', // REQUIRED
'tagKeys' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
ARN identifier.
- tagKeys
-
- Required: Yes
- Type: Array of strings
The tag keys to remove from the resource.
Result Syntax
[]
Result Details
Errors
- InternalServerException:
Internal service error.
- ResourceNotFoundException:
Resource not found.
- ValidationException:
Validation error — invalid input parameters.
- ThrottlingException:
Too many requests — rate limit exceeded.
- AccessDeniedException:
Access denied — caller lacks required permissions.
UpdateAssertion
$result = $client->updateAssertion([/* ... */]); $promise = $client->updateAssertionAsync([/* ... */]);
Updates a resilience assertion.
Parameter Syntax
$result = $client->updateAssertion([
'assertionId' => '<string>', // REQUIRED
'serviceArn' => '<string>', // REQUIRED
'text' => '<string>',
]);
Parameter Details
Members
- assertionId
-
- Required: Yes
- Type: string
The unique identifier of the assertion to update.
- serviceArn
-
- Required: Yes
- Type: string
ARN identifier.
- text
-
- Type: string
The updated text content of the assertion.
Result Syntax
[
'assertion' => [
'assertionId' => '<string>',
'createdAt' => <DateTime>,
'serviceArn' => '<string>',
'source' => 'AI_GENERATED|USER',
'text' => '<string>',
'updatedAt' => <DateTime>,
],
]
Result Details
Members
- assertion
-
- Required: Yes
- Type: Assertion structure
The updated assertion.
Errors
- InternalServerException:
Internal service error.
- ResourceNotFoundException:
Resource not found.
- ValidationException:
Validation error — invalid input parameters.
- ConflictException:
Conflict — resource already exists.
- AccessDeniedException:
Access denied — caller lacks required permissions.
UpdateDependency
$result = $client->updateDependency([/* ... */]); $promise = $client->updateDependencyAsync([/* ... */]);
Updates a dependency classification.
Parameter Syntax
$result = $client->updateDependency([
'comment' => '<string>',
'criticality' => 'HARD|SOFT|UNKNOWN',
'dependencyId' => '<string>', // REQUIRED
'serviceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- comment
-
- Type: string
A comment about the dependency.
- criticality
-
- Type: string
The updated criticality level of the dependency.
- dependencyId
-
- Required: Yes
- Type: string
The identifier of the dependency to update.
- serviceArn
-
- Required: Yes
- Type: string
ARN identifier.
Result Syntax
[
'comment' => '<string>',
'criticality' => 'HARD|SOFT|UNKNOWN',
'dependencyId' => '<string>',
'dependencyName' => '<string>',
'location' => '<string>',
'provider' => '<string>',
'updatedAt' => <DateTime>,
]
Result Details
Members
- comment
-
- Type: string
The comment about the dependency.
- criticality
-
- Required: Yes
- Type: string
The criticality level of the dependency.
- dependencyId
-
- Required: Yes
- Type: string
The identifier of the updated dependency.
- dependencyName
-
- Required: Yes
- Type: string
The name of the updated dependency.
- location
-
- Required: Yes
- Type: string
The location of the dependency.
- provider
-
- Type: string
The provider of the dependency.
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the dependency was updated.
Errors
- InternalServerException:
Internal service error.
- ResourceNotFoundException:
Resource not found.
- ValidationException:
Validation error — invalid input parameters.
- ConflictException:
Conflict — resource already exists.
- AccessDeniedException:
Access denied — caller lacks required permissions.
UpdateFailureModeFinding
$result = $client->updateFailureModeFinding([/* ... */]); $promise = $client->updateFailureModeFindingAsync([/* ... */]);
Updates an existing finding.
Parameter Syntax
$result = $client->updateFailureModeFinding([
'comment' => '<string>',
'findingId' => '<string>', // REQUIRED
'serviceArn' => '<string>', // REQUIRED
'status' => 'OPEN|RESOLVED|IRRELEVANT', // REQUIRED
]);
Parameter Details
Members
- comment
-
- Type: string
A comment about the finding update.
- findingId
-
- Required: Yes
- Type: string
The identifier of the finding to update.
- serviceArn
-
- Required: Yes
- Type: string
ARN identifier.
- status
-
- Required: Yes
- Type: string
The new status for the finding.
Result Syntax
[
'finding' => [
'comment' => '<string>',
'description' => '<string>',
'failureCategory' => 'SHARED_FATE|EXCESSIVE_LOAD|EXCESSIVE_LATENCY|MISCONFIGURATION_AND_BUGS|SINGLE_POINT_OF_FAILURE',
'findingId' => '<string>',
'infrastructureAndCodeRecommendations' => [
[
'suggestedChanges' => ['<string>', ...],
],
// ...
],
'name' => '<string>',
'observabilityRecommendations' => [
[
'suggestedChanges' => ['<string>', ...],
],
// ...
],
'policyComponent' => 'AVAILABILITY_SLO|MULTI_AZ_DISASTER_RECOVERY|MULTI_REGION_DISASTER_RECOVERY|DATA_RECOVERY',
'reasoning' => '<string>',
'serviceFunctions' => ['<string>', ...],
'severity' => 'LOW|MEDIUM|HIGH',
'status' => 'OPEN|RESOLVED|IRRELEVANT',
'testingRecommendations' => [
[
'suggestedChanges' => ['<string>', ...],
],
// ...
],
'updatedAt' => <DateTime>,
],
]
Result Details
Members
- finding
-
- Type: Finding structure
The updated finding.
Errors
- InternalServerException:
Internal service error.
- ResourceNotFoundException:
Resource not found.
- ValidationException:
Validation error — invalid input parameters.
- ConflictException:
Conflict — resource already exists.
- AccessDeniedException:
Access denied — caller lacks required permissions.
UpdatePolicy
$result = $client->updatePolicy([/* ... */]); $promise = $client->updatePolicyAsync([/* ... */]);
Updates an existing resilience policy.
Parameter Syntax
$result = $client->updatePolicy([
'availabilitySlo' => [
'target' => <float>,
],
'dataRecovery' => [
'timeBetweenBackupsInMinutes' => <integer>,
],
'description' => '<string>',
'multiAz' => [
'disasterRecoveryApproach' => 'ACTIVE_ACTIVE|HOT_STANDBY|WARM_STANDBY|PILOT_LIGHT|BACKUP_AND_RESTORE',
'rpoInMinutes' => <integer>,
'rtoInMinutes' => <integer>,
],
'multiRegion' => [
'disasterRecoveryApproach' => 'ACTIVE_ACTIVE|HOT_STANDBY|WARM_STANDBY|PILOT_LIGHT|BACKUP_AND_RESTORE',
'rpoInMinutes' => <integer>,
'rtoInMinutes' => <integer>,
],
'policyArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- availabilitySlo
-
- Type: AvailabilitySlo structure
The updated availability SLO for the policy.
- dataRecovery
-
- Type: DataRecoveryTargets structure
The updated data recovery targets for the policy.
- description
-
- Type: string
Resource description for services and policies.
- multiAz
-
- Type: MultiAzTargets structure
The updated multi-AZ disaster recovery targets for the policy.
- multiRegion
-
- Type: MultiRegionTargets structure
The updated multi-Region disaster recovery targets for the policy.
- policyArn
-
- Required: Yes
- Type: string
ARN identifier.
Result Syntax
[
'policy' => [
'associatedServiceCount' => <integer>,
'availabilitySlo' => [
'target' => <float>,
],
'createdAt' => <DateTime>,
'dataRecovery' => [
'timeBetweenBackupsInMinutes' => <integer>,
],
'description' => '<string>',
'kmsKeyId' => '<string>',
'multiAz' => [
'disasterRecoveryApproach' => 'ACTIVE_ACTIVE|HOT_STANDBY|WARM_STANDBY|PILOT_LIGHT|BACKUP_AND_RESTORE',
'rpoInMinutes' => <integer>,
'rtoInMinutes' => <integer>,
],
'multiRegion' => [
'disasterRecoveryApproach' => 'ACTIVE_ACTIVE|HOT_STANDBY|WARM_STANDBY|PILOT_LIGHT|BACKUP_AND_RESTORE',
'rpoInMinutes' => <integer>,
'rtoInMinutes' => <integer>,
],
'name' => '<string>',
'policyArn' => '<string>',
'tags' => ['<string>', ...],
'updatedAt' => <DateTime>,
],
]
Result Details
Members
- policy
-
- Required: Yes
- Type: Policy structure
The updated policy.
Errors
- InternalServerException:
Internal service error.
- ResourceNotFoundException:
Resource not found.
- ValidationException:
Validation error — invalid input parameters.
- ConflictException:
Conflict — resource already exists.
- AccessDeniedException:
Access denied — caller lacks required permissions.
UpdateService
$result = $client->updateService([/* ... */]); $promise = $client->updateServiceAsync([/* ... */]);
Updates an existing service.
Parameter Syntax
$result = $client->updateService([
'associatedSystems' => [
[
'systemArn' => '<string>', // REQUIRED
'systemName' => '<string>',
'userJourneyIds' => ['<string>', ...],
],
// ...
],
'dependencyDiscovery' => 'ENABLED|DISABLED',
'description' => '<string>',
'permissionModel' => [
'crossAccountRoles' => [
[
'crossAccountRoleArn' => '<string>', // REQUIRED
'externalId' => '<string>',
],
// ...
],
'invokerRoleName' => '<string>', // REQUIRED
],
'policyArn' => '<string>',
'regions' => ['<string>', ...],
'reportConfiguration' => [
'reportOutputs' => [ // REQUIRED
[
's3' => [
'bucketOwner' => '<string>', // REQUIRED
'bucketPath' => '<string>', // REQUIRED
],
],
// ...
],
],
'serviceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- associatedSystems
-
- Type: Array of AssociatedSystem structures
The updated systems to associate with the service.
- dependencyDiscovery
-
- Type: string
Caller-settable values for dependency discovery. INITIALIZING is system-managed.
- description
-
- Type: string
Resource description for services and policies.
- permissionModel
-
- Type: PermissionModel structure
The updated permission model for the service.
- policyArn
-
- Type: string
ARN identifier.
- regions
-
- Type: Array of strings
The updated AWS Regions where the service operates.
- reportConfiguration
-
- Type: ServiceReportConfiguration structure
Configuration for automatic report generation on a Service.
- serviceArn
-
- Required: Yes
- Type: string
ARN identifier.
Result Syntax
[
'service' => [
'accountId' => '<string>',
'achievability' => [
'availabilitySlo' => 'ACHIEVABLE|NOT_ACHIEVABLE',
'multiAzRtoRpo' => 'ACHIEVABLE|NOT_ACHIEVABLE',
'multiRegionRtoRpo' => 'ACHIEVABLE|NOT_ACHIEVABLE',
],
'assessmentStatus' => 'NOT_STARTED|PENDING|IN_PROGRESS|FAILED|SUCCESS',
'associatedSystems' => [
[
'systemArn' => '<string>',
'systemName' => '<string>',
'userJourneyIds' => ['<string>', ...],
],
// ...
],
'createdAt' => <DateTime>,
'dependencyDiscovery' => [
'status' => 'ENABLED|INITIALIZING|DISABLED',
'updatedAt' => <DateTime>,
],
'description' => '<string>',
'effectivePolicyValues' => [
'availabilitySlo' => [
'policyName' => '<string>',
'source' => 'SELF|CROSS_ACCOUNT',
'value' => <float>,
],
'dataRecoveryTimeBetweenBackups' => [
'policyName' => '<string>',
'source' => 'SELF|CROSS_ACCOUNT',
'value' => <integer>,
],
'multiAzDrApproach' => [
'policyName' => '<string>',
'source' => 'SELF|CROSS_ACCOUNT',
'value' => '<string>',
],
'multiAzRpo' => [
'policyName' => '<string>',
'source' => 'SELF|CROSS_ACCOUNT',
'value' => <integer>,
],
'multiAzRto' => [
'policyName' => '<string>',
'source' => 'SELF|CROSS_ACCOUNT',
'value' => <integer>,
],
'multiRegionDrApproach' => [
'policyName' => '<string>',
'source' => 'SELF|CROSS_ACCOUNT',
'value' => '<string>',
],
'multiRegionRpo' => [
'policyName' => '<string>',
'source' => 'SELF|CROSS_ACCOUNT',
'value' => <integer>,
],
'multiRegionRto' => [
'policyName' => '<string>',
'source' => 'SELF|CROSS_ACCOUNT',
'value' => <integer>,
],
],
'estimatedAssessmentCost' => [
'amount' => <float>,
'currency' => 'USD',
],
'kmsKeyId' => '<string>',
'name' => '<string>',
'openFindingsCount' => <integer>,
'organizationId' => '<string>',
'ouId' => '<string>',
'permissionModel' => [
'crossAccountRoles' => [
[
'crossAccountRoleArn' => '<string>',
'externalId' => '<string>',
],
// ...
],
'invokerRoleName' => '<string>',
],
'policyArn' => '<string>',
'regions' => ['<string>', ...],
'reportConfiguration' => [
'reportOutputs' => [
[
's3' => [
'bucketOwner' => '<string>',
'bucketPath' => '<string>',
],
],
// ...
],
],
'rerunAssessment' => true || false,
'resolvedFindingsCount' => <integer>,
'resourceDiscovery' => [
'errorCode' => 'INVALID_PERMISSIONS|STACK_NOT_FOUND|CLUSTER_NOT_FOUND|STATE_FILE_NOT_FOUND|ACCESS_DENIED|UNSUPPORTED_CLUSTER|INTERNAL_ERROR',
'errorMessage' => '<string>',
'lastRunAt' => <DateTime>,
'status' => 'RUNNING|SUCCEEDED|FAILED|COMPLETED_WITH_FAILURES|NOT_STARTED',
],
'serviceArn' => '<string>',
'tags' => ['<string>', ...],
'updatedAt' => <DateTime>,
],
]
Result Details
Members
- service
-
- Required: Yes
- Type: Service structure
The updated service.
Errors
- InternalServerException:
Internal service error.
- ResourceNotFoundException:
Resource not found.
- ValidationException:
Validation error — invalid input parameters.
- ConflictException:
Conflict — resource already exists.
- ServiceQuotaExceededException:
Service quota exceeded.
- AccessDeniedException:
Access denied — caller lacks required permissions.
UpdateServiceFunction
$result = $client->updateServiceFunction([/* ... */]); $promise = $client->updateServiceFunctionAsync([/* ... */]);
Updates a service function.
Parameter Syntax
$result = $client->updateServiceFunction([
'criticality' => 'PRIMARY|SUPPLEMENTAL',
'description' => '<string>',
'name' => '<string>',
'serviceArn' => '<string>', // REQUIRED
'serviceFunctionId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- criticality
-
- Type: string
The updated criticality level of the service function.
- description
-
- Type: string
Resource description.
- name
-
- Type: string
Entity label (not part of ARN — spaces allowed).
- serviceArn
-
- Required: Yes
- Type: string
ARN identifier.
- serviceFunctionId
-
- Required: Yes
- Type: string
The identifier of the service function to update.
Result Syntax
[
'serviceFunction' => [
'createdAt' => <DateTime>,
'criticality' => 'PRIMARY|SUPPLEMENTAL',
'description' => '<string>',
'name' => '<string>',
'resourceCount' => <integer>,
'serviceArn' => '<string>',
'serviceFunctionId' => '<string>',
'source' => 'AI_GENERATED|USER',
'updatedAt' => <DateTime>,
],
]
Result Details
Members
- serviceFunction
-
- Required: Yes
- Type: ServiceFunction structure
The updated service function.
Errors
- InternalServerException:
Internal service error.
- ResourceNotFoundException:
Resource not found.
- ValidationException:
Validation error — invalid input parameters.
- ConflictException:
Conflict — resource already exists.
- AccessDeniedException:
Access denied — caller lacks required permissions.
UpdateSystem
$result = $client->updateSystem([/* ... */]); $promise = $client->updateSystemAsync([/* ... */]);
Updates an existing system.
Parameter Syntax
$result = $client->updateSystem([
'description' => '<string>',
'sharingEnabled' => true || false,
'systemArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- description
-
- Type: string
Resource description.
- sharingEnabled
-
- Type: boolean
Whether cross-account sharing is enabled for the system.
- systemArn
-
- Required: Yes
- Type: string
ARN identifier.
Result Syntax
[
'system' => [
'createdAt' => <DateTime>,
'description' => '<string>',
'kmsKeyId' => '<string>',
'name' => '<string>',
'organizationId' => '<string>',
'ouId' => '<string>',
'sharingEnabled' => true || false,
'systemArn' => '<string>',
'systemId' => '<string>',
'tags' => ['<string>', ...],
'updatedAt' => <DateTime>,
],
]
Result Details
Members
- system
-
- Required: Yes
- Type: System structure
The updated system.
Errors
- InternalServerException:
Internal service error.
- ResourceNotFoundException:
Resource not found.
- ValidationException:
Validation error — invalid input parameters.
- ConflictException:
Conflict — resource already exists.
- AccessDeniedException:
Access denied — caller lacks required permissions.
UpdateUserJourney
$result = $client->updateUserJourney([/* ... */]); $promise = $client->updateUserJourneyAsync([/* ... */]);
Updates an existing user journey.
Parameter Syntax
$result = $client->updateUserJourney([
'description' => '<string>',
'name' => '<string>',
'policyArn' => '<string>',
'systemArn' => '<string>', // REQUIRED
'userJourneyId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- description
-
- Type: string
Resource description.
- name
-
- Type: string
Entity label (not part of ARN — spaces allowed).
- policyArn
-
- Type: string
ARN identifier.
- systemArn
-
- Required: Yes
- Type: string
ARN identifier.
- userJourneyId
-
- Required: Yes
- Type: string
The identifier of the user journey to update.
Result Syntax
[
'userJourney' => [
'createdAt' => <DateTime>,
'description' => '<string>',
'name' => '<string>',
'policyArn' => '<string>',
'updatedAt' => <DateTime>,
'userJourneyId' => '<string>',
],
]
Result Details
Members
- userJourney
-
- Required: Yes
- Type: UserJourney structure
The updated user journey.
Errors
- InternalServerException:
Internal service error.
- ResourceNotFoundException:
Resource not found.
- ValidationException:
Validation error — invalid input parameters.
- ConflictException:
Conflict — resource already exists.
- AccessDeniedException:
Access denied — caller lacks required permissions.
Shapes
AccessDeniedException
Description
Access denied — caller lacks required permissions.
Members
- message
-
- Required: Yes
- Type: string
Achievability
Description
Describes the achievability status of a service's resilience targets based on the most recent assessment.
Members
- availabilitySlo
-
- Type: string
The achievability status of the availability SLO target for the service.
- multiAzRtoRpo
-
- Type: string
The achievability status of the multi-AZ RTO and RPO targets for the service.
- multiRegionRtoRpo
-
- Type: string
The achievability status of the multi-Region RTO and RPO targets for the service.
Assertion
Description
Represents a resilience assertion for a service.
Members
- assertionId
-
- Required: Yes
- Type: string
The unique identifier of the assertion.
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the assertion was created.
- serviceArn
-
- Required: Yes
- Type: string
ARN identifier.
- source
-
- Required: Yes
- Type: string
The source of the assertion, indicating whether it was AI-generated or created by a user.
- text
-
- Required: Yes
- Type: string
The text content of the assertion.
- updatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the assertion was last updated.
AssertionCreatedMetadata
Description
Metadata for an assertion created event.
Members
- assertionId
-
- Type: string
The unique identifier of the created assertion.
- assertionName
-
- Type: string
The name of the created assertion.
AssertionDeletedMetadata
Description
Metadata for an assertion deleted event.
Members
- assertionId
-
- Type: string
The unique identifier of the deleted assertion.
- assertionName
-
- Type: string
The name of the deleted assertion.
AssertionUpdatedMetadata
Description
Metadata for an assertion updated event.
Members
- assertionId
-
- Type: string
The unique identifier of the updated assertion.
- assertionName
-
- Type: string
The name of the updated assertion.
AssessmentCost
Description
Represents the cost of running a failure mode assessment.
Members
- amount
-
- Type: double
The cost amount for the assessment.
- currency
-
- Type: string
The currency of the assessment cost.
AssessmentSummary
Description
Contains summary information about a failure mode assessment.
Members
- achievability
-
- Type: Achievability structure
The achievability results from the assessment.
- assessmentCost
-
- Type: AssessmentCost structure
The cost of the assessment.
- assessmentId
-
- Required: Yes
- Type: string
The unique identifier of the assessment.
- assessmentStatus
-
- Type: string
The current status of the assessment.
- assessmentStep
-
- Type: string
The current step of the assessment process.
- billableAssessmentUnitCount
-
- Type: int
The number of billable assessment units consumed by the assessment.
- endedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the assessment ended.
- errorCode
-
- Type: string
The error code if the assessment failed.
- errorMessage
-
- Type: string
A message describing the error if the assessment failed.
- serviceArn
-
- Required: Yes
- Type: string
ARN identifier.
- startedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the assessment started.
- totalFindings
-
- Type: int
The total number of findings generated by the assessment.
AssociatedSystem
Description
Represents a system associated with a service.
Members
- systemArn
-
- Required: Yes
- Type: string
ARN identifier.
- systemName
-
- Type: string
Resource name (used in ARN — no spaces allowed).
- userJourneyIds
-
- Type: Array of strings
The list of user journey identifiers that associate this system with the service.
AvailabilitySlo
Description
Defines the availability service level objective (SLO) for a resilience policy.
Members
- target
-
- Type: double
The target availability percentage, expressed as a value between 0 and 100.
ConflictException
Description
Conflict — resource already exists.
Members
- message
-
- Required: Yes
- Type: string
CrossAccountRole
Description
Specifies a cross-account IAM role ARN and optional external ID.
Members
- crossAccountRoleArn
-
- Required: Yes
- Type: string
ARN of the IAM Role for the profile. Null if the permission profile is the 'Admin' profile.
- externalId
-
- Type: string
The external ID used for assuming the cross-account role.
DataRecoveryTargets
Description
Defines data recovery targets for a resilience policy.
Members
- timeBetweenBackupsInMinutes
-
- Type: int
The target time between backups, in minutes.
DependencyDiscoveryConfig
Description
Configuration for dependency discovery on a service.
Members
- status
-
- Required: Yes
- Type: string
The current status of dependency discovery.
- updatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when dependency discovery was last updated.
DependencySummary
Description
Contains summary information about a discovered dependency.
Members
- comment
-
- Type: string
A user-provided comment about the dependency.
- criticality
-
- Required: Yes
- Type: string
The criticality level of the dependency.
- dependencyId
-
- Required: Yes
- Type: string
The unique identifier of the dependency.
- dependencyName
-
- Required: Yes
- Type: string
The name of the dependency.
- dnsName
-
- Required: Yes
- Type: string
The DNS name associated with the dependency.
- lastDetectedTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the dependency was last detected.
- location
-
- Required: Yes
- Type: string
The location of the dependency.
- provider
-
- Type: string
The provider of the dependency.
- queryRange
-
- Required: Yes
- Type: QueryRange structure
The query range data for the dependency.
- serviceArn
-
- Required: Yes
- Type: string
ARN identifier.
- sourceRegions
-
- Required: Yes
- Type: Array of strings
The source Regions from which the dependency was detected.
DisasterRecoverySource
Description
Contains the effective disaster recovery approach value for a service.
Members
- policyName
-
- Type: string
Resource name (used in ARN — no spaces allowed).
- source
-
- Type: string
Indicates whether the value comes from the service's own account or a cross-account policy.
- value
-
- Type: string
The disaster recovery approach value.
EdgePropertySummary
Description
Contains property information for a service topology edge.
Members
- label
-
- Type: string
Human-readable relationship description. Only present for LLM-inferred edges.
- topologyType
-
- Type: string
The topology type of the edge.
EffectivePolicyValues
Description
Contains the effective resilience policy values for a service.
Members
- availabilitySlo
-
- Type: SloSource structure
The effective availability SLO value for the service.
- dataRecoveryTimeBetweenBackups
-
- Type: TargetSource structure
The effective data recovery time between backups value for the service.
- multiAzDrApproach
-
- Type: DisasterRecoverySource structure
The effective multi-AZ disaster recovery approach for the service.
- multiAzRpo
-
- Type: TargetSource structure
The effective multi-AZ RPO value for the service, in minutes.
- multiAzRto
-
- Type: TargetSource structure
The effective multi-AZ RTO value for the service, in minutes.
- multiRegionDrApproach
-
- Type: DisasterRecoverySource structure
The effective multi-Region disaster recovery approach for the service.
- multiRegionRpo
-
- Type: TargetSource structure
The effective multi-Region RPO value for the service, in minutes.
- multiRegionRto
-
- Type: TargetSource structure
The effective multi-Region RTO value for the service, in minutes.
EksSource
Description
Defines an Amazon EKS cluster and its namespaces as an input source for resource discovery.
Members
- clusterArn
-
- Required: Yes
- Type: string
ARN identifier.
- namespaces
-
- Required: Yes
- Type: Array of strings
The list of Kubernetes namespaces within the EKS cluster.
EventActor
Description
Identifies the actor that triggered an event.
Members
- accountId
-
- Type: string
The AWS account ID of the actor.
- principalId
-
- Required: Yes
- Type: string
The principal ID of the actor.
- type
-
- Required: Yes
- Type: string
The type of actor, either USER or SYSTEM.
- userName
-
- Type: string
The user name of the actor.
FailedReportOutput
Description
Details when report generation failed.
Members
- errorCode
-
- Required: Yes
- Type: string
The error code describing why the report generation failed.
- errorMessage
-
- Type: string
The error message describing why the report generation failed.
Finding
Description
Represents a resilience finding from a failure mode assessment.
Members
- comment
-
- Type: string
A user-provided comment about the finding.
- description
-
- Type: string
Resource description.
- failureCategory
-
- Type: string
The failure category of the finding.
- findingId
-
- Type: string
The unique identifier of the finding.
- infrastructureAndCodeRecommendations
-
- Type: Array of InfrastructureAndCodeRecommendation structures
Infrastructure and code recommendations to address the finding.
- name
-
- Type: string
The name of the finding.
- observabilityRecommendations
-
- Type: Array of ObservabilityRecommendation structures
Observability recommendations to address the finding.
- policyComponent
-
- Type: string
The policy component associated with the finding.
- reasoning
-
- Type: string
The reasoning behind the finding.
- serviceFunctions
-
- Type: Array of strings
The service functions associated with the finding.
- severity
-
- Type: string
The severity of the finding.
- status
-
- Type: string
The current status of the finding.
- testingRecommendations
-
- Type: Array of TestingRecommendation structures
Testing recommendations to address the finding.
- updatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the finding was last updated.
FindingSummary
Description
Contains summary information about a finding.
Members
- description
-
- Type: string
Resource description.
- failureCategory
-
- Type: string
The failure category of the finding.
- findingId
-
- Type: string
The unique identifier of the finding.
- name
-
- Type: string
The name of the finding.
- policyComponent
-
- Type: string
The policy component associated with the finding.
- serviceArn
-
- Type: string
ARN identifier.
- severity
-
- Type: string
The severity of the finding.
- status
-
- Type: string
The current status of the finding.
- updatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the finding was last updated.
InfrastructureAndCodeRecommendation
Description
An infrastructure and code recommendation to address a finding.
Members
- suggestedChanges
-
- Type: Array of strings
The list of suggested changes.
InputSource
Description
Identifies an input source by its identifier and type.
Members
- identifier
-
- Required: Yes
- Type: string
The identifier of the input source.
- type
-
- Required: Yes
- Type: string
The type of the input source.
InputSourceSummary
Description
Contains summary information about an input source for a service.
Members
- cfnStackArn
-
- Type: string
ARN identifier.
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the input source was created.
- designFileS3Url
-
- Type: string
S3 URL — virtual hosted-style or s3:// URI.
- eks
-
- Type: EksSource structure
The Amazon EKS configuration, if this input source uses EKS.
- inputSourceId
-
- Required: Yes
- Type: string
The unique identifier of the input source.
- resourceTags
-
- Type: Array of ResourceTag structures
The resource tags used for discovery, if this input source uses tags.
- tfStateFileUrl
-
- Type: string
S3 URL — virtual hosted-style or s3:// URI.
- type
-
- Type: string
The type of the input source.
InternalServerException
Description
Internal service error.
Members
- message
-
- Required: Yes
- Type: string
MultiAzTargets
Description
Defines the multi-AZ disaster recovery targets for a resilience policy.
Members
- disasterRecoveryApproach
-
- Type: string
The disaster recovery approach for multi-AZ.
- rpoInMinutes
-
- Type: int
The recovery point objective (RPO) target for multi-AZ, in minutes.
- rtoInMinutes
-
- Type: int
The recovery time objective (RTO) target for multi-AZ, in minutes.
MultiRegionTargets
Description
Defines the multi-Region disaster recovery targets for a resilience policy.
Members
- disasterRecoveryApproach
-
- Type: string
The disaster recovery approach for multi-Region.
- rpoInMinutes
-
- Type: int
The recovery point objective (RPO) target for multi-Region, in minutes.
- rtoInMinutes
-
- Type: int
The recovery time objective (RTO) target for multi-Region, in minutes.
ObservabilityRecommendation
Description
An observability recommendation to address a finding.
Members
- suggestedChanges
-
- Type: Array of strings
The list of suggested observability changes.
PermissionModel
Description
Defines the permission model for a service.
Members
- crossAccountRoles
-
- Type: Array of CrossAccountRole structures
The list of cross-account IAM role ARNs.
- invokerRoleName
-
- Required: Yes
- Type: string
IAM role name (supports up to 64 characters per IAM limits).
Policy
Description
Represents a resilience policy that defines availability and disaster recovery requirements.
Members
- associatedServiceCount
-
- Type: int
The number of services associated with this policy.
- availabilitySlo
-
- Type: AvailabilitySlo structure
The availability SLO defined in the policy.
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the policy was created.
- dataRecovery
-
- Type: DataRecoveryTargets structure
The data recovery targets defined in the policy.
- description
-
- Type: string
Resource description for services and policies.
- kmsKeyId
-
- Type: string
KMS key identifier — accepts key ID, key ARN, alias name, or alias ARN.
- multiAz
-
- Type: MultiAzTargets structure
The multi-AZ disaster recovery targets defined in the policy.
- multiRegion
-
- Type: MultiRegionTargets structure
The multi-Region disaster recovery targets defined in the policy.
- name
-
- Required: Yes
- Type: string
Resource name (used in ARN — no spaces allowed).
- policyArn
-
- Required: Yes
- Type: string
ARN identifier.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Resource tags.
- updatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the policy was last updated.
PolicySummary
Description
Contains summary information about a resilience policy.
Members
- associatedServiceCount
-
- Type: int
The number of services associated with this policy.
- availabilitySlo
-
- Type: AvailabilitySlo structure
The availability SLO defined in the policy.
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the policy was created.
- dataRecovery
-
- Type: DataRecoveryTargets structure
The data recovery targets defined in the policy.
- multiAz
-
- Type: MultiAzTargets structure
The multi-AZ disaster recovery targets defined in the policy.
- multiRegion
-
- Type: MultiRegionTargets structure
The multi-Region disaster recovery targets defined in the policy.
- name
-
- Required: Yes
- Type: string
Resource name (used in ARN — no spaces allowed).
- policyArn
-
- Required: Yes
- Type: string
ARN identifier.
- updatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the policy was last updated.
QueryDataPoint
Description
A data point in a dependency query range.
Members
- queryCount
-
- Required: Yes
- Type: long (int|float)
The number of queries at this data point.
- timestamp
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of the data point.
QueryRange
Description
Defines a time range for dependency query data.
Members
- dataPoints
-
- Required: Yes
- Type: Array of QueryDataPoint structures
The data points within the query range.
- endTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The end time of the query range.
- granularity
-
- Required: Yes
- Type: string
The granularity of the query range data points.
- startTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The start time of the query range.
ReportGenerationResult
Description
Result of a report generation attempt.
Members
- assessmentId
-
- Type: string
Present for FAILURE_MODE reports.
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the report was created.
- reportOutput
-
- Type: ReportOutput structure
Present when status is SUCCEEDED or FAILED.
- reportType
-
- Required: Yes
- Type: string
The type of the generated report.
- serviceArn
-
- Type: string
The service this report was generated for.
- status
-
- Required: Yes
- Type: string
The status of the report generation.
ReportOutput
Description
Union of possible report outputs.
Members
- failedReportOutput
-
- Type: FailedReportOutput structure
Details when report generation failed.
- s3ReportOutput
-
- Type: S3ReportOutput structure
The S3 location where the report was written.
ReportOutputConfiguration
Description
Configuration for a report output destination.
Members
- s3
-
- Type: S3ReportOutputConfiguration structure
S3 configuration for report output.
Resource
Description
Represents an AWS resource discovered by Resilience Hub.
Members
- awsAccountId
-
- Type: string
The AWS account ID that owns the resource.
- awsRegion
-
- Type: string
The AWS Region where the resource is located.
- identifier
-
- Required: Yes
- Type: string
The identifier of the resource.
- resourceType
-
- Type: string
The type of the resource.
ResourceConfiguration
Description
Resource configuration for an input source. Provide exactly one field.
Members
- cfnStackArn
-
- Type: string
ARN identifier.
- designFileS3Url
-
- Type: string
S3 URL — virtual hosted-style or s3:// URI.
- eks
-
- Type: EksSource structure
The Amazon EKS configuration for resource discovery.
- resourceTags
-
- Type: Array of ResourceTag structures
The resource tags for tag-based resource discovery.
- tfStateFileUrl
-
- Type: string
S3 URL — virtual hosted-style or s3:// URI.
ResourceDiscoveryStatus
Description
Contains the status of resource discovery for a service.
Members
- errorCode
-
- Type: string
The error code if resource discovery failed.
- errorMessage
-
- Type: string
A message describing the error if resource discovery failed.
- lastRunAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of the last resource discovery run.
- status
-
- Type: string
The current status of resource discovery.
ResourceNotFoundException
Description
Resource not found.
Members
- message
-
- Required: Yes
- Type: string
- resourceId
-
- Type: string
The identifier of the resource that was not found.
- resourceType
-
- Type: string
The type of the resource that was not found.
ResourceTag
Description
A tag key-value pair used for resource discovery.
Members
- key
-
- Required: Yes
- Type: string
Tag key.
- values
-
- Required: Yes
- Type: Array of strings
The list of tag values.
S3ReportOutput
Description
S3 location where report was written.
Members
- s3ObjectKey
-
- Required: Yes
- Type: string
The S3 object key for the generated report.
S3ReportOutputConfiguration
Description
S3 configuration for report output.
Members
- bucketOwner
-
- Required: Yes
- Type: string
Account ID of the bucket owner for cross-account access verification.
- bucketPath
-
- Required: Yes
- Type: string
S3 bucket path where reports will be written (e.g., my-bucket/ngrh-reports/).
Service
Description
Represents a service in Resilience Hub. A service is the primary unit of resilience assessment.
Members
- accountId
-
- Type: string
The AWS account ID that owns the service.
- achievability
-
- Type: Achievability structure
The achievability status of the service's resilience targets.
- assessmentStatus
-
- Type: string
The current assessment status of the service.
- associatedSystems
-
- Type: Array of AssociatedSystem structures
The systems associated with the service.
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the service was created.
- dependencyDiscovery
-
- Type: DependencyDiscoveryConfig structure
The dependency discovery configuration for the service.
- description
-
- Type: string
Resource description for services and policies.
- effectivePolicyValues
-
- Type: EffectivePolicyValues structure
The effective policy values for the service.
- estimatedAssessmentCost
-
- Type: AssessmentCost structure
The estimated cost of running an assessment on the service.
- kmsKeyId
-
- Type: string
KMS key identifier — accepts key ID, key ARN, alias name, or alias ARN.
- name
-
- Required: Yes
- Type: string
Resource name (used in ARN — no spaces allowed).
- openFindingsCount
-
- Type: int
The number of open findings for the service.
- organizationId
-
- Type: string
The AWS Organizations identifier for the service.
- ouId
-
- Type: string
The organizational unit (OU) identifier for the service.
- permissionModel
-
- Type: PermissionModel structure
The permission model for the service.
- policyArn
-
- Type: string
ARN identifier.
- regions
-
- Type: Array of strings
The AWS Regions where the service operates.
- reportConfiguration
-
- Type: ServiceReportConfiguration structure
Configuration for automatic report generation on a Service.
- rerunAssessment
-
- Type: boolean
Indicates whether the assessment should be rerun.
- resolvedFindingsCount
-
- Type: int
The number of resolved findings for the service.
- resourceDiscovery
-
- Type: ResourceDiscoveryStatus structure
The resource discovery status for the service.
- serviceArn
-
- Required: Yes
- Type: string
ARN identifier.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Resource tags.
- updatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the service was last updated.
ServiceAchievabilityUpdatedMetadata
Description
Metadata for a service achievability updated event.
Members
- assessmentId
-
- Type: string
The assessment identifier that triggered the update.
- availabilitySlo
-
- Type: string
The updated achievability status of the availability SLO.
- multiAzRtoRpo
-
- Type: string
The updated achievability status of the multi-AZ RTO and RPO targets.
- multiRegionRtoRpo
-
- Type: string
The updated achievability status of the multi-Region RTO and RPO targets.
ServiceCreatedMetadata
Description
Metadata for a service created event.
Members
ServiceDeletedMetadata
Description
Metadata for a service deleted event.
Members
ServiceEvent
Description
Represents an event in the service event log.
Members
- actor
-
- Required: Yes
- Type: EventActor structure
The actor that triggered the event.
- eventDetails
-
- Required: Yes
- Type: ServiceEventDetails structure
The details of the event.
- eventId
-
- Required: Yes
- Type: string
The unique identifier of the event.
- eventType
-
- Required: Yes
- Type: string
The type of the event.
- serviceArn
-
- Required: Yes
- Type: string
ARN identifier.
- timestamp
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of the event.
ServiceEventDetails
Description
Contains the details of a service event.
Members
- description
-
- Required: Yes
- Type: string
The description of the event.
- eventMetadata
-
- Type: ServiceEventMetadata structure
Type-specific metadata for each service event type.
- title
-
- Required: Yes
- Type: string
The title of the event.
ServiceEventMetadata
Description
Type-specific metadata for each service event type.
Members
- assertionCreated
-
- Type: AssertionCreatedMetadata structure
Metadata for an assertion created event.
- assertionDeleted
-
- Type: AssertionDeletedMetadata structure
Metadata for an assertion deleted event.
- assertionUpdated
-
- Type: AssertionUpdatedMetadata structure
Metadata for an assertion updated event.
- serviceAchievabilityUpdated
-
- Type: ServiceAchievabilityUpdatedMetadata structure
Metadata for a service achievability updated event.
- serviceCreated
-
- Type: ServiceCreatedMetadata structure
Metadata for a service created event.
- serviceDeleted
-
- Type: ServiceDeletedMetadata structure
Metadata for a service deleted event.
- serviceFunctionCreated
-
- Type: ServiceFunctionCreatedMetadata structure
Metadata for a service function created event.
- serviceFunctionDeleted
-
- Type: ServiceFunctionDeletedMetadata structure
Metadata for a service function deleted event.
- serviceFunctionResourcesAdded
-
- Type: ServiceFunctionResourcesAddedMetadata structure
Metadata for a service function resources added event.
- serviceFunctionResourcesRemoved
-
- Type: ServiceFunctionResourcesRemovedMetadata structure
Metadata for a service function resources removed event.
- serviceFunctionUpdated
-
- Type: ServiceFunctionUpdatedMetadata structure
Metadata for a service function updated event.
- serviceInputSourcesUpdated
-
- Type: ServiceInputSourcesUpdatedMetadata structure
Metadata for a service input sources updated event.
- servicePolicyAssociated
-
- Type: ServicePolicyAssociatedMetadata structure
Metadata for a service policy associated event.
- servicePolicyDisassociated
-
- Type: ServicePolicyDisassociatedMetadata structure
Metadata for a service policy disassociated event.
- serviceResourcesAssociated
-
- Type: ServiceResourcesAssociatedMetadata structure
Metadata for a service resources associated event.
- serviceResourcesDisassociated
-
- Type: ServiceResourcesDisassociatedMetadata structure
Metadata for a service resources disassociated event.
- serviceSystemAssociated
-
- Type: ServiceSystemAssociatedMetadata structure
Metadata for a service system associated event.
- serviceSystemDisassociated
-
- Type: ServiceSystemDisassociatedMetadata structure
Metadata for a service system disassociated event.
- serviceWorkflowUpdated
-
- Type: ServiceWorkflowUpdatedMetadata structure
Metadata for a service workflow updated event.
ServiceFunction
Description
Represents a logical component of a service.
Members
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the service function was created.
- criticality
-
- Required: Yes
- Type: string
The criticality level of the service function.
- description
-
- Type: string
Resource description.
- name
-
- Required: Yes
- Type: string
Entity label (not part of ARN — spaces allowed).
- resourceCount
-
- Type: int
The number of resources associated with the service function.
- serviceArn
-
- Required: Yes
- Type: string
ARN identifier.
- serviceFunctionId
-
- Required: Yes
- Type: string
The unique identifier of the service function.
- source
-
- Type: string
The source of the service function.
- updatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the service function was last updated.
ServiceFunctionCreatedMetadata
Description
Metadata for a service function created event.
Members
- serviceFunctionId
-
- Type: string
The identifier of the created service function.
- serviceFunctionName
-
- Type: string
The name of the created service function.
ServiceFunctionDeletedMetadata
Description
Metadata for a service function deleted event.
Members
- serviceFunctionId
-
- Type: string
The identifier of the deleted service function.
- serviceFunctionName
-
- Type: string
The name of the deleted service function.
ServiceFunctionResourcesAddedMetadata
Description
Metadata for a service function resources added event.
Members
- resourcesAdded
-
- Type: Array of strings
The list of resource ARNs that were added.
- serviceFunctionId
-
- Type: string
The identifier of the service function.
- serviceFunctionName
-
- Type: string
The name of the service function.
ServiceFunctionResourcesRemovedMetadata
Description
Metadata for a service function resources removed event.
Members
- resourcesRemoved
-
- Type: Array of strings
The list of resource ARNs that were removed.
- serviceFunctionId
-
- Type: string
The identifier of the service function.
- serviceFunctionName
-
- Type: string
The name of the service function.
ServiceFunctionUpdatedMetadata
Description
Metadata for a service function updated event.
Members
- resourcesAdded
-
- Type: Array of strings
The list of resource ARNs that were added.
- resourcesRemoved
-
- Type: Array of strings
The list of resource ARNs that were removed.
- serviceFunctionId
-
- Type: string
The identifier of the service function.
- serviceFunctionName
-
- Type: string
The name of the service function.
ServiceInputSourcesUpdatedMetadata
Description
Metadata for a service input sources updated event.
Members
ServicePolicyAssociatedMetadata
Description
Metadata for a service policy associated event.
Members
- policyArn
-
- Type: string
ARN identifier.
- policyName
-
- Type: string
The name of the associated policy.
ServicePolicyDisassociatedMetadata
Description
Metadata for a service policy disassociated event.
Members
- policyArn
-
- Type: string
ARN identifier.
- policyName
-
- Type: string
The name of the disassociated policy.
ServiceQuotaExceededException
Description
Service quota exceeded.
Members
- message
-
- Required: Yes
- Type: string
ServiceReference
Description
A reference to a service by ID and name.
Members
- serviceId
-
- Type: string
The identifier of the referenced service.
- serviceName
-
- Type: string
The name of the referenced service.
ServiceReferenceChanges
Description
Describes changes to service references.
Members
- added
-
- Type: Array of ServiceReference structures
The list of service references that were added.
- removed
-
- Type: Array of ServiceReference structures
The list of service references that were removed.
ServiceReportConfiguration
Description
Configuration for automatic report generation on a Service.
Members
- reportOutputs
-
- Required: Yes
- Type: Array of ReportOutputConfiguration structures
Output destinations for generated reports.
ServiceResource
Description
Represents a resource associated with a service.
Members
- inputSource
-
- Type: InputSource structure
The input source that discovered the resource.
- resource
-
- Required: Yes
- Type: Resource structure
The resource details.
- resourceIdentifier
-
- Required: Yes
- Type: string
The identifier of the resource.
ServiceResourcesAssociatedMetadata
Description
Metadata for a service resources associated event.
Members
- resourceCount
-
- Type: int
The number of resources associated.
- resourceTypes
-
- Type: Array of strings
The types of resources associated.
ServiceResourcesDisassociatedMetadata
Description
Metadata for a service resources disassociated event.
Members
- resourceCount
-
- Type: int
The number of resources disassociated.
- resourceTypes
-
- Type: Array of strings
The types of resources disassociated.
ServiceSummary
Description
Contains summary information about a service.
Members
- accountId
-
- Type: string
Displayed only if caller has access.
- achievability
-
- Type: Achievability structure
The achievability status of the service's resilience targets.
- assessmentStatus
-
- Type: string
The current assessment status of the service.
- associatedSystems
-
- Type: Array of AssociatedSystem structures
The systems associated with the service.
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the service was created.
- dependencyDiscovery
-
- Type: DependencyDiscoveryConfig structure
The dependency discovery configuration.
- name
-
- Required: Yes
- Type: string
Resource name (used in ARN — no spaces allowed).
- openFindingsCount
-
- Type: int
The number of open findings.
- organizationId
-
- Type: string
Displayed only if caller has access.
- ouId
-
- Type: string
Displayed only if caller has access.
- policyArn
-
- Type: string
ARN identifier.
- regions
-
- Type: Array of strings
The AWS Regions where the service operates.
- resolvedFindingsCount
-
- Type: int
The number of resolved findings.
- serviceArn
-
- Required: Yes
- Type: string
ARN identifier.
- updatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the service was last updated.
ServiceSystemAssociatedMetadata
Description
Metadata for a service system associated event.
Members
- systemArn
-
- Type: string
ARN identifier.
- systemName
-
- Type: string
The name of the associated system.
ServiceSystemDisassociatedMetadata
Description
Metadata for a service system disassociated event.
Members
- systemArn
-
- Type: string
ARN identifier.
- systemId
-
- Type: string
The identifier of the disassociated system.
- systemName
-
- Type: string
The name of the disassociated system.
ServiceTopologyEdgeSummary
Description
Contains summary information about a service topology edge.
Members
- destinationResourceIdentifier
-
- Required: Yes
- Type: string
The identifier of the destination resource.
- properties
-
- Type: Array of EdgePropertySummary structures
The properties of the topology edge.
- sourceResourceIdentifier
-
- Required: Yes
- Type: string
The identifier of the source resource.
ServiceWorkflowUpdatedMetadata
Description
Metadata for a service workflow updated event.
Members
- serviceFunctionId
-
- Type: string
The identifier of the service function.
- serviceFunctionName
-
- Type: string
The name of the service function.
SloSource
Description
Contains the effective availability SLO value and its source.
Members
- policyName
-
- Type: string
Resource name (used in ARN — no spaces allowed).
- source
-
- Type: string
Indicates whether the value comes from the service's own account or a cross-account policy.
- value
-
- Type: double
The availability SLO percentage value.
StringChange
Description
Describes a change from one string value to another.
Members
- newValue
-
- Type: string
The new value.
- oldValue
-
- Type: string
The old value.
System
Description
Represents a system in Resilience Hub. A system is a logical grouping of services.
Members
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the system was created.
- description
-
- Type: string
Resource description.
- kmsKeyId
-
- Type: string
KMS key identifier — accepts key ID, key ARN, alias name, or alias ARN.
- name
-
- Required: Yes
- Type: string
Resource name (used in ARN — no spaces allowed).
- organizationId
-
- Type: string
The AWS Organizations identifier for the system.
- ouId
-
- Type: string
The organizational unit (OU) identifier for the system.
- sharingEnabled
-
- Type: boolean
Indicates whether cross-account sharing is enabled.
- systemArn
-
- Required: Yes
- Type: string
ARN identifier.
- systemId
-
- Required: Yes
- Type: string
System ID for cross-account use without exposing account structure.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Resource tags.
- updatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the system was last updated.
SystemCreatedMetadata
Description
Metadata for a system created event.
Members
SystemDeletedMetadata
Description
Metadata for a system deleted event.
Members
SystemEvent
Description
Represents an event in the system event log.
Members
- actor
-
- Required: Yes
- Type: EventActor structure
The actor that triggered the event.
- eventDetails
-
- Required: Yes
- Type: SystemEventDetails structure
The details of the event.
- eventId
-
- Required: Yes
- Type: string
The unique identifier of the event.
- eventType
-
- Required: Yes
- Type: string
The type of the event.
- systemArn
-
- Required: Yes
- Type: string
ARN identifier.
- timestamp
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of the event.
SystemEventDetails
Description
Contains the details of a system event.
Members
- description
-
- Required: Yes
- Type: string
The description of the event.
- eventMetadata
-
- Type: SystemEventMetadata structure
Type-specific metadata for each system event type.
- title
-
- Required: Yes
- Type: string
The title of the event.
SystemEventMetadata
Description
Type-specific metadata for each system event type.
Members
- systemCreated
-
- Type: SystemCreatedMetadata structure
Metadata for a system created event.
- systemDeleted
-
- Type: SystemDeletedMetadata structure
Metadata for a system deleted event.
- systemPolicyAssociated
-
- Type: SystemPolicyAssociatedMetadata structure
Metadata for a system policy associated event.
- systemPolicyDisassociated
-
- Type: SystemPolicyDisassociatedMetadata structure
Metadata for a system policy disassociated event.
- systemServiceAssociated
-
- Type: SystemServiceAssociatedMetadata structure
Metadata for a system service associated event.
- systemServiceDisassociated
-
- Type: SystemServiceDisassociatedMetadata structure
Metadata for a system service disassociated event.
- systemUserJourneyCreated
-
- Type: SystemUserJourneyCreatedMetadata structure
Metadata for a system user journey created event.
- systemUserJourneyDeleted
-
- Type: SystemUserJourneyDeletedMetadata structure
Metadata for a system user journey deleted event.
- systemUserJourneyUpdated
-
- Type: SystemUserJourneyUpdatedMetadata structure
Metadata for a system user journey updated event.
SystemPolicyAssociatedMetadata
Description
Metadata for a system policy associated event.
Members
- policyArn
-
- Type: string
ARN identifier.
- policyName
-
- Type: string
The name of the associated policy.
SystemPolicyDisassociatedMetadata
Description
Metadata for a system policy disassociated event.
Members
- policyArn
-
- Type: string
ARN identifier.
- policyName
-
- Type: string
The name of the disassociated policy.
SystemServiceAssociatedMetadata
Description
Metadata for a system service associated event.
Members
- serviceArn
-
- Type: string
ARN identifier.
- serviceName
-
- Type: string
The name of the associated service.
- userJourneys
-
- Type: Array of strings
The user journeys linking the service to the system.
SystemServiceDisassociatedMetadata
Description
Metadata for a system service disassociated event.
Members
- comment
-
- Type: string
A comment about the disassociation.
- serviceArn
-
- Type: string
ARN identifier.
- serviceName
-
- Type: string
The name of the disassociated service.
- userJourneysAffected
-
- Type: Array of strings
The user journeys affected by the disassociation.
SystemSummary
Description
Contains summary information about a system.
Members
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the system was created.
- name
-
- Required: Yes
- Type: string
Resource name (used in ARN — no spaces allowed).
- organizationId
-
- Type: string
Displayed only if caller has access.
- ouId
-
- Type: string
Displayed only if caller has access.
- servicesCount
-
- Type: int
The number of services in the system.
- systemArn
-
- Type: string
ARN identifier.
- systemId
-
- Required: Yes
- Type: string
System ID for cross-account use without exposing account structure.
- updatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the system was last updated.
- userJourneysCount
-
- Type: int
The number of user journeys in the system.
SystemUserJourneyCreatedMetadata
Description
Metadata for a system user journey created event.
Members
- associatedServices
-
- Type: Array of ServiceReference structures
The services associated with the created user journey.
- userJourneyName
-
- Type: string
The name of the created user journey.
SystemUserJourneyDeletedMetadata
Description
Metadata for a system user journey deleted event.
Members
- associatedServicesAtDeletion
-
- Type: Array of ServiceReference structures
The services that were associated at the time of deletion.
- userJourneyName
-
- Type: string
The name of the deleted user journey.
SystemUserJourneyUpdatedMetadata
Description
Metadata for a system user journey updated event.
Members
- changes
-
- Type: UserJourneyChanges structure
The changes made to the user journey.
- userJourneyName
-
- Type: string
The name of the updated user journey.
TargetSource
Description
Contains an effective RTO or RPO value and its source.
Members
- policyName
-
- Type: string
Resource name (used in ARN — no spaces allowed).
- source
-
- Type: string
Indicates whether the value comes from the service's own account or a cross-account policy.
- value
-
- Type: int
The RTO or RPO value in minutes.
TestingRecommendation
Description
A testing recommendation to address a finding.
Members
- suggestedChanges
-
- Type: Array of strings
The list of suggested testing changes.
ThrottlingException
Description
Too many requests — rate limit exceeded.
Members
- message
-
- Required: Yes
- Type: string
- retryAfterSeconds
-
- Type: int
The number of seconds to wait before retrying the request.
UserJourney
Description
Represents a user journey that defines a critical path through a system.
Members
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the user journey was created.
- description
-
- Type: string
Resource description.
- name
-
- Required: Yes
- Type: string
Entity label (not part of ARN — spaces allowed).
- policyArn
-
- Type: string
ARN identifier.
- updatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the user journey was last updated.
- userJourneyId
-
- Required: Yes
- Type: string
The unique identifier of the user journey.
UserJourneyChanges
Description
Describes changes made to a user journey.
Members
- associatedServices
-
- Type: ServiceReferenceChanges structure
Changes to the services associated with the user journey.
- journeyDescription
-
- Type: StringChange structure
Changes to the user journey description.
UserJourneySummary
Description
Contains summary information about a user journey.
Members
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the user journey was created.
- name
-
- Required: Yes
- Type: string
Entity label (not part of ARN — spaces allowed).
- updatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the user journey was last updated.
- userJourneyId
-
- Required: Yes
- Type: string
The unique identifier of the user journey.
ValidationException
Description
Validation error — invalid input parameters.
Members
- fieldList
-
- Type: Array of ValidationExceptionField structures
The list of fields that failed validation.
- message
-
- Required: Yes
- Type: string
- reason
-
- Type: string
The reason for the validation failure.
ValidationExceptionField
Description
Describes a field that failed validation.
Members
- message
-
- Required: Yes
- Type: string
The validation error message for the field.
- name
-
- Required: Yes
- Type: string
The name of the field that failed validation.