Amazon Cognito · Schema

CodeDeliveryDetailsType

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

AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity

Properties

Name Type Description
Destination object
DeliveryMedium object
AttributeName object
View JSON Schema on GitHub

JSON Schema

user-pools-code-delivery-details-type-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-cognito/refs/heads/main/json-schema/user-pools-code-delivery-details-type-schema.json",
  "title": "CodeDeliveryDetailsType",
  "description": "The delivery details for an email or SMS message that Amazon Cognito sent for authentication or verification.",
  "type": "object",
  "properties": {
    "Destination": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StringType"
        },
        {
          "description": "The email address or phone number destination where Amazon Cognito sent the code."
        }
      ]
    },
    "DeliveryMedium": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DeliveryMediumType"
        },
        {
          "description": "The method that Amazon Cognito used to send the code."
        }
      ]
    },
    "AttributeName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AttributeNameType"
        },
        {
          "description": "The name of the attribute that Amazon Cognito verifies with the code."
        }
      ]
    }
  }
}