Skip to main content

aws_sdk_endusermessaging/client/
validate_notify_code_verification.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 [`ValidateNotifyCodeVerification`](crate::operation::validate_notify_code_verification::builders::ValidateNotifyCodeVerificationFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`destination_identity(impl Into<String>)`](crate::operation::validate_notify_code_verification::builders::ValidateNotifyCodeVerificationFluentBuilder::destination_identity) / [`set_destination_identity(Option<String>)`](crate::operation::validate_notify_code_verification::builders::ValidateNotifyCodeVerificationFluentBuilder::set_destination_identity):<br>required: **true**<br><p>The recipient identifier. For the TEXT and VOICE channels, specify an E.164 phone number. For the WhatsApp channel, specify a WhatsApp address.</p><br>
7    ///   - [`reference_id(impl Into<String>)`](crate::operation::validate_notify_code_verification::builders::ValidateNotifyCodeVerificationFluentBuilder::reference_id) / [`set_reference_id(Option<String>)`](crate::operation::validate_notify_code_verification::builders::ValidateNotifyCodeVerificationFluentBuilder::set_reference_id):<br>required: **false**<br><p>The caller-supplied reference identifier used to locate the verification. This value must match the value that you supplied to the SendNotifyCodeVerification operation.</p><br>
8    ///   - [`code(impl Into<String>)`](crate::operation::validate_notify_code_verification::builders::ValidateNotifyCodeVerificationFluentBuilder::code) / [`set_code(Option<String>)`](crate::operation::validate_notify_code_verification::builders::ValidateNotifyCodeVerificationFluentBuilder::set_code):<br>required: **true**<br><p>The one-time passcode that the recipient submitted for validation.</p><br>
9    /// - On success, responds with [`ValidateNotifyCodeVerificationOutput`](crate::operation::validate_notify_code_verification::ValidateNotifyCodeVerificationOutput) with field(s):
10    ///   - [`status(VerificationStatus)`](crate::operation::validate_notify_code_verification::ValidateNotifyCodeVerificationOutput::status): <p>The outcome of the validation attempt. VALID indicates that the submitted passcode matched an active verification. INVALID indicates that the passcode did not match, expired, or exceeded its attempt limit.</p>
11    /// - On failure, responds with [`SdkError<ValidateNotifyCodeVerificationError>`](crate::operation::validate_notify_code_verification::ValidateNotifyCodeVerificationError)
12    pub fn validate_notify_code_verification(
13        &self,
14    ) -> crate::operation::validate_notify_code_verification::builders::ValidateNotifyCodeVerificationFluentBuilder {
15        crate::operation::validate_notify_code_verification::builders::ValidateNotifyCodeVerificationFluentBuilder::new(self.handle.clone())
16    }
17}