aws_sdk_ec2/client/
describe_capacity_block_extension_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 [`DescribeCapacityBlockExtensionOfferings`](crate::operation::describe_capacity_block_extension_offerings::builders::DescribeCapacityBlockExtensionOfferingsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_capacity_block_extension_offerings::builders::DescribeCapacityBlockExtensionOfferingsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`dry_run(bool)`](crate::operation::describe_capacity_block_extension_offerings::builders::DescribeCapacityBlockExtensionOfferingsFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::describe_capacity_block_extension_offerings::builders::DescribeCapacityBlockExtensionOfferingsFluentBuilder::set_dry_run):<br>required: **false**<br><p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p><br>
8    ///   - [`capacity_block_extension_duration_hours(i32)`](crate::operation::describe_capacity_block_extension_offerings::builders::DescribeCapacityBlockExtensionOfferingsFluentBuilder::capacity_block_extension_duration_hours) / [`set_capacity_block_extension_duration_hours(Option<i32>)`](crate::operation::describe_capacity_block_extension_offerings::builders::DescribeCapacityBlockExtensionOfferingsFluentBuilder::set_capacity_block_extension_duration_hours):<br>required: **true**<br><p>The duration of the Capacity Block extension offering in hours.</p><br>
9    ///   - [`capacity_reservation_id(impl Into<String>)`](crate::operation::describe_capacity_block_extension_offerings::builders::DescribeCapacityBlockExtensionOfferingsFluentBuilder::capacity_reservation_id) / [`set_capacity_reservation_id(Option<String>)`](crate::operation::describe_capacity_block_extension_offerings::builders::DescribeCapacityBlockExtensionOfferingsFluentBuilder::set_capacity_reservation_id):<br>required: **true**<br><p>The ID of the Capacity reservation to be extended.</p><br>
10    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_capacity_block_extension_offerings::builders::DescribeCapacityBlockExtensionOfferingsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_capacity_block_extension_offerings::builders::DescribeCapacityBlockExtensionOfferingsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token to use to retrieve the next page of results.</p><br>
11    ///   - [`max_results(i32)`](crate::operation::describe_capacity_block_extension_offerings::builders::DescribeCapacityBlockExtensionOfferingsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_capacity_block_extension_offerings::builders::DescribeCapacityBlockExtensionOfferingsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination">Pagination</a>.</p><br>
12    /// - On success, responds with [`DescribeCapacityBlockExtensionOfferingsOutput`](crate::operation::describe_capacity_block_extension_offerings::DescribeCapacityBlockExtensionOfferingsOutput) with field(s):
13    ///   - [`capacity_block_extension_offerings(Option<Vec::<CapacityBlockExtensionOffering>>)`](crate::operation::describe_capacity_block_extension_offerings::DescribeCapacityBlockExtensionOfferingsOutput::capacity_block_extension_offerings): <p>The recommended Capacity Block extension offerings for the dates specified.</p>
14    ///   - [`next_token(Option<String>)`](crate::operation::describe_capacity_block_extension_offerings::DescribeCapacityBlockExtensionOfferingsOutput::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>
15    /// - On failure, responds with [`SdkError<DescribeCapacityBlockExtensionOfferingsError>`](crate::operation::describe_capacity_block_extension_offerings::DescribeCapacityBlockExtensionOfferingsError)
16    pub fn describe_capacity_block_extension_offerings(
17        &self,
18    ) -> crate::operation::describe_capacity_block_extension_offerings::builders::DescribeCapacityBlockExtensionOfferingsFluentBuilder {
19        crate::operation::describe_capacity_block_extension_offerings::builders::DescribeCapacityBlockExtensionOfferingsFluentBuilder::new(
20            self.handle.clone(),
21        )
22    }
23}