aws_sdk_opensearchserverless/client/
create_index.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 [`CreateIndex`](crate::operation::create_index::builders::CreateIndexFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`id(impl Into<String>)`](crate::operation::create_index::builders::CreateIndexFluentBuilder::id) / [`set_id(Option<String>)`](crate::operation::create_index::builders::CreateIndexFluentBuilder::set_id):<br>required: **true**<br><p>The unique identifier of the collection in which to create the index.</p><br>
7    ///   - [`index_name(impl Into<String>)`](crate::operation::create_index::builders::CreateIndexFluentBuilder::index_name) / [`set_index_name(Option<String>)`](crate::operation::create_index::builders::CreateIndexFluentBuilder::set_index_name):<br>required: **true**<br><p>The name of the index to create. Index names must be lowercase and can't begin with underscores (_) or hyphens (-).</p><br>
8    ///   - [`index_schema(Document)`](crate::operation::create_index::builders::CreateIndexFluentBuilder::index_schema) / [`set_index_schema(Option<Document>)`](crate::operation::create_index::builders::CreateIndexFluentBuilder::set_index_schema):<br>required: **false**<br><p>The JSON schema definition for the index, including field mappings and settings.</p><br>
9    /// - On success, responds with [`CreateIndexOutput`](crate::operation::create_index::CreateIndexOutput)
10    /// - On failure, responds with [`SdkError<CreateIndexError>`](crate::operation::create_index::CreateIndexError)
11    pub fn create_index(&self) -> crate::operation::create_index::builders::CreateIndexFluentBuilder {
12        crate::operation::create_index::builders::CreateIndexFluentBuilder::new(self.handle.clone())
13    }
14}