Skip to content
AWS for Query.Farm

aws.lexv2_models.list_slots

Example SQL Queries

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

Description

Gets a list of slots that match the specified criteria.

Table Definition

Column NameColumn Data Type
bot_id Required Input Column

The identifier of the bot that contains the slots.

VARCHAR
bot_version Required Input Column

The version of the bot that contains the slots.

VARCHAR
intent_id Required Input Column

The identifier of the intent that contains the slots.

VARCHAR
locale_id Required Input Column

The language and locale of the slots in the list.

VARCHAR
filters Input Column

Provides the specification of a filter used to limit the slots in the response to only those that match the filter specification. You can only specify one filter and only one string to filter on.

STRUCT(
    "name" VARCHAR,
    "values" VARCHAR[],
    "operator" VARCHAR
)[]
Show child fields
filters[]
Show child fields
filters[].name

The name of the field to use for filtering.

filters[].operator

The operator to use for the filter. Specify EQ when the ListSlots operation should return only aliases that equal the specified value. Specify CO when the ListSlots operation should return aliases that contain the specified value.

filters[].values[]
max_results Input Column

The maximum number of slots to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

BIGINT
next_token Input Column

A token that indicates whether there are more results to return in a response to the ListSlots operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListSlots operation request to get the next page of results.

VARCHAR
sort_by Input Column

Determines the sort order for the response from the ListSlots operation. You can choose to sort by the slot name or last updated date in either ascending or descending order.

STRUCT(
    "attribute" VARCHAR,
    "order" VARCHAR
)
Show child fields
sort_by.attribute

The attribute to use to sort the list.

sort_by.order

The order to sort the list. You can choose ascending or descending.

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

slot_summaries

Summary information for the slots that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter of the request. If there are more slots available, the nextToken field contains a token to get the next page of results.

STRUCT(
    "slot_id" VARCHAR,
    "slot_name" VARCHAR,
    "description" VARCHAR,
    "slot_constraint" VARCHAR,
    "slot_type_id" VARCHAR,
    "value_elicitation_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
                )
            ))
    ),
    "last_updated_date_time" TIMESTAMP_S
)[]
Show child fields
slot_summaries[]
Show child fields
slot_summaries[].description

The description of the slot.

slot_summaries[].last_updated_date_time

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

slot_summaries[].slot_constraint

Whether the slot is required or optional. An intent is complete when all required slots are filled.

slot_summaries[].slot_id

The unique identifier of the slot.

slot_summaries[].slot_name

The name given to the slot.

slot_summaries[].slot_type_id

The unique identifier for the slot type that defines the values for the slot.

slot_summaries[].value_elicitation_prompt_specification

Prompts that are sent to the user to elicit a value for the slot.

Show child fields
slot_summaries[].value_elicitation_prompt_specification.allow_interrupt

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

slot_summaries[].value_elicitation_prompt_specification.max_retries

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

slot_summaries[].value_elicitation_prompt_specification.message_groups[]
Show child fields
slot_summaries[].value_elicitation_prompt_specification.message_groups[].message

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

Show child fields
slot_summaries[].value_elicitation_prompt_specification.message_groups[].message.custom_payload

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

Show child fields
slot_summaries[].value_elicitation_prompt_specification.message_groups[].message.custom_payload.value

The string that is sent to your application.

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

slot_summaries[].value_elicitation_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.

slot_summaries[].value_elicitation_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.

slot_summaries[].value_elicitation_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.

slot_summaries[].value_elicitation_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.

slot_summaries[].value_elicitation_prompt_specification.message_groups[].message.plain_text_message

A message in plain text format.

Show child fields
slot_summaries[].value_elicitation_prompt_specification.message_groups[].message.plain_text_message.value

The message to send to the user.

slot_summaries[].value_elicitation_prompt_specification.message_groups[].message.ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
slot_summaries[].value_elicitation_prompt_specification.message_groups[].message.ssml_message.value

The SSML text that defines the prompt.

slot_summaries[].value_elicitation_prompt_specification.message_groups[].variations[]
Show child fields
slot_summaries[].value_elicitation_prompt_specification.message_groups[].variations[].custom_payload

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

Show child fields
slot_summaries[].value_elicitation_prompt_specification.message_groups[].variations[].custom_payload.value

The string that is sent to your application.

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

slot_summaries[].value_elicitation_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.

slot_summaries[].value_elicitation_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.

slot_summaries[].value_elicitation_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.

slot_summaries[].value_elicitation_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.

slot_summaries[].value_elicitation_prompt_specification.message_groups[].variations[].plain_text_message

A message in plain text format.

Show child fields
slot_summaries[].value_elicitation_prompt_specification.message_groups[].variations[].plain_text_message.value

The message to send to the user.

slot_summaries[].value_elicitation_prompt_specification.message_groups[].variations[].ssml_message

A message in Speech Synthesis Markup Language (SSML).

Show child fields
slot_summaries[].value_elicitation_prompt_specification.message_groups[].variations[].ssml_message.value

The SSML text that defines the prompt.

slot_summaries[].value_elicitation_prompt_specification.message_selection_strategy

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

slot_summaries[].value_elicitation_prompt_specification.prompt_attempts_specification

Specifies the advanced settings on each attempt of the prompt.