Skip to content
AWS for Query.Farm

aws.lexv2_models.describe_import

Example SQL Queries

SELECT * FROM
aws.lexv2_models.describe_import
WHERE
"import_id" = 'VALUE';

Description

Gets information about a specific import.

Table Definition

Column NameColumn Data Type
import_id Required Input Column

The unique identifier of the described import.

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

The date and time that the import was created.

TIMESTAMP_S
failure_reasons

If the importStatus field is Failed, this provides one or more reasons for the failure.

VARCHAR[]
Show child fields
failure_reasons[]
import_status

The status of the import process. When the status is Completed the resource is imported and ready for use.

VARCHAR
imported_resource_id

The unique identifier that Amazon Lex assigned to the resource created by the import.

VARCHAR
imported_resource_name

The name of the imported resource.

VARCHAR
last_updated_date_time

The date and time that the import was last updated.

TIMESTAMP_S
merge_strategy

The strategy used when there was a name conflict between the imported resource and an existing resource. When the merge strategy is FailOnConflict existing resources are not overwritten and the import fails.

VARCHAR
resource_specification

The specifications of the imported bot, bot locale, or custom vocabulary.

STRUCT(
    "bot_import_specification" STRUCT(
        "bot_name" VARCHAR,
        "role_arn" VARCHAR,
        "data_privacy" STRUCT(
            "child_directed" BOOLEAN
        ),
        "idle_session_ttl_in_seconds" BIGINT,
        "bot_tags" MAP(VARCHAR, VARCHAR),
        "test_bot_alias_tags" MAP(VARCHAR, VARCHAR)
    ),
    "bot_locale_import_specification" STRUCT(
        "bot_id" VARCHAR,
        "bot_version" VARCHAR,
        "locale_id" VARCHAR,
        "nlu_intent_confidence_threshold" DOUBLE,
        "voice_settings" STRUCT(
            "voice_id" VARCHAR,
            "engine" VARCHAR
        )
    ),
    "custom_vocabulary_import_specification" STRUCT(
        "bot_id" VARCHAR,
        "bot_version" VARCHAR,
        "locale_id" VARCHAR
    ),
    "test_set_import_resource_specification" STRUCT(
        "test_set_name" VARCHAR,
        "description" VARCHAR,
        "role_arn" VARCHAR,
        "storage_location" STRUCT(
            "s3_bucket_name" VARCHAR,
            "s3_path" VARCHAR,
            "kms_key_arn" VARCHAR
        ),
        "import_input_location" STRUCT(
            "s3_bucket_name" VARCHAR,
            "s3_path" VARCHAR
        ),
        "modality" VARCHAR,
        "test_set_tags" MAP(VARCHAR, VARCHAR)
    )
)
Show child fields
resource_specification.bot_import_specification

Parameters for importing a bot.

Show child fields
resource_specification.bot_import_specification.bot_name

The name that Amazon Lex should use for the bot.

resource_specification.bot_import_specification.bot_tags

A list of tags to add to the bot. You can only add tags when you import a bot. You can't use the UpdateBot operation to update tags. To update tags, use the TagResource operation.

resource_specification.bot_import_specification.data_privacy

By default, data stored by Amazon Lex is encrypted. The DataPrivacy structure provides settings that determine how Amazon Lex handles special cases of securing the data for your bot.

Show child fields
resource_specification.bot_import_specification.data_privacy.child_directed

For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.

resource_specification.bot_import_specification.idle_session_ttl_in_seconds

The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.

A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.

You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.

resource_specification.bot_import_specification.role_arn

The Amazon Resource Name (ARN) of the IAM role used to build and run the bot.

resource_specification.bot_import_specification.test_bot_alias_tags

A list of tags to add to the test alias for a bot. You can only add tags when you import a bot. You can't use the UpdateAlias operation to update tags. To update tags on the test alias, use the TagResource operation.

resource_specification.bot_locale_import_specification

Parameters for importing a bot locale.

Show child fields
resource_specification.bot_locale_import_specification.bot_id

The identifier of the bot to import the locale to.

resource_specification.bot_locale_import_specification.bot_version

The version of the bot to import the locale to. This can only be the DRAFT version of the bot.

resource_specification.bot_locale_import_specification.locale_id

The identifier of the language and locale that the bot will be used in. The string must match one of the supported locales. All of the intents, slot types, and slots used in the bot must have the same locale. For more information, see Supported languages.

resource_specification.bot_locale_import_specification.nlu_intent_confidence_threshold

Determines the threshold where Amazon Lex will insert the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents. AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they are configured for the bot.

For example, suppose a bot is configured with the confidence threshold of 0.80 and the AMAZON.FallbackIntent. Amazon Lex returns three alternative intents with the following confidence scores: IntentA (0.70), IntentB (0.60), IntentC (0.50). The response from the PostText operation would be:

  • AMAZON.FallbackIntent

  • IntentA

  • IntentB

  • IntentC

resource_specification.bot_locale_import_specification.voice_settings

Defines settings for using an Amazon Polly voice to communicate with a user.

Show child fields
resource_specification.bot_locale_import_specification.voice_settings.engine

Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the engine parameter of the SynthesizeSpeech operation in the Amazon Polly developer guide.

If you do not specify a value, the default is standard.

resource_specification.bot_locale_import_specification.voice_settings.voice_id

The identifier of the Amazon Polly voice to use.

resource_specification.custom_vocabulary_import_specification

Provides the parameters required for importing a custom vocabulary.

Show child fields
resource_specification.custom_vocabulary_import_specification.bot_id

The identifier of the bot to import the custom vocabulary to.

resource_specification.custom_vocabulary_import_specification.bot_version

The version of the bot to import the custom vocabulary to.

resource_specification.custom_vocabulary_import_specification.locale_id

The identifier of the local to import the custom vocabulary to. The value must be en_GB.

resource_specification.test_set_import_resource_specification

Specifications for the test set that is imported.

Show child fields
resource_specification.test_set_import_resource_specification.description

The description of the test set.

resource_specification.test_set_import_resource_specification.import_input_location

Contains information about the input location from where test-set should be imported.

Show child fields
resource_specification.test_set_import_resource_specification.import_input_location.s3_bucket_name

The name of the Amazon S3 bucket.

resource_specification.test_set_import_resource_specification.import_input_location.s3_path

The path inside the Amazon S3 bucket pointing to the test-set CSV file.

resource_specification.test_set_import_resource_specification.modality

Specifies whether the test-set being imported contains written or spoken data.

resource_specification.test_set_import_resource_specification.role_arn

The Amazon Resource Name (ARN) of an IAM role that has permission to access the test set.

resource_specification.test_set_import_resource_specification.storage_location

Contains information about the location that Amazon Lex uses to store the test-set.

Show child fields
resource_specification.test_set_import_resource_specification.storage_location.kms_key_arn

The Amazon Resource Name (ARN) of an Amazon Web Services Key Management Service (KMS) key for encrypting the test set.

resource_specification.test_set_import_resource_specification.storage_location.s3_bucket_name

The name of the Amazon S3 bucket in which the test set is stored.

resource_specification.test_set_import_resource_specification.storage_location.s3_path

The path inside the Amazon S3 bucket where the test set is stored.

resource_specification.test_set_import_resource_specification.test_set_name

The name of the test set.

resource_specification.test_set_import_resource_specification.test_set_tags

A list of tags to add to the test set. You can only add tags when you import/generate a new test set. You can't use the UpdateTestSet operation to update tags. To update tags, use the TagResource operation.