Skip to content

aws.lexv2_models.describe_intent

Example SQL Queries

SELECT * FROM
aws.lexv2_models.describe_intent
WHERE
"intent_id" = 'VALUE'
AND "bot_id" = 'VALUE'
AND "bot_version" = 'VALUE'
AND "locale_id" = 'VALUE';

Description

Returns metadata about an intent.

Table Definition

Column NameColumn Data Type
bot_id Required Input Column

The identifier of the bot associated with the intent.

VARCHAR
bot_version Required Input Column

The version of the bot associated with the intent.

VARCHAR
intent_id Required Input Column

The unique identifier assigned to the intent when it was created.

VARCHAR
locale_id Required Input Column

The language and locale specified for the intent.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

creation_date_time

A timestamp of the date and time that the intent was created.

TIMESTAMP_S
description

The description of the intent.

VARCHAR
dialog_code_hook

The Lambda function called during each turn of a conversation with the intent.

STRUCT(
"enabled" BOOLEAN
)
Show child fields
dialog_code_hook.enabled

Enables the dialog code hook so that it processes user requests.

fulfillment_code_hook

The Lambda function called when the intent is complete and ready for fulfillment.

STRUCT(
"enabled" BOOLEAN,
"post_fulfillment_status_specification" STRUCT(
"success_response" STRUCT(
"message_groups" STRUCT(
"message" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
),
"variations" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
)[]
)[],
"allow_interrupt" BOOLEAN
),
"failure_response" STRUCT(
"message_groups" STRUCT(
"message" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
),
"variations" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
)[]
)[],
"allow_interrupt" BOOLEAN
),
"timeout_response" STRUCT(
"message_groups" STRUCT(
"message" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
),
"variations" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
)[]
)[],
"allow_interrupt" BOOLEAN
),
"success_next_step" STRUCT(
"dialog_action" STRUCT(
"type" VARCHAR,
"slot_to_elicit" VARCHAR,
"suppress_next_message" BOOLEAN
),
"intent" STRUCT(
"name" VARCHAR,
"slots" MAP(VARCHAR, STRUCT(
"shape" VARCHAR,
"value" STRUCT(
"interpreted_value" VARCHAR
)
))
),
"session_attributes" MAP(VARCHAR, VARCHAR)
),
"success_conditional" STRUCT(
"active" BOOLEAN,
"conditional_branches" STRUCT(
"name" VARCHAR,
"condition" STRUCT(
"expression_string" VARCHAR
),
"next_step" STRUCT(
"dialog_action" STRUCT(
"type" VARCHAR,
"slot_to_elicit" VARCHAR,
"suppress_next_message" BOOLEAN
),
"intent" STRUCT(
"name" VARCHAR,
"slots" MAP(VARCHAR, STRUCT(
"shape" VARCHAR,
"value" STRUCT(
"interpreted_value" VARCHAR
)
))
),
"session_attributes" MAP(VARCHAR, VARCHAR)
),
"response" STRUCT(
"message_groups" STRUCT(
"message" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
),
"variations" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
)[]
)[],
"allow_interrupt" BOOLEAN
)
)[],
"default_branch" STRUCT(
"next_step" STRUCT(
"dialog_action" STRUCT(
"type" VARCHAR,
"slot_to_elicit" VARCHAR,
"suppress_next_message" BOOLEAN
),
"intent" STRUCT(
"name" VARCHAR,
"slots" MAP(VARCHAR, STRUCT(
"shape" VARCHAR,
"value" STRUCT(
"interpreted_value" VARCHAR
)
))
),
"session_attributes" MAP(VARCHAR, VARCHAR)
),
"response" STRUCT(
"message_groups" STRUCT(
"message" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
),
"variations" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
)[]
)[],
"allow_interrupt" BOOLEAN
)
)
),
"failure_next_step" STRUCT(
"dialog_action" STRUCT(
"type" VARCHAR,
"slot_to_elicit" VARCHAR,
"suppress_next_message" BOOLEAN
),
"intent" STRUCT(
"name" VARCHAR,
"slots" MAP(VARCHAR, STRUCT(
"shape" VARCHAR,
"value" STRUCT(
"interpreted_value" VARCHAR
)
))
),
"session_attributes" MAP(VARCHAR, VARCHAR)
),
"failure_conditional" STRUCT(
"active" BOOLEAN,
"conditional_branches" STRUCT(
"name" VARCHAR,
"condition" STRUCT(
"expression_string" VARCHAR
),
"next_step" STRUCT(
"dialog_action" STRUCT(
"type" VARCHAR,
"slot_to_elicit" VARCHAR,
"suppress_next_message" BOOLEAN
),
"intent" STRUCT(
"name" VARCHAR,
"slots" MAP(VARCHAR, STRUCT(
"shape" VARCHAR,
"value" STRUCT(
"interpreted_value" VARCHAR
)
))
),
"session_attributes" MAP(VARCHAR, VARCHAR)
),
"response" STRUCT(
"message_groups" STRUCT(
"message" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
),
"variations" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
)[]
)[],
"allow_interrupt" BOOLEAN
)
)[],
"default_branch" STRUCT(
"next_step" STRUCT(
"dialog_action" STRUCT(
"type" VARCHAR,
"slot_to_elicit" VARCHAR,
"suppress_next_message" BOOLEAN
),
"intent" STRUCT(
"name" VARCHAR,
"slots" MAP(VARCHAR, STRUCT(
"shape" VARCHAR,
"value" STRUCT(
"interpreted_value" VARCHAR
)
))
),
"session_attributes" MAP(VARCHAR, VARCHAR)
),
"response" STRUCT(
"message_groups" STRUCT(
"message" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
),
"variations" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
)[]
)[],
"allow_interrupt" BOOLEAN
)
)
),
"timeout_next_step" STRUCT(
"dialog_action" STRUCT(
"type" VARCHAR,
"slot_to_elicit" VARCHAR,
"suppress_next_message" BOOLEAN
),
"intent" STRUCT(
"name" VARCHAR,
"slots" MAP(VARCHAR, STRUCT(
"shape" VARCHAR,
"value" STRUCT(
"interpreted_value" VARCHAR
)
))
),
"session_attributes" MAP(VARCHAR, VARCHAR)
),
"timeout_conditional" STRUCT(
"active" BOOLEAN,
"conditional_branches" STRUCT(
"name" VARCHAR,
"condition" STRUCT(
"expression_string" VARCHAR
),
"next_step" STRUCT(
"dialog_action" STRUCT(
"type" VARCHAR,
"slot_to_elicit" VARCHAR,
"suppress_next_message" BOOLEAN
),
"intent" STRUCT(
"name" VARCHAR,
"slots" MAP(VARCHAR, STRUCT(
"shape" VARCHAR,
"value" STRUCT(
"interpreted_value" VARCHAR
)
))
),
"session_attributes" MAP(VARCHAR, VARCHAR)
),
"response" STRUCT(
"message_groups" STRUCT(
"message" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
),
"variations" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
)[]
)[],
"allow_interrupt" BOOLEAN
)
)[],
"default_branch" STRUCT(
"next_step" STRUCT(
"dialog_action" STRUCT(
"type" VARCHAR,
"slot_to_elicit" VARCHAR,
"suppress_next_message" BOOLEAN
),
"intent" STRUCT(
"name" VARCHAR,
"slots" MAP(VARCHAR, STRUCT(
"shape" VARCHAR,
"value" STRUCT(
"interpreted_value" VARCHAR
)
))
),
"session_attributes" MAP(VARCHAR, VARCHAR)
),
"response" STRUCT(
"message_groups" STRUCT(
"message" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
),
"variations" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
)[]
)[],
"allow_interrupt" BOOLEAN
)
)
)
),
"fulfillment_updates_specification" STRUCT(
"active" BOOLEAN,
"start_response" STRUCT(
"delay_in_seconds" BIGINT,
"message_groups" STRUCT(
"message" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
),
"variations" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
)[]
)[],
"allow_interrupt" BOOLEAN
),
"update_response" STRUCT(
"frequency_in_seconds" BIGINT,
"message_groups" STRUCT(
"message" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
),
"variations" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
)[]
)[],
"allow_interrupt" BOOLEAN
),
"timeout_in_seconds" BIGINT
),
"active" BOOLEAN
)
Show child fields
fulfillment_code_hook.active

Determines whether the fulfillment code hook is used. When active is false, the code hook doesn't run.

fulfillment_code_hook.enabled

Indicates whether a Lambda function should be invoked to fulfill a specific intent.

fulfillment_code_hook.fulfillment_updates_specification

Provides settings for update messages sent to the user for long-running Lambda fulfillment functions. Fulfillment updates can be used only with streaming conversations.

Show child fields
fulfillment_code_hook.fulfillment_updates_specification.active

Determines whether fulfillment updates are sent to the user. When this field is true, updates are sent.

If the active field is set to true, the startResponse, updateResponse, and timeoutInSeconds fields are required.

fulfillment_code_hook.fulfillment_updates_specification.start_response

Provides configuration information for the message sent to users when the fulfillment Lambda functions starts running.

Show child fields
fulfillment_code_hook.fulfillment_updates_specification.start_response.allow_interrupt

Determines whether the user can interrupt the start message while it is playing.

fulfillment_code_hook.fulfillment_updates_specification.start_response.delay_in_seconds

The delay between when the Lambda fulfillment function starts running and the start message is played. If the Lambda function returns before the delay is over, the start message isn't played.

fulfillment_code_hook.fulfillment_updates_specification.start_response.message_groups[]
Show child fields
fulfillment_code_hook.fulfillment_updates_specification.start_response.message_groups[].message

The primary message that Amazon Lex should send to the user.

Show child fields
fulfillment_code_hook.fulfillment_updates_specification.start_response.message_groups[].message.custom_payload

A message in a custom format defined by the client application.

Show child fields
fulfillment_code_hook.fulfillment_updates_specification.start_response.message_groups[].message.custom_payload.value

The string that is sent to your application.

fulfillment_code_hook.fulfillment_updates_specification.start_response.message_groups[].message.image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
fulfillment_code_hook.fulfillment_updates_specification.start_response.message_groups[].message.image_response_card.buttons[]
Show child fields
fulfillment_code_hook.fulfillment_updates_specification.start_response.message_groups[].message.image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

fulfillment_code_hook.fulfillment_updates_specification.start_response.message_groups[].message.image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

fulfillment_code_hook.fulfillment_updates_specification.start_response.message_groups[].message.image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

fulfillment_code_hook.fulfillment_updates_specification.start_response.message_groups[].message.image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

fulfillment_code_hook.fulfillment_updates_specification.start_response.message_groups[].message.image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

fulfillment_code_hook.fulfillment_updates_specification.start_response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
fulfillment_code_hook.fulfillment_updates_specification.start_response.message_groups[].message.plain_text_message.value

The message to send to the user.

fulfillment_code_hook.fulfillment_updates_specification.start_response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
fulfillment_code_hook.fulfillment_updates_specification.start_response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

fulfillment_code_hook.fulfillment_updates_specification.start_response.message_groups[].variations[]
Show child fields
fulfillment_code_hook.fulfillment_updates_specification.start_response.message_groups[].variations[].custom_payload

A message in a custom format defined by the client application.

Show child fields
fulfillment_code_hook.fulfillment_updates_specification.start_response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

fulfillment_code_hook.fulfillment_updates_specification.start_response.message_groups[].variations[].image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
fulfillment_code_hook.fulfillment_updates_specification.start_response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
fulfillment_code_hook.fulfillment_updates_specification.start_response.message_groups[].variations[].image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

fulfillment_code_hook.fulfillment_updates_specification.start_response.message_groups[].variations[].image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

fulfillment_code_hook.fulfillment_updates_specification.start_response.message_groups[].variations[].image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

fulfillment_code_hook.fulfillment_updates_specification.start_response.message_groups[].variations[].image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

fulfillment_code_hook.fulfillment_updates_specification.start_response.message_groups[].variations[].image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

fulfillment_code_hook.fulfillment_updates_specification.start_response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
fulfillment_code_hook.fulfillment_updates_specification.start_response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

fulfillment_code_hook.fulfillment_updates_specification.start_response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
fulfillment_code_hook.fulfillment_updates_specification.start_response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

fulfillment_code_hook.fulfillment_updates_specification.timeout_in_seconds

The length of time that the fulfillment Lambda function should run before it times out.

fulfillment_code_hook.fulfillment_updates_specification.update_response

Provides configuration information for messages sent periodically to the user while the fulfillment Lambda function is running.

Show child fields
fulfillment_code_hook.fulfillment_updates_specification.update_response.allow_interrupt

Determines whether the user can interrupt an update message while it is playing.

fulfillment_code_hook.fulfillment_updates_specification.update_response.frequency_in_seconds

The frequency that a message is sent to the user. When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user. If the fulfillment Lambda returns before the first period ends, an update message is not played to the user.

fulfillment_code_hook.fulfillment_updates_specification.update_response.message_groups[]
Show child fields
fulfillment_code_hook.fulfillment_updates_specification.update_response.message_groups[].message

The primary message that Amazon Lex should send to the user.

Show child fields
fulfillment_code_hook.fulfillment_updates_specification.update_response.message_groups[].message.custom_payload

A message in a custom format defined by the client application.

Show child fields
fulfillment_code_hook.fulfillment_updates_specification.update_response.message_groups[].message.custom_payload.value

The string that is sent to your application.

fulfillment_code_hook.fulfillment_updates_specification.update_response.message_groups[].message.image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
fulfillment_code_hook.fulfillment_updates_specification.update_response.message_groups[].message.image_response_card.buttons[]
Show child fields
fulfillment_code_hook.fulfillment_updates_specification.update_response.message_groups[].message.image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

fulfillment_code_hook.fulfillment_updates_specification.update_response.message_groups[].message.image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

fulfillment_code_hook.fulfillment_updates_specification.update_response.message_groups[].message.image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

fulfillment_code_hook.fulfillment_updates_specification.update_response.message_groups[].message.image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

fulfillment_code_hook.fulfillment_updates_specification.update_response.message_groups[].message.image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

fulfillment_code_hook.fulfillment_updates_specification.update_response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
fulfillment_code_hook.fulfillment_updates_specification.update_response.message_groups[].message.plain_text_message.value

The message to send to the user.

fulfillment_code_hook.fulfillment_updates_specification.update_response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
fulfillment_code_hook.fulfillment_updates_specification.update_response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

fulfillment_code_hook.fulfillment_updates_specification.update_response.message_groups[].variations[]
Show child fields
fulfillment_code_hook.fulfillment_updates_specification.update_response.message_groups[].variations[].custom_payload

A message in a custom format defined by the client application.

Show child fields
fulfillment_code_hook.fulfillment_updates_specification.update_response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

fulfillment_code_hook.fulfillment_updates_specification.update_response.message_groups[].variations[].image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
fulfillment_code_hook.fulfillment_updates_specification.update_response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
fulfillment_code_hook.fulfillment_updates_specification.update_response.message_groups[].variations[].image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

fulfillment_code_hook.fulfillment_updates_specification.update_response.message_groups[].variations[].image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

fulfillment_code_hook.fulfillment_updates_specification.update_response.message_groups[].variations[].image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

fulfillment_code_hook.fulfillment_updates_specification.update_response.message_groups[].variations[].image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

fulfillment_code_hook.fulfillment_updates_specification.update_response.message_groups[].variations[].image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

fulfillment_code_hook.fulfillment_updates_specification.update_response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
fulfillment_code_hook.fulfillment_updates_specification.update_response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

fulfillment_code_hook.fulfillment_updates_specification.update_response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
fulfillment_code_hook.fulfillment_updates_specification.update_response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

fulfillment_code_hook.post_fulfillment_status_specification

Provides settings for messages sent to the user for after the Lambda fulfillment function completes. Post-fulfillment messages can be sent for both streaming and non-streaming conversations.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional

A list of conditional branches to evaluate after the fulfillment code hook throws an exception or returns with the State field of the Intent object set to Failed.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.active

Determines whether a conditional branch is active. When active is false, the conditions are not evaluated.

fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.conditional_branches[]
Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.conditional_branches[].condition

Contains the expression to evaluate. If the condition is true, the branch's actions are taken.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.conditional_branches[].condition.expression_string

The expression string that is evaluated.

fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.conditional_branches[].name

The name of the branch.

fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.conditional_branches[].next_step

The next step in the conversation.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.conditional_branches[].next_step.dialog_action

Defines the action that the bot executes at runtime when the conversation reaches this step.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.conditional_branches[].next_step.dialog_action.slot_to_elicit

If the dialog action is ElicitSlot, defines the slot to elicit from the user.

fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.conditional_branches[].next_step.dialog_action.suppress_next_message

When true the next message for the intent is not used.

fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.conditional_branches[].next_step.dialog_action.type

The action that the bot should execute.

fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.conditional_branches[].next_step.intent

Override settings to configure the intent state.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.conditional_branches[].next_step.intent.name

The name of the intent. Only required when you're switching intents.

fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.conditional_branches[].next_step.intent.slots

A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.

fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.conditional_branches[].next_step.session_attributes

Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.conditional_branches[].response

Specifies a list of message groups that Amazon Lex uses to respond the user input.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.conditional_branches[].response.allow_interrupt

Indicates whether the user can interrupt a speech response from Amazon Lex.

fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.conditional_branches[].response.message_groups[]
Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.conditional_branches[].response.message_groups[].message

The primary message that Amazon Lex should send to the user.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.conditional_branches[].response.message_groups[].message.custom_payload

A message in a custom format defined by the client application.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.conditional_branches[].response.message_groups[].message.custom_payload.value

The string that is sent to your application.

fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.conditional_branches[].response.message_groups[].message.image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.conditional_branches[].response.message_groups[].message.image_response_card.buttons[]
Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.conditional_branches[].response.message_groups[].message.image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.conditional_branches[].response.message_groups[].message.image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.conditional_branches[].response.message_groups[].message.image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.conditional_branches[].response.message_groups[].message.image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.conditional_branches[].response.message_groups[].message.image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.conditional_branches[].response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.conditional_branches[].response.message_groups[].message.plain_text_message.value

The message to send to the user.

fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.conditional_branches[].response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.conditional_branches[].response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.conditional_branches[].response.message_groups[].variations[]
Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.conditional_branches[].response.message_groups[].variations[].custom_payload

A message in a custom format defined by the client application.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.conditional_branches[].response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.conditional_branches[].response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.conditional_branches[].response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.conditional_branches[].response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.conditional_branches[].response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.default_branch

The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.default_branch.next_step

The next step in the conversation.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.default_branch.next_step.dialog_action

Defines the action that the bot executes at runtime when the conversation reaches this step.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.default_branch.next_step.dialog_action.slot_to_elicit

If the dialog action is ElicitSlot, defines the slot to elicit from the user.

fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.default_branch.next_step.dialog_action.suppress_next_message

When true the next message for the intent is not used.

fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.default_branch.next_step.dialog_action.type

The action that the bot should execute.

fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.default_branch.next_step.intent

Override settings to configure the intent state.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.default_branch.next_step.intent.name

The name of the intent. Only required when you're switching intents.

fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.default_branch.next_step.intent.slots

A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.

fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.default_branch.next_step.session_attributes

Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.default_branch.response

Specifies a list of message groups that Amazon Lex uses to respond the user input.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.default_branch.response.allow_interrupt

Indicates whether the user can interrupt a speech response from Amazon Lex.

fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.default_branch.response.message_groups[]
Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.default_branch.response.message_groups[].message

The primary message that Amazon Lex should send to the user.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.default_branch.response.message_groups[].message.custom_payload

A message in a custom format defined by the client application.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.default_branch.response.message_groups[].message.custom_payload.value

The string that is sent to your application.

fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.default_branch.response.message_groups[].message.image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.default_branch.response.message_groups[].message.image_response_card.buttons[]
Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.default_branch.response.message_groups[].message.image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.default_branch.response.message_groups[].message.image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.default_branch.response.message_groups[].message.image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.default_branch.response.message_groups[].message.image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.default_branch.response.message_groups[].message.image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.default_branch.response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.default_branch.response.message_groups[].message.plain_text_message.value

The message to send to the user.

fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.default_branch.response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.default_branch.response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.default_branch.response.message_groups[].variations[]
Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.default_branch.response.message_groups[].variations[].custom_payload

A message in a custom format defined by the client application.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.default_branch.response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.default_branch.response.message_groups[].variations[].image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.default_branch.response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.default_branch.response.message_groups[].variations[].image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.default_branch.response.message_groups[].variations[].image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.default_branch.response.message_groups[].variations[].image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.default_branch.response.message_groups[].variations[].image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.default_branch.response.message_groups[].variations[].image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.default_branch.response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.default_branch.response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.default_branch.response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_conditional.default_branch.response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

