Amazon Cognito · JSON Structure

Cognito Idp Notify Configuration Type Structure

The notify configuration type.

Type: object Properties: 6 Required: 1
AuthenticationAuthorizationIdentityIdentity ProviderOAuth2OIDC

NotifyConfigurationType is a JSON Structure definition published by Amazon Cognito, describing 6 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

From ReplyTo SourceArn BlockEmail NoActionEmail MfaEmail

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

JSON Structure

Raw ↑
{
  "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"
  ],
  "description": "The notify configuration type.",
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aws-cognito/refs/heads/main/json-structure/cognito-idp-notify-configuration-type-structure.json",
  "name": "NotifyConfigurationType"
}