Skip to content

aws.lexv2_models.describe_slot

Example SQL Queries

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

Description

Gets metadata information about a slot.

Table Definition

Column NameColumn Data Type
bot_id Required Input Column

The identifier of the bot associated with the slot.

VARCHAR
bot_version Required Input Column

The version of the bot associated with the slot.

VARCHAR
intent_id Required Input Column

The identifier of the intent associated with the slot.

VARCHAR
locale_id Required Input Column

The language and locale specified for the slot.

VARCHAR
slot_id Required Input Column

The unique identifier generated for the slot.

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 slot was created.

TIMESTAMP_S
description

The description specified for the slot.

VARCHAR
last_updated_date_time

A timestamp of the date and time that the slot was last updated.

TIMESTAMP_S
multiple_values_setting

Indicates whether the slot accepts multiple values in a single utterance.

If the multipleValuesSetting is not set, the default value is false.

STRUCT(
"allow_multiple_values" BOOLEAN
)
Show child fields
multiple_values_setting.allow_multiple_values

Indicates whether a slot can return multiple values. When true, the slot may return more than one value in a response. When false, the slot returns only a single value.

Multi-value slots are only available in the en-US locale. If you set this value to true in any other locale, Amazon Lex throws a ValidationException.

If the allowMutlipleValues is not set, the default value is false.

obfuscation_setting

Whether slot values are shown in Amazon CloudWatch logs. If the value is None, the actual value of the slot is shown in logs.

STRUCT(
"obfuscation_setting_type" VARCHAR
)
Show child fields
obfuscation_setting.obfuscation_setting_type

Value that determines whether Amazon Lex obscures slot values in conversation logs. The default is to obscure the values.

slot_name

The name specified for the slot.

VARCHAR
slot_type_id

The identifier of the slot type that determines the values entered into the slot.

VARCHAR
sub_slot_setting

Specifications for the constituent sub slots and the expression for the composite slot.

STRUCT(
"expression" VARCHAR,
"slot_specifications" MAP(VARCHAR, STRUCT(
"slot_type_id" VARCHAR,
"value_elicitation_setting" STRUCT(
"default_value_specification" STRUCT(
"default_value_list" STRUCT(
"default_value" VARCHAR
)[]
),
"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
)
))
),
"sample_utterances" STRUCT(
"utterance" VARCHAR
)[],
"wait_and_continue_specification" STRUCT(
"waiting_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
),
"continue_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
),
"still_waiting_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
)[]
)
)[]
)[],
"frequency_in_seconds" BIGINT,
"timeout_in_seconds" BIGINT,
"allow_interrupt" BOOLEAN
),
"active" BOOLEAN
)
)
))
)
Show child fields
sub_slot_setting.expression

The expression text for defining the constituent sub slots in the composite slot using logical AND and OR operators.

sub_slot_setting.slot_specifications

Specifications for the constituent sub slots of a composite slot.

value_elicitation_setting

Prompts that Amazon Lex uses to elicit a value for the slot.

STRUCT(
"default_value_specification" STRUCT(
"default_value_list" STRUCT(
"default_value" VARCHAR
)[]
),
"slot_constraint" VARCHAR,
"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
)
))
),
"sample_utterances" STRUCT(
"utterance" VARCHAR
)[],
"wait_and_continue_specification" STRUCT(
"waiting_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
),
"continue_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
),
"still_waiting_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
)[]
)
)[]
)[],
"frequency_in_seconds" BIGINT,
"timeout_in_seconds" BIGINT,
"allow_interrupt" BOOLEAN
),
"active" BOOLEAN
),
"slot_capture_setting" STRUCT(
"capture_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
),
"capture_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)
),
"capture_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
)
),
"slot_resolution_setting" STRUCT(
"slot_resolution_strategy" VARCHAR
)
)
Show child fields
value_elicitation_setting.default_value_specification

A list of default values for a slot. Default values are used when Amazon Lex hasn't determined a value for a slot. You can specify default values from context variables, session attributes, and defined values.

Show child fields
value_elicitation_setting.default_value_specification.default_value_list[]
Show child fields
value_elicitation_setting.default_value_specification.default_value_list[].default_value

The default value to use when a user doesn't provide a value for a slot.

value_elicitation_setting.prompt_specification

The prompt that Amazon Lex uses to elicit the slot value from the user.

Show child fields
value_elicitation_setting.prompt_specification.allow_interrupt

Indicates whether the user can interrupt a speech prompt from the bot.

value_elicitation_setting.prompt_specification.max_retries

The maximum number of times the bot tries to elicit a response from the user using this prompt.

value_elicitation_setting.prompt_specification.message_groups[]
Show child fields
value_elicitation_setting.prompt_specification.message_groups[].message

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

Show child fields
value_elicitation_setting.prompt_specification.message_groups[].message.custom_payload

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

Show child fields
value_elicitation_setting.prompt_specification.message_groups[].message.custom_payload.value

The string that is sent to your application.

