aws_sdk_pinpointsmsvoicev2/client/

send_voice_message.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`SendVoiceMessage`](crate::operation::send_voice_message::builders::SendVoiceMessageFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`destination_phone_number(impl Into<String>)`](crate::operation::send_voice_message::builders::SendVoiceMessageFluentBuilder::destination_phone_number) / [`set_destination_phone_number(Option<String>)`](crate::operation::send_voice_message::builders::SendVoiceMessageFluentBuilder::set_destination_phone_number):<br>required: **true**<br><p>The destination phone number in E.164 format.</p><br>
    ///   - [`origination_identity(impl Into<String>)`](crate::operation::send_voice_message::builders::SendVoiceMessageFluentBuilder::origination_identity) / [`set_origination_identity(Option<String>)`](crate::operation::send_voice_message::builders::SendVoiceMessageFluentBuilder::set_origination_identity):<br>required: **true**<br><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 AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).</p> </important><br>
    ///   - [`message_body(impl Into<String>)`](crate::operation::send_voice_message::builders::SendVoiceMessageFluentBuilder::message_body) / [`set_message_body(Option<String>)`](crate::operation::send_voice_message::builders::SendVoiceMessageFluentBuilder::set_message_body):<br>required: **false**<br><p>The text to convert to a voice message.</p><br>
    ///   - [`message_body_text_type(VoiceMessageBodyTextType)`](crate::operation::send_voice_message::builders::SendVoiceMessageFluentBuilder::message_body_text_type) / [`set_message_body_text_type(Option<VoiceMessageBodyTextType>)`](crate::operation::send_voice_message::builders::SendVoiceMessageFluentBuilder::set_message_body_text_type):<br>required: **false**<br><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><br>
    ///   - [`voice_id(VoiceId)`](crate::operation::send_voice_message::builders::SendVoiceMessageFluentBuilder::voice_id) / [`set_voice_id(Option<VoiceId>)`](crate::operation::send_voice_message::builders::SendVoiceMessageFluentBuilder::set_voice_id):<br>required: **false**<br><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><br>
    ///   - [`configuration_set_name(impl Into<String>)`](crate::operation::send_voice_message::builders::SendVoiceMessageFluentBuilder::configuration_set_name) / [`set_configuration_set_name(Option<String>)`](crate::operation::send_voice_message::builders::SendVoiceMessageFluentBuilder::set_configuration_set_name):<br>required: **false**<br><p>The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.</p><br>
    ///   - [`max_price_per_minute(impl Into<String>)`](crate::operation::send_voice_message::builders::SendVoiceMessageFluentBuilder::max_price_per_minute) / [`set_max_price_per_minute(Option<String>)`](crate::operation::send_voice_message::builders::SendVoiceMessageFluentBuilder::set_max_price_per_minute):<br>required: **false**<br><p>The maximum amount to spend per voice message, in US dollars.</p><br>
    ///   - [`time_to_live(i32)`](crate::operation::send_voice_message::builders::SendVoiceMessageFluentBuilder::time_to_live) / [`set_time_to_live(Option<i32>)`](crate::operation::send_voice_message::builders::SendVoiceMessageFluentBuilder::set_time_to_live):<br>required: **false**<br><p>How long the voice message is valid for. By default this is 72 hours.</p><br>
    ///   - [`context(impl Into<String>, impl Into<String>)`](crate::operation::send_voice_message::builders::SendVoiceMessageFluentBuilder::context) / [`set_context(Option<HashMap::<String, String>>)`](crate::operation::send_voice_message::builders::SendVoiceMessageFluentBuilder::set_context):<br>required: **false**<br><p>You can specify custom data in this field. If you do, that data is logged to the event destination.</p><br>
    ///   - [`dry_run(bool)`](crate::operation::send_voice_message::builders::SendVoiceMessageFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::send_voice_message::builders::SendVoiceMessageFluentBuilder::set_dry_run):<br>required: **false**<br><p>When set to true, the message is checked and validated, but isn't sent to the end recipient.</p><br>
    ///   - [`protect_configuration_id(impl Into<String>)`](crate::operation::send_voice_message::builders::SendVoiceMessageFluentBuilder::protect_configuration_id) / [`set_protect_configuration_id(Option<String>)`](crate::operation::send_voice_message::builders::SendVoiceMessageFluentBuilder::set_protect_configuration_id):<br>required: **false**<br><p>The unique identifier for the protect configuration.</p><br>
    ///   - [`message_feedback_enabled(bool)`](crate::operation::send_voice_message::builders::SendVoiceMessageFluentBuilder::message_feedback_enabled) / [`set_message_feedback_enabled(Option<bool>)`](crate::operation::send_voice_message::builders::SendVoiceMessageFluentBuilder::set_message_feedback_enabled):<br>required: **false**<br><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><br>
    /// - On success, responds with [`SendVoiceMessageOutput`](crate::operation::send_voice_message::SendVoiceMessageOutput) with field(s):
    ///   - [`message_id(Option<String>)`](crate::operation::send_voice_message::SendVoiceMessageOutput::message_id): <p>The unique identifier for the message.</p>
    /// - On failure, responds with [`SdkError<SendVoiceMessageError>`](crate::operation::send_voice_message::SendVoiceMessageError)
    pub fn send_voice_message(&self) -> crate::operation::send_voice_message::builders::SendVoiceMessageFluentBuilder {
        crate::operation::send_voice_message::builders::SendVoiceMessageFluentBuilder::new(self.handle.clone())
    }
}