get_database

SsmSap.Client.get_database(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_database(
    ApplicationId='string',
    ComponentId='string',
    DatabaseId='string',
    DatabaseArn='string'
)

Parameters

• ApplicationId (string) -- The ID of the application.
• ComponentId (string) -- The ID of the component.
• DatabaseId (string) -- The ID of the database.
• DatabaseArn (string) -- The Amazon Resource Name (ARN) of the database.

Return type

dict

Returns

Response Syntax

{
    'Database': {
        'ApplicationId': 'string',
        'ComponentId': 'string',
        'Credentials': [
            {
                'DatabaseName': 'string',
                'CredentialType': 'ADMIN',
                'SecretId': 'string'
            },
        ],
        'DatabaseId': 'string',
        'DatabaseName': 'string',
        'DatabaseType': 'SYSTEM'|'TENANT',
        'Arn': 'string',
        'Status': 'RUNNING'|'STARTING'|'STOPPED'|'WARNING'|'UNKNOWN',
        'PrimaryHost': 'string',
        'SQLPort': 123,
        'LastUpdated': datetime(2015, 1, 1)
    },
    'Tags': {
        'string': 'string'
    }
}

Response Structure

• (dict) --

  • Database (dict) --

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

    • ApplicationId (string) --

      The ID of the application.

    • ComponentId (string) --

      The ID of the component.

    • Credentials (list) --

      The credentials of the database.

      • (dict) --

        The credentials of your SAP application.

        • DatabaseName (string) --

          The name of the SAP HANA database.

        • CredentialType (string) --

          The type of the application credentials.

        • SecretId (string) --

          The secret ID created in AWS Secrets Manager to store the credentials of the SAP application.

    • DatabaseId (string) --

      The ID of the SAP HANA database.

    • DatabaseName (string) --

      The name of the database.

    • DatabaseType (string) --

      The type of the database.

    • Arn (string) --

      The Amazon Resource Name (ARN) of the database.

    • Status (string) --

      The status of the database.

    • PrimaryHost (string) --

      The primary host of the database.

    • SQLPort (integer) --

      The SQL port of the database.

    • LastUpdated (datetime) --

      The time at which the database was last updated.

  • Tags (dict) --

    The tags of a database.

    • (string) --
      • (string) --

Exceptions

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