Lex Models V2

This page documents function available when using the Lex_Models_V2 module, created with @service Lex_Models_V2.

Index

Documentation

Main.Lex_Models_V2.batch_create_custom_vocabulary_itemMethod
batch_create_custom_vocabulary_item(bot_id, bot_version, custom_vocabulary_item_list, locale_id)
batch_create_custom_vocabulary_item(bot_id, bot_version, custom_vocabulary_item_list, locale_id, params::Dict{String,<:Any})

Batch create custom vocabulary item for the specified locale in the specified bot.

Arguments

  • bot_id: The unique identifier of the bot to batch create the custom vocabulary item for.
  • bot_version: The bot version of the bot to batch create the custom vocabulary item for.
  • custom_vocabulary_item_list: The custom vocabulary item list of the bot to batch create the custom vocabulary item for.
  • locale_id: The unique locale identifier of the bot to batch create the custom vocabulary item for.
source
Main.Lex_Models_V2.batch_delete_custom_vocabulary_itemMethod
batch_delete_custom_vocabulary_item(bot_id, bot_version, custom_vocabulary_item_list, locale_id)
batch_delete_custom_vocabulary_item(bot_id, bot_version, custom_vocabulary_item_list, locale_id, params::Dict{String,<:Any})

Batch delete custom vocabulary item for the specified locale in the specified bot.

Arguments

  • bot_id: The unique identifier of the bot to batch delete request for the custom vocabulary item.
  • bot_version: The version of the bot to batch delete request for the custom vocabulary item.
  • custom_vocabulary_item_list: The custom vocabulary list to batch delete request for the custom vocabulary item.
  • locale_id: The locale identifier of the bot to batch delete request for the custom vocabulary item.
source
Main.Lex_Models_V2.batch_update_custom_vocabulary_itemMethod
batch_update_custom_vocabulary_item(bot_id, bot_version, custom_vocabulary_item_list, locale_id)
batch_update_custom_vocabulary_item(bot_id, bot_version, custom_vocabulary_item_list, locale_id, params::Dict{String,<:Any})

Batch update custom vocabulary item for the specified locale in the specified bot.

Arguments

  • bot_id: The unique identifier of the bot to the batch update request for the custom vocabulary item.
  • bot_version: The bot version of the bot to the batch update request for the custom vocabulary item.
  • custom_vocabulary_item_list: The custom vocabulary item list of the bot to the batch update request for the custom vocabulary item.
  • locale_id: The locale identifier of the bot to the batch update request for the custom vocabulary item.
source
Main.Lex_Models_V2.build_bot_localeMethod
build_bot_locale(bot_id, bot_version, locale_id)
build_bot_locale(bot_id, bot_version, locale_id, params::Dict{String,<:Any})

Builds a bot, its intents, and its slot types into a specific locale. A bot can be built into multiple locales. At runtime the locale is used to choose a specific build of the bot.

Arguments

  • bot_id: The identifier of the bot to build. The identifier is returned in the response from the CreateBot operation.
  • bot_version: The version of the bot to build. This can only be the draft version of the bot.
  • 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.
source
Main.Lex_Models_V2.create_botMethod
create_bot(bot_name, data_privacy, idle_session_ttlin_seconds, role_arn)
create_bot(bot_name, data_privacy, idle_session_ttlin_seconds, role_arn, params::Dict{String,<:Any})

Creates an Amazon Lex conversational bot.

Arguments

  • bot_name: The name of the bot. The bot name must be unique in the account that creates the bot.
  • data_privacy: Provides information on additional privacy protections Amazon Lex should use with the bot's data.
  • idle_session_ttlin_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.
  • role_arn: The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "botTags": A list of tags to add to the bot. You can only add tags when you create a bot. You can't use the UpdateBot operation to update tags. To update tags, use the TagResource operation.
  • "description": A description of the bot. It appears in lists to help you identify a particular bot.
  • "testBotAliasTags": A list of tags to add to the test alias for a bot. You can only add tags when you create a bot. You can't use the UpdateAlias operation to update tags. To update tags on the test alias, use the TagResource operation.
source
Main.Lex_Models_V2.create_bot_aliasMethod
create_bot_alias(bot_alias_name, bot_id)
create_bot_alias(bot_alias_name, bot_id, params::Dict{String,<:Any})

Creates an alias for the specified version of a bot. Use an alias to enable you to change the version of a bot without updating applications that use the bot. For example, you can create an alias called "PROD" that your applications use to call the Amazon Lex bot.

Arguments

  • bot_alias_name: The alias to create. The name must be unique for the bot.
  • bot_id: The unique identifier of the bot that the alias applies to.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "botAliasLocaleSettings": Maps configuration information to a specific locale. You can use this parameter to specify a specific Lambda function to run different functions in different locales.
  • "botVersion": The version of the bot that this alias points to. You can use the UpdateBotAlias operation to change the bot version associated with the alias.
  • "conversationLogSettings": Specifies whether Amazon Lex logs text and audio for a conversation with the bot. When you enable conversation logs, text logs store text input, transcripts of audio input, and associated metadata in Amazon CloudWatch Logs. Audio logs store audio input in Amazon S3.
  • "description": A description of the alias. Use this description to help identify the alias.
  • "sentimentAnalysisSettings":
  • "tags": A list of tags to add to the bot alias. You can only add tags when you create an alias, you can't use the UpdateBotAlias operation to update the tags on a bot alias. To update tags, use the TagResource operation.
source
Main.Lex_Models_V2.create_bot_localeMethod
create_bot_locale(bot_id, bot_version, locale_id, nlu_intent_confidence_threshold)
create_bot_locale(bot_id, bot_version, locale_id, nlu_intent_confidence_threshold, params::Dict{String,<:Any})

Creates a locale in the bot. The locale contains the intents and slot types that the bot uses in conversations with users in the specified language and locale. You must add a locale to a bot before you can add intents and slot types to the bot.

Arguments

  • bot_id: The identifier of the bot to create the locale for.
  • bot_version: The version of the bot to create the locale for. This can only be the draft version of the bot.
  • 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.
  • 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 RecognizeText operation would be: AMAZON.FallbackIntent IntentA IntentB IntentC

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": A description of the bot locale. Use this to help identify the bot locale in lists.
  • "voiceSettings": The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user.
source
Main.Lex_Models_V2.create_bot_versionMethod
create_bot_version(bot_id, bot_version_locale_specification)
create_bot_version(bot_id, bot_version_locale_specification, params::Dict{String,<:Any})

Creates a new version of the bot based on the DRAFT version. If the DRAFT version of this resource hasn't changed since you created the last version, Amazon Lex doesn't create a new version, it returns the last created version. When you create the first version of a bot, Amazon Lex sets the version to 1. Subsequent versions increment by 1.

Arguments

  • bot_id: The identifier of the bot to create the version for.
  • bot_version_locale_specification: Specifies the locales that Amazon Lex adds to this version. You can choose the Draft version or any other previously published version for each locale. When you specify a source version, the locale data is copied from the source version to the new version.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": A description of the version. Use the description to help identify the version in lists.
