aws_sdk_ec2/client/describe_capacity_block_extension_history.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 [`DescribeCapacityBlockExtensionHistory`](crate::operation::describe_capacity_block_extension_history::builders::DescribeCapacityBlockExtensionHistoryFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_capacity_block_extension_history::builders::DescribeCapacityBlockExtensionHistoryFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`capacity_reservation_ids(impl Into<String>)`](crate::operation::describe_capacity_block_extension_history::builders::DescribeCapacityBlockExtensionHistoryFluentBuilder::capacity_reservation_ids) / [`set_capacity_reservation_ids(Option<Vec::<String>>)`](crate::operation::describe_capacity_block_extension_history::builders::DescribeCapacityBlockExtensionHistoryFluentBuilder::set_capacity_reservation_ids):<br>required: **false**<br><p>The IDs of Capacity Block reservations that you want to display the history for.</p><br>
8 /// - [`next_token(impl Into<String>)`](crate::operation::describe_capacity_block_extension_history::builders::DescribeCapacityBlockExtensionHistoryFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_capacity_block_extension_history::builders::DescribeCapacityBlockExtensionHistoryFluentBuilder::set_next_token):<br>required: **false**<br><p>The token to use to retrieve the next page of results.</p><br>
9 /// - [`max_results(i32)`](crate::operation::describe_capacity_block_extension_history::builders::DescribeCapacityBlockExtensionHistoryFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_capacity_block_extension_history::builders::DescribeCapacityBlockExtensionHistoryFluentBuilder::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>
10 /// - [`filters(Filter)`](crate::operation::describe_capacity_block_extension_history::builders::DescribeCapacityBlockExtensionHistoryFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::describe_capacity_block_extension_history::builders::DescribeCapacityBlockExtensionHistoryFluentBuilder::set_filters):<br>required: **false**<br><p>One or more filters</p> <ul> <li> <p><code>availability-zone</code> - The Availability Zone of the extension.</p></li> <li> <p><code>availability-zone-id</code> - The Availability Zone ID of the extension.</p></li> <li> <p><code>capacity-block-extension-offering-id</code> - The ID of the extension offering.</p></li> <li> <p><code>capacity-block-extension-status</code> - The status of the extension (<code>payment-pending</code> | <code>payment-failed</code> | <code>payment-succeeded</code>).</p></li> <li> <p><code>capacity-reservation-id</code> - The reservation ID of the extension.</p></li> <li> <p><code>instance-type</code> - The instance type of the extension.</p></li> </ul><br>
11 /// - [`dry_run(bool)`](crate::operation::describe_capacity_block_extension_history::builders::DescribeCapacityBlockExtensionHistoryFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::describe_capacity_block_extension_history::builders::DescribeCapacityBlockExtensionHistoryFluentBuilder::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>
12 /// - On success, responds with [`DescribeCapacityBlockExtensionHistoryOutput`](crate::operation::describe_capacity_block_extension_history::DescribeCapacityBlockExtensionHistoryOutput) with field(s):
13 /// - [`capacity_block_extensions(Option<Vec::<CapacityBlockExtension>>)`](crate::operation::describe_capacity_block_extension_history::DescribeCapacityBlockExtensionHistoryOutput::capacity_block_extensions): <p>Describes one or more of your Capacity Block extensions. The results describe only the Capacity Block extensions in the Amazon Web Services Region that you're currently using.</p>
14 /// - [`next_token(Option<String>)`](crate::operation::describe_capacity_block_extension_history::DescribeCapacityBlockExtensionHistoryOutput::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<DescribeCapacityBlockExtensionHistoryError>`](crate::operation::describe_capacity_block_extension_history::DescribeCapacityBlockExtensionHistoryError)
16 pub fn describe_capacity_block_extension_history(
17 &self,
18 ) -> crate::operation::describe_capacity_block_extension_history::builders::DescribeCapacityBlockExtensionHistoryFluentBuilder {
19 crate::operation::describe_capacity_block_extension_history::builders::DescribeCapacityBlockExtensionHistoryFluentBuilder::new(
20 self.handle.clone(),
21 )
22 }
23}