aws_sdk_memorydb/client/describe_reserved_nodes_offerings.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 [`DescribeReservedNodesOfferings`](crate::operation::describe_reserved_nodes_offerings::builders::DescribeReservedNodesOfferingsFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_reserved_nodes_offerings::builders::DescribeReservedNodesOfferingsFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`reserved_nodes_offering_id(impl Into<String>)`](crate::operation::describe_reserved_nodes_offerings::builders::DescribeReservedNodesOfferingsFluentBuilder::reserved_nodes_offering_id) / [`set_reserved_nodes_offering_id(Option<String>)`](crate::operation::describe_reserved_nodes_offerings::builders::DescribeReservedNodesOfferingsFluentBuilder::set_reserved_nodes_offering_id):<br>required: **false**<br><p>The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.</p><br>
8 /// - [`node_type(impl Into<String>)`](crate::operation::describe_reserved_nodes_offerings::builders::DescribeReservedNodesOfferingsFluentBuilder::node_type) / [`set_node_type(Option<String>)`](crate::operation::describe_reserved_nodes_offerings::builders::DescribeReservedNodesOfferingsFluentBuilder::set_node_type):<br>required: **false**<br><p>The node type for the reserved nodes. For more information, see <a href="https://docs.aws.amazon.com/memorydb/latest/devguide/nodes.reserved.html#reserved-nodes-supported">Supported node types</a>.</p><br>
9 /// - [`duration(impl Into<String>)`](crate::operation::describe_reserved_nodes_offerings::builders::DescribeReservedNodesOfferingsFluentBuilder::duration) / [`set_duration(Option<String>)`](crate::operation::describe_reserved_nodes_offerings::builders::DescribeReservedNodesOfferingsFluentBuilder::set_duration):<br>required: **false**<br><p>Duration filter value, specified in years or seconds. Use this parameter to show only reservations for a given duration.</p><br>
10 /// - [`offering_type(impl Into<String>)`](crate::operation::describe_reserved_nodes_offerings::builders::DescribeReservedNodesOfferingsFluentBuilder::offering_type) / [`set_offering_type(Option<String>)`](crate::operation::describe_reserved_nodes_offerings::builders::DescribeReservedNodesOfferingsFluentBuilder::set_offering_type):<br>required: **false**<br><p>The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type. Valid values: "All Upfront"|"Partial Upfront"| "No Upfront"</p><br>
11 /// - [`max_results(i32)`](crate::operation::describe_reserved_nodes_offerings::builders::DescribeReservedNodesOfferingsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_reserved_nodes_offerings::builders::DescribeReservedNodesOfferingsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.</p><br>
12 /// - [`next_token(impl Into<String>)`](crate::operation::describe_reserved_nodes_offerings::builders::DescribeReservedNodesOfferingsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_reserved_nodes_offerings::builders::DescribeReservedNodesOfferingsFluentBuilder::set_next_token):<br>required: **false**<br><p>An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.</p><br>
13 /// - On success, responds with [`DescribeReservedNodesOfferingsOutput`](crate::operation::describe_reserved_nodes_offerings::DescribeReservedNodesOfferingsOutput) with field(s):
14 /// - [`next_token(Option<String>)`](crate::operation::describe_reserved_nodes_offerings::DescribeReservedNodesOfferingsOutput::next_token): <p>An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.</p>
15 /// - [`reserved_nodes_offerings(Option<Vec::<ReservedNodesOffering>>)`](crate::operation::describe_reserved_nodes_offerings::DescribeReservedNodesOfferingsOutput::reserved_nodes_offerings): <p>Lists available reserved node offerings.</p>
16 /// - On failure, responds with [`SdkError<DescribeReservedNodesOfferingsError>`](crate::operation::describe_reserved_nodes_offerings::DescribeReservedNodesOfferingsError)
17 pub fn describe_reserved_nodes_offerings(
18 &self,
19 ) -> crate::operation::describe_reserved_nodes_offerings::builders::DescribeReservedNodesOfferingsFluentBuilder {
20 crate::operation::describe_reserved_nodes_offerings::builders::DescribeReservedNodesOfferingsFluentBuilder::new(self.handle.clone())
21 }
22}