1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::describe_capacity_reservations::_describe_capacity_reservations_input::DescribeCapacityReservationsInputBuilder;
pub use crate::operation::describe_capacity_reservations::_describe_capacity_reservations_output::DescribeCapacityReservationsOutputBuilder;
impl crate::operation::describe_capacity_reservations::builders::DescribeCapacityReservationsInputBuilder {
/// 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_reservations::DescribeCapacityReservationsOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::describe_capacity_reservations::DescribeCapacityReservationsError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let mut fluent_builder = client.describe_capacity_reservations();
fluent_builder.inner = self;
fluent_builder.send().await
}
}
/// Fluent builder constructing a request to `DescribeCapacityReservations`.
///
/// <p>Describes one or more of your Capacity Reservations. The results describe only the Capacity Reservations in the Amazon Web Services Region that you're currently using.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct DescribeCapacityReservationsFluentBuilder {
handle: ::std::sync::Arc<crate::client::Handle>,
inner: crate::operation::describe_capacity_reservations::builders::DescribeCapacityReservationsInputBuilder,
config_override: ::std::option::Option<crate::config::Builder>,
}
impl
crate::client::customize::internal::CustomizableSend<
crate::operation::describe_capacity_reservations::DescribeCapacityReservationsOutput,
crate::operation::describe_capacity_reservations::DescribeCapacityReservationsError,
> for DescribeCapacityReservationsFluentBuilder
{
fn send(
self,
config_override: crate::config::Builder,
) -> crate::client::customize::internal::BoxFuture<
crate::client::customize::internal::SendResult<
crate::operation::describe_capacity_reservations::DescribeCapacityReservationsOutput,
crate::operation::describe_capacity_reservations::DescribeCapacityReservationsError,
>,
> {
::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
}
}
impl DescribeCapacityReservationsFluentBuilder {
/// Creates a new `DescribeCapacityReservationsFluentBuilder`.
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 DescribeCapacityReservations as a reference.
pub fn as_input(&self) -> &crate::operation::describe_capacity_reservations::builders::DescribeCapacityReservationsInputBuilder {
&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_reservations::DescribeCapacityReservationsOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::describe_capacity_reservations::DescribeCapacityReservationsError,
::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_reservations::DescribeCapacityReservations::operation_runtime_plugins(
self.handle.runtime_plugins.clone(),
&self.handle.conf,
self.config_override,
);
crate::operation::describe_capacity_reservations::DescribeCapacityReservations::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_reservations::DescribeCapacityReservationsOutput,
crate::operation::describe_capacity_reservations::DescribeCapacityReservationsError,
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_reservations::paginator::DescribeCapacityReservationsPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
pub fn into_paginator(self) -> crate::operation::describe_capacity_reservations::paginator::DescribeCapacityReservationsPaginator {
crate::operation::describe_capacity_reservations::paginator::DescribeCapacityReservationsPaginator::new(self.handle, self.inner)
}
///
/// Appends an item to `CapacityReservationIds`.
///
/// To override the contents of this collection use [`set_capacity_reservation_ids`](Self::set_capacity_reservation_ids).
///
/// <p>The ID of the Capacity Reservation.</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 ID of the Capacity Reservation.</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 ID of the Capacity Reservation.</p>
pub fn get_capacity_reservation_ids(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
self.inner.get_capacity_reservation_ids()
}
/// <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()
}
///
/// Appends an item to `Filters`.
///
/// To override the contents of this collection use [`set_filters`](Self::set_filters).
///
/// <p>One or more filters.</p>
/// <ul>
/// <li>
/// <p><code>instance-type</code> - The type of instance for which the Capacity Reservation reserves capacity.</p></li>
/// <li>
/// <p><code>owner-id</code> - The ID of the Amazon Web Services account that owns the Capacity Reservation.</p></li>
/// <li>
/// <p><code>instance-platform</code> - The type of operating system for which the Capacity Reservation reserves capacity.</p></li>
/// <li>
/// <p><code>availability-zone</code> - The Availability Zone of the Capacity Reservation.</p></li>
/// <li>
/// <p><code>tenancy</code> - Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:</p>
/// <ul>
/// <li>
/// <p><code>default</code> - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.</p></li>
/// <li>
/// <p><code>dedicated</code> - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.</p></li>
/// </ul></li>
/// <li>
/// <p><code>outpost-arn</code> - The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created.</p></li>
/// <li>
/// <p><code>state</code> - The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:</p>
/// <ul>
/// <li>
/// <p><code>active</code>- The Capacity Reservation is active and the capacity is available for your use.</p></li>
/// <li>
/// <p><code>expired</code> - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.</p></li>
/// <li>
/// <p><code>cancelled</code> - The Capacity Reservation was cancelled. The reserved capacity is no longer available for your use.</p></li>
/// <li>
/// <p><code>pending</code> - The Capacity Reservation request was successful but the capacity provisioning is still pending.</p></li>
/// <li>
/// <p><code>failed</code> - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.</p></li>
/// </ul></li>
/// <li>
/// <p><code>start-date</code> - The date and time at which the Capacity Reservation was started.</p></li>
/// <li>
/// <p><code>end-date</code> - The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.</p></li>
/// <li>
/// <p><code>end-date-type</code> - Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:</p>
/// <ul>
/// <li>
/// <p><code>unlimited</code> - The Capacity Reservation remains active until you explicitly cancel it.</p></li>
/// <li>
/// <p><code>limited</code> - The Capacity Reservation expires automatically at a specified date and time.</p></li>
/// </ul></li>
/// <li>
/// <p><code>instance-match-criteria</code> - Indicates the type of instance launches that the Capacity Reservation accepts. The options include:</p>
/// <ul>
/// <li>
/// <p><code>open</code> - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying any additional parameters.</p></li>
/// <li>
/// <p><code>targeted</code> - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.</p></li>
/// </ul></li>
/// <li>
/// <p><code>placement-group-arn</code> - The ARN of the cluster placement group in which the Capacity Reservation was created.</p></li>
/// </ul>
pub fn filters(mut self, input: crate::types::Filter) -> Self {
self.inner = self.inner.filters(input);
self
}
/// <p>One or more filters.</p>
/// <ul>
/// <li>
/// <p><code>instance-type</code> - The type of instance for which the Capacity Reservation reserves capacity.</p></li>
/// <li>
/// <p><code>owner-id</code> - The ID of the Amazon Web Services account that owns the Capacity Reservation.</p></li>
/// <li>
/// <p><code>instance-platform</code> - The type of operating system for which the Capacity Reservation reserves capacity.</p></li>
/// <li>
/// <p><code>availability-zone</code> - The Availability Zone of the Capacity Reservation.</p></li>
/// <li>
/// <p><code>tenancy</code> - Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:</p>
/// <ul>
/// <li>
/// <p><code>default</code> - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.</p></li>
/// <li>
/// <p><code>dedicated</code> - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.</p></li>
/// </ul></li>
/// <li>
/// <p><code>outpost-arn</code> - The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created.</p></li>
/// <li>
/// <p><code>state</code> - The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:</p>
/// <ul>
/// <li>
/// <p><code>active</code>- The Capacity Reservation is active and the capacity is available for your use.</p></li>
/// <li>
/// <p><code>expired</code> - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.</p></li>
/// <li>
/// <p><code>cancelled</code> - The Capacity Reservation was cancelled. The reserved capacity is no longer available for your use.</p></li>
/// <li>
/// <p><code>pending</code> - The Capacity Reservation request was successful but the capacity provisioning is still pending.</p></li>
/// <li>
/// <p><code>failed</code> - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.</p></li>
/// </ul></li>
/// <li>
/// <p><code>start-date</code> - The date and time at which the Capacity Reservation was started.</p></li>
/// <li>
/// <p><code>end-date</code> - The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.</p></li>
/// <li>
/// <p><code>end-date-type</code> - Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:</p>
/// <ul>
/// <li>
/// <p><code>unlimited</code> - The Capacity Reservation remains active until you explicitly cancel it.</p></li>
/// <li>
/// <p><code>limited</code> - The Capacity Reservation expires automatically at a specified date and time.</p></li>
/// </ul></li>
/// <li>
/// <p><code>instance-match-criteria</code> - Indicates the type of instance launches that the Capacity Reservation accepts. The options include:</p>
/// <ul>
/// <li>
/// <p><code>open</code> - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying any additional parameters.</p></li>
/// <li>
/// <p><code>targeted</code> - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.</p></li>
/// </ul></li>
/// <li>
/// <p><code>placement-group-arn</code> - The ARN of the cluster placement group in which the Capacity Reservation was created.</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>One or more filters.</p>
/// <ul>
/// <li>
/// <p><code>instance-type</code> - The type of instance for which the Capacity Reservation reserves capacity.</p></li>
/// <li>
/// <p><code>owner-id</code> - The ID of the Amazon Web Services account that owns the Capacity Reservation.</p></li>
/// <li>
/// <p><code>instance-platform</code> - The type of operating system for which the Capacity Reservation reserves capacity.</p></li>
/// <li>
/// <p><code>availability-zone</code> - The Availability Zone of the Capacity Reservation.</p></li>
/// <li>
/// <p><code>tenancy</code> - Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:</p>
/// <ul>
/// <li>
/// <p><code>default</code> - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.</p></li>
/// <li>
/// <p><code>dedicated</code> - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.</p></li>
/// </ul></li>
/// <li>
/// <p><code>outpost-arn</code> - The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created.</p></li>
/// <li>
/// <p><code>state</code> - The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:</p>
/// <ul>
/// <li>
/// <p><code>active</code>- The Capacity Reservation is active and the capacity is available for your use.</p></li>
/// <li>
/// <p><code>expired</code> - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.</p></li>
/// <li>
/// <p><code>cancelled</code> - The Capacity Reservation was cancelled. The reserved capacity is no longer available for your use.</p></li>
/// <li>
/// <p><code>pending</code> - The Capacity Reservation request was successful but the capacity provisioning is still pending.</p></li>
/// <li>
/// <p><code>failed</code> - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.</p></li>
/// </ul></li>
/// <li>
/// <p><code>start-date</code> - The date and time at which the Capacity Reservation was started.</p></li>
/// <li>
/// <p><code>end-date</code> - The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.</p></li>
/// <li>
/// <p><code>end-date-type</code> - Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:</p>
/// <ul>
/// <li>
/// <p><code>unlimited</code> - The Capacity Reservation remains active until you explicitly cancel it.</p></li>
/// <li>
/// <p><code>limited</code> - The Capacity Reservation expires automatically at a specified date and time.</p></li>
/// </ul></li>
/// <li>
/// <p><code>instance-match-criteria</code> - Indicates the type of instance launches that the Capacity Reservation accepts. The options include:</p>
/// <ul>
/// <li>
/// <p><code>open</code> - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying any additional parameters.</p></li>
/// <li>
/// <p><code>targeted</code> - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.</p></li>
/// </ul></li>
/// <li>
/// <p><code>placement-group-arn</code> - The ARN of the cluster placement group in which the Capacity Reservation was created.</p></li>
/// </ul>
pub fn get_filters(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Filter>> {
self.inner.get_filters()
}
/// <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()
}
}