S3Vectors / Paginator / ListVectorBuckets

ListVectorBuckets¶

class S3Vectors.Paginator.ListVectorBuckets¶

paginator = client.get_paginator('list_vector_buckets')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from S3Vectors.Client.list_vector_buckets().

Request Syntax

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

Parameters:

prefix (string) – Limits the response to vector buckets that begin with the specified prefix.
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

{
    'vectorBuckets': [
        {
            'vectorBucketName': 'string',
            'vectorBucketArn': 'string',
            'creationTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- vectorBuckets (list) –
  
  The list of vector buckets owned by the requester.
  - (dict) –
    
    Note
    Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.
    
    Summary information about a vector bucket.
    - vectorBucketName (string) –
      
      The name of the vector bucket.
    - vectorBucketArn (string) –
      
      The Amazon Resource Name (ARN) of the vector bucket.
    - creationTime (datetime) –
      
      Date and time when the vector bucket was created.
- NextToken (string) –
  
  A token to resume pagination.