source
Main.Lex_Models_V2.create_exportMethod
create_export(file_format, resource_specification)
create_export(file_format, resource_specification, params::Dict{String,<:Any})

Creates a zip archive containing the contents of a bot or a bot locale. The archive contains a directory structure that contains JSON files that define the bot. You can create an archive that contains the complete definition of a bot, or you can specify that the archive contain only the definition of a single bot locale. For more information about exporting bots, and about the structure of the export archive, see Importing and exporting bots

Arguments

  • file_format: The file format of the bot or bot locale definition files.
  • resource_specification: Specifies the type of resource to export, either a bot or a bot locale. You can only specify one type of resource to export.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "filePassword": An password to use to encrypt the exported archive. Using a password is optional, but you should encrypt the archive to protect the data in transit between Amazon Lex and your local computer.
source
Main.Lex_Models_V2.create_intentMethod
create_intent(bot_id, bot_version, intent_name, locale_id)
create_intent(bot_id, bot_version, intent_name, locale_id, params::Dict{String,<:Any})

Creates an intent. To define the interaction between the user and your bot, you define one or more intents. For example, for a pizza ordering bot you would create an OrderPizza intent. When you create an intent, you must provide a name. You can optionally provide the following: Sample utterances. For example, "I want to order a pizza" and "Can I order a pizza." You can't provide utterances for built-in intents. Information to be gathered. You specify slots for the information that you bot requests from the user. You can specify standard slot types, such as date and time, or custom slot types for your application. How the intent is fulfilled. You can provide a Lambda function or configure the intent to return the intent information to your client application. If you use a Lambda function, Amazon Lex invokes the function when all of the intent information is available. A confirmation prompt to send to the user to confirm an intent. For example, "Shall I order your pizza?" A conclusion statement to send to the user after the intent is fulfilled. For example, "I ordered your pizza." A follow-up prompt that asks the user for additional activity. For example, "Do you want a drink with your pizza?"

Arguments

  • bot_id: The identifier of the bot associated with this intent.
  • bot_version: The identifier of the version of the bot associated with this intent.
  • intent_name: The name of the intent. Intent names must be unique in the locale that contains the intent and cannot match the name of any built-in intent.
  • locale_id: The identifier of the language and locale where this intent is used. All of the bots, slot types, and slots used by the intent must have the same locale. For more information, see Supported languages.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": A description of the intent. Use the description to help identify the intent in lists.
  • "dialogCodeHook": Specifies that Amazon Lex invokes the alias Lambda function for each user input. You can invoke this Lambda function to personalize user interaction. For example, suppose that your bot determines that the user's name is John. You Lambda function might retrieve John's information from a backend database and prepopulate some of the values. For example, if you find that John is gluten intolerant, you might set the corresponding intent slot, glutenIntolerant to true. You might find John's phone number and set the corresponding session attribute.
  • "fulfillmentCodeHook": Specifies that Amazon Lex invokes the alias Lambda function when the intent is ready for fulfillment. You can invoke this function to complete the bot's transaction with the user. For example, in a pizza ordering bot, the Lambda function can look up the closest pizza restaurant to the customer's location and then place an order on the customer's behalf.
  • "initialResponseSetting": Configuration settings for the response that is sent to the user at the beginning of a conversation, before eliciting slot values.
  • "inputContexts": A list of contexts that must be active for this intent to be considered by Amazon Lex. When an intent has an input context list, Amazon Lex only considers using the intent in an interaction with the user when the specified contexts are included in the active context list for the session. If the contexts are not active, then Amazon Lex will not use the intent. A context can be automatically activated using the outputContexts property or it can be set at runtime. For example, if there are two intents with different input contexts that respond to the same utterances, only the intent with the active context will respond. An intent may have up to 5 input contexts. If an intent has multiple input contexts, all of the contexts must be active to consider the intent.
  • "intentClosingSetting": Sets the response that Amazon Lex sends to the user when the intent is closed.
  • "intentConfirmationSetting": Provides prompts that Amazon Lex sends to the user to confirm the completion of an intent. If the user answers "no," the settings contain a statement that is sent to the user to end the intent.
  • "kendraConfiguration": Configuration information required to use the AMAZON.KendraSearchIntent intent to connect to an Amazon Kendra index. The AMAZON.KendraSearchIntent intent is called when Amazon Lex can't determine another intent to invoke.
  • "outputContexts": A lists of contexts that the intent activates when it is fulfilled. You can use an output context to indicate the intents that Amazon Lex should consider for the next turn of the conversation with a customer. When you use the outputContextsList property, all of the contexts specified in the list are activated when the intent is fulfilled. You can set up to 10 output contexts. You can also set the number of conversation turns that the context should be active, or the length of time that the context should be active.
  • "parentIntentSignature": A unique identifier for the built-in intent to base this intent on.
  • "sampleUtterances": An array of strings that a user might say to signal the intent. For example, "I want a pizza", or "I want a {PizzaSize} pizza". In an utterance, slot names are enclosed in curly braces ("{", "}") to indicate where they should be displayed in the utterance shown to the user..
source
Main.Lex_Models_V2.create_resource_policyMethod
create_resource_policy(policy, resource_arn)
create_resource_policy(policy, resource_arn, params::Dict{String,<:Any})

Creates a new resource policy with the specified policy statements.

Arguments

  • policy: A resource policy to add to the resource. The policy is a JSON structure that contains one or more statements that define the policy. The policy must follow the IAM syntax. For more information about the contents of a JSON policy document, see IAM JSON policy reference . If the policy isn't valid, Amazon Lex returns a validation exception.
  • resource_arn: The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.
source
Main.Lex_Models_V2.create_resource_policy_statementMethod
create_resource_policy_statement(action, effect, principal, resource_arn, statement_id)
create_resource_policy_statement(action, effect, principal, resource_arn, statement_id, params::Dict{String,<:Any})

Adds a new resource policy statement to a bot or bot alias. If a resource policy exists, the statement is added to the current resource policy. If a policy doesn't exist, a new policy is created. You can't create a resource policy statement that allows cross-account access.

Arguments

  • action: The Amazon Lex action that this policy either allows or denies. The action must apply to the resource type of the specified ARN. For more information, see Actions, resources, and condition keys for Amazon Lex V2.
  • effect: Determines whether the statement allows or denies access to the resource.
  • principal: An IAM principal, such as an IAM users, IAM roles, or AWS services that is allowed or denied access to a resource. For more information, see AWS JSON policy elements: Principal.
  • resource_arn: The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.
  • statement_id: The name of the statement. The ID is the same as the Sid IAM property. The statement name must be unique within the policy. For more information, see IAM JSON policy elements: Sid.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "condition": Specifies a condition when the policy is in effect. If the principal of the policy is a service principal, you must provide two condition blocks, one with a SourceAccount global condition key and one with a SourceArn global condition key. For more information, see IAM JSON policy elements: Condition .
  • "expectedRevisionId": The identifier of the revision of the policy to edit. If this revision ID doesn't match the current revision ID, Amazon Lex throws an exception. If you don't specify a revision, Amazon Lex overwrites the contents of the policy with the new values.
