Amazon Cognito · JSON Structure

User Pools Code Delivery Details Type Structure

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

Type: object Properties: 3
AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity

CodeDeliveryDetailsType is a JSON Structure definition published by Amazon Cognito, describing 3 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

Destination DeliveryMedium AttributeName

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-cognito/refs/heads/main/json-structure/user-pools-code-delivery-details-type-structure.json",
  "name": "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."
        }
      ]
    }
  }
}