AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS End User Messaging SendNotifyCodeVerification API operation.

Syntax

Send-EUMNotifyCodeVerification
-Channel <NotifyChannel>
-OverrideCodeConfigurationParameters_CodeLength <Int32>
-OverrideCodeConfigurationParameters_CodeType <CodeType>
-ConfigurationSetName <String>
-Context <Hashtable>
-OverrideChannelParameters_Text_DestinationCountryParameter <Hashtable>
-DestinationIdentity <String>
-OverrideChannelParameters_Text_InlineTemplateBody <String>
-OverrideChannelParameters_Voice_InlineTemplateBody <String>
-OverrideChannelParameters_Voice_LanguageCode <String>
-OverrideChannelParameters_WhatsApp_LanguageCode <String>
-OverrideCodeConfigurationParameters_MaxAttempt <Int32>
-NotifyCodeConfiguration <String>
-OverrideChannelParameters_Notify_NotifyTemplateId <String>
-OriginationIdentity <String>
-ReferenceId <String>
-OverrideCodeConfigurationParameters_ValidityPeriodMinute <Int32>
-OverrideChannelParameters_Notify_VoiceId <String>
-OverrideChannelParameters_Voice_VoiceId <String>
-OverrideChannelParameters_Voice_VoiceMessageBodyTextType <VoiceMessageBodyTextType>
-OverrideChannelParameters_WhatsApp_WhatsAppTemplateName <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonEndUserMessagingConfig>

Description

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.

Parameters

-Channel <NotifyChannel>
The channel used to deliver the one-time passcode to the recipient.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonEndUserMessagingConfig>
Amazon.PowerShell.Cmdlets.EUM.AmazonEndUserMessagingClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConfigurationSetName <String>
The name of the configuration set used to control how delivery events for the message are handled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Context <Hashtable>
A map of custom key and value pairs that are propagated to the delivery events for this verification. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DestinationIdentity <String>
The recipient identifier. For the TEXT and VOICE channels, specify an E.164 phone number. For the WhatsApp channel, specify a WhatsApp address.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NotifyCodeConfiguration <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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OriginationIdentity <String>
The identity used to send the message, such as a phone number, sender ID, or pool that is owned by your account.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-OverrideChannelParameters_Notify_NotifyTemplateId <String>
The identifier of a preapproved notify template for the SMS or voice channels.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OverrideChannelParameters_Notify_VoiceId <String>
The Amazon Polly voice ID used when the notify template is delivered over the voice channel.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OverrideChannelParameters_Text_DestinationCountryParameter <Hashtable>
A map of country-specific parameters that control one-time passcode delivery. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOverrideChannelParameters_Text_DestinationCountryParameters
-OverrideChannelParameters_Text_InlineTemplateBody <String>
The freeform message template used to render the one-time passcode for the SMS or RCS channels. The template must contain the code placeholder.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OverrideChannelParameters_Voice_InlineTemplateBody <String>
The freeform message template used to render the one-time passcode for the voice channel. The template must contain the code placeholder.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OverrideChannelParameters_Voice_LanguageCode <String>
The BCP 47 language code used to render the voice message.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OverrideChannelParameters_Voice_VoiceId <String>
The Amazon Polly voice ID used for the voice channel.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OverrideChannelParameters_Voice_VoiceMessageBodyTextType <VoiceMessageBodyTextType>
The format of the voice message body. Valid values are TEXT and SSML.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OverrideChannelParameters_WhatsApp_LanguageCode <String>
The BCP 47 language code used to render the template. This value is required for the WhatsApp channel.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OverrideChannelParameters_WhatsApp_WhatsAppTemplateName <String>
The name of the Meta-approved WhatsApp authentication template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OverrideCodeConfigurationParameters_CodeLength <Int32>
The number of characters in the one-time passcode. Valid values range from 4 through 8. When you do not specify a value, the default is applied when a passcode is sent.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OverrideCodeConfigurationParameters_CodeType <CodeType>
The character set used to generate the one-time passcode. Valid values are NUMERIC (digits only), ALPHA (uppercase letters only), and ALPHANUMERIC (uppercase letters and digits). When you do not specify a value, the default is applied when a passcode is sent.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OverrideCodeConfigurationParameters_MaxAttempt <Int32>
The maximum number of validation attempts that are allowed before the verification is locked. Valid values range from 1 through 5. When you do not specify a value, the default is applied when a passcode is sent.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOverrideCodeConfigurationParameters_MaxAttempts
-OverrideCodeConfigurationParameters_ValidityPeriodMinute <Int32>
The length of time, in minutes, that the one-time passcode remains valid. Valid values range from 1 through 60. When you do not specify a value, the default is applied when a passcode is sent.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOverrideCodeConfigurationParameters_ValidityPeriodMinutes
-ReferenceId <String>
A caller-supplied reference identifier that binds a send request to a later validate request. Specify the same value in both requests.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EndUserMessaging.Model.SendNotifyCodeVerificationResponse). Specifying the name of a property of type Amazon.EndUserMessaging.Model.SendNotifyCodeVerificationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.EndUserMessaging.Model.SendNotifyCodeVerificationResponse
This cmdlet returns an Amazon.EndUserMessaging.Model.SendNotifyCodeVerificationResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z