SsmSap / Client / get_component

get_component#

SsmSap.Client.get_component(**kwargs)#

Gets the component of an application registered with AWS Systems Manager for SAP.

Request Syntax

response = client.get_component(
    ApplicationId='string',
    ComponentId='string'
)

Parameters:

ApplicationId (string) –
[REQUIRED]

The ID of the application.
ComponentId (string) –
[REQUIRED]

The ID of the component.

Return type:

dict

Returns:

Response Syntax

{
    'Component': {
        'ComponentId': 'string',
        'Sid': 'string',
        'SystemNumber': 'string',
        'ParentComponent': 'string',
        'ChildComponents': [
            'string',
        ],
        'ApplicationId': 'string',
        'ComponentType': 'HANA'|'HANA_NODE'|'ABAP'|'ASCS'|'DIALOG'|'WEBDISP'|'WD'|'ERS',
        'Status': 'ACTIVATED'|'STARTING'|'STOPPED'|'STOPPING'|'RUNNING'|'RUNNING_WITH_ERROR'|'UNDEFINED',
        'SapHostname': 'string',
        'SapFeature': 'string',
        'SapKernelVersion': 'string',
        'HdbVersion': 'string',
        'Resilience': {
            'HsrTier': 'string',
            'HsrReplicationMode': 'PRIMARY'|'NONE'|'SYNC'|'SYNCMEM'|'ASYNC',
            'HsrOperationMode': 'PRIMARY'|'LOGREPLAY'|'DELTA_DATASHIPPING'|'LOGREPLAY_READACCESS'|'NONE',
            'ClusterStatus': 'ONLINE'|'STANDBY'|'MAINTENANCE'|'OFFLINE'|'NONE',
            'EnqueueReplication': True|False
        },
        'AssociatedHost': {
            'Hostname': 'string',
            'Ec2InstanceId': 'string',
            'IpAddresses': [
                {
                    'IpAddress': 'string',
                    'Primary': True|False,
                    'AllocationType': 'VPC_SUBNET'|'ELASTIC_IP'|'OVERLAY'|'UNKNOWN'
                },
            ],
            'OsVersion': 'string'
        },
        'Databases': [
            'string',
        ],
        'Hosts': [
            {
                'HostName': 'string',
                'HostIp': 'string',
                'EC2InstanceId': 'string',
                'InstanceId': 'string',
                'HostRole': 'LEADER'|'WORKER'|'STANDBY'|'UNKNOWN',
                'OsVersion': 'string'
            },
        ],
        'PrimaryHost': 'string',
        'DatabaseConnection': {
            'DatabaseConnectionMethod': 'DIRECT'|'OVERLAY',
            'DatabaseArn': 'string',
            'ConnectionIp': 'string'
        },
        'LastUpdated': datetime(2015, 1, 1),
        'Arn': 'string'
    },
    'Tags': {
        'string': 'string'
    }
}

Response Structure

(dict) –
- Component (dict) –
  
  The component of an application registered with AWS Systems Manager for SAP.
  - ComponentId (string) –
    
    The ID of the component.
  - Sid (string) –
    
    The SAP System Identifier of the application component.
  - SystemNumber (string) –
    
    The SAP system number of the application component.
  - ParentComponent (string) –
    
    The parent component of a highly available environment. For example, in a highly available SAP on AWS workload, the parent component consists of the entire setup, including the child components.
  - ChildComponents (list) –
    
    The child components of a highly available environment. For example, in a highly available SAP on AWS workload, the child component consists of the primary and secondar instances.
    - (string) –
  - ApplicationId (string) –
    
    The ID of the application.
  - ComponentType (string) –
    
    The type of the component.
  - Status (string) –
    
    The status of the component.
    - ACTIVATED - this status has been deprecated.
    - STARTING - the component is in the process of being started.
    - STOPPED - the component is not running.
    - STOPPING - the component is in the process of being stopped.
    - RUNNING - the component is running.
    - RUNNING_WITH_ERROR - one or more child component(s) of the parent component is not running. Call GetComponent to review the status of each child component.
    - UNDEFINED - AWS Systems Manager for SAP cannot provide the component status based on the discovered information. Verify your SAP application.
  - SapHostname (string) –
    
    The hostname of the component.
  - SapFeature (string) –
    
    The SAP feature of the component.
  - SapKernelVersion (string) –
    
    The kernel version of the component.
  - HdbVersion (string) –
    
    The SAP HANA version of the component.
  - Resilience (dict) –
    
    Details of the SAP HANA system replication for the component.
    - HsrTier (string) –
      
      The tier of the component.
    - HsrReplicationMode (string) –
      
      The replication mode of the component.
    - HsrOperationMode (string) –
      
      The operation mode of the component.
    - ClusterStatus (string) –
      
      The cluster status of the component.
    - EnqueueReplication (boolean) –
      
      Indicates if or not enqueue replication is enabled for the ASCS component.
  - AssociatedHost (dict) –
    
    The associated host of the component.
    - Hostname (string) –
      
      The name of the host.
    - Ec2InstanceId (string) –
      
      The ID of the Amazon EC2 instance.
    - IpAddresses (list) –
      
      The IP addresses of the associated host.
      - (dict) –
        
        Provides information of the IP address.
        
        IpAddress (string) –
        
        The IP address.
        
        Primary (boolean) –
        
        The primary IP address.
        
        AllocationType (string) –
        
        The type of allocation for the IP address.
    - OsVersion (string) –
      
      The version of the operating system.
  - Databases (list) –
    
    The SAP HANA databases of the component.
    - (string) –
  - Hosts (list) –
    
    The hosts of the component.
    - (dict) –
      
      Describes the properties of the Dedicated Host.
      - HostName (string) –
        
        The name of the Dedicated Host.
      - HostIp (string) –
        
        The IP address of the Dedicated Host.
      - EC2InstanceId (string) –
        
        The ID of Amazon EC2 instance.
      - InstanceId (string) –
        
        The instance ID of the instance on the Dedicated Host.
      - HostRole (string) –
        
        The role of the Dedicated Host.
      - OsVersion (string) –
        
        The version of the operating system.
  - PrimaryHost (string) –
    
    The primary host of the component.
  - DatabaseConnection (dict) –
    
    The connection specifications for the database of the component.
    - DatabaseConnectionMethod (string) –
      
      The method of connection.
    - DatabaseArn (string) –
      
      The Amazon Resource Name of the connected SAP HANA database.
    - ConnectionIp (string) –
      
      The IP address for connection.
  - LastUpdated (datetime) –
    
    The time at which the component was last updated.
  - Arn (string) –
    
    The Amazon Resource Name (ARN) of the component.
- Tags (dict) –
  
  The tags of a component.
  - (string) –
    - (string) –

Exceptions

SsmSap.Client.exceptions.UnauthorizedException
SsmSap.Client.exceptions.ValidationException
SsmSap.Client.exceptions.InternalServerException