2026/10/13 - AWS Resilience Hub V2 - 10 updated api methods
Changes Adds support for DevOpsAgent integration where users can specify the agent space ARN at service level and launch investigations directly from Resilience Hub v2.
{'devOpsAgentConfiguration': {'agentSpaceArn': 'string'}}
Response {'service': {'devOpsAgentConfiguration': {'agentSpaceArn': 'string',
'agentSpaceId': 'string',
'connectedAt': 'timestamp',
'operatorAppUrl': 'string',
'region': 'string',
'status': 'CONNECTING | CONNECTED | '
'DISCONNECTED | FAILED',
'statusReason': 'string'}}}
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',
devOpsAgentConfiguration={
'agentSpaceArn': '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 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
The optional DevOps Agent integration configuration to apply to the new service. If you omit this field, the new service has no DevOps Agent integration.
agentSpaceArn (string) --
The ARN of the DevOps Agent Agent Space to link to this service.
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),
'eligibleResourceCount': 123,
'message': 'string'
},
'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',
'dataRecoveryTimeBetweenBackups': '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',
'devOpsAgentConfiguration': {
'agentSpaceArn': 'string',
'agentSpaceId': 'string',
'region': 'string',
'status': 'CONNECTING'|'CONNECTED'|'DISCONNECTED'|'FAILED',
'operatorAppUrl': 'string',
'connectedAt': datetime(2015, 1, 1),
'statusReason': '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 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.
eligibleResourceCount (integer) --
The count of resources eligible for dependency attribution.
message (string) --
A status message for dependency discovery, displayed during the initialization state.
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.
dataRecoveryTimeBetweenBackups (string) --
The achievability status of the data recovery time between backups 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.
devOpsAgentConfiguration (dict) --
The current DevOps Agent integration state for the service.
agentSpaceArn (string) --
The ARN of the linked DevOps Agent Agent Space.
agentSpaceId (string) --
The identifier of the linked DevOps Agent Agent Space.
region (string) --
The AWS Region of the linked DevOps Agent Agent Space.
status (string) --
The connection status of the DevOps Agent integration for this service. Valid values:
CONNECTING - The service is being connected to the Agent Space.
CONNECTED - The service is connected to the Agent Space.
DISCONNECTED - The service is not connected to an Agent Space.
FAILED - The connection attempt failed. See statusReason for details.
operatorAppUrl (string) --
The URL of the DevOps Agent Operator App for the linked Agent Space. This URL is present when the connection status is CONNECTED.
connectedAt (datetime) --
The timestamp when the service successfully connected to the DevOps Agent Agent Space.
statusReason (string) --
A human-readable explanation of the current connection status. This field explains the status when the connection fails.
createdAt (datetime) --
The timestamp when the service was created.
updatedAt (datetime) --
The timestamp when the service was last updated.
{'finding': {'investigationDeepLink': 'string'}}
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),
'investigationDeepLink': 'string'
}
}
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.
investigationDeepLink (string) --
A deep link to an interactive DevOps Agent investigation seeded with this finding. This value is null until DevOps Agent creates an investigation.
{'service': {'devOpsAgentConfiguration': {'agentSpaceArn': 'string',
'agentSpaceId': 'string',
'connectedAt': 'timestamp',
'operatorAppUrl': 'string',
'region': 'string',
'status': 'CONNECTING | CONNECTED | '
'DISCONNECTED | FAILED',
'statusReason': 'string'}}}
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),
'eligibleResourceCount': 123,
'message': 'string'
},
'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',
'dataRecoveryTimeBetweenBackups': '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',
'devOpsAgentConfiguration': {
'agentSpaceArn': 'string',
'agentSpaceId': 'string',
'region': 'string',
'status': 'CONNECTING'|'CONNECTED'|'DISCONNECTED'|'FAILED',
'operatorAppUrl': 'string',
'connectedAt': datetime(2015, 1, 1),
'statusReason': '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 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.
eligibleResourceCount (integer) --
The count of resources eligible for dependency attribution.
message (string) --
A status message for dependency discovery, displayed during the initialization state.
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.
dataRecoveryTimeBetweenBackups (string) --
The achievability status of the data recovery time between backups 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.
devOpsAgentConfiguration (dict) --
The current DevOps Agent integration state for the service.
agentSpaceArn (string) --
The ARN of the linked DevOps Agent Agent Space.
agentSpaceId (string) --
The identifier of the linked DevOps Agent Agent Space.
region (string) --
The AWS Region of the linked DevOps Agent Agent Space.
status (string) --
The connection status of the DevOps Agent integration for this service. Valid values:
CONNECTING - The service is being connected to the Agent Space.
CONNECTED - The service is connected to the Agent Space.
DISCONNECTED - The service is not connected to an Agent Space.
FAILED - The connection attempt failed. See statusReason for details.
operatorAppUrl (string) --
The URL of the DevOps Agent Operator App for the linked Agent Space. This URL is present when the connection status is CONNECTED.
connectedAt (datetime) --
The timestamp when the service successfully connected to the DevOps Agent Agent Space.
statusReason (string) --
A human-readable explanation of the current connection status. This field explains the status when the connection fails.
createdAt (datetime) --
The timestamp when the service was created.
updatedAt (datetime) --
The timestamp when the service was last updated.
{'testRun': {'devOpsAgentInvestigation': {'confidence': 'HIGH | MEDIUM | LOW',
'deepLink': 'string',
'status': 'PENDING | IN_PROGRESS | '
'COMPLETED | FAILED | '
'TIMED_OUT | CANCELED',
'summary': 'string',
'verdict': 'PASS | FAIL'}}}
Retrieves a test run by ID, including its status, results, and the configuration snapshotted when the run started.
See also: AWS API Documentation
Request Syntax
client.get_test_run(
testRunId='string',
serviceArn='string'
)
string
[REQUIRED]
The identifier of the test run to retrieve.
string
[REQUIRED]
The ARN of the service the test run belongs to.
dict
Response Syntax
{
'testRun': {
'testRunId': 'string',
'testId': 'string',
'status': 'INITIALIZING'|'RUNNING'|'STOPPING'|'PASSED'|'FAILED'|'STOPPED'|'ERROR',
'serviceArn': 'string',
'startedAt': datetime(2015, 1, 1),
'endedAt': datetime(2015, 1, 1),
'experiments': [
{
'experimentArn': 'string',
'details': 'string'
},
],
'eventCount': 123,
'parameters': {
'string': [
'string',
]
},
'errorMessage': 'string',
'stopConditions': [
{
'source': 'aws:cloudwatch:alarm'|'none',
'value': 'string'
},
],
'loggingConfiguration': {
's3BucketName': 'string',
'cloudWatchLogGroupArn': 'string',
'logSchemaVersion': 'string'
},
'roleName': 'string',
'testTemplateArn': 'string',
'reportConfiguration': {
'reportOutput': [
{
's3': {
'bucketPath': 'string',
'bucketOwner': 'string'
}
},
]
},
'policy': {
'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
}
},
'reportOutput': {
'reportType': 'FAILURE_MODE'|'TESTING',
'status': 'PENDING'|'SUCCEEDED'|'FAILED',
'serviceArn': 'string',
'assessmentId': 'string',
'testRunId': 'string',
'testTemplateArn': 'string',
'createdAt': datetime(2015, 1, 1),
'reportOutput': {
's3ReportOutput': {
's3ObjectKey': 'string'
},
'failedReportOutput': {
'errorCode': 'INSUFFICIENT_PERMISSIONS'|'CONFIGURATION_ERROR'|'INTERNAL_ERROR',
'errorMessage': 'string'
}
}
},
'regionSwitchPlanArn': 'string',
'regionSwitchExecutionId': 'string',
'permissionModel': {
'invokerRoleName': 'string',
'crossAccountRoles': [
{
'crossAccountRoleArn': 'string',
'externalId': 'string'
},
]
},
'regions': [
'string',
],
'accountTargeting': 'SINGLE_ACCOUNT'|'MULTI_ACCOUNT',
'devOpsAgentInvestigation': {
'verdict': 'PASS'|'FAIL',
'confidence': 'HIGH'|'MEDIUM'|'LOW',
'deepLink': 'string',
'status': 'PENDING'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'TIMED_OUT'|'CANCELED',
'summary': 'string'
}
}
}
Response Structure
(dict) --
testRun (dict) --
The requested test run.
testRunId (string) --
The unique identifier of the test run.
testId (string) --
The identifier of the test that was run.
status (string) --
The current status of the test run.
serviceArn (string) --
The ARN of the service the test run belongs to.
startedAt (datetime) --
The timestamp when the test run started.
endedAt (datetime) --
The timestamp when the test run ended.
experiments (list) --
The AWS Fault Injection Service (AWS FIS) experiments run as part of the test run.
(dict) --
Details about an AWS Fault Injection Service (AWS FIS) experiment run as part of a test run.
experimentArn (string) --
The ARN of the AWS FIS experiment.
details (string) --
Additional details about the experiment.
eventCount (integer) --
The number of events recorded for the test run. Use ListTestRunEvents to retrieve the details.
parameters (dict) --
The parameter values used for the test run.
(string) --
The key of a test parameter.
(list) --
(string) --
A value of a test parameter.
errorMessage (string) --
A human-readable reason for test run failure. Only present when the status is FAILED or ERROR.
stopConditions (list) --
The stop conditions snapshotted from the test when the run was started.
(dict) --
A CloudWatch alarm that automatically stops a test run if it breaches its threshold.
source (string) --
The source of the stop condition.
value (string) --
The value of the stop condition, such as the ARN of the CloudWatch alarm.
loggingConfiguration (dict) --
The logging configuration snapshotted from the test when the run was started.
s3BucketName (string) --
The name of the S3 bucket for log delivery.
cloudWatchLogGroupArn (string) --
The ARN of the CloudWatch Logs log group for log delivery.
logSchemaVersion (string) --
The version of the log schema.
roleName (string) --
The IAM execution role name snapshotted from the test when the run was started.
testTemplateArn (string) --
The ARN of the test template snapshotted from the test when the run was started.
reportConfiguration (dict) --
The report configuration snapshotted from the service when the run was started.
reportOutput (list) --
The 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.
policy (dict) --
The resilience policy snapshotted from the service when the run was started.
policyArn (string) --
The ARN of the policy.
name (string) --
The name of the policy.
availabilitySlo (dict) --
The availability SLO targets.
target (float) --
The target availability percentage, expressed as a value between 0 and 100.
multiAz (dict) --
The multi-AZ resilience targets.
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 resilience targets.
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.
timeBetweenBackupsInMinutes (integer) --
The target time between backups, in minutes.
reportOutput (dict) --
The report generation result for the test run. Present after report generation completes or fails.
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.
testRunId (string) --
The unique identifier of a test run.
testTemplateArn (string) --
An ARN owned by the service. Accepts either a standard 12-digit account ID or the literal "aws" for AWS-managed resources, such as AWS-managed test templates.
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.
regionSwitchPlanArn (string) --
The ARN of the ARC Region switch plan associated with the test run.
regionSwitchExecutionId (string) --
The identifier of the ARC Region switch execution detected during the test run.
permissionModel (dict) --
The permission model snapshotted from the service when the run was started.
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.
regions (list) --
The Regions snapshotted from the service when the run was started.
(string) --
accountTargeting (string) --
Indicates whether the test run targets resources in a single AWS account or across multiple accounts.
devOpsAgentInvestigation (dict) --
The DevOps Agent investigation result for the test run, present when the integration is enabled for the service.
verdict (string) --
The investigation verdict. Valid values:
PASS - The resilience test run passed.
FAIL - The resilience test run failed.
INCONCLUSIVE - The investigation could not determine a clear outcome.
confidence (string) --
The confidence level of the verdict. Valid values:
HIGH - The verdict is highly reliable.
MEDIUM - The verdict has moderate reliability.
LOW - The verdict has low reliability.
deepLink (string) --
A deep link to the interactive DevOps Agent investigation session.
status (string) --
The lifecycle status of the investigation. Valid values:
PENDING - The investigation has been created but has not started.
IN_PROGRESS - The investigation is running.
COMPLETED - The investigation finished successfully.
FAILED - The investigation failed to complete.
TIMED_OUT - The investigation did not complete within the allotted time.
CANCELED - The investigation was canceled.
summary (string) --
The DevOps Agent analysis summary for the investigation.
{'service': {'devOpsAgentConfiguration': {'agentSpaceArn': 'string',
'agentSpaceId': 'string',
'connectedAt': 'timestamp',
'operatorAppUrl': 'string',
'region': 'string',
'status': 'CONNECTING | CONNECTED | '
'DISCONNECTED | FAILED',
'statusReason': 'string'}}}
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),
'eligibleResourceCount': 123,
'message': 'string'
},
'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',
'dataRecoveryTimeBetweenBackups': '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',
'devOpsAgentConfiguration': {
'agentSpaceArn': 'string',
'agentSpaceId': 'string',
'region': 'string',
'status': 'CONNECTING'|'CONNECTED'|'DISCONNECTED'|'FAILED',
'operatorAppUrl': 'string',
'connectedAt': datetime(2015, 1, 1),
'statusReason': '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 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.
eligibleResourceCount (integer) --
The count of resources eligible for dependency attribution.
message (string) --
A status message for dependency discovery, displayed during the initialization state.
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.
dataRecoveryTimeBetweenBackups (string) --
The achievability status of the data recovery time between backups 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.
devOpsAgentConfiguration (dict) --
The current DevOps Agent integration state for the service.
agentSpaceArn (string) --
The ARN of the linked DevOps Agent Agent Space.
agentSpaceId (string) --
The identifier of the linked DevOps Agent Agent Space.
region (string) --
The AWS Region of the linked DevOps Agent Agent Space.
status (string) --
The connection status of the DevOps Agent integration for this service. Valid values:
CONNECTING - The service is being connected to the Agent Space.
CONNECTED - The service is connected to the Agent Space.
DISCONNECTED - The service is not connected to an Agent Space.
FAILED - The connection attempt failed. See statusReason for details.
operatorAppUrl (string) --
The URL of the DevOps Agent Operator App for the linked Agent Space. This URL is present when the connection status is CONNECTED.
connectedAt (datetime) --
The timestamp when the service successfully connected to the DevOps Agent Agent Space.
statusReason (string) --
A human-readable explanation of the current connection status. This field explains the status when the connection fails.
createdAt (datetime) --
The timestamp when the service was created.
updatedAt (datetime) --
The timestamp when the service was last updated.
{'findingsSummary': {'investigationDeepLink': 'string'}}
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),
'investigationDeepLink': 'string'
},
],
'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.
investigationDeepLink (string) --
A deep link to an interactive DevOps Agent investigation seeded with this finding. This value is null until DevOps Agent creates an investigation.
nextToken (string) --
Pagination token.
{'serviceResources': {'resource': {'availabilityZoneId': 'string',
'availabilityZoneName': 'string',
'containmentParentId': 'string',
'logicalResourceGroupId': 'string'}}}
List resources.
See also: AWS API Documentation
Request Syntax
client.list_resources(
serviceArn='string',
serviceFunctionId='string',
awsRegion='string',
resourceTypes=[
'string',
],
billable=True|False,
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
ARN identifier.
string
Filter resources by service function identifier.
string
Filter resources by AWS Region.
list
The CloudFormation resource types to include in the response.
(string) --
boolean
Specifies whether to filter non-billable resources. When true (the default), the operation returns only billable resources.
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',
'availabilityZoneId': 'string',
'availabilityZoneName': 'string',
'containmentParentId': 'string',
'logicalResourceGroupId': '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.
availabilityZoneId (string) --
The Availability Zone ID of the Availability Zone that hosts the resource, such as use1-az1. The Availability Zone ID is consistent across Amazon Web Services (AWS) accounts, unlike the Availability Zone name.
availabilityZoneName (string) --
The name of the Availability Zone that hosts the resource, such as us-west-2a.
containmentParentId (string) --
The identifier of the single parent resource that contains this resource, used to represent containment relationships in the resource topology. A resource has at most one containment parent.
logicalResourceGroupId (string) --
The identifier of the logical resource group that this resource belongs to. Resources that share this identifier are managed as a single unit.
nextToken (string) --
Pagination token.
{'serviceSummaries': {'devOpsAgentSpaceArn': 'string',
'devOpsAgentStatus': 'CONNECTING | CONNECTED | '
'DISCONNECTED | FAILED'}}
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',
'devOpsAgentStatus': 'CONNECTING'|'CONNECTED'|'DISCONNECTED'|'FAILED',
'devOpsAgentSpaceArn': 'string',
'openFindingsCount': 123,
'resolvedFindingsCount': 123,
'dependencyDiscovery': {
'status': 'ENABLED'|'INITIALIZING'|'DISABLED',
'updatedAt': datetime(2015, 1, 1),
'eligibleResourceCount': 123,
'message': 'string'
},
'achievability': {
'availabilitySlo': 'ACHIEVABLE'|'NOT_ACHIEVABLE',
'multiAzRtoRpo': 'ACHIEVABLE'|'NOT_ACHIEVABLE',
'multiRegionRtoRpo': 'ACHIEVABLE'|'NOT_ACHIEVABLE',
'dataRecoveryTimeBetweenBackups': '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 Regions where the service operates.
(string) --
policyArn (string) --
ARN identifier.
assessmentStatus (string) --
The current assessment status of the service.
devOpsAgentStatus (string) --
The DevOps Agent connection status for the service. Valid values:
CONNECTING - The service is being connected to the Agent Space.
CONNECTED - The service is connected to the Agent Space.
DISCONNECTED - The service is not connected to an Agent Space.
FAILED - The connection attempt failed.
devOpsAgentSpaceArn (string) --
The ARN of the DevOps Agent Agent Space linked to the service, when the service is linked to one.
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.
eligibleResourceCount (integer) --
The count of resources eligible for dependency attribution.
message (string) --
A status message for dependency discovery, displayed during the initialization state.
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.
dataRecoveryTimeBetweenBackups (string) --
The achievability status of the data recovery time between backups 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.
{'finding': {'investigationDeepLink': 'string'}}
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),
'investigationDeepLink': 'string'
}
}
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.
investigationDeepLink (string) --
A deep link to an interactive DevOps Agent investigation seeded with this finding. This value is null until DevOps Agent creates an investigation.
{'devOpsAgentConfiguration': {'agentSpaceArn': 'string'}}
Response {'service': {'devOpsAgentConfiguration': {'agentSpaceArn': 'string',
'agentSpaceId': 'string',
'connectedAt': 'timestamp',
'operatorAppUrl': 'string',
'region': 'string',
'status': 'CONNECTING | CONNECTED | '
'DISCONNECTED | FAILED',
'statusReason': 'string'}}}
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'
}
},
]
},
devOpsAgentConfiguration={
'agentSpaceArn': '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
The optional DevOps Agent integration configuration to set, replace, or disconnect for the service. If you omit this field, the existing DevOps Agent linkage stays unchanged.
agentSpaceArn (string) --
The ARN of the DevOps Agent Agent Space to link to this service.
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),
'eligibleResourceCount': 123,
'message': 'string'
},
'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',
'dataRecoveryTimeBetweenBackups': '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',
'devOpsAgentConfiguration': {
'agentSpaceArn': 'string',
'agentSpaceId': 'string',
'region': 'string',
'status': 'CONNECTING'|'CONNECTED'|'DISCONNECTED'|'FAILED',
'operatorAppUrl': 'string',
'connectedAt': datetime(2015, 1, 1),
'statusReason': '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 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.
eligibleResourceCount (integer) --
The count of resources eligible for dependency attribution.
message (string) --
A status message for dependency discovery, displayed during the initialization state.
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.
dataRecoveryTimeBetweenBackups (string) --
The achievability status of the data recovery time between backups 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.
devOpsAgentConfiguration (dict) --
The current DevOps Agent integration state for the service.
agentSpaceArn (string) --
The ARN of the linked DevOps Agent Agent Space.
agentSpaceId (string) --
The identifier of the linked DevOps Agent Agent Space.
region (string) --
The AWS Region of the linked DevOps Agent Agent Space.
status (string) --
The connection status of the DevOps Agent integration for this service. Valid values:
CONNECTING - The service is being connected to the Agent Space.
CONNECTED - The service is connected to the Agent Space.
DISCONNECTED - The service is not connected to an Agent Space.
FAILED - The connection attempt failed. See statusReason for details.
operatorAppUrl (string) --
The URL of the DevOps Agent Operator App for the linked Agent Space. This URL is present when the connection status is CONNECTED.
connectedAt (datetime) --
The timestamp when the service successfully connected to the DevOps Agent Agent Space.
statusReason (string) --
A human-readable explanation of the current connection status. This field explains the status when the connection fails.
createdAt (datetime) --
The timestamp when the service was created.
updatedAt (datetime) --
The timestamp when the service was last updated.