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
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct DescribeCapacityBlocksInput {
/// <p>The IDs of the Capacity Blocks.</p>
pub capacity_block_ids: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
/// <p>The token to use to retrieve the next page of results.</p>
pub next_token: ::std::option::Option<::std::string::String>,
/// <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 max_results: ::std::option::Option<i32>,
/// <p>One or more filters.</p>
/// <ul>
/// <li>
/// <p><code>capacity-block-id</code> - The ID of the Capacity Block.</p></li>
/// <li>
/// <p><code>ultraserver-type</code> - The Capacity Block type. The type can be <code>instances</code> or <code>ultraservers</code>.</p></li>
/// <li>
/// <p><code>availability-zone</code> - The Availability Zone of the Capacity Block.</p></li>
/// <li>
/// <p><code>start-date</code> - The date and time at which the Capacity Block was started.</p></li>
/// <li>
/// <p><code>end-date</code> - The date and time at which the Capacity Block expires. When a Capacity Block expires, all instances in the Capacity Block are terminated.</p></li>
/// <li>
/// <p><code>create-date</code> - The date and time at which the Capacity Block was created.</p></li>
/// <li>
/// <p><code>state</code> - The state of the Capacity Block (<code>active</code> | <code>expired</code> | <code>unavailable</code> | <code>cancelled</code> | <code>failed</code> | <code>scheduled</code> | <code>payment-pending</code> | <code>payment-failed</code>).</p></li>
/// <li>
/// <p><code>tags</code> - The tags assigned to the Capacity Block.</p></li>
/// </ul>
pub filters: ::std::option::Option<::std::vec::Vec<crate::types::Filter>>,
/// <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 dry_run: ::std::option::Option<bool>,
}
impl DescribeCapacityBlocksInput {
/// <p>The IDs of the Capacity Blocks.</p>
///
/// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.capacity_block_ids.is_none()`.
pub fn capacity_block_ids(&self) -> &[::std::string::String] {
self.capacity_block_ids.as_deref().unwrap_or_default()
}
/// <p>The token to use to retrieve the next page of results.</p>
pub fn next_token(&self) -> ::std::option::Option<&str> {
self.next_token.as_deref()
}
/// <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(&self) -> ::std::option::Option<i32> {
self.max_results
}
/// <p>One or more filters.</p>
/// <ul>
/// <li>
/// <p><code>capacity-block-id</code> - The ID of the Capacity Block.</p></li>
/// <li>
/// <p><code>ultraserver-type</code> - The Capacity Block type. The type can be <code>instances</code> or <code>ultraservers</code>.</p></li>
/// <li>
/// <p><code>availability-zone</code> - The Availability Zone of the Capacity Block.</p></li>
/// <li>
/// <p><code>start-date</code> - The date and time at which the Capacity Block was started.</p></li>
/// <li>
/// <p><code>end-date</code> - The date and time at which the Capacity Block expires. When a Capacity Block expires, all instances in the Capacity Block are terminated.</p></li>
/// <li>
/// <p><code>create-date</code> - The date and time at which the Capacity Block was created.</p></li>
/// <li>
/// <p><code>state</code> - The state of the Capacity Block (<code>active</code> | <code>expired</code> | <code>unavailable</code> | <code>cancelled</code> | <code>failed</code> | <code>scheduled</code> | <code>payment-pending</code> | <code>payment-failed</code>).</p></li>
/// <li>
/// <p><code>tags</code> - The tags assigned to the Capacity Block.</p></li>
/// </ul>
///
/// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.filters.is_none()`.
pub fn filters(&self) -> &[crate::types::Filter] {
self.filters.as_deref().unwrap_or_default()
}
/// <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(&self) -> ::std::option::Option<bool> {
self.dry_run
}
}
impl DescribeCapacityBlocksInput {
/// Creates a new builder-style object to manufacture [`DescribeCapacityBlocksInput`](crate::operation::describe_capacity_blocks::DescribeCapacityBlocksInput).
pub fn builder() -> crate::operation::describe_capacity_blocks::builders::DescribeCapacityBlocksInputBuilder {
crate::operation::describe_capacity_blocks::builders::DescribeCapacityBlocksInputBuilder::default()
}
}
/// A builder for [`DescribeCapacityBlocksInput`](crate::operation::describe_capacity_blocks::DescribeCapacityBlocksInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct DescribeCapacityBlocksInputBuilder {
pub(crate) capacity_block_ids: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
pub(crate) next_token: ::std::option::Option<::std::string::String>,
pub(crate) max_results: ::std::option::Option<i32>,
pub(crate) filters: ::std::option::Option<::std::vec::Vec<crate::types::Filter>>,
pub(crate) dry_run: ::std::option::Option<bool>,
}
impl DescribeCapacityBlocksInputBuilder {
/// Appends an item to `capacity_block_ids`.
///
/// To override the contents of this collection use [`set_capacity_block_ids`](Self::set_capacity_block_ids).
///
/// <p>The IDs of the Capacity Blocks.</p>
pub fn capacity_block_ids(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
let mut v = self.capacity_block_ids.unwrap_or_default();
v.push(input.into());
self.capacity_block_ids = ::std::option::Option::Some(v);
self
}
/// <p>The IDs of the Capacity Blocks.</p>
pub fn set_capacity_block_ids(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.capacity_block_ids = input;
self
}
/// <p>The IDs of the Capacity Blocks.</p>
pub fn get_capacity_block_ids(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
&self.capacity_block_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.next_token = ::std::option::Option::Some(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.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.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.max_results = ::std::option::Option::Some(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.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.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>capacity-block-id</code> - The ID of the Capacity Block.</p></li>
/// <li>
/// <p><code>ultraserver-type</code> - The Capacity Block type. The type can be <code>instances</code> or <code>ultraservers</code>.</p></li>
/// <li>
/// <p><code>availability-zone</code> - The Availability Zone of the Capacity Block.</p></li>
/// <li>
/// <p><code>start-date</code> - The date and time at which the Capacity Block was started.</p></li>
/// <li>
/// <p><code>end-date</code> - The date and time at which the Capacity Block expires. When a Capacity Block expires, all instances in the Capacity Block are terminated.</p></li>
/// <li>
/// <p><code>create-date</code> - The date and time at which the Capacity Block was created.</p></li>
/// <li>
/// <p><code>state</code> - The state of the Capacity Block (<code>active</code> | <code>expired</code> | <code>unavailable</code> | <code>cancelled</code> | <code>failed</code> | <code>scheduled</code> | <code>payment-pending</code> | <code>payment-failed</code>).</p></li>
/// <li>
/// <p><code>tags</code> - The tags assigned to the Capacity Block.</p></li>
/// </ul>
pub fn filters(mut self, input: crate::types::Filter) -> Self {
let mut v = self.filters.unwrap_or_default();
v.push(input);
self.filters = ::std::option::Option::Some(v);
self
}
/// <p>One or more filters.</p>
/// <ul>
/// <li>
/// <p><code>capacity-block-id</code> - The ID of the Capacity Block.</p></li>
/// <li>
/// <p><code>ultraserver-type</code> - The Capacity Block type. The type can be <code>instances</code> or <code>ultraservers</code>.</p></li>
/// <li>
/// <p><code>availability-zone</code> - The Availability Zone of the Capacity Block.</p></li>
/// <li>
/// <p><code>start-date</code> - The date and time at which the Capacity Block was started.</p></li>
/// <li>
/// <p><code>end-date</code> - The date and time at which the Capacity Block expires. When a Capacity Block expires, all instances in the Capacity Block are terminated.</p></li>
/// <li>
/// <p><code>create-date</code> - The date and time at which the Capacity Block was created.</p></li>
/// <li>
/// <p><code>state</code> - The state of the Capacity Block (<code>active</code> | <code>expired</code> | <code>unavailable</code> | <code>cancelled</code> | <code>failed</code> | <code>scheduled</code> | <code>payment-pending</code> | <code>payment-failed</code>).</p></li>
/// <li>
/// <p><code>tags</code> - The tags assigned to the Capacity Block.</p></li>
/// </ul>
pub fn set_filters(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Filter>>) -> Self {
self.filters = input;
self
}
/// <p>One or more filters.</p>
/// <ul>
/// <li>
/// <p><code>capacity-block-id</code> - The ID of the Capacity Block.</p></li>
/// <li>
/// <p><code>ultraserver-type</code> - The Capacity Block type. The type can be <code>instances</code> or <code>ultraservers</code>.</p></li>
/// <li>
/// <p><code>availability-zone</code> - The Availability Zone of the Capacity Block.</p></li>
/// <li>
/// <p><code>start-date</code> - The date and time at which the Capacity Block was started.</p></li>
/// <li>
/// <p><code>end-date</code> - The date and time at which the Capacity Block expires. When a Capacity Block expires, all instances in the Capacity Block are terminated.</p></li>
/// <li>
/// <p><code>create-date</code> - The date and time at which the Capacity Block was created.</p></li>
/// <li>
/// <p><code>state</code> - The state of the Capacity Block (<code>active</code> | <code>expired</code> | <code>unavailable</code> | <code>cancelled</code> | <code>failed</code> | <code>scheduled</code> | <code>payment-pending</code> | <code>payment-failed</code>).</p></li>
/// <li>
/// <p><code>tags</code> - The tags assigned to the Capacity Block.</p></li>
/// </ul>
pub fn get_filters(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Filter>> {
&self.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.dry_run = ::std::option::Option::Some(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.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.dry_run
}
/// Consumes the builder and constructs a [`DescribeCapacityBlocksInput`](crate::operation::describe_capacity_blocks::DescribeCapacityBlocksInput).
pub fn build(
self,
) -> ::std::result::Result<
crate::operation::describe_capacity_blocks::DescribeCapacityBlocksInput,
::aws_smithy_types::error::operation::BuildError,
> {
::std::result::Result::Ok(crate::operation::describe_capacity_blocks::DescribeCapacityBlocksInput {
capacity_block_ids: self.capacity_block_ids,
next_token: self.next_token,
max_results: self.max_results,
filters: self.filters,
dry_run: self.dry_run,
})
}
}