ListVectorBuckets
Note
Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.
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
POST /ListVectorBuckets HTTP/1.1
Content-type: application/json
{
"maxResults": number
,
"nextToken": "string
",
"prefix": "string
"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- maxResults
-
The maximum number of vector buckets to be returned in the response.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 500.
Required: No
- nextToken
-
The previous pagination token.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Required: No
- prefix
-
Limits the response to vector buckets that begin with the specified prefix.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"nextToken": "string",
"vectorBuckets": [
{
"creationTime": number,
"vectorBucketArn": "string",
"vectorBucketName": "string"
}
]
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- nextToken
-
The element is included in the response when there are more buckets to be listed with pagination.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
- vectorBuckets
-
The list of vector buckets owned by the requester.
Type: Array of VectorBucketSummary objects
Errors
- AccessDeniedException
-
Access denied.
HTTP Status Code: 403
- InternalServerException
-
The request failed due to an internal server error.
HTTP Status Code: 500
- ServiceQuotaExceededException
-
Your request exceeds a service quota.
HTTP Status Code: 402
- ServiceUnavailableException
-
The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.
HTTP Status Code: 503
- TooManyRequestsException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The requested action isn't valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: