aws_sdk_ec2/operation/describe_host_reservations/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::describe_host_reservations::_describe_host_reservations_output::DescribeHostReservationsOutputBuilder;
3
4pub use crate::operation::describe_host_reservations::_describe_host_reservations_input::DescribeHostReservationsInputBuilder;
5
6impl crate::operation::describe_host_reservations::builders::DescribeHostReservationsInputBuilder {
7 /// Sends a request with this input using the given client.
8 pub async fn send_with(
9 self,
10 client: &crate::Client,
11 ) -> ::std::result::Result<
12 crate::operation::describe_host_reservations::DescribeHostReservationsOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::describe_host_reservations::DescribeHostReservationsError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.describe_host_reservations();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `DescribeHostReservations`.
24///
25/// <p>Describes reservations that are associated with Dedicated Hosts in your account.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct DescribeHostReservationsFluentBuilder {
28 handle: ::std::sync::Arc<crate::client::Handle>,
29 inner: crate::operation::describe_host_reservations::builders::DescribeHostReservationsInputBuilder,
30 config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33 crate::client::customize::internal::CustomizableSend<
34 crate::operation::describe_host_reservations::DescribeHostReservationsOutput,
35 crate::operation::describe_host_reservations::DescribeHostReservationsError,
36 > for DescribeHostReservationsFluentBuilder
37{
38 fn send(
39 self,
40 config_override: crate::config::Builder,
41 ) -> crate::client::customize::internal::BoxFuture<
42 crate::client::customize::internal::SendResult<
43 crate::operation::describe_host_reservations::DescribeHostReservationsOutput,
44 crate::operation::describe_host_reservations::DescribeHostReservationsError,
45 >,
46 > {
47 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48 }
49}
50impl DescribeHostReservationsFluentBuilder {
51 /// Creates a new `DescribeHostReservationsFluentBuilder`.
52 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
53 Self {
54 handle,
55 inner: ::std::default::Default::default(),
56 config_override: ::std::option::Option::None,
57 }
58 }
59 /// Access the DescribeHostReservations as a reference.
60 pub fn as_input(&self) -> &crate::operation::describe_host_reservations::builders::DescribeHostReservationsInputBuilder {
61 &self.inner
62 }
63 /// Sends the request and returns the response.
64 ///
65 /// If an error occurs, an `SdkError` will be returned with additional details that
66 /// can be matched against.
67 ///
68 /// By default, any retryable failures will be retried twice. Retry behavior
69 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
70 /// set when configuring the client.
71 pub async fn send(
72 self,
73 ) -> ::std::result::Result<
74 crate::operation::describe_host_reservations::DescribeHostReservationsOutput,
75 ::aws_smithy_runtime_api::client::result::SdkError<
76 crate::operation::describe_host_reservations::DescribeHostReservationsError,
77 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
78 >,
79 > {
80 let input = self
81 .inner
82 .build()
83 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
84 let runtime_plugins = crate::operation::describe_host_reservations::DescribeHostReservations::operation_runtime_plugins(
85 self.handle.runtime_plugins.clone(),
86 &self.handle.conf,
87 self.config_override,
88 );
89 crate::operation::describe_host_reservations::DescribeHostReservations::orchestrate(&runtime_plugins, input).await
90 }
91
92 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
93 pub fn customize(
94 self,
95 ) -> crate::client::customize::CustomizableOperation<
96 crate::operation::describe_host_reservations::DescribeHostReservationsOutput,
97 crate::operation::describe_host_reservations::DescribeHostReservationsError,
98 Self,
99 > {
100 crate::client::customize::CustomizableOperation::new(self)
101 }
102 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
103 self.set_config_override(::std::option::Option::Some(config_override.into()));
104 self
105 }
106
107 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
108 self.config_override = config_override;
109 self
110 }
111 /// Create a paginator for this request
112 ///
113 /// Paginators are used by calling [`send().await`](crate::operation::describe_host_reservations::paginator::DescribeHostReservationsPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
114 pub fn into_paginator(self) -> crate::operation::describe_host_reservations::paginator::DescribeHostReservationsPaginator {
115 crate::operation::describe_host_reservations::paginator::DescribeHostReservationsPaginator::new(self.handle, self.inner)
116 }
117 ///
118 /// Appends an item to `Filter`.
119 ///
120 /// To override the contents of this collection use [`set_filter`](Self::set_filter).
121 ///
122 /// <p>The filters.</p>
123 /// <ul>
124 /// <li>
125 /// <p><code>instance-family</code> - The instance family (for example, <code>m4</code>).</p></li>
126 /// <li>
127 /// <p><code>payment-option</code> - The payment option (<code>NoUpfront</code> | <code>PartialUpfront</code> | <code>AllUpfront</code>).</p></li>
128 /// <li>
129 /// <p><code>state</code> - The state of the reservation (<code>payment-pending</code> | <code>payment-failed</code> | <code>active</code> | <code>retired</code>).</p></li>
130 /// <li>
131 /// <p><code>tag:<key></key></code> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter value.</p></li>
132 /// <li>
133 /// <p><code>tag-key</code> - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.</p></li>
134 /// </ul>
135 pub fn filter(mut self, input: crate::types::Filter) -> Self {
136 self.inner = self.inner.filter(input);
137 self
138 }
139 /// <p>The filters.</p>
140 /// <ul>
141 /// <li>
142 /// <p><code>instance-family</code> - The instance family (for example, <code>m4</code>).</p></li>
143 /// <li>
144 /// <p><code>payment-option</code> - The payment option (<code>NoUpfront</code> | <code>PartialUpfront</code> | <code>AllUpfront</code>).</p></li>
145 /// <li>
146 /// <p><code>state</code> - The state of the reservation (<code>payment-pending</code> | <code>payment-failed</code> | <code>active</code> | <code>retired</code>).</p></li>
147 /// <li>
148 /// <p><code>tag:<key></key></code> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter value.</p></li>
149 /// <li>
150 /// <p><code>tag-key</code> - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.</p></li>
151 /// </ul>
152 pub fn set_filter(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Filter>>) -> Self {
153 self.inner = self.inner.set_filter(input);
154 self
155 }
156 /// <p>The filters.</p>
157 /// <ul>
158 /// <li>
159 /// <p><code>instance-family</code> - The instance family (for example, <code>m4</code>).</p></li>
160 /// <li>
161 /// <p><code>payment-option</code> - The payment option (<code>NoUpfront</code> | <code>PartialUpfront</code> | <code>AllUpfront</code>).</p></li>
162 /// <li>
163 /// <p><code>state</code> - The state of the reservation (<code>payment-pending</code> | <code>payment-failed</code> | <code>active</code> | <code>retired</code>).</p></li>
164 /// <li>
165 /// <p><code>tag:<key></key></code> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter value.</p></li>
166 /// <li>
167 /// <p><code>tag-key</code> - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.</p></li>
168 /// </ul>
169 pub fn get_filter(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Filter>> {
170 self.inner.get_filter()
171 }
172 ///
173 /// Appends an item to `HostReservationIdSet`.
174 ///
175 /// To override the contents of this collection use [`set_host_reservation_id_set`](Self::set_host_reservation_id_set).
176 ///
177 /// <p>The host reservation IDs.</p>
178 pub fn host_reservation_id_set(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
179 self.inner = self.inner.host_reservation_id_set(input.into());
180 self
181 }
182 /// <p>The host reservation IDs.</p>
183 pub fn set_host_reservation_id_set(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
184 self.inner = self.inner.set_host_reservation_id_set(input);
185 self
186 }
187 /// <p>The host reservation IDs.</p>
188 pub fn get_host_reservation_id_set(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
189 self.inner.get_host_reservation_id_set()
190 }
191 /// <p>The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned <code>nextToken</code> value. This value can be between 5 and 500. If <code>maxResults</code> is given a larger value than 500, you receive an error.</p>
192 pub fn max_results(mut self, input: i32) -> Self {
193 self.inner = self.inner.max_results(input);
194 self
195 }
196 /// <p>The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned <code>nextToken</code> value. This value can be between 5 and 500. If <code>maxResults</code> is given a larger value than 500, you receive an error.</p>
197 pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
198 self.inner = self.inner.set_max_results(input);
199 self
200 }
201 /// <p>The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned <code>nextToken</code> value. This value can be between 5 and 500. If <code>maxResults</code> is given a larger value than 500, you receive an error.</p>
202 pub fn get_max_results(&self) -> &::std::option::Option<i32> {
203 self.inner.get_max_results()
204 }
205 /// <p>The token to use to retrieve the next page of results.</p>
206 pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
207 self.inner = self.inner.next_token(input.into());
208 self
209 }
210 /// <p>The token to use to retrieve the next page of results.</p>
211 pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
212 self.inner = self.inner.set_next_token(input);
213 self
214 }
215 /// <p>The token to use to retrieve the next page of results.</p>
216 pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
217 self.inner.get_next_token()
218 }
219}