Amazon Cognito · Schema

NotifyConfigurationType

The notify configuration type.

AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity

Properties

Name Type Description
From object
ReplyTo object
SourceArn object
BlockEmail object
NoActionEmail object
MfaEmail object
View JSON Schema on GitHub

JSON Schema

user-pools-notify-configuration-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-notify-configuration-type-schema.json",
  "title": "NotifyConfigurationType",
  "description": "The notify configuration type.",
  "type": "object",
  "properties": {
    "From": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StringType"
        },
        {
          "description": "The email address that is sending the email. The address must be either individually verified with Amazon Simple Email Service, or from a domain that has been verified with Amazon SES."
        }
      ]
    },
    "ReplyTo": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StringType"
        },
        {
          "description": "The destination to which the receiver of an email should reply to."
        }
      ]
    },
    "SourceArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ArnType"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the identity that is associated with the sending authorization policy. This identity permits Amazon Cognito to send for the email address specified in the <code>From</code> parameter."
        }
      ]
    },
    "BlockEmail": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NotifyEmailType"
        },
        {
          "description": "Email template used when a detected risk event is blocked."
        }
      ]
    },
    "NoActionEmail": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NotifyEmailType"
        },
        {
          "description": "The email template used when a detected risk event is allowed."
        }
      ]
    },
    "MfaEmail": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NotifyEmailType"
        },
        {
          "description": "The multi-factor authentication (MFA) email template used when MFA is challenged as part of a detected risk."
        }
      ]
    }
  },
  "required": [
    "SourceArn"
  ]
}