source
Main.Lex_Models_V2.create_slotMethod
create_slot(bot_id, bot_version, intent_id, locale_id, slot_name, value_elicitation_setting)
create_slot(bot_id, bot_version, intent_id, locale_id, slot_name, value_elicitation_setting, params::Dict{String,<:Any})

Creates a slot in an intent. A slot is a variable needed to fulfill an intent. For example, an OrderPizza intent might need slots for size, crust, and number of pizzas. For each slot, you define one or more utterances that Amazon Lex uses to elicit a response from the user.

Arguments

  • bot_id: The identifier of the bot associated with the slot.
  • bot_version: The version of the bot associated with the slot.
  • intent_id: The identifier of the intent that contains the slot.
  • locale_id: The identifier of the language and locale that the slot will be used in. The string must match one of the supported locales. All of the bots, intents, slot types used by the slot must have the same locale. For more information, see Supported languages.
  • slot_name: The name of the slot. Slot names must be unique within the bot that contains the slot.
  • value_elicitation_setting: Specifies prompts that Amazon Lex sends to the user to elicit a response that provides the value for the slot.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": A description of the slot. Use this to help identify the slot in lists.
  • "multipleValuesSetting": Indicates whether the slot returns multiple values in one response. 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 multipleValuesSetting is not set, the default value is false.
  • "obfuscationSetting": Determines how slot values are used in Amazon CloudWatch logs. If the value of the obfuscationSetting parameter is DefaultObfuscation, slot values are obfuscated in the log output. If the value is None, the actual value is present in the log output. The default is to obfuscate values in the CloudWatch logs.
  • "slotTypeId": The unique identifier for the slot type associated with this slot. The slot type determines the values that can be entered into the slot.
  • "subSlotSetting": Specifications for the constituent sub slots and the expression for the composite slot.
source
Main.Lex_Models_V2.create_slot_typeMethod
create_slot_type(bot_id, bot_version, locale_id, slot_type_name)
create_slot_type(bot_id, bot_version, locale_id, slot_type_name, params::Dict{String,<:Any})

Creates a custom slot type To create a custom slot type, specify a name for the slot type and a set of enumeration values, the values that a slot of this type can assume.

Arguments

  • bot_id: The identifier of the bot associated with this slot type.
  • bot_version: The identifier of the bot version associated with this slot type.
  • locale_id: The identifier of the language and locale that the slot type will be used in. The string must match one of the supported locales. All of the bots, intents, and slots used by the slot type must have the same locale. For more information, see Supported languages.
  • slot_type_name: The name for the slot. A slot type name must be unique within the account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "compositeSlotTypeSetting": Specifications for a composite slot type.
  • "description": A description of the slot type. Use the description to help identify the slot type in lists.
  • "externalSourceSetting": Sets the type of external information used to create the slot type.
  • "parentSlotTypeSignature": The built-in slot type used as a parent of this slot type. When you define a parent slot type, the new slot type has the configuration of the parent slot type. Only AMAZON.AlphaNumeric is supported.
  • "slotTypeValues": A list of SlotTypeValue objects that defines the values that the slot type can take. Each value can have a list of synonyms, additional values that help train the machine learning model about the values that it resolves for a slot.
  • "valueSelectionSetting": Determines the strategy that Amazon Lex uses to select a value from the list of possible values. The field can be set to one of the following values: OriginalValue - Returns the value entered by the user, if the user value is similar to the slot value. TopResolution - If there is a resolution list for the slot, return the first value in the resolution list. If there is no resolution list, return null. If you don't specify the valueSelectionSetting parameter, the default is OriginalValue.
source
Main.Lex_Models_V2.create_upload_urlMethod
create_upload_url()
create_upload_url(params::Dict{String,<:Any})

Gets a pre-signed S3 write URL that you use to upload the zip archive when importing a bot or a bot locale.

source
Main.Lex_Models_V2.delete_botMethod
delete_bot(bot_id)
delete_bot(bot_id, params::Dict{String,<:Any})

Deletes all versions of a bot, including the Draft version. To delete a specific version, use the DeleteBotVersion operation. When you delete a bot, all of the resources contained in the bot are also deleted. Deleting a bot removes all locales, intents, slot, and slot types defined for the bot. If a bot has an alias, the DeleteBot operation returns a ResourceInUseException exception. If you want to delete the bot and the alias, set the skipResourceInUseCheck parameter to true.

Arguments

  • bot_id: The identifier of the bot to delete.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "skipResourceInUseCheck": When true, Amazon Lex doesn't check to see if another resource, such as an alias, is using the bot before it is deleted.
source
Main.Lex_Models_V2.delete_bot_aliasMethod
delete_bot_alias(bot_alias_id, bot_id)
delete_bot_alias(bot_alias_id, bot_id, params::Dict{String,<:Any})

Deletes the specified bot alias.

Arguments

  • bot_alias_id: The unique identifier of the bot alias to delete.
  • bot_id: The unique identifier of the bot associated with the alias to delete.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "skipResourceInUseCheck": When this parameter is true, Amazon Lex doesn't check to see if any other resource is using the alias before it is deleted.
source
Main.Lex_Models_V2.delete_bot_localeMethod
delete_bot_locale(bot_id, bot_version, locale_id)
delete_bot_locale(bot_id, bot_version, locale_id, params::Dict{String,<:Any})

Removes a locale from a bot. When you delete a locale, all intents, slots, and slot types defined for the locale are also deleted.

Arguments

  • bot_id: The unique identifier of the bot that contains the locale.
  • bot_version: The version of the bot that contains the locale.
  • locale_id: The identifier of the language and locale that will be deleted. The string must match one of the supported locales. For more information, see Supported languages.
source
Main.Lex_Models_V2.delete_bot_versionMethod
delete_bot_version(bot_id, bot_version)
delete_bot_version(bot_id, bot_version, params::Dict{String,<:Any})

Deletes a specific version of a bot. To delete all version of a bot, use the DeleteBot operation.

Arguments

  • bot_id: The identifier of the bot that contains the version.
  • bot_version: The version of the bot to delete.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "skipResourceInUseCheck": By default, the DeleteBotVersion operations throws a ResourceInUseException exception if you try to delete a bot version that has an alias pointing at it. Set the skipResourceInUseCheck parameter to true to skip this check and remove the version even if an alias points to it.
source
Main.Lex_Models_V2.delete_custom_vocabularyMethod
delete_custom_vocabulary(bot_id, bot_version, locale_id)
delete_custom_vocabulary(bot_id, bot_version, locale_id, params::Dict{String,<:Any})

Removes a custom vocabulary from the specified locale in the specified bot.

Arguments

  • bot_id: The unique identifier of the bot to remove the custom vocabulary from.
  • bot_version: The version of the bot to remove the custom vocabulary from.
  • locale_id: The locale identifier for the locale that contains the custom vocabulary to remove.
source
Main.Lex_Models_V2.delete_exportMethod
delete_export(export_id)
delete_export(export_id, params::Dict{String,<:Any})