fulfillment_code_hook.post_fulfillment_status_specification.failure_next_step

Specifies the next step the bot runs after the fulfillment code hook throws an exception or returns with the State field of the Intent object set to Failed.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_next_step.dialog_action

Defines the action that the bot executes at runtime when the conversation reaches this step.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_next_step.dialog_action.slot_to_elicit

If the dialog action is ElicitSlot, defines the slot to elicit from the user.

fulfillment_code_hook.post_fulfillment_status_specification.failure_next_step.dialog_action.suppress_next_message

When true the next message for the intent is not used.

fulfillment_code_hook.post_fulfillment_status_specification.failure_next_step.dialog_action.type

The action that the bot should execute.

fulfillment_code_hook.post_fulfillment_status_specification.failure_next_step.intent

Override settings to configure the intent state.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_next_step.intent.name

The name of the intent. Only required when you're switching intents.

fulfillment_code_hook.post_fulfillment_status_specification.failure_next_step.intent.slots

A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.

fulfillment_code_hook.post_fulfillment_status_specification.failure_next_step.session_attributes

Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

fulfillment_code_hook.post_fulfillment_status_specification.failure_response

Specifies a list of message groups that Amazon Lex uses to respond the user input.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_response.allow_interrupt

Indicates whether the user can interrupt a speech response from Amazon Lex.

fulfillment_code_hook.post_fulfillment_status_specification.failure_response.message_groups[]
Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_response.message_groups[].message

The primary message that Amazon Lex should send to the user.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_response.message_groups[].message.custom_payload

A message in a custom format defined by the client application.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_response.message_groups[].message.custom_payload.value

The string that is sent to your application.

fulfillment_code_hook.post_fulfillment_status_specification.failure_response.message_groups[].message.image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_response.message_groups[].message.image_response_card.buttons[]
Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_response.message_groups[].message.image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

fulfillment_code_hook.post_fulfillment_status_specification.failure_response.message_groups[].message.image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

fulfillment_code_hook.post_fulfillment_status_specification.failure_response.message_groups[].message.image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

fulfillment_code_hook.post_fulfillment_status_specification.failure_response.message_groups[].message.image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

fulfillment_code_hook.post_fulfillment_status_specification.failure_response.message_groups[].message.image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

fulfillment_code_hook.post_fulfillment_status_specification.failure_response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_response.message_groups[].message.plain_text_message.value

The message to send to the user.

fulfillment_code_hook.post_fulfillment_status_specification.failure_response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

fulfillment_code_hook.post_fulfillment_status_specification.failure_response.message_groups[].variations[]
Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_response.message_groups[].variations[].custom_payload

A message in a custom format defined by the client application.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

fulfillment_code_hook.post_fulfillment_status_specification.failure_response.message_groups[].variations[].image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_response.message_groups[].variations[].image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

fulfillment_code_hook.post_fulfillment_status_specification.failure_response.message_groups[].variations[].image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

fulfillment_code_hook.post_fulfillment_status_specification.failure_response.message_groups[].variations[].image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

fulfillment_code_hook.post_fulfillment_status_specification.failure_response.message_groups[].variations[].image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

fulfillment_code_hook.post_fulfillment_status_specification.failure_response.message_groups[].variations[].image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

fulfillment_code_hook.post_fulfillment_status_specification.failure_response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

fulfillment_code_hook.post_fulfillment_status_specification.failure_response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.failure_response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

fulfillment_code_hook.post_fulfillment_status_specification.success_conditional

A list of conditional branches to evaluate after the fulfillment code hook finishes successfully.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.active

Determines whether a conditional branch is active. When active is false, the conditions are not evaluated.

fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.conditional_branches[]
Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.conditional_branches[].condition

Contains the expression to evaluate. If the condition is true, the branch's actions are taken.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.conditional_branches[].condition.expression_string

The expression string that is evaluated.

fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.conditional_branches[].name

The name of the branch.

fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.conditional_branches[].next_step

The next step in the conversation.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.conditional_branches[].next_step.dialog_action

Defines the action that the bot executes at runtime when the conversation reaches this step.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.conditional_branches[].next_step.dialog_action.slot_to_elicit

If the dialog action is ElicitSlot, defines the slot to elicit from the user.

fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.conditional_branches[].next_step.dialog_action.suppress_next_message

When true the next message for the intent is not used.

fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.conditional_branches[].next_step.dialog_action.type

The action that the bot should execute.

fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.conditional_branches[].next_step.intent

Override settings to configure the intent state.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.conditional_branches[].next_step.intent.name

The name of the intent. Only required when you're switching intents.

fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.conditional_branches[].next_step.intent.slots

A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.

fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.conditional_branches[].next_step.session_attributes

Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.conditional_branches[].response

Specifies a list of message groups that Amazon Lex uses to respond the user input.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.conditional_branches[].response.allow_interrupt

Indicates whether the user can interrupt a speech response from Amazon Lex.

fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.conditional_branches[].response.message_groups[]
Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.conditional_branches[].response.message_groups[].message

The primary message that Amazon Lex should send to the user.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.conditional_branches[].response.message_groups[].message.custom_payload

A message in a custom format defined by the client application.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.conditional_branches[].response.message_groups[].message.custom_payload.value

The string that is sent to your application.

fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.conditional_branches[].response.message_groups[].message.image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.conditional_branches[].response.message_groups[].message.image_response_card.buttons[]
Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.conditional_branches[].response.message_groups[].message.image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.conditional_branches[].response.message_groups[].message.image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.conditional_branches[].response.message_groups[].message.image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.conditional_branches[].response.message_groups[].message.image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.conditional_branches[].response.message_groups[].message.image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.conditional_branches[].response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.conditional_branches[].response.message_groups[].message.plain_text_message.value

The message to send to the user.

fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.conditional_branches[].response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.conditional_branches[].response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.conditional_branches[].response.message_groups[].variations[]
Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.conditional_branches[].response.message_groups[].variations[].custom_payload

A message in a custom format defined by the client application.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.conditional_branches[].response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.conditional_branches[].response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.conditional_branches[].response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.conditional_branches[].response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.conditional_branches[].response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.default_branch

The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.default_branch.next_step

The next step in the conversation.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.default_branch.next_step.dialog_action

Defines the action that the bot executes at runtime when the conversation reaches this step.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.default_branch.next_step.dialog_action.slot_to_elicit

If the dialog action is ElicitSlot, defines the slot to elicit from the user.

fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.default_branch.next_step.dialog_action.suppress_next_message

When true the next message for the intent is not used.

fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.default_branch.next_step.dialog_action.type

The action that the bot should execute.

fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.default_branch.next_step.intent

Override settings to configure the intent state.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.default_branch.next_step.intent.name

The name of the intent. Only required when you're switching intents.

fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.default_branch.next_step.intent.slots

A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.

fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.default_branch.next_step.session_attributes

Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.default_branch.response

Specifies a list of message groups that Amazon Lex uses to respond the user input.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.default_branch.response.allow_interrupt

Indicates whether the user can interrupt a speech response from Amazon Lex.

fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.default_branch.response.message_groups[]
Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.default_branch.response.message_groups[].message

The primary message that Amazon Lex should send to the user.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.default_branch.response.message_groups[].message.custom_payload

A message in a custom format defined by the client application.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.default_branch.response.message_groups[].message.custom_payload.value

The string that is sent to your application.

fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.default_branch.response.message_groups[].message.image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.default_branch.response.message_groups[].message.image_response_card.buttons[]
Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.default_branch.response.message_groups[].message.image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.default_branch.response.message_groups[].message.image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.default_branch.response.message_groups[].message.image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.default_branch.response.message_groups[].message.image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.default_branch.response.message_groups[].message.image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.default_branch.response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.default_branch.response.message_groups[].message.plain_text_message.value

The message to send to the user.

fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.default_branch.response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.default_branch.response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.default_branch.response.message_groups[].variations[]
Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.default_branch.response.message_groups[].variations[].custom_payload

A message in a custom format defined by the client application.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.default_branch.response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.default_branch.response.message_groups[].variations[].image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.default_branch.response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.default_branch.response.message_groups[].variations[].image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.default_branch.response.message_groups[].variations[].image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.default_branch.response.message_groups[].variations[].image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.default_branch.response.message_groups[].variations[].image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.default_branch.response.message_groups[].variations[].image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.default_branch.response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.default_branch.response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.default_branch.response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_conditional.default_branch.response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

fulfillment_code_hook.post_fulfillment_status_specification.success_next_step

Specifies the next step in the conversation that Amazon Lex invokes when the fulfillment code hook completes successfully.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_next_step.dialog_action

Defines the action that the bot executes at runtime when the conversation reaches this step.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_next_step.dialog_action.slot_to_elicit

If the dialog action is ElicitSlot, defines the slot to elicit from the user.

fulfillment_code_hook.post_fulfillment_status_specification.success_next_step.dialog_action.suppress_next_message

When true the next message for the intent is not used.

fulfillment_code_hook.post_fulfillment_status_specification.success_next_step.dialog_action.type

The action that the bot should execute.

fulfillment_code_hook.post_fulfillment_status_specification.success_next_step.intent

Override settings to configure the intent state.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_next_step.intent.name

The name of the intent. Only required when you're switching intents.

fulfillment_code_hook.post_fulfillment_status_specification.success_next_step.intent.slots

A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.

fulfillment_code_hook.post_fulfillment_status_specification.success_next_step.session_attributes

Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

fulfillment_code_hook.post_fulfillment_status_specification.success_response

Specifies a list of message groups that Amazon Lex uses to respond the user input.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_response.allow_interrupt

Indicates whether the user can interrupt a speech response from Amazon Lex.

fulfillment_code_hook.post_fulfillment_status_specification.success_response.message_groups[]
Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_response.message_groups[].message

The primary message that Amazon Lex should send to the user.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_response.message_groups[].message.custom_payload

A message in a custom format defined by the client application.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_response.message_groups[].message.custom_payload.value

The string that is sent to your application.

fulfillment_code_hook.post_fulfillment_status_specification.success_response.message_groups[].message.image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_response.message_groups[].message.image_response_card.buttons[]
Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_response.message_groups[].message.image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

fulfillment_code_hook.post_fulfillment_status_specification.success_response.message_groups[].message.image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

fulfillment_code_hook.post_fulfillment_status_specification.success_response.message_groups[].message.image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

fulfillment_code_hook.post_fulfillment_status_specification.success_response.message_groups[].message.image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

fulfillment_code_hook.post_fulfillment_status_specification.success_response.message_groups[].message.image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

fulfillment_code_hook.post_fulfillment_status_specification.success_response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_response.message_groups[].message.plain_text_message.value

The message to send to the user.

fulfillment_code_hook.post_fulfillment_status_specification.success_response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

fulfillment_code_hook.post_fulfillment_status_specification.success_response.message_groups[].variations[]
Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_response.message_groups[].variations[].custom_payload

A message in a custom format defined by the client application.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

fulfillment_code_hook.post_fulfillment_status_specification.success_response.message_groups[].variations[].image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_response.message_groups[].variations[].image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

fulfillment_code_hook.post_fulfillment_status_specification.success_response.message_groups[].variations[].image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

fulfillment_code_hook.post_fulfillment_status_specification.success_response.message_groups[].variations[].image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

fulfillment_code_hook.post_fulfillment_status_specification.success_response.message_groups[].variations[].image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

fulfillment_code_hook.post_fulfillment_status_specification.success_response.message_groups[].variations[].image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

fulfillment_code_hook.post_fulfillment_status_specification.success_response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

fulfillment_code_hook.post_fulfillment_status_specification.success_response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.success_response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional

A list of conditional branches to evaluate if the fulfillment code hook times out.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.active

Determines whether a conditional branch is active. When active is false, the conditions are not evaluated.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.conditional_branches[]
Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.conditional_branches[].condition

Contains the expression to evaluate. If the condition is true, the branch's actions are taken.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.conditional_branches[].condition.expression_string

The expression string that is evaluated.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.conditional_branches[].name

The name of the branch.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.conditional_branches[].next_step

The next step in the conversation.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.conditional_branches[].next_step.dialog_action

Defines the action that the bot executes at runtime when the conversation reaches this step.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.conditional_branches[].next_step.dialog_action.slot_to_elicit

If the dialog action is ElicitSlot, defines the slot to elicit from the user.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.conditional_branches[].next_step.dialog_action.suppress_next_message

When true the next message for the intent is not used.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.conditional_branches[].next_step.dialog_action.type

The action that the bot should execute.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.conditional_branches[].next_step.intent

Override settings to configure the intent state.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.conditional_branches[].next_step.intent.name

The name of the intent. Only required when you're switching intents.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.conditional_branches[].next_step.intent.slots

A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.conditional_branches[].next_step.session_attributes

Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.conditional_branches[].response

Specifies a list of message groups that Amazon Lex uses to respond the user input.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.conditional_branches[].response.allow_interrupt

Indicates whether the user can interrupt a speech response from Amazon Lex.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.conditional_branches[].response.message_groups[]
Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.conditional_branches[].response.message_groups[].message

The primary message that Amazon Lex should send to the user.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.conditional_branches[].response.message_groups[].message.custom_payload

A message in a custom format defined by the client application.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.conditional_branches[].response.message_groups[].message.custom_payload.value

The string that is sent to your application.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.conditional_branches[].response.message_groups[].message.image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.conditional_branches[].response.message_groups[].message.image_response_card.buttons[]
Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.conditional_branches[].response.message_groups[].message.image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.conditional_branches[].response.message_groups[].message.image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.conditional_branches[].response.message_groups[].message.image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.conditional_branches[].response.message_groups[].message.image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.conditional_branches[].response.message_groups[].message.image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.conditional_branches[].response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.conditional_branches[].response.message_groups[].message.plain_text_message.value

The message to send to the user.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.conditional_branches[].response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.conditional_branches[].response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.conditional_branches[].response.message_groups[].variations[]
Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.conditional_branches[].response.message_groups[].variations[].custom_payload

A message in a custom format defined by the client application.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.conditional_branches[].response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.conditional_branches[].response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.conditional_branches[].response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.conditional_branches[].response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.conditional_branches[].response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.default_branch

The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.default_branch.next_step

The next step in the conversation.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.default_branch.next_step.dialog_action

Defines the action that the bot executes at runtime when the conversation reaches this step.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.default_branch.next_step.dialog_action.slot_to_elicit

If the dialog action is ElicitSlot, defines the slot to elicit from the user.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.default_branch.next_step.dialog_action.suppress_next_message

When true the next message for the intent is not used.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.default_branch.next_step.dialog_action.type

The action that the bot should execute.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.default_branch.next_step.intent

Override settings to configure the intent state.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.default_branch.next_step.intent.name

The name of the intent. Only required when you're switching intents.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.default_branch.next_step.intent.slots

A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.default_branch.next_step.session_attributes

Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.default_branch.response

Specifies a list of message groups that Amazon Lex uses to respond the user input.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.default_branch.response.allow_interrupt

Indicates whether the user can interrupt a speech response from Amazon Lex.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.default_branch.response.message_groups[]
Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.default_branch.response.message_groups[].message

The primary message that Amazon Lex should send to the user.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.default_branch.response.message_groups[].message.custom_payload

A message in a custom format defined by the client application.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.default_branch.response.message_groups[].message.custom_payload.value

The string that is sent to your application.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.default_branch.response.message_groups[].message.image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.default_branch.response.message_groups[].message.image_response_card.buttons[]
Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.default_branch.response.message_groups[].message.image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.default_branch.response.message_groups[].message.image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.default_branch.response.message_groups[].message.image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.default_branch.response.message_groups[].message.image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.default_branch.response.message_groups[].message.image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.default_branch.response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.default_branch.response.message_groups[].message.plain_text_message.value

The message to send to the user.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.default_branch.response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.default_branch.response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.default_branch.response.message_groups[].variations[]
Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.default_branch.response.message_groups[].variations[].custom_payload

A message in a custom format defined by the client application.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.default_branch.response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.default_branch.response.message_groups[].variations[].image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.default_branch.response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.default_branch.response.message_groups[].variations[].image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.default_branch.response.message_groups[].variations[].image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.default_branch.response.message_groups[].variations[].image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.default_branch.response.message_groups[].variations[].image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.default_branch.response.message_groups[].variations[].image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.default_branch.response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.default_branch.response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.default_branch.response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_conditional.default_branch.response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_next_step

Specifies the next step that the bot runs when the fulfillment code hook times out.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_next_step.dialog_action

Defines the action that the bot executes at runtime when the conversation reaches this step.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_next_step.dialog_action.slot_to_elicit

If the dialog action is ElicitSlot, defines the slot to elicit from the user.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_next_step.dialog_action.suppress_next_message

When true the next message for the intent is not used.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_next_step.dialog_action.type

The action that the bot should execute.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_next_step.intent

Override settings to configure the intent state.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_next_step.intent.name

The name of the intent. Only required when you're switching intents.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_next_step.intent.slots

A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_next_step.session_attributes

Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_response

Specifies a list of message groups that Amazon Lex uses to respond the user input.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_response.allow_interrupt

Indicates whether the user can interrupt a speech response from Amazon Lex.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_response.message_groups[]
Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_response.message_groups[].message

The primary message that Amazon Lex should send to the user.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_response.message_groups[].message.custom_payload

A message in a custom format defined by the client application.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_response.message_groups[].message.custom_payload.value

The string that is sent to your application.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_response.message_groups[].message.image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_response.message_groups[].message.image_response_card.buttons[]
Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_response.message_groups[].message.image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_response.message_groups[].message.image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_response.message_groups[].message.image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_response.message_groups[].message.image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_response.message_groups[].message.image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_response.message_groups[].message.plain_text_message.value

The message to send to the user.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_response.message_groups[].variations[]
Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_response.message_groups[].variations[].custom_payload

A message in a custom format defined by the client application.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_response.message_groups[].variations[].image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_response.message_groups[].variations[].image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_response.message_groups[].variations[].image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_response.message_groups[].variations[].image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_response.message_groups[].variations[].image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_response.message_groups[].variations[].image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

fulfillment_code_hook.post_fulfillment_status_specification.timeout_response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
fulfillment_code_hook.post_fulfillment_status_specification.timeout_response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

initial_response_setting

Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots.

