delete_vector_bucket `async` ¶

delete_vector_bucket(
    *,
    config_overrides: Optional[AsyncS3VectorsClientConfig] = None,
    vector_bucket_name: Optional[VectorBucketName] = None,
    vector_bucket_arn: Optional[VectorBucketArn] = None,
) -> DeleteVectorBucketOutput

Deletes a vector bucket. All vector indexes in the vector bucket must be deleted before the vector bucket can be deleted. To perform this operation, you must use either the vector bucket name or the vector bucket Amazon Resource Name (ARN).

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

Parameters:

vector_bucket_name (Optional[VectorBucketName], default: None ) –

The name of the vector bucket to delete.
vector_bucket_arn (Optional[VectorBucketArn], default: None ) –

The ARN of the vector bucket to delete.

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.
ConflictException –

The request failed because a vector bucket name or a vector index name already exists. Vector bucket names must be unique within your Amazon Web Services account for each Amazon Web Services Region. Vector index names must be unique within your vector bucket. Choose a different vector bucket name or vector index name, and try again.
NotFoundException –

The request was rejected because the specified resource can't be found.
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/async_s3_vectors.py

async def delete_vector_bucket(
    self,
    *,
    config_overrides: Optional[AsyncS3VectorsClientConfig] = None,
    vector_bucket_name: Optional[
        "capo_s3vectors.types.vector_bucket_name.VectorBucketName"
    ] = None,
    vector_bucket_arn: Optional[
        "capo_s3vectors.types.vector_bucket_arn.VectorBucketArn"
    ] = None,
) -> "capo_s3vectors.types.delete_vector_bucket_output.DeleteVectorBucketOutput":
    """<p>Deletes a vector bucket. All vector indexes in the vector bucket must be deleted before the vector bucket can be deleted. To perform this operation, you must use either the vector bucket name or the vector bucket Amazon Resource Name (ARN). </p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3vectors:DeleteVectorBucket</code> permission to use this operation. </p> </dd> </dl>

    Args:
        vector_bucket_name: <p>The name of the vector bucket to delete.</p>
        vector_bucket_arn: <p>The ARN of the vector bucket to delete.</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.conflict_exception.ConflictException: <p>The request failed because a vector bucket name or a vector index name already exists. Vector bucket names must be unique within your Amazon Web Services account for each Amazon Web Services Region. Vector index names must be unique within your vector bucket. Choose a different vector bucket name or vector index name, and try again.</p>
        capo_s3vectors.errors.not_found_exception.NotFoundException: <p>The request was rejected because the specified resource can't be found.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_s3vectors.types.delete_vector_bucket_input.DeleteVectorBucketInput]",
    ) -> AsyncOperationResponse[
        "capo_s3vectors.types.delete_vector_bucket_output.DeleteVectorBucketOutput"
    ]:
        import capo_s3vectors._operations.s3_vectors.delete_vector_bucket

        (
            output,
            http_response,
        ) = await capo_s3vectors._operations.s3_vectors.delete_vector_bucket.async_delete_vector_bucket(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteVectorBucket")
    )
    input_: capo_s3vectors.types.delete_vector_bucket_input.DeleteVectorBucketInput = {}
    if vector_bucket_name is not None:
        input_["vector_bucket_name"] = vector_bucket_name
    if vector_bucket_arn is not None:
        input_["vector_bucket_arn"] = vector_bucket_arn

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

delete_vector_bucket async ¶

delete_vector_bucket `async` ¶