Removes a previous export and the associated files stored in an S3 bucket.

Arguments

  • export_id: The unique identifier of the export to delete.
source
Main.Lex_Models_V2.delete_importMethod
delete_import(import_id)
delete_import(import_id, params::Dict{String,<:Any})

Removes a previous import and the associated file stored in an S3 bucket.

Arguments

  • import_id: The unique identifier of the import to delete.
source
Main.Lex_Models_V2.delete_intentMethod
delete_intent(bot_id, bot_version, intent_id, locale_id)
delete_intent(bot_id, bot_version, intent_id, locale_id, params::Dict{String,<:Any})

Removes the specified intent. Deleting an intent also deletes the slots associated with the intent.

Arguments

  • bot_id: The identifier of the bot associated with the intent.
  • bot_version: The version of the bot associated with the intent.
  • intent_id: The unique identifier of the intent to delete.
  • locale_id: The identifier of the language and locale where the bot will be deleted. The string must match one of the supported locales. For more information, see Supported languages.
source
Main.Lex_Models_V2.delete_resource_policyMethod
delete_resource_policy(resource_arn)
delete_resource_policy(resource_arn, params::Dict{String,<:Any})

Removes an existing policy from a bot or bot alias. If the resource doesn't have a policy attached, Amazon Lex returns an exception.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the bot or bot alias that has the resource policy attached.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "expectedRevisionId": The identifier of the revision to edit. If this ID doesn't match the current revision number, Amazon Lex returns an exception If you don't specify a revision ID, Amazon Lex will delete the current policy.
source
Main.Lex_Models_V2.delete_resource_policy_statementMethod
delete_resource_policy_statement(resource_arn, statement_id)
delete_resource_policy_statement(resource_arn, statement_id, params::Dict{String,<:Any})

Deletes a policy statement from a resource policy. If you delete the last statement from a policy, the policy is deleted. If you specify a statement ID that doesn't exist in the policy, or if the bot or bot alias doesn't have a policy attached, Amazon Lex returns an exception.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.
  • statement_id: The name of the statement (SID) to delete from the policy.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "expectedRevisionId": The identifier of the revision of the policy to delete the statement from. If this revision ID doesn't match the current revision ID, Amazon Lex throws an exception. If you don't specify a revision, Amazon Lex removes the current contents of the statement.
source
Main.Lex_Models_V2.delete_slotMethod
delete_slot(bot_id, bot_version, intent_id, locale_id, slot_id)
delete_slot(bot_id, bot_version, intent_id, locale_id, slot_id, params::Dict{String,<:Any})

Deletes the specified slot from an intent.

Arguments

  • bot_id: The identifier of the bot associated with the slot to delete.
  • bot_version: The version of the bot associated with the slot to delete.
  • intent_id: The identifier of the intent associated with the slot.
  • locale_id: The identifier of the language and locale that the slot will be deleted from. The string must match one of the supported locales. For more information, see Supported languages.
  • slot_id: The identifier of the slot to delete.
source
Main.Lex_Models_V2.delete_slot_typeMethod
delete_slot_type(bot_id, bot_version, locale_id, slot_type_id)
delete_slot_type(bot_id, bot_version, locale_id, slot_type_id, params::Dict{String,<:Any})

Deletes a slot type from a bot locale. If a slot is using the slot type, Amazon Lex throws a ResourceInUseException exception. To avoid the exception, set the skipResourceInUseCheck parameter to true.

Arguments

  • bot_id: The identifier of the bot associated with the slot type.
  • bot_version: The version of the bot associated with the slot type.
  • locale_id: The identifier of the language and locale that the slot type will be deleted from. The string must match one of the supported locales. For more information, see Supported languages.
  • slot_type_id: The identifier of the slot type to delete.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "skipResourceInUseCheck": By default, the DeleteSlotType operations throws a ResourceInUseException exception if you try to delete a slot type used by a slot. Set the skipResourceInUseCheck parameter to true to skip this check and remove the slot type even if a slot uses it.
source
Main.Lex_Models_V2.delete_utterancesMethod
delete_utterances(bot_id)
delete_utterances(bot_id, params::Dict{String,<:Any})

Deletes stored utterances. Amazon Lex stores the utterances that users send to your bot. Utterances are stored for 15 days for use with the ListAggregatedUtterances operation, and then stored indefinitely for use in improving the ability of your bot to respond to user input.. Use the DeleteUtterances operation to manually delete utterances for a specific session. When you use the DeleteUtterances operation, utterances stored for improving your bot's ability to respond to user input are deleted immediately. Utterances stored for use with the ListAggregatedUtterances operation are deleted after 15 days.

Arguments

  • bot_id: The unique identifier of the bot that contains the utterances.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "localeId": The identifier of the language and locale where the utterances were collected. The string must match one of the supported locales. For more information, see Supported languages.
  • "sessionId": The unique identifier of the session with the user. The ID is returned in the response from the RecognizeText and RecognizeUtterance operations.
source
Main.Lex_Models_V2.describe_botMethod
describe_bot(bot_id)
describe_bot(bot_id, params::Dict{String,<:Any})

Provides metadata information about a bot.

Arguments

  • bot_id: The unique identifier of the bot to describe.
source
Main.Lex_Models_V2.describe_bot_aliasMethod
describe_bot_alias(bot_alias_id, bot_id)
describe_bot_alias(bot_alias_id, bot_id, params::Dict{String,<:Any})

Get information about a specific bot alias.

Arguments

  • bot_alias_id: The identifier of the bot alias to describe.
  • bot_id: The identifier of the bot associated with the bot alias to describe.
source
Main.Lex_Models_V2.describe_bot_localeMethod
describe_bot_locale(bot_id, bot_version, locale_id)
describe_bot_locale(bot_id, bot_version, locale_id, params::Dict{String,<:Any})

Describes the settings that a bot has for a specific locale.

Arguments

  • bot_id: The identifier of the bot associated with the locale.
  • bot_version: The identifier of the version of the bot associated with the locale.
  • locale_id: The unique identifier of the locale to describe. The string must match one of the supported locales. For more information, see Supported languages.
source
Main.Lex_Models_V2.describe_bot_recommendationMethod
describe_bot_recommendation(bot_id, bot_recommendation_id, bot_version, locale_id)
describe_bot_recommendation(bot_id, bot_recommendation_id, bot_version, locale_id, params::Dict{String,<:Any})

Provides metadata information about a bot recommendation. This information will enable you to get a description on the request inputs, to download associated transcripts after processing is complete, and to download intents and slot-types generated by the bot recommendation.

Arguments

  • bot_id: The unique identifier of the bot associated with the bot recommendation.
  • bot_recommendation_id: The identifier of the bot recommendation to describe.
  • bot_version: The version of the bot associated with the bot recommendation.
  • locale_id: The identifier of the language and locale of the bot recommendation to describe. The string must match one of the supported locales. For more information, see Supported languages.
source
Main.Lex_Models_V2.describe_bot_versionMethod
describe_bot_version(bot_id, bot_version)
describe_bot_version(bot_id, bot_version, params::Dict{String,<:Any})

