S3 / Paginator / ListDirectoryBuckets

ListDirectoryBuckets¶

class S3.Paginator.ListDirectoryBuckets¶

paginator = client.get_paginator('list_directory_buckets')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from S3.Client.list_directory_buckets().

Request Syntax

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

Parameters:

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

{
    'Buckets': [
        {
            'Name': 'string',
            'CreationDate': datetime(2015, 1, 1),
            'BucketRegion': 'string',
            'BucketArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- Buckets (list) –
  
  The list of buckets owned by the requester.
  - (dict) –
    
    In terms of implementation, a Bucket is a resource.
    - Name (string) –
      
      The name of the bucket.
    - CreationDate (datetime) –
      
      Date the bucket was created. This date can change when making changes to your bucket, such as editing its bucket policy.
    - BucketRegion (string) –
      
      BucketRegion indicates the Amazon Web Services region where the bucket is located. If the request contains at least one valid parameter, it is included in the response.
    - BucketArn (string) –
      
      The Amazon Resource Name (ARN) of the S3 bucket. ARNs uniquely identify Amazon Web Services resources across all of Amazon Web Services.
      
      Note
      This parameter is only supported for S3 directory buckets. For more information, see Using tags with directory buckets.
- NextToken (string) –
  
  A token to resume pagination.