STRUCT(
"initial_response" STRUCT(
"message_groups" STRUCT(
"message" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
),
"variations" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
)[]
)[],
"allow_interrupt" BOOLEAN
),
"next_step" STRUCT(
"dialog_action" STRUCT(
"type" VARCHAR,
"slot_to_elicit" VARCHAR,
"suppress_next_message" BOOLEAN
),
"intent" STRUCT(
"name" VARCHAR,
"slots" MAP(VARCHAR, STRUCT(
"shape" VARCHAR,
"value" STRUCT(
"interpreted_value" VARCHAR
)
))
),
"session_attributes" MAP(VARCHAR, VARCHAR)
),
"conditional" STRUCT(
"active" BOOLEAN,
"conditional_branches" STRUCT(
"name" VARCHAR,
"condition" STRUCT(
"expression_string" VARCHAR
),
"next_step" STRUCT(
"dialog_action" STRUCT(
"type" VARCHAR,
"slot_to_elicit" VARCHAR,
"suppress_next_message" BOOLEAN
),
"intent" STRUCT(
"name" VARCHAR,
"slots" MAP(VARCHAR, STRUCT(
"shape" VARCHAR,
"value" STRUCT(
"interpreted_value" VARCHAR
)
))
),
"session_attributes" MAP(VARCHAR, VARCHAR)
),
"response" STRUCT(
"message_groups" STRUCT(
"message" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
),
"variations" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
)[]
)[],
"allow_interrupt" BOOLEAN
)
)[],
"default_branch" STRUCT(
"next_step" STRUCT(
"dialog_action" STRUCT(
"type" VARCHAR,
"slot_to_elicit" VARCHAR,
"suppress_next_message" BOOLEAN
),
"intent" STRUCT(
"name" VARCHAR,
"slots" MAP(VARCHAR, STRUCT(
"shape" VARCHAR,
"value" STRUCT(
"interpreted_value" VARCHAR
)
))
),
"session_attributes" MAP(VARCHAR, VARCHAR)
),
"response" STRUCT(
"message_groups" STRUCT(
"message" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
),
"variations" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
)[]
)[],
"allow_interrupt" BOOLEAN
)
)
),
"code_hook" STRUCT(
"enable_code_hook_invocation" BOOLEAN,
"active" BOOLEAN,
"invocation_label" VARCHAR,
"post_code_hook_specification" STRUCT(
"success_response" STRUCT(
"message_groups" STRUCT(
"message" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
),
"variations" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
)[]
)[],
"allow_interrupt" BOOLEAN
),
"success_next_step" STRUCT(
"dialog_action" STRUCT(
"type" VARCHAR,
"slot_to_elicit" VARCHAR,
"suppress_next_message" BOOLEAN
),
"intent" STRUCT(
"name" VARCHAR,
"slots" MAP(VARCHAR, STRUCT(
"shape" VARCHAR,
"value" STRUCT(
"interpreted_value" VARCHAR
)
))
),
"session_attributes" MAP(VARCHAR, VARCHAR)
),
"success_conditional" STRUCT(
"active" BOOLEAN,
"conditional_branches" STRUCT(
"name" VARCHAR,
"condition" STRUCT(
"expression_string" VARCHAR
),
"next_step" STRUCT(
"dialog_action" STRUCT(
"type" VARCHAR,
"slot_to_elicit" VARCHAR,
"suppress_next_message" BOOLEAN
),
"intent" STRUCT(
"name" VARCHAR,
"slots" MAP(VARCHAR, STRUCT(
"shape" VARCHAR,
"value" STRUCT(
"interpreted_value" VARCHAR
)
))
),
"session_attributes" MAP(VARCHAR, VARCHAR)
),
"response" STRUCT(
"message_groups" STRUCT(
"message" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
),
"variations" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
)[]
)[],
"allow_interrupt" BOOLEAN
)
)[],
"default_branch" STRUCT(
"next_step" STRUCT(
"dialog_action" STRUCT(
"type" VARCHAR,
"slot_to_elicit" VARCHAR,
"suppress_next_message" BOOLEAN
),
"intent" STRUCT(
"name" VARCHAR,
"slots" MAP(VARCHAR, STRUCT(
"shape" VARCHAR,
"value" STRUCT(
"interpreted_value" VARCHAR
)
))
),
"session_attributes" MAP(VARCHAR, VARCHAR)
),
"response" STRUCT(
"message_groups" STRUCT(
"message" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
),
"variations" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
)[]
)[],
"allow_interrupt" BOOLEAN
)
)
),
"failure_response" STRUCT(
"message_groups" STRUCT(
"message" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
),
"variations" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
)[]
)[],
"allow_interrupt" BOOLEAN
),
"failure_next_step" STRUCT(
"dialog_action" STRUCT(
"type" VARCHAR,
"slot_to_elicit" VARCHAR,
"suppress_next_message" BOOLEAN
),
"intent" STRUCT(
"name" VARCHAR,
"slots" MAP(VARCHAR, STRUCT(
"shape" VARCHAR,
"value" STRUCT(
"interpreted_value" VARCHAR
)
))
),
"session_attributes" MAP(VARCHAR, VARCHAR)
),
"failure_conditional" STRUCT(
"active" BOOLEAN,
"conditional_branches" STRUCT(
"name" VARCHAR,
"condition" STRUCT(
"expression_string" VARCHAR
),
"next_step" STRUCT(
"dialog_action" STRUCT(
"type" VARCHAR,
"slot_to_elicit" VARCHAR,
"suppress_next_message" BOOLEAN
),
"intent" STRUCT(
"name" VARCHAR,
"slots" MAP(VARCHAR, STRUCT(
"shape" VARCHAR,
"value" STRUCT(
"interpreted_value" VARCHAR
)
))
),
"session_attributes" MAP(VARCHAR, VARCHAR)
),
"response" STRUCT(
"message_groups" STRUCT(
"message" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
),
"variations" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
)[]
)[],
"allow_interrupt" BOOLEAN
)
)[],
"default_branch" STRUCT(
"next_step" STRUCT(
"dialog_action" STRUCT(
"type" VARCHAR,
"slot_to_elicit" VARCHAR,
"suppress_next_message" BOOLEAN
),
"intent" STRUCT(
"name" VARCHAR,
"slots" MAP(VARCHAR, STRUCT(
"shape" VARCHAR,
"value" STRUCT(
"interpreted_value" VARCHAR
)
))
),
"session_attributes" MAP(VARCHAR, VARCHAR)
),
"response" STRUCT(
"message_groups" STRUCT(
"message" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
),
"variations" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
)[]
)[],
"allow_interrupt" BOOLEAN
)
)
),
"timeout_response" STRUCT(
"message_groups" STRUCT(
"message" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
),
"variations" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
)[]
)[],
"allow_interrupt" BOOLEAN
),
"timeout_next_step" STRUCT(
"dialog_action" STRUCT(
"type" VARCHAR,
"slot_to_elicit" VARCHAR,
"suppress_next_message" BOOLEAN
),
"intent" STRUCT(
"name" VARCHAR,
"slots" MAP(VARCHAR, STRUCT(
"shape" VARCHAR,
"value" STRUCT(
"interpreted_value" VARCHAR
)
))
),
"session_attributes" MAP(VARCHAR, VARCHAR)
),
"timeout_conditional" STRUCT(
"active" BOOLEAN,
"conditional_branches" STRUCT(
"name" VARCHAR,
"condition" STRUCT(
"expression_string" VARCHAR
),
"next_step" STRUCT(
"dialog_action" STRUCT(
"type" VARCHAR,
"slot_to_elicit" VARCHAR,
"suppress_next_message" BOOLEAN
),
"intent" STRUCT(
"name" VARCHAR,
"slots" MAP(VARCHAR, STRUCT(
"shape" VARCHAR,
"value" STRUCT(
"interpreted_value" VARCHAR
)
))
),
"session_attributes" MAP(VARCHAR, VARCHAR)
),
"response" STRUCT(
"message_groups" STRUCT(
"message" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
),
"variations" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
)[]
)[],
"allow_interrupt" BOOLEAN
)
)[],
"default_branch" STRUCT(
"next_step" STRUCT(
"dialog_action" STRUCT(
"type" VARCHAR,
"slot_to_elicit" VARCHAR,
"suppress_next_message" BOOLEAN
),
"intent" STRUCT(
"name" VARCHAR,
"slots" MAP(VARCHAR, STRUCT(
"shape" VARCHAR,
"value" STRUCT(
"interpreted_value" VARCHAR
)
))
),
"session_attributes" MAP(VARCHAR, VARCHAR)
),
"response" STRUCT(
"message_groups" STRUCT(
"message" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
),
"variations" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
)[]
)[],
"allow_interrupt" BOOLEAN
)
)
)
)
)
)
Show child fields
initial_response_setting.code_hook

Settings that specify the dialog code hook that is called by Amazon Lex at a step of the conversation.

Show child fields
initial_response_setting.code_hook.active

Determines whether a dialog code hook is used when the intent is activated.

initial_response_setting.code_hook.enable_code_hook_invocation

Indicates whether a Lambda function should be invoked for the dialog.

initial_response_setting.code_hook.invocation_label

A label that indicates the dialog step from which the dialog code hook is happening.

initial_response_setting.code_hook.post_code_hook_specification

Contains the responses and actions that Amazon Lex takes after the Lambda function is complete.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_conditional

A list of conditional branches to evaluate after the dialog code hook throws an exception or returns with the State field of the Intent object set to Failed.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.active

Determines whether a conditional branch is active. When active is false, the conditions are not evaluated.

initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[]
Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].condition

Contains the expression to evaluate. If the condition is true, the branch's actions are taken.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].condition.expression_string

The expression string that is evaluated.

initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].name

The name of the branch.

initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].next_step

The next step in the conversation.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].next_step.dialog_action

Defines the action that the bot executes at runtime when the conversation reaches this step.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].next_step.dialog_action.slot_to_elicit

If the dialog action is ElicitSlot, defines the slot to elicit from the user.

initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].next_step.dialog_action.suppress_next_message

When true the next message for the intent is not used.

initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].next_step.dialog_action.type

The action that the bot should execute.

initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].next_step.intent

Override settings to configure the intent state.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].next_step.intent.name

The name of the intent. Only required when you're switching intents.

initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].next_step.intent.slots

A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.

initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].next_step.session_attributes

Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response

Specifies a list of message groups that Amazon Lex uses to respond the user input.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.allow_interrupt

Indicates whether the user can interrupt a speech response from Amazon Lex.

initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[]
Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].message

The primary message that Amazon Lex should send to the user.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].message.custom_payload

A message in a custom format defined by the client application.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].message.custom_payload.value

The string that is sent to your application.

initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].message.image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].message.image_response_card.buttons[]
Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].message.image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].message.image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].message.image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].message.image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].message.image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].message.plain_text_message.value

The message to send to the user.

initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].variations[]
Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].variations[].custom_payload

A message in a custom format defined by the client application.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch

The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.next_step

The next step in the conversation.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.next_step.dialog_action

Defines the action that the bot executes at runtime when the conversation reaches this step.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.next_step.dialog_action.slot_to_elicit

If the dialog action is ElicitSlot, defines the slot to elicit from the user.

initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.next_step.dialog_action.suppress_next_message

When true the next message for the intent is not used.

initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.next_step.dialog_action.type

The action that the bot should execute.

initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.next_step.intent

Override settings to configure the intent state.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.next_step.intent.name

The name of the intent. Only required when you're switching intents.

initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.next_step.intent.slots

A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.

initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.next_step.session_attributes

Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response

Specifies a list of message groups that Amazon Lex uses to respond the user input.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.allow_interrupt

Indicates whether the user can interrupt a speech response from Amazon Lex.

initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[]
Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].message

The primary message that Amazon Lex should send to the user.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].message.custom_payload

A message in a custom format defined by the client application.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].message.custom_payload.value

The string that is sent to your application.

initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].message.image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].message.image_response_card.buttons[]
Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].message.image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].message.image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].message.image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].message.image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].message.image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].message.plain_text_message.value

The message to send to the user.

initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].variations[]
Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].variations[].custom_payload

A message in a custom format defined by the client application.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].variations[].image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].variations[].image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].variations[].image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].variations[].image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].variations[].image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].variations[].image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

initial_response_setting.code_hook.post_code_hook_specification.failure_next_step

Specifies the next step the bot runs after the dialog code hook throws an exception or returns with the State field of the Intent object set to Failed.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_next_step.dialog_action

Defines the action that the bot executes at runtime when the conversation reaches this step.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_next_step.dialog_action.slot_to_elicit

If the dialog action is ElicitSlot, defines the slot to elicit from the user.

initial_response_setting.code_hook.post_code_hook_specification.failure_next_step.dialog_action.suppress_next_message

When true the next message for the intent is not used.

initial_response_setting.code_hook.post_code_hook_specification.failure_next_step.dialog_action.type

The action that the bot should execute.

initial_response_setting.code_hook.post_code_hook_specification.failure_next_step.intent

Override settings to configure the intent state.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_next_step.intent.name

The name of the intent. Only required when you're switching intents.

initial_response_setting.code_hook.post_code_hook_specification.failure_next_step.intent.slots

A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.

initial_response_setting.code_hook.post_code_hook_specification.failure_next_step.session_attributes

Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

initial_response_setting.code_hook.post_code_hook_specification.failure_response

Specifies a list of message groups that Amazon Lex uses to respond the user input.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_response.allow_interrupt

Indicates whether the user can interrupt a speech response from Amazon Lex.

initial_response_setting.code_hook.post_code_hook_specification.failure_response.message_groups[]
Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].message

The primary message that Amazon Lex should send to the user.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].message.custom_payload

A message in a custom format defined by the client application.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].message.custom_payload.value

The string that is sent to your application.

initial_response_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].message.image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].message.image_response_card.buttons[]
Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].message.image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

initial_response_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].message.image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

initial_response_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].message.image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

initial_response_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].message.image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

initial_response_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].message.image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

initial_response_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].message.plain_text_message.value

The message to send to the user.

initial_response_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

initial_response_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].variations[]
Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].variations[].custom_payload

A message in a custom format defined by the client application.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

initial_response_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].variations[].image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].variations[].image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

initial_response_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].variations[].image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

initial_response_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].variations[].image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

initial_response_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].variations[].image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

initial_response_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].variations[].image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

initial_response_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

initial_response_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

initial_response_setting.code_hook.post_code_hook_specification.success_conditional

A list of conditional branches to evaluate after the dialog code hook finishes successfully.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_conditional.active

Determines whether a conditional branch is active. When active is false, the conditions are not evaluated.

initial_response_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[]
Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].condition

Contains the expression to evaluate. If the condition is true, the branch's actions are taken.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].condition.expression_string

The expression string that is evaluated.

initial_response_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].name

The name of the branch.

initial_response_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].next_step

The next step in the conversation.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].next_step.dialog_action

Defines the action that the bot executes at runtime when the conversation reaches this step.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].next_step.dialog_action.slot_to_elicit

If the dialog action is ElicitSlot, defines the slot to elicit from the user.

initial_response_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].next_step.dialog_action.suppress_next_message

When true the next message for the intent is not used.

initial_response_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].next_step.dialog_action.type

The action that the bot should execute.

initial_response_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].next_step.intent

Override settings to configure the intent state.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].next_step.intent.name

The name of the intent. Only required when you're switching intents.

initial_response_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].next_step.intent.slots

A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.

initial_response_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].next_step.session_attributes

Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

initial_response_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response

Specifies a list of message groups that Amazon Lex uses to respond the user input.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.allow_interrupt

Indicates whether the user can interrupt a speech response from Amazon Lex.

initial_response_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[]
Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].message

The primary message that Amazon Lex should send to the user.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].message.custom_payload

A message in a custom format defined by the client application.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].message.custom_payload.value

The string that is sent to your application.

initial_response_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].message.image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].message.image_response_card.buttons[]
Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].message.image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

initial_response_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].message.image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

initial_response_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].message.image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

initial_response_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].message.image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

initial_response_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].message.image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

initial_response_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].message.plain_text_message.value

The message to send to the user.

initial_response_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

initial_response_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].variations[]
Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].variations[].custom_payload

A message in a custom format defined by the client application.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

initial_response_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

initial_response_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

initial_response_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

initial_response_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

initial_response_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

initial_response_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

initial_response_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

initial_response_setting.code_hook.post_code_hook_specification.success_conditional.default_branch

The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.next_step

The next step in the conversation.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.next_step.dialog_action

Defines the action that the bot executes at runtime when the conversation reaches this step.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.next_step.dialog_action.slot_to_elicit

If the dialog action is ElicitSlot, defines the slot to elicit from the user.

initial_response_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.next_step.dialog_action.suppress_next_message

When true the next message for the intent is not used.

initial_response_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.next_step.dialog_action.type

The action that the bot should execute.

initial_response_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.next_step.intent

Override settings to configure the intent state.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.next_step.intent.name

The name of the intent. Only required when you're switching intents.

initial_response_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.next_step.intent.slots

A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.

initial_response_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.next_step.session_attributes

Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

initial_response_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response

Specifies a list of message groups that Amazon Lex uses to respond the user input.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.allow_interrupt

Indicates whether the user can interrupt a speech response from Amazon Lex.

initial_response_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[]
Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].message

The primary message that Amazon Lex should send to the user.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].message.custom_payload

A message in a custom format defined by the client application.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].message.custom_payload.value

The string that is sent to your application.

initial_response_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].message.image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].message.image_response_card.buttons[]
Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].message.image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

initial_response_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].message.image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

initial_response_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].message.image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

initial_response_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].message.image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

initial_response_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].message.image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

initial_response_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].message.plain_text_message.value

The message to send to the user.

initial_response_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

initial_response_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].variations[]
Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].variations[].custom_payload

A message in a custom format defined by the client application.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

initial_response_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].variations[].image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].variations[].image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

initial_response_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].variations[].image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

initial_response_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].variations[].image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

initial_response_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].variations[].image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

initial_response_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].variations[].image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

initial_response_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

initial_response_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

initial_response_setting.code_hook.post_code_hook_specification.success_next_step

Specifics the next step the bot runs after the dialog code hook finishes successfully.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_next_step.dialog_action

Defines the action that the bot executes at runtime when the conversation reaches this step.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_next_step.dialog_action.slot_to_elicit

If the dialog action is ElicitSlot, defines the slot to elicit from the user.

initial_response_setting.code_hook.post_code_hook_specification.success_next_step.dialog_action.suppress_next_message

When true the next message for the intent is not used.

initial_response_setting.code_hook.post_code_hook_specification.success_next_step.dialog_action.type

The action that the bot should execute.

initial_response_setting.code_hook.post_code_hook_specification.success_next_step.intent

Override settings to configure the intent state.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_next_step.intent.name

The name of the intent. Only required when you're switching intents.

initial_response_setting.code_hook.post_code_hook_specification.success_next_step.intent.slots

A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.

initial_response_setting.code_hook.post_code_hook_specification.success_next_step.session_attributes

Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

initial_response_setting.code_hook.post_code_hook_specification.success_response

Specifies a list of message groups that Amazon Lex uses to respond the user input.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_response.allow_interrupt

Indicates whether the user can interrupt a speech response from Amazon Lex.

initial_response_setting.code_hook.post_code_hook_specification.success_response.message_groups[]
Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_response.message_groups[].message

The primary message that Amazon Lex should send to the user.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_response.message_groups[].message.custom_payload

A message in a custom format defined by the client application.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_response.message_groups[].message.custom_payload.value

The string that is sent to your application.

initial_response_setting.code_hook.post_code_hook_specification.success_response.message_groups[].message.image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_response.message_groups[].message.image_response_card.buttons[]
Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_response.message_groups[].message.image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

initial_response_setting.code_hook.post_code_hook_specification.success_response.message_groups[].message.image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

initial_response_setting.code_hook.post_code_hook_specification.success_response.message_groups[].message.image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

initial_response_setting.code_hook.post_code_hook_specification.success_response.message_groups[].message.image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

initial_response_setting.code_hook.post_code_hook_specification.success_response.message_groups[].message.image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

initial_response_setting.code_hook.post_code_hook_specification.success_response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_response.message_groups[].message.plain_text_message.value

The message to send to the user.

initial_response_setting.code_hook.post_code_hook_specification.success_response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

initial_response_setting.code_hook.post_code_hook_specification.success_response.message_groups[].variations[]
Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_response.message_groups[].variations[].custom_payload

A message in a custom format defined by the client application.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

initial_response_setting.code_hook.post_code_hook_specification.success_response.message_groups[].variations[].image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_response.message_groups[].variations[].image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

initial_response_setting.code_hook.post_code_hook_specification.success_response.message_groups[].variations[].image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

initial_response_setting.code_hook.post_code_hook_specification.success_response.message_groups[].variations[].image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

initial_response_setting.code_hook.post_code_hook_specification.success_response.message_groups[].variations[].image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

initial_response_setting.code_hook.post_code_hook_specification.success_response.message_groups[].variations[].image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

initial_response_setting.code_hook.post_code_hook_specification.success_response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

initial_response_setting.code_hook.post_code_hook_specification.success_response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.success_response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional

A list of conditional branches to evaluate if the code hook times out.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.active

Determines whether a conditional branch is active. When active is false, the conditions are not evaluated.

initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[]
Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].condition

Contains the expression to evaluate. If the condition is true, the branch's actions are taken.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].condition.expression_string

The expression string that is evaluated.

initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].name

The name of the branch.

initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].next_step

The next step in the conversation.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].next_step.dialog_action

Defines the action that the bot executes at runtime when the conversation reaches this step.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].next_step.dialog_action.slot_to_elicit

If the dialog action is ElicitSlot, defines the slot to elicit from the user.

initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].next_step.dialog_action.suppress_next_message

When true the next message for the intent is not used.

initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].next_step.dialog_action.type

The action that the bot should execute.

initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].next_step.intent

Override settings to configure the intent state.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].next_step.intent.name

The name of the intent. Only required when you're switching intents.

initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].next_step.intent.slots

A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.

initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].next_step.session_attributes

Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response

Specifies a list of message groups that Amazon Lex uses to respond the user input.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.allow_interrupt

Indicates whether the user can interrupt a speech response from Amazon Lex.

initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[]
Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].message

The primary message that Amazon Lex should send to the user.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].message.custom_payload

A message in a custom format defined by the client application.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].message.custom_payload.value

The string that is sent to your application.

initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].message.image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].message.image_response_card.buttons[]
Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].message.image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].message.image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].message.image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].message.image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].message.image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].message.plain_text_message.value

The message to send to the user.

initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].variations[]
Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].variations[].custom_payload

A message in a custom format defined by the client application.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch

The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.next_step

The next step in the conversation.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.next_step.dialog_action

Defines the action that the bot executes at runtime when the conversation reaches this step.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.next_step.dialog_action.slot_to_elicit

If the dialog action is ElicitSlot, defines the slot to elicit from the user.

initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.next_step.dialog_action.suppress_next_message

When true the next message for the intent is not used.

initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.next_step.dialog_action.type

The action that the bot should execute.

initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.next_step.intent

Override settings to configure the intent state.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.next_step.intent.name

The name of the intent. Only required when you're switching intents.

initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.next_step.intent.slots

A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.

initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.next_step.session_attributes

Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response

Specifies a list of message groups that Amazon Lex uses to respond the user input.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.allow_interrupt

Indicates whether the user can interrupt a speech response from Amazon Lex.

initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[]
Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].message

The primary message that Amazon Lex should send to the user.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].message.custom_payload

A message in a custom format defined by the client application.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].message.custom_payload.value

The string that is sent to your application.

initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].message.image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].message.image_response_card.buttons[]
Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].message.image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].message.image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].message.image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].message.image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].message.image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].message.plain_text_message.value

The message to send to the user.

initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].variations[]
Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].variations[].custom_payload

A message in a custom format defined by the client application.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].variations[].image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].variations[].image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].variations[].image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].variations[].image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].variations[].image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].variations[].image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

initial_response_setting.code_hook.post_code_hook_specification.timeout_next_step

Specifies the next step that the bot runs when the code hook times out.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_next_step.dialog_action

Defines the action that the bot executes at runtime when the conversation reaches this step.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_next_step.dialog_action.slot_to_elicit

If the dialog action is ElicitSlot, defines the slot to elicit from the user.

initial_response_setting.code_hook.post_code_hook_specification.timeout_next_step.dialog_action.suppress_next_message

When true the next message for the intent is not used.

initial_response_setting.code_hook.post_code_hook_specification.timeout_next_step.dialog_action.type

The action that the bot should execute.

initial_response_setting.code_hook.post_code_hook_specification.timeout_next_step.intent

Override settings to configure the intent state.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_next_step.intent.name

The name of the intent. Only required when you're switching intents.

initial_response_setting.code_hook.post_code_hook_specification.timeout_next_step.intent.slots

A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.

initial_response_setting.code_hook.post_code_hook_specification.timeout_next_step.session_attributes

Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

initial_response_setting.code_hook.post_code_hook_specification.timeout_response

Specifies a list of message groups that Amazon Lex uses to respond the user input.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_response.allow_interrupt

Indicates whether the user can interrupt a speech response from Amazon Lex.

initial_response_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[]
Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].message

The primary message that Amazon Lex should send to the user.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].message.custom_payload

A message in a custom format defined by the client application.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].message.custom_payload.value

The string that is sent to your application.

initial_response_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].message.image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].message.image_response_card.buttons[]
Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].message.image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

initial_response_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].message.image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

initial_response_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].message.image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

initial_response_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].message.image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

initial_response_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].message.image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

initial_response_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].message.plain_text_message.value

The message to send to the user.

initial_response_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

initial_response_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].variations[]
Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].variations[].custom_payload

A message in a custom format defined by the client application.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

initial_response_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].variations[].image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].variations[].image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

initial_response_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].variations[].image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

initial_response_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].variations[].image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

initial_response_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].variations[].image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

initial_response_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].variations[].image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

initial_response_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

initial_response_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
initial_response_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

initial_response_setting.conditional

Provides a list of conditional branches. Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition.

Show child fields
initial_response_setting.conditional.active

Determines whether a conditional branch is active. When active is false, the conditions are not evaluated.

initial_response_setting.conditional.conditional_branches[]
Show child fields
initial_response_setting.conditional.conditional_branches[].condition

Contains the expression to evaluate. If the condition is true, the branch's actions are taken.

Show child fields
initial_response_setting.conditional.conditional_branches[].condition.expression_string

The expression string that is evaluated.

initial_response_setting.conditional.conditional_branches[].name

The name of the branch.

initial_response_setting.conditional.conditional_branches[].next_step

The next step in the conversation.

Show child fields
initial_response_setting.conditional.conditional_branches[].next_step.dialog_action

Defines the action that the bot executes at runtime when the conversation reaches this step.

Show child fields
initial_response_setting.conditional.conditional_branches[].next_step.dialog_action.slot_to_elicit

If the dialog action is ElicitSlot, defines the slot to elicit from the user.

initial_response_setting.conditional.conditional_branches[].next_step.dialog_action.suppress_next_message

When true the next message for the intent is not used.

initial_response_setting.conditional.conditional_branches[].next_step.dialog_action.type

The action that the bot should execute.

initial_response_setting.conditional.conditional_branches[].next_step.intent

Override settings to configure the intent state.

Show child fields
initial_response_setting.conditional.conditional_branches[].next_step.intent.name

The name of the intent. Only required when you're switching intents.

initial_response_setting.conditional.conditional_branches[].next_step.intent.slots

A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.

initial_response_setting.conditional.conditional_branches[].next_step.session_attributes

Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

initial_response_setting.conditional.conditional_branches[].response

Specifies a list of message groups that Amazon Lex uses to respond the user input.

Show child fields
initial_response_setting.conditional.conditional_branches[].response.allow_interrupt

Indicates whether the user can interrupt a speech response from Amazon Lex.

initial_response_setting.conditional.conditional_branches[].response.message_groups[]
Show child fields
initial_response_setting.conditional.conditional_branches[].response.message_groups[].message

The primary message that Amazon Lex should send to the user.

Show child fields
initial_response_setting.conditional.conditional_branches[].response.message_groups[].message.custom_payload

A message in a custom format defined by the client application.

Show child fields
initial_response_setting.conditional.conditional_branches[].response.message_groups[].message.custom_payload.value

The string that is sent to your application.

initial_response_setting.conditional.conditional_branches[].response.message_groups[].message.image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
initial_response_setting.conditional.conditional_branches[].response.message_groups[].message.image_response_card.buttons[]
Show child fields
initial_response_setting.conditional.conditional_branches[].response.message_groups[].message.image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

initial_response_setting.conditional.conditional_branches[].response.message_groups[].message.image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

initial_response_setting.conditional.conditional_branches[].response.message_groups[].message.image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

initial_response_setting.conditional.conditional_branches[].response.message_groups[].message.image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

initial_response_setting.conditional.conditional_branches[].response.message_groups[].message.image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

initial_response_setting.conditional.conditional_branches[].response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
initial_response_setting.conditional.conditional_branches[].response.message_groups[].message.plain_text_message.value

The message to send to the user.

initial_response_setting.conditional.conditional_branches[].response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
initial_response_setting.conditional.conditional_branches[].response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

initial_response_setting.conditional.conditional_branches[].response.message_groups[].variations[]
Show child fields
initial_response_setting.conditional.conditional_branches[].response.message_groups[].variations[].custom_payload

A message in a custom format defined by the client application.

Show child fields
initial_response_setting.conditional.conditional_branches[].response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

initial_response_setting.conditional.conditional_branches[].response.message_groups[].variations[].image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
initial_response_setting.conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
initial_response_setting.conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

initial_response_setting.conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

initial_response_setting.conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

initial_response_setting.conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

initial_response_setting.conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

initial_response_setting.conditional.conditional_branches[].response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
initial_response_setting.conditional.conditional_branches[].response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

initial_response_setting.conditional.conditional_branches[].response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
initial_response_setting.conditional.conditional_branches[].response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

initial_response_setting.conditional.default_branch

The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.

Show child fields
initial_response_setting.conditional.default_branch.next_step

The next step in the conversation.

Show child fields
initial_response_setting.conditional.default_branch.next_step.dialog_action

Defines the action that the bot executes at runtime when the conversation reaches this step.

Show child fields
initial_response_setting.conditional.default_branch.next_step.dialog_action.slot_to_elicit

If the dialog action is ElicitSlot, defines the slot to elicit from the user.

initial_response_setting.conditional.default_branch.next_step.dialog_action.suppress_next_message

When true the next message for the intent is not used.

initial_response_setting.conditional.default_branch.next_step.dialog_action.type

The action that the bot should execute.

initial_response_setting.conditional.default_branch.next_step.intent

Override settings to configure the intent state.

Show child fields
initial_response_setting.conditional.default_branch.next_step.intent.name

The name of the intent. Only required when you're switching intents.

initial_response_setting.conditional.default_branch.next_step.intent.slots

A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.

initial_response_setting.conditional.default_branch.next_step.session_attributes

Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

initial_response_setting.conditional.default_branch.response

Specifies a list of message groups that Amazon Lex uses to respond the user input.

Show child fields
initial_response_setting.conditional.default_branch.response.allow_interrupt

Indicates whether the user can interrupt a speech response from Amazon Lex.

initial_response_setting.conditional.default_branch.response.message_groups[]
Show child fields
initial_response_setting.conditional.default_branch.response.message_groups[].message

The primary message that Amazon Lex should send to the user.

Show child fields
initial_response_setting.conditional.default_branch.response.message_groups[].message.custom_payload

A message in a custom format defined by the client application.

Show child fields
initial_response_setting.conditional.default_branch.response.message_groups[].message.custom_payload.value

The string that is sent to your application.

initial_response_setting.conditional.default_branch.response.message_groups[].message.image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
initial_response_setting.conditional.default_branch.response.message_groups[].message.image_response_card.buttons[]
Show child fields
initial_response_setting.conditional.default_branch.response.message_groups[].message.image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

initial_response_setting.conditional.default_branch.response.message_groups[].message.image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

initial_response_setting.conditional.default_branch.response.message_groups[].message.image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

initial_response_setting.conditional.default_branch.response.message_groups[].message.image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

initial_response_setting.conditional.default_branch.response.message_groups[].message.image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

initial_response_setting.conditional.default_branch.response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
initial_response_setting.conditional.default_branch.response.message_groups[].message.plain_text_message.value

The message to send to the user.

initial_response_setting.conditional.default_branch.response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
initial_response_setting.conditional.default_branch.response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

initial_response_setting.conditional.default_branch.response.message_groups[].variations[]
Show child fields
initial_response_setting.conditional.default_branch.response.message_groups[].variations[].custom_payload

A message in a custom format defined by the client application.

Show child fields
initial_response_setting.conditional.default_branch.response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

initial_response_setting.conditional.default_branch.response.message_groups[].variations[].image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
initial_response_setting.conditional.default_branch.response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
initial_response_setting.conditional.default_branch.response.message_groups[].variations[].image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

initial_response_setting.conditional.default_branch.response.message_groups[].variations[].image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

initial_response_setting.conditional.default_branch.response.message_groups[].variations[].image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

initial_response_setting.conditional.default_branch.response.message_groups[].variations[].image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

initial_response_setting.conditional.default_branch.response.message_groups[].variations[].image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

initial_response_setting.conditional.default_branch.response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
initial_response_setting.conditional.default_branch.response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

initial_response_setting.conditional.default_branch.response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
initial_response_setting.conditional.default_branch.response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

initial_response_setting.initial_response

Specifies a list of message groups that Amazon Lex uses to respond the user input.

Show child fields
initial_response_setting.initial_response.allow_interrupt

Indicates whether the user can interrupt a speech response from Amazon Lex.

initial_response_setting.initial_response.message_groups[]
Show child fields
initial_response_setting.initial_response.message_groups[].message

The primary message that Amazon Lex should send to the user.

Show child fields
initial_response_setting.initial_response.message_groups[].message.custom_payload

A message in a custom format defined by the client application.

Show child fields
initial_response_setting.initial_response.message_groups[].message.custom_payload.value

The string that is sent to your application.

initial_response_setting.initial_response.message_groups[].message.image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
initial_response_setting.initial_response.message_groups[].message.image_response_card.buttons[]
Show child fields
initial_response_setting.initial_response.message_groups[].message.image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

initial_response_setting.initial_response.message_groups[].message.image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

initial_response_setting.initial_response.message_groups[].message.image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

initial_response_setting.initial_response.message_groups[].message.image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

initial_response_setting.initial_response.message_groups[].message.image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

initial_response_setting.initial_response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
initial_response_setting.initial_response.message_groups[].message.plain_text_message.value

The message to send to the user.

initial_response_setting.initial_response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
initial_response_setting.initial_response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

initial_response_setting.initial_response.message_groups[].variations[]
Show child fields
initial_response_setting.initial_response.message_groups[].variations[].custom_payload

A message in a custom format defined by the client application.

Show child fields
initial_response_setting.initial_response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

initial_response_setting.initial_response.message_groups[].variations[].image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
initial_response_setting.initial_response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
initial_response_setting.initial_response.message_groups[].variations[].image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

initial_response_setting.initial_response.message_groups[].variations[].image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

initial_response_setting.initial_response.message_groups[].variations[].image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

initial_response_setting.initial_response.message_groups[].variations[].image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

initial_response_setting.initial_response.message_groups[].variations[].image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

initial_response_setting.initial_response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
initial_response_setting.initial_response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

initial_response_setting.initial_response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
initial_response_setting.initial_response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

initial_response_setting.next_step

The next step in the conversation.

Show child fields
initial_response_setting.next_step.dialog_action

Defines the action that the bot executes at runtime when the conversation reaches this step.

Show child fields
initial_response_setting.next_step.dialog_action.slot_to_elicit

If the dialog action is ElicitSlot, defines the slot to elicit from the user.

initial_response_setting.next_step.dialog_action.suppress_next_message

When true the next message for the intent is not used.

initial_response_setting.next_step.dialog_action.type

The action that the bot should execute.

initial_response_setting.next_step.intent

Override settings to configure the intent state.

Show child fields
initial_response_setting.next_step.intent.name

The name of the intent. Only required when you're switching intents.

initial_response_setting.next_step.intent.slots

A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.

initial_response_setting.next_step.session_attributes

Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

input_contexts

A list of contexts that must be active for the intent to be considered for sending to the user.

STRUCT(
"name" VARCHAR
)[]
Show child fields
input_contexts[]
Show child fields
input_contexts[].name

The name of the context.

intent_closing_setting

The response that Amazon Lex sends to when the intent is closed.

STRUCT(
"closing_response" STRUCT(
"message_groups" STRUCT(
"message" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
),
"variations" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
)[]
)[],
"allow_interrupt" BOOLEAN
),
"active" BOOLEAN,
"next_step" STRUCT(
"dialog_action" STRUCT(
"type" VARCHAR,
"slot_to_elicit" VARCHAR,
"suppress_next_message" BOOLEAN
),
"intent" STRUCT(
"name" VARCHAR,
"slots" MAP(VARCHAR, STRUCT(
"shape" VARCHAR,
"value" STRUCT(
"interpreted_value" VARCHAR
)
))
),
"session_attributes" MAP(VARCHAR, VARCHAR)
),
"conditional" STRUCT(
"active" BOOLEAN,
"conditional_branches" STRUCT(
"name" VARCHAR,
"condition" STRUCT(
"expression_string" VARCHAR
),
"next_step" STRUCT(
"dialog_action" STRUCT(
"type" VARCHAR,
"slot_to_elicit" VARCHAR,
"suppress_next_message" BOOLEAN
),
"intent" STRUCT(
"name" VARCHAR,
"slots" MAP(VARCHAR, STRUCT(
"shape" VARCHAR,
"value" STRUCT(
"interpreted_value" VARCHAR
)
))
),
"session_attributes" MAP(VARCHAR, VARCHAR)
),
"response" STRUCT(
"message_groups" STRUCT(
"message" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
),
"variations" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
)[]
)[],
"allow_interrupt" BOOLEAN
)
)[],
"default_branch" STRUCT(
"next_step" STRUCT(
"dialog_action" STRUCT(
"type" VARCHAR,
"slot_to_elicit" VARCHAR,
"suppress_next_message" BOOLEAN
),
"intent" STRUCT(
"name" VARCHAR,
"slots" MAP(VARCHAR, STRUCT(
"shape" VARCHAR,
"value" STRUCT(
"interpreted_value" VARCHAR
)
))
),
"session_attributes" MAP(VARCHAR, VARCHAR)
),
"response" STRUCT(
"message_groups" STRUCT(
"message" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
),
"variations" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
)[]
)[],
"allow_interrupt" BOOLEAN
)
)
)
)
Show child fields
intent_closing_setting.active

Specifies whether an intent's closing response is used. When this field is false, the closing response isn't sent to the user. If the active field isn't specified, the default is true.

intent_closing_setting.closing_response

The response that Amazon Lex sends to the user when the intent is complete.

Show child fields
intent_closing_setting.closing_response.allow_interrupt

Indicates whether the user can interrupt a speech response from Amazon Lex.

intent_closing_setting.closing_response.message_groups[]
Show child fields
intent_closing_setting.closing_response.message_groups[].message

The primary message that Amazon Lex should send to the user.

Show child fields
intent_closing_setting.closing_response.message_groups[].message.custom_payload

A message in a custom format defined by the client application.

Show child fields
intent_closing_setting.closing_response.message_groups[].message.custom_payload.value

The string that is sent to your application.

intent_closing_setting.closing_response.message_groups[].message.image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
intent_closing_setting.closing_response.message_groups[].message.image_response_card.buttons[]
Show child fields
intent_closing_setting.closing_response.message_groups[].message.image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

intent_closing_setting.closing_response.message_groups[].message.image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

intent_closing_setting.closing_response.message_groups[].message.image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

intent_closing_setting.closing_response.message_groups[].message.image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

intent_closing_setting.closing_response.message_groups[].message.image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

intent_closing_setting.closing_response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
intent_closing_setting.closing_response.message_groups[].message.plain_text_message.value

The message to send to the user.

intent_closing_setting.closing_response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
intent_closing_setting.closing_response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

intent_closing_setting.closing_response.message_groups[].variations[]
Show child fields
intent_closing_setting.closing_response.message_groups[].variations[].custom_payload

A message in a custom format defined by the client application.

Show child fields
intent_closing_setting.closing_response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

intent_closing_setting.closing_response.message_groups[].variations[].image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
intent_closing_setting.closing_response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
intent_closing_setting.closing_response.message_groups[].variations[].image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

intent_closing_setting.closing_response.message_groups[].variations[].image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

intent_closing_setting.closing_response.message_groups[].variations[].image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

intent_closing_setting.closing_response.message_groups[].variations[].image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

intent_closing_setting.closing_response.message_groups[].variations[].image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

intent_closing_setting.closing_response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
intent_closing_setting.closing_response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

intent_closing_setting.closing_response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
intent_closing_setting.closing_response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

intent_closing_setting.conditional

A list of conditional branches associated with the intent's closing response. These branches are executed when the nextStep attribute is set to EvalutateConditional.

Show child fields
intent_closing_setting.conditional.active

Determines whether a conditional branch is active. When active is false, the conditions are not evaluated.

intent_closing_setting.conditional.conditional_branches[]
Show child fields
intent_closing_setting.conditional.conditional_branches[].condition

Contains the expression to evaluate. If the condition is true, the branch's actions are taken.

Show child fields
intent_closing_setting.conditional.conditional_branches[].condition.expression_string

The expression string that is evaluated.

intent_closing_setting.conditional.conditional_branches[].name

The name of the branch.

intent_closing_setting.conditional.conditional_branches[].next_step

The next step in the conversation.

Show child fields
intent_closing_setting.conditional.conditional_branches[].next_step.dialog_action

Defines the action that the bot executes at runtime when the conversation reaches this step.

Show child fields
intent_closing_setting.conditional.conditional_branches[].next_step.dialog_action.slot_to_elicit

If the dialog action is ElicitSlot, defines the slot to elicit from the user.

intent_closing_setting.conditional.conditional_branches[].next_step.dialog_action.suppress_next_message

When true the next message for the intent is not used.

intent_closing_setting.conditional.conditional_branches[].next_step.dialog_action.type

The action that the bot should execute.

intent_closing_setting.conditional.conditional_branches[].next_step.intent

Override settings to configure the intent state.

Show child fields
intent_closing_setting.conditional.conditional_branches[].next_step.intent.name

The name of the intent. Only required when you're switching intents.

intent_closing_setting.conditional.conditional_branches[].next_step.intent.slots

A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.

intent_closing_setting.conditional.conditional_branches[].next_step.session_attributes

Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

intent_closing_setting.conditional.conditional_branches[].response

Specifies a list of message groups that Amazon Lex uses to respond the user input.

Show child fields
intent_closing_setting.conditional.conditional_branches[].response.allow_interrupt

Indicates whether the user can interrupt a speech response from Amazon Lex.

intent_closing_setting.conditional.conditional_branches[].response.message_groups[]
Show child fields
intent_closing_setting.conditional.conditional_branches[].response.message_groups[].message

The primary message that Amazon Lex should send to the user.

Show child fields
intent_closing_setting.conditional.conditional_branches[].response.message_groups[].message.custom_payload

A message in a custom format defined by the client application.