value_elicitation_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
value_elicitation_setting.prompt_specification.message_groups[].message.image_response_card.buttons[]
Show child fields
value_elicitation_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.

value_elicitation_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.

value_elicitation_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.

value_elicitation_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.

value_elicitation_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.

value_elicitation_setting.prompt_specification.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
value_elicitation_setting.prompt_specification.message_groups[].message.plain_text_message.value

The message to send to the user.

value_elicitation_setting.prompt_specification.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
value_elicitation_setting.prompt_specification.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

value_elicitation_setting.prompt_specification.message_groups[].variations[]
Show child fields
value_elicitation_setting.prompt_specification.message_groups[].variations[].custom_payload

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

Show child fields
value_elicitation_setting.prompt_specification.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

value_elicitation_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
value_elicitation_setting.prompt_specification.message_groups[].variations[].image_response_card.buttons[]
Show child fields
value_elicitation_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.

value_elicitation_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.

value_elicitation_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.

value_elicitation_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.

value_elicitation_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.

value_elicitation_setting.prompt_specification.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
value_elicitation_setting.prompt_specification.message_groups[].variations[].plain_text_message.value

The message to send to the user.

value_elicitation_setting.prompt_specification.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
value_elicitation_setting.prompt_specification.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

value_elicitation_setting.prompt_specification.message_selection_strategy

Indicates how a message is selected from a message group among retries.

value_elicitation_setting.prompt_specification.prompt_attempts_specification

Specifies the advanced settings on each attempt of the prompt.

value_elicitation_setting.sample_utterances[]
Show child fields
value_elicitation_setting.sample_utterances[].utterance

The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.

value_elicitation_setting.slot_capture_setting

Specifies the settings that Amazon Lex uses when a slot value is successfully entered by a user.

Show child fields
value_elicitation_setting.slot_capture_setting.capture_conditional

A list of conditional branches to evaluate after the slot value is captured.

Show child fields
value_elicitation_setting.slot_capture_setting.capture_conditional.active

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

value_elicitation_setting.slot_capture_setting.capture_conditional.conditional_branches[]
Show child fields
value_elicitation_setting.slot_capture_setting.capture_conditional.conditional_branches[].condition

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

Show child fields
value_elicitation_setting.slot_capture_setting.capture_conditional.conditional_branches[].condition.expression_string

The expression string that is evaluated.

value_elicitation_setting.slot_capture_setting.capture_conditional.conditional_branches[].name

The name of the branch.

value_elicitation_setting.slot_capture_setting.capture_conditional.conditional_branches[].next_step

The next step in the conversation.

Show child fields
value_elicitation_setting.slot_capture_setting.capture_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
value_elicitation_setting.slot_capture_setting.capture_conditional.conditional_branches[].next_step.dialog_action.slot_to_elicit

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

value_elicitation_setting.slot_capture_setting.capture_conditional.conditional_branches[].next_step.dialog_action.suppress_next_message

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

value_elicitation_setting.slot_capture_setting.capture_conditional.conditional_branches[].next_step.dialog_action.type

The action that the bot should execute.

value_elicitation_setting.slot_capture_setting.capture_conditional.conditional_branches[].next_step.intent

Override settings to configure the intent state.

Show child fields
value_elicitation_setting.slot_capture_setting.capture_conditional.conditional_branches[].next_step.intent.name

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

value_elicitation_setting.slot_capture_setting.capture_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.

value_elicitation_setting.slot_capture_setting.capture_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.

value_elicitation_setting.slot_capture_setting.capture_conditional.conditional_branches[].response

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

Show child fields
value_elicitation_setting.slot_capture_setting.capture_conditional.conditional_branches[].response.allow_interrupt

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

value_elicitation_setting.slot_capture_setting.capture_conditional.conditional_branches[].response.message_groups[]
Show child fields
value_elicitation_setting.slot_capture_setting.capture_conditional.conditional_branches[].response.message_groups[].message

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

Show child fields
value_elicitation_setting.slot_capture_setting.capture_conditional.conditional_branches[].response.message_groups[].message.custom_payload

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

Show child fields
value_elicitation_setting.slot_capture_setting.capture_conditional.conditional_branches[].response.message_groups[].message.custom_payload.value

The string that is sent to your application.

value_elicitation_setting.slot_capture_setting.capture_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
value_elicitation_setting.slot_capture_setting.capture_conditional.conditional_branches[].response.message_groups[].message.image_response_card.buttons[]
Show child fields
value_elicitation_setting.slot_capture_setting.capture_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.

value_elicitation_setting.slot_capture_setting.capture_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.

value_elicitation_setting.slot_capture_setting.capture_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.

value_elicitation_setting.slot_capture_setting.capture_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.

value_elicitation_setting.slot_capture_setting.capture_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.

value_elicitation_setting.slot_capture_setting.capture_conditional.conditional_branches[].response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
value_elicitation_setting.slot_capture_setting.capture_conditional.conditional_branches[].response.message_groups[].message.plain_text_message.value

The message to send to the user.

value_elicitation_setting.slot_capture_setting.capture_conditional.conditional_branches[].response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
value_elicitation_setting.slot_capture_setting.capture_conditional.conditional_branches[].response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

value_elicitation_setting.slot_capture_setting.capture_conditional.conditional_branches[].response.message_groups[].variations[]
Show child fields
value_elicitation_setting.slot_capture_setting.capture_conditional.conditional_branches[].response.message_groups[].variations[].custom_payload

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

Show child fields
value_elicitation_setting.slot_capture_setting.capture_conditional.conditional_branches[].response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

value_elicitation_setting.slot_capture_setting.capture_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
value_elicitation_setting.slot_capture_setting.capture_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
value_elicitation_setting.slot_capture_setting.capture_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.

value_elicitation_setting.slot_capture_setting.capture_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.

value_elicitation_setting.slot_capture_setting.capture_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.

value_elicitation_setting.slot_capture_setting.capture_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.

value_elicitation_setting.slot_capture_setting.capture_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.

value_elicitation_setting.slot_capture_setting.capture_conditional.conditional_branches[].response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
value_elicitation_setting.slot_capture_setting.capture_conditional.conditional_branches[].response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

value_elicitation_setting.slot_capture_setting.capture_conditional.conditional_branches[].response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
value_elicitation_setting.slot_capture_setting.capture_conditional.conditional_branches[].response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

value_elicitation_setting.slot_capture_setting.capture_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
value_elicitation_setting.slot_capture_setting.capture_conditional.default_branch.next_step

The next step in the conversation.

Show child fields
value_elicitation_setting.slot_capture_setting.capture_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
value_elicitation_setting.slot_capture_setting.capture_conditional.default_branch.next_step.dialog_action.slot_to_elicit

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

value_elicitation_setting.slot_capture_setting.capture_conditional.default_branch.next_step.dialog_action.suppress_next_message

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

value_elicitation_setting.slot_capture_setting.capture_conditional.default_branch.next_step.dialog_action.type

The action that the bot should execute.

value_elicitation_setting.slot_capture_setting.capture_conditional.default_branch.next_step.intent

Override settings to configure the intent state.

Show child fields
value_elicitation_setting.slot_capture_setting.capture_conditional.default_branch.next_step.intent.name

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

value_elicitation_setting.slot_capture_setting.capture_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.

value_elicitation_setting.slot_capture_setting.capture_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.

value_elicitation_setting.slot_capture_setting.capture_conditional.default_branch.response

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

Show child fields
value_elicitation_setting.slot_capture_setting.capture_conditional.default_branch.response.allow_interrupt

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

value_elicitation_setting.slot_capture_setting.capture_conditional.default_branch.response.message_groups[]
Show child fields
value_elicitation_setting.slot_capture_setting.capture_conditional.default_branch.response.message_groups[].message

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

Show child fields
value_elicitation_setting.slot_capture_setting.capture_conditional.default_branch.response.message_groups[].message.custom_payload

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

Show child fields
value_elicitation_setting.slot_capture_setting.capture_conditional.default_branch.response.message_groups[].message.custom_payload.value

The string that is sent to your application.

value_elicitation_setting.slot_capture_setting.capture_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
value_elicitation_setting.slot_capture_setting.capture_conditional.default_branch.response.message_groups[].message.image_response_card.buttons[]
Show child fields
value_elicitation_setting.slot_capture_setting.capture_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.

value_elicitation_setting.slot_capture_setting.capture_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.

value_elicitation_setting.slot_capture_setting.capture_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.

value_elicitation_setting.slot_capture_setting.capture_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.

value_elicitation_setting.slot_capture_setting.capture_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.

value_elicitation_setting.slot_capture_setting.capture_conditional.default_branch.response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
value_elicitation_setting.slot_capture_setting.capture_conditional.default_branch.response.message_groups[].message.plain_text_message.value

The message to send to the user.

value_elicitation_setting.slot_capture_setting.capture_conditional.default_branch.response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
value_elicitation_setting.slot_capture_setting.capture_conditional.default_branch.response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

value_elicitation_setting.slot_capture_setting.capture_conditional.default_branch.response.message_groups[].variations[]
Show child fields
value_elicitation_setting.slot_capture_setting.capture_conditional.default_branch.response.message_groups[].variations[].custom_payload

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

Show child fields
value_elicitation_setting.slot_capture_setting.capture_conditional.default_branch.response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

value_elicitation_setting.slot_capture_setting.capture_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
value_elicitation_setting.slot_capture_setting.capture_conditional.default_branch.response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
value_elicitation_setting.slot_capture_setting.capture_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.

value_elicitation_setting.slot_capture_setting.capture_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.

value_elicitation_setting.slot_capture_setting.capture_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.

value_elicitation_setting.slot_capture_setting.capture_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.

value_elicitation_setting.slot_capture_setting.capture_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.

value_elicitation_setting.slot_capture_setting.capture_conditional.default_branch.response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
value_elicitation_setting.slot_capture_setting.capture_conditional.default_branch.response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

value_elicitation_setting.slot_capture_setting.capture_conditional.default_branch.response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
value_elicitation_setting.slot_capture_setting.capture_conditional.default_branch.response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

value_elicitation_setting.slot_capture_setting.capture_next_step

Specifies the next step that the bot runs when the slot value is captured before the code hook times out.

Show child fields
value_elicitation_setting.slot_capture_setting.capture_next_step.dialog_action

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

Show child fields
value_elicitation_setting.slot_capture_setting.capture_next_step.dialog_action.slot_to_elicit

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

value_elicitation_setting.slot_capture_setting.capture_next_step.dialog_action.suppress_next_message

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

value_elicitation_setting.slot_capture_setting.capture_next_step.dialog_action.type

The action that the bot should execute.

value_elicitation_setting.slot_capture_setting.capture_next_step.intent

Override settings to configure the intent state.

Show child fields
value_elicitation_setting.slot_capture_setting.capture_next_step.intent.name

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

value_elicitation_setting.slot_capture_setting.capture_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.

value_elicitation_setting.slot_capture_setting.capture_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.

value_elicitation_setting.slot_capture_setting.capture_response

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

Show child fields
value_elicitation_setting.slot_capture_setting.capture_response.allow_interrupt

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

value_elicitation_setting.slot_capture_setting.capture_response.message_groups[]
Show child fields
value_elicitation_setting.slot_capture_setting.capture_response.message_groups[].message

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

Show child fields
value_elicitation_setting.slot_capture_setting.capture_response.message_groups[].message.custom_payload

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

Show child fields
value_elicitation_setting.slot_capture_setting.capture_response.message_groups[].message.custom_payload.value

The string that is sent to your application.

value_elicitation_setting.slot_capture_setting.capture_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
value_elicitation_setting.slot_capture_setting.capture_response.message_groups[].message.image_response_card.buttons[]
Show child fields
value_elicitation_setting.slot_capture_setting.capture_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.

value_elicitation_setting.slot_capture_setting.capture_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.

value_elicitation_setting.slot_capture_setting.capture_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.

value_elicitation_setting.slot_capture_setting.capture_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.

value_elicitation_setting.slot_capture_setting.capture_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.

value_elicitation_setting.slot_capture_setting.capture_response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
value_elicitation_setting.slot_capture_setting.capture_response.message_groups[].message.plain_text_message.value

The message to send to the user.

value_elicitation_setting.slot_capture_setting.capture_response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
value_elicitation_setting.slot_capture_setting.capture_response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

value_elicitation_setting.slot_capture_setting.capture_response.message_groups[].variations[]
Show child fields
value_elicitation_setting.slot_capture_setting.capture_response.message_groups[].variations[].custom_payload

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

Show child fields
value_elicitation_setting.slot_capture_setting.capture_response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

value_elicitation_setting.slot_capture_setting.capture_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
value_elicitation_setting.slot_capture_setting.capture_response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
value_elicitation_setting.slot_capture_setting.capture_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.

value_elicitation_setting.slot_capture_setting.capture_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.

value_elicitation_setting.slot_capture_setting.capture_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.

value_elicitation_setting.slot_capture_setting.capture_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.

value_elicitation_setting.slot_capture_setting.capture_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.

value_elicitation_setting.slot_capture_setting.capture_response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
value_elicitation_setting.slot_capture_setting.capture_response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

value_elicitation_setting.slot_capture_setting.capture_response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
value_elicitation_setting.slot_capture_setting.capture_response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

value_elicitation_setting.slot_capture_setting.code_hook

Code hook called after Amazon Lex successfully captures a slot value.

Show child fields
value_elicitation_setting.slot_capture_setting.code_hook.active

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

value_elicitation_setting.slot_capture_setting.code_hook.enable_code_hook_invocation

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

value_elicitation_setting.slot_capture_setting.code_hook.invocation_label

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

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[]
Show child fields
value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].condition.expression_string

The expression string that is evaluated.

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].name

The name of the branch.

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].next_step

The next step in the conversation.

Show child fields
value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].next_step.dialog_action.type

The action that the bot should execute.

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].next_step.intent

Override settings to configure the intent state.

Show child fields
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[]
Show child fields
value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].message.image_response_card.buttons[]
Show child fields
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].variations[]
Show child fields
value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.failure_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.next_step

The next step in the conversation.

Show child fields
value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.next_step.dialog_action.type

The action that the bot should execute.

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.next_step.intent

Override settings to configure the intent state.

Show child fields
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[]
Show child fields
value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].message.image_response_card.buttons[]
Show child fields
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].variations[]
Show child fields
value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.failure_conditional.default_branch.response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.failure_next_step.dialog_action.type

The action that the bot should execute.

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.failure_next_step.intent

Override settings to configure the intent state.

Show child fields
value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.failure_next_step.intent.name

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

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.failure_response.allow_interrupt

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

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.failure_response.message_groups[]
Show child fields
value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].message.custom_payload.value

The string that is sent to your application.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].message.image_response_card.buttons[]
Show child fields
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].message.plain_text_message

A message in plain text format.

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

The message to send to the user.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].variations[]
Show child fields
value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.failure_response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[]
Show child fields
value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].condition.expression_string

The expression string that is evaluated.

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].name

The name of the branch.

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].next_step

The next step in the conversation.

Show child fields
value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].next_step.dialog_action.type

The action that the bot should execute.

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].next_step.intent

Override settings to configure the intent state.

Show child fields
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[]
Show child fields
value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].message.image_response_card.buttons[]
Show child fields
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].variations[]
Show child fields
value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.success_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.next_step

The next step in the conversation.

Show child fields
value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.next_step.dialog_action.type

The action that the bot should execute.

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.next_step.intent

Override settings to configure the intent state.

Show child fields
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[]
Show child fields
value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].message.image_response_card.buttons[]
Show child fields
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].variations[]
Show child fields
value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.success_conditional.default_branch.response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.success_next_step.dialog_action.type

The action that the bot should execute.

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.success_next_step.intent

Override settings to configure the intent state.

Show child fields
value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.success_next_step.intent.name

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

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.success_response.allow_interrupt

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

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.success_response.message_groups[]
Show child fields
value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.success_response.message_groups[].message.custom_payload.value

The string that is sent to your application.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.success_response.message_groups[].message.image_response_card.buttons[]
Show child fields
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.success_response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.success_response.message_groups[].message.plain_text_message.value

The message to send to the user.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.success_response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.success_response.message_groups[].variations[]
Show child fields
value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.success_response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.success_response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.success_response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.success_response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.success_response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[]
Show child fields
value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].condition.expression_string

The expression string that is evaluated.

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].name

The name of the branch.

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].next_step

The next step in the conversation.

Show child fields
value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].next_step.dialog_action.type

The action that the bot should execute.

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].next_step.intent

Override settings to configure the intent state.

Show child fields
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[]
Show child fields
value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].message.image_response_card.buttons[]
Show child fields
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].variations[]
Show child fields
value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.timeout_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.next_step

The next step in the conversation.

Show child fields
value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.next_step.dialog_action.type

The action that the bot should execute.

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.next_step.intent

Override settings to configure the intent state.

Show child fields
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[]
Show child fields
value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].message.image_response_card.buttons[]
Show child fields
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].variations[]
Show child fields
value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.timeout_conditional.default_branch.response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.timeout_next_step.dialog_action.type

The action that the bot should execute.

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.timeout_next_step.intent

Override settings to configure the intent state.

Show child fields
value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.timeout_next_step.intent.name

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

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.timeout_response.allow_interrupt

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

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[]
Show child fields
value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].message.custom_payload.value

The string that is sent to your application.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].message.image_response_card.buttons[]
Show child fields
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].message.plain_text_message.value

The message to send to the user.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].variations[]
Show child fields
value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.code_hook.post_code_hook_specification.timeout_response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

value_elicitation_setting.slot_capture_setting.elicitation_code_hook

Code hook called when Amazon Lex doesn't capture a slot value.

Show child fields
value_elicitation_setting.slot_capture_setting.elicitation_code_hook.enable_code_hook_invocation

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

value_elicitation_setting.slot_capture_setting.elicitation_code_hook.invocation_label

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

value_elicitation_setting.slot_capture_setting.failure_conditional

A list of conditional branches to evaluate when the slot value isn't captured.

Show child fields
value_elicitation_setting.slot_capture_setting.failure_conditional.active

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

value_elicitation_setting.slot_capture_setting.failure_conditional.conditional_branches[]
Show child fields
value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.failure_conditional.conditional_branches[].condition.expression_string

The expression string that is evaluated.

value_elicitation_setting.slot_capture_setting.failure_conditional.conditional_branches[].name

The name of the branch.

value_elicitation_setting.slot_capture_setting.failure_conditional.conditional_branches[].next_step

The next step in the conversation.

Show child fields
value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_setting.failure_conditional.conditional_branches[].next_step.dialog_action.suppress_next_message

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

value_elicitation_setting.slot_capture_setting.failure_conditional.conditional_branches[].next_step.dialog_action.type

The action that the bot should execute.

value_elicitation_setting.slot_capture_setting.failure_conditional.conditional_branches[].next_step.intent

Override settings to configure the intent state.

Show child fields
value_elicitation_setting.slot_capture_setting.failure_conditional.conditional_branches[].next_step.intent.name

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

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_setting.failure_conditional.conditional_branches[].response

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

Show child fields
value_elicitation_setting.slot_capture_setting.failure_conditional.conditional_branches[].response.allow_interrupt

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

value_elicitation_setting.slot_capture_setting.failure_conditional.conditional_branches[].response.message_groups[]
Show child fields
value_elicitation_setting.slot_capture_setting.failure_conditional.conditional_branches[].response.message_groups[].message

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

Show child fields
value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.failure_conditional.conditional_branches[].response.message_groups[].message.custom_payload.value

The string that is sent to your application.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.failure_conditional.conditional_branches[].response.message_groups[].message.image_response_card.buttons[]
Show child fields
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_setting.failure_conditional.conditional_branches[].response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
value_elicitation_setting.slot_capture_setting.failure_conditional.conditional_branches[].response.message_groups[].message.plain_text_message.value

The message to send to the user.

value_elicitation_setting.slot_capture_setting.failure_conditional.conditional_branches[].response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
value_elicitation_setting.slot_capture_setting.failure_conditional.conditional_branches[].response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

value_elicitation_setting.slot_capture_setting.failure_conditional.conditional_branches[].response.message_groups[].variations[]
Show child fields
value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.failure_conditional.conditional_branches[].response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.failure_conditional.conditional_branches[].response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_setting.failure_conditional.conditional_branches[].response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
value_elicitation_setting.slot_capture_setting.failure_conditional.conditional_branches[].response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

value_elicitation_setting.slot_capture_setting.failure_conditional.conditional_branches[].response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
value_elicitation_setting.slot_capture_setting.failure_conditional.conditional_branches[].response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.failure_conditional.default_branch.next_step

The next step in the conversation.

Show child fields
value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_setting.failure_conditional.default_branch.next_step.dialog_action.suppress_next_message

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

value_elicitation_setting.slot_capture_setting.failure_conditional.default_branch.next_step.dialog_action.type

The action that the bot should execute.

value_elicitation_setting.slot_capture_setting.failure_conditional.default_branch.next_step.intent

Override settings to configure the intent state.

Show child fields
value_elicitation_setting.slot_capture_setting.failure_conditional.default_branch.next_step.intent.name

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

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_setting.failure_conditional.default_branch.response

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

Show child fields
value_elicitation_setting.slot_capture_setting.failure_conditional.default_branch.response.allow_interrupt

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

value_elicitation_setting.slot_capture_setting.failure_conditional.default_branch.response.message_groups[]
Show child fields
value_elicitation_setting.slot_capture_setting.failure_conditional.default_branch.response.message_groups[].message

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

Show child fields
value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.failure_conditional.default_branch.response.message_groups[].message.custom_payload.value

The string that is sent to your application.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.failure_conditional.default_branch.response.message_groups[].message.image_response_card.buttons[]
Show child fields
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_setting.failure_conditional.default_branch.response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
value_elicitation_setting.slot_capture_setting.failure_conditional.default_branch.response.message_groups[].message.plain_text_message.value

The message to send to the user.

value_elicitation_setting.slot_capture_setting.failure_conditional.default_branch.response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
value_elicitation_setting.slot_capture_setting.failure_conditional.default_branch.response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

value_elicitation_setting.slot_capture_setting.failure_conditional.default_branch.response.message_groups[].variations[]
Show child fields
value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.failure_conditional.default_branch.response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.failure_conditional.default_branch.response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_setting.failure_conditional.default_branch.response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
value_elicitation_setting.slot_capture_setting.failure_conditional.default_branch.response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

value_elicitation_setting.slot_capture_setting.failure_conditional.default_branch.response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
value_elicitation_setting.slot_capture_setting.failure_conditional.default_branch.response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

value_elicitation_setting.slot_capture_setting.failure_next_step

Specifies the next step that the bot runs when the slot value code is not recognized.

Show child fields
value_elicitation_setting.slot_capture_setting.failure_next_step.dialog_action

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

Show child fields
value_elicitation_setting.slot_capture_setting.failure_next_step.dialog_action.slot_to_elicit

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

value_elicitation_setting.slot_capture_setting.failure_next_step.dialog_action.suppress_next_message

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

value_elicitation_setting.slot_capture_setting.failure_next_step.dialog_action.type

The action that the bot should execute.

value_elicitation_setting.slot_capture_setting.failure_next_step.intent

Override settings to configure the intent state.

Show child fields
value_elicitation_setting.slot_capture_setting.failure_next_step.intent.name

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

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_setting.failure_response

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

Show child fields
value_elicitation_setting.slot_capture_setting.failure_response.allow_interrupt

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

value_elicitation_setting.slot_capture_setting.failure_response.message_groups[]
Show child fields
value_elicitation_setting.slot_capture_setting.failure_response.message_groups[].message

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

Show child fields
value_elicitation_setting.slot_capture_setting.failure_response.message_groups[].message.custom_payload

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

Show child fields
value_elicitation_setting.slot_capture_setting.failure_response.message_groups[].message.custom_payload.value

The string that is sent to your application.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.failure_response.message_groups[].message.image_response_card.buttons[]
Show child fields
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_setting.failure_response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
value_elicitation_setting.slot_capture_setting.failure_response.message_groups[].message.plain_text_message.value

The message to send to the user.

value_elicitation_setting.slot_capture_setting.failure_response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
value_elicitation_setting.slot_capture_setting.failure_response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

