aws_sdk_elasticsearch/client/
describe_reserved_elasticsearch_instances.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 [`DescribeReservedElasticsearchInstances`](crate::operation::describe_reserved_elasticsearch_instances::builders::DescribeReservedElasticsearchInstancesFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_reserved_elasticsearch_instances::builders::DescribeReservedElasticsearchInstancesFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`reserved_elasticsearch_instance_id(impl Into<String>)`](crate::operation::describe_reserved_elasticsearch_instances::builders::DescribeReservedElasticsearchInstancesFluentBuilder::reserved_elasticsearch_instance_id) / [`set_reserved_elasticsearch_instance_id(Option<String>)`](crate::operation::describe_reserved_elasticsearch_instances::builders::DescribeReservedElasticsearchInstancesFluentBuilder::set_reserved_elasticsearch_instance_id):<br>required: **false**<br><p>The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved Elasticsearch instance ID.</p><br>
8    ///   - [`max_results(i32)`](crate::operation::describe_reserved_elasticsearch_instances::builders::DescribeReservedElasticsearchInstancesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_reserved_elasticsearch_instances::builders::DescribeReservedElasticsearchInstancesFluentBuilder::set_max_results):<br>required: **false**<br><p>Set this value to limit the number of results returned. If not specified, defaults to 100.</p><br>
9    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_reserved_elasticsearch_instances::builders::DescribeReservedElasticsearchInstancesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_reserved_elasticsearch_instances::builders::DescribeReservedElasticsearchInstancesFluentBuilder::set_next_token):<br>required: **false**<br><p>NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination.</p><br>
10    /// - On success, responds with [`DescribeReservedElasticsearchInstancesOutput`](crate::operation::describe_reserved_elasticsearch_instances::DescribeReservedElasticsearchInstancesOutput) with field(s):
11    ///   - [`next_token(Option<String>)`](crate::operation::describe_reserved_elasticsearch_instances::DescribeReservedElasticsearchInstancesOutput::next_token): <p>Provides an identifier to allow retrieval of paginated results.</p>
12    ///   - [`reserved_elasticsearch_instances(Option<Vec::<ReservedElasticsearchInstance>>)`](crate::operation::describe_reserved_elasticsearch_instances::DescribeReservedElasticsearchInstancesOutput::reserved_elasticsearch_instances): <p>List of reserved Elasticsearch instances.</p>
13    /// - On failure, responds with [`SdkError<DescribeReservedElasticsearchInstancesError>`](crate::operation::describe_reserved_elasticsearch_instances::DescribeReservedElasticsearchInstancesError)
14    pub fn describe_reserved_elasticsearch_instances(
15        &self,
16    ) -> crate::operation::describe_reserved_elasticsearch_instances::builders::DescribeReservedElasticsearchInstancesFluentBuilder {
17        crate::operation::describe_reserved_elasticsearch_instances::builders::DescribeReservedElasticsearchInstancesFluentBuilder::new(
18            self.handle.clone(),
19        )
20    }
21}