:doc:`S3Tables <../../s3tables>` / Paginator / ListTableBuckets

****************
ListTableBuckets
****************



.. py:class:: S3Tables.Paginator.ListTableBuckets

  ::

    
    paginator = client.get_paginator('list_table_buckets')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`S3Tables.Client.list_table_buckets`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/s3tables-2018-05-10/ListTableBuckets>`_    


    **Request Syntax**
    ::

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

      The prefix of the table buckets.

      

    
    :type type: string
    :param type: 

      The type of table buckets to filter by in the list.

      

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

      
      ::

        {
            'tableBuckets': [
                {
                    'arn': 'string',
                    'name': 'string',
                    'ownerAccountId': 'string',
                    'createdAt': datetime(2015, 1, 1),
                    'tableBucketId': 'string',
                    'type': 'customer'|'aws'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **tableBuckets** *(list) --* 

          A list of table buckets.

          
          

          - *(dict) --* 

            Contains details about a table bucket.

            
            

            - **arn** *(string) --* 

              The Amazon Resource Name (ARN) of the table bucket.

              
            

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

              The name of the table bucket.

              
            

            - **ownerAccountId** *(string) --* 

              The ID of the account that owns the table bucket.

              
            

            - **createdAt** *(datetime) --* 

              The date and time the table bucket was created at.

              
            

            - **tableBucketId** *(string) --* 

              The system-assigned unique identifier for the table bucket.

              
            

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

              The type of the table bucket.

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    