value_elicitation_setting.slot_capture_setting.failure_response.message_groups[].variations[]
Show child fields
value_elicitation_setting.slot_capture_setting.failure_response.message_groups[].variations[].custom_payload

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

Show child fields
value_elicitation_setting.slot_capture_setting.failure_response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

value_elicitation_setting.slot_capture_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
value_elicitation_setting.slot_capture_setting.failure_response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_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.

value_elicitation_setting.slot_capture_setting.failure_response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
value_elicitation_setting.slot_capture_setting.failure_response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

value_elicitation_setting.slot_capture_setting.failure_response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
value_elicitation_setting.slot_capture_setting.failure_response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

value_elicitation_setting.slot_constraint

Specifies whether the slot is required or optional.

value_elicitation_setting.slot_resolution_setting

An object containing information about whether assisted slot resolution is turned on for the slot or not.

Show child fields
value_elicitation_setting.slot_resolution_setting.slot_resolution_strategy

Specifies whether assisted slot resolution is turned on for the slot or not. If the value is EnhancedFallback, assisted slot resolution is activated when Amazon Lex defaults to the AMAZON.FallbackIntent. If the value is Default, assisted slot resolution is turned off.

value_elicitation_setting.wait_and_continue_specification

Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.

Show child fields
value_elicitation_setting.wait_and_continue_specification.active

Specifies whether the bot will wait for a user to respond. When this field is false, wait and continue responses for a slot aren't used. If the active field isn't specified, the default is true.

value_elicitation_setting.wait_and_continue_specification.continue_response

The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation.

Show child fields
value_elicitation_setting.wait_and_continue_specification.continue_response.allow_interrupt

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

value_elicitation_setting.wait_and_continue_specification.continue_response.message_groups[]
Show child fields
value_elicitation_setting.wait_and_continue_specification.continue_response.message_groups[].message

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

Show child fields
value_elicitation_setting.wait_and_continue_specification.continue_response.message_groups[].message.custom_payload

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

Show child fields
value_elicitation_setting.wait_and_continue_specification.continue_response.message_groups[].message.custom_payload.value

The string that is sent to your application.

value_elicitation_setting.wait_and_continue_specification.continue_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
value_elicitation_setting.wait_and_continue_specification.continue_response.message_groups[].message.image_response_card.buttons[]
Show child fields
value_elicitation_setting.wait_and_continue_specification.continue_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.

value_elicitation_setting.wait_and_continue_specification.continue_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.

value_elicitation_setting.wait_and_continue_specification.continue_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.

value_elicitation_setting.wait_and_continue_specification.continue_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.

value_elicitation_setting.wait_and_continue_specification.continue_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.

value_elicitation_setting.wait_and_continue_specification.continue_response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
value_elicitation_setting.wait_and_continue_specification.continue_response.message_groups[].message.plain_text_message.value

The message to send to the user.

value_elicitation_setting.wait_and_continue_specification.continue_response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
value_elicitation_setting.wait_and_continue_specification.continue_response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

value_elicitation_setting.wait_and_continue_specification.continue_response.message_groups[].variations[]
Show child fields
value_elicitation_setting.wait_and_continue_specification.continue_response.message_groups[].variations[].custom_payload

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

Show child fields
value_elicitation_setting.wait_and_continue_specification.continue_response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

value_elicitation_setting.wait_and_continue_specification.continue_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
value_elicitation_setting.wait_and_continue_specification.continue_response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
value_elicitation_setting.wait_and_continue_specification.continue_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.

value_elicitation_setting.wait_and_continue_specification.continue_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.

value_elicitation_setting.wait_and_continue_specification.continue_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.

value_elicitation_setting.wait_and_continue_specification.continue_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.

value_elicitation_setting.wait_and_continue_specification.continue_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.

value_elicitation_setting.wait_and_continue_specification.continue_response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
value_elicitation_setting.wait_and_continue_specification.continue_response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

value_elicitation_setting.wait_and_continue_specification.continue_response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
value_elicitation_setting.wait_and_continue_specification.continue_response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

value_elicitation_setting.wait_and_continue_specification.still_waiting_response

A response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user.

Show child fields
value_elicitation_setting.wait_and_continue_specification.still_waiting_response.allow_interrupt

Indicates that the user can interrupt the response by speaking while the message is being played.

value_elicitation_setting.wait_and_continue_specification.still_waiting_response.frequency_in_seconds

How often a message should be sent to the user. Minimum of 1 second, maximum of 5 minutes.

value_elicitation_setting.wait_and_continue_specification.still_waiting_response.message_groups[]
Show child fields
value_elicitation_setting.wait_and_continue_specification.still_waiting_response.message_groups[].message

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

Show child fields
value_elicitation_setting.wait_and_continue_specification.still_waiting_response.message_groups[].message.custom_payload

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

Show child fields
value_elicitation_setting.wait_and_continue_specification.still_waiting_response.message_groups[].message.custom_payload.value

The string that is sent to your application.

