:doc:`Athena <../../athena>` / Paginator / ListDataCatalogs

****************
ListDataCatalogs
****************



.. py:class:: Athena.Paginator.ListDataCatalogs

  ::

    
    paginator = client.get_paginator('list_data_catalogs')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`Athena.Client.list_data_catalogs`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          WorkGroup='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type WorkGroup: string
    :param WorkGroup: 

      The name of the workgroup. Required if making an IAM Identity Center request.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'DataCatalogsSummary': [
                {
                    'CatalogName': 'string',
                    'Type': 'LAMBDA'|'GLUE'|'HIVE'|'FEDERATED',
                    'Status': 'CREATE_IN_PROGRESS'|'CREATE_COMPLETE'|'CREATE_FAILED'|'CREATE_FAILED_CLEANUP_IN_PROGRESS'|'CREATE_FAILED_CLEANUP_COMPLETE'|'CREATE_FAILED_CLEANUP_FAILED'|'DELETE_IN_PROGRESS'|'DELETE_COMPLETE'|'DELETE_FAILED',
                    'ConnectionType': 'DYNAMODB'|'MYSQL'|'POSTGRESQL'|'REDSHIFT'|'ORACLE'|'SYNAPSE'|'SQLSERVER'|'DB2'|'OPENSEARCH'|'BIGQUERY'|'GOOGLECLOUDSTORAGE'|'HBASE'|'DOCUMENTDB'|'CMDB'|'TPCDS'|'TIMESTREAM'|'SAPHANA'|'SNOWFLAKE'|'DATALAKEGEN2'|'DB2AS400',
                    'Error': 'string'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **DataCatalogsSummary** *(list) --* 

          A summary list of data catalogs.

          
          

          - *(dict) --* 

            The summary information for the data catalog, which includes its name and type.

            
            

            - **CatalogName** *(string) --* 

              The name of the data catalog. The catalog name is unique for the Amazon Web Services account and can use a maximum of 127 alphanumeric, underscore, at sign, or hyphen characters. The remainder of the length constraint of 256 is reserved for use by Athena.

              
            

            - **Type** *(string) --* 

              The data catalog type.

              
            

            - **Status** *(string) --* 

              The status of the creation or deletion of the data catalog.

               

              
              * The ``LAMBDA``, ``GLUE``, and ``HIVE`` data catalog types are created synchronously. Their status is either ``CREATE_COMPLETE`` or ``CREATE_FAILED``.
               
              * The ``FEDERATED`` data catalog type is created asynchronously.
              

               

              Data catalog creation status:

               

              
              * ``CREATE_IN_PROGRESS``: Federated data catalog creation in progress.
               
              * ``CREATE_COMPLETE``: Data catalog creation complete.
               
              * ``CREATE_FAILED``: Data catalog could not be created.
               
              * ``CREATE_FAILED_CLEANUP_IN_PROGRESS``: Federated data catalog creation failed and is being removed.
               
              * ``CREATE_FAILED_CLEANUP_COMPLETE``: Federated data catalog creation failed and was removed.
               
              * ``CREATE_FAILED_CLEANUP_FAILED``: Federated data catalog creation failed but could not be removed.
              

               

              Data catalog deletion status:

               

              
              * ``DELETE_IN_PROGRESS``: Federated data catalog deletion in progress.
               
              * ``DELETE_COMPLETE``: Federated data catalog deleted.
               
              * ``DELETE_FAILED``: Federated data catalog could not be deleted.
              

              
            

            - **ConnectionType** *(string) --* 

              The type of connection for a ``FEDERATED`` data catalog (for example, ``REDSHIFT``, ``MYSQL``, or ``SQLSERVER``). For information about individual connectors, see `Available data source connectors <https://docs.aws.amazon.com/athena/latest/ug/connectors-available.html>`__.

              
            

            - **Error** *(string) --* 

              Text of the error that occurred during data catalog creation or deletion.

              
        
      
    