get_database

Athena.Client.get_database(**kwargs)

Returns a database object for the specified database and data catalog.

See also: AWS API Documentation

Request Syntax

response = client.get_database(
    CatalogName='string',
    DatabaseName='string'
)

Parameters

• CatalogName (string) --

  [REQUIRED]

  The name of the data catalog that contains the database to return.

• DatabaseName (string) --

  [REQUIRED]

  The name of the database to return.

Return type

dict

Returns

Response Syntax

{
    'Database': {
        'Name': 'string',
        'Description': 'string',
        'Parameters': {
            'string': 'string'
        }
    }
}

Response Structure

• (dict) --

  • Database (dict) --

    The database returned.

    • Name (string) --

      The name of the database.

    • Description (string) --

      An optional description of the database.

    • Parameters (dict) --

      A set of custom key/value pairs.

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

Exceptions

• Athena.Client.exceptions.InternalServerException
• Athena.Client.exceptions.InvalidRequestException
• Athena.Client.exceptions.MetadataException