Show child fields
intent_closing_setting.conditional.conditional_branches[].response.message_groups[].message.custom_payload.value

The string that is sent to your application.

intent_closing_setting.conditional.conditional_branches[].response.message_groups[].message.image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
intent_closing_setting.conditional.conditional_branches[].response.message_groups[].message.image_response_card.buttons[]
Show child fields
intent_closing_setting.conditional.conditional_branches[].response.message_groups[].message.image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

intent_closing_setting.conditional.conditional_branches[].response.message_groups[].message.image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

intent_closing_setting.conditional.conditional_branches[].response.message_groups[].message.image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

intent_closing_setting.conditional.conditional_branches[].response.message_groups[].message.image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

intent_closing_setting.conditional.conditional_branches[].response.message_groups[].message.image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

intent_closing_setting.conditional.conditional_branches[].response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
intent_closing_setting.conditional.conditional_branches[].response.message_groups[].message.plain_text_message.value

The message to send to the user.

intent_closing_setting.conditional.conditional_branches[].response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
intent_closing_setting.conditional.conditional_branches[].response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

intent_closing_setting.conditional.conditional_branches[].response.message_groups[].variations[]
Show child fields
intent_closing_setting.conditional.conditional_branches[].response.message_groups[].variations[].custom_payload

A message in a custom format defined by the client application.

Show child fields
intent_closing_setting.conditional.conditional_branches[].response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

intent_closing_setting.conditional.conditional_branches[].response.message_groups[].variations[].image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
intent_closing_setting.conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
intent_closing_setting.conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

intent_closing_setting.conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

intent_closing_setting.conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

intent_closing_setting.conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

intent_closing_setting.conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

intent_closing_setting.conditional.conditional_branches[].response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
intent_closing_setting.conditional.conditional_branches[].response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

intent_closing_setting.conditional.conditional_branches[].response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
intent_closing_setting.conditional.conditional_branches[].response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

intent_closing_setting.conditional.default_branch

The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.

Show child fields
intent_closing_setting.conditional.default_branch.next_step

The next step in the conversation.

Show child fields
intent_closing_setting.conditional.default_branch.next_step.dialog_action

Defines the action that the bot executes at runtime when the conversation reaches this step.

Show child fields
intent_closing_setting.conditional.default_branch.next_step.dialog_action.slot_to_elicit

If the dialog action is ElicitSlot, defines the slot to elicit from the user.

intent_closing_setting.conditional.default_branch.next_step.dialog_action.suppress_next_message

When true the next message for the intent is not used.

intent_closing_setting.conditional.default_branch.next_step.dialog_action.type

The action that the bot should execute.

intent_closing_setting.conditional.default_branch.next_step.intent

Override settings to configure the intent state.

Show child fields
intent_closing_setting.conditional.default_branch.next_step.intent.name

The name of the intent. Only required when you're switching intents.

intent_closing_setting.conditional.default_branch.next_step.intent.slots

A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.

intent_closing_setting.conditional.default_branch.next_step.session_attributes

Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

intent_closing_setting.conditional.default_branch.response

Specifies a list of message groups that Amazon Lex uses to respond the user input.

Show child fields
intent_closing_setting.conditional.default_branch.response.allow_interrupt

Indicates whether the user can interrupt a speech response from Amazon Lex.

intent_closing_setting.conditional.default_branch.response.message_groups[]
Show child fields
intent_closing_setting.conditional.default_branch.response.message_groups[].message

The primary message that Amazon Lex should send to the user.

Show child fields
intent_closing_setting.conditional.default_branch.response.message_groups[].message.custom_payload

A message in a custom format defined by the client application.

Show child fields
intent_closing_setting.conditional.default_branch.response.message_groups[].message.custom_payload.value

The string that is sent to your application.

intent_closing_setting.conditional.default_branch.response.message_groups[].message.image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
intent_closing_setting.conditional.default_branch.response.message_groups[].message.image_response_card.buttons[]
Show child fields
intent_closing_setting.conditional.default_branch.response.message_groups[].message.image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

intent_closing_setting.conditional.default_branch.response.message_groups[].message.image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

intent_closing_setting.conditional.default_branch.response.message_groups[].message.image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

intent_closing_setting.conditional.default_branch.response.message_groups[].message.image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

intent_closing_setting.conditional.default_branch.response.message_groups[].message.image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

intent_closing_setting.conditional.default_branch.response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
intent_closing_setting.conditional.default_branch.response.message_groups[].message.plain_text_message.value

The message to send to the user.

intent_closing_setting.conditional.default_branch.response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
intent_closing_setting.conditional.default_branch.response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

intent_closing_setting.conditional.default_branch.response.message_groups[].variations[]
Show child fields
intent_closing_setting.conditional.default_branch.response.message_groups[].variations[].custom_payload

A message in a custom format defined by the client application.

Show child fields
intent_closing_setting.conditional.default_branch.response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

intent_closing_setting.conditional.default_branch.response.message_groups[].variations[].image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
intent_closing_setting.conditional.default_branch.response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
intent_closing_setting.conditional.default_branch.response.message_groups[].variations[].image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

intent_closing_setting.conditional.default_branch.response.message_groups[].variations[].image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

intent_closing_setting.conditional.default_branch.response.message_groups[].variations[].image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

intent_closing_setting.conditional.default_branch.response.message_groups[].variations[].image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

intent_closing_setting.conditional.default_branch.response.message_groups[].variations[].image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

intent_closing_setting.conditional.default_branch.response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
intent_closing_setting.conditional.default_branch.response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

intent_closing_setting.conditional.default_branch.response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
intent_closing_setting.conditional.default_branch.response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

intent_closing_setting.next_step

Specifies the next step that the bot executes after playing the intent's closing response.

Show child fields
intent_closing_setting.next_step.dialog_action

Defines the action that the bot executes at runtime when the conversation reaches this step.

Show child fields
intent_closing_setting.next_step.dialog_action.slot_to_elicit

If the dialog action is ElicitSlot, defines the slot to elicit from the user.

intent_closing_setting.next_step.dialog_action.suppress_next_message

When true the next message for the intent is not used.

intent_closing_setting.next_step.dialog_action.type

The action that the bot should execute.

intent_closing_setting.next_step.intent

Override settings to configure the intent state.

Show child fields
intent_closing_setting.next_step.intent.name

The name of the intent. Only required when you're switching intents.

intent_closing_setting.next_step.intent.slots

A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.

intent_closing_setting.next_step.session_attributes

Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

intent_confirmation_setting

Prompts that Amazon Lex sends to the user to confirm completion of an intent.

STRUCT(
"prompt_specification" STRUCT(
"message_groups" STRUCT(
"message" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
),
"variations" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
)[]
)[],
"max_retries" BIGINT,
"allow_interrupt" BOOLEAN,
"message_selection_strategy" VARCHAR,
"prompt_attempts_specification" MAP(VARCHAR, STRUCT(
"allow_interrupt" BOOLEAN,
"allowed_input_types" STRUCT(
"allow_audio_input" BOOLEAN,
"allow_dtmf_input" BOOLEAN
),
"audio_and_dtmf_input_specification" STRUCT(
"start_timeout_ms" BIGINT,
"audio_specification" STRUCT(
"max_length_ms" BIGINT,
"end_timeout_ms" BIGINT
),
"dtmf_specification" STRUCT(
"max_length" BIGINT,
"end_timeout_ms" BIGINT,
"deletion_character" VARCHAR,
"end_character" VARCHAR
)
),
"text_input_specification" STRUCT(
"start_timeout_ms" BIGINT
)
))
),
"declination_response" STRUCT(
"message_groups" STRUCT(
"message" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
),
"variations" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
)[]
)[],
"allow_interrupt" BOOLEAN
),
"active" BOOLEAN,
"confirmation_response" STRUCT(
"message_groups" STRUCT(
"message" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
),
"variations" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
)[]
)[],
"allow_interrupt" BOOLEAN
),
"confirmation_next_step" STRUCT(
"dialog_action" STRUCT(
"type" VARCHAR,
"slot_to_elicit" VARCHAR,
"suppress_next_message" BOOLEAN
),
"intent" STRUCT(
"name" VARCHAR,
"slots" MAP(VARCHAR, STRUCT(
"shape" VARCHAR,
"value" STRUCT(
"interpreted_value" VARCHAR
)
))
),
"session_attributes" MAP(VARCHAR, VARCHAR)
),
"confirmation_conditional" STRUCT(
"active" BOOLEAN,
"conditional_branches" STRUCT(
"name" VARCHAR,
"condition" STRUCT(
"expression_string" VARCHAR
),
"next_step" STRUCT(
"dialog_action" STRUCT(
"type" VARCHAR,
"slot_to_elicit" VARCHAR,
"suppress_next_message" BOOLEAN
),
"intent" STRUCT(
"name" VARCHAR,
"slots" MAP(VARCHAR, STRUCT(
"shape" VARCHAR,
"value" STRUCT(
"interpreted_value" VARCHAR
)
))
),
"session_attributes" MAP(VARCHAR, VARCHAR)
),
"response" STRUCT(
"message_groups" STRUCT(
"message" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
),
"variations" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
)[]
)[],
"allow_interrupt" BOOLEAN
)
)[],
"default_branch" STRUCT(
"next_step" STRUCT(
"dialog_action" STRUCT(
"type" VARCHAR,
"slot_to_elicit" VARCHAR,
"suppress_next_message" BOOLEAN
),
"intent" STRUCT(
"name" VARCHAR,
"slots" MAP(VARCHAR, STRUCT(
"shape" VARCHAR,
"value" STRUCT(
"interpreted_value" VARCHAR
)
))
),
"session_attributes" MAP(VARCHAR, VARCHAR)
),
"response" STRUCT(
"message_groups" STRUCT(
"message" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
),
"variations" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
)[]
)[],
"allow_interrupt" BOOLEAN
)
)
),
"declination_next_step" STRUCT(
"dialog_action" STRUCT(
"type" VARCHAR,
"slot_to_elicit" VARCHAR,
"suppress_next_message" BOOLEAN
),
"intent" STRUCT(
"name" VARCHAR,
"slots" MAP(VARCHAR, STRUCT(
"shape" VARCHAR,
"value" STRUCT(
"interpreted_value" VARCHAR
)
))
),
"session_attributes" MAP(VARCHAR, VARCHAR)
),
"declination_conditional" STRUCT(
"active" BOOLEAN,
"conditional_branches" STRUCT(
"name" VARCHAR,
"condition" STRUCT(
"expression_string" VARCHAR
),
"next_step" STRUCT(
"dialog_action" STRUCT(
"type" VARCHAR,
"slot_to_elicit" VARCHAR,
"suppress_next_message" BOOLEAN
),
"intent" STRUCT(
"name" VARCHAR,
"slots" MAP(VARCHAR, STRUCT(
"shape" VARCHAR,
"value" STRUCT(
"interpreted_value" VARCHAR
)
))
),
"session_attributes" MAP(VARCHAR, VARCHAR)
),
"response" STRUCT(
"message_groups" STRUCT(
"message" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
),
"variations" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
)[]
)[],
"allow_interrupt" BOOLEAN
)
)[],
"default_branch" STRUCT(
"next_step" STRUCT(
"dialog_action" STRUCT(
"type" VARCHAR,
"slot_to_elicit" VARCHAR,
"suppress_next_message" BOOLEAN
),
"intent" STRUCT(
"name" VARCHAR,
"slots" MAP(VARCHAR, STRUCT(
"shape" VARCHAR,
"value" STRUCT(
"interpreted_value" VARCHAR
)
))
),
"session_attributes" MAP(VARCHAR, VARCHAR)
),
"response" STRUCT(
"message_groups" STRUCT(
"message" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
),
"variations" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
)[]
)[],
"allow_interrupt" BOOLEAN
)
)
),
"failure_response" STRUCT(
"message_groups" STRUCT(
"message" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
),
"variations" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
)[]
)[],
"allow_interrupt" BOOLEAN
),
"failure_next_step" STRUCT(
"dialog_action" STRUCT(
"type" VARCHAR,
"slot_to_elicit" VARCHAR,
"suppress_next_message" BOOLEAN
),
"intent" STRUCT(
"name" VARCHAR,
"slots" MAP(VARCHAR, STRUCT(
"shape" VARCHAR,
"value" STRUCT(
"interpreted_value" VARCHAR
)
))
),
"session_attributes" MAP(VARCHAR, VARCHAR)
),
"failure_conditional" STRUCT(
"active" BOOLEAN,
"conditional_branches" STRUCT(
"name" VARCHAR,
"condition" STRUCT(
"expression_string" VARCHAR
),
"next_step" STRUCT(
"dialog_action" STRUCT(
"type" VARCHAR,
"slot_to_elicit" VARCHAR,
"suppress_next_message" BOOLEAN
),
"intent" STRUCT(
"name" VARCHAR,
"slots" MAP(VARCHAR, STRUCT(
"shape" VARCHAR,
"value" STRUCT(
"interpreted_value" VARCHAR
)
))
),
"session_attributes" MAP(VARCHAR, VARCHAR)
),
"response" STRUCT(
"message_groups" STRUCT(
"message" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
),
"variations" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
)[]
)[],
"allow_interrupt" BOOLEAN
)
)[],
"default_branch" STRUCT(
"next_step" STRUCT(
"dialog_action" STRUCT(
"type" VARCHAR,
"slot_to_elicit" VARCHAR,
"suppress_next_message" BOOLEAN
),
"intent" STRUCT(
"name" VARCHAR,
"slots" MAP(VARCHAR, STRUCT(
"shape" VARCHAR,
"value" STRUCT(
"interpreted_value" VARCHAR
)
))
),
"session_attributes" MAP(VARCHAR, VARCHAR)
),
"response" STRUCT(
"message_groups" STRUCT(
"message" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
),
"variations" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
)[]
)[],
"allow_interrupt" BOOLEAN
)
)
),
"code_hook" STRUCT(
"enable_code_hook_invocation" BOOLEAN,
"active" BOOLEAN,
"invocation_label" VARCHAR,
"post_code_hook_specification" STRUCT(
"success_response" STRUCT(
"message_groups" STRUCT(
"message" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
),
"variations" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
)[]
)[],
"allow_interrupt" BOOLEAN
),
"success_next_step" STRUCT(
"dialog_action" STRUCT(
"type" VARCHAR,
"slot_to_elicit" VARCHAR,
"suppress_next_message" BOOLEAN
),
"intent" STRUCT(
"name" VARCHAR,
"slots" MAP(VARCHAR, STRUCT(
"shape" VARCHAR,
"value" STRUCT(
"interpreted_value" VARCHAR
)
))
),
"session_attributes" MAP(VARCHAR, VARCHAR)
),
"success_conditional" STRUCT(
"active" BOOLEAN,
"conditional_branches" STRUCT(
"name" VARCHAR,
"condition" STRUCT(
"expression_string" VARCHAR
),
"next_step" STRUCT(
"dialog_action" STRUCT(
"type" VARCHAR,
"slot_to_elicit" VARCHAR,
"suppress_next_message" BOOLEAN
),
"intent" STRUCT(
"name" VARCHAR,
"slots" MAP(VARCHAR, STRUCT(
"shape" VARCHAR,
"value" STRUCT(
"interpreted_value" VARCHAR
)
))
),
"session_attributes" MAP(VARCHAR, VARCHAR)
),
"response" STRUCT(
"message_groups" STRUCT(
"message" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
),
"variations" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
)[]
)[],
"allow_interrupt" BOOLEAN
)
)[],
"default_branch" STRUCT(
"next_step" STRUCT(
"dialog_action" STRUCT(
"type" VARCHAR,
"slot_to_elicit" VARCHAR,
"suppress_next_message" BOOLEAN
),
"intent" STRUCT(
"name" VARCHAR,
"slots" MAP(VARCHAR, STRUCT(
"shape" VARCHAR,
"value" STRUCT(
"interpreted_value" VARCHAR
)
))
),
"session_attributes" MAP(VARCHAR, VARCHAR)
),
"response" STRUCT(
"message_groups" STRUCT(
"message" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
),
"variations" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
)[]
)[],
"allow_interrupt" BOOLEAN
)
)
),
"failure_response" STRUCT(
"message_groups" STRUCT(
"message" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
),
"variations" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
)[]
)[],
"allow_interrupt" BOOLEAN
),
"failure_next_step" STRUCT(
"dialog_action" STRUCT(
"type" VARCHAR,
"slot_to_elicit" VARCHAR,
"suppress_next_message" BOOLEAN
),
"intent" STRUCT(
"name" VARCHAR,
"slots" MAP(VARCHAR, STRUCT(
"shape" VARCHAR,
"value" STRUCT(
"interpreted_value" VARCHAR
)
))
),
"session_attributes" MAP(VARCHAR, VARCHAR)
),
"failure_conditional" STRUCT(
"active" BOOLEAN,
"conditional_branches" STRUCT(
"name" VARCHAR,
"condition" STRUCT(
"expression_string" VARCHAR
),
"next_step" STRUCT(
"dialog_action" STRUCT(
"type" VARCHAR,
"slot_to_elicit" VARCHAR,
"suppress_next_message" BOOLEAN
),
"intent" STRUCT(
"name" VARCHAR,
"slots" MAP(VARCHAR, STRUCT(
"shape" VARCHAR,
"value" STRUCT(
"interpreted_value" VARCHAR
)
))
),
"session_attributes" MAP(VARCHAR, VARCHAR)
),
"response" STRUCT(
"message_groups" STRUCT(
"message" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
),
"variations" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
)[]
)[],
"allow_interrupt" BOOLEAN
)
)[],
"default_branch" STRUCT(
"next_step" STRUCT(
"dialog_action" STRUCT(
"type" VARCHAR,
"slot_to_elicit" VARCHAR,
"suppress_next_message" BOOLEAN
),
"intent" STRUCT(
"name" VARCHAR,
"slots" MAP(VARCHAR, STRUCT(
"shape" VARCHAR,
"value" STRUCT(
"interpreted_value" VARCHAR
)
))
),
"session_attributes" MAP(VARCHAR, VARCHAR)
),
"response" STRUCT(
"message_groups" STRUCT(
"message" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
),
"variations" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
)[]
)[],
"allow_interrupt" BOOLEAN
)
)
),
"timeout_response" STRUCT(
"message_groups" STRUCT(
"message" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
),
"variations" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
)[]
)[],
"allow_interrupt" BOOLEAN
),
"timeout_next_step" STRUCT(
"dialog_action" STRUCT(
"type" VARCHAR,
"slot_to_elicit" VARCHAR,
"suppress_next_message" BOOLEAN
),
"intent" STRUCT(
"name" VARCHAR,
"slots" MAP(VARCHAR, STRUCT(
"shape" VARCHAR,
"value" STRUCT(
"interpreted_value" VARCHAR
)
))
),
"session_attributes" MAP(VARCHAR, VARCHAR)
),
"timeout_conditional" STRUCT(
"active" BOOLEAN,
"conditional_branches" STRUCT(
"name" VARCHAR,
"condition" STRUCT(
"expression_string" VARCHAR
),
"next_step" STRUCT(
"dialog_action" STRUCT(
"type" VARCHAR,
"slot_to_elicit" VARCHAR,
"suppress_next_message" BOOLEAN
),
"intent" STRUCT(
"name" VARCHAR,
"slots" MAP(VARCHAR, STRUCT(
"shape" VARCHAR,
"value" STRUCT(
"interpreted_value" VARCHAR
)
))
),
"session_attributes" MAP(VARCHAR, VARCHAR)
),
"response" STRUCT(
"message_groups" STRUCT(
"message" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
),
"variations" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
)[]
)[],
"allow_interrupt" BOOLEAN
)
)[],
"default_branch" STRUCT(
"next_step" STRUCT(
"dialog_action" STRUCT(
"type" VARCHAR,
"slot_to_elicit" VARCHAR,
"suppress_next_message" BOOLEAN
),
"intent" STRUCT(
"name" VARCHAR,
"slots" MAP(VARCHAR, STRUCT(
"shape" VARCHAR,
"value" STRUCT(
"interpreted_value" VARCHAR
)
))
),
"session_attributes" MAP(VARCHAR, VARCHAR)
),
"response" STRUCT(
"message_groups" STRUCT(
"message" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
),
"variations" STRUCT(
"plain_text_message" STRUCT(
"value" VARCHAR
),
"custom_payload" STRUCT(
"value" VARCHAR
),
"ssml_message" STRUCT(
"value" VARCHAR
),
"image_response_card" STRUCT(
"title" VARCHAR,
"subtitle" VARCHAR,
"image_url" VARCHAR,
"buttons" STRUCT(
"text" VARCHAR,
"value" VARCHAR
)[]
)
)[]
)[],
"allow_interrupt" BOOLEAN
)
)
)
)
),
"elicitation_code_hook" STRUCT(
"enable_code_hook_invocation" BOOLEAN,
"invocation_label" VARCHAR
)
)
Show child fields
intent_confirmation_setting.active

Specifies whether the intent's confirmation is sent to the user. When this field is false, confirmation and declination responses aren't sent. If the active field isn't specified, the default is true.

intent_confirmation_setting.code_hook

The DialogCodeHookInvocationSetting object associated with intent's confirmation step. The dialog code hook is triggered based on these invocation settings when the confirmation next step or declination next step or failure next step is InvokeDialogCodeHook.

Show child fields
intent_confirmation_setting.code_hook.active

Determines whether a dialog code hook is used when the intent is activated.

intent_confirmation_setting.code_hook.enable_code_hook_invocation

Indicates whether a Lambda function should be invoked for the dialog.

intent_confirmation_setting.code_hook.invocation_label

A label that indicates the dialog step from which the dialog code hook is happening.

intent_confirmation_setting.code_hook.post_code_hook_specification

Contains the responses and actions that Amazon Lex takes after the Lambda function is complete.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional

A list of conditional branches to evaluate after the dialog code hook throws an exception or returns with the State field of the Intent object set to Failed.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.active

Determines whether a conditional branch is active. When active is false, the conditions are not evaluated.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[]
Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].condition

Contains the expression to evaluate. If the condition is true, the branch's actions are taken.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].condition.expression_string

The expression string that is evaluated.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].name

The name of the branch.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].next_step

The next step in the conversation.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].next_step.dialog_action

Defines the action that the bot executes at runtime when the conversation reaches this step.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].next_step.dialog_action.slot_to_elicit

If the dialog action is ElicitSlot, defines the slot to elicit from the user.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].next_step.dialog_action.suppress_next_message

When true the next message for the intent is not used.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].next_step.dialog_action.type

The action that the bot should execute.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].next_step.intent

Override settings to configure the intent state.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].next_step.intent.name

The name of the intent. Only required when you're switching intents.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].next_step.intent.slots

A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].next_step.session_attributes

Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response

Specifies a list of message groups that Amazon Lex uses to respond the user input.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.allow_interrupt

Indicates whether the user can interrupt a speech response from Amazon Lex.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[]
Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].message

The primary message that Amazon Lex should send to the user.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].message.custom_payload

A message in a custom format defined by the client application.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].message.custom_payload.value

The string that is sent to your application.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].message.image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].message.image_response_card.buttons[]
Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].message.image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].message.image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].message.image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].message.image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].message.image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].message.plain_text_message.value

The message to send to the user.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].variations[]
Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].variations[].custom_payload

A message in a custom format defined by the client application.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch

The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.next_step

The next step in the conversation.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.next_step.dialog_action

Defines the action that the bot executes at runtime when the conversation reaches this step.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.next_step.dialog_action.slot_to_elicit

If the dialog action is ElicitSlot, defines the slot to elicit from the user.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.next_step.dialog_action.suppress_next_message

When true the next message for the intent is not used.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.next_step.dialog_action.type

The action that the bot should execute.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.next_step.intent

Override settings to configure the intent state.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.next_step.intent.name

The name of the intent. Only required when you're switching intents.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.next_step.intent.slots

A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.next_step.session_attributes

Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response

Specifies a list of message groups that Amazon Lex uses to respond the user input.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.allow_interrupt

Indicates whether the user can interrupt a speech response from Amazon Lex.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[]
Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].message

The primary message that Amazon Lex should send to the user.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].message.custom_payload

A message in a custom format defined by the client application.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].message.custom_payload.value

The string that is sent to your application.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].message.image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].message.image_response_card.buttons[]
Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].message.image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].message.image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].message.image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].message.image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].message.image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].message.plain_text_message.value

The message to send to the user.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].variations[]
Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].variations[].custom_payload

A message in a custom format defined by the client application.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].variations[].image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].variations[].image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].variations[].image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].variations[].image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].variations[].image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].variations[].image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_next_step

Specifies the next step the bot runs after the dialog code hook throws an exception or returns with the State field of the Intent object set to Failed.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_next_step.dialog_action

Defines the action that the bot executes at runtime when the conversation reaches this step.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_next_step.dialog_action.slot_to_elicit

If the dialog action is ElicitSlot, defines the slot to elicit from the user.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_next_step.dialog_action.suppress_next_message

When true the next message for the intent is not used.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_next_step.dialog_action.type

The action that the bot should execute.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_next_step.intent

Override settings to configure the intent state.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_next_step.intent.name

The name of the intent. Only required when you're switching intents.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_next_step.intent.slots

A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_next_step.session_attributes

Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_response

Specifies a list of message groups that Amazon Lex uses to respond the user input.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_response.allow_interrupt

Indicates whether the user can interrupt a speech response from Amazon Lex.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_response.message_groups[]
Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].message

The primary message that Amazon Lex should send to the user.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].message.custom_payload

A message in a custom format defined by the client application.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].message.custom_payload.value

The string that is sent to your application.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].message.image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].message.image_response_card.buttons[]
Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].message.image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].message.image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].message.image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].message.image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].message.image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].message.plain_text_message.value

The message to send to the user.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].variations[]
Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].variations[].custom_payload

A message in a custom format defined by the client application.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].variations[].image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].variations[].image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].variations[].image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].variations[].image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].variations[].image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].variations[].image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

intent_confirmation_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional

A list of conditional branches to evaluate after the dialog code hook finishes successfully.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.active

Determines whether a conditional branch is active. When active is false, the conditions are not evaluated.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[]
Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].condition

Contains the expression to evaluate. If the condition is true, the branch's actions are taken.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].condition.expression_string

The expression string that is evaluated.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].name

The name of the branch.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].next_step

The next step in the conversation.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].next_step.dialog_action

Defines the action that the bot executes at runtime when the conversation reaches this step.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].next_step.dialog_action.slot_to_elicit

If the dialog action is ElicitSlot, defines the slot to elicit from the user.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].next_step.dialog_action.suppress_next_message

When true the next message for the intent is not used.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].next_step.dialog_action.type

The action that the bot should execute.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].next_step.intent

Override settings to configure the intent state.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].next_step.intent.name

The name of the intent. Only required when you're switching intents.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].next_step.intent.slots

A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].next_step.session_attributes

Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response

Specifies a list of message groups that Amazon Lex uses to respond the user input.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.allow_interrupt

Indicates whether the user can interrupt a speech response from Amazon Lex.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[]
Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].message

The primary message that Amazon Lex should send to the user.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].message.custom_payload

A message in a custom format defined by the client application.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].message.custom_payload.value

The string that is sent to your application.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].message.image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].message.image_response_card.buttons[]
Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].message.image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].message.image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].message.image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].message.image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].message.image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].message.plain_text_message.value

The message to send to the user.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].variations[]
Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].variations[].custom_payload

A message in a custom format defined by the client application.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.default_branch

The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.next_step

The next step in the conversation.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.next_step.dialog_action

Defines the action that the bot executes at runtime when the conversation reaches this step.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.next_step.dialog_action.slot_to_elicit

If the dialog action is ElicitSlot, defines the slot to elicit from the user.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.next_step.dialog_action.suppress_next_message

When true the next message for the intent is not used.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.next_step.dialog_action.type

The action that the bot should execute.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.next_step.intent

Override settings to configure the intent state.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.next_step.intent.name

The name of the intent. Only required when you're switching intents.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.next_step.intent.slots

A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.next_step.session_attributes

Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response

Specifies a list of message groups that Amazon Lex uses to respond the user input.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.allow_interrupt

Indicates whether the user can interrupt a speech response from Amazon Lex.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[]
Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].message

The primary message that Amazon Lex should send to the user.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].message.custom_payload

A message in a custom format defined by the client application.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].message.custom_payload.value

The string that is sent to your application.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].message.image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].message.image_response_card.buttons[]
Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].message.image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].message.image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].message.image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].message.image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].message.image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].message.plain_text_message.value

The message to send to the user.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].variations[]
Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].variations[].custom_payload

A message in a custom format defined by the client application.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].variations[].image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].variations[].image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].variations[].image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].variations[].image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].variations[].image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].variations[].image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_next_step

Specifics the next step the bot runs after the dialog code hook finishes successfully.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_next_step.dialog_action

Defines the action that the bot executes at runtime when the conversation reaches this step.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_next_step.dialog_action.slot_to_elicit

If the dialog action is ElicitSlot, defines the slot to elicit from the user.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_next_step.dialog_action.suppress_next_message

When true the next message for the intent is not used.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_next_step.dialog_action.type

The action that the bot should execute.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_next_step.intent

Override settings to configure the intent state.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_next_step.intent.name

The name of the intent. Only required when you're switching intents.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_next_step.intent.slots

A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_next_step.session_attributes

Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_response

Specifies a list of message groups that Amazon Lex uses to respond the user input.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_response.allow_interrupt

Indicates whether the user can interrupt a speech response from Amazon Lex.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_response.message_groups[]
Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_response.message_groups[].message

The primary message that Amazon Lex should send to the user.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_response.message_groups[].message.custom_payload

A message in a custom format defined by the client application.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_response.message_groups[].message.custom_payload.value

The string that is sent to your application.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_response.message_groups[].message.image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_response.message_groups[].message.image_response_card.buttons[]
Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_response.message_groups[].message.image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_response.message_groups[].message.image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_response.message_groups[].message.image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_response.message_groups[].message.image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_response.message_groups[].message.image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_response.message_groups[].message.plain_text_message.value

The message to send to the user.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_response.message_groups[].variations[]
Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_response.message_groups[].variations[].custom_payload

A message in a custom format defined by the client application.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_response.message_groups[].variations[].image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_response.message_groups[].variations[].image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_response.message_groups[].variations[].image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_response.message_groups[].variations[].image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_response.message_groups[].variations[].image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_response.message_groups[].variations[].image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

intent_confirmation_setting.code_hook.post_code_hook_specification.success_response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.success_response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional

A list of conditional branches to evaluate if the code hook times out.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.active

Determines whether a conditional branch is active. When active is false, the conditions are not evaluated.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[]
Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].condition

Contains the expression to evaluate. If the condition is true, the branch's actions are taken.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].condition.expression_string

The expression string that is evaluated.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].name

The name of the branch.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].next_step

The next step in the conversation.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].next_step.dialog_action

Defines the action that the bot executes at runtime when the conversation reaches this step.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].next_step.dialog_action.slot_to_elicit

If the dialog action is ElicitSlot, defines the slot to elicit from the user.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].next_step.dialog_action.suppress_next_message

When true the next message for the intent is not used.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].next_step.dialog_action.type

The action that the bot should execute.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].next_step.intent

Override settings to configure the intent state.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].next_step.intent.name

The name of the intent. Only required when you're switching intents.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].next_step.intent.slots

A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].next_step.session_attributes

Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response

Specifies a list of message groups that Amazon Lex uses to respond the user input.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.allow_interrupt

Indicates whether the user can interrupt a speech response from Amazon Lex.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[]
Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].message

The primary message that Amazon Lex should send to the user.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].message.custom_payload

A message in a custom format defined by the client application.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].message.custom_payload.value

The string that is sent to your application.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].message.image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].message.image_response_card.buttons[]
Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].message.image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].message.image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].message.image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].message.image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].message.image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].message.plain_text_message.value

The message to send to the user.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].variations[]
Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].variations[].custom_payload

A message in a custom format defined by the client application.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch

The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.next_step

The next step in the conversation.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.next_step.dialog_action

Defines the action that the bot executes at runtime when the conversation reaches this step.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.next_step.dialog_action.slot_to_elicit

If the dialog action is ElicitSlot, defines the slot to elicit from the user.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.next_step.dialog_action.suppress_next_message

When true the next message for the intent is not used.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.next_step.dialog_action.type

The action that the bot should execute.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.next_step.intent

Override settings to configure the intent state.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.next_step.intent.name

The name of the intent. Only required when you're switching intents.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.next_step.intent.slots

A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.next_step.session_attributes

Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response

Specifies a list of message groups that Amazon Lex uses to respond the user input.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.allow_interrupt

Indicates whether the user can interrupt a speech response from Amazon Lex.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[]
Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].message

The primary message that Amazon Lex should send to the user.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].message.custom_payload

A message in a custom format defined by the client application.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].message.custom_payload.value

The string that is sent to your application.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].message.image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].message.image_response_card.buttons[]
Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].message.image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].message.image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].message.image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].message.image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].message.image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].message.plain_text_message.value

The message to send to the user.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].variations[]
Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].variations[].custom_payload

A message in a custom format defined by the client application.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].variations[].image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].variations[].image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].variations[].image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].variations[].image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].variations[].image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].variations[].image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_next_step

Specifies the next step that the bot runs when the code hook times out.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_next_step.dialog_action

Defines the action that the bot executes at runtime when the conversation reaches this step.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_next_step.dialog_action.slot_to_elicit

If the dialog action is ElicitSlot, defines the slot to elicit from the user.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_next_step.dialog_action.suppress_next_message

When true the next message for the intent is not used.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_next_step.dialog_action.type

The action that the bot should execute.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_next_step.intent

Override settings to configure the intent state.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_next_step.intent.name

The name of the intent. Only required when you're switching intents.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_next_step.intent.slots

A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_next_step.session_attributes

Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_response

Specifies a list of message groups that Amazon Lex uses to respond the user input.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_response.allow_interrupt

Indicates whether the user can interrupt a speech response from Amazon Lex.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[]
Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].message

The primary message that Amazon Lex should send to the user.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].message.custom_payload

A message in a custom format defined by the client application.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].message.custom_payload.value

The string that is sent to your application.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].message.image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].message.image_response_card.buttons[]
Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].message.image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].message.image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].message.image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].message.image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].message.image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].message.plain_text_message.value

The message to send to the user.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].variations[]
Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].variations[].custom_payload

A message in a custom format defined by the client application.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].variations[].image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].variations[].image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].variations[].image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].variations[].image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].variations[].image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].variations[].image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
intent_confirmation_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

intent_confirmation_setting.confirmation_conditional

A list of conditional branches to evaluate after the intent is closed.

Show child fields
intent_confirmation_setting.confirmation_conditional.active

Determines whether a conditional branch is active. When active is false, the conditions are not evaluated.

intent_confirmation_setting.confirmation_conditional.conditional_branches[]
Show child fields
intent_confirmation_setting.confirmation_conditional.conditional_branches[].condition

Contains the expression to evaluate. If the condition is true, the branch's actions are taken.

Show child fields
intent_confirmation_setting.confirmation_conditional.conditional_branches[].condition.expression_string

The expression string that is evaluated.

intent_confirmation_setting.confirmation_conditional.conditional_branches[].name

The name of the branch.

intent_confirmation_setting.confirmation_conditional.conditional_branches[].next_step

The next step in the conversation.

Show child fields
intent_confirmation_setting.confirmation_conditional.conditional_branches[].next_step.dialog_action

Defines the action that the bot executes at runtime when the conversation reaches this step.

Show child fields
intent_confirmation_setting.confirmation_conditional.conditional_branches[].next_step.dialog_action.slot_to_elicit

If the dialog action is ElicitSlot, defines the slot to elicit from the user.

intent_confirmation_setting.confirmation_conditional.conditional_branches[].next_step.dialog_action.suppress_next_message

When true the next message for the intent is not used.

intent_confirmation_setting.confirmation_conditional.conditional_branches[].next_step.dialog_action.type

The action that the bot should execute.

intent_confirmation_setting.confirmation_conditional.conditional_branches[].next_step.intent

Override settings to configure the intent state.

Show child fields
intent_confirmation_setting.confirmation_conditional.conditional_branches[].next_step.intent.name

The name of the intent. Only required when you're switching intents.

intent_confirmation_setting.confirmation_conditional.conditional_branches[].next_step.intent.slots

A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.

intent_confirmation_setting.confirmation_conditional.conditional_branches[].next_step.session_attributes

Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

intent_confirmation_setting.confirmation_conditional.conditional_branches[].response

Specifies a list of message groups that Amazon Lex uses to respond the user input.

Show child fields
intent_confirmation_setting.confirmation_conditional.conditional_branches[].response.allow_interrupt

Indicates whether the user can interrupt a speech response from Amazon Lex.

intent_confirmation_setting.confirmation_conditional.conditional_branches[].response.message_groups[]
Show child fields
intent_confirmation_setting.confirmation_conditional.conditional_branches[].response.message_groups[].message

The primary message that Amazon Lex should send to the user.

Show child fields
intent_confirmation_setting.confirmation_conditional.conditional_branches[].response.message_groups[].message.custom_payload

A message in a custom format defined by the client application.

Show child fields
intent_confirmation_setting.confirmation_conditional.conditional_branches[].response.message_groups[].message.custom_payload.value

The string that is sent to your application.

intent_confirmation_setting.confirmation_conditional.conditional_branches[].response.message_groups[].message.image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
intent_confirmation_setting.confirmation_conditional.conditional_branches[].response.message_groups[].message.image_response_card.buttons[]
Show child fields
intent_confirmation_setting.confirmation_conditional.conditional_branches[].response.message_groups[].message.image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

intent_confirmation_setting.confirmation_conditional.conditional_branches[].response.message_groups[].message.image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

intent_confirmation_setting.confirmation_conditional.conditional_branches[].response.message_groups[].message.image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

intent_confirmation_setting.confirmation_conditional.conditional_branches[].response.message_groups[].message.image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

intent_confirmation_setting.confirmation_conditional.conditional_branches[].response.message_groups[].message.image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

intent_confirmation_setting.confirmation_conditional.conditional_branches[].response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
intent_confirmation_setting.confirmation_conditional.conditional_branches[].response.message_groups[].message.plain_text_message.value

The message to send to the user.

intent_confirmation_setting.confirmation_conditional.conditional_branches[].response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
intent_confirmation_setting.confirmation_conditional.conditional_branches[].response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

intent_confirmation_setting.confirmation_conditional.conditional_branches[].response.message_groups[].variations[]
Show child fields
intent_confirmation_setting.confirmation_conditional.conditional_branches[].response.message_groups[].variations[].custom_payload

A message in a custom format defined by the client application.

Show child fields
intent_confirmation_setting.confirmation_conditional.conditional_branches[].response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

intent_confirmation_setting.confirmation_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
intent_confirmation_setting.confirmation_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
intent_confirmation_setting.confirmation_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

intent_confirmation_setting.confirmation_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

intent_confirmation_setting.confirmation_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

intent_confirmation_setting.confirmation_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

intent_confirmation_setting.confirmation_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

intent_confirmation_setting.confirmation_conditional.conditional_branches[].response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
intent_confirmation_setting.confirmation_conditional.conditional_branches[].response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

intent_confirmation_setting.confirmation_conditional.conditional_branches[].response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
intent_confirmation_setting.confirmation_conditional.conditional_branches[].response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

intent_confirmation_setting.confirmation_conditional.default_branch

The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.

Show child fields
intent_confirmation_setting.confirmation_conditional.default_branch.next_step

The next step in the conversation.

Show child fields
intent_confirmation_setting.confirmation_conditional.default_branch.next_step.dialog_action

Defines the action that the bot executes at runtime when the conversation reaches this step.

Show child fields
intent_confirmation_setting.confirmation_conditional.default_branch.next_step.dialog_action.slot_to_elicit

If the dialog action is ElicitSlot, defines the slot to elicit from the user.

intent_confirmation_setting.confirmation_conditional.default_branch.next_step.dialog_action.suppress_next_message

When true the next message for the intent is not used.

intent_confirmation_setting.confirmation_conditional.default_branch.next_step.dialog_action.type

The action that the bot should execute.

intent_confirmation_setting.confirmation_conditional.default_branch.next_step.intent

Override settings to configure the intent state.

Show child fields
intent_confirmation_setting.confirmation_conditional.default_branch.next_step.intent.name

The name of the intent. Only required when you're switching intents.

intent_confirmation_setting.confirmation_conditional.default_branch.next_step.intent.slots

A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.

intent_confirmation_setting.confirmation_conditional.default_branch.next_step.session_attributes

Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

intent_confirmation_setting.confirmation_conditional.default_branch.response

Specifies a list of message groups that Amazon Lex uses to respond the user input.

Show child fields
intent_confirmation_setting.confirmation_conditional.default_branch.response.allow_interrupt

Indicates whether the user can interrupt a speech response from Amazon Lex.

intent_confirmation_setting.confirmation_conditional.default_branch.response.message_groups[]
Show child fields
intent_confirmation_setting.confirmation_conditional.default_branch.response.message_groups[].message

