:doc:`TimestreamWrite <../../timestream-write>` / Client / describe_database

*****************
describe_database
*****************



.. py:method:: 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 <https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html>`__. See `code sample <https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-db.html>`__ for details.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/DescribeDatabase>`_  


  **Request Syntax**
  ::

    response = client.describe_database(
        DatabaseName='string'
    )
    
  :type DatabaseName: string
  :param DatabaseName: **[REQUIRED]** 

    The name of the Timestream database.

    

  
  
  :rtype: 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**
  
  *   :py:class:`TimestreamWrite.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`TimestreamWrite.Client.exceptions.ValidationException`

  
  *   :py:class:`TimestreamWrite.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`TimestreamWrite.Client.exceptions.ThrottlingException`

  
  *   :py:class:`TimestreamWrite.Client.exceptions.InternalServerException`

  
  *   :py:class:`TimestreamWrite.Client.exceptions.InvalidEndpointException`

  