get_component

SsmSap.Client.get_component(**kwargs)

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

See also: AWS API Documentation

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',
        'ApplicationId': 'string',
        'ComponentType': 'HANA',
        'Status': 'ACTIVATED',
        'Databases': [
            'string',
        ],
        'Hosts': [
            {
                'HostName': 'string',
                'HostRole': 'LEADER'|'WORKER'|'STANDBY'|'UNKNOWN',
                'HostIp': 'string',
                'InstanceId': 'string'
            },
        ],
        'PrimaryHost': 'string',
        'LastUpdated': datetime(2015, 1, 1)
    }
}

Response Structure

• (dict) --

  • Component (dict) --

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

    • ComponentId (string) --

      The ID of the component.

    • ApplicationId (string) --

      The ID of the application.

    • ComponentType (string) --

      The type of the component.

    • Status (string) --

      The status of the component.

    • 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.

        • HostRole (string) --

          The role of the Dedicated Host.

        • HostIp (string) --

          The IP address of the Dedicated Host.

        • InstanceId (string) --

          The instance ID of the instance on the Dedicated Host.

    • PrimaryHost (string) --

      The primary host of the component.

    • LastUpdated (datetime) --

      The time at which the component was last updated.

Exceptions

• SsmSap.Client.exceptions.ValidationException
• SsmSap.Client.exceptions.InternalServerException