Skip to content
AWS for Query.Farm

aws.lex_models.get_intent

Example SQL Queries

SELECT * FROM
aws.lex_models.get_intent
WHERE
"name" = 'VALUE'
AND "version" = 'VALUE';

Description

Returns information about an intent. In addition to the intent name, you must specify the intent version.

This operation requires permissions to perform the lex:GetIntent action.

Table Definition

Column NameColumn Data Type
name Required Input Column

The name of the intent.

VARCHAR
version Required Input Column

The version of the intent.

VARCHAR
_aws_profile Input Column

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

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

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

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

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

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

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

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

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

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

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

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

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

_aws_profile.via_profile_name

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

checksum

Checksum of the intent.

VARCHAR
conclusion_statement

After the Lambda function specified in the fulfillmentActivity element fulfills the intent, Amazon Lex conveys this statement to the user.

STRUCT(
    "messages" STRUCT(
        "content_type" VARCHAR,
        "content" VARCHAR,
        "group_number" BIGINT
    )[],
    "response_card" VARCHAR
)
Show child fields
conclusion_statement.messages[]
Show child fields
conclusion_statement.messages[].content

The text of the message.

conclusion_statement.messages[].content_type

The content type of the message string.

conclusion_statement.messages[].group_number

Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.

conclusion_statement.response_card

At runtime, if the client is using the PostText API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.

confirmation_prompt

If defined in the bot, Amazon Lex uses prompt to confirm the intent before fulfilling the user's request. For more information, see PutIntent. 

STRUCT(
    "messages" STRUCT(
        "content_type" VARCHAR,
        "content" VARCHAR,
        "group_number" BIGINT
    )[],
    "max_attempts" BIGINT,
    "response_card" VARCHAR
)
Show child fields
confirmation_prompt.max_attempts

The number of times to prompt the user for information.

confirmation_prompt.messages[]
Show child fields
confirmation_prompt.messages[].content

The text of the message.

confirmation_prompt.messages[].content_type

The content type of the message string.

confirmation_prompt.messages[].group_number

Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.

confirmation_prompt.response_card

A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card.

created_date

The date that the intent was created.

TIMESTAMP_S
description

A description of the intent.

VARCHAR
dialog_code_hook

If defined in the bot, Amazon Amazon Lex invokes this Lambda function for each user input. For more information, see PutIntent. 

STRUCT(
    "uri" VARCHAR,
    "message_version" VARCHAR
)
Show child fields
dialog_code_hook.message_version

The version of the request-response that you want Amazon Lex to use to invoke your Lambda function. For more information, see using-lambda.

dialog_code_hook.uri

The Amazon Resource Name (ARN) of the Lambda function.

follow_up_prompt

If defined in the bot, Amazon Lex uses this prompt to solicit additional user activity after the intent is fulfilled. For more information, see PutIntent.

STRUCT(
    "prompt" STRUCT(
        "messages" STRUCT(
            "content_type" VARCHAR,
            "content" VARCHAR,
            "group_number" BIGINT
        )[],
        "max_attempts" BIGINT,
        "response_card" VARCHAR
    ),
    "rejection_statement" STRUCT(
        "messages" STRUCT(
            "content_type" VARCHAR,
            "content" VARCHAR,
            "group_number" BIGINT
        )[],
        "response_card" VARCHAR
    )
)
Show child fields
follow_up_prompt.prompt

Prompts for information from the user.

Show child fields
follow_up_prompt.prompt.max_attempts

The number of times to prompt the user for information.

follow_up_prompt.prompt.messages[]
Show child fields
follow_up_prompt.prompt.messages[].content

The text of the message.

follow_up_prompt.prompt.messages[].content_type

The content type of the message string.

follow_up_prompt.prompt.messages[].group_number

Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.

follow_up_prompt.prompt.response_card

A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card.

follow_up_prompt.rejection_statement

If the user answers "no" to the question defined in the prompt field, Amazon Lex responds with this statement to acknowledge that the intent was canceled.

Show child fields
follow_up_prompt.rejection_statement.messages[]
Show child fields
follow_up_prompt.rejection_statement.messages[].content

The text of the message.

follow_up_prompt.rejection_statement.messages[].content_type

The content type of the message string.

follow_up_prompt.rejection_statement.messages[].group_number

Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.

follow_up_prompt.rejection_statement.response_card

At runtime, if the client is using the PostText API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.

fulfillment_activity

Describes how the intent is fulfilled. For more information, see PutIntent. 

STRUCT(
    "type" VARCHAR,
    "code_hook" STRUCT(
        "uri" VARCHAR,
        "message_version" VARCHAR
    )
)
Show child fields
fulfillment_activity.code_hook

A description of the Lambda function that is run to fulfill the intent.

Show child fields
fulfillment_activity.code_hook.message_version

The version of the request-response that you want Amazon Lex to use to invoke your Lambda function. For more information, see using-lambda.

fulfillment_activity.code_hook.uri

The Amazon Resource Name (ARN) of the Lambda function.

fulfillment_activity.type

How the intent should be fulfilled, either by running a Lambda function or by returning the slot data to the client application.

input_contexts

An array of InputContext objects that lists the contexts that must be active for Amazon Lex to choose the intent in a conversation with the user.

STRUCT(
    "name" VARCHAR
)[]
Show child fields
input_contexts[]
Show child fields
input_contexts[].name

The name of the context.

