TimestreamWrite / Client / describe_database

describe_database#

TimestreamWrite.Client.describe_database(**kwargs)#

Returns information about the database, including the database name, time that the database was created, and the total number of tables found within the database. Service quotas apply. See code sample for details.

Request Syntax

response = client.describe_database(
    DatabaseName='string'
)

Parameters:

DatabaseName (string) –

[REQUIRED]

The name of the Timestream database.

Return type:

dict

Returns:

Response Syntax

{
    'Database': {
        'Arn': 'string',
        'DatabaseName': 'string',
        'TableCount': 123,
        'KmsKeyId': 'string',
        'CreationTime': datetime(2015, 1, 1),
        'LastUpdatedTime': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) –
- Database (dict) –
  
  The name of the Timestream table.
  - 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.

Exceptions

TimestreamWrite.Client.exceptions.ResourceNotFoundException
TimestreamWrite.Client.exceptions.ValidationException
TimestreamWrite.Client.exceptions.AccessDeniedException
TimestreamWrite.Client.exceptions.ThrottlingException
TimestreamWrite.Client.exceptions.InternalServerException
TimestreamWrite.Client.exceptions.InvalidEndpointException