1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeHostReservationOfferings`](crate::operation::describe_host_reservation_offerings::builders::DescribeHostReservationOfferingsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_host_reservation_offerings::builders::DescribeHostReservationOfferingsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`filter(Filter)`](crate::operation::describe_host_reservation_offerings::builders::DescribeHostReservationOfferingsFluentBuilder::filter) / [`set_filter(Option<Vec::<Filter>>)`](crate::operation::describe_host_reservation_offerings::builders::DescribeHostReservationOfferingsFluentBuilder::set_filter):<br>required: **false**<br><p>The filters.</p> <ul>  <li>   <p><code>instance-family</code> - The instance family of the offering (for example, <code>m4</code>).</p></li>  <li>   <p><code>payment-option</code> - The payment option (<code>NoUpfront</code> | <code>PartialUpfront</code> | <code>AllUpfront</code>).</p></li> </ul><br>
    ///   - [`max_duration(i32)`](crate::operation::describe_host_reservation_offerings::builders::DescribeHostReservationOfferingsFluentBuilder::max_duration) / [`set_max_duration(Option<i32>)`](crate::operation::describe_host_reservation_offerings::builders::DescribeHostReservationOfferingsFluentBuilder::set_max_duration):<br>required: **false**<br><p>This is the maximum duration of the reservation to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 94608000 for three years.</p><br>
    ///   - [`max_results(i32)`](crate::operation::describe_host_reservation_offerings::builders::DescribeHostReservationOfferingsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_host_reservation_offerings::builders::DescribeHostReservationOfferingsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned <code>nextToken</code> value. This value can be between 5 and 500. If <code>maxResults</code> is given a larger value than 500, you receive an error.</p><br>
    ///   - [`min_duration(i32)`](crate::operation::describe_host_reservation_offerings::builders::DescribeHostReservationOfferingsFluentBuilder::min_duration) / [`set_min_duration(Option<i32>)`](crate::operation::describe_host_reservation_offerings::builders::DescribeHostReservationOfferingsFluentBuilder::set_min_duration):<br>required: **false**<br><p>This is the minimum duration of the reservation you'd like to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 31536000 for one year.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_host_reservation_offerings::builders::DescribeHostReservationOfferingsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_host_reservation_offerings::builders::DescribeHostReservationOfferingsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token to use to retrieve the next page of results.</p><br>
    ///   - [`offering_id(impl Into<String>)`](crate::operation::describe_host_reservation_offerings::builders::DescribeHostReservationOfferingsFluentBuilder::offering_id) / [`set_offering_id(Option<String>)`](crate::operation::describe_host_reservation_offerings::builders::DescribeHostReservationOfferingsFluentBuilder::set_offering_id):<br>required: **false**<br><p>The ID of the reservation offering.</p><br>
    /// - On success, responds with [`DescribeHostReservationOfferingsOutput`](crate::operation::describe_host_reservation_offerings::DescribeHostReservationOfferingsOutput) with field(s):
    ///   - [`next_token(Option<String>)`](crate::operation::describe_host_reservation_offerings::DescribeHostReservationOfferingsOutput::next_token): <p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>
    ///   - [`offering_set(Option<Vec::<HostOffering>>)`](crate::operation::describe_host_reservation_offerings::DescribeHostReservationOfferingsOutput::offering_set): <p>Information about the offerings.</p>
    /// - On failure, responds with [`SdkError<DescribeHostReservationOfferingsError>`](crate::operation::describe_host_reservation_offerings::DescribeHostReservationOfferingsError)
    pub fn describe_host_reservation_offerings(
        &self,
    ) -> crate::operation::describe_host_reservation_offerings::builders::DescribeHostReservationOfferingsFluentBuilder {
        crate::operation::describe_host_reservation_offerings::builders::DescribeHostReservationOfferingsFluentBuilder::new(self.handle.clone())
    }
}