aws_sdk_opensearchserverless/client/update_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 [`UpdateCollection`](crate::operation::update_collection::builders::UpdateCollectionFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`id(impl Into<String>)`](crate::operation::update_collection::builders::UpdateCollectionFluentBuilder::id) / [`set_id(Option<String>)`](crate::operation::update_collection::builders::UpdateCollectionFluentBuilder::set_id):<br>required: **true**<br><p>The unique identifier of the collection.</p><br>
7 /// - [`description(impl Into<String>)`](crate::operation::update_collection::builders::UpdateCollectionFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::update_collection::builders::UpdateCollectionFluentBuilder::set_description):<br>required: **false**<br><p>A description of the collection.</p><br>
8 /// - [`vector_options(VectorOptions)`](crate::operation::update_collection::builders::UpdateCollectionFluentBuilder::vector_options) / [`set_vector_options(Option<VectorOptions>)`](crate::operation::update_collection::builders::UpdateCollectionFluentBuilder::set_vector_options):<br>required: **false**<br><p>Configuration options for vector search capabilities in the collection.</p><br>
9 /// - [`deletion_protection(DeletionProtection)`](crate::operation::update_collection::builders::UpdateCollectionFluentBuilder::deletion_protection) / [`set_deletion_protection(Option<DeletionProtection>)`](crate::operation::update_collection::builders::UpdateCollectionFluentBuilder::set_deletion_protection):<br>required: **false**<br><p>Indicates whether to enable or disable deletion protection for the collection. When set to <code>ENABLED</code>, the collection cannot be deleted.</p><br>
10 /// - [`client_token(impl Into<String>)`](crate::operation::update_collection::builders::UpdateCollectionFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::update_collection::builders::UpdateCollectionFluentBuilder::set_client_token):<br>required: **false**<br><p>Unique, case-sensitive identifier to ensure idempotency of the request.</p><br>
11 /// - On success, responds with [`UpdateCollectionOutput`](crate::operation::update_collection::UpdateCollectionOutput) with field(s):
12 /// - [`update_collection_detail(Option<UpdateCollectionDetail>)`](crate::operation::update_collection::UpdateCollectionOutput::update_collection_detail): <p>Details about the updated collection.</p>
13 /// - On failure, responds with [`SdkError<UpdateCollectionError>`](crate::operation::update_collection::UpdateCollectionError)
14 pub fn update_collection(&self) -> crate::operation::update_collection::builders::UpdateCollectionFluentBuilder {
15 crate::operation::update_collection::builders::UpdateCollectionFluentBuilder::new(self.handle.clone())
16 }
17}