get_system¶

ResilienceHubV2.Client.get_system(**kwargs)¶

Retrieves a system by ARN.

Request Syntax

response = client.get_system(
    systemArn='string'
)

Parameters:

systemArn (string) –

[REQUIRED]

ARN identifier.

Return type:

dict

Returns:

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.

Exceptions

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