:doc:`S3Tables <../../s3tables>` / Client / list_table_buckets

******************
list_table_buckets
******************



.. py:method:: S3Tables.Client.list_table_buckets(**kwargs)

  

  Lists table buckets for your account. For more information, see `S3 Table buckets <https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-buckets.html>`__ in the *Amazon Simple Storage Service User Guide*.

    Permissions  

  You must have the ``s3tables:ListTableBuckets`` permission to use this operation.

  

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


  **Request Syntax**
  ::

    response = client.list_table_buckets(
        prefix='string',
        continuationToken='string',
        maxBuckets=123,
        type='customer'|'aws'
    )
    
  :type prefix: string
  :param prefix: 

    The prefix of the table buckets.

    

  
  :type continuationToken: string
  :param continuationToken: 

    ``ContinuationToken`` indicates to Amazon S3 that the list is being continued on this bucket with a token. ``ContinuationToken`` is obfuscated and is not a real key. You can use this ``ContinuationToken`` for pagination of the list results.

    

  
  :type maxBuckets: integer
  :param maxBuckets: 

    The maximum number of table buckets to return in the list.

    

  
  :type type: string
  :param type: 

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

    

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

    
    ::

      {
          'tableBuckets': [
              {
                  'arn': 'string',
                  'name': 'string',
                  'ownerAccountId': 'string',
                  'createdAt': datetime(2015, 1, 1),
                  'tableBucketId': 'string',
                  'type': 'customer'|'aws'
              },
          ],
          'continuationToken': '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.

            
      
    
      

      - **continuationToken** *(string) --* 

        You can use this ``ContinuationToken`` for pagination of the list results.

        
  
  **Exceptions**
  
  *   :py:class:`S3Tables.Client.exceptions.InternalServerErrorException`

  
  *   :py:class:`S3Tables.Client.exceptions.ForbiddenException`

  
  *   :py:class:`S3Tables.Client.exceptions.NotFoundException`

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

  
  *   :py:class:`S3Tables.Client.exceptions.TooManyRequestsException`

  
  *   :py:class:`S3Tables.Client.exceptions.ConflictException`

  
  *   :py:class:`S3Tables.Client.exceptions.BadRequestException`

  