aws_sdk_ec2/client/

describe_capacity_block_offerings.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeCapacityBlockOfferings`](crate::operation::describe_capacity_block_offerings::builders::DescribeCapacityBlockOfferingsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_capacity_block_offerings::builders::DescribeCapacityBlockOfferingsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`dry_run(bool)`](crate::operation::describe_capacity_block_offerings::builders::DescribeCapacityBlockOfferingsFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::describe_capacity_block_offerings::builders::DescribeCapacityBlockOfferingsFluentBuilder::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>
    ///   - [`instance_type(impl Into<String>)`](crate::operation::describe_capacity_block_offerings::builders::DescribeCapacityBlockOfferingsFluentBuilder::instance_type) / [`set_instance_type(Option<String>)`](crate::operation::describe_capacity_block_offerings::builders::DescribeCapacityBlockOfferingsFluentBuilder::set_instance_type):<br>required: **false**<br><p>The type of instance for which the Capacity Block offering reserves capacity.</p><br>
    ///   - [`instance_count(i32)`](crate::operation::describe_capacity_block_offerings::builders::DescribeCapacityBlockOfferingsFluentBuilder::instance_count) / [`set_instance_count(Option<i32>)`](crate::operation::describe_capacity_block_offerings::builders::DescribeCapacityBlockOfferingsFluentBuilder::set_instance_count):<br>required: **false**<br><p>The number of instances for which to reserve capacity. Each Capacity Block can have up to 64 instances, and you can have up to 256 instances across Capacity Blocks.</p><br>
    ///   - [`start_date_range(DateTime)`](crate::operation::describe_capacity_block_offerings::builders::DescribeCapacityBlockOfferingsFluentBuilder::start_date_range) / [`set_start_date_range(Option<DateTime>)`](crate::operation::describe_capacity_block_offerings::builders::DescribeCapacityBlockOfferingsFluentBuilder::set_start_date_range):<br>required: **false**<br><p>The earliest start date for the Capacity Block offering.</p><br>
    ///   - [`end_date_range(DateTime)`](crate::operation::describe_capacity_block_offerings::builders::DescribeCapacityBlockOfferingsFluentBuilder::end_date_range) / [`set_end_date_range(Option<DateTime>)`](crate::operation::describe_capacity_block_offerings::builders::DescribeCapacityBlockOfferingsFluentBuilder::set_end_date_range):<br>required: **false**<br><p>The latest end date for the Capacity Block offering.</p><br>
    ///   - [`capacity_duration_hours(i32)`](crate::operation::describe_capacity_block_offerings::builders::DescribeCapacityBlockOfferingsFluentBuilder::capacity_duration_hours) / [`set_capacity_duration_hours(Option<i32>)`](crate::operation::describe_capacity_block_offerings::builders::DescribeCapacityBlockOfferingsFluentBuilder::set_capacity_duration_hours):<br>required: **true**<br><p>The reservation duration for the Capacity Block, in hours. You must specify the duration in 1-day increments up 14 days, and in 7-day increments up to 182 days.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_capacity_block_offerings::builders::DescribeCapacityBlockOfferingsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_capacity_block_offerings::builders::DescribeCapacityBlockOfferingsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token to use to retrieve the next page of results.</p><br>
    ///   - [`max_results(i32)`](crate::operation::describe_capacity_block_offerings::builders::DescribeCapacityBlockOfferingsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_capacity_block_offerings::builders::DescribeCapacityBlockOfferingsFluentBuilder::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>
    ///   - [`ultraserver_type(impl Into<String>)`](crate::operation::describe_capacity_block_offerings::builders::DescribeCapacityBlockOfferingsFluentBuilder::ultraserver_type) / [`set_ultraserver_type(Option<String>)`](crate::operation::describe_capacity_block_offerings::builders::DescribeCapacityBlockOfferingsFluentBuilder::set_ultraserver_type):<br>required: **false**<br><p>The EC2 UltraServer type of the Capacity Block offerings.</p><br>
    ///   - [`ultraserver_count(i32)`](crate::operation::describe_capacity_block_offerings::builders::DescribeCapacityBlockOfferingsFluentBuilder::ultraserver_count) / [`set_ultraserver_count(Option<i32>)`](crate::operation::describe_capacity_block_offerings::builders::DescribeCapacityBlockOfferingsFluentBuilder::set_ultraserver_count):<br>required: **false**<br><p>The number of EC2 UltraServers in the offerings.</p><br>
    /// - On success, responds with [`DescribeCapacityBlockOfferingsOutput`](crate::operation::describe_capacity_block_offerings::DescribeCapacityBlockOfferingsOutput) with field(s):
    ///   - [`capacity_block_offerings(Option<Vec::<CapacityBlockOffering>>)`](crate::operation::describe_capacity_block_offerings::DescribeCapacityBlockOfferingsOutput::capacity_block_offerings): <p>The recommended Capacity Block offering for the dates specified.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::describe_capacity_block_offerings::DescribeCapacityBlockOfferingsOutput::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>
    /// - On failure, responds with [`SdkError<DescribeCapacityBlockOfferingsError>`](crate::operation::describe_capacity_block_offerings::DescribeCapacityBlockOfferingsError)
    pub fn describe_capacity_block_offerings(
        &self,
    ) -> crate::operation::describe_capacity_block_offerings::builders::DescribeCapacityBlockOfferingsFluentBuilder {
        crate::operation::describe_capacity_block_offerings::builders::DescribeCapacityBlockOfferingsFluentBuilder::new(self.handle.clone())
    }
}