View a markdown version of this page

CodeConfigurationParameters - AWS End User Messaging

CodeConfigurationParameters

The passcode policy parameters that are grouped for reuse across a notify code configuration and its create request. Each member is optional. When you omit a member on a create request, no value is applied at create time and the default is applied when a passcode is sent.

Contents

codeLength

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.

Type: Integer

Valid Range: Minimum value of 4. Maximum value of 8.

Required: No

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.

Type: String

Valid Values: NUMERIC | ALPHA | ALPHANUMERIC

Required: No

maxAttempts

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.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 5.

Required: No

validityPeriodMinutes

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.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 60.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: