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

***************
list_namespaces
***************



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

  

  Lists the namespaces within a table bucket. For more information, see `Table namespaces <https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-namespace.html>`__ in the *Amazon Simple Storage Service User Guide*.

    Permissions  

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

  

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


  **Request Syntax**
  ::

    response = client.list_namespaces(
        tableBucketARN='string',
        prefix='string',
        continuationToken='string',
        maxNamespaces=123
    )
    
  :type tableBucketARN: string
  :param tableBucketARN: **[REQUIRED]** 

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

    

  
  :type prefix: string
  :param prefix: 

    The prefix of the namespaces.

    

  
  :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 maxNamespaces: integer
  :param maxNamespaces: 

    The maximum number of namespaces to return in the list.

    

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

    
    ::

      {
          'namespaces': [
              {
                  'namespace': [
                      'string',
                  ],
                  'createdAt': datetime(2015, 1, 1),
                  'createdBy': 'string',
                  'ownerAccountId': 'string',
                  'namespaceId': 'string',
                  'tableBucketId': 'string'
              },
          ],
          'continuationToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **namespaces** *(list) --* 

        A list of namespaces.

        
        

        - *(dict) --* 

          Contains details about a namespace.

          
          

          - **namespace** *(list) --* 

            The name of the namespace.

            
            

            - *(string) --* 
        
          

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

            The date and time the namespace was created at.

            
          

          - **createdBy** *(string) --* 

            The ID of the account that created the namespace.

            
          

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

            The ID of the account that owns the namespace.

            
          

          - **namespaceId** *(string) --* 

            The system-assigned unique identifier for the namespace.

            
          

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

            The system-assigned unique identifier for the table bucket that contains this namespace.

            
      
    
      

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

        The ``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`

  