Provides metadata about a version of a bot.

Arguments

  • bot_id: The identifier of the bot containing the version to return metadata for.
  • bot_version: The version of the bot to return metadata for.
source
Main.Lex_Models_V2.describe_custom_vocabulary_metadataMethod
describe_custom_vocabulary_metadata(bot_id, bot_version, locale_id)
describe_custom_vocabulary_metadata(bot_id, bot_version, locale_id, params::Dict{String,<:Any})

Provides metadata information about a custom vocabulary.

Arguments

  • bot_id: The unique identifier of the bot that contains the custom vocabulary.
  • bot_version: The bot version of the bot to return metadata for.
  • locale_id: The locale to return the custom vocabulary information for. The locale must be en_GB.
source
Main.Lex_Models_V2.describe_exportMethod
describe_export(export_id)
describe_export(export_id, params::Dict{String,<:Any})

Gets information about a specific export.

Arguments

  • export_id: The unique identifier of the export to describe.
source
Main.Lex_Models_V2.describe_importMethod
describe_import(import_id)
describe_import(import_id, params::Dict{String,<:Any})

Gets information about a specific import.

Arguments

  • import_id: The unique identifier of the import to describe.
source
Main.Lex_Models_V2.describe_intentMethod
describe_intent(bot_id, bot_version, intent_id, locale_id)
describe_intent(bot_id, bot_version, intent_id, locale_id, params::Dict{String,<:Any})

Returns metadata about an intent.

Arguments

  • bot_id: The identifier of the bot associated with the intent.
  • bot_version: The version of the bot associated with the intent.
  • intent_id: The identifier of the intent to describe.
  • locale_id: The identifier of the language and locale of the intent to describe. The string must match one of the supported locales. For more information, see Supported languages.
source
Main.Lex_Models_V2.describe_resource_policyMethod
describe_resource_policy(resource_arn)
describe_resource_policy(resource_arn, params::Dict{String,<:Any})

Gets the resource policy and policy revision for a bot or bot alias.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.
source
Main.Lex_Models_V2.describe_slotMethod
describe_slot(bot_id, bot_version, intent_id, locale_id, slot_id)
describe_slot(bot_id, bot_version, intent_id, locale_id, slot_id, params::Dict{String,<:Any})

Gets metadata information about a slot.

Arguments

  • bot_id: The identifier of the bot associated with the slot.
  • bot_version: The version of the bot associated with the slot.
  • intent_id: The identifier of the intent that contains the slot.
  • locale_id: The identifier of the language and locale of the slot to describe. The string must match one of the supported locales. For more information, see Supported languages.
  • slot_id: The unique identifier for the slot.
source
Main.Lex_Models_V2.describe_slot_typeMethod
describe_slot_type(bot_id, bot_version, locale_id, slot_type_id)
describe_slot_type(bot_id, bot_version, locale_id, slot_type_id, params::Dict{String,<:Any})

Gets metadata information about a slot type.

Arguments

  • bot_id: The identifier of the bot associated with the slot type.
  • bot_version: The version of the bot associated with the slot type.
  • locale_id: The identifier of the language and locale of the slot type to describe. The string must match one of the supported locales. For more information, see Supported languages.
  • slot_type_id: The identifier of the slot type.
source
Main.Lex_Models_V2.list_aggregated_utterancesMethod
list_aggregated_utterances(aggregation_duration, bot_id, locale_id)
list_aggregated_utterances(aggregation_duration, bot_id, locale_id, params::Dict{String,<:Any})

Provides a list of utterances that users have sent to the bot. Utterances are aggregated by the text of the utterance. For example, all instances where customers used the phrase "I want to order pizza" are aggregated into the same line in the response. You can see both detected utterances and missed utterances. A detected utterance is where the bot properly recognized the utterance and activated the associated intent. A missed utterance was not recognized by the bot and didn't activate an intent. Utterances can be aggregated for a bot alias or for a bot version, but not both at the same time. Utterances statistics are not generated under the following conditions: The childDirected field was set to true when the bot was created. You are using slot obfuscation with one or more slots. You opted out of participating in improving Amazon Lex.

Arguments

  • aggregation_duration: The time window for aggregating the utterance information. You can specify a time between one hour and two weeks.
  • bot_id: The unique identifier of the bot associated with this request.
  • locale_id: The identifier of the language and locale where the utterances were collected. For more information, see Supported languages.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "botAliasId": The identifier of the bot alias associated with this request. If you specify the bot alias, you can't specify the bot version.
  • "botVersion": The identifier of the bot version associated with this request. If you specify the bot version, you can't specify the bot alias.
  • "filters": Provides the specification of a filter used to limit the utterances in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.
  • "maxResults": The maximum number of utterances to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned. If you don't specify the maxResults parameter, 1,000 results are returned.
  • "nextToken": If the response from the ListAggregatedUtterances operation contains more results that specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.
  • "sortBy": Specifies sorting parameters for the list of utterances. You can sort by the hit count, the missed count, or the number of distinct sessions the utterance appeared in.
source
Main.Lex_Models_V2.list_bot_aliasesMethod
list_bot_aliases(bot_id)
list_bot_aliases(bot_id, params::Dict{String,<:Any})

Gets a list of aliases for the specified bot.

Arguments

  • bot_id: The identifier of the bot to list aliases for.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of aliases 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.
  • "nextToken": If the response from the ListBotAliases operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.
source
Main.Lex_Models_V2.list_bot_localesMethod
list_bot_locales(bot_id, bot_version)
list_bot_locales(bot_id, bot_version, params::Dict{String,<:Any})

Gets a list of locales for the specified bot.

Arguments

  • bot_id: The identifier of the bot to list locales for.
  • bot_version: The version of the bot to list locales for.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "filters": Provides the specification for a filter used to limit the response to only those locales that match the filter specification. You can only specify one filter and one value to filter on.
  • "maxResults": The maximum number of aliases 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.
  • "nextToken": If the response from the ListBotLocales operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token as the nextToken parameter to return the next page of results.
  • "sortBy": Specifies sorting parameters for the list of locales. You can sort by locale name in ascending or descending order.
source
Main.Lex_Models_V2.list_bot_recommendationsMethod
list_bot_recommendations(bot_id, bot_version, locale_id)
list_bot_recommendations(bot_id, bot_version, locale_id, params::Dict{String,<:Any})

Get a list of bot recommendations that meet the specified criteria.

Arguments

  • bot_id: The unique identifier of the bot that contains the bot recommendation list.
  • bot_version: The version of the bot that contains the bot recommendation list.
  • locale_id: The identifier of the language and locale of the bot recommendation list.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of bot recommendations 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.
  • "nextToken": If the response from the ListBotRecommendation operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.
source
Main.Lex_Models_V2.list_bot_versionsMethod
list_bot_versions(bot_id)
list_bot_versions(bot_id, params::Dict{String,<:Any})

