S3Tables / Paginator / ListNamespaces

ListNamespaces#

class S3Tables.Paginator.ListNamespaces#

paginator = client.get_paginator('list_namespaces')

paginate(**kwargs)#

Creates an iterator that will paginate through responses from S3Tables.Client.list_namespaces().

Request Syntax

response_iterator = paginator.paginate(
    tableBucketARN='string',
    prefix='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

tableBucketARN (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the table bucket.
prefix (string) – The prefix of the namespaces.
PaginationConfig (dict) –
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.

Return type:

dict

Returns:

Response Syntax

{
    'namespaces': [
        {
            'namespace': [
                'string',
            ],
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'ownerAccountId': 'string'
        },
    ],
    'NextToken': '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.
- NextToken (string) –
  
  A token to resume pagination.