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
// 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 DescribeHostsInput {
/// <p>The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.</p>
pub host_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 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>
/// <p>You cannot specify this parameter and the host IDs parameter in the same request.</p>
pub max_results: ::std::option::Option<i32>,
/// <p>The filters.</p>
/// <ul>
/// <li>
/// <p><code>auto-placement</code> - Whether auto-placement is enabled or disabled (<code>on</code> | <code>off</code>).</p></li>
/// <li>
/// <p><code>availability-zone</code> - The Availability Zone of the host.</p></li>
/// <li>
/// <p><code>client-token</code> - The idempotency token that you provided when you allocated the host.</p></li>
/// <li>
/// <p><code>host-reservation-id</code> - The ID of the reservation assigned to this host.</p></li>
/// <li>
/// <p><code>instance-type</code> - The instance type size that the Dedicated Host is configured to support.</p></li>
/// <li>
/// <p><code>state</code> - The allocation state of the Dedicated Host (<code>available</code> | <code>under-assessment</code> | <code>permanent-failure</code> | <code>released</code> | <code>released-permanent-failure</code>).</p></li>
/// <li>
/// <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>
/// </ul>
pub filter: ::std::option::Option<::std::vec::Vec<crate::types::Filter>>,
}
impl DescribeHostsInput {
/// <p>The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.</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 `.host_ids.is_none()`.
pub fn host_ids(&self) -> &[::std::string::String] {
self.host_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 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>
/// <p>You cannot specify this parameter and the host IDs parameter in the same request.</p>
pub fn max_results(&self) -> ::std::option::Option<i32> {
self.max_results
}
/// <p>The filters.</p>
/// <ul>
/// <li>
/// <p><code>auto-placement</code> - Whether auto-placement is enabled or disabled (<code>on</code> | <code>off</code>).</p></li>
/// <li>
/// <p><code>availability-zone</code> - The Availability Zone of the host.</p></li>
/// <li>
/// <p><code>client-token</code> - The idempotency token that you provided when you allocated the host.</p></li>
/// <li>
/// <p><code>host-reservation-id</code> - The ID of the reservation assigned to this host.</p></li>
/// <li>
/// <p><code>instance-type</code> - The instance type size that the Dedicated Host is configured to support.</p></li>
/// <li>
/// <p><code>state</code> - The allocation state of the Dedicated Host (<code>available</code> | <code>under-assessment</code> | <code>permanent-failure</code> | <code>released</code> | <code>released-permanent-failure</code>).</p></li>
/// <li>
/// <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>
/// </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 `.filter.is_none()`.
pub fn filter(&self) -> &[crate::types::Filter] {
self.filter.as_deref().unwrap_or_default()
}
}
impl DescribeHostsInput {
/// Creates a new builder-style object to manufacture [`DescribeHostsInput`](crate::operation::describe_hosts::DescribeHostsInput).
pub fn builder() -> crate::operation::describe_hosts::builders::DescribeHostsInputBuilder {
crate::operation::describe_hosts::builders::DescribeHostsInputBuilder::default()
}
}
/// A builder for [`DescribeHostsInput`](crate::operation::describe_hosts::DescribeHostsInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct DescribeHostsInputBuilder {
pub(crate) host_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) filter: ::std::option::Option<::std::vec::Vec<crate::types::Filter>>,
}
impl DescribeHostsInputBuilder {
/// Appends an item to `host_ids`.
///
/// To override the contents of this collection use [`set_host_ids`](Self::set_host_ids).
///
/// <p>The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.</p>
pub fn host_ids(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
let mut v = self.host_ids.unwrap_or_default();
v.push(input.into());
self.host_ids = ::std::option::Option::Some(v);
self
}
/// <p>The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.</p>
pub fn set_host_ids(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.host_ids = input;
self
}
/// <p>The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.</p>
pub fn get_host_ids(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
&self.host_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 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>
/// <p>You cannot specify this parameter and the host IDs parameter in the same request.</p>
pub fn max_results(mut self, input: i32) -> Self {
self.max_results = ::std::option::Option::Some(input);
self
}
/// <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>
/// <p>You cannot specify this parameter and the host IDs parameter in the same request.</p>
pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
self.max_results = input;
self
}
/// <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>
/// <p>You cannot specify this parameter and the host IDs parameter in the same request.</p>
pub fn get_max_results(&self) -> &::std::option::Option<i32> {
&self.max_results
}
/// Appends an item to `filter`.
///
/// To override the contents of this collection use [`set_filter`](Self::set_filter).
///
/// <p>The filters.</p>
/// <ul>
/// <li>
/// <p><code>auto-placement</code> - Whether auto-placement is enabled or disabled (<code>on</code> | <code>off</code>).</p></li>
/// <li>
/// <p><code>availability-zone</code> - The Availability Zone of the host.</p></li>
/// <li>
/// <p><code>client-token</code> - The idempotency token that you provided when you allocated the host.</p></li>
/// <li>
/// <p><code>host-reservation-id</code> - The ID of the reservation assigned to this host.</p></li>
/// <li>
/// <p><code>instance-type</code> - The instance type size that the Dedicated Host is configured to support.</p></li>
/// <li>
/// <p><code>state</code> - The allocation state of the Dedicated Host (<code>available</code> | <code>under-assessment</code> | <code>permanent-failure</code> | <code>released</code> | <code>released-permanent-failure</code>).</p></li>
/// <li>
/// <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>
/// </ul>
pub fn filter(mut self, input: crate::types::Filter) -> Self {
let mut v = self.filter.unwrap_or_default();
v.push(input);
self.filter = ::std::option::Option::Some(v);
self
}
/// <p>The filters.</p>
/// <ul>
/// <li>
/// <p><code>auto-placement</code> - Whether auto-placement is enabled or disabled (<code>on</code> | <code>off</code>).</p></li>
/// <li>
/// <p><code>availability-zone</code> - The Availability Zone of the host.</p></li>
/// <li>
/// <p><code>client-token</code> - The idempotency token that you provided when you allocated the host.</p></li>
/// <li>
/// <p><code>host-reservation-id</code> - The ID of the reservation assigned to this host.</p></li>
/// <li>
/// <p><code>instance-type</code> - The instance type size that the Dedicated Host is configured to support.</p></li>
/// <li>
/// <p><code>state</code> - The allocation state of the Dedicated Host (<code>available</code> | <code>under-assessment</code> | <code>permanent-failure</code> | <code>released</code> | <code>released-permanent-failure</code>).</p></li>
/// <li>
/// <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>
/// </ul>
pub fn set_filter(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Filter>>) -> Self {
self.filter = input;
self
}
/// <p>The filters.</p>
/// <ul>
/// <li>
/// <p><code>auto-placement</code> - Whether auto-placement is enabled or disabled (<code>on</code> | <code>off</code>).</p></li>
/// <li>
/// <p><code>availability-zone</code> - The Availability Zone of the host.</p></li>
/// <li>
/// <p><code>client-token</code> - The idempotency token that you provided when you allocated the host.</p></li>
/// <li>
/// <p><code>host-reservation-id</code> - The ID of the reservation assigned to this host.</p></li>
/// <li>
/// <p><code>instance-type</code> - The instance type size that the Dedicated Host is configured to support.</p></li>
/// <li>
/// <p><code>state</code> - The allocation state of the Dedicated Host (<code>available</code> | <code>under-assessment</code> | <code>permanent-failure</code> | <code>released</code> | <code>released-permanent-failure</code>).</p></li>
/// <li>
/// <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>
/// </ul>
pub fn get_filter(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Filter>> {
&self.filter
}
/// Consumes the builder and constructs a [`DescribeHostsInput`](crate::operation::describe_hosts::DescribeHostsInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::describe_hosts::DescribeHostsInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::describe_hosts::DescribeHostsInput {
host_ids: self.host_ids,
next_token: self.next_token,
max_results: self.max_results,
filter: self.filter,
})
}
}