Gets information about all of the versions of a bot. The ListBotVersions operation returns a summary of each version of a bot. For example, if a bot has three numbered versions, the ListBotVersions operation returns for summaries, one for each numbered version and one for the DRAFT version. The ListBotVersions operation always returns at least one version, the DRAFT version.

Arguments

  • bot_id: The identifier of the bot to list versions for.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of versions 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.
  • "nextToken": If the response to the ListBotVersion operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.
  • "sortBy": Specifies sorting parameters for the list of versions. You can specify that the list be sorted by version name in either ascending or descending order.
source
Main.Lex_Models_V2.list_botsMethod
list_bots()
list_bots(params::Dict{String,<:Any})

Gets a list of available bots.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "filters": Provides the specification of a filter used to limit the bots in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.
  • "maxResults": The maximum number of bots to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.
  • "nextToken": If the response from the ListBots operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use the returned token in the nextToken parameter of a ListBots request to return the next page of results. For a complete set of results, call the ListBots operation until the nextToken returned in the response is null.
  • "sortBy": Specifies sorting parameters for the list of bots. You can specify that the list be sorted by bot name in ascending or descending order.
source
Main.Lex_Models_V2.list_built_in_intentsMethod
list_built_in_intents(locale_id)
list_built_in_intents(locale_id, params::Dict{String,<:Any})

Gets a list of built-in intents provided by Amazon Lex that you can use in your bot. To use a built-in intent as a the base for your own intent, include the built-in intent signature in the parentIntentSignature parameter when you call the CreateIntent operation. For more information, see CreateIntent.

Arguments

  • locale_id: The identifier of the language and locale of the intents to list. The string must match one of the supported locales. For more information, see Supported languages.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of built-in intents 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.
  • "nextToken": If the response from the ListBuiltInIntents operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.
  • "sortBy": Specifies sorting parameters for the list of built-in intents. You can specify that the list be sorted by the built-in intent signature in either ascending or descending order.
source
Main.Lex_Models_V2.list_built_in_slot_typesMethod
list_built_in_slot_types(locale_id)
list_built_in_slot_types(locale_id, params::Dict{String,<:Any})

Gets a list of built-in slot types that meet the specified criteria.

Arguments

  • locale_id: The identifier of the language and locale of the slot types to list. The string must match one of the supported locales. For more information, see Supported languages.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of built-in slot types 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.
  • "nextToken": If the response from the ListBuiltInSlotTypes operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.
  • "sortBy": Determines the sort order for the response from the ListBuiltInSlotTypes operation. You can choose to sort by the slot type signature in either ascending or descending order.
source
Main.Lex_Models_V2.list_custom_vocabulary_itemsMethod
list_custom_vocabulary_items(bot_id, bot_version, locale_id)
list_custom_vocabulary_items(bot_id, bot_version, locale_id, params::Dict{String,<:Any})

List custom vocabulary items for the specified locale in the specified bot.

Arguments

  • bot_id: The unique identifier of the bot to the list custom vocabulary request.
  • bot_version: The bot version of the bot to the list custom vocabulary request.
  • locale_id: The locale identifier of the bot to the list custom vocabulary request.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum results to the list custom vocabulary request.
  • "nextToken": The nextToken identifier to the list custom vocabulary request.
source
Main.Lex_Models_V2.list_exportsMethod
list_exports()
list_exports(params::Dict{String,<:Any})

Lists the exports for a bot, bot locale, or custom vocabulary. Exports are kept in the list for 7 days.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "botId": The unique identifier that Amazon Lex assigned to the bot.
  • "botVersion": The version of the bot to list exports for.
  • "filters": Provides the specification of a filter used to limit the exports in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.
  • "localeId": Specifies the resources that should be exported. If you don't specify a resource type in the filters parameter, both bot locales and custom vocabularies are exported.
  • "maxResults": The maximum number of exports 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.
  • "nextToken": If the response from the ListExports operation contains more results that specified in the maxResults parameter, a token is returned in the response. Use the returned token in the nextToken parameter of a ListExports request to return the next page of results. For a complete set of results, call the ListExports operation until the nextToken returned in the response is null.
  • "sortBy": Determines the field that the list of exports is sorted by. You can sort by the LastUpdatedDateTime field in ascending or descending order.
source
Main.Lex_Models_V2.list_importsMethod
list_imports()
list_imports(params::Dict{String,<:Any})

Lists the imports for a bot, bot locale, or custom vocabulary. Imports are kept in the list for 7 days.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "botId": The unique identifier that Amazon Lex assigned to the bot.
  • "botVersion": The version of the bot to list imports for.
  • "filters": Provides the specification of a filter used to limit the bots in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.
  • "localeId": Specifies the locale that should be present in the list. If you don't specify a resource type in the filters parameter, the list contains both bot locales and custom vocabularies.
  • "maxResults": The maximum number of imports 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.
  • "nextToken": If the response from the ListImports operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use the returned token in the nextToken parameter of a ListImports request to return the next page of results. For a complete set of results, call the ListImports operation until the nextToken returned in the response is null.
  • "sortBy": Determines the field that the list of imports is sorted by. You can sort by the LastUpdatedDateTime field in ascending or descending order.
source
Main.Lex_Models_V2.list_intentsMethod
list_intents(bot_id, bot_version, locale_id)
list_intents(bot_id, bot_version, locale_id, params::Dict{String,<:Any})

Get a list of intents that meet the specified criteria.

Arguments

  • bot_id: The unique identifier of the bot that contains the intent.
  • bot_version: The version of the bot that contains the intent.
  • locale_id: The identifier of the language and locale of the intents to list. The string must match one of the supported locales. For more information, see Supported languages.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "filters": Provides the specification of a filter used to limit the intents in the response to only those that match the filter specification. You can only specify one filter and only one string to filter on.
  • "maxResults": The maximum number of intents 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.
  • "nextToken": If the response from the ListIntents operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use the returned token in the nextToken parameter of a ListIntents request to return the next page of results. For a complete set of results, call the ListIntents operation until the nextToken returned in the response is null.
  • "sortBy": Determines the sort order for the response from the ListIntents operation. You can choose to sort by the intent name or last updated date in either ascending or descending order.
source
Main.Lex_Models_V2.list_recommended_intentsMethod
list_recommended_intents(bot_id, bot_recommendation_id, bot_version, locale_id)
list_recommended_intents(bot_id, bot_recommendation_id, bot_version, locale_id, params::Dict{String,<:Any})

Gets a list of recommended intents provided by the bot recommendation that you can use in your bot. Intents in the response are ordered by relevance.

Arguments

  • bot_id: The unique identifier of the bot associated with the recommended intents.
  • bot_recommendation_id: The identifier of the bot recommendation that contains the recommended intents.
  • bot_version: The version of the bot that contains the recommended intents.
  • locale_id: The identifier of the language and locale of the recommended intents.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of bot recommendations 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.
  • "nextToken": If the response from the ListRecommendedIntents operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.
source
Main.Lex_Models_V2.list_slot_typesMethod
list_slot_types(bot_id, bot_version, locale_id)
list_slot_types(bot_id, bot_version, locale_id, params::Dict{String,<:Any})

