View a markdown version of this page

NotifyCodeConfiguration - AWS End User Messaging

NotifyCodeConfiguration

Contains the settings of a notify code configuration, which is a reusable one-time passcode policy.

Contents

createdAt

The time when the resource was created, in Unix epoch time.

Type: Timestamp

Required: Yes

deletionProtectionEnabled

Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.

Type: Boolean

Required: Yes

notifyCodeConfigurationArn

The Amazon Resource Name (ARN) of the notify code configuration.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 256.

Pattern: arn:[A-Za-z0-9_:/-]+

Required: Yes

notifyCodeConfigurationId

The unique identifier of the notify code configuration.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [A-Za-z0-9_-]+

Required: Yes

notifyCodeConfigurationName

The name of the notify code configuration.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [A-Za-z0-9_ -]*[A-Za-z0-9_-][A-Za-z0-9_ -]*

Required: Yes

updatedAt

The time when the resource was last updated, in Unix epoch time.

Type: Timestamp

Required: Yes

channelParameters

The channel-specific parameters used to render and deliver the one-time passcode. A configuration can carry parameters for every channel at once, and the send route selects the matching channel at send time.

Type: ChannelParameters object

Required: No

codeConfigurationParameters

The passcode policy parameters, including the code type, length, validity period, and maximum number of attempts.

Type: CodeConfigurationParameters object

Required: No

See Also

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