S3Vectors / Client / list_vector_buckets

list_vector_buckets¶

S3Vectors.Client.list_vector_buckets(**kwargs)¶

Returns a list of all the vector buckets that are owned by the authenticated sender of the request.

Permissions

You must have the s3vectors:ListVectorBuckets permission to use this operation.

Request Syntax

response = client.list_vector_buckets(
    maxResults=123,
    nextToken='string',
    prefix='string'
)

Parameters:

maxResults (integer) – The maximum number of vector buckets to be returned in the response.
nextToken (string) – The previous pagination token.
prefix (string) – Limits the response to vector buckets that begin with the specified prefix.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –
- nextToken (string) –
  
  The element is included in the response when there are more buckets to be listed with pagination.
- vectorBuckets (list) –
  
  The list of vector buckets owned by the requester.
  - (dict) –
    
    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.

Exceptions

S3Vectors.Client.exceptions.ValidationException
S3Vectors.Client.exceptions.ServiceUnavailableException
S3Vectors.Client.exceptions.TooManyRequestsException
S3Vectors.Client.exceptions.InternalServerException
S3Vectors.Client.exceptions.AccessDeniedException
S3Vectors.Client.exceptions.RequestTimeoutException