ResilienceHubV2 / Client / update_service

update_service¶

ResilienceHubV2.Client.update_service(**kwargs)¶

Updates an existing service.

Request Syntax

response = 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'
                }
            },
        ]
    }
)

Parameters:

serviceArn (string) –
[REQUIRED]

ARN identifier.
description (string) – Resource description for services and policies.
associatedSystems (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) –
policyArn (string) – ARN identifier.
regions (list) –
The updated AWS Regions where the service operates.
- (string) –
permissionModel (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.
dependencyDiscovery (string) – Caller-settable values for dependency discovery. INITIALIZING is system-managed.
reportConfiguration (dict) –
Configuration for automatic report generation on a Service.
- reportOutputs (list) – [REQUIRED]
  
  Output destinations for generated reports.
  - (dict) –
    
    Configuration for a report output destination.
    
    Note
    This is a Tagged Union structure. Only one of the following top level keys can be set: s3.
    - 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.

Return type:

dict

Returns:

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.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys will be set: s3. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        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.

Exceptions

ResilienceHubV2.Client.exceptions.InternalServerException
ResilienceHubV2.Client.exceptions.ResourceNotFoundException
ResilienceHubV2.Client.exceptions.ValidationException
ResilienceHubV2.Client.exceptions.ConflictException
ResilienceHubV2.Client.exceptions.ServiceQuotaExceededException
ResilienceHubV2.Client.exceptions.AccessDeniedException