Table Of Contents


User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . athena ]



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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--catalog-name <value>
--database-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--catalog-name (string)

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

--database-name (string)

The name of the database to return.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.


To return information about a database in a data catalog

The following get-database example returns information about the sampledb database in the AwsDataCatalog data catalog.

aws athena get-database \
    --catalog-name AwsDataCatalog \
    --database-name sampledb


    "Database": {
        "Name": "sampledb",
        "Description": "Sample database",
        "Parameters": {
            "CreatedBy": "Athena",
            "EXTERNAL": "TRUE"

For more information, see Showing Database Details: get-database in the Amazon Athena User Guide.


Database -> (structure)

The database returned.

Name -> (string)

The name of the database.

Description -> (string)

An optional description of the database.

Parameters -> (map)

A set of custom key/value pairs.

key -> (string)

value -> (string)