:doc:`Athena <../../athena>` / Client / get_database

************
get_database
************



.. py:method:: Athena.Client.get_database(**kwargs)

  

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

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetDatabase>`_  


  **Request Syntax**
  ::

    response = client.get_database(
        CatalogName='string',
        DatabaseName='string',
        WorkGroup='string'
    )
    
  :type CatalogName: string
  :param CatalogName: **[REQUIRED]** 

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

    

  
  :type DatabaseName: string
  :param DatabaseName: **[REQUIRED]** 

    The name of the database to return.

    

  
  :type WorkGroup: string
  :param WorkGroup: 

    The name of the workgroup for which the metadata is being fetched. Required if requesting an IAM Identity Center enabled Glue Data Catalog.

    

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

  
  *   :py:class:`Athena.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`Athena.Client.exceptions.MetadataException`

  