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
// 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 RequestPhoneNumberInput {
/// <p>The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.</p>
pub iso_country_code: ::std::option::Option<::std::string::String>,
/// <p>The type of message. Valid values are <code>TRANSACTIONAL</code> for messages that are critical or time-sensitive and <code>PROMOTIONAL</code> for messages that aren't critical or time-sensitive.</p>
pub message_type: ::std::option::Option<crate::types::MessageType>,
/// <p>Indicates if the phone number will be used for text messages, voice messages, or both.</p>
pub number_capabilities: ::std::option::Option<::std::vec::Vec<crate::types::NumberCapability>>,
/// <p>The type of phone number to request.</p>
/// <p>When you request a <code>SIMULATOR</code> phone number, you must set <b>MessageType</b> as <code>TRANSACTIONAL</code>.</p>
pub number_type: ::std::option::Option<crate::types::RequestableNumberType>,
/// <p>The name of the OptOutList to associate with the phone number. You can use the OptOutListName or OptOutListArn.</p><important>
/// <p>If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).</p>
/// </important>
pub opt_out_list_name: ::std::option::Option<::std::string::String>,
/// <p>The pool to associated with the phone number. You can use the PoolId or PoolArn.</p><important>
/// <p>If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).</p>
/// </important>
pub pool_id: ::std::option::Option<::std::string::String>,
/// <p>Use this field to attach your phone number for an external registration process.</p>
pub registration_id: ::std::option::Option<::std::string::String>,
/// <p>An optional selection preference used to request a specific phone number, such as a number that starts with, ends with, or contains a particular digit pattern. You can specify at most one preference. Number preferences apply only to <code>TEN_DLC</code> requests in the <code>US</code>.</p>
pub number_preference: ::std::option::Option<::std::vec::Vec<crate::types::NumberPreferenceItem>>,
/// <p>By default this is set to false. When set to true the international sending of phone number is Enabled.</p>
pub international_sending_enabled: ::std::option::Option<bool>,
/// <p>By default this is set to false. When set to true the phone number can't be deleted.</p>
pub deletion_protection_enabled: ::std::option::Option<bool>,
/// <p>An array of tags (key and value pairs) to associate with the requested phone number.</p>
pub tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
/// <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.</p>
pub client_token: ::std::option::Option<::std::string::String>,
}
impl RequestPhoneNumberInput {
/// <p>The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.</p>
pub fn iso_country_code(&self) -> ::std::option::Option<&str> {
self.iso_country_code.as_deref()
}
/// <p>The type of message. Valid values are <code>TRANSACTIONAL</code> for messages that are critical or time-sensitive and <code>PROMOTIONAL</code> for messages that aren't critical or time-sensitive.</p>
pub fn message_type(&self) -> ::std::option::Option<&crate::types::MessageType> {
self.message_type.as_ref()
}
/// <p>Indicates if the phone number will be used for text messages, voice messages, or both.</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 `.number_capabilities.is_none()`.
pub fn number_capabilities(&self) -> &[crate::types::NumberCapability] {
self.number_capabilities.as_deref().unwrap_or_default()
}
/// <p>The type of phone number to request.</p>
/// <p>When you request a <code>SIMULATOR</code> phone number, you must set <b>MessageType</b> as <code>TRANSACTIONAL</code>.</p>
pub fn number_type(&self) -> ::std::option::Option<&crate::types::RequestableNumberType> {
self.number_type.as_ref()
}
/// <p>The name of the OptOutList to associate with the phone number. You can use the OptOutListName or OptOutListArn.</p><important>
/// <p>If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).</p>
/// </important>
pub fn opt_out_list_name(&self) -> ::std::option::Option<&str> {
self.opt_out_list_name.as_deref()
}
/// <p>The pool to associated with the phone number. You can use the PoolId or PoolArn.</p><important>
/// <p>If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).</p>
/// </important>
pub fn pool_id(&self) -> ::std::option::Option<&str> {
self.pool_id.as_deref()
}
/// <p>Use this field to attach your phone number for an external registration process.</p>
pub fn registration_id(&self) -> ::std::option::Option<&str> {
self.registration_id.as_deref()
}
/// <p>An optional selection preference used to request a specific phone number, such as a number that starts with, ends with, or contains a particular digit pattern. You can specify at most one preference. Number preferences apply only to <code>TEN_DLC</code> requests in the <code>US</code>.</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 `.number_preference.is_none()`.
pub fn number_preference(&self) -> &[crate::types::NumberPreferenceItem] {
self.number_preference.as_deref().unwrap_or_default()
}
/// <p>By default this is set to false. When set to true the international sending of phone number is Enabled.</p>
pub fn international_sending_enabled(&self) -> ::std::option::Option<bool> {
self.international_sending_enabled
}
/// <p>By default this is set to false. When set to true the phone number can't be deleted.</p>
pub fn deletion_protection_enabled(&self) -> ::std::option::Option<bool> {
self.deletion_protection_enabled
}
/// <p>An array of tags (key and value pairs) to associate with the requested phone number.</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 `.tags.is_none()`.
pub fn tags(&self) -> &[crate::types::Tag] {
self.tags.as_deref().unwrap_or_default()
}
/// <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.</p>
pub fn client_token(&self) -> ::std::option::Option<&str> {
self.client_token.as_deref()
}
}
impl RequestPhoneNumberInput {
/// Creates a new builder-style object to manufacture [`RequestPhoneNumberInput`](crate::operation::request_phone_number::RequestPhoneNumberInput).
pub fn builder() -> crate::operation::request_phone_number::builders::RequestPhoneNumberInputBuilder {
crate::operation::request_phone_number::builders::RequestPhoneNumberInputBuilder::default()
}
}
/// A builder for [`RequestPhoneNumberInput`](crate::operation::request_phone_number::RequestPhoneNumberInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct RequestPhoneNumberInputBuilder {
pub(crate) iso_country_code: ::std::option::Option<::std::string::String>,
pub(crate) message_type: ::std::option::Option<crate::types::MessageType>,
pub(crate) number_capabilities: ::std::option::Option<::std::vec::Vec<crate::types::NumberCapability>>,
pub(crate) number_type: ::std::option::Option<crate::types::RequestableNumberType>,
pub(crate) opt_out_list_name: ::std::option::Option<::std::string::String>,
pub(crate) pool_id: ::std::option::Option<::std::string::String>,
pub(crate) registration_id: ::std::option::Option<::std::string::String>,
pub(crate) number_preference: ::std::option::Option<::std::vec::Vec<crate::types::NumberPreferenceItem>>,
pub(crate) international_sending_enabled: ::std::option::Option<bool>,
pub(crate) deletion_protection_enabled: ::std::option::Option<bool>,
pub(crate) tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
pub(crate) client_token: ::std::option::Option<::std::string::String>,
}
impl RequestPhoneNumberInputBuilder {
/// <p>The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.</p>
/// This field is required.
pub fn iso_country_code(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.iso_country_code = ::std::option::Option::Some(input.into());
self
}
/// <p>The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.</p>
pub fn set_iso_country_code(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.iso_country_code = input;
self
}
/// <p>The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.</p>
pub fn get_iso_country_code(&self) -> &::std::option::Option<::std::string::String> {
&self.iso_country_code
}
/// <p>The type of message. Valid values are <code>TRANSACTIONAL</code> for messages that are critical or time-sensitive and <code>PROMOTIONAL</code> for messages that aren't critical or time-sensitive.</p>
/// This field is required.
pub fn message_type(mut self, input: crate::types::MessageType) -> Self {
self.message_type = ::std::option::Option::Some(input);
self
}
/// <p>The type of message. Valid values are <code>TRANSACTIONAL</code> for messages that are critical or time-sensitive and <code>PROMOTIONAL</code> for messages that aren't critical or time-sensitive.</p>
pub fn set_message_type(mut self, input: ::std::option::Option<crate::types::MessageType>) -> Self {
self.message_type = input;
self
}
/// <p>The type of message. Valid values are <code>TRANSACTIONAL</code> for messages that are critical or time-sensitive and <code>PROMOTIONAL</code> for messages that aren't critical or time-sensitive.</p>
pub fn get_message_type(&self) -> &::std::option::Option<crate::types::MessageType> {
&self.message_type
}
/// Appends an item to `number_capabilities`.
///
/// To override the contents of this collection use [`set_number_capabilities`](Self::set_number_capabilities).
///
/// <p>Indicates if the phone number will be used for text messages, voice messages, or both.</p>
pub fn number_capabilities(mut self, input: crate::types::NumberCapability) -> Self {
let mut v = self.number_capabilities.unwrap_or_default();
v.push(input);
self.number_capabilities = ::std::option::Option::Some(v);
self
}
/// <p>Indicates if the phone number will be used for text messages, voice messages, or both.</p>
pub fn set_number_capabilities(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::NumberCapability>>) -> Self {
self.number_capabilities = input;
self
}
/// <p>Indicates if the phone number will be used for text messages, voice messages, or both.</p>
pub fn get_number_capabilities(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::NumberCapability>> {
&self.number_capabilities
}
/// <p>The type of phone number to request.</p>
/// <p>When you request a <code>SIMULATOR</code> phone number, you must set <b>MessageType</b> as <code>TRANSACTIONAL</code>.</p>
/// This field is required.
pub fn number_type(mut self, input: crate::types::RequestableNumberType) -> Self {
self.number_type = ::std::option::Option::Some(input);
self
}
/// <p>The type of phone number to request.</p>
/// <p>When you request a <code>SIMULATOR</code> phone number, you must set <b>MessageType</b> as <code>TRANSACTIONAL</code>.</p>
pub fn set_number_type(mut self, input: ::std::option::Option<crate::types::RequestableNumberType>) -> Self {
self.number_type = input;
self
}
/// <p>The type of phone number to request.</p>
/// <p>When you request a <code>SIMULATOR</code> phone number, you must set <b>MessageType</b> as <code>TRANSACTIONAL</code>.</p>
pub fn get_number_type(&self) -> &::std::option::Option<crate::types::RequestableNumberType> {
&self.number_type
}
/// <p>The name of the OptOutList to associate with the phone number. You can use the OptOutListName or OptOutListArn.</p><important>
/// <p>If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).</p>
/// </important>
pub fn opt_out_list_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.opt_out_list_name = ::std::option::Option::Some(input.into());
self
}
/// <p>The name of the OptOutList to associate with the phone number. You can use the OptOutListName or OptOutListArn.</p><important>
/// <p>If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).</p>
/// </important>
pub fn set_opt_out_list_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.opt_out_list_name = input;
self
}
/// <p>The name of the OptOutList to associate with the phone number. You can use the OptOutListName or OptOutListArn.</p><important>
/// <p>If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).</p>
/// </important>
pub fn get_opt_out_list_name(&self) -> &::std::option::Option<::std::string::String> {
&self.opt_out_list_name
}
/// <p>The pool to associated with the phone number. You can use the PoolId or PoolArn.</p><important>
/// <p>If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).</p>
/// </important>
pub fn pool_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.pool_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The pool to associated with the phone number. You can use the PoolId or PoolArn.</p><important>
/// <p>If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).</p>
/// </important>
pub fn set_pool_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.pool_id = input;
self
}
/// <p>The pool to associated with the phone number. You can use the PoolId or PoolArn.</p><important>
/// <p>If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).</p>
/// </important>
pub fn get_pool_id(&self) -> &::std::option::Option<::std::string::String> {
&self.pool_id
}
/// <p>Use this field to attach your phone number for an external registration process.</p>
pub fn registration_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.registration_id = ::std::option::Option::Some(input.into());
self
}
/// <p>Use this field to attach your phone number for an external registration process.</p>
pub fn set_registration_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.registration_id = input;
self
}
/// <p>Use this field to attach your phone number for an external registration process.</p>
pub fn get_registration_id(&self) -> &::std::option::Option<::std::string::String> {
&self.registration_id
}
/// Appends an item to `number_preference`.
///
/// To override the contents of this collection use [`set_number_preference`](Self::set_number_preference).
///
/// <p>An optional selection preference used to request a specific phone number, such as a number that starts with, ends with, or contains a particular digit pattern. You can specify at most one preference. Number preferences apply only to <code>TEN_DLC</code> requests in the <code>US</code>.</p>
pub fn number_preference(mut self, input: crate::types::NumberPreferenceItem) -> Self {
let mut v = self.number_preference.unwrap_or_default();
v.push(input);
self.number_preference = ::std::option::Option::Some(v);
self
}
/// <p>An optional selection preference used to request a specific phone number, such as a number that starts with, ends with, or contains a particular digit pattern. You can specify at most one preference. Number preferences apply only to <code>TEN_DLC</code> requests in the <code>US</code>.</p>
pub fn set_number_preference(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::NumberPreferenceItem>>) -> Self {
self.number_preference = input;
self
}
/// <p>An optional selection preference used to request a specific phone number, such as a number that starts with, ends with, or contains a particular digit pattern. You can specify at most one preference. Number preferences apply only to <code>TEN_DLC</code> requests in the <code>US</code>.</p>
pub fn get_number_preference(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::NumberPreferenceItem>> {
&self.number_preference
}
/// <p>By default this is set to false. When set to true the international sending of phone number is Enabled.</p>
pub fn international_sending_enabled(mut self, input: bool) -> Self {
self.international_sending_enabled = ::std::option::Option::Some(input);
self
}
/// <p>By default this is set to false. When set to true the international sending of phone number is Enabled.</p>
pub fn set_international_sending_enabled(mut self, input: ::std::option::Option<bool>) -> Self {
self.international_sending_enabled = input;
self
}
/// <p>By default this is set to false. When set to true the international sending of phone number is Enabled.</p>
pub fn get_international_sending_enabled(&self) -> &::std::option::Option<bool> {
&self.international_sending_enabled
}
/// <p>By default this is set to false. When set to true the phone number can't be deleted.</p>
pub fn deletion_protection_enabled(mut self, input: bool) -> Self {
self.deletion_protection_enabled = ::std::option::Option::Some(input);
self
}
/// <p>By default this is set to false. When set to true the phone number can't be deleted.</p>
pub fn set_deletion_protection_enabled(mut self, input: ::std::option::Option<bool>) -> Self {
self.deletion_protection_enabled = input;
self
}
/// <p>By default this is set to false. When set to true the phone number can't be deleted.</p>
pub fn get_deletion_protection_enabled(&self) -> &::std::option::Option<bool> {
&self.deletion_protection_enabled
}
/// Appends an item to `tags`.
///
/// To override the contents of this collection use [`set_tags`](Self::set_tags).
///
/// <p>An array of tags (key and value pairs) to associate with the requested phone number.</p>
pub fn tags(mut self, input: crate::types::Tag) -> Self {
let mut v = self.tags.unwrap_or_default();
v.push(input);
self.tags = ::std::option::Option::Some(v);
self
}
/// <p>An array of tags (key and value pairs) to associate with the requested phone number.</p>
pub fn set_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>) -> Self {
self.tags = input;
self
}
/// <p>An array of tags (key and value pairs) to associate with the requested phone number.</p>
pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Tag>> {
&self.tags
}
/// <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.</p>
pub fn client_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.client_token = ::std::option::Option::Some(input.into());
self
}
/// <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.</p>
pub fn set_client_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.client_token = input;
self
}
/// <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.</p>
pub fn get_client_token(&self) -> &::std::option::Option<::std::string::String> {
&self.client_token
}
/// Consumes the builder and constructs a [`RequestPhoneNumberInput`](crate::operation::request_phone_number::RequestPhoneNumberInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::request_phone_number::RequestPhoneNumberInput, ::aws_smithy_types::error::operation::BuildError>
{
::std::result::Result::Ok(crate::operation::request_phone_number::RequestPhoneNumberInput {
iso_country_code: self.iso_country_code,
message_type: self.message_type,
number_capabilities: self.number_capabilities,
number_type: self.number_type,
opt_out_list_name: self.opt_out_list_name,
pool_id: self.pool_id,
registration_id: self.registration_id,
number_preference: self.number_preference,
international_sending_enabled: self.international_sending_enabled,
deletion_protection_enabled: self.deletion_protection_enabled,
tags: self.tags,
client_token: self.client_token,
})
}
}