The primary message that Amazon Lex should send to the user.

Show child fields
intent_confirmation_setting.confirmation_conditional.default_branch.response.message_groups[].message.custom_payload

A message in a custom format defined by the client application.

Show child fields
intent_confirmation_setting.confirmation_conditional.default_branch.response.message_groups[].message.custom_payload.value

The string that is sent to your application.

intent_confirmation_setting.confirmation_conditional.default_branch.response.message_groups[].message.image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
intent_confirmation_setting.confirmation_conditional.default_branch.response.message_groups[].message.image_response_card.buttons[]
Show child fields
intent_confirmation_setting.confirmation_conditional.default_branch.response.message_groups[].message.image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

intent_confirmation_setting.confirmation_conditional.default_branch.response.message_groups[].message.image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

intent_confirmation_setting.confirmation_conditional.default_branch.response.message_groups[].message.image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

intent_confirmation_setting.confirmation_conditional.default_branch.response.message_groups[].message.image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

intent_confirmation_setting.confirmation_conditional.default_branch.response.message_groups[].message.image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

intent_confirmation_setting.confirmation_conditional.default_branch.response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
intent_confirmation_setting.confirmation_conditional.default_branch.response.message_groups[].message.plain_text_message.value

The message to send to the user.

intent_confirmation_setting.confirmation_conditional.default_branch.response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
intent_confirmation_setting.confirmation_conditional.default_branch.response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

intent_confirmation_setting.confirmation_conditional.default_branch.response.message_groups[].variations[]
Show child fields
intent_confirmation_setting.confirmation_conditional.default_branch.response.message_groups[].variations[].custom_payload

A message in a custom format defined by the client application.

Show child fields
intent_confirmation_setting.confirmation_conditional.default_branch.response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

intent_confirmation_setting.confirmation_conditional.default_branch.response.message_groups[].variations[].image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
intent_confirmation_setting.confirmation_conditional.default_branch.response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
intent_confirmation_setting.confirmation_conditional.default_branch.response.message_groups[].variations[].image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

intent_confirmation_setting.confirmation_conditional.default_branch.response.message_groups[].variations[].image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

intent_confirmation_setting.confirmation_conditional.default_branch.response.message_groups[].variations[].image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

intent_confirmation_setting.confirmation_conditional.default_branch.response.message_groups[].variations[].image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

intent_confirmation_setting.confirmation_conditional.default_branch.response.message_groups[].variations[].image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

intent_confirmation_setting.confirmation_conditional.default_branch.response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
intent_confirmation_setting.confirmation_conditional.default_branch.response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

intent_confirmation_setting.confirmation_conditional.default_branch.response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
intent_confirmation_setting.confirmation_conditional.default_branch.response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

intent_confirmation_setting.confirmation_next_step

Specifies the next step that the bot executes when the customer confirms the intent.

Show child fields
intent_confirmation_setting.confirmation_next_step.dialog_action

Defines the action that the bot executes at runtime when the conversation reaches this step.

Show child fields
intent_confirmation_setting.confirmation_next_step.dialog_action.slot_to_elicit

If the dialog action is ElicitSlot, defines the slot to elicit from the user.

intent_confirmation_setting.confirmation_next_step.dialog_action.suppress_next_message

When true the next message for the intent is not used.

intent_confirmation_setting.confirmation_next_step.dialog_action.type

The action that the bot should execute.

intent_confirmation_setting.confirmation_next_step.intent

Override settings to configure the intent state.

Show child fields
intent_confirmation_setting.confirmation_next_step.intent.name

The name of the intent. Only required when you're switching intents.

intent_confirmation_setting.confirmation_next_step.intent.slots

A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.

intent_confirmation_setting.confirmation_next_step.session_attributes

Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

intent_confirmation_setting.confirmation_response

Specifies a list of message groups that Amazon Lex uses to respond the user input.

Show child fields
intent_confirmation_setting.confirmation_response.allow_interrupt

Indicates whether the user can interrupt a speech response from Amazon Lex.

intent_confirmation_setting.confirmation_response.message_groups[]
Show child fields
intent_confirmation_setting.confirmation_response.message_groups[].message

The primary message that Amazon Lex should send to the user.

Show child fields
intent_confirmation_setting.confirmation_response.message_groups[].message.custom_payload

A message in a custom format defined by the client application.

Show child fields
intent_confirmation_setting.confirmation_response.message_groups[].message.custom_payload.value

The string that is sent to your application.

intent_confirmation_setting.confirmation_response.message_groups[].message.image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
intent_confirmation_setting.confirmation_response.message_groups[].message.image_response_card.buttons[]
Show child fields
intent_confirmation_setting.confirmation_response.message_groups[].message.image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

intent_confirmation_setting.confirmation_response.message_groups[].message.image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

intent_confirmation_setting.confirmation_response.message_groups[].message.image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

intent_confirmation_setting.confirmation_response.message_groups[].message.image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

intent_confirmation_setting.confirmation_response.message_groups[].message.image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

intent_confirmation_setting.confirmation_response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
intent_confirmation_setting.confirmation_response.message_groups[].message.plain_text_message.value

The message to send to the user.

intent_confirmation_setting.confirmation_response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
intent_confirmation_setting.confirmation_response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

intent_confirmation_setting.confirmation_response.message_groups[].variations[]
Show child fields
intent_confirmation_setting.confirmation_response.message_groups[].variations[].custom_payload

A message in a custom format defined by the client application.

Show child fields
intent_confirmation_setting.confirmation_response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

intent_confirmation_setting.confirmation_response.message_groups[].variations[].image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
intent_confirmation_setting.confirmation_response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
intent_confirmation_setting.confirmation_response.message_groups[].variations[].image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

intent_confirmation_setting.confirmation_response.message_groups[].variations[].image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

intent_confirmation_setting.confirmation_response.message_groups[].variations[].image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

intent_confirmation_setting.confirmation_response.message_groups[].variations[].image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

intent_confirmation_setting.confirmation_response.message_groups[].variations[].image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

intent_confirmation_setting.confirmation_response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
intent_confirmation_setting.confirmation_response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

intent_confirmation_setting.confirmation_response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
intent_confirmation_setting.confirmation_response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

intent_confirmation_setting.declination_conditional

A list of conditional branches to evaluate after the intent is declined.

Show child fields
intent_confirmation_setting.declination_conditional.active

Determines whether a conditional branch is active. When active is false, the conditions are not evaluated.

intent_confirmation_setting.declination_conditional.conditional_branches[]
Show child fields
intent_confirmation_setting.declination_conditional.conditional_branches[].condition

Contains the expression to evaluate. If the condition is true, the branch's actions are taken.

Show child fields
intent_confirmation_setting.declination_conditional.conditional_branches[].condition.expression_string

The expression string that is evaluated.

intent_confirmation_setting.declination_conditional.conditional_branches[].name

The name of the branch.

intent_confirmation_setting.declination_conditional.conditional_branches[].next_step

The next step in the conversation.

Show child fields
intent_confirmation_setting.declination_conditional.conditional_branches[].next_step.dialog_action

Defines the action that the bot executes at runtime when the conversation reaches this step.

Show child fields
intent_confirmation_setting.declination_conditional.conditional_branches[].next_step.dialog_action.slot_to_elicit

If the dialog action is ElicitSlot, defines the slot to elicit from the user.

intent_confirmation_setting.declination_conditional.conditional_branches[].next_step.dialog_action.suppress_next_message

When true the next message for the intent is not used.

intent_confirmation_setting.declination_conditional.conditional_branches[].next_step.dialog_action.type

The action that the bot should execute.

intent_confirmation_setting.declination_conditional.conditional_branches[].next_step.intent

Override settings to configure the intent state.

Show child fields
intent_confirmation_setting.declination_conditional.conditional_branches[].next_step.intent.name

The name of the intent. Only required when you're switching intents.

intent_confirmation_setting.declination_conditional.conditional_branches[].next_step.intent.slots

A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.

intent_confirmation_setting.declination_conditional.conditional_branches[].next_step.session_attributes

Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

intent_confirmation_setting.declination_conditional.conditional_branches[].response

Specifies a list of message groups that Amazon Lex uses to respond the user input.

Show child fields
intent_confirmation_setting.declination_conditional.conditional_branches[].response.allow_interrupt

Indicates whether the user can interrupt a speech response from Amazon Lex.

intent_confirmation_setting.declination_conditional.conditional_branches[].response.message_groups[]
Show child fields
intent_confirmation_setting.declination_conditional.conditional_branches[].response.message_groups[].message

The primary message that Amazon Lex should send to the user.

Show child fields
intent_confirmation_setting.declination_conditional.conditional_branches[].response.message_groups[].message.custom_payload

A message in a custom format defined by the client application.

Show child fields
intent_confirmation_setting.declination_conditional.conditional_branches[].response.message_groups[].message.custom_payload.value

The string that is sent to your application.

intent_confirmation_setting.declination_conditional.conditional_branches[].response.message_groups[].message.image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
intent_confirmation_setting.declination_conditional.conditional_branches[].response.message_groups[].message.image_response_card.buttons[]
Show child fields
intent_confirmation_setting.declination_conditional.conditional_branches[].response.message_groups[].message.image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

intent_confirmation_setting.declination_conditional.conditional_branches[].response.message_groups[].message.image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

intent_confirmation_setting.declination_conditional.conditional_branches[].response.message_groups[].message.image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

intent_confirmation_setting.declination_conditional.conditional_branches[].response.message_groups[].message.image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

intent_confirmation_setting.declination_conditional.conditional_branches[].response.message_groups[].message.image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

intent_confirmation_setting.declination_conditional.conditional_branches[].response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
intent_confirmation_setting.declination_conditional.conditional_branches[].response.message_groups[].message.plain_text_message.value

The message to send to the user.

intent_confirmation_setting.declination_conditional.conditional_branches[].response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
intent_confirmation_setting.declination_conditional.conditional_branches[].response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

intent_confirmation_setting.declination_conditional.conditional_branches[].response.message_groups[].variations[]
Show child fields
intent_confirmation_setting.declination_conditional.conditional_branches[].response.message_groups[].variations[].custom_payload

A message in a custom format defined by the client application.

Show child fields
intent_confirmation_setting.declination_conditional.conditional_branches[].response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

intent_confirmation_setting.declination_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
intent_confirmation_setting.declination_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
intent_confirmation_setting.declination_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

intent_confirmation_setting.declination_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

intent_confirmation_setting.declination_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

intent_confirmation_setting.declination_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

intent_confirmation_setting.declination_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

intent_confirmation_setting.declination_conditional.conditional_branches[].response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
intent_confirmation_setting.declination_conditional.conditional_branches[].response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

intent_confirmation_setting.declination_conditional.conditional_branches[].response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
intent_confirmation_setting.declination_conditional.conditional_branches[].response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

intent_confirmation_setting.declination_conditional.default_branch

The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.

Show child fields
intent_confirmation_setting.declination_conditional.default_branch.next_step

The next step in the conversation.

Show child fields
intent_confirmation_setting.declination_conditional.default_branch.next_step.dialog_action

Defines the action that the bot executes at runtime when the conversation reaches this step.

Show child fields
intent_confirmation_setting.declination_conditional.default_branch.next_step.dialog_action.slot_to_elicit

If the dialog action is ElicitSlot, defines the slot to elicit from the user.

intent_confirmation_setting.declination_conditional.default_branch.next_step.dialog_action.suppress_next_message

When true the next message for the intent is not used.

intent_confirmation_setting.declination_conditional.default_branch.next_step.dialog_action.type

The action that the bot should execute.

intent_confirmation_setting.declination_conditional.default_branch.next_step.intent

Override settings to configure the intent state.

Show child fields
intent_confirmation_setting.declination_conditional.default_branch.next_step.intent.name

The name of the intent. Only required when you're switching intents.

intent_confirmation_setting.declination_conditional.default_branch.next_step.intent.slots

A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.

intent_confirmation_setting.declination_conditional.default_branch.next_step.session_attributes

Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

intent_confirmation_setting.declination_conditional.default_branch.response

Specifies a list of message groups that Amazon Lex uses to respond the user input.

Show child fields
intent_confirmation_setting.declination_conditional.default_branch.response.allow_interrupt

Indicates whether the user can interrupt a speech response from Amazon Lex.

intent_confirmation_setting.declination_conditional.default_branch.response.message_groups[]
Show child fields
intent_confirmation_setting.declination_conditional.default_branch.response.message_groups[].message

The primary message that Amazon Lex should send to the user.

Show child fields
intent_confirmation_setting.declination_conditional.default_branch.response.message_groups[].message.custom_payload

A message in a custom format defined by the client application.

Show child fields
intent_confirmation_setting.declination_conditional.default_branch.response.message_groups[].message.custom_payload.value

The string that is sent to your application.

intent_confirmation_setting.declination_conditional.default_branch.response.message_groups[].message.image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
intent_confirmation_setting.declination_conditional.default_branch.response.message_groups[].message.image_response_card.buttons[]
Show child fields
intent_confirmation_setting.declination_conditional.default_branch.response.message_groups[].message.image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

intent_confirmation_setting.declination_conditional.default_branch.response.message_groups[].message.image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

intent_confirmation_setting.declination_conditional.default_branch.response.message_groups[].message.image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

intent_confirmation_setting.declination_conditional.default_branch.response.message_groups[].message.image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

intent_confirmation_setting.declination_conditional.default_branch.response.message_groups[].message.image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

intent_confirmation_setting.declination_conditional.default_branch.response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
intent_confirmation_setting.declination_conditional.default_branch.response.message_groups[].message.plain_text_message.value

The message to send to the user.

intent_confirmation_setting.declination_conditional.default_branch.response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
intent_confirmation_setting.declination_conditional.default_branch.response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

intent_confirmation_setting.declination_conditional.default_branch.response.message_groups[].variations[]
Show child fields
intent_confirmation_setting.declination_conditional.default_branch.response.message_groups[].variations[].custom_payload

A message in a custom format defined by the client application.

Show child fields
intent_confirmation_setting.declination_conditional.default_branch.response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

intent_confirmation_setting.declination_conditional.default_branch.response.message_groups[].variations[].image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
intent_confirmation_setting.declination_conditional.default_branch.response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
intent_confirmation_setting.declination_conditional.default_branch.response.message_groups[].variations[].image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

intent_confirmation_setting.declination_conditional.default_branch.response.message_groups[].variations[].image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

intent_confirmation_setting.declination_conditional.default_branch.response.message_groups[].variations[].image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

intent_confirmation_setting.declination_conditional.default_branch.response.message_groups[].variations[].image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

intent_confirmation_setting.declination_conditional.default_branch.response.message_groups[].variations[].image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

intent_confirmation_setting.declination_conditional.default_branch.response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
intent_confirmation_setting.declination_conditional.default_branch.response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

intent_confirmation_setting.declination_conditional.default_branch.response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
intent_confirmation_setting.declination_conditional.default_branch.response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

intent_confirmation_setting.declination_next_step

Specifies the next step that the bot executes when the customer declines the intent.

Show child fields
intent_confirmation_setting.declination_next_step.dialog_action

Defines the action that the bot executes at runtime when the conversation reaches this step.

Show child fields
intent_confirmation_setting.declination_next_step.dialog_action.slot_to_elicit

If the dialog action is ElicitSlot, defines the slot to elicit from the user.

intent_confirmation_setting.declination_next_step.dialog_action.suppress_next_message

When true the next message for the intent is not used.

intent_confirmation_setting.declination_next_step.dialog_action.type

The action that the bot should execute.

intent_confirmation_setting.declination_next_step.intent

Override settings to configure the intent state.

Show child fields
intent_confirmation_setting.declination_next_step.intent.name

The name of the intent. Only required when you're switching intents.

intent_confirmation_setting.declination_next_step.intent.slots

A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.

intent_confirmation_setting.declination_next_step.session_attributes

Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

intent_confirmation_setting.declination_response

When the user answers "no" to the question defined in promptSpecification, Amazon Lex responds with this response to acknowledge that the intent was canceled.

Show child fields
intent_confirmation_setting.declination_response.allow_interrupt

Indicates whether the user can interrupt a speech response from Amazon Lex.

intent_confirmation_setting.declination_response.message_groups[]
Show child fields
intent_confirmation_setting.declination_response.message_groups[].message

The primary message that Amazon Lex should send to the user.

Show child fields
intent_confirmation_setting.declination_response.message_groups[].message.custom_payload

A message in a custom format defined by the client application.

Show child fields
intent_confirmation_setting.declination_response.message_groups[].message.custom_payload.value

The string that is sent to your application.

intent_confirmation_setting.declination_response.message_groups[].message.image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
intent_confirmation_setting.declination_response.message_groups[].message.image_response_card.buttons[]
Show child fields
intent_confirmation_setting.declination_response.message_groups[].message.image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

intent_confirmation_setting.declination_response.message_groups[].message.image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

intent_confirmation_setting.declination_response.message_groups[].message.image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

intent_confirmation_setting.declination_response.message_groups[].message.image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

intent_confirmation_setting.declination_response.message_groups[].message.image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

intent_confirmation_setting.declination_response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
intent_confirmation_setting.declination_response.message_groups[].message.plain_text_message.value

The message to send to the user.

intent_confirmation_setting.declination_response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
intent_confirmation_setting.declination_response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

intent_confirmation_setting.declination_response.message_groups[].variations[]
Show child fields
intent_confirmation_setting.declination_response.message_groups[].variations[].custom_payload

A message in a custom format defined by the client application.

Show child fields
intent_confirmation_setting.declination_response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

intent_confirmation_setting.declination_response.message_groups[].variations[].image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
intent_confirmation_setting.declination_response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
intent_confirmation_setting.declination_response.message_groups[].variations[].image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

intent_confirmation_setting.declination_response.message_groups[].variations[].image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

intent_confirmation_setting.declination_response.message_groups[].variations[].image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

intent_confirmation_setting.declination_response.message_groups[].variations[].image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

intent_confirmation_setting.declination_response.message_groups[].variations[].image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

intent_confirmation_setting.declination_response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
intent_confirmation_setting.declination_response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

intent_confirmation_setting.declination_response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
intent_confirmation_setting.declination_response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

intent_confirmation_setting.elicitation_code_hook

The DialogCodeHookInvocationSetting used when the code hook is invoked during confirmation prompt retries.

Show child fields
intent_confirmation_setting.elicitation_code_hook.enable_code_hook_invocation

Indicates whether a Lambda function should be invoked for the dialog.

intent_confirmation_setting.elicitation_code_hook.invocation_label

A label that indicates the dialog step from which the dialog code hook is happening.

intent_confirmation_setting.failure_conditional

Provides a list of conditional branches. Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition.

Show child fields
intent_confirmation_setting.failure_conditional.active

Determines whether a conditional branch is active. When active is false, the conditions are not evaluated.

intent_confirmation_setting.failure_conditional.conditional_branches[]
Show child fields
intent_confirmation_setting.failure_conditional.conditional_branches[].condition

Contains the expression to evaluate. If the condition is true, the branch's actions are taken.

Show child fields
intent_confirmation_setting.failure_conditional.conditional_branches[].condition.expression_string

The expression string that is evaluated.

intent_confirmation_setting.failure_conditional.conditional_branches[].name

The name of the branch.

intent_confirmation_setting.failure_conditional.conditional_branches[].next_step

The next step in the conversation.

Show child fields
intent_confirmation_setting.failure_conditional.conditional_branches[].next_step.dialog_action

Defines the action that the bot executes at runtime when the conversation reaches this step.

Show child fields
intent_confirmation_setting.failure_conditional.conditional_branches[].next_step.dialog_action.slot_to_elicit

If the dialog action is ElicitSlot, defines the slot to elicit from the user.

intent_confirmation_setting.failure_conditional.conditional_branches[].next_step.dialog_action.suppress_next_message

When true the next message for the intent is not used.

intent_confirmation_setting.failure_conditional.conditional_branches[].next_step.dialog_action.type

The action that the bot should execute.

intent_confirmation_setting.failure_conditional.conditional_branches[].next_step.intent

Override settings to configure the intent state.

Show child fields
intent_confirmation_setting.failure_conditional.conditional_branches[].next_step.intent.name

The name of the intent. Only required when you're switching intents.

intent_confirmation_setting.failure_conditional.conditional_branches[].next_step.intent.slots

A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.

intent_confirmation_setting.failure_conditional.conditional_branches[].next_step.session_attributes

Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

intent_confirmation_setting.failure_conditional.conditional_branches[].response

Specifies a list of message groups that Amazon Lex uses to respond the user input.

