list_vector_buckets ¶

list_vector_buckets(
    *,
    config_overrides: Optional[S3VectorsClientConfig] = None,
    max_results: Optional[ListVectorBucketsMaxResults] = None,
    next_token: Optional[ListVectorBucketsNextToken] = None,
    prefix: Optional[ListVectorBucketsPrefix] = None,
) -> ListVectorBucketsOutput

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.

Parameters:

max_results (Optional[ListVectorBucketsMaxResults], default: None ) –

The maximum number of vector buckets to be returned in the response.
next_token (Optional[ListVectorBucketsNextToken], default: None ) –

The previous pagination token.
prefix (Optional[ListVectorBucketsPrefix], default: None ) –

Limits the response to vector buckets that begin with the specified prefix.

Raises:

AccessDeniedException –

Access denied.
InternalServerException –

The request failed due to an internal server error.
RequestTimeoutException –

The request timed out. Retry your request.
TooManyRequestsException –

The request was denied due to request throttling.
ValidationException –

The requested action isn't valid.
ServiceUnavailableException –

The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_s3vectors/_services/s3_vectors.py

def list_vector_buckets(
    self,
    *,
    config_overrides: Optional[S3VectorsClientConfig] = None,
    max_results: Optional[
        "capo_s3vectors.types.list_vector_buckets_max_results.ListVectorBucketsMaxResults"
    ] = None,
    next_token: Optional[
        "capo_s3vectors.types.list_vector_buckets_next_token.ListVectorBucketsNextToken"
    ] = None,
    prefix: Optional[
        "capo_s3vectors.types.list_vector_buckets_prefix.ListVectorBucketsPrefix"
    ] = None,
) -> "capo_s3vectors.types.list_vector_buckets_output.ListVectorBucketsOutput":
    """<p>Returns a list of all the vector buckets that are owned by the authenticated sender of the request.</p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3vectors:ListVectorBuckets</code> permission to use this operation. </p> </dd> </dl>

    Args:
        max_results: <p>The maximum number of vector buckets to be returned in the response. </p>
        next_token: <p>The previous pagination token. </p>
        prefix: <p>Limits the response to vector buckets that begin with the specified prefix.</p>

    Raises:
        capo_s3vectors.errors.access_denied_exception.AccessDeniedException: <p>Access denied.</p>
        capo_s3vectors.errors.internal_server_exception.InternalServerException: <p>The request failed due to an internal server error.</p>
        capo_s3vectors.errors.request_timeout_exception.RequestTimeoutException: <p>The request timed out. Retry your request.</p>
        capo_s3vectors.errors.too_many_requests_exception.TooManyRequestsException: <p>The request was denied due to request throttling.</p>
        capo_s3vectors.errors.validation_exception.ValidationException: <p>The requested action isn't valid.</p>
        capo_s3vectors.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.</p>
        capo_s3vectors.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_s3vectors.types.list_vector_buckets_input.ListVectorBucketsInput]",
    ) -> OperationResponse[
        "capo_s3vectors.types.list_vector_buckets_output.ListVectorBucketsOutput"
    ]:
        import capo_s3vectors._operations.s3_vectors.list_vector_buckets

        output, http_response = (
            capo_s3vectors._operations.s3_vectors.list_vector_buckets.list_vector_buckets(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListVectorBuckets")
    )
    input_: capo_s3vectors.types.list_vector_buckets_input.ListVectorBucketsInput = {}
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if prefix is not None:
        input_["prefix"] = prefix

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output