SsmSap / Client / list_databases

list_databases#

SsmSap.Client.list_databases(**kwargs)#

Lists the SAP HANA databases of an application registered with AWS Systems Manager for SAP.

See also: AWS API Documentation

Request Syntax

response = client.list_databases(
    ApplicationId='string',
    ComponentId='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • ApplicationId (string) – The ID of the application.

  • ComponentId (string) – The ID of the component.

  • NextToken (string) – The token for the next page of results.

  • MaxResults (integer) – The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. If you do not specify a value for MaxResults, the request returns 50 items per page by default.

Return type:

dict

Returns:

Response Syntax

{
    'Databases': [
        {
            'ApplicationId': 'string',
            'ComponentId': 'string',
            'DatabaseId': 'string',
            'DatabaseType': 'SYSTEM'|'TENANT',
            'Arn': 'string',
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Databases (list) –

      The SAP HANA databases of an application.

      • (dict) –

        The summary of the database.

        • ApplicationId (string) –

          The ID of the application.

        • ComponentId (string) –

          The ID of the component.

        • DatabaseId (string) –

          The ID of the database.

        • DatabaseType (string) –

          The type of the database.

        • Arn (string) –

          The Amazon Resource Name (ARN) of the database.

        • Tags (dict) –

          The tags of the database.

          • (string) –

            • (string) –

    • NextToken (string) –

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions

  • SsmSap.Client.exceptions.ResourceNotFoundException

  • SsmSap.Client.exceptions.ValidationException

  • SsmSap.Client.exceptions.InternalServerException