2026/05/28 - AWS Resilience Hub V2 - 51 new api methods
Changes This is the initial SDK release for the next generation of Resilience Hub.
Retrieves a service by ARN.
See also: AWS API Documentation
Request Syntax
client.get_service(
serviceArn='string'
)
string
[REQUIRED]
ARN identifier.
dict
Response Syntax
{
'service': {
'serviceArn': 'string',
'name': 'string',
'description': 'string',
'associatedSystems': [
{
'systemArn': 'string',
'systemName': 'string',
'userJourneyIds': [
'string',
]
},
],
'policyArn': 'string',
'regions': [
'string',
],
'permissionModel': {
'invokerRoleName': 'string',
'crossAccountRoles': [
{
'crossAccountRoleArn': 'string',
'externalId': 'string'
},
]
},
'dependencyDiscovery': {
'status': 'ENABLED'|'INITIALIZING'|'DISABLED',
'updatedAt': datetime(2015, 1, 1)
},
'effectivePolicyValues': {
'availabilitySlo': {
'value': 123.0,
'policyName': 'string',
'source': 'SELF'|'CROSS_ACCOUNT'
},
'multiAzRto': {
'value': 123,
'policyName': 'string',
'source': 'SELF'|'CROSS_ACCOUNT'
},
'multiAzRpo': {
'value': 123,
'policyName': 'string',
'source': 'SELF'|'CROSS_ACCOUNT'
},
'multiAzDrApproach': {
'value': 'string',
'policyName': 'string',
'source': 'SELF'|'CROSS_ACCOUNT'
},
'multiRegionRto': {
'value': 123,
'policyName': 'string',
'source': 'SELF'|'CROSS_ACCOUNT'
},
'multiRegionRpo': {
'value': 123,
'policyName': 'string',
'source': 'SELF'|'CROSS_ACCOUNT'
},
'multiRegionDrApproach': {
'value': 'string',
'policyName': 'string',
'source': 'SELF'|'CROSS_ACCOUNT'
},
'dataRecoveryTimeBetweenBackups': {
'value': 123,
'policyName': 'string',
'source': 'SELF'|'CROSS_ACCOUNT'
}
},
'achievability': {
'availabilitySlo': 'ACHIEVABLE'|'NOT_ACHIEVABLE',
'multiAzRtoRpo': 'ACHIEVABLE'|'NOT_ACHIEVABLE',
'multiRegionRtoRpo': 'ACHIEVABLE'|'NOT_ACHIEVABLE'
},
'reportConfiguration': {
'reportOutputs': [
{
's3': {
'bucketPath': 'string',
'bucketOwner': 'string'
}
},
]
},
'kmsKeyId': 'string',
'tags': {
'string': 'string'
},
'estimatedAssessmentCost': {
'amount': 123.0,
'currency': 'USD'
},
'resourceDiscovery': {
'status': 'RUNNING'|'SUCCEEDED'|'FAILED'|'COMPLETED_WITH_FAILURES'|'NOT_STARTED',
'lastRunAt': datetime(2015, 1, 1),
'errorCode': 'INVALID_PERMISSIONS'|'STACK_NOT_FOUND'|'CLUSTER_NOT_FOUND'|'STATE_FILE_NOT_FOUND'|'ACCESS_DENIED'|'UNSUPPORTED_CLUSTER'|'INTERNAL_ERROR',
'errorMessage': 'string'
},
'assessmentStatus': 'NOT_STARTED'|'PENDING'|'IN_PROGRESS'|'FAILED'|'SUCCESS',
'rerunAssessment': True|False,
'openFindingsCount': 123,
'resolvedFindingsCount': 123,
'organizationId': 'string',
'ouId': 'string',
'accountId': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
service (dict) --
The requested service.
serviceArn (string) --
ARN identifier.
name (string) --
Resource name (used in ARN — no spaces allowed).
description (string) --
Resource description for services and policies.
associatedSystems (list) --
The systems associated with the service.
(dict) --
Represents a system associated with a service.
systemArn (string) --
ARN identifier.
systemName (string) --
Resource name (used in ARN — no spaces allowed).
userJourneyIds (list) --
The list of user journey identifiers that associate this system with the service.
(string) --
policyArn (string) --
ARN identifier.
regions (list) --
The AWS Regions where the service operates.
(string) --
permissionModel (dict) --
The permission model for the service.
invokerRoleName (string) --
IAM role name (supports up to 64 characters per IAM limits).
crossAccountRoles (list) --
The list of cross-account IAM role ARNs.
(dict) --
Specifies a cross-account IAM role ARN and optional external ID.
crossAccountRoleArn (string) --
ARN of the IAM Role for the profile. Null if the permission profile is the 'Admin' profile.
externalId (string) --
The external ID used for assuming the cross-account role.
dependencyDiscovery (dict) --
The dependency discovery configuration for the service.
status (string) --
The current status of dependency discovery.
updatedAt (datetime) --
The timestamp when dependency discovery was last updated.
effectivePolicyValues (dict) --
The effective policy values for the service.
availabilitySlo (dict) --
The effective availability SLO value for the service.
value (float) --
The availability SLO percentage value.
policyName (string) --
Resource name (used in ARN — no spaces allowed).
source (string) --
Indicates whether the value comes from the service's own account or a cross-account policy.
multiAzRto (dict) --
The effective multi-AZ RTO value for the service, in minutes.
value (integer) --
The RTO or RPO value in minutes.
policyName (string) --
Resource name (used in ARN — no spaces allowed).
source (string) --
Indicates whether the value comes from the service's own account or a cross-account policy.
multiAzRpo (dict) --
The effective multi-AZ RPO value for the service, in minutes.
value (integer) --
The RTO or RPO value in minutes.
policyName (string) --
Resource name (used in ARN — no spaces allowed).
source (string) --
Indicates whether the value comes from the service's own account or a cross-account policy.
multiAzDrApproach (dict) --
The effective multi-AZ disaster recovery approach for the service.
value (string) --
The disaster recovery approach value.
policyName (string) --
Resource name (used in ARN — no spaces allowed).
source (string) --
Indicates whether the value comes from the service's own account or a cross-account policy.
multiRegionRto (dict) --
The effective multi-Region RTO value for the service, in minutes.
value (integer) --
The RTO or RPO value in minutes.
policyName (string) --
Resource name (used in ARN — no spaces allowed).
source (string) --
Indicates whether the value comes from the service's own account or a cross-account policy.
multiRegionRpo (dict) --
The effective multi-Region RPO value for the service, in minutes.
value (integer) --
The RTO or RPO value in minutes.
policyName (string) --
Resource name (used in ARN — no spaces allowed).
source (string) --
Indicates whether the value comes from the service's own account or a cross-account policy.
multiRegionDrApproach (dict) --
The effective multi-Region disaster recovery approach for the service.
value (string) --
The disaster recovery approach value.
policyName (string) --
Resource name (used in ARN — no spaces allowed).
source (string) --
Indicates whether the value comes from the service's own account or a cross-account policy.
dataRecoveryTimeBetweenBackups (dict) --
The effective data recovery time between backups value for the service.
value (integer) --
The RTO or RPO value in minutes.
policyName (string) --
Resource name (used in ARN — no spaces allowed).
source (string) --
Indicates whether the value comes from the service's own account or a cross-account policy.
achievability (dict) --
The achievability status of the service's resilience targets.
availabilitySlo (string) --
The achievability status of the availability SLO target for the service.
multiAzRtoRpo (string) --
The achievability status of the multi-AZ RTO and RPO targets for the service.
multiRegionRtoRpo (string) --
The achievability status of the multi-Region RTO and RPO targets for the service.
reportConfiguration (dict) --
Configuration for automatic report generation on a Service.
reportOutputs (list) --
Output destinations for generated reports.
(dict) --
Configuration for a report output destination.
s3 (dict) --
S3 configuration for report output.
bucketPath (string) --
S3 bucket path where reports will be written (e.g., my-bucket/ngrh-reports/).
bucketOwner (string) --
Account ID of the bucket owner for cross-account access verification.
kmsKeyId (string) --
KMS key identifier — accepts key ID, key ARN, alias name, or alias ARN.
tags (dict) --
Resource tags.
(string) --
Tag key.
(string) --
Tag value.
estimatedAssessmentCost (dict) --
The estimated cost of running an assessment on the service.
amount (float) --
The cost amount for the assessment.
currency (string) --
The currency of the assessment cost.
resourceDiscovery (dict) --
The resource discovery status for the service.
status (string) --
The current status of resource discovery.
lastRunAt (datetime) --
The timestamp of the last resource discovery run.
errorCode (string) --
The error code if resource discovery failed.
errorMessage (string) --
A message describing the error if resource discovery failed.
assessmentStatus (string) --
The current assessment status of the service.
rerunAssessment (boolean) --
Indicates whether the assessment should be rerun.
openFindingsCount (integer) --
The number of open findings for the service.
resolvedFindingsCount (integer) --
The number of resolved findings for the service.
organizationId (string) --
The AWS Organizations identifier for the service.
ouId (string) --
The organizational unit (OU) identifier for the service.
accountId (string) --
The AWS account ID that owns the service.
createdAt (datetime) --
The timestamp when the service was created.
updatedAt (datetime) --
The timestamp when the service was last updated.
Associates resources with a service function.
See also: AWS API Documentation
Request Syntax
client.create_service_function_resources(
serviceArn='string',
serviceFunctionId='string',
resources=[
'string',
]
)
string
[REQUIRED]
ARN identifier.
string
[REQUIRED]
The identifier of the service function to associate resources with.
list
[REQUIRED]
The list of resources to associate with the service function.
(string) --
dict
Response Syntax
{
'serviceArn': 'string',
'serviceFunctionId': 'string',
'resources': [
'string',
]
}
Response Structure
(dict) --
serviceArn (string) --
ARN identifier.
serviceFunctionId (string) --
The identifier of the service function.
resources (list) --
The list of resources that were associated.
(string) --
List resources.
See also: AWS API Documentation
Request Syntax
client.list_resources(
serviceArn='string',
serviceFunctionId='string',
awsRegion='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
ARN identifier.
string
Filter resources by service function identifier.
string
Filter resources by AWS Region.
integer
Pagination page size.
string
Pagination token.
dict
Response Syntax
{
'serviceFunctionId': 'string',
'serviceResources': [
{
'resourceIdentifier': 'string',
'inputSource': {
'identifier': 'string',
'type': 'CFN_STACK'|'TAGS'|'EKS'|'TERRAFORM'|'DESIGN_FILE'|'MONITORING'
},
'resource': {
'identifier': 'string',
'awsRegion': 'string',
'awsAccountId': 'string',
'resourceType': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
serviceFunctionId (string) --
The service function identifier for the returned resources.
serviceResources (list) --
The list of service resources.
(dict) --
Represents a resource associated with a service.
resourceIdentifier (string) --
The identifier of the resource.
inputSource (dict) --
The input source that discovered the resource.
identifier (string) --
The identifier of the input source.
type (string) --
The type of the input source.
resource (dict) --
The resource details.
identifier (string) --
The identifier of the resource.
awsRegion (string) --
The AWS Region where the resource is located.
awsAccountId (string) --
The AWS account ID that owns the resource.
resourceType (string) --
The type of the resource.
nextToken (string) --
Pagination token.
Removes tags from a resource.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
string
[REQUIRED]
ARN identifier.
list
[REQUIRED]
The tag keys to remove from the resource.
(string) --
Tag key.
dict
Response Syntax
{}
Response Structure
(dict) --
Imports a V1 policy into V2, mapping RTO/RPO values from V1 scenarios.
See also: AWS API Documentation
Request Syntax
client.import_policy(
v1PolicyArn='string',
kmsKeyId='string',
availabilitySlo={
'target': 123.0
},
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': 'string'
},
clientToken='string'
)
string
[REQUIRED]
ARN identifier.
string
KMS key identifier — accepts key ID, key ARN, alias name, or alias ARN.
dict
The availability SLO to set on the imported policy.
target (float) --
The target availability percentage, expressed as a value between 0 and 100.
string
The multi-AZ disaster recovery approach for the imported policy.
string
The multi-Region disaster recovery approach for the imported policy.
dict
Resource tags.
(string) --
Tag key.
(string) --
Tag value.
string
Idempotency token.
This field is autopopulated if not provided.
dict
Response Syntax
{
'policy': {
'policyArn': 'string',
'name': 'string',
'description': 'string',
'availabilitySlo': {
'target': 123.0
},
'multiAz': {
'rtoInMinutes': 123,
'rpoInMinutes': 123,
'disasterRecoveryApproach': 'ACTIVE_ACTIVE'|'HOT_STANDBY'|'WARM_STANDBY'|'PILOT_LIGHT'|'BACKUP_AND_RESTORE'
},
'multiRegion': {
'rtoInMinutes': 123,
'rpoInMinutes': 123,
'disasterRecoveryApproach': 'ACTIVE_ACTIVE'|'HOT_STANDBY'|'WARM_STANDBY'|'PILOT_LIGHT'|'BACKUP_AND_RESTORE'
},
'dataRecovery': {
'timeBetweenBackupsInMinutes': 123
},
'kmsKeyId': 'string',
'tags': {
'string': 'string'
},
'associatedServiceCount': 123,
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
policy (dict) --
The imported policy.
policyArn (string) --
ARN identifier.
name (string) --
Resource name (used in ARN — no spaces allowed).
description (string) --
Resource description for services and policies.
availabilitySlo (dict) --
The availability SLO defined in the policy.
target (float) --
The target availability percentage, expressed as a value between 0 and 100.
multiAz (dict) --
The multi-AZ disaster recovery targets defined in the policy.
rtoInMinutes (integer) --
The recovery time objective (RTO) target for multi-AZ, in minutes.
rpoInMinutes (integer) --
The recovery point objective (RPO) target for multi-AZ, in minutes.
disasterRecoveryApproach (string) --
The disaster recovery approach for multi-AZ.
multiRegion (dict) --
The multi-Region disaster recovery targets defined in the policy.
rtoInMinutes (integer) --
The recovery time objective (RTO) target for multi-Region, in minutes.
rpoInMinutes (integer) --
The recovery point objective (RPO) target for multi-Region, in minutes.
disasterRecoveryApproach (string) --
The disaster recovery approach for multi-Region.
dataRecovery (dict) --
The data recovery targets defined in the policy.
timeBetweenBackupsInMinutes (integer) --
The target time between backups, in minutes.
kmsKeyId (string) --
KMS key identifier — accepts key ID, key ARN, alias name, or alias ARN.
tags (dict) --
Resource tags.
(string) --
Tag key.
(string) --
Tag value.
associatedServiceCount (integer) --
The number of services associated with this policy.
createdAt (datetime) --
The timestamp when the policy was created.
updatedAt (datetime) --
The timestamp when the policy was last updated.
Lists dependencies discovered for services.
See also: AWS API Documentation
Request Syntax
client.list_dependencies(
serviceArn='string',
queryRangeStartTime=datetime(2015, 1, 1),
queryRangeEndTime=datetime(2015, 1, 1),
queryRangeGranularity='HOURLY'|'DAILY',
maxResults=123,
nextToken='string'
)
string
ARN identifier.
datetime
The start time for the dependency query range.
datetime
The end time for the dependency query range.
string
The granularity for the dependency query range.
integer
Pagination page size.
string
Pagination token.
dict
Response Syntax
{
'dependencySummaries': [
{
'dependencyId': 'string',
'serviceArn': 'string',
'dependencyName': 'string',
'dnsName': 'string',
'location': 'string',
'lastDetectedTime': datetime(2015, 1, 1),
'sourceRegions': [
'string',
],
'provider': 'string',
'queryRange': {
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'granularity': 'HOURLY'|'DAILY',
'dataPoints': [
{
'timestamp': datetime(2015, 1, 1),
'queryCount': 123
},
]
},
'criticality': 'HARD'|'SOFT'|'UNKNOWN',
'comment': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
dependencySummaries (list) --
The list of dependency summaries.
(dict) --
Contains summary information about a discovered dependency.
dependencyId (string) --
The unique identifier of the dependency.
serviceArn (string) --
ARN identifier.
dependencyName (string) --
The name of the dependency.
dnsName (string) --
The DNS name associated with the dependency.
location (string) --
The location of the dependency.
lastDetectedTime (datetime) --
The timestamp when the dependency was last detected.
sourceRegions (list) --
The source Regions from which the dependency was detected.
(string) --
provider (string) --
The provider of the dependency.
queryRange (dict) --
The query range data for the dependency.
startTime (datetime) --
The start time of the query range.
endTime (datetime) --
The end time of the query range.
granularity (string) --
The granularity of the query range data points.
dataPoints (list) --
The data points within the query range.
(dict) --
A data point in a dependency query range.
timestamp (datetime) --
The timestamp of the data point.
queryCount (integer) --
The number of queries at this data point.
criticality (string) --
The criticality level of the dependency.
comment (string) --
A user-provided comment about the dependency.
nextToken (string) --
Pagination token.
Updates an existing finding.
See also: AWS API Documentation
Request Syntax
client.update_failure_mode_finding(
findingId='string',
status='OPEN'|'RESOLVED'|'IRRELEVANT',
serviceArn='string',
comment='string'
)
string
[REQUIRED]
The identifier of the finding to update.
string
[REQUIRED]
The new status for the finding.
string
[REQUIRED]
ARN identifier.
string
A comment about the finding update.
dict
Response Syntax
{
'finding': {
'findingId': 'string',
'name': 'string',
'description': 'string',
'failureCategory': 'SHARED_FATE'|'EXCESSIVE_LOAD'|'EXCESSIVE_LATENCY'|'MISCONFIGURATION_AND_BUGS'|'SINGLE_POINT_OF_FAILURE',
'status': 'OPEN'|'RESOLVED'|'IRRELEVANT',
'reasoning': 'string',
'comment': 'string',
'severity': 'LOW'|'MEDIUM'|'HIGH',
'serviceFunctions': [
'string',
],
'policyComponent': 'AVAILABILITY_SLO'|'MULTI_AZ_DISASTER_RECOVERY'|'MULTI_REGION_DISASTER_RECOVERY'|'DATA_RECOVERY',
'infrastructureAndCodeRecommendations': [
{
'suggestedChanges': [
'string',
]
},
],
'observabilityRecommendations': [
{
'suggestedChanges': [
'string',
]
},
],
'testingRecommendations': [
{
'suggestedChanges': [
'string',
]
},
],
'updatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
finding (dict) --
The updated finding.
findingId (string) --
The unique identifier of the finding.
name (string) --
The name of the finding.
description (string) --
Resource description.
failureCategory (string) --
The failure category of the finding.
status (string) --
The current status of the finding.
reasoning (string) --
The reasoning behind the finding.
comment (string) --
A user-provided comment about the finding.
severity (string) --
The severity of the finding.
serviceFunctions (list) --
The service functions associated with the finding.
(string) --
policyComponent (string) --
The policy component associated with the finding.
infrastructureAndCodeRecommendations (list) --
Infrastructure and code recommendations to address the finding.
(dict) --
An infrastructure and code recommendation to address a finding.
suggestedChanges (list) --
The list of suggested changes.
(string) --
Resource description.
observabilityRecommendations (list) --
Observability recommendations to address the finding.
(dict) --
An observability recommendation to address a finding.
suggestedChanges (list) --
The list of suggested observability changes.
(string) --
Resource description.
testingRecommendations (list) --
Testing recommendations to address the finding.
(dict) --
A testing recommendation to address a finding.
suggestedChanges (list) --
The list of suggested testing changes.
(string) --
Resource description.
updatedAt (datetime) --
The timestamp when the finding was last updated.
Lists events for a system.
See also: AWS API Documentation
Request Syntax
client.list_system_events(
systemArn='string',
eventTypes=[
'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',
],
startTime=datetime(2015, 1, 1),
endTime=datetime(2015, 1, 1),
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
ARN identifier.
list
Filter events by type.
(string) --
datetime
The start time for filtering events.
datetime
The end time for filtering events.
integer
Pagination page size.
string
Pagination token.
dict
Response Syntax
{
'events': [
{
'eventId': 'string',
'timestamp': datetime(2015, 1, 1),
'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',
'actor': {
'type': 'USER'|'SYSTEM',
'principalId': 'string',
'accountId': 'string',
'userName': 'string'
},
'eventDetails': {
'title': 'string',
'description': 'string',
'eventMetadata': {
'systemCreated': {},
'systemDeleted': {},
'systemUserJourneyCreated': {
'userJourneyName': 'string',
'associatedServices': [
{
'serviceId': 'string',
'serviceName': 'string'
},
]
},
'systemUserJourneyUpdated': {
'userJourneyName': 'string',
'changes': {
'journeyDescription': {
'oldValue': 'string',
'newValue': 'string'
},
'associatedServices': {
'added': [
{
'serviceId': 'string',
'serviceName': 'string'
},
],
'removed': [
{
'serviceId': 'string',
'serviceName': 'string'
},
]
}
}
},
'systemUserJourneyDeleted': {
'userJourneyName': 'string',
'associatedServicesAtDeletion': [
{
'serviceId': 'string',
'serviceName': 'string'
},
]
},
'systemServiceAssociated': {
'serviceName': 'string',
'serviceArn': 'string',
'userJourneys': [
'string',
]
},
'systemServiceDisassociated': {
'serviceName': 'string',
'serviceArn': 'string',
'userJourneysAffected': [
'string',
],
'comment': 'string'
},
'systemPolicyAssociated': {
'policyName': 'string',
'policyArn': 'string'
},
'systemPolicyDisassociated': {
'policyName': 'string',
'policyArn': 'string'
}
}
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
events (list) --
The list of system events.
(dict) --
Represents an event in the system event log.
eventId (string) --
The unique identifier of the event.
timestamp (datetime) --
The timestamp of the event.
eventType (string) --
The type of the event.
systemArn (string) --
ARN identifier.
actor (dict) --
The actor that triggered the event.
type (string) --
The type of actor, either USER or SYSTEM.
principalId (string) --
The principal ID of the actor.
accountId (string) --
The AWS account ID of the actor.
userName (string) --
The user name of the actor.
eventDetails (dict) --
The details of the event.
title (string) --
The title of the event.
description (string) --
The description of the event.
eventMetadata (dict) --
Type-specific metadata for each system event type.
systemCreated (dict) --
Metadata for a system created event.
systemDeleted (dict) --
Metadata for a system deleted event.
systemUserJourneyCreated (dict) --
Metadata for a system user journey created event.
userJourneyName (string) --
The name of the created user journey.
associatedServices (list) --
The services associated with the created user journey.
(dict) --
A reference to a service by ID and name.
serviceId (string) --
The identifier of the referenced service.
serviceName (string) --
The name of the referenced service.
systemUserJourneyUpdated (dict) --
Metadata for a system user journey updated event.
userJourneyName (string) --
The name of the updated user journey.
changes (dict) --
The changes made to the user journey.
journeyDescription (dict) --
Changes to the user journey description.
oldValue (string) --
The old value.
newValue (string) --
The new value.
associatedServices (dict) --
Changes to the services associated with the user journey.
added (list) --
The list of service references that were added.
(dict) --
A reference to a service by ID and name.
serviceId (string) --
The identifier of the referenced service.
serviceName (string) --
The name of the referenced service.
removed (list) --
The list of service references that were removed.
(dict) --
A reference to a service by ID and name.
serviceId (string) --
The identifier of the referenced service.
serviceName (string) --
The name of the referenced service.
systemUserJourneyDeleted (dict) --
Metadata for a system user journey deleted event.
userJourneyName (string) --
The name of the deleted user journey.
associatedServicesAtDeletion (list) --
The services that were associated at the time of deletion.
(dict) --
A reference to a service by ID and name.
serviceId (string) --
The identifier of the referenced service.
serviceName (string) --
The name of the referenced service.
systemServiceAssociated (dict) --
Metadata for a system service associated event.
serviceName (string) --
The name of the associated service.
serviceArn (string) --
ARN identifier.
userJourneys (list) --
The user journeys linking the service to the system.
(string) --
systemServiceDisassociated (dict) --
Metadata for a system service disassociated event.
serviceName (string) --
The name of the disassociated service.
serviceArn (string) --
ARN identifier.
userJourneysAffected (list) --
The user journeys affected by the disassociation.
(string) --
comment (string) --
A comment about the disassociation.
systemPolicyAssociated (dict) --
Metadata for a system policy associated event.
policyName (string) --
The name of the associated policy.
policyArn (string) --
ARN identifier.
systemPolicyDisassociated (dict) --
Metadata for a system policy disassociated event.
policyName (string) --
The name of the disassociated policy.
policyArn (string) --
ARN identifier.
nextToken (string) --
Pagination token.
Deletes a resilience assertion from a service.
See also: AWS API Documentation
Request Syntax
client.delete_assertion(
serviceArn='string',
assertionId='string'
)
string
[REQUIRED]
ARN identifier.
string
[REQUIRED]
The unique identifier of the assertion to delete.
dict
Response Syntax
{
'assertionId': 'string'
}
Response Structure
(dict) --
assertionId (string) --
The unique identifier of the deleted assertion.
Updates an existing service.
See also: AWS API Documentation
Request Syntax
client.update_service(
serviceArn='string',
description='string',
associatedSystems=[
{
'systemArn': 'string',
'systemName': 'string',
'userJourneyIds': [
'string',
]
},
],
policyArn='string',
regions=[
'string',
],
permissionModel={
'invokerRoleName': 'string',
'crossAccountRoles': [
{
'crossAccountRoleArn': 'string',
'externalId': 'string'
},
]
},
dependencyDiscovery='ENABLED'|'DISABLED',
reportConfiguration={
'reportOutputs': [
{
's3': {
'bucketPath': 'string',
'bucketOwner': 'string'
}
},
]
}
)
string
[REQUIRED]
ARN identifier.
string
Resource description for services and policies.
list
The updated systems to associate with the service.
(dict) --
Represents a system associated with a service.
systemArn (string) -- [REQUIRED]
ARN identifier.
systemName (string) --
Resource name (used in ARN — no spaces allowed).
userJourneyIds (list) --
The list of user journey identifiers that associate this system with the service.
(string) --
string
ARN identifier.
list
The updated AWS Regions where the service operates.
(string) --
dict
The updated permission model for the service.
invokerRoleName (string) -- [REQUIRED]
IAM role name (supports up to 64 characters per IAM limits).
crossAccountRoles (list) --
The list of cross-account IAM role ARNs.
(dict) --
Specifies a cross-account IAM role ARN and optional external ID.
crossAccountRoleArn (string) -- [REQUIRED]
ARN of the IAM Role for the profile. Null if the permission profile is the 'Admin' profile.
externalId (string) --
The external ID used for assuming the cross-account role.
string
Caller-settable values for dependency discovery. INITIALIZING is system-managed.
dict
Configuration for automatic report generation on a Service.
reportOutputs (list) -- [REQUIRED]
Output destinations for generated reports.
(dict) --
Configuration for a report output destination.
s3 (dict) --
S3 configuration for report output.
bucketPath (string) -- [REQUIRED]
S3 bucket path where reports will be written (e.g., my-bucket/ngrh-reports/).
bucketOwner (string) -- [REQUIRED]
Account ID of the bucket owner for cross-account access verification.
dict
Response Syntax
{
'service': {
'serviceArn': 'string',
'name': 'string',
'description': 'string',
'associatedSystems': [
{
'systemArn': 'string',
'systemName': 'string',
'userJourneyIds': [
'string',
]
},
],
'policyArn': 'string',
'regions': [
'string',
],
'permissionModel': {
'invokerRoleName': 'string',
'crossAccountRoles': [
{
'crossAccountRoleArn': 'string',
'externalId': 'string'
},
]
},
'dependencyDiscovery': {
'status': 'ENABLED'|'INITIALIZING'|'DISABLED',
'updatedAt': datetime(2015, 1, 1)
},
'effectivePolicyValues': {
'availabilitySlo': {
'value': 123.0,
'policyName': 'string',
'source': 'SELF'|'CROSS_ACCOUNT'
},
'multiAzRto': {
'value': 123,
'policyName': 'string',
'source': 'SELF'|'CROSS_ACCOUNT'
},
'multiAzRpo': {
'value': 123,
'policyName': 'string',
'source': 'SELF'|'CROSS_ACCOUNT'
},
'multiAzDrApproach': {
'value': 'string',
'policyName': 'string',
'source': 'SELF'|'CROSS_ACCOUNT'
},
'multiRegionRto': {
'value': 123,
'policyName': 'string',
'source': 'SELF'|'CROSS_ACCOUNT'
},
'multiRegionRpo': {
'value': 123,
'policyName': 'string',
'source': 'SELF'|'CROSS_ACCOUNT'
},
'multiRegionDrApproach': {
'value': 'string',
'policyName': 'string',
'source': 'SELF'|'CROSS_ACCOUNT'
},
'dataRecoveryTimeBetweenBackups': {
'value': 123,
'policyName': 'string',
'source': 'SELF'|'CROSS_ACCOUNT'
}
},
'achievability': {
'availabilitySlo': 'ACHIEVABLE'|'NOT_ACHIEVABLE',
'multiAzRtoRpo': 'ACHIEVABLE'|'NOT_ACHIEVABLE',
'multiRegionRtoRpo': 'ACHIEVABLE'|'NOT_ACHIEVABLE'
},
'reportConfiguration': {
'reportOutputs': [
{
's3': {
'bucketPath': 'string',
'bucketOwner': 'string'
}
},
]
},
'kmsKeyId': 'string',
'tags': {
'string': 'string'
},
'estimatedAssessmentCost': {
'amount': 123.0,
'currency': 'USD'
},
'resourceDiscovery': {
'status': 'RUNNING'|'SUCCEEDED'|'FAILED'|'COMPLETED_WITH_FAILURES'|'NOT_STARTED',
'lastRunAt': datetime(2015, 1, 1),
'errorCode': 'INVALID_PERMISSIONS'|'STACK_NOT_FOUND'|'CLUSTER_NOT_FOUND'|'STATE_FILE_NOT_FOUND'|'ACCESS_DENIED'|'UNSUPPORTED_CLUSTER'|'INTERNAL_ERROR',
'errorMessage': 'string'
},
'assessmentStatus': 'NOT_STARTED'|'PENDING'|'IN_PROGRESS'|'FAILED'|'SUCCESS',
'rerunAssessment': True|False,
'openFindingsCount': 123,
'resolvedFindingsCount': 123,
'organizationId': 'string',
'ouId': 'string',
'accountId': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
service (dict) --
The updated service.
serviceArn (string) --
ARN identifier.
name (string) --
Resource name (used in ARN — no spaces allowed).
description (string) --
Resource description for services and policies.
associatedSystems (list) --
The systems associated with the service.
(dict) --
Represents a system associated with a service.
systemArn (string) --
ARN identifier.
systemName (string) --
Resource name (used in ARN — no spaces allowed).
userJourneyIds (list) --
The list of user journey identifiers that associate this system with the service.
(string) --
policyArn (string) --
ARN identifier.
regions (list) --
The AWS Regions where the service operates.
(string) --
permissionModel (dict) --
The permission model for the service.
invokerRoleName (string) --
IAM role name (supports up to 64 characters per IAM limits).
crossAccountRoles (list) --
The list of cross-account IAM role ARNs.
(dict) --
Specifies a cross-account IAM role ARN and optional external ID.
crossAccountRoleArn (string) --
ARN of the IAM Role for the profile. Null if the permission profile is the 'Admin' profile.
externalId (string) --
The external ID used for assuming the cross-account role.
dependencyDiscovery (dict) --
The dependency discovery configuration for the service.
status (string) --
The current status of dependency discovery.
updatedAt (datetime) --
The timestamp when dependency discovery was last updated.
effectivePolicyValues (dict) --
The effective policy values for the service.
availabilitySlo (dict) --
The effective availability SLO value for the service.
value (float) --
The availability SLO percentage value.
policyName (string) --
Resource name (used in ARN — no spaces allowed).
source (string) --
Indicates whether the value comes from the service's own account or a cross-account policy.
multiAzRto (dict) --
The effective multi-AZ RTO value for the service, in minutes.
value (integer) --
The RTO or RPO value in minutes.
policyName (string) --
Resource name (used in ARN — no spaces allowed).
source (string) --
Indicates whether the value comes from the service's own account or a cross-account policy.
multiAzRpo (dict) --
The effective multi-AZ RPO value for the service, in minutes.
value (integer) --
The RTO or RPO value in minutes.
policyName (string) --
Resource name (used in ARN — no spaces allowed).
source (string) --
Indicates whether the value comes from the service's own account or a cross-account policy.
multiAzDrApproach (dict) --
The effective multi-AZ disaster recovery approach for the service.
value (string) --
The disaster recovery approach value.
policyName (string) --
Resource name (used in ARN — no spaces allowed).
source (string) --
Indicates whether the value comes from the service's own account or a cross-account policy.
multiRegionRto (dict) --
The effective multi-Region RTO value for the service, in minutes.
value (integer) --
The RTO or RPO value in minutes.
policyName (string) --
Resource name (used in ARN — no spaces allowed).
source (string) --
Indicates whether the value comes from the service's own account or a cross-account policy.
multiRegionRpo (dict) --
The effective multi-Region RPO value for the service, in minutes.
value (integer) --
The RTO or RPO value in minutes.
policyName (string) --
Resource name (used in ARN — no spaces allowed).
source (string) --
Indicates whether the value comes from the service's own account or a cross-account policy.
multiRegionDrApproach (dict) --
The effective multi-Region disaster recovery approach for the service.
value (string) --
The disaster recovery approach value.
policyName (string) --
Resource name (used in ARN — no spaces allowed).
source (string) --
Indicates whether the value comes from the service's own account or a cross-account policy.
dataRecoveryTimeBetweenBackups (dict) --
The effective data recovery time between backups value for the service.
value (integer) --
The RTO or RPO value in minutes.
policyName (string) --
Resource name (used in ARN — no spaces allowed).
source (string) --
Indicates whether the value comes from the service's own account or a cross-account policy.
achievability (dict) --
The achievability status of the service's resilience targets.
availabilitySlo (string) --
The achievability status of the availability SLO target for the service.
multiAzRtoRpo (string) --
The achievability status of the multi-AZ RTO and RPO targets for the service.
multiRegionRtoRpo (string) --
The achievability status of the multi-Region RTO and RPO targets for the service.
reportConfiguration (dict) --
Configuration for automatic report generation on a Service.
reportOutputs (list) --
Output destinations for generated reports.
(dict) --
Configuration for a report output destination.
s3 (dict) --
S3 configuration for report output.
bucketPath (string) --
S3 bucket path where reports will be written (e.g., my-bucket/ngrh-reports/).
bucketOwner (string) --
Account ID of the bucket owner for cross-account access verification.
kmsKeyId (string) --
KMS key identifier — accepts key ID, key ARN, alias name, or alias ARN.
tags (dict) --
Resource tags.
(string) --
Tag key.
(string) --
Tag value.
estimatedAssessmentCost (dict) --
The estimated cost of running an assessment on the service.
amount (float) --
The cost amount for the assessment.
currency (string) --
The currency of the assessment cost.
resourceDiscovery (dict) --
The resource discovery status for the service.
status (string) --
The current status of resource discovery.
lastRunAt (datetime) --
The timestamp of the last resource discovery run.
errorCode (string) --
The error code if resource discovery failed.
errorMessage (string) --
A message describing the error if resource discovery failed.
assessmentStatus (string) --
The current assessment status of the service.
rerunAssessment (boolean) --
Indicates whether the assessment should be rerun.
openFindingsCount (integer) --
The number of open findings for the service.
resolvedFindingsCount (integer) --
The number of resolved findings for the service.
organizationId (string) --
The AWS Organizations identifier for the service.
ouId (string) --
The organizational unit (OU) identifier for the service.
accountId (string) --
The AWS account ID that owns the service.
createdAt (datetime) --
The timestamp when the service was created.
updatedAt (datetime) --
The timestamp when the service was last updated.
Lists the tags for a resource.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
resourceArn='string'
)
string
[REQUIRED]
ARN identifier.
dict
Response Syntax
{
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
tags (dict) --
Resource tags.
(string) --
Tag key.
(string) --
Tag value.
Deletes a service.
See also: AWS API Documentation
Request Syntax
client.delete_service(
serviceArn='string'
)
string
[REQUIRED]
ARN identifier.
dict
Response Syntax
{
'serviceArn': 'string'
}
Response Structure
(dict) --
serviceArn (string) --
ARN identifier.
Lists topology edges for a service.
See also: AWS API Documentation
Request Syntax
client.list_service_topology_edges(
serviceArn='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
ARN identifier.
integer
Pagination page size.
string
Pagination token.
dict
Response Syntax
{
'serviceTopologyEdgeSummaries': [
{
'sourceResourceIdentifier': 'string',
'destinationResourceIdentifier': 'string',
'properties': [
{
'topologyType': 'CONTAINMENT'|'DATA_FLOW'|'OBSERVABILITY'|'PERMISSIONS',
'label': 'string'
},
]
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
serviceTopologyEdgeSummaries (list) --
The list of service topology edge summaries.
(dict) --
Contains summary information about a service topology edge.
sourceResourceIdentifier (string) --
The identifier of the source resource.
destinationResourceIdentifier (string) --
The identifier of the destination resource.
properties (list) --
The properties of the topology edge.
(dict) --
Contains property information for a service topology edge.
topologyType (string) --
The topology type of the edge.
label (string) --
Human-readable relationship description. Only present for LLM-inferred edges.
nextToken (string) --
Pagination token.
Lists service functions for a service.
See also: AWS API Documentation
Request Syntax
client.list_service_functions(
serviceArn='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
ARN identifier.
integer
Pagination page size.
string
Pagination token.
dict
Response Syntax
{
'serviceFunctions': [
{
'serviceArn': 'string',
'serviceFunctionId': 'string',
'name': 'string',
'description': 'string',
'criticality': 'PRIMARY'|'SUPPLEMENTAL',
'resourceCount': 123,
'source': 'AI_GENERATED'|'USER',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
serviceFunctions (list) --
The list of service functions.
(dict) --
Represents a logical component of a service.
serviceArn (string) --
ARN identifier.
serviceFunctionId (string) --
The unique identifier of the service function.
name (string) --
Entity label (not part of ARN — spaces allowed).
description (string) --
Resource description.
criticality (string) --
The criticality level of the service function.
resourceCount (integer) --
The number of resources associated with the service function.
source (string) --
The source of the service function.
createdAt (datetime) --
The timestamp when the service function was created.
updatedAt (datetime) --
The timestamp when the service function was last updated.
nextToken (string) --
Pagination token.
Deletes an input source.
See also: AWS API Documentation
Request Syntax
client.delete_input_source(
serviceArn='string',
inputSourceId='string'
)
string
[REQUIRED]
ARN identifier.
string
[REQUIRED]
The identifier of the input source to delete.
dict
Response Syntax
{
'serviceArn': 'string',
'inputSourceId': 'string'
}
Response Structure
(dict) --
serviceArn (string) --
ARN identifier.
inputSourceId (string) --
The identifier of the deleted input source.
Start a failure mode assessment.
See also: AWS API Documentation
Request Syntax
client.start_failure_mode_assessment(
serviceArn='string',
clientToken='string'
)
string
[REQUIRED]
ARN identifier.
string
Idempotency token.
This field is autopopulated if not provided.
dict
Response Syntax
{
'assessmentId': 'string',
'serviceArn': 'string',
'assessmentStatus': 'NOT_STARTED'|'PENDING'|'IN_PROGRESS'|'FAILED'|'SUCCESS',
'startedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
assessmentId (string) --
The unique identifier of the started assessment.
serviceArn (string) --
ARN identifier.
assessmentStatus (string) --
The status of the started assessment.
startedAt (datetime) --
The timestamp when the assessment started.
Deletes a resilience policy.
See also: AWS API Documentation
Request Syntax
client.delete_policy(
policyArn='string'
)
string
[REQUIRED]
ARN identifier.
dict
Response Syntax
{
'policyArn': 'string'
}
Response Structure
(dict) --
policyArn (string) --
ARN identifier.
Deletes a system.
See also: AWS API Documentation
Request Syntax
client.delete_system(
systemArn='string'
)
string
[REQUIRED]
ARN identifier.
dict
Response Syntax
{
'systemArn': 'string'
}
Response Structure
(dict) --
systemArn (string) --
ARN identifier.
Removes resources from a service function.
See also: AWS API Documentation
Request Syntax
client.delete_service_function_resources(
serviceArn='string',
serviceFunctionId='string',
resources=[
'string',
]
)
string
[REQUIRED]
ARN identifier.
string
[REQUIRED]
The identifier of the service function to remove resources from.
list
[REQUIRED]
The list of resources to remove from the service function.
(string) --
dict
Response Syntax
{
'serviceArn': 'string',
'serviceFunctionId': 'string',
'resources': [
'string',
]
}
Response Structure
(dict) --
serviceArn (string) --
ARN identifier.
serviceFunctionId (string) --
The identifier of the service function.
resources (list) --
The list of resources that were removed.
(string) --
Lists user journeys for a system.
See also: AWS API Documentation
Request Syntax
client.list_user_journeys(
systemArn='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
ARN identifier.
integer
Pagination page size.
string
Pagination token.
dict
Response Syntax
{
'userJourneySummaries': [
{
'userJourneyId': 'string',
'name': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
userJourneySummaries (list) --
The list of user journey summaries.
(dict) --
Contains summary information about a user journey.
userJourneyId (string) --
The unique identifier of the user journey.
name (string) --
Entity label (not part of ARN — spaces allowed).
createdAt (datetime) --
The timestamp when the user journey was created.
updatedAt (datetime) --
The timestamp when the user journey was last updated.
nextToken (string) --
Pagination token.
Adds tags to a resource.
See also: AWS API Documentation
Request Syntax
client.tag_resource(
resourceArn='string',
tags={
'string': 'string'
}
)
string
[REQUIRED]
ARN identifier.
dict
[REQUIRED]
Resource tags.
(string) --
Tag key.
(string) --
Tag value.
dict
Response Syntax
{}
Response Structure
(dict) --
Updates a resilience assertion.
See also: AWS API Documentation
Request Syntax
client.update_assertion(
serviceArn='string',
assertionId='string',
text='string'
)
string
[REQUIRED]
ARN identifier.
string
[REQUIRED]
The unique identifier of the assertion to update.
string
The updated text content of the assertion.
dict
Response Syntax
{
'assertion': {
'serviceArn': 'string',
'assertionId': 'string',
'text': 'string',
'source': 'AI_GENERATED'|'USER',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
assertion (dict) --
The updated assertion.
serviceArn (string) --
ARN identifier.
assertionId (string) --
The unique identifier of the assertion.
text (string) --
The text content of the assertion.
source (string) --
The source of the assertion, indicating whether it was AI-generated or created by a user.
createdAt (datetime) --
The timestamp when the assertion was created.
updatedAt (datetime) --
The timestamp when the assertion was last updated.
Deletes a user journey.
See also: AWS API Documentation
Request Syntax
client.delete_user_journey(
systemArn='string',
userJourneyId='string'
)
string
[REQUIRED]
ARN identifier.
string
[REQUIRED]
The identifier of the user journey to delete.
dict
Response Syntax
{
'userJourneyId': 'string'
}
Response Structure
(dict) --
userJourneyId (string) --
The identifier of the deleted user journey.
Updates an existing user journey.
See also: AWS API Documentation
Request Syntax
client.update_user_journey(
systemArn='string',
userJourneyId='string',
name='string',
description='string',
policyArn='string'
)
string
[REQUIRED]
ARN identifier.
string
[REQUIRED]
The identifier of the user journey to update.
string
Entity label (not part of ARN — spaces allowed).
string
Resource description.
string
ARN identifier.
dict
Response Syntax
{
'userJourney': {
'userJourneyId': 'string',
'name': 'string',
'description': 'string',
'policyArn': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
userJourney (dict) --
The updated user journey.
userJourneyId (string) --
The unique identifier of the user journey.
name (string) --
Entity label (not part of ARN — spaces allowed).
description (string) --
Resource description.
policyArn (string) --
ARN identifier.
createdAt (datetime) --
The timestamp when the user journey was created.
updatedAt (datetime) --
The timestamp when the user journey was last updated.
Lists events for a service.
See also: AWS API Documentation
Request Syntax
client.list_service_events(
serviceArn='string',
eventTypes=[
'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',
],
startTime=datetime(2015, 1, 1),
endTime=datetime(2015, 1, 1),
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
ARN identifier.
list
Filter events by type.
(string) --
datetime
The start time for filtering events.
datetime
The end time for filtering events.
integer
Pagination page size.
string
Pagination token.
dict
Response Syntax
{
'events': [
{
'eventId': 'string',
'timestamp': datetime(2015, 1, 1),
'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',
'actor': {
'type': 'USER'|'SYSTEM',
'principalId': 'string',
'accountId': 'string',
'userName': 'string'
},
'eventDetails': {
'title': 'string',
'description': 'string',
'eventMetadata': {
'serviceCreated': {},
'serviceDeleted': {},
'serviceSystemAssociated': {
'systemName': 'string',
'systemArn': 'string'
},
'serviceSystemDisassociated': {
'systemId': 'string',
'systemName': 'string',
'systemArn': 'string'
},
'serviceResourcesAssociated': {
'resourceCount': 123,
'resourceTypes': [
'string',
]
},
'serviceResourcesDisassociated': {
'resourceCount': 123,
'resourceTypes': [
'string',
]
},
'serviceWorkflowUpdated': {
'serviceFunctionId': 'string',
'serviceFunctionName': 'string'
},
'serviceInputSourcesUpdated': {},
'servicePolicyAssociated': {
'policyName': 'string',
'policyArn': 'string'
},
'servicePolicyDisassociated': {
'policyName': 'string',
'policyArn': 'string'
},
'serviceFunctionCreated': {
'serviceFunctionId': 'string',
'serviceFunctionName': 'string'
},
'serviceFunctionUpdated': {
'serviceFunctionId': 'string',
'serviceFunctionName': 'string',
'resourcesAdded': [
'string',
],
'resourcesRemoved': [
'string',
]
},
'serviceFunctionDeleted': {
'serviceFunctionId': 'string',
'serviceFunctionName': 'string'
},
'serviceFunctionResourcesAdded': {
'serviceFunctionId': 'string',
'serviceFunctionName': 'string',
'resourcesAdded': [
'string',
]
},
'serviceFunctionResourcesRemoved': {
'serviceFunctionId': 'string',
'serviceFunctionName': 'string',
'resourcesRemoved': [
'string',
]
},
'serviceAchievabilityUpdated': {
'assessmentId': 'string',
'availabilitySlo': 'string',
'multiAzRtoRpo': 'string',
'multiRegionRtoRpo': 'string'
},
'assertionCreated': {
'assertionId': 'string',
'assertionName': 'string'
},
'assertionUpdated': {
'assertionId': 'string',
'assertionName': 'string'
},
'assertionDeleted': {
'assertionId': 'string',
'assertionName': 'string'
}
}
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
events (list) --
The list of service events.
(dict) --
Represents an event in the service event log.
eventId (string) --
The unique identifier of the event.
timestamp (datetime) --
The timestamp of the event.
eventType (string) --
The type of the event.
serviceArn (string) --
ARN identifier.
actor (dict) --
The actor that triggered the event.
type (string) --
The type of actor, either USER or SYSTEM.
principalId (string) --
The principal ID of the actor.
accountId (string) --
The AWS account ID of the actor.
userName (string) --
The user name of the actor.
eventDetails (dict) --
The details of the event.
title (string) --
The title of the event.
description (string) --
The description of the event.
eventMetadata (dict) --
Type-specific metadata for each service event type.
serviceCreated (dict) --
Metadata for a service created event.
serviceDeleted (dict) --
Metadata for a service deleted event.
serviceSystemAssociated (dict) --
Metadata for a service system associated event.
systemName (string) --
The name of the associated system.
systemArn (string) --
ARN identifier.
serviceSystemDisassociated (dict) --
Metadata for a service system disassociated event.
systemId (string) --
The identifier of the disassociated system.
systemName (string) --
The name of the disassociated system.
systemArn (string) --
ARN identifier.
serviceResourcesAssociated (dict) --
Metadata for a service resources associated event.
resourceCount (integer) --
The number of resources associated.
resourceTypes (list) --
The types of resources associated.
(string) --
serviceResourcesDisassociated (dict) --
Metadata for a service resources disassociated event.
resourceCount (integer) --
The number of resources disassociated.
resourceTypes (list) --
The types of resources disassociated.
(string) --
serviceWorkflowUpdated (dict) --
Metadata for a service workflow updated event.
serviceFunctionId (string) --
The identifier of the service function.
serviceFunctionName (string) --
The name of the service function.
serviceInputSourcesUpdated (dict) --
Metadata for a service input sources updated event.
servicePolicyAssociated (dict) --
Metadata for a service policy associated event.
policyName (string) --
The name of the associated policy.
policyArn (string) --
ARN identifier.
servicePolicyDisassociated (dict) --
Metadata for a service policy disassociated event.
policyName (string) --
The name of the disassociated policy.
policyArn (string) --
ARN identifier.
serviceFunctionCreated (dict) --
Metadata for a service function created event.
serviceFunctionId (string) --
The identifier of the created service function.
serviceFunctionName (string) --
The name of the created service function.
serviceFunctionUpdated (dict) --
Metadata for a service function updated event.
serviceFunctionId (string) --
The identifier of the service function.
serviceFunctionName (string) --
The name of the service function.
resourcesAdded (list) --
The list of resource ARNs that were added.
(string) --
ARN identifier.
resourcesRemoved (list) --
The list of resource ARNs that were removed.
(string) --
ARN identifier.
serviceFunctionDeleted (dict) --
Metadata for a service function deleted event.
serviceFunctionId (string) --
The identifier of the deleted service function.
serviceFunctionName (string) --
The name of the deleted service function.
serviceFunctionResourcesAdded (dict) --
Metadata for a service function resources added event.
serviceFunctionId (string) --
The identifier of the service function.
serviceFunctionName (string) --
The name of the service function.
resourcesAdded (list) --
The list of resource ARNs that were added.
(string) --
ARN identifier.
serviceFunctionResourcesRemoved (dict) --
Metadata for a service function resources removed event.
serviceFunctionId (string) --
The identifier of the service function.
serviceFunctionName (string) --
The name of the service function.
resourcesRemoved (list) --
The list of resource ARNs that were removed.
(string) --
ARN identifier.
serviceAchievabilityUpdated (dict) --
Metadata for a service achievability updated event.
assessmentId (string) --
The assessment identifier that triggered the update.
availabilitySlo (string) --
The updated achievability status of the availability SLO.
multiAzRtoRpo (string) --
The updated achievability status of the multi-AZ RTO and RPO targets.
multiRegionRtoRpo (string) --
The updated achievability status of the multi-Region RTO and RPO targets.
assertionCreated (dict) --
Metadata for an assertion created event.
assertionId (string) --
The unique identifier of the created assertion.
assertionName (string) --
The name of the created assertion.
assertionUpdated (dict) --
Metadata for an assertion updated event.
assertionId (string) --
The unique identifier of the updated assertion.
assertionName (string) --
The name of the updated assertion.
assertionDeleted (dict) --
Metadata for an assertion deleted event.
assertionId (string) --
The unique identifier of the deleted assertion.
assertionName (string) --
The name of the deleted assertion.
nextToken (string) --
Pagination token.
Retrieves a user journey.
See also: AWS API Documentation
Request Syntax
client.get_user_journey(
systemArn='string',
userJourneyId='string'
)
string
[REQUIRED]
ARN identifier.
string
[REQUIRED]
The identifier of the user journey to retrieve.
dict
Response Syntax
{
'userJourney': {
'userJourneyId': 'string',
'name': 'string',
'description': 'string',
'policyArn': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
userJourney (dict) --
The requested user journey.
userJourneyId (string) --
The unique identifier of the user journey.
name (string) --
Entity label (not part of ARN — spaces allowed).
description (string) --
Resource description.
policyArn (string) --
ARN identifier.
createdAt (datetime) --
The timestamp when the user journey was created.
updatedAt (datetime) --
The timestamp when the user journey was last updated.
Updates an existing resilience policy.
See also: AWS API Documentation
Request Syntax
client.update_policy(
policyArn='string',
description='string',
availabilitySlo={
'target': 123.0
},
multiAz={
'rtoInMinutes': 123,
'rpoInMinutes': 123,
'disasterRecoveryApproach': 'ACTIVE_ACTIVE'|'HOT_STANDBY'|'WARM_STANDBY'|'PILOT_LIGHT'|'BACKUP_AND_RESTORE'
},
multiRegion={
'rtoInMinutes': 123,
'rpoInMinutes': 123,
'disasterRecoveryApproach': 'ACTIVE_ACTIVE'|'HOT_STANDBY'|'WARM_STANDBY'|'PILOT_LIGHT'|'BACKUP_AND_RESTORE'
},
dataRecovery={
'timeBetweenBackupsInMinutes': 123
}
)
string
[REQUIRED]
ARN identifier.
string
Resource description for services and policies.
dict
The updated availability SLO for the policy.
target (float) --
The target availability percentage, expressed as a value between 0 and 100.
dict
The updated multi-AZ disaster recovery targets for the policy.
rtoInMinutes (integer) --
The recovery time objective (RTO) target for multi-AZ, in minutes.
rpoInMinutes (integer) --
The recovery point objective (RPO) target for multi-AZ, in minutes.
disasterRecoveryApproach (string) --
The disaster recovery approach for multi-AZ.
dict
The updated multi-Region disaster recovery targets for the policy.
rtoInMinutes (integer) --
The recovery time objective (RTO) target for multi-Region, in minutes.
rpoInMinutes (integer) --
The recovery point objective (RPO) target for multi-Region, in minutes.
disasterRecoveryApproach (string) --
The disaster recovery approach for multi-Region.
dict
The updated data recovery targets for the policy.
timeBetweenBackupsInMinutes (integer) --
The target time between backups, in minutes.
dict
Response Syntax
{
'policy': {
'policyArn': 'string',
'name': 'string',
'description': 'string',
'availabilitySlo': {
'target': 123.0
},
'multiAz': {
'rtoInMinutes': 123,
'rpoInMinutes': 123,
'disasterRecoveryApproach': 'ACTIVE_ACTIVE'|'HOT_STANDBY'|'WARM_STANDBY'|'PILOT_LIGHT'|'BACKUP_AND_RESTORE'
},
'multiRegion': {
'rtoInMinutes': 123,
'rpoInMinutes': 123,
'disasterRecoveryApproach': 'ACTIVE_ACTIVE'|'HOT_STANDBY'|'WARM_STANDBY'|'PILOT_LIGHT'|'BACKUP_AND_RESTORE'
},
'dataRecovery': {
'timeBetweenBackupsInMinutes': 123
},
'kmsKeyId': 'string',
'tags': {
'string': 'string'
},
'associatedServiceCount': 123,
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
policy (dict) --
The updated policy.
policyArn (string) --
ARN identifier.
name (string) --
Resource name (used in ARN — no spaces allowed).
description (string) --
Resource description for services and policies.
availabilitySlo (dict) --
The availability SLO defined in the policy.
target (float) --
The target availability percentage, expressed as a value between 0 and 100.
multiAz (dict) --
The multi-AZ disaster recovery targets defined in the policy.
rtoInMinutes (integer) --
The recovery time objective (RTO) target for multi-AZ, in minutes.
rpoInMinutes (integer) --
The recovery point objective (RPO) target for multi-AZ, in minutes.
disasterRecoveryApproach (string) --
The disaster recovery approach for multi-AZ.
multiRegion (dict) --
The multi-Region disaster recovery targets defined in the policy.
rtoInMinutes (integer) --
The recovery time objective (RTO) target for multi-Region, in minutes.
rpoInMinutes (integer) --
The recovery point objective (RPO) target for multi-Region, in minutes.
disasterRecoveryApproach (string) --
The disaster recovery approach for multi-Region.
dataRecovery (dict) --
The data recovery targets defined in the policy.
timeBetweenBackupsInMinutes (integer) --
The target time between backups, in minutes.
kmsKeyId (string) --
KMS key identifier — accepts key ID, key ARN, alias name, or alias ARN.
tags (dict) --
Resource tags.
(string) --
Tag key.
(string) --
Tag value.
associatedServiceCount (integer) --
The number of services associated with this policy.
createdAt (datetime) --
The timestamp when the policy was created.
updatedAt (datetime) --
The timestamp when the policy was last updated.
Creates a service function within a service.
See also: AWS API Documentation
Request Syntax
client.create_service_function(
name='string',
serviceArn='string',
description='string',
criticality='PRIMARY'|'SUPPLEMENTAL',
clientToken='string'
)
string
[REQUIRED]
Entity label (not part of ARN — spaces allowed).
string
[REQUIRED]
ARN identifier.
string
Resource description.
string
[REQUIRED]
The criticality level of the service function.
string
Idempotency token.
This field is autopopulated if not provided.
dict
Response Syntax
{
'serviceFunction': {
'serviceArn': 'string',
'serviceFunctionId': 'string',
'name': 'string',
'description': 'string',
'criticality': 'PRIMARY'|'SUPPLEMENTAL',
'resourceCount': 123,
'source': 'AI_GENERATED'|'USER',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
serviceFunction (dict) --
The created service function.
serviceArn (string) --
ARN identifier.
serviceFunctionId (string) --
The unique identifier of the service function.
name (string) --
Entity label (not part of ARN — spaces allowed).
description (string) --
Resource description.
criticality (string) --
The criticality level of the service function.
resourceCount (integer) --
The number of resources associated with the service function.
source (string) --
The source of the service function.
createdAt (datetime) --
The timestamp when the service function was created.
updatedAt (datetime) --
The timestamp when the service function was last updated.
Updates a dependency classification.
See also: AWS API Documentation
Request Syntax
client.update_dependency(
serviceArn='string',
dependencyId='string',
criticality='HARD'|'SOFT'|'UNKNOWN',
comment='string'
)
string
[REQUIRED]
ARN identifier.
string
[REQUIRED]
The identifier of the dependency to update.
string
The updated criticality level of the dependency.
string
A comment about the dependency.
dict
Response Syntax
{
'dependencyId': 'string',
'dependencyName': 'string',
'location': 'string',
'criticality': 'HARD'|'SOFT'|'UNKNOWN',
'comment': 'string',
'provider': 'string',
'updatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
dependencyId (string) --
The identifier of the updated dependency.
dependencyName (string) --
The name of the updated dependency.
location (string) --
The location of the dependency.
criticality (string) --
The criticality level of the dependency.
comment (string) --
The comment about the dependency.
provider (string) --
The provider of the dependency.
updatedAt (datetime) --
The timestamp when the dependency was updated.
Lists resilience assertions for a service.
See also: AWS API Documentation
Request Syntax
client.list_assertions(
serviceArn='string',
source='AI_GENERATED'|'USER',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
ARN identifier.
string
Filter assertions by source type.
integer
Pagination page size.
string
Pagination token.
dict
Response Syntax
{
'assertions': [
{
'serviceArn': 'string',
'assertionId': 'string',
'text': 'string',
'source': 'AI_GENERATED'|'USER',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
assertions (list) --
The list of assertions.
(dict) --
Represents a resilience assertion for a service.
serviceArn (string) --
ARN identifier.
assertionId (string) --
The unique identifier of the assertion.
text (string) --
The text content of the assertion.
source (string) --
The source of the assertion, indicating whether it was AI-generated or created by a user.
createdAt (datetime) --
The timestamp when the assertion was created.
updatedAt (datetime) --
The timestamp when the assertion was last updated.
nextToken (string) --
Pagination token.
Lists services.
See also: AWS API Documentation
Request Syntax
client.list_services(
systemArn='string',
userJourneyId='string',
ouId='string',
accountId='string',
assessmentStatus='NOT_STARTED'|'PENDING'|'IN_PROGRESS'|'FAILED'|'SUCCESS',
policyArn='string',
maxResults=123,
nextToken='string'
)
string
ARN identifier.
string
Filter services by user journey identifier.
string
Filter services by organizational unit (OU) identifier.
string
Filter services by AWS account ID.
string
Filter services by assessment status.
string
ARN identifier.
integer
Pagination page size.
string
Pagination token.
dict
Response Syntax
{
'serviceSummaries': [
{
'serviceArn': 'string',
'name': 'string',
'associatedSystems': [
{
'systemArn': 'string',
'systemName': 'string',
'userJourneyIds': [
'string',
]
},
],
'regions': [
'string',
],
'policyArn': 'string',
'assessmentStatus': 'NOT_STARTED'|'PENDING'|'IN_PROGRESS'|'FAILED'|'SUCCESS',
'openFindingsCount': 123,
'resolvedFindingsCount': 123,
'dependencyDiscovery': {
'status': 'ENABLED'|'INITIALIZING'|'DISABLED',
'updatedAt': datetime(2015, 1, 1)
},
'achievability': {
'availabilitySlo': 'ACHIEVABLE'|'NOT_ACHIEVABLE',
'multiAzRtoRpo': 'ACHIEVABLE'|'NOT_ACHIEVABLE',
'multiRegionRtoRpo': 'ACHIEVABLE'|'NOT_ACHIEVABLE'
},
'organizationId': 'string',
'ouId': 'string',
'accountId': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
serviceSummaries (list) --
The list of service summaries.
(dict) --
Contains summary information about a service.
serviceArn (string) --
ARN identifier.
name (string) --
Resource name (used in ARN — no spaces allowed).
associatedSystems (list) --
The systems associated with the service.
(dict) --
Represents a system associated with a service.
systemArn (string) --
ARN identifier.
systemName (string) --
Resource name (used in ARN — no spaces allowed).
userJourneyIds (list) --
The list of user journey identifiers that associate this system with the service.
(string) --
regions (list) --
The AWS Regions where the service operates.
(string) --
policyArn (string) --
ARN identifier.
assessmentStatus (string) --
The current assessment status of the service.
openFindingsCount (integer) --
The number of open findings.
resolvedFindingsCount (integer) --
The number of resolved findings.
dependencyDiscovery (dict) --
The dependency discovery configuration.
status (string) --
The current status of dependency discovery.
updatedAt (datetime) --
The timestamp when dependency discovery was last updated.
achievability (dict) --
The achievability status of the service's resilience targets.
availabilitySlo (string) --
The achievability status of the availability SLO target for the service.
multiAzRtoRpo (string) --
The achievability status of the multi-AZ RTO and RPO targets for the service.
multiRegionRtoRpo (string) --
The achievability status of the multi-Region RTO and RPO targets for the service.
organizationId (string) --
Displayed only if caller has access.
ouId (string) --
Displayed only if caller has access.
accountId (string) --
Displayed only if caller has access.
createdAt (datetime) --
The timestamp when the service was created.
updatedAt (datetime) --
The timestamp when the service was last updated.
nextToken (string) --
Pagination token.
Imports a V1 app into the V2 resource model, creating a service with the same name.
See also: AWS API Documentation
Request Syntax
client.import_app(
v1AppArn='string',
policyArn='string',
kmsKeyId='string',
skipManuallyAddedResources=True|False,
associatedSystems=[
{
'systemArn': 'string',
'systemName': 'string',
'userJourneyIds': [
'string',
]
},
],
tags={
'string': 'string'
},
clientToken='string'
)
string
[REQUIRED]
ARN identifier.
string
ARN identifier.
string
KMS key identifier — accepts key ID, key ARN, alias name, or alias ARN.
boolean
Whether to skip manually added resources during import.
list
The systems to associate with the imported service.
(dict) --
Represents a system associated with a service.
systemArn (string) -- [REQUIRED]
ARN identifier.
systemName (string) --
Resource name (used in ARN — no spaces allowed).
userJourneyIds (list) --
The list of user journey identifiers that associate this system with the service.
(string) --
dict
Resource tags.
(string) --
Tag key.
(string) --
Tag value.
string
Idempotency token.
This field is autopopulated if not provided.
dict
Response Syntax
{
'service': {
'serviceArn': 'string',
'name': 'string',
'description': 'string',
'associatedSystems': [
{
'systemArn': 'string',
'systemName': 'string',
'userJourneyIds': [
'string',
]
},
],
'policyArn': 'string',
'regions': [
'string',
],
'permissionModel': {
'invokerRoleName': 'string',
'crossAccountRoles': [
{
'crossAccountRoleArn': 'string',
'externalId': 'string'
},
]
},
'dependencyDiscovery': {
'status': 'ENABLED'|'INITIALIZING'|'DISABLED',
'updatedAt': datetime(2015, 1, 1)
},
'effectivePolicyValues': {
'availabilitySlo': {
'value': 123.0,
'policyName': 'string',
'source': 'SELF'|'CROSS_ACCOUNT'
},
'multiAzRto': {
'value': 123,
'policyName': 'string',
'source': 'SELF'|'CROSS_ACCOUNT'
},
'multiAzRpo': {
'value': 123,
'policyName': 'string',
'source': 'SELF'|'CROSS_ACCOUNT'
},
'multiAzDrApproach': {
'value': 'string',
'policyName': 'string',
'source': 'SELF'|'CROSS_ACCOUNT'
},
'multiRegionRto': {
'value': 123,
'policyName': 'string',
'source': 'SELF'|'CROSS_ACCOUNT'
},
'multiRegionRpo': {
'value': 123,
'policyName': 'string',
'source': 'SELF'|'CROSS_ACCOUNT'
},
'multiRegionDrApproach': {
'value': 'string',
'policyName': 'string',
'source': 'SELF'|'CROSS_ACCOUNT'
},
'dataRecoveryTimeBetweenBackups': {
'value': 123,
'policyName': 'string',
'source': 'SELF'|'CROSS_ACCOUNT'
}
},
'achievability': {
'availabilitySlo': 'ACHIEVABLE'|'NOT_ACHIEVABLE',
'multiAzRtoRpo': 'ACHIEVABLE'|'NOT_ACHIEVABLE',
'multiRegionRtoRpo': 'ACHIEVABLE'|'NOT_ACHIEVABLE'
},
'reportConfiguration': {
'reportOutputs': [
{
's3': {
'bucketPath': 'string',
'bucketOwner': 'string'
}
},
]
},
'kmsKeyId': 'string',
'tags': {
'string': 'string'
},
'estimatedAssessmentCost': {
'amount': 123.0,
'currency': 'USD'
},
'resourceDiscovery': {
'status': 'RUNNING'|'SUCCEEDED'|'FAILED'|'COMPLETED_WITH_FAILURES'|'NOT_STARTED',
'lastRunAt': datetime(2015, 1, 1),
'errorCode': 'INVALID_PERMISSIONS'|'STACK_NOT_FOUND'|'CLUSTER_NOT_FOUND'|'STATE_FILE_NOT_FOUND'|'ACCESS_DENIED'|'UNSUPPORTED_CLUSTER'|'INTERNAL_ERROR',
'errorMessage': 'string'
},
'assessmentStatus': 'NOT_STARTED'|'PENDING'|'IN_PROGRESS'|'FAILED'|'SUCCESS',
'rerunAssessment': True|False,
'openFindingsCount': 123,
'resolvedFindingsCount': 123,
'organizationId': 'string',
'ouId': 'string',
'accountId': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
service (dict) --
The imported service.
serviceArn (string) --
ARN identifier.
name (string) --
Resource name (used in ARN — no spaces allowed).
description (string) --
Resource description for services and policies.
associatedSystems (list) --
The systems associated with the service.
(dict) --
Represents a system associated with a service.
systemArn (string) --
ARN identifier.
systemName (string) --
Resource name (used in ARN — no spaces allowed).
userJourneyIds (list) --
The list of user journey identifiers that associate this system with the service.
(string) --
policyArn (string) --
ARN identifier.
regions (list) --
The AWS Regions where the service operates.
(string) --
permissionModel (dict) --
The permission model for the service.
invokerRoleName (string) --
IAM role name (supports up to 64 characters per IAM limits).
crossAccountRoles (list) --
The list of cross-account IAM role ARNs.
(dict) --
Specifies a cross-account IAM role ARN and optional external ID.
crossAccountRoleArn (string) --
ARN of the IAM Role for the profile. Null if the permission profile is the 'Admin' profile.
externalId (string) --
The external ID used for assuming the cross-account role.
dependencyDiscovery (dict) --
The dependency discovery configuration for the service.
status (string) --
The current status of dependency discovery.
updatedAt (datetime) --
The timestamp when dependency discovery was last updated.
effectivePolicyValues (dict) --
The effective policy values for the service.
availabilitySlo (dict) --
The effective availability SLO value for the service.
value (float) --
The availability SLO percentage value.
policyName (string) --
Resource name (used in ARN — no spaces allowed).
source (string) --
Indicates whether the value comes from the service's own account or a cross-account policy.
multiAzRto (dict) --
The effective multi-AZ RTO value for the service, in minutes.
value (integer) --
The RTO or RPO value in minutes.
policyName (string) --
Resource name (used in ARN — no spaces allowed).
source (string) --
Indicates whether the value comes from the service's own account or a cross-account policy.
multiAzRpo (dict) --
The effective multi-AZ RPO value for the service, in minutes.
value (integer) --
The RTO or RPO value in minutes.
policyName (string) --
Resource name (used in ARN — no spaces allowed).
source (string) --
Indicates whether the value comes from the service's own account or a cross-account policy.
multiAzDrApproach (dict) --
The effective multi-AZ disaster recovery approach for the service.
value (string) --
The disaster recovery approach value.
policyName (string) --
Resource name (used in ARN — no spaces allowed).
source (string) --
Indicates whether the value comes from the service's own account or a cross-account policy.
multiRegionRto (dict) --
The effective multi-Region RTO value for the service, in minutes.
value (integer) --
The RTO or RPO value in minutes.
policyName (string) --
Resource name (used in ARN — no spaces allowed).
source (string) --
Indicates whether the value comes from the service's own account or a cross-account policy.
multiRegionRpo (dict) --
The effective multi-Region RPO value for the service, in minutes.
value (integer) --
The RTO or RPO value in minutes.
policyName (string) --
Resource name (used in ARN — no spaces allowed).
source (string) --
Indicates whether the value comes from the service's own account or a cross-account policy.
multiRegionDrApproach (dict) --
The effective multi-Region disaster recovery approach for the service.
value (string) --
The disaster recovery approach value.
policyName (string) --
Resource name (used in ARN — no spaces allowed).
source (string) --
Indicates whether the value comes from the service's own account or a cross-account policy.
dataRecoveryTimeBetweenBackups (dict) --
The effective data recovery time between backups value for the service.
value (integer) --
The RTO or RPO value in minutes.
policyName (string) --
Resource name (used in ARN — no spaces allowed).
source (string) --
Indicates whether the value comes from the service's own account or a cross-account policy.
achievability (dict) --
The achievability status of the service's resilience targets.
availabilitySlo (string) --
The achievability status of the availability SLO target for the service.
multiAzRtoRpo (string) --
The achievability status of the multi-AZ RTO and RPO targets for the service.
multiRegionRtoRpo (string) --
The achievability status of the multi-Region RTO and RPO targets for the service.
reportConfiguration (dict) --
Configuration for automatic report generation on a Service.
reportOutputs (list) --
Output destinations for generated reports.
(dict) --
Configuration for a report output destination.
s3 (dict) --
S3 configuration for report output.
bucketPath (string) --
S3 bucket path where reports will be written (e.g., my-bucket/ngrh-reports/).
bucketOwner (string) --
Account ID of the bucket owner for cross-account access verification.
kmsKeyId (string) --
KMS key identifier — accepts key ID, key ARN, alias name, or alias ARN.
tags (dict) --
Resource tags.
(string) --
Tag key.
(string) --
Tag value.
estimatedAssessmentCost (dict) --
The estimated cost of running an assessment on the service.
amount (float) --
The cost amount for the assessment.
currency (string) --
The currency of the assessment cost.
resourceDiscovery (dict) --
The resource discovery status for the service.
status (string) --
The current status of resource discovery.
lastRunAt (datetime) --
The timestamp of the last resource discovery run.
errorCode (string) --
The error code if resource discovery failed.
errorMessage (string) --
A message describing the error if resource discovery failed.
assessmentStatus (string) --
The current assessment status of the service.
rerunAssessment (boolean) --
Indicates whether the assessment should be rerun.
openFindingsCount (integer) --
The number of open findings for the service.
resolvedFindingsCount (integer) --
The number of resolved findings for the service.
organizationId (string) --
The AWS Organizations identifier for the service.
ouId (string) --
The organizational unit (OU) identifier for the service.
accountId (string) --
The AWS account ID that owns the service.
createdAt (datetime) --
The timestamp when the service was created.
updatedAt (datetime) --
The timestamp when the service was last updated.
Lists systems.
See also: AWS API Documentation
Request Syntax
client.list_systems(
ouId='string',
maxResults=123,
nextToken='string'
)
string
Filter systems by organizational unit (OU) identifier.
integer
Pagination page size.
string
Pagination token.
dict
Response Syntax
{
'systemSummaries': [
{
'systemId': 'string',
'name': 'string',
'systemArn': 'string',
'userJourneysCount': 123,
'servicesCount': 123,
'organizationId': 'string',
'ouId': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
systemSummaries (list) --
The list of system summaries.
(dict) --
Contains summary information about a system.
systemId (string) --
System ID for cross-account use without exposing account structure.
name (string) --
Resource name (used in ARN — no spaces allowed).
systemArn (string) --
ARN identifier.
userJourneysCount (integer) --
The number of user journeys in the system.
servicesCount (integer) --
The number of services in the system.
organizationId (string) --
Displayed only if caller has access.
ouId (string) --
Displayed only if caller has access.
createdAt (datetime) --
The timestamp when the system was created.
updatedAt (datetime) --
The timestamp when the system was last updated.
nextToken (string) --
Pagination token.
Lists resilience policies.
See also: AWS API Documentation
Request Syntax
client.list_policies(
maxResults=123,
nextToken='string'
)
integer
Pagination page size.
string
Pagination token.
dict
Response Syntax
{
'policySummaries': [
{
'policyArn': 'string',
'name': 'string',
'availabilitySlo': {
'target': 123.0
},
'multiAz': {
'rtoInMinutes': 123,
'rpoInMinutes': 123,
'disasterRecoveryApproach': 'ACTIVE_ACTIVE'|'HOT_STANDBY'|'WARM_STANDBY'|'PILOT_LIGHT'|'BACKUP_AND_RESTORE'
},
'multiRegion': {
'rtoInMinutes': 123,
'rpoInMinutes': 123,
'disasterRecoveryApproach': 'ACTIVE_ACTIVE'|'HOT_STANDBY'|'WARM_STANDBY'|'PILOT_LIGHT'|'BACKUP_AND_RESTORE'
},
'dataRecovery': {
'timeBetweenBackupsInMinutes': 123
},
'associatedServiceCount': 123,
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
policySummaries (list) --
The list of policy summaries.
(dict) --
Contains summary information about a resilience policy.
policyArn (string) --
ARN identifier.
name (string) --
Resource name (used in ARN — no spaces allowed).
availabilitySlo (dict) --
The availability SLO defined in the policy.
target (float) --
The target availability percentage, expressed as a value between 0 and 100.
multiAz (dict) --
The multi-AZ disaster recovery targets defined in the policy.
rtoInMinutes (integer) --
The recovery time objective (RTO) target for multi-AZ, in minutes.
rpoInMinutes (integer) --
The recovery point objective (RPO) target for multi-AZ, in minutes.
disasterRecoveryApproach (string) --
The disaster recovery approach for multi-AZ.
multiRegion (dict) --
The multi-Region disaster recovery targets defined in the policy.
rtoInMinutes (integer) --
The recovery time objective (RTO) target for multi-Region, in minutes.
rpoInMinutes (integer) --
The recovery point objective (RPO) target for multi-Region, in minutes.
disasterRecoveryApproach (string) --
The disaster recovery approach for multi-Region.
dataRecovery (dict) --
The data recovery targets defined in the policy.
timeBetweenBackupsInMinutes (integer) --
The target time between backups, in minutes.
associatedServiceCount (integer) --
The number of services associated with this policy.
createdAt (datetime) --
The timestamp when the policy was created.
updatedAt (datetime) --
The timestamp when the policy was last updated.
nextToken (string) --
Pagination token.
Lists input sources for a service.
See also: AWS API Documentation
Request Syntax
client.list_input_sources(
serviceArn='string',
type='CFN_STACK'|'TAGS'|'EKS'|'TERRAFORM'|'DESIGN_FILE'|'MONITORING',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
ARN identifier.
string
Filter input sources by type.
integer
Pagination page size.
string
Pagination token.
dict
Response Syntax
{
'inputSourceSummaries': [
{
'inputSourceId': 'string',
'type': 'CFN_STACK'|'TAGS'|'EKS'|'TERRAFORM'|'DESIGN_FILE'|'MONITORING',
'resourceTags': [
{
'key': 'string',
'values': [
'string',
]
},
],
'cfnStackArn': 'string',
'tfStateFileUrl': 'string',
'eks': {
'clusterArn': 'string',
'namespaces': [
'string',
]
},
'designFileS3Url': 'string',
'createdAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
inputSourceSummaries (list) --
The list of input source summaries.
(dict) --
Contains summary information about an input source for a service.
inputSourceId (string) --
The unique identifier of the input source.
type (string) --
The type of the input source.
resourceTags (list) --
The resource tags used for discovery, if this input source uses tags.
(dict) --
A tag key-value pair used for resource discovery.
key (string) --
Tag key.
values (list) --
The list of tag values.
(string) --
Tag value.
cfnStackArn (string) --
ARN identifier.
tfStateFileUrl (string) --
S3 URL — virtual hosted-style or s3:// URI.
eks (dict) --
The Amazon EKS configuration, if this input source uses EKS.
clusterArn (string) --
ARN identifier.
namespaces (list) --
The list of Kubernetes namespaces within the EKS cluster.
(string) --
Kubernetes namespace name (RFC 1123 Label).
designFileS3Url (string) --
S3 URL — virtual hosted-style or s3:// URI.
createdAt (datetime) --
The timestamp when the input source was created.
nextToken (string) --
Pagination token.
Updates a service function.
See also: AWS API Documentation
Request Syntax
client.update_service_function(
serviceArn='string',
serviceFunctionId='string',
name='string',
description='string',
criticality='PRIMARY'|'SUPPLEMENTAL'
)
string
[REQUIRED]
ARN identifier.
string
[REQUIRED]
The identifier of the service function to update.
string
Entity label (not part of ARN — spaces allowed).
string
Resource description.
string
The updated criticality level of the service function.
dict
Response Syntax
{
'serviceFunction': {
'serviceArn': 'string',
'serviceFunctionId': 'string',
'name': 'string',
'description': 'string',
'criticality': 'PRIMARY'|'SUPPLEMENTAL',
'resourceCount': 123,
'source': 'AI_GENERATED'|'USER',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
serviceFunction (dict) --
The updated service function.
serviceArn (string) --
ARN identifier.
serviceFunctionId (string) --
The unique identifier of the service function.
name (string) --
Entity label (not part of ARN — spaces allowed).
description (string) --
Resource description.
criticality (string) --
The criticality level of the service function.
resourceCount (integer) --
The number of resources associated with the service function.
source (string) --
The source of the service function.
createdAt (datetime) --
The timestamp when the service function was created.
updatedAt (datetime) --
The timestamp when the service function was last updated.
Creates a system that represents a logical grouping of services.
See also: AWS API Documentation
Request Syntax
client.create_system(
name='string',
description='string',
sharingEnabled=True|False,
kmsKeyId='string',
tags={
'string': 'string'
},
clientToken='string'
)
string
[REQUIRED]
Resource name (used in ARN — no spaces allowed).
string
Resource description.
boolean
Indicates whether cross-account sharing is enabled for the system.
string
KMS key identifier — accepts key ID, key ARN, alias name, or alias ARN.
dict
Resource tags.
(string) --
Tag key.
(string) --
Tag value.
string
Idempotency token.
This field is autopopulated if not provided.
dict
Response Syntax
{
'system': {
'systemArn': 'string',
'systemId': 'string',
'name': 'string',
'description': 'string',
'sharingEnabled': True|False,
'tags': {
'string': 'string'
},
'kmsKeyId': 'string',
'organizationId': 'string',
'ouId': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
system (dict) --
The created system.
systemArn (string) --
ARN identifier.
systemId (string) --
System ID for cross-account use without exposing account structure.
name (string) --
Resource name (used in ARN — no spaces allowed).
description (string) --
Resource description.
sharingEnabled (boolean) --
Indicates whether cross-account sharing is enabled.
tags (dict) --
Resource tags.
(string) --
Tag key.
(string) --
Tag value.
kmsKeyId (string) --
KMS key identifier — accepts key ID, key ARN, alias name, or alias ARN.
organizationId (string) --
The AWS Organizations identifier for the system.
ouId (string) --
The organizational unit (OU) identifier for the system.
createdAt (datetime) --
The timestamp when the system was created.
updatedAt (datetime) --
The timestamp when the system was last updated.
Retrieves a finding by findingId.
See also: AWS API Documentation
Request Syntax
client.get_failure_mode_finding(
findingId='string',
serviceArn='string'
)
string
[REQUIRED]
The unique identifier of the finding to retrieve.
string
[REQUIRED]
ARN identifier.
dict
Response Syntax
{
'finding': {
'findingId': 'string',
'name': 'string',
'description': 'string',
'failureCategory': 'SHARED_FATE'|'EXCESSIVE_LOAD'|'EXCESSIVE_LATENCY'|'MISCONFIGURATION_AND_BUGS'|'SINGLE_POINT_OF_FAILURE',
'status': 'OPEN'|'RESOLVED'|'IRRELEVANT',
'reasoning': 'string',
'comment': 'string',
'severity': 'LOW'|'MEDIUM'|'HIGH',
'serviceFunctions': [
'string',
],
'policyComponent': 'AVAILABILITY_SLO'|'MULTI_AZ_DISASTER_RECOVERY'|'MULTI_REGION_DISASTER_RECOVERY'|'DATA_RECOVERY',
'infrastructureAndCodeRecommendations': [
{
'suggestedChanges': [
'string',
]
},
],
'observabilityRecommendations': [
{
'suggestedChanges': [
'string',
]
},
],
'testingRecommendations': [
{
'suggestedChanges': [
'string',
]
},
],
'updatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
finding (dict) --
The requested finding.
findingId (string) --
The unique identifier of the finding.
name (string) --
The name of the finding.
description (string) --
Resource description.
failureCategory (string) --
The failure category of the finding.
status (string) --
The current status of the finding.
reasoning (string) --
The reasoning behind the finding.
comment (string) --
A user-provided comment about the finding.
severity (string) --
The severity of the finding.
serviceFunctions (list) --
The service functions associated with the finding.
(string) --
policyComponent (string) --
The policy component associated with the finding.
infrastructureAndCodeRecommendations (list) --
Infrastructure and code recommendations to address the finding.
(dict) --
An infrastructure and code recommendation to address a finding.
suggestedChanges (list) --
The list of suggested changes.
(string) --
Resource description.
observabilityRecommendations (list) --
Observability recommendations to address the finding.
(dict) --
An observability recommendation to address a finding.
suggestedChanges (list) --
The list of suggested observability changes.
(string) --
Resource description.
testingRecommendations (list) --
Testing recommendations to address the finding.
(dict) --
A testing recommendation to address a finding.
suggestedChanges (list) --
The list of suggested testing changes.
(string) --
Resource description.
updatedAt (datetime) --
The timestamp when the finding was last updated.
Lists failure mode assessments.
See also: AWS API Documentation
Request Syntax
client.list_failure_mode_assessments(
serviceArn='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
ARN identifier.
integer
Pagination page size.
string
Pagination token.
dict
Response Syntax
{
'assessmentSummaries': [
{
'assessmentId': 'string',
'serviceArn': 'string',
'assessmentStatus': 'NOT_STARTED'|'PENDING'|'IN_PROGRESS'|'FAILED'|'SUCCESS',
'assessmentStep': 'TOPOLOGY_ENHANCEMENT'|'SERVICE_FUNCTION_GENERATION'|'RESILIENCE_ASSESSMENT',
'totalFindings': 123,
'startedAt': datetime(2015, 1, 1),
'endedAt': datetime(2015, 1, 1),
'errorMessage': 'string',
'errorCode': 'INVALID_PERMISSIONS'|'CMK_ACCESS_DENIED'|'AGENT_ERROR'|'INTERNAL_ERROR'|'DESIGN_FILE_ACCESS_DENIED',
'assessmentCost': {
'amount': 123.0,
'currency': 'USD'
},
'billableAssessmentUnitCount': 123,
'achievability': {
'availabilitySlo': 'ACHIEVABLE'|'NOT_ACHIEVABLE',
'multiAzRtoRpo': 'ACHIEVABLE'|'NOT_ACHIEVABLE',
'multiRegionRtoRpo': 'ACHIEVABLE'|'NOT_ACHIEVABLE'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
assessmentSummaries (list) --
The list of assessment summaries.
(dict) --
Contains summary information about a failure mode assessment.
assessmentId (string) --
The unique identifier of the assessment.
serviceArn (string) --
ARN identifier.
assessmentStatus (string) --
The current status of the assessment.
assessmentStep (string) --
The current step of the assessment process.
totalFindings (integer) --
The total number of findings generated by the assessment.
startedAt (datetime) --
The timestamp when the assessment started.
endedAt (datetime) --
The timestamp when the assessment ended.
errorMessage (string) --
A message describing the error if the assessment failed.
errorCode (string) --
The error code if the assessment failed.
assessmentCost (dict) --
The cost of the assessment.
amount (float) --
The cost amount for the assessment.
currency (string) --
The currency of the assessment cost.
billableAssessmentUnitCount (integer) --
The number of billable assessment units consumed by the assessment.
achievability (dict) --
The achievability results from the assessment.
availabilitySlo (string) --
The achievability status of the availability SLO target for the service.
multiAzRtoRpo (string) --
The achievability status of the multi-AZ RTO and RPO targets for the service.
multiRegionRtoRpo (string) --
The achievability status of the multi-Region RTO and RPO targets for the service.
nextToken (string) --
Pagination token.
Retrieves a resilience policy by ARN.
See also: AWS API Documentation
Request Syntax
client.get_policy(
policyArn='string'
)
string
[REQUIRED]
ARN identifier.
dict
Response Syntax
{
'policy': {
'policyArn': 'string',
'name': 'string',
'description': 'string',
'availabilitySlo': {
'target': 123.0
},
'multiAz': {
'rtoInMinutes': 123,
'rpoInMinutes': 123,
'disasterRecoveryApproach': 'ACTIVE_ACTIVE'|'HOT_STANDBY'|'WARM_STANDBY'|'PILOT_LIGHT'|'BACKUP_AND_RESTORE'
},
'multiRegion': {
'rtoInMinutes': 123,
'rpoInMinutes': 123,
'disasterRecoveryApproach': 'ACTIVE_ACTIVE'|'HOT_STANDBY'|'WARM_STANDBY'|'PILOT_LIGHT'|'BACKUP_AND_RESTORE'
},
'dataRecovery': {
'timeBetweenBackupsInMinutes': 123
},
'kmsKeyId': 'string',
'tags': {
'string': 'string'
},
'associatedServiceCount': 123,
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
policy (dict) --
The requested resilience policy.
policyArn (string) --
ARN identifier.
name (string) --
Resource name (used in ARN — no spaces allowed).
description (string) --
Resource description for services and policies.
availabilitySlo (dict) --
The availability SLO defined in the policy.
target (float) --
The target availability percentage, expressed as a value between 0 and 100.
multiAz (dict) --
The multi-AZ disaster recovery targets defined in the policy.
rtoInMinutes (integer) --
The recovery time objective (RTO) target for multi-AZ, in minutes.
rpoInMinutes (integer) --
The recovery point objective (RPO) target for multi-AZ, in minutes.
disasterRecoveryApproach (string) --
The disaster recovery approach for multi-AZ.
multiRegion (dict) --
The multi-Region disaster recovery targets defined in the policy.
rtoInMinutes (integer) --
The recovery time objective (RTO) target for multi-Region, in minutes.
rpoInMinutes (integer) --
The recovery point objective (RPO) target for multi-Region, in minutes.
disasterRecoveryApproach (string) --
The disaster recovery approach for multi-Region.
dataRecovery (dict) --
The data recovery targets defined in the policy.
timeBetweenBackupsInMinutes (integer) --
The target time between backups, in minutes.
kmsKeyId (string) --
KMS key identifier — accepts key ID, key ARN, alias name, or alias ARN.
tags (dict) --
Resource tags.
(string) --
Tag key.
(string) --
Tag value.
associatedServiceCount (integer) --
The number of services associated with this policy.
createdAt (datetime) --
The timestamp when the policy was created.
updatedAt (datetime) --
The timestamp when the policy was last updated.
List findings.
See also: AWS API Documentation
Request Syntax
client.list_failure_mode_findings(
serviceArn='string',
severity='LOW'|'MEDIUM'|'HIGH',
failureCategory='SHARED_FATE'|'EXCESSIVE_LOAD'|'EXCESSIVE_LATENCY'|'MISCONFIGURATION_AND_BUGS'|'SINGLE_POINT_OF_FAILURE',
status='OPEN'|'RESOLVED'|'IRRELEVANT',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
ARN identifier.
string
Filter findings by severity.
string
Filter findings by failure category.
string
Filter findings by status.
integer
Pagination page size.
string
Pagination token.
dict
Response Syntax
{
'findingsSummary': [
{
'serviceArn': 'string',
'findingId': 'string',
'name': 'string',
'description': 'string',
'failureCategory': 'SHARED_FATE'|'EXCESSIVE_LOAD'|'EXCESSIVE_LATENCY'|'MISCONFIGURATION_AND_BUGS'|'SINGLE_POINT_OF_FAILURE',
'severity': 'LOW'|'MEDIUM'|'HIGH',
'status': 'OPEN'|'RESOLVED'|'IRRELEVANT',
'policyComponent': 'AVAILABILITY_SLO'|'MULTI_AZ_DISASTER_RECOVERY'|'MULTI_REGION_DISASTER_RECOVERY'|'DATA_RECOVERY',
'updatedAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
findingsSummary (list) --
The list of finding summaries.
(dict) --
Contains summary information about a finding.
serviceArn (string) --
ARN identifier.
findingId (string) --
The unique identifier of the finding.
name (string) --
The name of the finding.
description (string) --
Resource description.
failureCategory (string) --
The failure category of the finding.
severity (string) --
The severity of the finding.
status (string) --
The current status of the finding.
policyComponent (string) --
The policy component associated with the finding.
updatedAt (datetime) --
The timestamp when the finding was last updated.
nextToken (string) --
Pagination token.
List reports for a service, or all reports owned by the account if serviceArn is not provided.
See also: AWS API Documentation
Request Syntax
client.list_reports(
serviceArn='string',
reportType='FAILURE_MODE',
maxResults=123,
nextToken='string'
)
string
Optional. If not provided, lists all reports owned by the account.
string
Filter reports by type.
integer
Pagination page size.
string
Pagination token.
dict
Response Syntax
{
'reportGenerationResults': [
{
'reportType': 'FAILURE_MODE',
'status': 'PENDING'|'SUCCEEDED'|'FAILED',
'serviceArn': 'string',
'assessmentId': 'string',
'createdAt': datetime(2015, 1, 1),
'reportOutput': {
's3ReportOutput': {
's3ObjectKey': 'string'
},
'failedReportOutput': {
'errorCode': 'INSUFFICIENT_PERMISSIONS'|'CONFIGURATION_ERROR'|'INTERNAL_ERROR',
'errorMessage': 'string'
}
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
reportGenerationResults (list) --
The list of report generation results.
(dict) --
Result of a report generation attempt.
reportType (string) --
The type of the generated report.
status (string) --
The status of the report generation.
serviceArn (string) --
The service this report was generated for.
assessmentId (string) --
Present for FAILURE_MODE reports.
createdAt (datetime) --
The timestamp when the report was created.
reportOutput (dict) --
Present when status is SUCCEEDED or FAILED.
s3ReportOutput (dict) --
The S3 location where the report was written.
s3ObjectKey (string) --
The S3 object key for the generated report.
failedReportOutput (dict) --
Details when report generation failed.
errorCode (string) --
The error code describing why the report generation failed.
errorMessage (string) --
The error message describing why the report generation failed.
nextToken (string) --
Pagination token.
Creates a resilience policy that defines availability and disaster recovery requirements.
See also: AWS API Documentation
Request Syntax
client.create_policy(
name='string',
description='string',
availabilitySlo={
'target': 123.0
},
multiAz={
'rtoInMinutes': 123,
'rpoInMinutes': 123,
'disasterRecoveryApproach': 'ACTIVE_ACTIVE'|'HOT_STANDBY'|'WARM_STANDBY'|'PILOT_LIGHT'|'BACKUP_AND_RESTORE'
},
multiRegion={
'rtoInMinutes': 123,
'rpoInMinutes': 123,
'disasterRecoveryApproach': 'ACTIVE_ACTIVE'|'HOT_STANDBY'|'WARM_STANDBY'|'PILOT_LIGHT'|'BACKUP_AND_RESTORE'
},
dataRecovery={
'timeBetweenBackupsInMinutes': 123
},
kmsKeyId='string',
tags={
'string': 'string'
},
clientToken='string'
)
string
[REQUIRED]
Resource name (used in ARN — no spaces allowed).
string
Resource description for services and policies.
dict
The availability SLO for the resilience policy.
target (float) --
The target availability percentage, expressed as a value between 0 and 100.
dict
The multi-AZ disaster recovery targets for the resilience policy.
rtoInMinutes (integer) --
The recovery time objective (RTO) target for multi-AZ, in minutes.
rpoInMinutes (integer) --
The recovery point objective (RPO) target for multi-AZ, in minutes.
disasterRecoveryApproach (string) --
The disaster recovery approach for multi-AZ.
dict
The multi-Region disaster recovery targets for the resilience policy.
rtoInMinutes (integer) --
The recovery time objective (RTO) target for multi-Region, in minutes.
rpoInMinutes (integer) --
The recovery point objective (RPO) target for multi-Region, in minutes.
disasterRecoveryApproach (string) --
The disaster recovery approach for multi-Region.
dict
The data recovery targets for the resilience policy.
timeBetweenBackupsInMinutes (integer) --
The target time between backups, in minutes.
string
KMS key identifier — accepts key ID, key ARN, alias name, or alias ARN.
dict
Resource tags.
(string) --
Tag key.
(string) --
Tag value.
string
Idempotency token.
This field is autopopulated if not provided.
dict
Response Syntax
{
'policy': {
'policyArn': 'string',
'name': 'string',
'description': 'string',
'availabilitySlo': {
'target': 123.0
},
'multiAz': {
'rtoInMinutes': 123,
'rpoInMinutes': 123,
'disasterRecoveryApproach': 'ACTIVE_ACTIVE'|'HOT_STANDBY'|'WARM_STANDBY'|'PILOT_LIGHT'|'BACKUP_AND_RESTORE'
},
'multiRegion': {
'rtoInMinutes': 123,
'rpoInMinutes': 123,
'disasterRecoveryApproach': 'ACTIVE_ACTIVE'|'HOT_STANDBY'|'WARM_STANDBY'|'PILOT_LIGHT'|'BACKUP_AND_RESTORE'
},
'dataRecovery': {
'timeBetweenBackupsInMinutes': 123
},
'kmsKeyId': 'string',
'tags': {
'string': 'string'
},
'associatedServiceCount': 123,
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
policy (dict) --
The created resilience policy.
policyArn (string) --
ARN identifier.
name (string) --
Resource name (used in ARN — no spaces allowed).
description (string) --
Resource description for services and policies.
availabilitySlo (dict) --
The availability SLO defined in the policy.
target (float) --
The target availability percentage, expressed as a value between 0 and 100.
multiAz (dict) --
The multi-AZ disaster recovery targets defined in the policy.
rtoInMinutes (integer) --
The recovery time objective (RTO) target for multi-AZ, in minutes.
rpoInMinutes (integer) --
The recovery point objective (RPO) target for multi-AZ, in minutes.
disasterRecoveryApproach (string) --
The disaster recovery approach for multi-AZ.
multiRegion (dict) --
The multi-Region disaster recovery targets defined in the policy.
rtoInMinutes (integer) --
The recovery time objective (RTO) target for multi-Region, in minutes.
rpoInMinutes (integer) --
The recovery point objective (RPO) target for multi-Region, in minutes.
disasterRecoveryApproach (string) --
The disaster recovery approach for multi-Region.
dataRecovery (dict) --
The data recovery targets defined in the policy.
timeBetweenBackupsInMinutes (integer) --
The target time between backups, in minutes.
kmsKeyId (string) --
KMS key identifier — accepts key ID, key ARN, alias name, or alias ARN.
tags (dict) --
Resource tags.
(string) --
Tag key.
(string) --
Tag value.
associatedServiceCount (integer) --
The number of services associated with this policy.
createdAt (datetime) --
The timestamp when the policy was created.
updatedAt (datetime) --
The timestamp when the policy was last updated.
Creates an input source for a service.
See also: AWS API Documentation
Request Syntax
client.create_input_source(
serviceArn='string',
resourceConfiguration={
'resourceTags': [
{
'key': 'string',
'values': [
'string',
]
},
],
'cfnStackArn': 'string',
'tfStateFileUrl': 'string',
'eks': {
'clusterArn': 'string',
'namespaces': [
'string',
]
},
'designFileS3Url': 'string'
},
clientToken='string'
)
string
[REQUIRED]
ARN identifier.
dict
[REQUIRED]
Resource configuration for an input source. Provide exactly one field.
resourceTags (list) --
The resource tags for tag-based resource discovery.
(dict) --
A tag key-value pair used for resource discovery.
key (string) -- [REQUIRED]
Tag key.
values (list) -- [REQUIRED]
The list of tag values.
(string) --
Tag value.
cfnStackArn (string) --
ARN identifier.
tfStateFileUrl (string) --
S3 URL — virtual hosted-style or s3:// URI.
eks (dict) --
The Amazon EKS configuration for resource discovery.
clusterArn (string) -- [REQUIRED]
ARN identifier.
namespaces (list) -- [REQUIRED]
The list of Kubernetes namespaces within the EKS cluster.
(string) --
Kubernetes namespace name (RFC 1123 Label).
designFileS3Url (string) --
S3 URL — virtual hosted-style or s3:// URI.
string
Idempotency token.
This field is autopopulated if not provided.
dict
Response Syntax
{
'serviceArn': 'string',
'inputSourceId': 'string'
}
Response Structure
(dict) --
serviceArn (string) --
ARN identifier.
inputSourceId (string) --
The unique identifier assigned to the created input source.
Deletes a service function.
See also: AWS API Documentation
Request Syntax
client.delete_service_function(
serviceArn='string',
serviceFunctionId='string'
)
string
[REQUIRED]
ARN identifier.
string
[REQUIRED]
The identifier of the service function to delete.
dict
Response Syntax
{
'serviceFunctionId': 'string'
}
Response Structure
(dict) --
serviceFunctionId (string) --
The identifier of the deleted service function.
Creates a user journey within a system.
See also: AWS API Documentation
Request Syntax
client.create_user_journey(
systemArn='string',
name='string',
description='string',
policyArn='string',
clientToken='string'
)
string
[REQUIRED]
ARN identifier.
string
[REQUIRED]
Entity label (not part of ARN — spaces allowed).
string
Resource description.
string
ARN identifier.
string
Idempotency token.
This field is autopopulated if not provided.
dict
Response Syntax
{
'userJourney': {
'userJourneyId': 'string',
'name': 'string',
'description': 'string',
'policyArn': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
userJourney (dict) --
The created user journey.
userJourneyId (string) --
The unique identifier of the user journey.
name (string) --
Entity label (not part of ARN — spaces allowed).
description (string) --
Resource description.
policyArn (string) --
ARN identifier.
createdAt (datetime) --
The timestamp when the user journey was created.
updatedAt (datetime) --
The timestamp when the user journey was last updated.
Creates a resilience assertion for a service.
See also: AWS API Documentation
Request Syntax
client.create_assertion(
serviceArn='string',
text='string',
clientToken='string'
)
string
[REQUIRED]
ARN identifier.
string
[REQUIRED]
The text content of the assertion.
string
Idempotency token.
This field is autopopulated if not provided.
dict
Response Syntax
{
'assertion': {
'serviceArn': 'string',
'assertionId': 'string',
'text': 'string',
'source': 'AI_GENERATED'|'USER',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
assertion (dict) --
The created assertion.
serviceArn (string) --
ARN identifier.
assertionId (string) --
The unique identifier of the assertion.
text (string) --
The text content of the assertion.
source (string) --
The source of the assertion, indicating whether it was AI-generated or created by a user.
createdAt (datetime) --
The timestamp when the assertion was created.
updatedAt (datetime) --
The timestamp when the assertion was last updated.
Creates a service.
See also: AWS API Documentation
Request Syntax
client.create_service(
name='string',
description='string',
associatedSystems=[
{
'systemArn': 'string',
'systemName': 'string',
'userJourneyIds': [
'string',
]
},
],
policyArn='string',
regions=[
'string',
],
permissionModel={
'invokerRoleName': 'string',
'crossAccountRoles': [
{
'crossAccountRoleArn': 'string',
'externalId': 'string'
},
]
},
dependencyDiscovery='ENABLED'|'DISABLED',
reportConfiguration={
'reportOutputs': [
{
's3': {
'bucketPath': 'string',
'bucketOwner': 'string'
}
},
]
},
kmsKeyId='string',
tags={
'string': 'string'
},
clientToken='string'
)
string
[REQUIRED]
Resource name (used in ARN — no spaces allowed).
string
Resource description for services and policies.
list
The systems to associate with the service.
(dict) --
Represents a system associated with a service.
systemArn (string) -- [REQUIRED]
ARN identifier.
systemName (string) --
Resource name (used in ARN — no spaces allowed).
userJourneyIds (list) --
The list of user journey identifiers that associate this system with the service.
(string) --
string
ARN identifier.
list
[REQUIRED]
The AWS Regions where the service operates.
(string) --
dict
[REQUIRED]
The permission model for the service.
invokerRoleName (string) -- [REQUIRED]
IAM role name (supports up to 64 characters per IAM limits).
crossAccountRoles (list) --
The list of cross-account IAM role ARNs.
(dict) --
Specifies a cross-account IAM role ARN and optional external ID.
crossAccountRoleArn (string) -- [REQUIRED]
ARN of the IAM Role for the profile. Null if the permission profile is the 'Admin' profile.
externalId (string) --
The external ID used for assuming the cross-account role.
string
Caller-settable values for dependency discovery. INITIALIZING is system-managed.
dict
Configuration for automatic report generation on a Service.
reportOutputs (list) -- [REQUIRED]
Output destinations for generated reports.
(dict) --
Configuration for a report output destination.
s3 (dict) --
S3 configuration for report output.
bucketPath (string) -- [REQUIRED]
S3 bucket path where reports will be written (e.g., my-bucket/ngrh-reports/).
bucketOwner (string) -- [REQUIRED]
Account ID of the bucket owner for cross-account access verification.
string
KMS key identifier — accepts key ID, key ARN, alias name, or alias ARN.
dict
Resource tags.
(string) --
Tag key.
(string) --
Tag value.
string
Idempotency token.
This field is autopopulated if not provided.
dict
Response Syntax
{
'service': {
'serviceArn': 'string',
'name': 'string',
'description': 'string',
'associatedSystems': [
{
'systemArn': 'string',
'systemName': 'string',
'userJourneyIds': [
'string',
]
},
],
'policyArn': 'string',
'regions': [
'string',
],
'permissionModel': {
'invokerRoleName': 'string',
'crossAccountRoles': [
{
'crossAccountRoleArn': 'string',
'externalId': 'string'
},
]
},
'dependencyDiscovery': {
'status': 'ENABLED'|'INITIALIZING'|'DISABLED',
'updatedAt': datetime(2015, 1, 1)
},
'effectivePolicyValues': {
'availabilitySlo': {
'value': 123.0,
'policyName': 'string',
'source': 'SELF'|'CROSS_ACCOUNT'
},
'multiAzRto': {
'value': 123,
'policyName': 'string',
'source': 'SELF'|'CROSS_ACCOUNT'
},
'multiAzRpo': {
'value': 123,
'policyName': 'string',
'source': 'SELF'|'CROSS_ACCOUNT'
},
'multiAzDrApproach': {
'value': 'string',
'policyName': 'string',
'source': 'SELF'|'CROSS_ACCOUNT'
},
'multiRegionRto': {
'value': 123,
'policyName': 'string',
'source': 'SELF'|'CROSS_ACCOUNT'
},
'multiRegionRpo': {
'value': 123,
'policyName': 'string',
'source': 'SELF'|'CROSS_ACCOUNT'
},
'multiRegionDrApproach': {
'value': 'string',
'policyName': 'string',
'source': 'SELF'|'CROSS_ACCOUNT'
},
'dataRecoveryTimeBetweenBackups': {
'value': 123,
'policyName': 'string',
'source': 'SELF'|'CROSS_ACCOUNT'
}
},
'achievability': {
'availabilitySlo': 'ACHIEVABLE'|'NOT_ACHIEVABLE',
'multiAzRtoRpo': 'ACHIEVABLE'|'NOT_ACHIEVABLE',
'multiRegionRtoRpo': 'ACHIEVABLE'|'NOT_ACHIEVABLE'
},
'reportConfiguration': {
'reportOutputs': [
{
's3': {
'bucketPath': 'string',
'bucketOwner': 'string'
}
},
]
},
'kmsKeyId': 'string',
'tags': {
'string': 'string'
},
'estimatedAssessmentCost': {
'amount': 123.0,
'currency': 'USD'
},
'resourceDiscovery': {
'status': 'RUNNING'|'SUCCEEDED'|'FAILED'|'COMPLETED_WITH_FAILURES'|'NOT_STARTED',
'lastRunAt': datetime(2015, 1, 1),
'errorCode': 'INVALID_PERMISSIONS'|'STACK_NOT_FOUND'|'CLUSTER_NOT_FOUND'|'STATE_FILE_NOT_FOUND'|'ACCESS_DENIED'|'UNSUPPORTED_CLUSTER'|'INTERNAL_ERROR',
'errorMessage': 'string'
},
'assessmentStatus': 'NOT_STARTED'|'PENDING'|'IN_PROGRESS'|'FAILED'|'SUCCESS',
'rerunAssessment': True|False,
'openFindingsCount': 123,
'resolvedFindingsCount': 123,
'organizationId': 'string',
'ouId': 'string',
'accountId': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
service (dict) --
The created service.
serviceArn (string) --
ARN identifier.
name (string) --
Resource name (used in ARN — no spaces allowed).
description (string) --
Resource description for services and policies.
associatedSystems (list) --
The systems associated with the service.
(dict) --
Represents a system associated with a service.
systemArn (string) --
ARN identifier.
systemName (string) --
Resource name (used in ARN — no spaces allowed).
userJourneyIds (list) --
The list of user journey identifiers that associate this system with the service.
(string) --
policyArn (string) --
ARN identifier.
regions (list) --
The AWS Regions where the service operates.
(string) --
permissionModel (dict) --
The permission model for the service.
invokerRoleName (string) --
IAM role name (supports up to 64 characters per IAM limits).
crossAccountRoles (list) --
The list of cross-account IAM role ARNs.
(dict) --
Specifies a cross-account IAM role ARN and optional external ID.
crossAccountRoleArn (string) --
ARN of the IAM Role for the profile. Null if the permission profile is the 'Admin' profile.
externalId (string) --
The external ID used for assuming the cross-account role.
dependencyDiscovery (dict) --
The dependency discovery configuration for the service.
status (string) --
The current status of dependency discovery.
updatedAt (datetime) --
The timestamp when dependency discovery was last updated.
effectivePolicyValues (dict) --
The effective policy values for the service.
availabilitySlo (dict) --
The effective availability SLO value for the service.
value (float) --
The availability SLO percentage value.
policyName (string) --
Resource name (used in ARN — no spaces allowed).
source (string) --
Indicates whether the value comes from the service's own account or a cross-account policy.
multiAzRto (dict) --
The effective multi-AZ RTO value for the service, in minutes.
value (integer) --
The RTO or RPO value in minutes.
policyName (string) --
Resource name (used in ARN — no spaces allowed).
source (string) --
Indicates whether the value comes from the service's own account or a cross-account policy.
multiAzRpo (dict) --
The effective multi-AZ RPO value for the service, in minutes.
value (integer) --
The RTO or RPO value in minutes.
policyName (string) --
Resource name (used in ARN — no spaces allowed).
source (string) --
Indicates whether the value comes from the service's own account or a cross-account policy.
multiAzDrApproach (dict) --
The effective multi-AZ disaster recovery approach for the service.
value (string) --
The disaster recovery approach value.
policyName (string) --
Resource name (used in ARN — no spaces allowed).
source (string) --
Indicates whether the value comes from the service's own account or a cross-account policy.
multiRegionRto (dict) --
The effective multi-Region RTO value for the service, in minutes.
value (integer) --
The RTO or RPO value in minutes.
policyName (string) --
Resource name (used in ARN — no spaces allowed).
source (string) --
Indicates whether the value comes from the service's own account or a cross-account policy.
multiRegionRpo (dict) --
The effective multi-Region RPO value for the service, in minutes.
value (integer) --
The RTO or RPO value in minutes.
policyName (string) --
Resource name (used in ARN — no spaces allowed).
source (string) --
Indicates whether the value comes from the service's own account or a cross-account policy.
multiRegionDrApproach (dict) --
The effective multi-Region disaster recovery approach for the service.
value (string) --
The disaster recovery approach value.
policyName (string) --
Resource name (used in ARN — no spaces allowed).
source (string) --
Indicates whether the value comes from the service's own account or a cross-account policy.
dataRecoveryTimeBetweenBackups (dict) --
The effective data recovery time between backups value for the service.
value (integer) --
The RTO or RPO value in minutes.
policyName (string) --
Resource name (used in ARN — no spaces allowed).
source (string) --
Indicates whether the value comes from the service's own account or a cross-account policy.
achievability (dict) --
The achievability status of the service's resilience targets.
availabilitySlo (string) --
The achievability status of the availability SLO target for the service.
multiAzRtoRpo (string) --
The achievability status of the multi-AZ RTO and RPO targets for the service.
multiRegionRtoRpo (string) --
The achievability status of the multi-Region RTO and RPO targets for the service.
reportConfiguration (dict) --
Configuration for automatic report generation on a Service.
reportOutputs (list) --
Output destinations for generated reports.
(dict) --
Configuration for a report output destination.
s3 (dict) --
S3 configuration for report output.
bucketPath (string) --
S3 bucket path where reports will be written (e.g., my-bucket/ngrh-reports/).
bucketOwner (string) --
Account ID of the bucket owner for cross-account access verification.
kmsKeyId (string) --
KMS key identifier — accepts key ID, key ARN, alias name, or alias ARN.
tags (dict) --
Resource tags.
(string) --
Tag key.
(string) --
Tag value.
estimatedAssessmentCost (dict) --
The estimated cost of running an assessment on the service.
amount (float) --
The cost amount for the assessment.
currency (string) --
The currency of the assessment cost.
resourceDiscovery (dict) --
The resource discovery status for the service.
status (string) --
The current status of resource discovery.
lastRunAt (datetime) --
The timestamp of the last resource discovery run.
errorCode (string) --
The error code if resource discovery failed.
errorMessage (string) --
A message describing the error if resource discovery failed.
assessmentStatus (string) --
The current assessment status of the service.
rerunAssessment (boolean) --
Indicates whether the assessment should be rerun.
openFindingsCount (integer) --
The number of open findings for the service.
resolvedFindingsCount (integer) --
The number of resolved findings for the service.
organizationId (string) --
The AWS Organizations identifier for the service.
ouId (string) --
The organizational unit (OU) identifier for the service.
accountId (string) --
The AWS account ID that owns the service.
createdAt (datetime) --
The timestamp when the service was created.
updatedAt (datetime) --
The timestamp when the service was last updated.
On-demand report creation. Idempotent — duplicate requests with same clientToken return existing result.
See also: AWS API Documentation
Request Syntax
client.create_report(
serviceArn='string',
reportType='FAILURE_MODE',
clientToken='string'
)
string
[REQUIRED]
ARN identifier.
string
[REQUIRED]
The type of report to generate.
string
Idempotency token.
This field is autopopulated if not provided.
dict
Response Syntax
{
'reportGenerationResult': {
'reportType': 'FAILURE_MODE',
'status': 'PENDING'|'SUCCEEDED'|'FAILED',
'serviceArn': 'string',
'assessmentId': 'string',
'createdAt': datetime(2015, 1, 1),
'reportOutput': {
's3ReportOutput': {
's3ObjectKey': 'string'
},
'failedReportOutput': {
'errorCode': 'INSUFFICIENT_PERMISSIONS'|'CONFIGURATION_ERROR'|'INTERNAL_ERROR',
'errorMessage': 'string'
}
}
}
}
Response Structure
(dict) --
reportGenerationResult (dict) --
The result of the report generation request.
reportType (string) --
The type of the generated report.
status (string) --
The status of the report generation.
serviceArn (string) --
The service this report was generated for.
assessmentId (string) --
Present for FAILURE_MODE reports.
createdAt (datetime) --
The timestamp when the report was created.
reportOutput (dict) --
Present when status is SUCCEEDED or FAILED.
s3ReportOutput (dict) --
The S3 location where the report was written.
s3ObjectKey (string) --
The S3 object key for the generated report.
failedReportOutput (dict) --
Details when report generation failed.
errorCode (string) --
The error code describing why the report generation failed.
errorMessage (string) --
The error message describing why the report generation failed.
Updates an existing system.
See also: AWS API Documentation
Request Syntax
client.update_system(
systemArn='string',
description='string',
sharingEnabled=True|False
)
string
[REQUIRED]
ARN identifier.
string
Resource description.
boolean
Whether cross-account sharing is enabled for the system.
dict
Response Syntax
{
'system': {
'systemArn': 'string',
'systemId': 'string',
'name': 'string',
'description': 'string',
'sharingEnabled': True|False,
'tags': {
'string': 'string'
},
'kmsKeyId': 'string',
'organizationId': 'string',
'ouId': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
system (dict) --
The updated system.
systemArn (string) --
ARN identifier.
systemId (string) --
System ID for cross-account use without exposing account structure.
name (string) --
Resource name (used in ARN — no spaces allowed).
description (string) --
Resource description.
sharingEnabled (boolean) --
Indicates whether cross-account sharing is enabled.
tags (dict) --
Resource tags.
(string) --
Tag key.
(string) --
Tag value.
kmsKeyId (string) --
KMS key identifier — accepts key ID, key ARN, alias name, or alias ARN.
organizationId (string) --
The AWS Organizations identifier for the system.
ouId (string) --
The organizational unit (OU) identifier for the system.
createdAt (datetime) --
The timestamp when the system was created.
updatedAt (datetime) --
The timestamp when the system was last updated.
Retrieves a system by ARN.
See also: AWS API Documentation
Request Syntax
client.get_system(
systemArn='string'
)
string
[REQUIRED]
ARN identifier.
dict
Response Syntax
{
'system': {
'systemArn': 'string',
'systemId': 'string',
'name': 'string',
'description': 'string',
'sharingEnabled': True|False,
'tags': {
'string': 'string'
},
'kmsKeyId': 'string',
'organizationId': 'string',
'ouId': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
system (dict) --
The requested system.
systemArn (string) --
ARN identifier.
systemId (string) --
System ID for cross-account use without exposing account structure.
name (string) --
Resource name (used in ARN — no spaces allowed).
description (string) --
Resource description.
sharingEnabled (boolean) --
Indicates whether cross-account sharing is enabled.
tags (dict) --
Resource tags.
(string) --
Tag key.
(string) --
Tag value.
kmsKeyId (string) --
KMS key identifier — accepts key ID, key ARN, alias name, or alias ARN.
organizationId (string) --
The AWS Organizations identifier for the system.
ouId (string) --
The organizational unit (OU) identifier for the system.
createdAt (datetime) --
The timestamp when the system was created.
updatedAt (datetime) --
The timestamp when the system was last updated.