kendra_configuration

Configuration information, if any, to connect to an Amazon Kendra index with the AMAZON.KendraSearchIntent intent.

STRUCT(
    "kendra_index" VARCHAR,
    "query_filter_string" VARCHAR,
    "role" VARCHAR
)
Show child fields
kendra_configuration.kendra_index

The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search. The index must be in the same account and Region as the Amazon Lex bot. If the Amazon Kendra index does not exist, you get an exception when you call the PutIntent operation.

kendra_configuration.query_filter_string

A query filter that Amazon Lex sends to Amazon Kendra to filter the response from the query. The filter is in the format defined by Amazon Kendra. For more information, see Filtering queries.

You can override this filter string with a new filter string at runtime.

kendra_configuration.role

The Amazon Resource Name (ARN) of an IAM role that has permission to search the Amazon Kendra index. The role must be in the same account and Region as the Amazon Lex bot. If the role does not exist, you get an exception when you call the PutIntent operation.

last_updated_date

The date that the intent was updated. When you create a resource, the creation date and the last updated date are the same. 

TIMESTAMP_S
output_contexts

An array of OutputContext objects that lists the contexts that the intent activates when the intent is fulfilled.

STRUCT(
    "name" VARCHAR,
    "time_to_live_in_seconds" BIGINT,
    "turns_to_live" BIGINT
)[]
Show child fields
output_contexts[]
Show child fields
output_contexts[].name

The name of the context.

output_contexts[].time_to_live_in_seconds

The number of seconds that the context should be active after it is first sent in a PostContent or PostText response. You can set the value between 5 and 86,400 seconds (24 hours).

output_contexts[].turns_to_live

The number of conversation turns that the context should be active. A conversation turn is one PostContent or PostText request and the corresponding response from Amazon Lex.

parent_intent_signature

A unique identifier for a built-in intent.

VARCHAR
rejection_statement

If the user answers "no" to the question defined in confirmationPrompt, Amazon Lex responds with this statement to acknowledge that the intent was canceled. 

STRUCT(
    "messages" STRUCT(
        "content_type" VARCHAR,
        "content" VARCHAR,
        "group_number" BIGINT
    )[],
    "response_card" VARCHAR
)
Show child fields
rejection_statement.messages[]
Show child fields
rejection_statement.messages[].content

The text of the message.

rejection_statement.messages[].content_type

The content type of the message string.

rejection_statement.messages[].group_number

Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.

rejection_statement.response_card

At runtime, if the client is using the PostText API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.

sample_utterances

An array of sample utterances configured for the intent.

VARCHAR[]
Show child fields
sample_utterances[]
slots

An array of intent slots configured for the intent.

STRUCT(
    "name" VARCHAR,
    "description" VARCHAR,
    "slot_constraint" VARCHAR,
    "slot_type" VARCHAR,
    "slot_type_version" VARCHAR,
    "value_elicitation_prompt" STRUCT(
        "messages" STRUCT(
            "content_type" VARCHAR,
            "content" VARCHAR,
            "group_number" BIGINT
        )[],
        "max_attempts" BIGINT,
        "response_card" VARCHAR
    ),
    "priority" BIGINT,
    "sample_utterances" VARCHAR[],
    "response_card" VARCHAR,
    "obfuscation_setting" VARCHAR,
    "default_value_spec" STRUCT(
        "default_value_list" STRUCT(
            "default_value" VARCHAR
        )[]
    )
)[]
Show child fields
slots[]
Show child fields
slots[].default_value_spec

A list of default values for the 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
slots[].default_value_spec.default_value_list[]
Show child fields
slots[].default_value_spec.default_value_list[].default_value

The default value for the slot. You can specify one of the following:

  • #context-name.slot-name - The slot value "slot-name" in the context "context-name."

  • {attribute} - The slot value of the session attribute "attribute."

  • 'value' - The discrete value "value."

slots[].description

A description of the slot.

slots[].name

The name of the slot.

slots[].obfuscation_setting

Determines whether a slot is obfuscated in conversation logs and stored utterances. When you obfuscate a slot, the value is replaced by the slot name in curly braces ({}). For example, if the slot name is "full_name", obfuscated values are replaced with "{full_name}". For more information, see Slot Obfuscation .

slots[].priority

Directs Amazon Lex the order in which to elicit this slot value from the user. For example, if the intent has two slots with priorities 1 and 2, AWS Amazon Lex first elicits a value for the slot with priority 1.

If multiple slots share the same priority, the order in which Amazon Lex elicits values is arbitrary.

slots[].response_card

A set of possible responses for the slot type used by text-based clients. A user chooses an option from the response card, instead of using text to reply.

slots[].sample_utterances[]
slots[].slot_constraint

Specifies whether the slot is required or optional.

slots[].slot_type

The type of the slot, either a custom slot type that you defined or one of the built-in slot types.

slots[].slot_type_version

The version of the slot type.

slots[].value_elicitation_prompt

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

Show child fields
slots[].value_elicitation_prompt.max_attempts

The number of times to prompt the user for information.

slots[].value_elicitation_prompt.messages[]
Show child fields
slots[].value_elicitation_prompt.messages[].content

The text of the message.

slots[].value_elicitation_prompt.messages[].content_type

The content type of the message string.

slots[].value_elicitation_prompt.messages[].group_number

Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.

slots[].value_elicitation_prompt.response_card

A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card.