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
// 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 SendVoiceMessageInput {
/// <p>The destination phone number in E.164 format.</p>
pub destination_phone_number: ::std::option::Option<::std::string::String>,
/// <p>The origination identity to use for the voice call. This can be the PhoneNumber, PhoneNumberId, PhoneNumberArn, 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 origination_identity: ::std::option::Option<::std::string::String>,
/// <p>The text to convert to a voice message.</p>
pub message_body: ::std::option::Option<::std::string::String>,
/// <p>Specifies if the MessageBody field contains text or <a href="https://docs.aws.amazon.com/polly/latest/dg/what-is.html">speech synthesis markup language (SSML)</a>.</p>
/// <ul>
/// <li>
/// <p>TEXT: This is the default value. When used the maximum character limit is 3000.</p></li>
/// <li>
/// <p>SSML: When used the maximum character limit is 6000 including SSML tagging.</p></li>
/// </ul>
pub message_body_text_type: ::std::option::Option<crate::types::VoiceMessageBodyTextType>,
/// <p>The voice for the <a href="https://docs.aws.amazon.com/polly/latest/dg/what-is.html">Amazon Polly</a> service to use. By default this is set to "MATTHEW".</p>
pub voice_id: ::std::option::Option<crate::types::VoiceId>,
/// <p>The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.</p>
pub configuration_set_name: ::std::option::Option<::std::string::String>,
/// <p>The maximum amount to spend per voice message, in US dollars.</p>
pub max_price_per_minute: ::std::option::Option<::std::string::String>,
/// <p>How long the voice message is valid for. By default this is 72 hours.</p>
pub time_to_live: ::std::option::Option<i32>,
/// <p>You can specify custom data in this field. If you do, that data is logged to the event destination.</p>
pub context: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
/// <p>When set to true, the message is checked and validated, but isn't sent to the end recipient.</p>
pub dry_run: ::std::option::Option<bool>,
/// <p>The unique identifier for the protect configuration.</p>
pub protect_configuration_id: ::std::option::Option<::std::string::String>,
/// <p>Set to true to enable message feedback for the message. When a user receives the message you need to update the message status using <code>PutMessageFeedback</code>.</p>
pub message_feedback_enabled: ::std::option::Option<bool>,
}
impl SendVoiceMessageInput {
/// <p>The destination phone number in E.164 format.</p>
pub fn destination_phone_number(&self) -> ::std::option::Option<&str> {
self.destination_phone_number.as_deref()
}
/// <p>The origination identity to use for the voice call. This can be the PhoneNumber, PhoneNumberId, PhoneNumberArn, 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 origination_identity(&self) -> ::std::option::Option<&str> {
self.origination_identity.as_deref()
}
/// <p>The text to convert to a voice message.</p>
pub fn message_body(&self) -> ::std::option::Option<&str> {
self.message_body.as_deref()
}
/// <p>Specifies if the MessageBody field contains text or <a href="https://docs.aws.amazon.com/polly/latest/dg/what-is.html">speech synthesis markup language (SSML)</a>.</p>
/// <ul>
/// <li>
/// <p>TEXT: This is the default value. When used the maximum character limit is 3000.</p></li>
/// <li>
/// <p>SSML: When used the maximum character limit is 6000 including SSML tagging.</p></li>
/// </ul>
pub fn message_body_text_type(&self) -> ::std::option::Option<&crate::types::VoiceMessageBodyTextType> {
self.message_body_text_type.as_ref()
}
/// <p>The voice for the <a href="https://docs.aws.amazon.com/polly/latest/dg/what-is.html">Amazon Polly</a> service to use. By default this is set to "MATTHEW".</p>
pub fn voice_id(&self) -> ::std::option::Option<&crate::types::VoiceId> {
self.voice_id.as_ref()
}
/// <p>The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.</p>
pub fn configuration_set_name(&self) -> ::std::option::Option<&str> {
self.configuration_set_name.as_deref()
}
/// <p>The maximum amount to spend per voice message, in US dollars.</p>
pub fn max_price_per_minute(&self) -> ::std::option::Option<&str> {
self.max_price_per_minute.as_deref()
}
/// <p>How long the voice message is valid for. By default this is 72 hours.</p>
pub fn time_to_live(&self) -> ::std::option::Option<i32> {
self.time_to_live
}
/// <p>You can specify custom data in this field. If you do, that data is logged to the event destination.</p>
pub fn context(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, ::std::string::String>> {
self.context.as_ref()
}
/// <p>When set to true, the message is checked and validated, but isn't sent to the end recipient.</p>
pub fn dry_run(&self) -> ::std::option::Option<bool> {
self.dry_run
}
/// <p>The unique identifier for the protect configuration.</p>
pub fn protect_configuration_id(&self) -> ::std::option::Option<&str> {
self.protect_configuration_id.as_deref()
}
/// <p>Set to true to enable message feedback for the message. When a user receives the message you need to update the message status using <code>PutMessageFeedback</code>.</p>
pub fn message_feedback_enabled(&self) -> ::std::option::Option<bool> {
self.message_feedback_enabled
}
}
impl SendVoiceMessageInput {
/// Creates a new builder-style object to manufacture [`SendVoiceMessageInput`](crate::operation::send_voice_message::SendVoiceMessageInput).
pub fn builder() -> crate::operation::send_voice_message::builders::SendVoiceMessageInputBuilder {
crate::operation::send_voice_message::builders::SendVoiceMessageInputBuilder::default()
}
}
/// A builder for [`SendVoiceMessageInput`](crate::operation::send_voice_message::SendVoiceMessageInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct SendVoiceMessageInputBuilder {
pub(crate) destination_phone_number: ::std::option::Option<::std::string::String>,
pub(crate) origination_identity: ::std::option::Option<::std::string::String>,
pub(crate) message_body: ::std::option::Option<::std::string::String>,
pub(crate) message_body_text_type: ::std::option::Option<crate::types::VoiceMessageBodyTextType>,
pub(crate) voice_id: ::std::option::Option<crate::types::VoiceId>,
pub(crate) configuration_set_name: ::std::option::Option<::std::string::String>,
pub(crate) max_price_per_minute: ::std::option::Option<::std::string::String>,
pub(crate) time_to_live: ::std::option::Option<i32>,
pub(crate) context: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
pub(crate) dry_run: ::std::option::Option<bool>,
pub(crate) protect_configuration_id: ::std::option::Option<::std::string::String>,
pub(crate) message_feedback_enabled: ::std::option::Option<bool>,
}
impl SendVoiceMessageInputBuilder {
/// <p>The destination phone number in E.164 format.</p>
/// This field is required.
pub fn destination_phone_number(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.destination_phone_number = ::std::option::Option::Some(input.into());
self
}
/// <p>The destination phone number in E.164 format.</p>
pub fn set_destination_phone_number(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.destination_phone_number = input;
self
}
/// <p>The destination phone number in E.164 format.</p>
pub fn get_destination_phone_number(&self) -> &::std::option::Option<::std::string::String> {
&self.destination_phone_number
}
/// <p>The origination identity to use for the voice call. This can be the PhoneNumber, PhoneNumberId, PhoneNumberArn, 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>
/// This field is required.
pub fn origination_identity(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.origination_identity = ::std::option::Option::Some(input.into());
self
}
/// <p>The origination identity to use for the voice call. This can be the PhoneNumber, PhoneNumberId, PhoneNumberArn, 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_origination_identity(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.origination_identity = input;
self
}
/// <p>The origination identity to use for the voice call. This can be the PhoneNumber, PhoneNumberId, PhoneNumberArn, 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_origination_identity(&self) -> &::std::option::Option<::std::string::String> {
&self.origination_identity
}
/// <p>The text to convert to a voice message.</p>
pub fn message_body(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.message_body = ::std::option::Option::Some(input.into());
self
}
/// <p>The text to convert to a voice message.</p>
pub fn set_message_body(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.message_body = input;
self
}
/// <p>The text to convert to a voice message.</p>
pub fn get_message_body(&self) -> &::std::option::Option<::std::string::String> {
&self.message_body
}
/// <p>Specifies if the MessageBody field contains text or <a href="https://docs.aws.amazon.com/polly/latest/dg/what-is.html">speech synthesis markup language (SSML)</a>.</p>
/// <ul>
/// <li>
/// <p>TEXT: This is the default value. When used the maximum character limit is 3000.</p></li>
/// <li>
/// <p>SSML: When used the maximum character limit is 6000 including SSML tagging.</p></li>
/// </ul>
pub fn message_body_text_type(mut self, input: crate::types::VoiceMessageBodyTextType) -> Self {
self.message_body_text_type = ::std::option::Option::Some(input);
self
}
/// <p>Specifies if the MessageBody field contains text or <a href="https://docs.aws.amazon.com/polly/latest/dg/what-is.html">speech synthesis markup language (SSML)</a>.</p>
/// <ul>
/// <li>
/// <p>TEXT: This is the default value. When used the maximum character limit is 3000.</p></li>
/// <li>
/// <p>SSML: When used the maximum character limit is 6000 including SSML tagging.</p></li>
/// </ul>
pub fn set_message_body_text_type(mut self, input: ::std::option::Option<crate::types::VoiceMessageBodyTextType>) -> Self {
self.message_body_text_type = input;
self
}
/// <p>Specifies if the MessageBody field contains text or <a href="https://docs.aws.amazon.com/polly/latest/dg/what-is.html">speech synthesis markup language (SSML)</a>.</p>
/// <ul>
/// <li>
/// <p>TEXT: This is the default value. When used the maximum character limit is 3000.</p></li>
/// <li>
/// <p>SSML: When used the maximum character limit is 6000 including SSML tagging.</p></li>
/// </ul>
pub fn get_message_body_text_type(&self) -> &::std::option::Option<crate::types::VoiceMessageBodyTextType> {
&self.message_body_text_type
}
/// <p>The voice for the <a href="https://docs.aws.amazon.com/polly/latest/dg/what-is.html">Amazon Polly</a> service to use. By default this is set to "MATTHEW".</p>
pub fn voice_id(mut self, input: crate::types::VoiceId) -> Self {
self.voice_id = ::std::option::Option::Some(input);
self
}
/// <p>The voice for the <a href="https://docs.aws.amazon.com/polly/latest/dg/what-is.html">Amazon Polly</a> service to use. By default this is set to "MATTHEW".</p>
pub fn set_voice_id(mut self, input: ::std::option::Option<crate::types::VoiceId>) -> Self {
self.voice_id = input;
self
}
/// <p>The voice for the <a href="https://docs.aws.amazon.com/polly/latest/dg/what-is.html">Amazon Polly</a> service to use. By default this is set to "MATTHEW".</p>
pub fn get_voice_id(&self) -> &::std::option::Option<crate::types::VoiceId> {
&self.voice_id
}
/// <p>The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.</p>
pub fn configuration_set_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.configuration_set_name = ::std::option::Option::Some(input.into());
self
}
/// <p>The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.</p>
pub fn set_configuration_set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.configuration_set_name = input;
self
}
/// <p>The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.</p>
pub fn get_configuration_set_name(&self) -> &::std::option::Option<::std::string::String> {
&self.configuration_set_name
}
/// <p>The maximum amount to spend per voice message, in US dollars.</p>
pub fn max_price_per_minute(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.max_price_per_minute = ::std::option::Option::Some(input.into());
self
}
/// <p>The maximum amount to spend per voice message, in US dollars.</p>
pub fn set_max_price_per_minute(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.max_price_per_minute = input;
self
}
/// <p>The maximum amount to spend per voice message, in US dollars.</p>
pub fn get_max_price_per_minute(&self) -> &::std::option::Option<::std::string::String> {
&self.max_price_per_minute
}
/// <p>How long the voice message is valid for. By default this is 72 hours.</p>
pub fn time_to_live(mut self, input: i32) -> Self {
self.time_to_live = ::std::option::Option::Some(input);
self
}
/// <p>How long the voice message is valid for. By default this is 72 hours.</p>
pub fn set_time_to_live(mut self, input: ::std::option::Option<i32>) -> Self {
self.time_to_live = input;
self
}
/// <p>How long the voice message is valid for. By default this is 72 hours.</p>
pub fn get_time_to_live(&self) -> &::std::option::Option<i32> {
&self.time_to_live
}
/// Adds a key-value pair to `context`.
///
/// To override the contents of this collection use [`set_context`](Self::set_context).
///
/// <p>You can specify custom data in this field. If you do, that data is logged to the event destination.</p>
pub fn context(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
let mut hash_map = self.context.unwrap_or_default();
hash_map.insert(k.into(), v.into());
self.context = ::std::option::Option::Some(hash_map);
self
}
/// <p>You can specify custom data in this field. If you do, that data is logged to the event destination.</p>
pub fn set_context(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
self.context = input;
self
}
/// <p>You can specify custom data in this field. If you do, that data is logged to the event destination.</p>
pub fn get_context(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
&self.context
}
/// <p>When set to true, the message is checked and validated, but isn't sent to the end recipient.</p>
pub fn dry_run(mut self, input: bool) -> Self {
self.dry_run = ::std::option::Option::Some(input);
self
}
/// <p>When set to true, the message is checked and validated, but isn't sent to the end recipient.</p>
pub fn set_dry_run(mut self, input: ::std::option::Option<bool>) -> Self {
self.dry_run = input;
self
}
/// <p>When set to true, the message is checked and validated, but isn't sent to the end recipient.</p>
pub fn get_dry_run(&self) -> &::std::option::Option<bool> {
&self.dry_run
}
/// <p>The unique identifier for the protect configuration.</p>
pub fn protect_configuration_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.protect_configuration_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The unique identifier for the protect configuration.</p>
pub fn set_protect_configuration_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.protect_configuration_id = input;
self
}
/// <p>The unique identifier for the protect configuration.</p>
pub fn get_protect_configuration_id(&self) -> &::std::option::Option<::std::string::String> {
&self.protect_configuration_id
}
/// <p>Set to true to enable message feedback for the message. When a user receives the message you need to update the message status using <code>PutMessageFeedback</code>.</p>
pub fn message_feedback_enabled(mut self, input: bool) -> Self {
self.message_feedback_enabled = ::std::option::Option::Some(input);
self
}
/// <p>Set to true to enable message feedback for the message. When a user receives the message you need to update the message status using <code>PutMessageFeedback</code>.</p>
pub fn set_message_feedback_enabled(mut self, input: ::std::option::Option<bool>) -> Self {
self.message_feedback_enabled = input;
self
}
/// <p>Set to true to enable message feedback for the message. When a user receives the message you need to update the message status using <code>PutMessageFeedback</code>.</p>
pub fn get_message_feedback_enabled(&self) -> &::std::option::Option<bool> {
&self.message_feedback_enabled
}
/// Consumes the builder and constructs a [`SendVoiceMessageInput`](crate::operation::send_voice_message::SendVoiceMessageInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::send_voice_message::SendVoiceMessageInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::send_voice_message::SendVoiceMessageInput {
destination_phone_number: self.destination_phone_number,
origination_identity: self.origination_identity,
message_body: self.message_body,
message_body_text_type: self.message_body_text_type,
voice_id: self.voice_id,
configuration_set_name: self.configuration_set_name,
max_price_per_minute: self.max_price_per_minute,
time_to_live: self.time_to_live,
context: self.context,
dry_run: self.dry_run,
protect_configuration_id: self.protect_configuration_id,
message_feedback_enabled: self.message_feedback_enabled,
})
}
}