:doc:`RedshiftDataAPIService <../../redshift-data>` / Paginator / ListTables

**********
ListTables
**********



.. py:class:: RedshiftDataAPIService.Paginator.ListTables

  ::

    
    paginator = client.get_paginator('list_tables')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`RedshiftDataAPIService.Client.list_tables`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/ListTables>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          ClusterIdentifier='string',
          SecretArn='string',
          DbUser='string',
          Database='string',
          ConnectedDatabase='string',
          SchemaPattern='string',
          TablePattern='string',
          WorkgroupName='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type ClusterIdentifier: string
    :param ClusterIdentifier: 

      The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

      

    
    :type SecretArn: string
    :param SecretArn: 

      The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.

      

    
    :type DbUser: string
    :param DbUser: 

      The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials.

      

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

      The name of the database that contains the tables to list. If ``ConnectedDatabase`` is not specified, this is also the database to connect to with your authentication credentials.

      

    
    :type ConnectedDatabase: string
    :param ConnectedDatabase: 

      A database name. The connected database is specified when you connect with your authentication credentials.

      

    
    :type SchemaPattern: string
    :param SchemaPattern: 

      A pattern to filter results by schema name. Within a schema pattern, "%" means match any substring of 0 or more characters and "_" means match any one character. Only schema name entries matching the search pattern are returned. If ``SchemaPattern`` is not specified, then all tables that match ``TablePattern`` are returned. If neither ``SchemaPattern`` or ``TablePattern`` are specified, then all tables are returned.

      

    
    :type TablePattern: string
    :param TablePattern: 

      A pattern to filter results by table name. Within a table pattern, "%" means match any substring of 0 or more characters and "_" means match any one character. Only table name entries matching the search pattern are returned. If ``TablePattern`` is not specified, then all tables that match ``SchemaPattern``are returned. If neither ``SchemaPattern`` or ``TablePattern`` are specified, then all tables are returned.

      

    
    :type WorkgroupName: string
    :param WorkgroupName: 

      The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

      

    
    :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**

      
      ::

        {
            'Tables': [
                {
                    'name': 'string',
                    'type': 'string',
                    'schema': 'string'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **Tables** *(list) --* 

          The tables that match the request pattern.

          
          

          - *(dict) --* 

            The properties of a table.

            
            

            - **name** *(string) --* 

              The name of the table.

              
            

            - **type** *(string) --* 

              The type of the table. Possible values include TABLE, VIEW, SYSTEM TABLE, GLOBAL TEMPORARY, LOCAL TEMPORARY, ALIAS, and SYNONYM.

              
            

            - **schema** *(string) --* 

              The schema containing the table.

              
        
      
    