aws_sdk_opensearchserverless/client/
get_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 [`GetIndex`](crate::operation::get_index::builders::GetIndexFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`id(impl Into<String>)`](crate::operation::get_index::builders::GetIndexFluentBuilder::id) / [`set_id(Option<String>)`](crate::operation::get_index::builders::GetIndexFluentBuilder::set_id):<br>required: **true**<br><p>The unique identifier of the collection containing the index.</p><br>
7    ///   - [`index_name(impl Into<String>)`](crate::operation::get_index::builders::GetIndexFluentBuilder::index_name) / [`set_index_name(Option<String>)`](crate::operation::get_index::builders::GetIndexFluentBuilder::set_index_name):<br>required: **true**<br><p>The name of the index to retrieve information about.</p><br>
8    /// - On success, responds with [`GetIndexOutput`](crate::operation::get_index::GetIndexOutput) with field(s):
9    ///   - [`index_schema(Option<Document>)`](crate::operation::get_index::GetIndexOutput::index_schema): <p>The JSON schema definition for the index, including field mappings and settings.</p>
10    /// - On failure, responds with [`SdkError<GetIndexError>`](crate::operation::get_index::GetIndexError)
11    pub fn get_index(&self) -> crate::operation::get_index::builders::GetIndexFluentBuilder {
12        crate::operation::get_index::builders::GetIndexFluentBuilder::new(self.handle.clone())
13    }
14}