aws_sdk_opensearchserverless/client/
delete_collection.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`DeleteCollection`](crate::operation::delete_collection::builders::DeleteCollectionFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`id(impl Into<String>)`](crate::operation::delete_collection::builders::DeleteCollectionFluentBuilder::id) / [`set_id(Option<String>)`](crate::operation::delete_collection::builders::DeleteCollectionFluentBuilder::set_id):<br>required: **true**<br><p>The unique identifier of the collection. For example, <code>1iu5usc406kd</code>. The ID is part of the collection endpoint. You can also retrieve it using the <a href="https://docs.aws.amazon.com/opensearch-service/latest/ServerlessAPIReference/API_ListCollections.html">ListCollections</a> API.</p><br>
7    ///   - [`client_token(impl Into<String>)`](crate::operation::delete_collection::builders::DeleteCollectionFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::delete_collection::builders::DeleteCollectionFluentBuilder::set_client_token):<br>required: **false**<br><p>A unique, case-sensitive identifier to ensure idempotency of the request.</p><br>
8    /// - On success, responds with [`DeleteCollectionOutput`](crate::operation::delete_collection::DeleteCollectionOutput) with field(s):
9    ///   - [`delete_collection_detail(Option<DeleteCollectionDetail>)`](crate::operation::delete_collection::DeleteCollectionOutput::delete_collection_detail): <p>Details of the deleted collection.</p>
10    /// - On failure, responds with [`SdkError<DeleteCollectionError>`](crate::operation::delete_collection::DeleteCollectionError)
11    pub fn delete_collection(&self) -> crate::operation::delete_collection::builders::DeleteCollectionFluentBuilder {
12        crate::operation::delete_collection::builders::DeleteCollectionFluentBuilder::new(self.handle.clone())
13    }
14}