TimestreamWrite / Client / list_databases

list_databases#

TimestreamWrite.Client.list_databases(**kwargs)#

Returns a list of your Timestream databases. Service quotas apply. See code sample for details.

See also: AWS API Documentation

Request Syntax

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

  • NextToken (string) – The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.

  • MaxResults (integer) – The total number of items to return in the output. If the total number of items available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.

Return type:

dict

Returns:

Response Syntax

{
    'Databases': [
        {
            'Arn': 'string',
            'DatabaseName': 'string',
            'TableCount': 123,
            'KmsKeyId': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'LastUpdatedTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Databases (list) –

      A list of database names.

      • (dict) –

        A top-level container for a table. Databases and tables are the fundamental management concepts in Amazon Timestream. All tables in a database are encrypted with the same KMS key.

        • Arn (string) –

          The Amazon Resource Name that uniquely identifies this database.

        • DatabaseName (string) –

          The name of the Timestream database.

        • TableCount (integer) –

          The total number of tables found within a Timestream database.

        • KmsKeyId (string) –

          The identifier of the KMS key used to encrypt the data stored in the database.

        • CreationTime (datetime) –

          The time when the database was created, calculated from the Unix epoch time.

        • LastUpdatedTime (datetime) –

          The last time that this database was updated.

    • NextToken (string) –

      The pagination token. This parameter is returned when the response is truncated.

Exceptions