Gets a list of slot types that match the specified criteria.

Arguments

  • bot_id: The unique identifier of the bot that contains the slot types.
  • bot_version: The version of the bot that contains the slot type.
  • locale_id: The identifier of the language and locale of the slot types to list. The string must match one of the supported locales. For more information, see Supported languages.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "filters": Provides the specification of a filter used to limit the slot types in the response to only those that match the filter specification. You can only specify one filter and only one string to filter on.
  • "maxResults": The maximum number of slot types 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.
  • "nextToken": If the response from the ListSlotTypes operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.
  • "sortBy": Determines the sort order for the response from the ListSlotTypes operation. You can choose to sort by the slot type name or last updated date in either ascending or descending order.
source
Main.Lex_Models_V2.list_slotsMethod
list_slots(bot_id, bot_version, intent_id, locale_id)
list_slots(bot_id, bot_version, intent_id, locale_id, params::Dict{String,<:Any})

Gets a list of slots that match the specified criteria.

Arguments

  • bot_id: The identifier of the bot that contains the slot.
  • bot_version: The version of the bot that contains the slot.
  • intent_id: The unique identifier of the intent that contains the slot.
  • locale_id: The identifier of the language and locale of the slots to list. The string must match one of the supported locales. For more information, see Supported languages.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "filters": 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.
  • "maxResults": 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.
  • "nextToken": If the response from the ListSlots operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.
  • "sortBy": 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.
source
Main.Lex_Models_V2.list_tags_for_resourceMethod
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

Gets a list of tags associated with a resource. Only bots, bot aliases, and bot channels can have tags associated with them.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the resource to get a list of tags for.
source
Main.Lex_Models_V2.search_associated_transcriptsMethod
search_associated_transcripts(bot_id, bot_recommendation_id, bot_version, filters, locale_id)
search_associated_transcripts(bot_id, bot_recommendation_id, bot_version, filters, locale_id, params::Dict{String,<:Any})

Search for associated transcripts that meet the specified criteria.

Arguments

  • bot_id: The unique identifier of the bot associated with the transcripts that you are searching.
  • bot_recommendation_id: The unique identifier of the bot recommendation associated with the transcripts to search.
  • bot_version: The version of the bot containing the transcripts that you are searching.
  • filters: A list of filter objects.
  • locale_id: The identifier of the language and locale of the transcripts to search. The string must match one of the supported locales. For more information, see Supported languages

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of bot recommendations 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.
  • "nextIndex": If the response from the SearchAssociatedTranscriptsRequest operation contains more results than specified in the maxResults parameter, an index is returned in the response. Use that index in the nextIndex parameter to return the next page of results.
  • "searchOrder": How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.
source
Main.Lex_Models_V2.start_bot_recommendationMethod
start_bot_recommendation(bot_id, bot_version, locale_id, transcript_source_setting)
start_bot_recommendation(bot_id, bot_version, locale_id, transcript_source_setting, params::Dict{String,<:Any})

Use this to provide your transcript data, and to start the bot recommendation process.

Arguments

  • bot_id: The unique identifier of the bot containing the bot recommendation.
  • bot_version: The version of the bot containing the bot recommendation.
  • locale_id: The identifier of the language and locale of the bot recommendation to start. The string must match one of the supported locales. For more information, see Supported languages
  • transcript_source_setting: The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "encryptionSetting": The object representing the passwords that will be used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.
source
Main.Lex_Models_V2.start_importMethod
start_import(import_id, merge_strategy, resource_specification)
start_import(import_id, merge_strategy, resource_specification, params::Dict{String,<:Any})

Starts importing a bot, bot locale, or custom vocabulary from a zip archive that you uploaded to an S3 bucket.

Arguments

  • import_id: The unique identifier for the import. It is included in the response from the CreateUploadUrl operation.
  • merge_strategy: The strategy to use when there is 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.
  • resource_specification: Parameters for creating the bot, bot locale or custom vocabulary.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "filePassword": The password used to encrypt the zip archive that contains the resource definition. You should always encrypt the zip archive to protect it during transit between your site and Amazon Lex.
source
Main.Lex_Models_V2.stop_bot_recommendationMethod
stop_bot_recommendation(bot_id, bot_recommendation_id, bot_version, locale_id)
stop_bot_recommendation(bot_id, bot_recommendation_id, bot_version, locale_id, params::Dict{String,<:Any})

Stop an already running Bot Recommendation request.

Arguments

  • bot_id: The unique identifier of the bot containing the bot recommendation to be stopped.
  • bot_recommendation_id: The unique identifier of the bot recommendation to be stopped.
  • bot_version: The version of the bot containing the bot recommendation.
  • locale_id: The identifier of the language and locale of the bot recommendation to stop. The string must match one of the supported locales. For more information, see Supported languages
source
Main.Lex_Models_V2.tag_resourceMethod
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

Adds the specified tags to the specified resource. If a tag key already exists, the existing value is replaced with the new value.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the bot, bot alias, or bot channel to tag.
  • tags: A list of tag keys to add to the resource. If a tag key already exists, the existing value is replaced with the new value.
source
Main.Lex_Models_V2.untag_resourceMethod
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

Removes tags from a bot, bot alias, or bot channel.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the resource to remove the tags from.
  • tag_keys: A list of tag keys to remove from the resource. If a tag key does not exist on the resource, it is ignored.
source
Main.Lex_Models_V2.update_botMethod
update_bot(bot_id, bot_name, data_privacy, idle_session_ttlin_seconds, role_arn)
update_bot(bot_id, bot_name, data_privacy, idle_session_ttlin_seconds, role_arn, params::Dict{String,<:Any})

Updates the configuration of an existing bot.

Arguments

  • bot_id: The unique identifier of the bot to update. This identifier is returned by the CreateBot operation.
  • bot_name: The new name of the bot. The name must be unique in the account that creates the bot.
  • data_privacy: Provides information on additional privacy protections Amazon Lex should use with the bot's data.
  • idle_session_ttlin_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.
  • role_arn: The Amazon Resource Name (ARN) of an IAM role that has permissions to access the bot.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": A description of the bot.
source
Main.Lex_Models_V2.update_bot_aliasMethod
update_bot_alias(bot_alias_id, bot_alias_name, bot_id)
update_bot_alias(bot_alias_id, bot_alias_name, bot_id, params::Dict{String,<:Any})

Updates the configuration of an existing bot alias.

Arguments

  • bot_alias_id: The unique identifier of the bot alias.
  • bot_alias_name: The new name to assign to the bot alias.
  • bot_id: The identifier of the bot with the updated alias.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "botAliasLocaleSettings": The new Lambda functions to use in each locale for the bot alias.
  • "botVersion": The new bot version to assign to the bot alias.
  • "conversationLogSettings": The new settings for storing conversation logs in Amazon CloudWatch Logs and Amazon S3 buckets.
  • "description": The new description to assign to the bot alias.
  • "sentimentAnalysisSettings":
