aws_sdk_opensearchserverless/client/
create_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 [`CreateCollection`](crate::operation::create_collection::builders::CreateCollectionFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`name(impl Into<String>)`](crate::operation::create_collection::builders::CreateCollectionFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::create_collection::builders::CreateCollectionFluentBuilder::set_name):<br>required: **true**<br><p>Name of the collection.</p><br>
7    ///   - [`r#type(CollectionType)`](crate::operation::create_collection::builders::CreateCollectionFluentBuilder::type) / [`set_type(Option<CollectionType>)`](crate::operation::create_collection::builders::CreateCollectionFluentBuilder::set_type):<br>required: **false**<br><p>The type of collection.</p><br>
8    ///   - [`description(impl Into<String>)`](crate::operation::create_collection::builders::CreateCollectionFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::create_collection::builders::CreateCollectionFluentBuilder::set_description):<br>required: **false**<br><p>Description of the collection.</p><br>
9    ///   - [`tags(Tag)`](crate::operation::create_collection::builders::CreateCollectionFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::create_collection::builders::CreateCollectionFluentBuilder::set_tags):<br>required: **false**<br><p>An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.</p><br>
10    ///   - [`standby_replicas(StandbyReplicas)`](crate::operation::create_collection::builders::CreateCollectionFluentBuilder::standby_replicas) / [`set_standby_replicas(Option<StandbyReplicas>)`](crate::operation::create_collection::builders::CreateCollectionFluentBuilder::set_standby_replicas):<br>required: **false**<br><p>Indicates whether standby replicas should be used for a collection.</p><br>
11    ///   - [`vector_options(VectorOptions)`](crate::operation::create_collection::builders::CreateCollectionFluentBuilder::vector_options) / [`set_vector_options(Option<VectorOptions>)`](crate::operation::create_collection::builders::CreateCollectionFluentBuilder::set_vector_options):<br>required: **false**<br><p>Configuration options for vector search capabilities in the collection.</p><br>
12    ///   - [`collection_group_name(impl Into<String>)`](crate::operation::create_collection::builders::CreateCollectionFluentBuilder::collection_group_name) / [`set_collection_group_name(Option<String>)`](crate::operation::create_collection::builders::CreateCollectionFluentBuilder::set_collection_group_name):<br>required: **false**<br><p>The name of the collection group to associate with the collection.</p><br>
13    ///   - [`encryption_config(EncryptionConfig)`](crate::operation::create_collection::builders::CreateCollectionFluentBuilder::encryption_config) / [`set_encryption_config(Option<EncryptionConfig>)`](crate::operation::create_collection::builders::CreateCollectionFluentBuilder::set_encryption_config):<br>required: **false**<br><p>Encryption settings for the collection.</p><br>
14    ///   - [`deletion_protection(DeletionProtection)`](crate::operation::create_collection::builders::CreateCollectionFluentBuilder::deletion_protection) / [`set_deletion_protection(Option<DeletionProtection>)`](crate::operation::create_collection::builders::CreateCollectionFluentBuilder::set_deletion_protection):<br>required: **false**<br><p>Indicates whether to enable deletion protection for the collection. When set to <code>ENABLED</code>, the collection cannot be deleted.</p><br>
15    ///   - [`client_token(impl Into<String>)`](crate::operation::create_collection::builders::CreateCollectionFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::create_collection::builders::CreateCollectionFluentBuilder::set_client_token):<br>required: **false**<br><p>Unique, case-sensitive identifier to ensure idempotency of the request.</p><br>
16    /// - On success, responds with [`CreateCollectionOutput`](crate::operation::create_collection::CreateCollectionOutput) with field(s):
17    ///   - [`create_collection_detail(Option<CreateCollectionDetail>)`](crate::operation::create_collection::CreateCollectionOutput::create_collection_detail): <p>Details about the collection.</p>
18    /// - On failure, responds with [`SdkError<CreateCollectionError>`](crate::operation::create_collection::CreateCollectionError)
19    pub fn create_collection(&self) -> crate::operation::create_collection::builders::CreateCollectionFluentBuilder {
20        crate::operation::create_collection::builders::CreateCollectionFluentBuilder::new(self.handle.clone())
21    }
22}
aws_sdk_opensearchserverless/client/create_collection.rs

aws_sdk_opensearchserverless/client/
create_collection.rs
