Amazon Cognito · JSON Structure

Cognito Idp Custom Sms Lambda Version Config Type Structure

A custom SMS sender Lambda configuration type.

Type: object Properties: 2 Required: 2
AuthenticationAuthorizationIdentityIdentity ProviderOAuth2OIDC

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

Properties

LambdaVersion LambdaArn

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

JSON Structure

Raw ↑ 
{
  "type": "object",
  "properties": {
    "LambdaVersion": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CustomSMSSenderLambdaVersionType"
        },
        {
          "description": "Signature of the \"request\" attribute in the \"event\" information that Amazon Cognito passes to your custom SMS Lambda function. The only supported value is <code>V1_0</code>."
        }
      ]
    },
    "LambdaArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ArnType"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the Lambda function that Amazon Cognito activates to send SMS notifications to users."
        }
      ]
    }
  },
  "required": [
    "LambdaVersion",
    "LambdaArn"
  ],
  "description": "A custom SMS sender Lambda 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-custom-sms-lambda-version-config-type-structure.json",
  "name": "CustomSMSLambdaVersionConfigType"
}