CodeDeliveryDetailsType - Amazon Cognito User Pools

CodeDeliveryDetailsType

The delivery details for an email or SMS message that Amazon Cognito sent for authentication or verification.

This data type is a response parameter of operations that send a code for user profile confirmation, verification, or management, for example ForgotPassword and SignUp.

Contents

AttributeName

The name of the attribute that Amazon Cognito verifies with the code.

Type: String

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

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Required: No

DeliveryMedium

The method that Amazon Cognito used to send the code.

Type: String

Valid Values: SMS | EMAIL

Required: No

Destination

The email address or phone number destination where Amazon Cognito sent the code.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 131072.

Required: No

See Also

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