aws_sdk_opensearch/client/

describe_reserved_instance_offerings.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeReservedInstanceOfferings`](crate::operation::describe_reserved_instance_offerings::builders::DescribeReservedInstanceOfferingsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_reserved_instance_offerings::builders::DescribeReservedInstanceOfferingsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`reserved_instance_offering_id(impl Into<String>)`](crate::operation::describe_reserved_instance_offerings::builders::DescribeReservedInstanceOfferingsFluentBuilder::reserved_instance_offering_id) / [`set_reserved_instance_offering_id(Option<String>)`](crate::operation::describe_reserved_instance_offerings::builders::DescribeReservedInstanceOfferingsFluentBuilder::set_reserved_instance_offering_id):<br>required: **false**<br><p>The Reserved Instance identifier filter value. Use this parameter to show only the available instance types that match the specified reservation identifier.</p><br>
    ///   - [`max_results(i32)`](crate::operation::describe_reserved_instance_offerings::builders::DescribeReservedInstanceOfferingsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_reserved_instance_offerings::builders::DescribeReservedInstanceOfferingsFluentBuilder::set_max_results):<br>required: **false**<br><p>An optional parameter that specifies the maximum number of results to return. You can use <code>nextToken</code> to get the next page of results.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_reserved_instance_offerings::builders::DescribeReservedInstanceOfferingsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_reserved_instance_offerings::builders::DescribeReservedInstanceOfferingsFluentBuilder::set_next_token):<br>required: **false**<br><p>If your initial <code>DescribeReservedInstanceOfferings</code> operation returns a <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent <code>DescribeReservedInstanceOfferings</code> operations, which returns results in the next page.</p><br>
    /// - On success, responds with [`DescribeReservedInstanceOfferingsOutput`](crate::operation::describe_reserved_instance_offerings::DescribeReservedInstanceOfferingsOutput) with field(s):
    ///   - [`next_token(Option<String>)`](crate::operation::describe_reserved_instance_offerings::DescribeReservedInstanceOfferingsOutput::next_token): <p>When <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.</p>
    ///   - [`reserved_instance_offerings(Option<Vec::<ReservedInstanceOffering>>)`](crate::operation::describe_reserved_instance_offerings::DescribeReservedInstanceOfferingsOutput::reserved_instance_offerings): <p>List of Reserved Instance offerings.</p>
    /// - On failure, responds with [`SdkError<DescribeReservedInstanceOfferingsError>`](crate::operation::describe_reserved_instance_offerings::DescribeReservedInstanceOfferingsError)
    pub fn describe_reserved_instance_offerings(
        &self,
    ) -> crate::operation::describe_reserved_instance_offerings::builders::DescribeReservedInstanceOfferingsFluentBuilder {
        crate::operation::describe_reserved_instance_offerings::builders::DescribeReservedInstanceOfferingsFluentBuilder::new(self.handle.clone())
    }
}