aws-sdk-ec2 1.218.0

AWS SDK for Amazon Elastic Compute Cloud
Documentation
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::describe_capacity_block_offerings::_describe_capacity_block_offerings_input::DescribeCapacityBlockOfferingsInputBuilder;

pub use crate::operation::describe_capacity_block_offerings::_describe_capacity_block_offerings_output::DescribeCapacityBlockOfferingsOutputBuilder;

impl crate::operation::describe_capacity_block_offerings::builders::DescribeCapacityBlockOfferingsInputBuilder {
    /// Sends a request with this input using the given client.
    pub async fn send_with(
        self,
        client: &crate::Client,
    ) -> ::std::result::Result<
        crate::operation::describe_capacity_block_offerings::DescribeCapacityBlockOfferingsOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::describe_capacity_block_offerings::DescribeCapacityBlockOfferingsError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let mut fluent_builder = client.describe_capacity_block_offerings();
        fluent_builder.inner = self;
        fluent_builder.send().await
    }
}
/// Fluent builder constructing a request to `DescribeCapacityBlockOfferings`.
///
/// <p>Describes Capacity Block offerings available for purchase in the Amazon Web Services Region that you're currently using. With Capacity Blocks, you can purchase a specific GPU instance type or EC2 UltraServer for a period of time.</p>
/// <p>To search for an available Capacity Block offering, you specify a reservation duration and instance count.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct DescribeCapacityBlockOfferingsFluentBuilder {
    handle: ::std::sync::Arc<crate::client::Handle>,
    inner: crate::operation::describe_capacity_block_offerings::builders::DescribeCapacityBlockOfferingsInputBuilder,
    config_override: ::std::option::Option<crate::config::Builder>,
}
impl
    crate::client::customize::internal::CustomizableSend<
        crate::operation::describe_capacity_block_offerings::DescribeCapacityBlockOfferingsOutput,
        crate::operation::describe_capacity_block_offerings::DescribeCapacityBlockOfferingsError,
    > for DescribeCapacityBlockOfferingsFluentBuilder
{
    fn send(
        self,
        config_override: crate::config::Builder,
    ) -> crate::client::customize::internal::BoxFuture<
        crate::client::customize::internal::SendResult<
            crate::operation::describe_capacity_block_offerings::DescribeCapacityBlockOfferingsOutput,
            crate::operation::describe_capacity_block_offerings::DescribeCapacityBlockOfferingsError,
        >,
    > {
        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
    }
}
impl DescribeCapacityBlockOfferingsFluentBuilder {
    /// Creates a new `DescribeCapacityBlockOfferingsFluentBuilder`.
    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
        Self {
            handle,
            inner: ::std::default::Default::default(),
            config_override: ::std::option::Option::None,
        }
    }
    /// Access the DescribeCapacityBlockOfferings as a reference.
    pub fn as_input(&self) -> &crate::operation::describe_capacity_block_offerings::builders::DescribeCapacityBlockOfferingsInputBuilder {
        &self.inner
    }
    /// Sends the request and returns the response.
    ///
    /// If an error occurs, an `SdkError` will be returned with additional details that
    /// can be matched against.
    ///
    /// By default, any retryable failures will be retried twice. Retry behavior
    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
    /// set when configuring the client.
    pub async fn send(
        self,
    ) -> ::std::result::Result<
        crate::operation::describe_capacity_block_offerings::DescribeCapacityBlockOfferingsOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::describe_capacity_block_offerings::DescribeCapacityBlockOfferingsError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let input = self
            .inner
            .build()
            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
        let runtime_plugins = crate::operation::describe_capacity_block_offerings::DescribeCapacityBlockOfferings::operation_runtime_plugins(
            self.handle.runtime_plugins.clone(),
            &self.handle.conf,
            self.config_override,
        );
        crate::operation::describe_capacity_block_offerings::DescribeCapacityBlockOfferings::orchestrate(&runtime_plugins, input).await
    }

    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
    pub fn customize(
        self,
    ) -> crate::client::customize::CustomizableOperation<
        crate::operation::describe_capacity_block_offerings::DescribeCapacityBlockOfferingsOutput,
        crate::operation::describe_capacity_block_offerings::DescribeCapacityBlockOfferingsError,
        Self,
    > {
        crate::client::customize::CustomizableOperation::new(self)
    }
    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
        self.set_config_override(::std::option::Option::Some(config_override.into()));
        self
    }

    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
        self.config_override = config_override;
        self
    }
    /// Create a paginator for this request
    ///
    /// Paginators are used by calling [`send().await`](crate::operation::describe_capacity_block_offerings::paginator::DescribeCapacityBlockOfferingsPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
    pub fn into_paginator(self) -> crate::operation::describe_capacity_block_offerings::paginator::DescribeCapacityBlockOfferingsPaginator {
        crate::operation::describe_capacity_block_offerings::paginator::DescribeCapacityBlockOfferingsPaginator::new(self.handle, self.inner)
    }
    /// <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>
    pub fn dry_run(mut self, input: bool) -> Self {
        self.inner = self.inner.dry_run(input);
        self
    }
    /// <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>
    pub fn set_dry_run(mut self, input: ::std::option::Option<bool>) -> Self {
        self.inner = self.inner.set_dry_run(input);
        self
    }
    /// <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>
    pub fn get_dry_run(&self) -> &::std::option::Option<bool> {
        self.inner.get_dry_run()
    }
    /// <p>The type of instance for which the Capacity Block offering reserves capacity.</p>
    pub fn instance_type(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.instance_type(input.into());
        self
    }
    /// <p>The type of instance for which the Capacity Block offering reserves capacity.</p>
    pub fn set_instance_type(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_instance_type(input);
        self
    }
    /// <p>The type of instance for which the Capacity Block offering reserves capacity.</p>
    pub fn get_instance_type(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_instance_type()
    }
    /// <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>
    pub fn instance_count(mut self, input: i32) -> Self {
        self.inner = self.inner.instance_count(input);
        self
    }
    /// <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>
    pub fn set_instance_count(mut self, input: ::std::option::Option<i32>) -> Self {
        self.inner = self.inner.set_instance_count(input);
        self
    }
    /// <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>
    pub fn get_instance_count(&self) -> &::std::option::Option<i32> {
        self.inner.get_instance_count()
    }
    /// <p>The earliest start date for the Capacity Block offering.</p>
    pub fn start_date_range(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.inner = self.inner.start_date_range(input);
        self
    }
    /// <p>The earliest start date for the Capacity Block offering.</p>
    pub fn set_start_date_range(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.inner = self.inner.set_start_date_range(input);
        self
    }
    /// <p>The earliest start date for the Capacity Block offering.</p>
    pub fn get_start_date_range(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        self.inner.get_start_date_range()
    }
    /// <p>The latest end date for the Capacity Block offering.</p>
    pub fn end_date_range(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.inner = self.inner.end_date_range(input);
        self
    }
    /// <p>The latest end date for the Capacity Block offering.</p>
    pub fn set_end_date_range(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.inner = self.inner.set_end_date_range(input);
        self
    }
    /// <p>The latest end date for the Capacity Block offering.</p>
    pub fn get_end_date_range(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        self.inner.get_end_date_range()
    }
    /// <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>
    pub fn capacity_duration_hours(mut self, input: i32) -> Self {
        self.inner = self.inner.capacity_duration_hours(input);
        self
    }
    /// <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>
    pub fn set_capacity_duration_hours(mut self, input: ::std::option::Option<i32>) -> Self {
        self.inner = self.inner.set_capacity_duration_hours(input);
        self
    }
    /// <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>
    pub fn get_capacity_duration_hours(&self) -> &::std::option::Option<i32> {
        self.inner.get_capacity_duration_hours()
    }
    /// <p>The token to use to retrieve the next page of results.</p>
    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.next_token(input.into());
        self
    }
    /// <p>The token to use to retrieve the next page of results.</p>
    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_next_token(input);
        self
    }
    /// <p>The token to use to retrieve the next page of results.</p>
    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_next_token()
    }
    /// <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>
    pub fn max_results(mut self, input: i32) -> Self {
        self.inner = self.inner.max_results(input);
        self
    }
    /// <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>
    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
        self.inner = self.inner.set_max_results(input);
        self
    }
    /// <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>
    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
        self.inner.get_max_results()
    }
    /// <p>The EC2 UltraServer type of the Capacity Block offerings.</p>
    pub fn ultraserver_type(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.ultraserver_type(input.into());
        self
    }
    /// <p>The EC2 UltraServer type of the Capacity Block offerings.</p>
    pub fn set_ultraserver_type(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_ultraserver_type(input);
        self
    }
    /// <p>The EC2 UltraServer type of the Capacity Block offerings.</p>
    pub fn get_ultraserver_type(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_ultraserver_type()
    }
    /// <p>The number of EC2 UltraServers in the offerings.</p>
    pub fn ultraserver_count(mut self, input: i32) -> Self {
        self.inner = self.inner.ultraserver_count(input);
        self
    }
    /// <p>The number of EC2 UltraServers in the offerings.</p>
    pub fn set_ultraserver_count(mut self, input: ::std::option::Option<i32>) -> Self {
        self.inner = self.inner.set_ultraserver_count(input);
        self
    }
    /// <p>The number of EC2 UltraServers in the offerings.</p>
    pub fn get_ultraserver_count(&self) -> &::std::option::Option<i32> {
        self.inner.get_ultraserver_count()
    }
    /// <p>Include all Availability Zones and Local Zones, regardless of your opt-in status. If you do not use this parameter, the results include available offerings from all Availability Zones in the Amazon Web Services Region and Local Zones you are opted into.</p>
    pub fn all_availability_zones(mut self, input: bool) -> Self {
        self.inner = self.inner.all_availability_zones(input);
        self
    }
    /// <p>Include all Availability Zones and Local Zones, regardless of your opt-in status. If you do not use this parameter, the results include available offerings from all Availability Zones in the Amazon Web Services Region and Local Zones you are opted into.</p>
    pub fn set_all_availability_zones(mut self, input: ::std::option::Option<bool>) -> Self {
        self.inner = self.inner.set_all_availability_zones(input);
        self
    }
    /// <p>Include all Availability Zones and Local Zones, regardless of your opt-in status. If you do not use this parameter, the results include available offerings from all Availability Zones in the Amazon Web Services Region and Local Zones you are opted into.</p>
    pub fn get_all_availability_zones(&self) -> &::std::option::Option<bool> {
        self.inner.get_all_availability_zones()
    }
}