pub struct SendNotifyCodeVerificationFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to SendNotifyCodeVerification.
Generates a one-time passcode and delivers it to a recipient over the requested channel. The passcode policy is captured from the referenced notify code configuration at the time of the request, so later updates to the configuration do not affect verifications that are already in progress.
Implementations§
Source§impl SendNotifyCodeVerificationFluentBuilder
impl SendNotifyCodeVerificationFluentBuilder
Sourcepub fn as_input(&self) -> &SendNotifyCodeVerificationInputBuilder
pub fn as_input(&self) -> &SendNotifyCodeVerificationInputBuilder
Access the SendNotifyCodeVerification as a reference.
Sourcepub async fn send(
self,
) -> Result<SendNotifyCodeVerificationOutput, SdkError<SendNotifyCodeVerificationError, HttpResponse>>
pub async fn send( self, ) -> Result<SendNotifyCodeVerificationOutput, SdkError<SendNotifyCodeVerificationError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<SendNotifyCodeVerificationOutput, SendNotifyCodeVerificationError, Self>
pub fn customize( self, ) -> CustomizableOperation<SendNotifyCodeVerificationOutput, SendNotifyCodeVerificationError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn channel(self, input: NotifyChannel) -> Self
pub fn channel(self, input: NotifyChannel) -> Self
The channel used to deliver the one-time passcode to the recipient.
Sourcepub fn set_channel(self, input: Option<NotifyChannel>) -> Self
pub fn set_channel(self, input: Option<NotifyChannel>) -> Self
The channel used to deliver the one-time passcode to the recipient.
Sourcepub fn get_channel(&self) -> &Option<NotifyChannel>
pub fn get_channel(&self) -> &Option<NotifyChannel>
The channel used to deliver the one-time passcode to the recipient.
Sourcepub fn destination_identity(self, input: impl Into<String>) -> Self
pub fn destination_identity(self, input: impl Into<String>) -> Self
The recipient identifier. For the TEXT and VOICE channels, specify an E.164 phone number. For the WhatsApp channel, specify a WhatsApp address.
Sourcepub fn set_destination_identity(self, input: Option<String>) -> Self
pub fn set_destination_identity(self, input: Option<String>) -> Self
The recipient identifier. For the TEXT and VOICE channels, specify an E.164 phone number. For the WhatsApp channel, specify a WhatsApp address.
Sourcepub fn get_destination_identity(&self) -> &Option<String>
pub fn get_destination_identity(&self) -> &Option<String>
The recipient identifier. For the TEXT and VOICE channels, specify an E.164 phone number. For the WhatsApp channel, specify a WhatsApp address.
Sourcepub fn origination_identity(self, input: impl Into<String>) -> Self
pub fn origination_identity(self, input: impl Into<String>) -> Self
The identity used to send the message, such as a phone number, sender ID, or pool that is owned by your account.
Sourcepub fn set_origination_identity(self, input: Option<String>) -> Self
pub fn set_origination_identity(self, input: Option<String>) -> Self
The identity used to send the message, such as a phone number, sender ID, or pool that is owned by your account.
Sourcepub fn get_origination_identity(&self) -> &Option<String>
pub fn get_origination_identity(&self) -> &Option<String>
The identity used to send the message, such as a phone number, sender ID, or pool that is owned by your account.
Sourcepub fn notify_code_configuration(self, input: impl Into<String>) -> Self
pub fn notify_code_configuration(self, input: impl Into<String>) -> Self
The identifier or Amazon Resource Name (ARN) of the notify code configuration that supplies the passcode policy and template defaults. When you do not specify a configuration, you must supply the template in the request.
Sourcepub fn set_notify_code_configuration(self, input: Option<String>) -> Self
pub fn set_notify_code_configuration(self, input: Option<String>) -> Self
The identifier or Amazon Resource Name (ARN) of the notify code configuration that supplies the passcode policy and template defaults. When you do not specify a configuration, you must supply the template in the request.
Sourcepub fn get_notify_code_configuration(&self) -> &Option<String>
pub fn get_notify_code_configuration(&self) -> &Option<String>
The identifier or Amazon Resource Name (ARN) of the notify code configuration that supplies the passcode policy and template defaults. When you do not specify a configuration, you must supply the template in the request.
Sourcepub fn override_channel_parameters(self, input: ChannelParameters) -> Self
pub fn override_channel_parameters(self, input: ChannelParameters) -> Self
The channel-specific parameters used to render and deliver the one-time passcode for this request. The route that is derived from the channel and the origination identity selects the matching channel. When you do not specify channel parameters, the service uses the parameters from the referenced notify code configuration.
Sourcepub fn set_override_channel_parameters(
self,
input: Option<ChannelParameters>,
) -> Self
pub fn set_override_channel_parameters( self, input: Option<ChannelParameters>, ) -> Self
The channel-specific parameters used to render and deliver the one-time passcode for this request. The route that is derived from the channel and the origination identity selects the matching channel. When you do not specify channel parameters, the service uses the parameters from the referenced notify code configuration.
Sourcepub fn get_override_channel_parameters(&self) -> &Option<ChannelParameters>
pub fn get_override_channel_parameters(&self) -> &Option<ChannelParameters>
The channel-specific parameters used to render and deliver the one-time passcode for this request. The route that is derived from the channel and the origination identity selects the matching channel. When you do not specify channel parameters, the service uses the parameters from the referenced notify code configuration.
Sourcepub fn override_code_configuration_parameters(
self,
input: CodeConfigurationParameters,
) -> Self
pub fn override_code_configuration_parameters( self, input: CodeConfigurationParameters, ) -> Self
The per-send overrides for the passcode policy parameters, including the code type, length, validity period, and maximum number of attempts. These values override the values from the referenced notify code configuration. When you do not specify a value, the value from the configuration is used, and if neither is set, the service default applies.
Sourcepub fn set_override_code_configuration_parameters(
self,
input: Option<CodeConfigurationParameters>,
) -> Self
pub fn set_override_code_configuration_parameters( self, input: Option<CodeConfigurationParameters>, ) -> Self
The per-send overrides for the passcode policy parameters, including the code type, length, validity period, and maximum number of attempts. These values override the values from the referenced notify code configuration. When you do not specify a value, the value from the configuration is used, and if neither is set, the service default applies.
Sourcepub fn get_override_code_configuration_parameters(
&self,
) -> &Option<CodeConfigurationParameters>
pub fn get_override_code_configuration_parameters( &self, ) -> &Option<CodeConfigurationParameters>
The per-send overrides for the passcode policy parameters, including the code type, length, validity period, and maximum number of attempts. These values override the values from the referenced notify code configuration. When you do not specify a value, the value from the configuration is used, and if neither is set, the service default applies.
Sourcepub fn configuration_set_name(self, input: impl Into<String>) -> Self
pub fn configuration_set_name(self, input: impl Into<String>) -> Self
The name of the configuration set used to control how delivery events for the message are handled.
Sourcepub fn set_configuration_set_name(self, input: Option<String>) -> Self
pub fn set_configuration_set_name(self, input: Option<String>) -> Self
The name of the configuration set used to control how delivery events for the message are handled.
Sourcepub fn get_configuration_set_name(&self) -> &Option<String>
pub fn get_configuration_set_name(&self) -> &Option<String>
The name of the configuration set used to control how delivery events for the message are handled.
Sourcepub fn context(self, k: impl Into<String>, v: impl Into<String>) -> Self
pub fn context(self, k: impl Into<String>, v: impl Into<String>) -> Self
Adds a key-value pair to context.
To override the contents of this collection use set_context.
A map of custom key and value pairs that are propagated to the delivery events for this verification.
Sourcepub fn set_context(self, input: Option<HashMap<String, String>>) -> Self
pub fn set_context(self, input: Option<HashMap<String, String>>) -> Self
A map of custom key and value pairs that are propagated to the delivery events for this verification.
Sourcepub fn get_context(&self) -> &Option<HashMap<String, String>>
pub fn get_context(&self) -> &Option<HashMap<String, String>>
A map of custom key and value pairs that are propagated to the delivery events for this verification.
Sourcepub fn reference_id(self, input: impl Into<String>) -> Self
pub fn reference_id(self, input: impl Into<String>) -> Self
A caller-supplied reference identifier that binds a send request to a later validate request. Specify the same value in both requests.
Sourcepub fn set_reference_id(self, input: Option<String>) -> Self
pub fn set_reference_id(self, input: Option<String>) -> Self
A caller-supplied reference identifier that binds a send request to a later validate request. Specify the same value in both requests.
Sourcepub fn get_reference_id(&self) -> &Option<String>
pub fn get_reference_id(&self) -> &Option<String>
A caller-supplied reference identifier that binds a send request to a later validate request. Specify the same value in both requests.
Trait Implementations§
Auto Trait Implementations§
impl !RefUnwindSafe for SendNotifyCodeVerificationFluentBuilder
impl !UnwindSafe for SendNotifyCodeVerificationFluentBuilder
impl Freeze for SendNotifyCodeVerificationFluentBuilder
impl Send for SendNotifyCodeVerificationFluentBuilder
impl Sync for SendNotifyCodeVerificationFluentBuilder
impl Unpin for SendNotifyCodeVerificationFluentBuilder
impl UnsafeUnpin for SendNotifyCodeVerificationFluentBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);