aws_sdk_pinpointsmsvoicev2/client/send_destination_number_verification_code.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`SendDestinationNumberVerificationCode`](crate::operation::send_destination_number_verification_code::builders::SendDestinationNumberVerificationCodeFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`verified_destination_number_id(impl Into<String>)`](crate::operation::send_destination_number_verification_code::builders::SendDestinationNumberVerificationCodeFluentBuilder::verified_destination_number_id) / [`set_verified_destination_number_id(Option<String>)`](crate::operation::send_destination_number_verification_code::builders::SendDestinationNumberVerificationCodeFluentBuilder::set_verified_destination_number_id):<br>required: **true**<br><p>The unique identifier for the verified destination phone number.</p><br>
7 /// - [`verification_channel(VerificationChannel)`](crate::operation::send_destination_number_verification_code::builders::SendDestinationNumberVerificationCodeFluentBuilder::verification_channel) / [`set_verification_channel(Option<VerificationChannel>)`](crate::operation::send_destination_number_verification_code::builders::SendDestinationNumberVerificationCodeFluentBuilder::set_verification_channel):<br>required: **true**<br><p>Choose to send the verification code as an SMS or voice message.</p><br>
8 /// - [`language_code(LanguageCode)`](crate::operation::send_destination_number_verification_code::builders::SendDestinationNumberVerificationCodeFluentBuilder::language_code) / [`set_language_code(Option<LanguageCode>)`](crate::operation::send_destination_number_verification_code::builders::SendDestinationNumberVerificationCodeFluentBuilder::set_language_code):<br>required: **false**<br><p>Choose the language to use for the message.</p><br>
9 /// - [`origination_identity(impl Into<String>)`](crate::operation::send_destination_number_verification_code::builders::SendDestinationNumberVerificationCodeFluentBuilder::origination_identity) / [`set_origination_identity(Option<String>)`](crate::operation::send_destination_number_verification_code::builders::SendDestinationNumberVerificationCodeFluentBuilder::set_origination_identity):<br>required: **false**<br><p>The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, 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>
10 /// - [`configuration_set_name(impl Into<String>)`](crate::operation::send_destination_number_verification_code::builders::SendDestinationNumberVerificationCodeFluentBuilder::configuration_set_name) / [`set_configuration_set_name(Option<String>)`](crate::operation::send_destination_number_verification_code::builders::SendDestinationNumberVerificationCodeFluentBuilder::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>
11 /// - [`context(impl Into<String>, impl Into<String>)`](crate::operation::send_destination_number_verification_code::builders::SendDestinationNumberVerificationCodeFluentBuilder::context) / [`set_context(Option<HashMap::<String, String>>)`](crate::operation::send_destination_number_verification_code::builders::SendDestinationNumberVerificationCodeFluentBuilder::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>
12 /// - [`destination_country_parameters(DestinationCountryParameterKey, impl Into<String>)`](crate::operation::send_destination_number_verification_code::builders::SendDestinationNumberVerificationCodeFluentBuilder::destination_country_parameters) / [`set_destination_country_parameters(Option<HashMap::<DestinationCountryParameterKey, String>>)`](crate::operation::send_destination_number_verification_code::builders::SendDestinationNumberVerificationCodeFluentBuilder::set_destination_country_parameters):<br>required: **false**<br><p>This field is used for any country-specific registration requirements. Currently, this setting is only used when you send messages to recipients in India using a sender ID. For more information see <a href="https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-senderid-india.html">Special requirements for sending SMS messages to recipients in India</a>.</p><br>
13 /// - On success, responds with [`SendDestinationNumberVerificationCodeOutput`](crate::operation::send_destination_number_verification_code::SendDestinationNumberVerificationCodeOutput) with field(s):
14 /// - [`message_id(String)`](crate::operation::send_destination_number_verification_code::SendDestinationNumberVerificationCodeOutput::message_id): <p>The unique identifier for the message.</p>
15 /// - On failure, responds with [`SdkError<SendDestinationNumberVerificationCodeError>`](crate::operation::send_destination_number_verification_code::SendDestinationNumberVerificationCodeError)
16 pub fn send_destination_number_verification_code(
17 &self,
18 ) -> crate::operation::send_destination_number_verification_code::builders::SendDestinationNumberVerificationCodeFluentBuilder {
19 crate::operation::send_destination_number_verification_code::builders::SendDestinationNumberVerificationCodeFluentBuilder::new(
20 self.handle.clone(),
21 )
22 }
23}