value_elicitation_setting.wait_and_continue_specification.still_waiting_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
value_elicitation_setting.wait_and_continue_specification.still_waiting_response.message_groups[].message.image_response_card.buttons[]
Show child fields
value_elicitation_setting.wait_and_continue_specification.still_waiting_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.

value_elicitation_setting.wait_and_continue_specification.still_waiting_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.

value_elicitation_setting.wait_and_continue_specification.still_waiting_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.

value_elicitation_setting.wait_and_continue_specification.still_waiting_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.

value_elicitation_setting.wait_and_continue_specification.still_waiting_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.

value_elicitation_setting.wait_and_continue_specification.still_waiting_response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
value_elicitation_setting.wait_and_continue_specification.still_waiting_response.message_groups[].message.plain_text_message.value

The message to send to the user.

value_elicitation_setting.wait_and_continue_specification.still_waiting_response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
value_elicitation_setting.wait_and_continue_specification.still_waiting_response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

value_elicitation_setting.wait_and_continue_specification.still_waiting_response.message_groups[].variations[]
Show child fields
value_elicitation_setting.wait_and_continue_specification.still_waiting_response.message_groups[].variations[].custom_payload

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

Show child fields
value_elicitation_setting.wait_and_continue_specification.still_waiting_response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

value_elicitation_setting.wait_and_continue_specification.still_waiting_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
value_elicitation_setting.wait_and_continue_specification.still_waiting_response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
value_elicitation_setting.wait_and_continue_specification.still_waiting_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.

value_elicitation_setting.wait_and_continue_specification.still_waiting_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.

value_elicitation_setting.wait_and_continue_specification.still_waiting_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.

value_elicitation_setting.wait_and_continue_specification.still_waiting_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.

value_elicitation_setting.wait_and_continue_specification.still_waiting_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.

value_elicitation_setting.wait_and_continue_specification.still_waiting_response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
value_elicitation_setting.wait_and_continue_specification.still_waiting_response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

value_elicitation_setting.wait_and_continue_specification.still_waiting_response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
value_elicitation_setting.wait_and_continue_specification.still_waiting_response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

value_elicitation_setting.wait_and_continue_specification.still_waiting_response.timeout_in_seconds

If Amazon Lex waits longer than this length of time for a response, it will stop sending messages.

value_elicitation_setting.wait_and_continue_specification.waiting_response

The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue.

Show child fields
value_elicitation_setting.wait_and_continue_specification.waiting_response.allow_interrupt

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

value_elicitation_setting.wait_and_continue_specification.waiting_response.message_groups[]
Show child fields
value_elicitation_setting.wait_and_continue_specification.waiting_response.message_groups[].message

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

Show child fields
value_elicitation_setting.wait_and_continue_specification.waiting_response.message_groups[].message.custom_payload

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

Show child fields
value_elicitation_setting.wait_and_continue_specification.waiting_response.message_groups[].message.custom_payload.value

The string that is sent to your application.

value_elicitation_setting.wait_and_continue_specification.waiting_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
value_elicitation_setting.wait_and_continue_specification.waiting_response.message_groups[].message.image_response_card.buttons[]
Show child fields
value_elicitation_setting.wait_and_continue_specification.waiting_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.

value_elicitation_setting.wait_and_continue_specification.waiting_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.

value_elicitation_setting.wait_and_continue_specification.waiting_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.

value_elicitation_setting.wait_and_continue_specification.waiting_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.

value_elicitation_setting.wait_and_continue_specification.waiting_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.

value_elicitation_setting.wait_and_continue_specification.waiting_response.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
value_elicitation_setting.wait_and_continue_specification.waiting_response.message_groups[].message.plain_text_message.value

The message to send to the user.

value_elicitation_setting.wait_and_continue_specification.waiting_response.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
value_elicitation_setting.wait_and_continue_specification.waiting_response.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

value_elicitation_setting.wait_and_continue_specification.waiting_response.message_groups[].variations[]
Show child fields
value_elicitation_setting.wait_and_continue_specification.waiting_response.message_groups[].variations[].custom_payload

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

Show child fields
value_elicitation_setting.wait_and_continue_specification.waiting_response.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

value_elicitation_setting.wait_and_continue_specification.waiting_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
value_elicitation_setting.wait_and_continue_specification.waiting_response.message_groups[].variations[].image_response_card.buttons[]
Show child fields
value_elicitation_setting.wait_and_continue_specification.waiting_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.

value_elicitation_setting.wait_and_continue_specification.waiting_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.

value_elicitation_setting.wait_and_continue_specification.waiting_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.

value_elicitation_setting.wait_and_continue_specification.waiting_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.

value_elicitation_setting.wait_and_continue_specification.waiting_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.

value_elicitation_setting.wait_and_continue_specification.waiting_response.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
value_elicitation_setting.wait_and_continue_specification.waiting_response.message_groups[].variations[].plain_text_message.value

The message to send to the user.

value_elicitation_setting.wait_and_continue_specification.waiting_response.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
value_elicitation_setting.wait_and_continue_specification.waiting_response.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.