// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::describe_capacity_reservation_topology::_describe_capacity_reservation_topology_input::DescribeCapacityReservationTopologyInputBuilder;
pub use crate::operation::describe_capacity_reservation_topology::_describe_capacity_reservation_topology_output::DescribeCapacityReservationTopologyOutputBuilder;
impl crate::operation::describe_capacity_reservation_topology::builders::DescribeCapacityReservationTopologyInputBuilder {
/// 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_reservation_topology::DescribeCapacityReservationTopologyOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::describe_capacity_reservation_topology::DescribeCapacityReservationTopologyError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let mut fluent_builder = client.describe_capacity_reservation_topology();
fluent_builder.inner = self;
fluent_builder.send().await
}
}
/// Fluent builder constructing a request to `DescribeCapacityReservationTopology`.
///
/// <p>Describes a tree-based hierarchy that represents the physical host placement of your pending or active Capacity Reservations within an Availability Zone or Local Zone. You can use this information to determine the relative proximity of your capacity within the Amazon Web Services network before it is launched and use this information to allocate capacity together to support your tightly coupled workloads.</p>
/// <p>Capacity Reservation topology is supported for specific instance types only. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-topology-prerequisites.html">Prerequisites for Amazon EC2 instance topology</a> in the <i>Amazon EC2 User Guide</i>.</p><note>
/// <p>The Amazon EC2 API follows an eventual consistency model due to the distributed nature of the system supporting it. As a result, when you call the DescribeCapacityReservationTopology API command immediately after launching instances, the response might return a <code>null</code> value for <code>capacityBlockId</code> because the data might not have fully propagated across all subsystems. For more information, see <a href="https://docs.aws.amazon.com/ec2/latest/devguide/eventual-consistency.html">Eventual consistency in the Amazon EC2 API</a> in the <i>Amazon EC2 Developer Guide</i>.</p>
/// </note>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-topology.html">Amazon EC2 topology</a> in the <i>Amazon EC2 User Guide</i>.</p>
/// <p></p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct DescribeCapacityReservationTopologyFluentBuilder {
handle: ::std::sync::Arc<crate::client::Handle>,
inner: crate::operation::describe_capacity_reservation_topology::builders::DescribeCapacityReservationTopologyInputBuilder,
config_override: ::std::option::Option<crate::config::Builder>,
}
impl
crate::client::customize::internal::CustomizableSend<
crate::operation::describe_capacity_reservation_topology::DescribeCapacityReservationTopologyOutput,
crate::operation::describe_capacity_reservation_topology::DescribeCapacityReservationTopologyError,
> for DescribeCapacityReservationTopologyFluentBuilder
{
fn send(
self,
config_override: crate::config::Builder,
) -> crate::client::customize::internal::BoxFuture<
crate::client::customize::internal::SendResult<
crate::operation::describe_capacity_reservation_topology::DescribeCapacityReservationTopologyOutput,
crate::operation::describe_capacity_reservation_topology::DescribeCapacityReservationTopologyError,
>,
> {
::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
}
}
impl DescribeCapacityReservationTopologyFluentBuilder {
/// Creates a new `DescribeCapacityReservationTopologyFluentBuilder`.
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 DescribeCapacityReservationTopology as a reference.
pub fn as_input(&self) -> &crate::operation::describe_capacity_reservation_topology::builders::DescribeCapacityReservationTopologyInputBuilder {
&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_reservation_topology::DescribeCapacityReservationTopologyOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::describe_capacity_reservation_topology::DescribeCapacityReservationTopologyError,
::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_reservation_topology::DescribeCapacityReservationTopology::operation_runtime_plugins(
self.handle.runtime_plugins.clone(),
&self.handle.conf,
self.config_override,
);
crate::operation::describe_capacity_reservation_topology::DescribeCapacityReservationTopology::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_reservation_topology::DescribeCapacityReservationTopologyOutput,
crate::operation::describe_capacity_reservation_topology::DescribeCapacityReservationTopologyError,
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
}
/// <p>Checks whether you have the required permissions for the operation, 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 operation, 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 operation, 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 token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.</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 returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.</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 returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.</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>
/// <p>You can't specify this parameter and the Capacity Reservation IDs parameter in the same request.</p>
/// <p>Default: <code>10</code></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>
/// <p>You can't specify this parameter and the Capacity Reservation IDs parameter in the same request.</p>
/// <p>Default: <code>10</code></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>
/// <p>You can't specify this parameter and the Capacity Reservation IDs parameter in the same request.</p>
/// <p>Default: <code>10</code></p>
pub fn get_max_results(&self) -> &::std::option::Option<i32> {
self.inner.get_max_results()
}
///
/// Appends an item to `CapacityReservationIds`.
///
/// To override the contents of this collection use [`set_capacity_reservation_ids`](Self::set_capacity_reservation_ids).
///
/// <p>The Capacity Reservation IDs.</p>
/// <p>Default: Describes all your Capacity Reservations.</p>
/// <p>Constraints: Maximum 100 explicitly specified Capacity Reservation IDs.</p>
pub fn capacity_reservation_ids(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.capacity_reservation_ids(input.into());
self
}
/// <p>The Capacity Reservation IDs.</p>
/// <p>Default: Describes all your Capacity Reservations.</p>
/// <p>Constraints: Maximum 100 explicitly specified Capacity Reservation IDs.</p>
pub fn set_capacity_reservation_ids(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.inner = self.inner.set_capacity_reservation_ids(input);
self
}
/// <p>The Capacity Reservation IDs.</p>
/// <p>Default: Describes all your Capacity Reservations.</p>
/// <p>Constraints: Maximum 100 explicitly specified Capacity Reservation IDs.</p>
pub fn get_capacity_reservation_ids(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
self.inner.get_capacity_reservation_ids()
}
///
/// Appends an item to `Filters`.
///
/// To override the contents of this collection use [`set_filters`](Self::set_filters).
///
/// <p>The filters.</p>
/// <ul>
/// <li>
/// <p><code>availability-zone</code> - The name of the Availability Zone (for example, <code>us-west-2a</code>) or Local Zone (for example, <code>us-west-2-lax-1b</code>) that the Capacity Reservation is in.</p></li>
/// <li>
/// <p><code>instance-type</code> - The instance type (for example, <code>p4d.24xlarge</code>) or instance family (for example, <code>p4d*</code>). You can use the <code>*</code> wildcard to match zero or more characters, or the <code>?</code> wildcard to match zero or one character.</p></li>
/// </ul>
pub fn filters(mut self, input: crate::types::Filter) -> Self {
self.inner = self.inner.filters(input);
self
}
/// <p>The filters.</p>
/// <ul>
/// <li>
/// <p><code>availability-zone</code> - The name of the Availability Zone (for example, <code>us-west-2a</code>) or Local Zone (for example, <code>us-west-2-lax-1b</code>) that the Capacity Reservation is in.</p></li>
/// <li>
/// <p><code>instance-type</code> - The instance type (for example, <code>p4d.24xlarge</code>) or instance family (for example, <code>p4d*</code>). You can use the <code>*</code> wildcard to match zero or more characters, or the <code>?</code> wildcard to match zero or one character.</p></li>
/// </ul>
pub fn set_filters(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Filter>>) -> Self {
self.inner = self.inner.set_filters(input);
self
}
/// <p>The filters.</p>
/// <ul>
/// <li>
/// <p><code>availability-zone</code> - The name of the Availability Zone (for example, <code>us-west-2a</code>) or Local Zone (for example, <code>us-west-2-lax-1b</code>) that the Capacity Reservation is in.</p></li>
/// <li>
/// <p><code>instance-type</code> - The instance type (for example, <code>p4d.24xlarge</code>) or instance family (for example, <code>p4d*</code>). You can use the <code>*</code> wildcard to match zero or more characters, or the <code>?</code> wildcard to match zero or one character.</p></li>
/// </ul>
pub fn get_filters(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Filter>> {
self.inner.get_filters()
}
}