source
Main.Lex_Models_V2.update_bot_localeMethod
update_bot_locale(bot_id, bot_version, locale_id, nlu_intent_confidence_threshold)
update_bot_locale(bot_id, bot_version, locale_id, nlu_intent_confidence_threshold, params::Dict{String,<:Any})

Updates the settings that a bot has for a specific locale.

Arguments

  • bot_id: The unique identifier of the bot that contains the locale.
  • bot_version: The version of the bot that contains the locale to be updated. The version can only be the DRAFT version.
  • locale_id: The identifier of the language and locale to update. The string must match one of the supported locales. For more information, see Supported languages.
  • nlu_intent_confidence_threshold: The new confidence threshold where Amazon Lex inserts the AMAZON.FallbackIntent and AMAZON.KendraSearchIntent intents in the list of possible intents for an utterance.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": The new description of the locale.
  • "voiceSettings": The new Amazon Polly voice Amazon Lex should use for voice interaction with the user.
source
Main.Lex_Models_V2.update_bot_recommendationMethod
update_bot_recommendation(bot_id, bot_recommendation_id, bot_version, encryption_setting, locale_id)
update_bot_recommendation(bot_id, bot_recommendation_id, bot_version, encryption_setting, locale_id, params::Dict{String,<:Any})

Updates an existing bot recommendation request.

Arguments

  • bot_id: The unique identifier of the bot containing the bot recommendation to be updated.
  • bot_recommendation_id: The unique identifier of the bot recommendation to be updated.
  • bot_version: The version of the bot containing the bot recommendation to be updated.
  • encryption_setting: The object representing the passwords that will be used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.
  • locale_id: The identifier of the language and locale of the bot recommendation to update. The string must match one of the supported locales. For more information, see Supported languages
source
Main.Lex_Models_V2.update_exportMethod
update_export(export_id)
update_export(export_id, params::Dict{String,<:Any})

Updates the password used to protect an export zip archive. The password is not required. If you don't supply a password, Amazon Lex generates a zip file that is not protected by a password. This is the archive that is available at the pre-signed S3 URL provided by the DescribeExport operation.

Arguments

  • export_id: The unique identifier Amazon Lex assigned to the export.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "filePassword": The new password to use to encrypt the export zip archive.
source
Main.Lex_Models_V2.update_intentMethod
update_intent(bot_id, bot_version, intent_id, intent_name, locale_id)
update_intent(bot_id, bot_version, intent_id, intent_name, locale_id, params::Dict{String,<:Any})

Updates the settings for an intent.

Arguments

  • bot_id: The identifier of the bot that contains the intent.
  • bot_version: The version of the bot that contains the intent. Must be DRAFT.
  • intent_id: The unique identifier of the intent to update.
  • intent_name: The new name for the intent.
  • locale_id: The identifier of the language and locale where this intent is used. The string must match one of the supported locales. For more information, see Supported languages.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": The new description of the intent.
  • "dialogCodeHook": The new Lambda function to use between each turn of the conversation with the bot.
  • "fulfillmentCodeHook": The new Lambda function to call when all of the intents required slots are provided and the intent is ready for fulfillment.
  • "initialResponseSetting":
  • "inputContexts": A new list of contexts that must be active in order for Amazon Lex to consider the intent.
  • "intentClosingSetting": The new response that Amazon Lex sends the user when the intent is closed.
  • "intentConfirmationSetting": New prompts that Amazon Lex sends to the user to confirm the completion of an intent.
  • "kendraConfiguration": New configuration settings for connecting to an Amazon Kendra index.
  • "outputContexts": A new list of contexts that Amazon Lex activates when the intent is fulfilled.
  • "parentIntentSignature": The signature of the new built-in intent to use as the parent of this intent.
  • "sampleUtterances": New utterances used to invoke the intent.
  • "slotPriorities": A new list of slots and their priorities that are contained by the intent.
source
Main.Lex_Models_V2.update_resource_policyMethod
update_resource_policy(policy, resource_arn)
update_resource_policy(policy, resource_arn, params::Dict{String,<:Any})

Replaces the existing resource policy for a bot or bot alias with a new one. If the policy doesn't exist, Amazon Lex returns an exception.

Arguments

  • policy: A resource policy to add to the resource. The policy is a JSON structure that contains one or more statements that define the policy. The policy must follow the IAM syntax. For more information about the contents of a JSON policy document, see IAM JSON policy reference . If the policy isn't valid, Amazon Lex returns a validation exception.
  • resource_arn: The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "expectedRevisionId": The identifier of the revision of the policy to update. If this revision ID doesn't match the current revision ID, Amazon Lex throws an exception. If you don't specify a revision, Amazon Lex overwrites the contents of the policy with the new values.
source
Main.Lex_Models_V2.update_slotMethod
update_slot(bot_id, bot_version, intent_id, locale_id, slot_id, slot_name, value_elicitation_setting)
update_slot(bot_id, bot_version, intent_id, locale_id, slot_id, slot_name, value_elicitation_setting, params::Dict{String,<:Any})

Updates the settings for a slot.

Arguments

  • bot_id: The unique identifier of the bot that contains the slot.
  • bot_version: The version of the bot that contains the slot. Must always be DRAFT.
  • intent_id: The identifier of the intent that contains the slot.
  • locale_id: The identifier of the language and locale that contains the slot. The string must match one of the supported locales. For more information, see Supported languages.
  • slot_id: The unique identifier for the slot to update.
  • slot_name: The new name for the slot.
  • value_elicitation_setting: A new set of prompts that Amazon Lex sends to the user to elicit a response the provides a value for the slot.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": The new description for the slot.
  • "multipleValuesSetting": Determines whether the slot accepts multiple values in one response. Multiple 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 multipleValuesSetting is not set, the default value is false.
  • "obfuscationSetting": New settings that determine how slot values are formatted in Amazon CloudWatch logs.
  • "slotTypeId": The unique identifier of the new slot type to associate with this slot.
  • "subSlotSetting": Specifications for the constituent sub slots and the expression for the composite slot.
source
Main.Lex_Models_V2.update_slot_typeMethod
update_slot_type(bot_id, bot_version, locale_id, slot_type_id, slot_type_name)
update_slot_type(bot_id, bot_version, locale_id, slot_type_id, slot_type_name, params::Dict{String,<:Any})

Updates the configuration of an existing slot type.

Arguments

  • bot_id: The identifier of the bot that contains the slot type.
  • bot_version: The version of the bot that contains the slot type. Must be DRAFT.
  • locale_id: The identifier of the language and locale that contains the slot type. The string must match one of the supported locales. For more information, see Supported languages.
  • slot_type_id: The unique identifier of the slot type to update.
  • slot_type_name: The new name of the slot type.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "compositeSlotTypeSetting": Specifications for a composite slot type.
  • "description": The new description of the slot type.
  • "externalSourceSetting":
  • "parentSlotTypeSignature": The new built-in slot type that should be used as the parent of this slot type.
  • "slotTypeValues": A new list of values and their optional synonyms that define the values that the slot type can take.
  • "valueSelectionSetting": The strategy that Amazon Lex should use when deciding on a value from the list of slot type values.
source