aws_sdk_opensearchserverless/client/
batch_get_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 [`BatchGetCollection`](crate::operation::batch_get_collection::builders::BatchGetCollectionFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`ids(impl Into<String>)`](crate::operation::batch_get_collection::builders::BatchGetCollectionFluentBuilder::ids) / [`set_ids(Option<Vec::<String>>)`](crate::operation::batch_get_collection::builders::BatchGetCollectionFluentBuilder::set_ids):<br>required: **false**<br><p>A list of collection IDs. You can't provide names and IDs in the same request. The ID is part of the collection endpoint. You can also retrieve it using the <a href="https://docs.aws.amazon.com/opensearch-service/latest/ServerlessAPIReference/API_ListCollections.html">ListCollections</a> API.</p><br>
7    ///   - [`names(impl Into<String>)`](crate::operation::batch_get_collection::builders::BatchGetCollectionFluentBuilder::names) / [`set_names(Option<Vec::<String>>)`](crate::operation::batch_get_collection::builders::BatchGetCollectionFluentBuilder::set_names):<br>required: **false**<br><p>A list of collection names. You can't provide names and IDs in the same request.</p><br>
8    /// - On success, responds with [`BatchGetCollectionOutput`](crate::operation::batch_get_collection::BatchGetCollectionOutput) with field(s):
9    ///   - [`collection_details(Option<Vec::<CollectionDetail>>)`](crate::operation::batch_get_collection::BatchGetCollectionOutput::collection_details): <p>Details about each collection.</p>
10    ///   - [`collection_error_details(Option<Vec::<CollectionErrorDetail>>)`](crate::operation::batch_get_collection::BatchGetCollectionOutput::collection_error_details): <p>Error information for the request.</p>
11    /// - On failure, responds with [`SdkError<BatchGetCollectionError>`](crate::operation::batch_get_collection::BatchGetCollectionError)
12    pub fn batch_get_collection(&self) -> crate::operation::batch_get_collection::builders::BatchGetCollectionFluentBuilder {
13        crate::operation::batch_get_collection::builders::BatchGetCollectionFluentBuilder::new(self.handle.clone())
14    }
15}