Show child fields
intent_confirmation_setting.failure_conditional.conditional_branches[].response.allow_interrupt

Indicates whether the user can interrupt a speech response from Amazon Lex.

intent_confirmation_setting.failure_conditional.conditional_branches[].response.message_groups[]
Show child fields
intent_confirmation_setting.failure_conditional.conditional_branches[].response.message_groups[].message

The primary message that Amazon Lex should send to the user.

Show child fields
intent_confirmation_setting.failure_conditional.conditional_branches[].response.message_groups[].message.custom_payload

A message in a custom format defined by the client application.

Show child fields
intent_confirmation_setting.failure_conditional.conditional_branches[].response.message_groups[].message.custom_payload.value

The string that is sent to your application.

intent_confirmation_setting.failure_conditional.conditional_branches[].response.message_groups[].message.image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
intent_confirmation_setting.failure_conditional.conditional_branches[].response.message_groups[].message.image_response_card.buttons[]
Show child fields
intent_confirmation_setting.failure_conditional.conditional_branches[].response.message_groups[].message.image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

intent_confirmation_setting.failure_conditional.conditional_branches[].response.message_groups[].message.image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

intent_confirmation_setting.failure_conditional.conditional_branches[].response.message_groups[].message.image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

intent_confirmation_setting.failure_conditional.conditional_branches[].response.message_groups[].message.image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

intent_confirmation_setting.failure_conditional.conditional_branches[].response.message_groups[].message.image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

intent_confirmation_setting.failure_conditional.conditional_branches[].response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
intent_confirmation_setting.failure_conditional.conditional_branches[].response.message_groups[].message.plain_text_message.value

The message to send to the user.

intent_confirmation_setting.failure_conditional.conditional_branches[].response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
intent_confirmation_setting.failure_conditional.conditional_branches[].response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

intent_confirmation_setting.failure_conditional.conditional_branches[].response.message_groups[].variations[]
Show child fields
intent_confirmation_setting.failure_conditional.conditional_branches[].response.message_groups[].variations[].custom_payload

A message in a custom format defined by the client application.

Show child fields
intent_confirmation_setting.failure_conditional.conditional_branches[].response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

intent_confirmation_setting.failure_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
intent_confirmation_setting.failure_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
intent_confirmation_setting.failure_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

intent_confirmation_setting.failure_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

intent_confirmation_setting.failure_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

intent_confirmation_setting.failure_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

intent_confirmation_setting.failure_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

intent_confirmation_setting.failure_conditional.conditional_branches[].response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
intent_confirmation_setting.failure_conditional.conditional_branches[].response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

intent_confirmation_setting.failure_conditional.conditional_branches[].response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
intent_confirmation_setting.failure_conditional.conditional_branches[].response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

intent_confirmation_setting.failure_conditional.default_branch

The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.

Show child fields
intent_confirmation_setting.failure_conditional.default_branch.next_step

The next step in the conversation.

Show child fields
intent_confirmation_setting.failure_conditional.default_branch.next_step.dialog_action

Defines the action that the bot executes at runtime when the conversation reaches this step.

Show child fields
intent_confirmation_setting.failure_conditional.default_branch.next_step.dialog_action.slot_to_elicit

If the dialog action is ElicitSlot, defines the slot to elicit from the user.

intent_confirmation_setting.failure_conditional.default_branch.next_step.dialog_action.suppress_next_message

When true the next message for the intent is not used.

intent_confirmation_setting.failure_conditional.default_branch.next_step.dialog_action.type

The action that the bot should execute.

intent_confirmation_setting.failure_conditional.default_branch.next_step.intent

Override settings to configure the intent state.

Show child fields
intent_confirmation_setting.failure_conditional.default_branch.next_step.intent.name

The name of the intent. Only required when you're switching intents.

intent_confirmation_setting.failure_conditional.default_branch.next_step.intent.slots

A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.

intent_confirmation_setting.failure_conditional.default_branch.next_step.session_attributes

Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

intent_confirmation_setting.failure_conditional.default_branch.response

Specifies a list of message groups that Amazon Lex uses to respond the user input.

Show child fields
intent_confirmation_setting.failure_conditional.default_branch.response.allow_interrupt

Indicates whether the user can interrupt a speech response from Amazon Lex.

intent_confirmation_setting.failure_conditional.default_branch.response.message_groups[]
Show child fields
intent_confirmation_setting.failure_conditional.default_branch.response.message_groups[].message

The primary message that Amazon Lex should send to the user.

Show child fields
intent_confirmation_setting.failure_conditional.default_branch.response.message_groups[].message.custom_payload

A message in a custom format defined by the client application.

Show child fields
intent_confirmation_setting.failure_conditional.default_branch.response.message_groups[].message.custom_payload.value

The string that is sent to your application.

intent_confirmation_setting.failure_conditional.default_branch.response.message_groups[].message.image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
intent_confirmation_setting.failure_conditional.default_branch.response.message_groups[].message.image_response_card.buttons[]
Show child fields
intent_confirmation_setting.failure_conditional.default_branch.response.message_groups[].message.image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

intent_confirmation_setting.failure_conditional.default_branch.response.message_groups[].message.image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

intent_confirmation_setting.failure_conditional.default_branch.response.message_groups[].message.image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

intent_confirmation_setting.failure_conditional.default_branch.response.message_groups[].message.image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

intent_confirmation_setting.failure_conditional.default_branch.response.message_groups[].message.image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

intent_confirmation_setting.failure_conditional.default_branch.response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
intent_confirmation_setting.failure_conditional.default_branch.response.message_groups[].message.plain_text_message.value

The message to send to the user.

intent_confirmation_setting.failure_conditional.default_branch.response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
intent_confirmation_setting.failure_conditional.default_branch.response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

intent_confirmation_setting.failure_conditional.default_branch.response.message_groups[].variations[]
Show child fields
intent_confirmation_setting.failure_conditional.default_branch.response.message_groups[].variations[].custom_payload

A message in a custom format defined by the client application.

Show child fields
intent_confirmation_setting.failure_conditional.default_branch.response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

intent_confirmation_setting.failure_conditional.default_branch.response.message_groups[].variations[].image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
intent_confirmation_setting.failure_conditional.default_branch.response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
intent_confirmation_setting.failure_conditional.default_branch.response.message_groups[].variations[].image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

intent_confirmation_setting.failure_conditional.default_branch.response.message_groups[].variations[].image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

intent_confirmation_setting.failure_conditional.default_branch.response.message_groups[].variations[].image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

intent_confirmation_setting.failure_conditional.default_branch.response.message_groups[].variations[].image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

intent_confirmation_setting.failure_conditional.default_branch.response.message_groups[].variations[].image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

intent_confirmation_setting.failure_conditional.default_branch.response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
intent_confirmation_setting.failure_conditional.default_branch.response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

intent_confirmation_setting.failure_conditional.default_branch.response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
intent_confirmation_setting.failure_conditional.default_branch.response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

intent_confirmation_setting.failure_next_step

The next step to take in the conversation if the confirmation step fails.

Show child fields
intent_confirmation_setting.failure_next_step.dialog_action

Defines the action that the bot executes at runtime when the conversation reaches this step.

Show child fields
intent_confirmation_setting.failure_next_step.dialog_action.slot_to_elicit

If the dialog action is ElicitSlot, defines the slot to elicit from the user.

intent_confirmation_setting.failure_next_step.dialog_action.suppress_next_message

When true the next message for the intent is not used.

intent_confirmation_setting.failure_next_step.dialog_action.type

The action that the bot should execute.

intent_confirmation_setting.failure_next_step.intent

Override settings to configure the intent state.

Show child fields
intent_confirmation_setting.failure_next_step.intent.name

The name of the intent. Only required when you're switching intents.

intent_confirmation_setting.failure_next_step.intent.slots

A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.

intent_confirmation_setting.failure_next_step.session_attributes

Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

intent_confirmation_setting.failure_response

Specifies a list of message groups that Amazon Lex uses to respond the user input.

Show child fields
intent_confirmation_setting.failure_response.allow_interrupt

Indicates whether the user can interrupt a speech response from Amazon Lex.

intent_confirmation_setting.failure_response.message_groups[]
Show child fields
intent_confirmation_setting.failure_response.message_groups[].message

The primary message that Amazon Lex should send to the user.

Show child fields
intent_confirmation_setting.failure_response.message_groups[].message.custom_payload

A message in a custom format defined by the client application.

Show child fields
intent_confirmation_setting.failure_response.message_groups[].message.custom_payload.value

The string that is sent to your application.

intent_confirmation_setting.failure_response.message_groups[].message.image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
intent_confirmation_setting.failure_response.message_groups[].message.image_response_card.buttons[]
Show child fields
intent_confirmation_setting.failure_response.message_groups[].message.image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

intent_confirmation_setting.failure_response.message_groups[].message.image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

intent_confirmation_setting.failure_response.message_groups[].message.image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

intent_confirmation_setting.failure_response.message_groups[].message.image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

intent_confirmation_setting.failure_response.message_groups[].message.image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

intent_confirmation_setting.failure_response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
intent_confirmation_setting.failure_response.message_groups[].message.plain_text_message.value

The message to send to the user.

intent_confirmation_setting.failure_response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
intent_confirmation_setting.failure_response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

intent_confirmation_setting.failure_response.message_groups[].variations[]
Show child fields
intent_confirmation_setting.failure_response.message_groups[].variations[].custom_payload

A message in a custom format defined by the client application.

Show child fields
intent_confirmation_setting.failure_response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

intent_confirmation_setting.failure_response.message_groups[].variations[].image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
intent_confirmation_setting.failure_response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
intent_confirmation_setting.failure_response.message_groups[].variations[].image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

intent_confirmation_setting.failure_response.message_groups[].variations[].image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

intent_confirmation_setting.failure_response.message_groups[].variations[].image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

intent_confirmation_setting.failure_response.message_groups[].variations[].image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

intent_confirmation_setting.failure_response.message_groups[].variations[].image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

intent_confirmation_setting.failure_response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
intent_confirmation_setting.failure_response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

intent_confirmation_setting.failure_response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
intent_confirmation_setting.failure_response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

intent_confirmation_setting.prompt_specification

Prompts the user to confirm the intent. This question should have a yes or no answer.

Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the OrderPizza intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information.

Show child fields
intent_confirmation_setting.prompt_specification.allow_interrupt

Indicates whether the user can interrupt a speech prompt from the bot.

intent_confirmation_setting.prompt_specification.max_retries

The maximum number of times the bot tries to elicit a response from the user using this prompt.

intent_confirmation_setting.prompt_specification.message_groups[]
Show child fields
intent_confirmation_setting.prompt_specification.message_groups[].message

The primary message that Amazon Lex should send to the user.

Show child fields
intent_confirmation_setting.prompt_specification.message_groups[].message.custom_payload

A message in a custom format defined by the client application.

Show child fields
intent_confirmation_setting.prompt_specification.message_groups[].message.custom_payload.value

The string that is sent to your application.

intent_confirmation_setting.prompt_specification.message_groups[].message.image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
intent_confirmation_setting.prompt_specification.message_groups[].message.image_response_card.buttons[]
Show child fields
intent_confirmation_setting.prompt_specification.message_groups[].message.image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

intent_confirmation_setting.prompt_specification.message_groups[].message.image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

intent_confirmation_setting.prompt_specification.message_groups[].message.image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

intent_confirmation_setting.prompt_specification.message_groups[].message.image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

intent_confirmation_setting.prompt_specification.message_groups[].message.image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

intent_confirmation_setting.prompt_specification.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
intent_confirmation_setting.prompt_specification.message_groups[].message.plain_text_message.value

The message to send to the user.

intent_confirmation_setting.prompt_specification.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
intent_confirmation_setting.prompt_specification.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

intent_confirmation_setting.prompt_specification.message_groups[].variations[]
Show child fields
intent_confirmation_setting.prompt_specification.message_groups[].variations[].custom_payload

A message in a custom format defined by the client application.

Show child fields
intent_confirmation_setting.prompt_specification.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

intent_confirmation_setting.prompt_specification.message_groups[].variations[].image_response_card

A message that defines a response card that the client application can show to the user.

Show child fields
intent_confirmation_setting.prompt_specification.message_groups[].variations[].image_response_card.buttons[]
Show child fields
intent_confirmation_setting.prompt_specification.message_groups[].variations[].image_response_card.buttons[].text

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

intent_confirmation_setting.prompt_specification.message_groups[].variations[].image_response_card.buttons[].value

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

intent_confirmation_setting.prompt_specification.message_groups[].variations[].image_response_card.image_url

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

intent_confirmation_setting.prompt_specification.message_groups[].variations[].image_response_card.subtitle

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

intent_confirmation_setting.prompt_specification.message_groups[].variations[].image_response_card.title

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

intent_confirmation_setting.prompt_specification.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
intent_confirmation_setting.prompt_specification.message_groups[].variations[].plain_text_message.value

The message to send to the user.

intent_confirmation_setting.prompt_specification.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
intent_confirmation_setting.prompt_specification.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

intent_confirmation_setting.prompt_specification.message_selection_strategy

Indicates how a message is selected from a message group among retries.

intent_confirmation_setting.prompt_specification.prompt_attempts_specification

Specifies the advanced settings on each attempt of the prompt.

intent_name

The name specified for the intent.

VARCHAR
kendra_configuration

Configuration information required to use the AMAZON.KendraSearchIntent intent.

STRUCT(
"kendra_index" VARCHAR,
"query_filter_string_enabled" BOOLEAN,
"query_filter_string" VARCHAR
)
Show child fields
kendra_configuration.kendra_index

The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search. The index must be in the same account and Region as the Amazon Lex bot.

kendra_configuration.query_filter_string

A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query. The filter is in the format defined by Amazon Kendra. For more information, see Filtering queries.

kendra_configuration.query_filter_string_enabled

Determines whether the AMAZON.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index.

last_updated_date_time

A timestamp of the date and time that the intent was last updated.

TIMESTAMP_S
output_contexts

A list of contexts that are activated when the intent is fulfilled.

STRUCT(
"name" VARCHAR,
"time_to_live_in_seconds" BIGINT,
"turns_to_live" BIGINT
)[]
Show child fields
output_contexts[]
Show child fields
output_contexts[].name

The name of the output context.

output_contexts[].time_to_live_in_seconds

The amount of time, in seconds, that the output context should remain active. The time is figured from the first time the context is sent to the user.

output_contexts[].turns_to_live

The number of conversation turns that the output context should remain active. The number of turns is counted from the first time that the context is sent to the user.

parent_intent_signature

The identifier of the built-in intent that this intent is derived from, if any.

VARCHAR
qn_a_intent_configuration

Details about the configuration of the built-in Amazon.QnAIntent.

STRUCT(
"data_source_configuration" STRUCT(
"opensearch_configuration" STRUCT(
"domain_endpoint" VARCHAR,
"index_name" VARCHAR,
"exact_response" BOOLEAN,
"exact_response_fields" STRUCT(
"question_field" VARCHAR,
"answer_field" VARCHAR
),
"include_fields" VARCHAR[]
),
"kendra_configuration" STRUCT(
"kendra_index" VARCHAR,
"query_filter_string_enabled" BOOLEAN,
"query_filter_string" VARCHAR,
"exact_response" BOOLEAN
),
"bedrock_knowledge_store_configuration" STRUCT(
"bedrock_knowledge_base_arn" VARCHAR,
"exact_response" BOOLEAN,
"exact_response_fields" STRUCT(
"answer_field" VARCHAR
)
)
),
"bedrock_model_configuration" STRUCT(
"model_arn" VARCHAR,
"guardrail" STRUCT(
"identifier" VARCHAR,
"version" VARCHAR
),
"trace_status" VARCHAR,
"custom_prompt" VARCHAR
)
)
Show child fields
qn_a_intent_configuration.bedrock_model_configuration

Contains information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.

Show child fields
qn_a_intent_configuration.bedrock_model_configuration.custom_prompt

The custom prompt used in the Bedrock model specification details.

qn_a_intent_configuration.bedrock_model_configuration.guardrail

The guardrail configuration in the Bedrock model specification details.

Show child fields
qn_a_intent_configuration.bedrock_model_configuration.guardrail.identifier

The unique guardrail id for the Bedrock guardrail configuration.

qn_a_intent_configuration.bedrock_model_configuration.guardrail.version

The guardrail version for the Bedrock guardrail configuration.

qn_a_intent_configuration.bedrock_model_configuration.model_arn

The ARN of the foundation model used in descriptive bot building.

qn_a_intent_configuration.bedrock_model_configuration.trace_status

The Bedrock trace status in the Bedrock model specification details.

qn_a_intent_configuration.data_source_configuration

Contains details about the configuration of the data source used for the AMAZON.QnAIntent.

Show child fields
qn_a_intent_configuration.data_source_configuration.bedrock_knowledge_store_configuration

Contains details about the configuration of the Amazon Bedrock knowledge base used for the AMAZON.QnAIntent. To set up a knowledge base, follow the steps at Building a knowledge base.

Show child fields
qn_a_intent_configuration.data_source_configuration.bedrock_knowledge_store_configuration.bedrock_knowledge_base_arn

The base ARN of the knowledge base used.

qn_a_intent_configuration.data_source_configuration.bedrock_knowledge_store_configuration.exact_response

Specifies whether to return an exact response, or to return an answer generated by the model, using the fields you specify from the database.

qn_a_intent_configuration.data_source_configuration.bedrock_knowledge_store_configuration.exact_response_fields

Contains the names of the fields used for an exact response to the user.

Show child fields
qn_a_intent_configuration.data_source_configuration.bedrock_knowledge_store_configuration.exact_response_fields.answer_field

The answer field used for an exact response from Bedrock Knowledge Store.

qn_a_intent_configuration.data_source_configuration.kendra_configuration

Contains details about the configuration of the Amazon Kendra index used for the AMAZON.QnAIntent. To create a Amazon Kendra index, follow the steps at Creating an index.

Show child fields
qn_a_intent_configuration.data_source_configuration.kendra_configuration.exact_response

Specifies whether to return an exact response from the Amazon Kendra index or to let the Amazon Bedrock model you select generate a response based on the results. To use this feature, you must first add FAQ questions to your index by following the steps at Adding frequently asked questions (FAQs) to an index.

qn_a_intent_configuration.data_source_configuration.kendra_configuration.kendra_index

The ARN of the Amazon Kendra index to use.

qn_a_intent_configuration.data_source_configuration.kendra_configuration.query_filter_string

Contains the Amazon Kendra filter string to use if enabled. For more information on the Amazon Kendra search filter JSON format, see Using document attributes to filter search results.

qn_a_intent_configuration.data_source_configuration.kendra_configuration.query_filter_string_enabled

Specifies whether to enable an Amazon Kendra filter string or not.

qn_a_intent_configuration.data_source_configuration.opensearch_configuration

Contains details about the configuration of the Amazon OpenSearch Service database used for the AMAZON.QnAIntent. To create a domain, follow the steps at Creating and managing Amazon OpenSearch Service domains.

Show child fields
qn_a_intent_configuration.data_source_configuration.opensearch_configuration.domain_endpoint

The endpoint of the Amazon OpenSearch Service domain.

qn_a_intent_configuration.data_source_configuration.opensearch_configuration.exact_response

Specifies whether to return an exact response or to return an answer generated by the model using the fields you specify from the database.

qn_a_intent_configuration.data_source_configuration.opensearch_configuration.exact_response_fields

Contains the names of the fields used for an exact response to the user.

Show child fields
qn_a_intent_configuration.data_source_configuration.opensearch_configuration.exact_response_fields.answer_field

The name of the field that contains the answer to the query made to the OpenSearch Service database.

qn_a_intent_configuration.data_source_configuration.opensearch_configuration.exact_response_fields.question_field

The name of the field that contains the query made to the OpenSearch Service database.

qn_a_intent_configuration.data_source_configuration.opensearch_configuration.include_fields[]
qn_a_intent_configuration.data_source_configuration.opensearch_configuration.index_name

The name of the Amazon OpenSearch Service index.

sample_utterances

User utterances that trigger this intent.

STRUCT(
"utterance" VARCHAR
)[]
Show child fields
sample_utterances[]
Show child fields
sample_utterances[].utterance

The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.

slot_priorities

The list that determines the priority that slots should be elicited from the user.

STRUCT(
"priority" BIGINT,
"slot_id" VARCHAR
)[]
Show child fields
slot_priorities[]
Show child fields
slot_priorities[].priority

The priority that Amazon Lex should apply to the slot.

slot_priorities[].slot_id

The unique identifier of the slot.