delete_index `async` ¶

delete_index(
    *,
    config_overrides: Optional[AsyncS3VectorsClientConfig] = None,
    vector_bucket_name: Optional[VectorBucketName] = None,
    index_name: Optional[IndexName] = None,
    index_arn: Optional[IndexArn] = None,
) -> DeleteIndexOutput

Deletes a vector index. To specify the vector index, you can either use both the vector bucket name and vector index name, or use the vector index Amazon Resource Name (ARN).

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

Parameters:

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

The name of the vector bucket that contains the vector index.
index_name (Optional[IndexName], default: None ) –

The name of the vector index to delete.
index_arn (Optional[IndexArn], default: None ) –

The ARN of the vector index 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.
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_index(
    self,
    *,
    config_overrides: Optional[AsyncS3VectorsClientConfig] = None,
    vector_bucket_name: Optional[
        "capo_s3vectors.types.vector_bucket_name.VectorBucketName"
    ] = None,
    index_name: Optional["capo_s3vectors.types.index_name.IndexName"] = None,
    index_arn: Optional["capo_s3vectors.types.index_arn.IndexArn"] = None,
) -> "capo_s3vectors.types.delete_index_output.DeleteIndexOutput":
    """<p>Deletes a vector index. To specify the vector index, you can either use both the vector bucket name and vector index name, or use the vector index Amazon Resource Name (ARN). </p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3vectors:DeleteIndex</code> permission to use this operation. </p> </dd> </dl>

    Args:
        vector_bucket_name: <p>The name of the vector bucket that contains the vector index. </p>
        index_name: <p>The name of the vector index to delete. </p>
        index_arn: <p>The ARN of the vector index 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.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_index_input.DeleteIndexInput]",
    ) -> AsyncOperationResponse[
        "capo_s3vectors.types.delete_index_output.DeleteIndexOutput"
    ]:
        import capo_s3vectors._operations.s3_vectors.delete_index

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteIndex")
    )
    input_: capo_s3vectors.types.delete_index_input.DeleteIndexInput = {}
    if vector_bucket_name is not None:
        input_["vector_bucket_name"] = vector_bucket_name
    if index_name is not None:
        input_["index_name"] = index_name
    if index_arn is not None:
        input_["index_arn"] = index_arn

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

delete_index async ¶

delete_index `async` ¶