Skip to main content

aws_sdk_opensearchserverless/client/
update_collection_group.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 [`UpdateCollectionGroup`](crate::operation::update_collection_group::builders::UpdateCollectionGroupFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`id(impl Into<String>)`](crate::operation::update_collection_group::builders::UpdateCollectionGroupFluentBuilder::id) / [`set_id(Option<String>)`](crate::operation::update_collection_group::builders::UpdateCollectionGroupFluentBuilder::set_id):<br>required: **true**<br><p>The unique identifier of the collection group to update.</p><br>
7    ///   - [`description(impl Into<String>)`](crate::operation::update_collection_group::builders::UpdateCollectionGroupFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::update_collection_group::builders::UpdateCollectionGroupFluentBuilder::set_description):<br>required: **false**<br><p>A new description for the collection group.</p><br>
8    ///   - [`capacity_limits(CollectionGroupCapacityLimits)`](crate::operation::update_collection_group::builders::UpdateCollectionGroupFluentBuilder::capacity_limits) / [`set_capacity_limits(Option<CollectionGroupCapacityLimits>)`](crate::operation::update_collection_group::builders::UpdateCollectionGroupFluentBuilder::set_capacity_limits):<br>required: **false**<br><p>Updated capacity limits for the collection group, in OpenSearch Compute Units (OCUs).</p><br>
9    ///   - [`client_token(impl Into<String>)`](crate::operation::update_collection_group::builders::UpdateCollectionGroupFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::update_collection_group::builders::UpdateCollectionGroupFluentBuilder::set_client_token):<br>required: **false**<br><p>Unique, case-sensitive identifier to ensure idempotency of the request.</p><br>
10    /// - On success, responds with [`UpdateCollectionGroupOutput`](crate::operation::update_collection_group::UpdateCollectionGroupOutput) with field(s):
11    ///   - [`update_collection_group_detail(Option<UpdateCollectionGroupDetail>)`](crate::operation::update_collection_group::UpdateCollectionGroupOutput::update_collection_group_detail): <p>Details about the updated collection group.</p>
12    /// - On failure, responds with [`SdkError<UpdateCollectionGroupError>`](crate::operation::update_collection_group::UpdateCollectionGroupError)
13    pub fn update_collection_group(&self) -> crate::operation::update_collection_group::builders::UpdateCollectionGroupFluentBuilder {
14        crate::operation::update_collection_group::builders::UpdateCollectionGroupFluentBuilder::new(self.handle.clone())
15    }
16}