Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.LexV2Models.Lens

Contents

Operations
Types

Description

Synopsis

Operations

BatchCreateCustomVocabularyItem

batchCreateCustomVocabularyItem_botId :: Lens' BatchCreateCustomVocabularyItem Text Source #

The unique identifier of the bot to batch create the custom vocabulary item for.

batchCreateCustomVocabularyItem_botVersion :: Lens' BatchCreateCustomVocabularyItem Text Source #

The bot version of the bot to batch create the custom vocabulary item for.

batchCreateCustomVocabularyItem_localeId :: Lens' BatchCreateCustomVocabularyItem Text Source #

The unique locale identifier of the bot to batch create the custom vocabulary item for.

batchCreateCustomVocabularyItem_customVocabularyItemList :: Lens' BatchCreateCustomVocabularyItem (NonEmpty NewCustomVocabularyItem) Source #

The custom vocabulary item list of the bot to batch create the custom vocabulary item for.

batchCreateCustomVocabularyItemResponse_botId :: Lens' BatchCreateCustomVocabularyItemResponse (Maybe Text) Source #

The unique identifier of the bot to batch create response for the custom vocabulary item.

batchCreateCustomVocabularyItemResponse_botVersion :: Lens' BatchCreateCustomVocabularyItemResponse (Maybe Text) Source #

The bot version of the bot to batch create the custom vocabulary item response for.

batchCreateCustomVocabularyItemResponse_errors :: Lens' BatchCreateCustomVocabularyItemResponse (Maybe [FailedCustomVocabularyItem]) Source #

The errors of the action to batch create the custom vocabulary item response for a bot.

batchCreateCustomVocabularyItemResponse_localeId :: Lens' BatchCreateCustomVocabularyItemResponse (Maybe Text) Source #

The unique locale identifier of the bot to batch create the custom vocabulary item response for.

batchCreateCustomVocabularyItemResponse_resources :: Lens' BatchCreateCustomVocabularyItemResponse (Maybe [CustomVocabularyItem]) Source #

The resources of the action to batch create the custom vocabulary item response for a bot.

batchCreateCustomVocabularyItemResponse_httpStatus :: Lens' BatchCreateCustomVocabularyItemResponse Int Source #

The response's http status code.

BatchDeleteCustomVocabularyItem

batchDeleteCustomVocabularyItem_botId :: Lens' BatchDeleteCustomVocabularyItem Text Source #

The unique identifier of the bot to batch delete request for the custom vocabulary item.

batchDeleteCustomVocabularyItem_botVersion :: Lens' BatchDeleteCustomVocabularyItem Text Source #

The version of the bot to batch delete request for the custom vocabulary item.

batchDeleteCustomVocabularyItem_localeId :: Lens' BatchDeleteCustomVocabularyItem Text Source #

The locale identifier of the bot to batch delete request for the custom vocabulary item.

batchDeleteCustomVocabularyItem_customVocabularyItemList :: Lens' BatchDeleteCustomVocabularyItem (NonEmpty CustomVocabularyEntryId) Source #

The custom vocabulary list to batch delete request for the custom vocabulary item.

batchDeleteCustomVocabularyItemResponse_botId :: Lens' BatchDeleteCustomVocabularyItemResponse (Maybe Text) Source #

The unique identifier of the bot to batch delete response for the custom vocabulary item.

batchDeleteCustomVocabularyItemResponse_botVersion :: Lens' BatchDeleteCustomVocabularyItemResponse (Maybe Text) Source #

The version of the bot to batch delete response for the custom vocabulary item.

batchDeleteCustomVocabularyItemResponse_errors :: Lens' BatchDeleteCustomVocabularyItemResponse (Maybe [FailedCustomVocabularyItem]) Source #

The errors of the action to batch delete response for the custom vocabulary item.

batchDeleteCustomVocabularyItemResponse_localeId :: Lens' BatchDeleteCustomVocabularyItemResponse (Maybe Text) Source #

The locale identifier of the bot to batch delete response for the custom vocabulary item.

batchDeleteCustomVocabularyItemResponse_resources :: Lens' BatchDeleteCustomVocabularyItemResponse (Maybe [CustomVocabularyItem]) Source #

The resources of the action to batch delete response for the custom vocabulary item.

batchDeleteCustomVocabularyItemResponse_httpStatus :: Lens' BatchDeleteCustomVocabularyItemResponse Int Source #

The response's http status code.

BatchUpdateCustomVocabularyItem

batchUpdateCustomVocabularyItem_botId :: Lens' BatchUpdateCustomVocabularyItem Text Source #

The unique identifier of the bot to the batch update request for the custom vocabulary item.

batchUpdateCustomVocabularyItem_botVersion :: Lens' BatchUpdateCustomVocabularyItem Text Source #

The bot version of the bot to the batch update request for the custom vocabulary item.

batchUpdateCustomVocabularyItem_localeId :: Lens' BatchUpdateCustomVocabularyItem Text Source #

The locale identifier of the bot to the batch update request for the custom vocabulary item.

batchUpdateCustomVocabularyItem_customVocabularyItemList :: Lens' BatchUpdateCustomVocabularyItem (NonEmpty CustomVocabularyItem) Source #

The custom vocabulary item list of the bot to the batch update request for the custom vocabulary item.

batchUpdateCustomVocabularyItemResponse_botId :: Lens' BatchUpdateCustomVocabularyItemResponse (Maybe Text) Source #

The unique identifier of the bot to the batch update response for the custom vocabulary item.

batchUpdateCustomVocabularyItemResponse_botVersion :: Lens' BatchUpdateCustomVocabularyItemResponse (Maybe Text) Source #

The bot version of the bot to the batch update response for the custom vocabulary item.

batchUpdateCustomVocabularyItemResponse_errors :: Lens' BatchUpdateCustomVocabularyItemResponse (Maybe [FailedCustomVocabularyItem]) Source #

The errors of the action to batch update response for the custom vocabulary item.

batchUpdateCustomVocabularyItemResponse_localeId :: Lens' BatchUpdateCustomVocabularyItemResponse (Maybe Text) Source #

The locale identifier of the bot to the batch update response for the custom vocabulary item.

batchUpdateCustomVocabularyItemResponse_resources :: Lens' BatchUpdateCustomVocabularyItemResponse (Maybe [CustomVocabularyItem]) Source #

The resources of the action to batch update response for the custom vocabulary item.

batchUpdateCustomVocabularyItemResponse_httpStatus :: Lens' BatchUpdateCustomVocabularyItemResponse Int Source #

The response's http status code.

BuildBotLocale

buildBotLocale_botId :: Lens' BuildBotLocale Text Source #

The identifier of the bot to build. The identifier is returned in the response from the CreateBot operation.

buildBotLocale_botVersion :: Lens' BuildBotLocale Text Source #

The version of the bot to build. This can only be the draft version of the bot.

buildBotLocale_localeId :: Lens' BuildBotLocale Text Source #

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.

buildBotLocaleResponse_botId :: Lens' BuildBotLocaleResponse (Maybe Text) Source #

The identifier of the specified bot.

buildBotLocaleResponse_botLocaleStatus :: Lens' BuildBotLocaleResponse (Maybe BotLocaleStatus) Source #

The bot's build status. When the status is ReadyExpressTesting you can test the bot using the utterances defined for the intents and slot types. When the status is Built, the bot is ready for use and can be tested using any utterance.

buildBotLocaleResponse_botVersion :: Lens' BuildBotLocaleResponse (Maybe Text) Source #

The version of the bot that was built. This is only the draft version of the bot.

buildBotLocaleResponse_lastBuildSubmittedDateTime :: Lens' BuildBotLocaleResponse (Maybe UTCTime) Source #

A timestamp indicating the date and time that the bot was last built for this locale.

buildBotLocaleResponse_localeId :: Lens' BuildBotLocaleResponse (Maybe Text) Source #

The language and locale specified of where the bot can be used.

buildBotLocaleResponse_httpStatus :: Lens' BuildBotLocaleResponse Int Source #

The response's http status code.

CreateBot

createBot_botTags :: Lens' CreateBot (Maybe (HashMap Text Text)) Source #

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.

createBot_description :: Lens' CreateBot (Maybe Text) Source #

A description of the bot. It appears in lists to help you identify a particular bot.

createBot_testBotAliasTags :: Lens' CreateBot (Maybe (HashMap Text Text)) Source #

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.

createBot_botName :: Lens' CreateBot Text Source #

The name of the bot. The bot name must be unique in the account that creates the bot.

createBot_roleArn :: Lens' CreateBot Text Source #

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

createBot_dataPrivacy :: Lens' CreateBot DataPrivacy Source #

Provides information on additional privacy protections Amazon Lex should use with the bot's data.

createBot_idleSessionTTLInSeconds :: Lens' CreateBot Natural Source #

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.

createBotResponse_botId :: Lens' CreateBotResponse (Maybe Text) Source #

A unique identifier for a particular bot. You use this to identify the bot when you call other Amazon Lex API operations.

createBotResponse_botName :: Lens' CreateBotResponse (Maybe Text) Source #

The name specified for the bot.

createBotResponse_botStatus :: Lens' CreateBotResponse (Maybe BotStatus) Source #

Shows the current status of the bot. The bot is first in the Creating status. Once the bot is read for use, it changes to the Available status. After the bot is created, you can use the Draft version of the bot.

createBotResponse_botTags :: Lens' CreateBotResponse (Maybe (HashMap Text Text)) Source #

A list of tags associated with the bot.

createBotResponse_creationDateTime :: Lens' CreateBotResponse (Maybe UTCTime) Source #

A timestamp indicating the date and time that the bot was created.

createBotResponse_dataPrivacy :: Lens' CreateBotResponse (Maybe DataPrivacy) Source #

The data privacy settings specified for the bot.

createBotResponse_description :: Lens' CreateBotResponse (Maybe Text) Source #

The description specified for the bot.

createBotResponse_idleSessionTTLInSeconds :: Lens' CreateBotResponse (Maybe Natural) Source #

The session idle time specified for the bot.

createBotResponse_roleArn :: Lens' CreateBotResponse (Maybe Text) Source #

The IAM role specified for the bot.

createBotResponse_testBotAliasTags :: Lens' CreateBotResponse (Maybe (HashMap Text Text)) Source #

A list of tags associated with the test alias for the bot.

createBotResponse_httpStatus :: Lens' CreateBotResponse Int Source #

The response's http status code.

CreateBotAlias

createBotAlias_botAliasLocaleSettings :: Lens' CreateBotAlias (Maybe (HashMap Text BotAliasLocaleSettings)) Source #

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.

createBotAlias_botVersion :: Lens' CreateBotAlias (Maybe Text) Source #

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.

createBotAlias_conversationLogSettings :: Lens' CreateBotAlias (Maybe ConversationLogSettings) Source #

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.

createBotAlias_description :: Lens' CreateBotAlias (Maybe Text) Source #

A description of the alias. Use this description to help identify the alias.

createBotAlias_sentimentAnalysisSettings :: Lens' CreateBotAlias (Maybe SentimentAnalysisSettings) Source #

Undocumented member.

createBotAlias_tags :: Lens' CreateBotAlias (Maybe (HashMap Text Text)) Source #

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.

createBotAlias_botAliasName :: Lens' CreateBotAlias Text Source #

The alias to create. The name must be unique for the bot.

createBotAlias_botId :: Lens' CreateBotAlias Text Source #

The unique identifier of the bot that the alias applies to.

createBotAliasResponse_botAliasId :: Lens' CreateBotAliasResponse (Maybe Text) Source #

The unique identifier of the bot alias.

createBotAliasResponse_botAliasLocaleSettings :: Lens' CreateBotAliasResponse (Maybe (HashMap Text BotAliasLocaleSettings)) Source #

Configuration information for a specific locale.

createBotAliasResponse_botAliasName :: Lens' CreateBotAliasResponse (Maybe Text) Source #

The name specified for the bot alias.

createBotAliasResponse_botAliasStatus :: Lens' CreateBotAliasResponse (Maybe BotAliasStatus) Source #

The current status of the alias. The alias is first put into the Creating state. When the alias is ready to be used, it is put into the Available state. You can use the DescribeBotAlias operation to get the current state of an alias.

createBotAliasResponse_botId :: Lens' CreateBotAliasResponse (Maybe Text) Source #

The unique identifier of the bot that this alias applies to.

createBotAliasResponse_botVersion :: Lens' CreateBotAliasResponse (Maybe Text) Source #

The version of the bot associated with this alias.

createBotAliasResponse_conversationLogSettings :: Lens' CreateBotAliasResponse (Maybe ConversationLogSettings) Source #

The conversation log settings specified for the alias.

createBotAliasResponse_creationDateTime :: Lens' CreateBotAliasResponse (Maybe UTCTime) Source #

A Unix timestamp indicating the date and time that the bot alias was created.

createBotAliasResponse_description :: Lens' CreateBotAliasResponse (Maybe Text) Source #

The description specified for the bot alias.

createBotAliasResponse_sentimentAnalysisSettings :: Lens' CreateBotAliasResponse (Maybe SentimentAnalysisSettings) Source #

Undocumented member.

createBotAliasResponse_tags :: Lens' CreateBotAliasResponse (Maybe (HashMap Text Text)) Source #

A list of tags associated with the bot alias.

createBotAliasResponse_httpStatus :: Lens' CreateBotAliasResponse Int Source #

The response's http status code.

CreateBotLocale

createBotLocale_description :: Lens' CreateBotLocale (Maybe Text) Source #

A description of the bot locale. Use this to help identify the bot locale in lists.

createBotLocale_voiceSettings :: Lens' CreateBotLocale (Maybe VoiceSettings) Source #

The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user.

createBotLocale_botId :: Lens' CreateBotLocale Text Source #

The identifier of the bot to create the locale for.

createBotLocale_botVersion :: Lens' CreateBotLocale Text Source #

The version of the bot to create the locale for. This can only be the draft version of the bot.

createBotLocale_localeId :: Lens' CreateBotLocale Text Source #

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.

createBotLocale_nluIntentConfidenceThreshold :: Lens' CreateBotLocale Double Source #

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

createBotLocaleResponse_botId :: Lens' CreateBotLocaleResponse (Maybe Text) Source #

The specified bot identifier.

createBotLocaleResponse_botLocaleStatus :: Lens' CreateBotLocaleResponse (Maybe BotLocaleStatus) Source #

The status of the bot.

When the status is Creating the bot locale is being configured. When the status is Building Amazon Lex is building the bot for testing and use.

If the status of the bot is ReadyExpressTesting, you can test the bot using the exact utterances specified in the bots' intents. When the bot is ready for full testing or to run, the status is Built.

If there was a problem with building the bot, the status is Failed. If the bot was saved but not built, the status is NotBuilt.

createBotLocaleResponse_botVersion :: Lens' CreateBotLocaleResponse (Maybe Text) Source #

The specified bot version.

createBotLocaleResponse_creationDateTime :: Lens' CreateBotLocaleResponse (Maybe UTCTime) Source #

A timestamp specifying the date and time that the bot locale was created.

createBotLocaleResponse_description :: Lens' CreateBotLocaleResponse (Maybe Text) Source #

The specified description of the bot locale.

createBotLocaleResponse_localeId :: Lens' CreateBotLocaleResponse (Maybe Text) Source #

The specified locale identifier.

createBotLocaleResponse_localeName :: Lens' CreateBotLocaleResponse (Maybe Text) Source #

The specified locale name.

createBotLocaleResponse_nluIntentConfidenceThreshold :: Lens' CreateBotLocaleResponse (Maybe Double) Source #

The specified confidence threshold for inserting the AMAZON.FallbackIntent and AMAZON.KendraSearchIntent intents.

createBotLocaleResponse_voiceSettings :: Lens' CreateBotLocaleResponse (Maybe VoiceSettings) Source #

The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user.

createBotLocaleResponse_httpStatus :: Lens' CreateBotLocaleResponse Int Source #

The response's http status code.

CreateBotVersion

createBotVersion_description :: Lens' CreateBotVersion (Maybe Text) Source #

A description of the version. Use the description to help identify the version in lists.

createBotVersion_botId :: Lens' CreateBotVersion Text Source #

The identifier of the bot to create the version for.

createBotVersion_botVersionLocaleSpecification :: Lens' CreateBotVersion (HashMap Text BotVersionLocaleDetails) Source #

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.

createBotVersionResponse_botId :: Lens' CreateBotVersionResponse (Maybe Text) Source #

The bot identifier specified in the request.

createBotVersionResponse_botStatus :: Lens' CreateBotVersionResponse (Maybe BotStatus) Source #

When you send a request to create or update a bot, Amazon Lex sets the status response element to Creating. After Amazon Lex builds the bot, it sets status to Available. If Amazon Lex can't build the bot, it sets status to Failed.

createBotVersionResponse_botVersion :: Lens' CreateBotVersionResponse (Maybe Text) Source #

The version number assigned to the version.

createBotVersionResponse_botVersionLocaleSpecification :: Lens' CreateBotVersionResponse (Maybe (HashMap Text BotVersionLocaleDetails)) Source #

The source versions used for each locale in the new version.

createBotVersionResponse_creationDateTime :: Lens' CreateBotVersionResponse (Maybe UTCTime) Source #

A timestamp of the date and time that the version was created.

createBotVersionResponse_description :: Lens' CreateBotVersionResponse (Maybe Text) Source #

The description of the version specified in the request.

createBotVersionResponse_httpStatus :: Lens' CreateBotVersionResponse Int Source #

The response's http status code.

CreateExport

createExport_filePassword :: Lens' CreateExport (Maybe Text) Source #

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.

createExport_resourceSpecification :: Lens' CreateExport ExportResourceSpecification Source #

Specifies the type of resource to export, either a bot or a bot locale. You can only specify one type of resource to export.

createExport_fileFormat :: Lens' CreateExport ImportExportFileFormat Source #

The file format of the bot or bot locale definition files.

createExportResponse_creationDateTime :: Lens' CreateExportResponse (Maybe UTCTime) Source #

The date and time that the request to export a bot was created.

createExportResponse_exportId :: Lens' CreateExportResponse (Maybe Text) Source #

An identifier for a specific request to create an export.

createExportResponse_exportStatus :: Lens' CreateExportResponse (Maybe ExportStatus) Source #

The status of the export. When the status is Completed, you can use the DescribeExport operation to get the pre-signed S3 URL link to your exported bot or bot locale.

createExportResponse_fileFormat :: Lens' CreateExportResponse (Maybe ImportExportFileFormat) Source #

The file format used for the bot or bot locale definition files.

createExportResponse_resourceSpecification :: Lens' CreateExportResponse (Maybe ExportResourceSpecification) Source #

A description of the type of resource that was exported, either a bot or a bot locale.

createExportResponse_httpStatus :: Lens' CreateExportResponse Int Source #

The response's http status code.

CreateIntent

createIntent_description :: Lens' CreateIntent (Maybe Text) Source #

A description of the intent. Use the description to help identify the intent in lists.

createIntent_dialogCodeHook :: Lens' CreateIntent (Maybe DialogCodeHookSettings) Source #

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.

createIntent_fulfillmentCodeHook :: Lens' CreateIntent (Maybe FulfillmentCodeHookSettings) Source #

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.

createIntent_initialResponseSetting :: Lens' CreateIntent (Maybe InitialResponseSetting) Source #

Configuration settings for the response that is sent to the user at the beginning of a conversation, before eliciting slot values.

createIntent_inputContexts :: Lens' CreateIntent (Maybe [InputContext]) Source #

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.

createIntent_intentClosingSetting :: Lens' CreateIntent (Maybe IntentClosingSetting) Source #

Sets the response that Amazon Lex sends to the user when the intent is closed.

createIntent_intentConfirmationSetting :: Lens' CreateIntent (Maybe IntentConfirmationSetting) Source #

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.

createIntent_kendraConfiguration :: Lens' CreateIntent (Maybe KendraConfiguration) Source #

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.

createIntent_outputContexts :: Lens' CreateIntent (Maybe [OutputContext]) Source #

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.

createIntent_parentIntentSignature :: Lens' CreateIntent (Maybe Text) Source #

A unique identifier for the built-in intent to base this intent on.

createIntent_sampleUtterances :: Lens' CreateIntent (Maybe [SampleUtterance]) Source #

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

createIntent_intentName :: Lens' CreateIntent Text Source #

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.

createIntent_botId :: Lens' CreateIntent Text Source #

The identifier of the bot associated with this intent.

createIntent_botVersion :: Lens' CreateIntent Text Source #

The identifier of the version of the bot associated with this intent.

createIntent_localeId :: Lens' CreateIntent Text Source #

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.

createIntentResponse_botId :: Lens' CreateIntentResponse (Maybe Text) Source #

The identifier of the bot associated with the intent.

createIntentResponse_botVersion :: Lens' CreateIntentResponse (Maybe Text) Source #

The identifier of the version of the bot associated with the intent.

createIntentResponse_creationDateTime :: Lens' CreateIntentResponse (Maybe UTCTime) Source #

A timestamp of the date and time that the intent was created.

createIntentResponse_description :: Lens' CreateIntentResponse (Maybe Text) Source #

The description specified for the intent.

createIntentResponse_dialogCodeHook :: Lens' CreateIntentResponse (Maybe DialogCodeHookSettings) Source #

The dialog Lambda function specified for the intent.

createIntentResponse_fulfillmentCodeHook :: Lens' CreateIntentResponse (Maybe FulfillmentCodeHookSettings) Source #

The fulfillment Lambda function specified for the intent.

createIntentResponse_initialResponseSetting :: Lens' CreateIntentResponse (Maybe InitialResponseSetting) Source #

Configuration settings for the response that is sent to the user at the beginning of a conversation, before eliciting slot values.

createIntentResponse_inputContexts :: Lens' CreateIntentResponse (Maybe [InputContext]) Source #

The list of input contexts specified for the intent.

createIntentResponse_intentClosingSetting :: Lens' CreateIntentResponse (Maybe IntentClosingSetting) Source #

The closing setting specified for the intent.

createIntentResponse_intentConfirmationSetting :: Lens' CreateIntentResponse (Maybe IntentConfirmationSetting) Source #

The confirmation setting specified for the intent.

createIntentResponse_intentId :: Lens' CreateIntentResponse (Maybe Text) Source #

A unique identifier for the intent.

createIntentResponse_intentName :: Lens' CreateIntentResponse (Maybe Text) Source #

The name specified for the intent.

createIntentResponse_kendraConfiguration :: Lens' CreateIntentResponse (Maybe KendraConfiguration) Source #

Configuration for searching a Amazon Kendra index specified for the intent.

createIntentResponse_localeId :: Lens' CreateIntentResponse (Maybe Text) Source #

The locale that the intent is specified to use.

createIntentResponse_outputContexts :: Lens' CreateIntentResponse (Maybe [OutputContext]) Source #

The list of output contexts specified for the intent.

createIntentResponse_parentIntentSignature :: Lens' CreateIntentResponse (Maybe Text) Source #

The signature of the parent intent specified for the intent.

createIntentResponse_sampleUtterances :: Lens' CreateIntentResponse (Maybe [SampleUtterance]) Source #

The sample utterances specified for the intent.

createIntentResponse_httpStatus :: Lens' CreateIntentResponse Int Source #

The response's http status code.

CreateResourcePolicy

createResourcePolicy_resourceArn :: Lens' CreateResourcePolicy Text Source #

The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.

createResourcePolicy_policy :: Lens' CreateResourcePolicy Text Source #

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.

createResourcePolicyResponse_resourceArn :: Lens' CreateResourcePolicyResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy was attached to.

createResourcePolicyResponse_revisionId :: Lens' CreateResourcePolicyResponse (Maybe Text) Source #

The current revision of the resource policy. Use the revision ID to make sure that you are updating the most current version of a resource policy when you add a policy statement to a resource, delete a resource, or update a resource.

createResourcePolicyResponse_httpStatus :: Lens' CreateResourcePolicyResponse Int Source #

The response's http status code.

CreateResourcePolicyStatement

createResourcePolicyStatement_condition :: Lens' CreateResourcePolicyStatement (Maybe (HashMap Text (HashMap Text Text))) Source #

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 .

createResourcePolicyStatement_expectedRevisionId :: Lens' CreateResourcePolicyStatement (Maybe Text) Source #

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.

createResourcePolicyStatement_resourceArn :: Lens' CreateResourcePolicyStatement Text Source #

The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.

createResourcePolicyStatement_statementId :: Lens' CreateResourcePolicyStatement Text Source #

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.

createResourcePolicyStatement_effect :: Lens' CreateResourcePolicyStatement Effect Source #

Determines whether the statement allows or denies access to the resource.

createResourcePolicyStatement_principal :: Lens' CreateResourcePolicyStatement [Principal] Source #

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.

createResourcePolicyStatement_action :: Lens' CreateResourcePolicyStatement [Text] Source #

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.

createResourcePolicyStatementResponse_resourceArn :: Lens' CreateResourcePolicyStatementResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.

createResourcePolicyStatementResponse_revisionId :: Lens' CreateResourcePolicyStatementResponse (Maybe Text) Source #

The current revision of the resource policy. Use the revision ID to make sure that you are updating the most current version of a resource policy when you add a policy statement to a resource, delete a resource, or update a resource.

createResourcePolicyStatementResponse_httpStatus :: Lens' CreateResourcePolicyStatementResponse Int Source #

The response's http status code.

CreateSlot

createSlot_description :: Lens' CreateSlot (Maybe Text) Source #

A description of the slot. Use this to help identify the slot in lists.

createSlot_multipleValuesSetting :: Lens' CreateSlot (Maybe MultipleValuesSetting) Source #

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.

createSlot_obfuscationSetting :: Lens' CreateSlot (Maybe ObfuscationSetting) Source #

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.

createSlot_slotTypeId :: Lens' CreateSlot (Maybe Text) Source #

The unique identifier for the slot type associated with this slot. The slot type determines the values that can be entered into the slot.

createSlot_subSlotSetting :: Lens' CreateSlot (Maybe SubSlotSetting) Source #

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

createSlot_slotName :: Lens' CreateSlot Text Source #

The name of the slot. Slot names must be unique within the bot that contains the slot.

createSlot_valueElicitationSetting :: Lens' CreateSlot SlotValueElicitationSetting Source #

Specifies prompts that Amazon Lex sends to the user to elicit a response that provides the value for the slot.

createSlot_botId :: Lens' CreateSlot Text Source #

The identifier of the bot associated with the slot.

createSlot_botVersion :: Lens' CreateSlot Text Source #

The version of the bot associated with the slot.

createSlot_localeId :: Lens' CreateSlot Text Source #

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.

createSlot_intentId :: Lens' CreateSlot Text Source #

The identifier of the intent that contains the slot.

createSlotResponse_botId :: Lens' CreateSlotResponse (Maybe Text) Source #

The unique identifier of the bot associated with the slot.

createSlotResponse_botVersion :: Lens' CreateSlotResponse (Maybe Text) Source #

The version of the bot associated with the slot.

createSlotResponse_creationDateTime :: Lens' CreateSlotResponse (Maybe UTCTime) Source #

The timestamp of the date and time that the slot was created.

createSlotResponse_description :: Lens' CreateSlotResponse (Maybe Text) Source #

The description associated with the slot.

createSlotResponse_intentId :: Lens' CreateSlotResponse (Maybe Text) Source #

The unique identifier of the intent associated with the slot.

createSlotResponse_localeId :: Lens' CreateSlotResponse (Maybe Text) Source #

The language and local specified for the slot.

createSlotResponse_multipleValuesSetting :: Lens' CreateSlotResponse (Maybe MultipleValuesSetting) Source #

Indicates whether the slot returns multiple values in one response.

createSlotResponse_obfuscationSetting :: Lens' CreateSlotResponse (Maybe ObfuscationSetting) Source #

Indicates whether the slot is configured to obfuscate values in Amazon CloudWatch logs.

createSlotResponse_slotId :: Lens' CreateSlotResponse (Maybe Text) Source #

The unique identifier associated with the slot. Use this to identify the slot when you update or delete it.

createSlotResponse_slotName :: Lens' CreateSlotResponse (Maybe Text) Source #

The name specified for the slot.

createSlotResponse_slotTypeId :: Lens' CreateSlotResponse (Maybe Text) Source #

The unique identifier of the slot type associated with this slot.

createSlotResponse_subSlotSetting :: Lens' CreateSlotResponse (Maybe SubSlotSetting) Source #

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

createSlotResponse_valueElicitationSetting :: Lens' CreateSlotResponse (Maybe SlotValueElicitationSetting) Source #

The value elicitation settings specified for the slot.

createSlotResponse_httpStatus :: Lens' CreateSlotResponse Int Source #

The response's http status code.

CreateSlotType

createSlotType_compositeSlotTypeSetting :: Lens' CreateSlotType (Maybe CompositeSlotTypeSetting) Source #

Specifications for a composite slot type.

createSlotType_description :: Lens' CreateSlotType (Maybe Text) Source #

A description of the slot type. Use the description to help identify the slot type in lists.

createSlotType_externalSourceSetting :: Lens' CreateSlotType (Maybe ExternalSourceSetting) Source #

Sets the type of external information used to create the slot type.

createSlotType_parentSlotTypeSignature :: Lens' CreateSlotType (Maybe Text) Source #

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.

createSlotType_slotTypeValues :: Lens' CreateSlotType (Maybe (NonEmpty SlotTypeValue)) Source #

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.

createSlotType_valueSelectionSetting :: Lens' CreateSlotType (Maybe SlotValueSelectionSetting) Source #

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.

createSlotType_slotTypeName :: Lens' CreateSlotType Text Source #

The name for the slot. A slot type name must be unique within the account.

createSlotType_botId :: Lens' CreateSlotType Text Source #

The identifier of the bot associated with this slot type.

createSlotType_botVersion :: Lens' CreateSlotType Text Source #

The identifier of the bot version associated with this slot type.

createSlotType_localeId :: Lens' CreateSlotType Text Source #

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.

createSlotTypeResponse_botId :: Lens' CreateSlotTypeResponse (Maybe Text) Source #

The identifier for the bot associated with the slot type.

createSlotTypeResponse_botVersion :: Lens' CreateSlotTypeResponse (Maybe Text) Source #

The version of the bot associated with the slot type.

createSlotTypeResponse_compositeSlotTypeSetting :: Lens' CreateSlotTypeResponse (Maybe CompositeSlotTypeSetting) Source #

Specifications for a composite slot type.

createSlotTypeResponse_creationDateTime :: Lens' CreateSlotTypeResponse (Maybe UTCTime) Source #

A timestamp of the date and time that the slot type was created.

createSlotTypeResponse_description :: Lens' CreateSlotTypeResponse (Maybe Text) Source #

The description specified for the slot type.

createSlotTypeResponse_externalSourceSetting :: Lens' CreateSlotTypeResponse (Maybe ExternalSourceSetting) Source #

The type of external information used to create the slot type.

createSlotTypeResponse_localeId :: Lens' CreateSlotTypeResponse (Maybe Text) Source #

The specified language and local specified for the slot type.

createSlotTypeResponse_parentSlotTypeSignature :: Lens' CreateSlotTypeResponse (Maybe Text) Source #

The signature of the base slot type specified for the slot type.

createSlotTypeResponse_slotTypeId :: Lens' CreateSlotTypeResponse (Maybe Text) Source #

The unique identifier assigned to the slot type. Use this to identify the slot type in the UpdateSlotType and DeleteSlotType operations.

createSlotTypeResponse_slotTypeName :: Lens' CreateSlotTypeResponse (Maybe Text) Source #

The name specified for the slot type.

createSlotTypeResponse_slotTypeValues :: Lens' CreateSlotTypeResponse (Maybe (NonEmpty SlotTypeValue)) Source #

The list of values that the slot type can assume.

createSlotTypeResponse_valueSelectionSetting :: Lens' CreateSlotTypeResponse (Maybe SlotValueSelectionSetting) Source #

The strategy that Amazon Lex uses to select a value from the list of possible values.

createSlotTypeResponse_httpStatus :: Lens' CreateSlotTypeResponse Int Source #

The response's http status code.

CreateUploadUrl

createUploadUrlResponse_importId :: Lens' CreateUploadUrlResponse (Maybe Text) Source #

An identifier for a unique import job. Use it when you call the StartImport operation.

createUploadUrlResponse_uploadUrl :: Lens' CreateUploadUrlResponse (Maybe Text) Source #

A pre-signed S3 write URL. Upload the zip archive file that contains the definition of your bot or bot locale.

createUploadUrlResponse_httpStatus :: Lens' CreateUploadUrlResponse Int Source #

The response's http status code.

DeleteBot

deleteBot_skipResourceInUseCheck :: Lens' DeleteBot (Maybe Bool) Source #

When true, Amazon Lex doesn't check to see if another resource, such as an alias, is using the bot before it is deleted.

deleteBot_botId :: Lens' DeleteBot Text Source #

The identifier of the bot to delete.

deleteBotResponse_botId :: Lens' DeleteBotResponse (Maybe Text) Source #

The unique identifier of the bot that Amazon Lex is deleting.

deleteBotResponse_botStatus :: Lens' DeleteBotResponse (Maybe BotStatus) Source #

The current status of the bot. The status is Deleting while the bot and its associated resources are being deleted.

deleteBotResponse_httpStatus :: Lens' DeleteBotResponse Int Source #

The response's http status code.

DeleteBotAlias

deleteBotAlias_skipResourceInUseCheck :: Lens' DeleteBotAlias (Maybe Bool) Source #

When this parameter is true, Amazon Lex doesn't check to see if any other resource is using the alias before it is deleted.

deleteBotAlias_botAliasId :: Lens' DeleteBotAlias Text Source #

The unique identifier of the bot alias to delete.

deleteBotAlias_botId :: Lens' DeleteBotAlias Text Source #

The unique identifier of the bot associated with the alias to delete.

deleteBotAliasResponse_botAliasId :: Lens' DeleteBotAliasResponse (Maybe Text) Source #

The unique identifier of the bot alias to delete.

deleteBotAliasResponse_botAliasStatus :: Lens' DeleteBotAliasResponse (Maybe BotAliasStatus) Source #

The current status of the alias. The status is Deleting while the alias is in the process of being deleted. Once the alias is deleted, it will no longer appear in the list of aliases returned by the ListBotAliases operation.

deleteBotAliasResponse_botId :: Lens' DeleteBotAliasResponse (Maybe Text) Source #

The unique identifier of the bot that contains the alias to delete.

deleteBotAliasResponse_httpStatus :: Lens' DeleteBotAliasResponse Int Source #

The response's http status code.

DeleteBotLocale

deleteBotLocale_botId :: Lens' DeleteBotLocale Text Source #

The unique identifier of the bot that contains the locale.

deleteBotLocale_botVersion :: Lens' DeleteBotLocale Text Source #

The version of the bot that contains the locale.

deleteBotLocale_localeId :: Lens' DeleteBotLocale Text Source #

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.

deleteBotLocaleResponse_botId :: Lens' DeleteBotLocaleResponse (Maybe Text) Source #

The identifier of the bot that contained the deleted locale.

deleteBotLocaleResponse_botLocaleStatus :: Lens' DeleteBotLocaleResponse (Maybe BotLocaleStatus) Source #

The status of deleting the bot locale. The locale first enters the Deleting status. Once the locale is deleted it no longer appears in the list of locales for the bot.

deleteBotLocaleResponse_botVersion :: Lens' DeleteBotLocaleResponse (Maybe Text) Source #

The version of the bot that contained the deleted locale.

deleteBotLocaleResponse_localeId :: Lens' DeleteBotLocaleResponse (Maybe Text) Source #

The language and locale of the deleted locale.

deleteBotLocaleResponse_httpStatus :: Lens' DeleteBotLocaleResponse Int Source #

The response's http status code.

DeleteBotVersion

deleteBotVersion_skipResourceInUseCheck :: Lens' DeleteBotVersion (Maybe Bool) Source #

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.

deleteBotVersion_botId :: Lens' DeleteBotVersion Text Source #

The identifier of the bot that contains the version.

deleteBotVersion_botVersion :: Lens' DeleteBotVersion Text Source #

The version of the bot to delete.

deleteBotVersionResponse_botId :: Lens' DeleteBotVersionResponse (Maybe Text) Source #

The identifier of the bot that is being deleted.

deleteBotVersionResponse_botStatus :: Lens' DeleteBotVersionResponse (Maybe BotStatus) Source #

The current status of the bot.

deleteBotVersionResponse_botVersion :: Lens' DeleteBotVersionResponse (Maybe Text) Source #

The version of the bot that is being deleted.

deleteBotVersionResponse_httpStatus :: Lens' DeleteBotVersionResponse Int Source #

The response's http status code.

DeleteCustomVocabulary

deleteCustomVocabulary_botId :: Lens' DeleteCustomVocabulary Text Source #

The unique identifier of the bot to remove the custom vocabulary from.

deleteCustomVocabulary_botVersion :: Lens' DeleteCustomVocabulary Text Source #

The version of the bot to remove the custom vocabulary from.

deleteCustomVocabulary_localeId :: Lens' DeleteCustomVocabulary Text Source #

The locale identifier for the locale that contains the custom vocabulary to remove.

deleteCustomVocabularyResponse_botId :: Lens' DeleteCustomVocabularyResponse (Maybe Text) Source #

The identifier of the bot that the custom vocabulary was removed from.

deleteCustomVocabularyResponse_botVersion :: Lens' DeleteCustomVocabularyResponse (Maybe Text) Source #

The version of the bot that the custom vocabulary was removed from.

deleteCustomVocabularyResponse_customVocabularyStatus :: Lens' DeleteCustomVocabularyResponse (Maybe CustomVocabularyStatus) Source #

The status of removing the custom vocabulary.

deleteCustomVocabularyResponse_localeId :: Lens' DeleteCustomVocabularyResponse (Maybe Text) Source #

The locale identifier for the locale that the custom vocabulary was removed from.

deleteCustomVocabularyResponse_httpStatus :: Lens' DeleteCustomVocabularyResponse Int Source #

The response's http status code.

DeleteExport

deleteExport_exportId :: Lens' DeleteExport Text Source #

The unique identifier of the export to delete.

deleteExportResponse_exportId :: Lens' DeleteExportResponse (Maybe Text) Source #

The unique identifier of the deleted export.

deleteExportResponse_exportStatus :: Lens' DeleteExportResponse (Maybe ExportStatus) Source #

The current status of the deletion. When the deletion is complete, the export will no longer be returned by the ListExports operation and calls to the DescribeExport operation with the export identifier will fail.

deleteExportResponse_httpStatus :: Lens' DeleteExportResponse Int Source #

The response's http status code.

DeleteImport

deleteImport_importId :: Lens' DeleteImport Text Source #

The unique identifier of the import to delete.

deleteImportResponse_importId :: Lens' DeleteImportResponse (Maybe Text) Source #

The unique identifier of the deleted import.

deleteImportResponse_importStatus :: Lens' DeleteImportResponse (Maybe ImportStatus) Source #

The current status of the deletion. When the deletion is complete, the import will no longer be returned by the ListImports operation and calls to the DescribeImport operation with the import identifier will fail.

deleteImportResponse_httpStatus :: Lens' DeleteImportResponse Int Source #

The response's http status code.

DeleteIntent

deleteIntent_intentId :: Lens' DeleteIntent Text Source #

The unique identifier of the intent to delete.

deleteIntent_botId :: Lens' DeleteIntent Text Source #

The identifier of the bot associated with the intent.

deleteIntent_botVersion :: Lens' DeleteIntent Text Source #

The version of the bot associated with the intent.

deleteIntent_localeId :: Lens' DeleteIntent Text Source #

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.

DeleteResourcePolicy

deleteResourcePolicy_expectedRevisionId :: Lens' DeleteResourcePolicy (Maybe Text) Source #

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.

deleteResourcePolicy_resourceArn :: Lens' DeleteResourcePolicy Text Source #

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

deleteResourcePolicyResponse_resourceArn :: Lens' DeleteResourcePolicyResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy was deleted from.

deleteResourcePolicyResponse_revisionId :: Lens' DeleteResourcePolicyResponse (Maybe Text) Source #

The current revision of the resource policy. Use the revision ID to make sure that you are updating the most current version of a resource policy when you add a policy statement to a resource, delete a resource, or update a resource.

deleteResourcePolicyResponse_httpStatus :: Lens' DeleteResourcePolicyResponse Int Source #

The response's http status code.

DeleteResourcePolicyStatement

deleteResourcePolicyStatement_expectedRevisionId :: Lens' DeleteResourcePolicyStatement (Maybe Text) Source #

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.

deleteResourcePolicyStatement_resourceArn :: Lens' DeleteResourcePolicyStatement Text Source #

The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.

deleteResourcePolicyStatement_statementId :: Lens' DeleteResourcePolicyStatement Text Source #

The name of the statement (SID) to delete from the policy.

deleteResourcePolicyStatementResponse_resourceArn :: Lens' DeleteResourcePolicyStatementResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy statement was removed from.

deleteResourcePolicyStatementResponse_revisionId :: Lens' DeleteResourcePolicyStatementResponse (Maybe Text) Source #

The current revision of the resource policy. Use the revision ID to make sure that you are updating the most current version of a resource policy when you add a policy statement to a resource, delete a resource, or update a resource.

deleteResourcePolicyStatementResponse_httpStatus :: Lens' DeleteResourcePolicyStatementResponse Int Source #

The response's http status code.

DeleteSlot

deleteSlot_slotId :: Lens' DeleteSlot Text Source #

The identifier of the slot to delete.

deleteSlot_botId :: Lens' DeleteSlot Text Source #

The identifier of the bot associated with the slot to delete.

deleteSlot_botVersion :: Lens' DeleteSlot Text Source #

The version of the bot associated with the slot to delete.

deleteSlot_localeId :: Lens' DeleteSlot Text Source #

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.

deleteSlot_intentId :: Lens' DeleteSlot Text Source #

The identifier of the intent associated with the slot.

DeleteSlotType

deleteSlotType_skipResourceInUseCheck :: Lens' DeleteSlotType (Maybe Bool) Source #

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.

deleteSlotType_slotTypeId :: Lens' DeleteSlotType Text Source #

The identifier of the slot type to delete.

deleteSlotType_botId :: Lens' DeleteSlotType Text Source #

The identifier of the bot associated with the slot type.

deleteSlotType_botVersion :: Lens' DeleteSlotType Text Source #

The version of the bot associated with the slot type.

deleteSlotType_localeId :: Lens' DeleteSlotType Text Source #

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.

DeleteUtterances

deleteUtterances_localeId :: Lens' DeleteUtterances (Maybe Text) Source #

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.

deleteUtterances_sessionId :: Lens' DeleteUtterances (Maybe Text) Source #

The unique identifier of the session with the user. The ID is returned in the response from the RecognizeText and RecognizeUtterance operations.

deleteUtterances_botId :: Lens' DeleteUtterances Text Source #

The unique identifier of the bot that contains the utterances.

deleteUtterancesResponse_httpStatus :: Lens' DeleteUtterancesResponse Int Source #

The response's http status code.

DescribeBot

describeBot_botId :: Lens' DescribeBot Text Source #

The unique identifier of the bot to describe.

describeBotResponse_botId :: Lens' DescribeBotResponse (Maybe Text) Source #

The unique identifier of the bot.

describeBotResponse_botName :: Lens' DescribeBotResponse (Maybe Text) Source #

The name of the bot.

describeBotResponse_botStatus :: Lens' DescribeBotResponse (Maybe BotStatus) Source #

The current status of the bot. When the status is Available the bot is ready to be used in conversations with users.

describeBotResponse_creationDateTime :: Lens' DescribeBotResponse (Maybe UTCTime) Source #

A timestamp of the date and time that the bot was created.

describeBotResponse_dataPrivacy :: Lens' DescribeBotResponse (Maybe DataPrivacy) Source #

Settings for managing data privacy of the bot and its conversations with users.

describeBotResponse_description :: Lens' DescribeBotResponse (Maybe Text) Source #

The description of the bot.

describeBotResponse_idleSessionTTLInSeconds :: Lens' DescribeBotResponse (Maybe Natural) Source #

The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.

describeBotResponse_lastUpdatedDateTime :: Lens' DescribeBotResponse (Maybe UTCTime) Source #

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

describeBotResponse_roleArn :: Lens' DescribeBotResponse (Maybe Text) Source #

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

describeBotResponse_httpStatus :: Lens' DescribeBotResponse Int Source #

The response's http status code.

DescribeBotAlias

describeBotAlias_botAliasId :: Lens' DescribeBotAlias Text Source #

The identifier of the bot alias to describe.

describeBotAlias_botId :: Lens' DescribeBotAlias Text Source #

The identifier of the bot associated with the bot alias to describe.

describeBotAliasResponse_botAliasHistoryEvents :: Lens' DescribeBotAliasResponse (Maybe [BotAliasHistoryEvent]) Source #

A list of events that affect a bot alias. For example, an event is recorded when the version that the alias points to changes.

describeBotAliasResponse_botAliasId :: Lens' DescribeBotAliasResponse (Maybe Text) Source #

The identifier of the bot alias.

describeBotAliasResponse_botAliasLocaleSettings :: Lens' DescribeBotAliasResponse (Maybe (HashMap Text BotAliasLocaleSettings)) Source #

The locale settings that are unique to the alias.

describeBotAliasResponse_botAliasName :: Lens' DescribeBotAliasResponse (Maybe Text) Source #

The name of the bot alias.

describeBotAliasResponse_botAliasStatus :: Lens' DescribeBotAliasResponse (Maybe BotAliasStatus) Source #

The current status of the alias. When the alias is Available, the alias is ready for use with your bot.

describeBotAliasResponse_botId :: Lens' DescribeBotAliasResponse (Maybe Text) Source #

The identifier of the bot associated with the bot alias.

describeBotAliasResponse_botVersion :: Lens' DescribeBotAliasResponse (Maybe Text) Source #

The version of the bot associated with the bot alias.

describeBotAliasResponse_conversationLogSettings :: Lens' DescribeBotAliasResponse (Maybe ConversationLogSettings) Source #

Specifics of how Amazon Lex logs text and audio conversations with the bot associated with the alias.

describeBotAliasResponse_creationDateTime :: Lens' DescribeBotAliasResponse (Maybe UTCTime) Source #

A timestamp of the date and time that the alias was created.

describeBotAliasResponse_description :: Lens' DescribeBotAliasResponse (Maybe Text) Source #

The description of the bot alias.

describeBotAliasResponse_lastUpdatedDateTime :: Lens' DescribeBotAliasResponse (Maybe UTCTime) Source #

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

describeBotAliasResponse_sentimentAnalysisSettings :: Lens' DescribeBotAliasResponse (Maybe SentimentAnalysisSettings) Source #

Undocumented member.

describeBotAliasResponse_httpStatus :: Lens' DescribeBotAliasResponse Int Source #

The response's http status code.

DescribeBotLocale

describeBotLocale_botId :: Lens' DescribeBotLocale Text Source #

The identifier of the bot associated with the locale.

describeBotLocale_botVersion :: Lens' DescribeBotLocale Text Source #

The identifier of the version of the bot associated with the locale.

describeBotLocale_localeId :: Lens' DescribeBotLocale Text Source #

The unique identifier of the locale to describe. The string must match one of the supported locales. For more information, see Supported languages.

describeBotLocaleResponse_botId :: Lens' DescribeBotLocaleResponse (Maybe Text) Source #

The identifier of the bot associated with the locale.

describeBotLocaleResponse_botLocaleHistoryEvents :: Lens' DescribeBotLocaleResponse (Maybe [BotLocaleHistoryEvent]) Source #

History of changes, such as when a locale is used in an alias, that have taken place for the locale.

describeBotLocaleResponse_botLocaleStatus :: Lens' DescribeBotLocaleResponse (Maybe BotLocaleStatus) Source #

The status of the bot. If the status is Failed, the reasons for the failure are listed in the failureReasons field.

describeBotLocaleResponse_botVersion :: Lens' DescribeBotLocaleResponse (Maybe Text) Source #

The identifier of the version of the bot associated with the locale.

describeBotLocaleResponse_creationDateTime :: Lens' DescribeBotLocaleResponse (Maybe UTCTime) Source #

The date and time that the locale was created.

describeBotLocaleResponse_description :: Lens' DescribeBotLocaleResponse (Maybe Text) Source #

The description of the locale.

describeBotLocaleResponse_failureReasons :: Lens' DescribeBotLocaleResponse (Maybe [Text]) Source #

if botLocaleStatus is Failed, Amazon Lex explains why it failed to build the bot.

describeBotLocaleResponse_intentsCount :: Lens' DescribeBotLocaleResponse (Maybe Int) Source #

The number of intents defined for the locale.

describeBotLocaleResponse_lastBuildSubmittedDateTime :: Lens' DescribeBotLocaleResponse (Maybe UTCTime) Source #

The date and time that the locale was last submitted for building.

describeBotLocaleResponse_lastUpdatedDateTime :: Lens' DescribeBotLocaleResponse (Maybe UTCTime) Source #

The date and time that the locale was last updated.

describeBotLocaleResponse_localeId :: Lens' DescribeBotLocaleResponse (Maybe Text) Source #

The unique identifier of the described locale.

describeBotLocaleResponse_localeName :: Lens' DescribeBotLocaleResponse (Maybe Text) Source #

The name of the locale.

describeBotLocaleResponse_nluIntentConfidenceThreshold :: Lens' DescribeBotLocaleResponse (Maybe Double) Source #

The confidence threshold where Amazon Lex inserts the AMAZON.FallbackIntent and AMAZON.KendraSearchIntent intents in the list of possible intents for an utterance.

describeBotLocaleResponse_recommendedActions :: Lens' DescribeBotLocaleResponse (Maybe [Text]) Source #

Recommended actions to take to resolve an error in the failureReasons field.

describeBotLocaleResponse_slotTypesCount :: Lens' DescribeBotLocaleResponse (Maybe Int) Source #

The number of slot types defined for the locale.

describeBotLocaleResponse_voiceSettings :: Lens' DescribeBotLocaleResponse (Maybe VoiceSettings) Source #

The Amazon Polly voice Amazon Lex uses for voice interaction with the user.

describeBotLocaleResponse_httpStatus :: Lens' DescribeBotLocaleResponse Int Source #

The response's http status code.

DescribeBotRecommendation

describeBotRecommendation_botId :: Lens' DescribeBotRecommendation Text Source #

The unique identifier of the bot associated with the bot recommendation.

describeBotRecommendation_botVersion :: Lens' DescribeBotRecommendation Text Source #

The version of the bot associated with the bot recommendation.

describeBotRecommendation_localeId :: Lens' DescribeBotRecommendation Text Source #

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.

describeBotRecommendation_botRecommendationId :: Lens' DescribeBotRecommendation Text Source #

The identifier of the bot recommendation to describe.

describeBotRecommendationResponse_botId :: Lens' DescribeBotRecommendationResponse (Maybe Text) Source #

The identifier of the bot associated with the bot recommendation.

describeBotRecommendationResponse_botRecommendationId :: Lens' DescribeBotRecommendationResponse (Maybe Text) Source #

The identifier of the bot recommendation being described.

describeBotRecommendationResponse_botRecommendationResults :: Lens' DescribeBotRecommendationResponse (Maybe BotRecommendationResults) Source #

The object representing the URL of the bot definition, the URL of the associated transcript and a statistical summary of the bot recommendation results.

describeBotRecommendationResponse_botRecommendationStatus :: Lens' DescribeBotRecommendationResponse (Maybe BotRecommendationStatus) Source #

The status of the bot recommendation. If the status is Failed, then the reasons for the failure are listed in the failureReasons field.

describeBotRecommendationResponse_botVersion :: Lens' DescribeBotRecommendationResponse (Maybe Text) Source #

The version of the bot associated with the bot recommendation.

describeBotRecommendationResponse_creationDateTime :: Lens' DescribeBotRecommendationResponse (Maybe UTCTime) Source #

The date and time that the bot recommendation was created.

describeBotRecommendationResponse_encryptionSetting :: Lens' DescribeBotRecommendationResponse (Maybe EncryptionSetting) Source #

The object representing the passwords that were used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.

describeBotRecommendationResponse_failureReasons :: Lens' DescribeBotRecommendationResponse (Maybe [Text]) Source #

If botRecommendationStatus is Failed, Amazon Lex explains why.

describeBotRecommendationResponse_lastUpdatedDateTime :: Lens' DescribeBotRecommendationResponse (Maybe UTCTime) Source #

The date and time that the bot recommendation was last updated.

describeBotRecommendationResponse_localeId :: Lens' DescribeBotRecommendationResponse (Maybe Text) Source #

The identifier of the language and locale of the bot recommendation to describe.

describeBotRecommendationResponse_transcriptSourceSetting :: Lens' DescribeBotRecommendationResponse (Maybe TranscriptSourceSetting) Source #

The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.

describeBotRecommendationResponse_httpStatus :: Lens' DescribeBotRecommendationResponse Int Source #

The response's http status code.

DescribeBotVersion

describeBotVersion_botId :: Lens' DescribeBotVersion Text Source #

The identifier of the bot containing the version to return metadata for.

describeBotVersion_botVersion :: Lens' DescribeBotVersion Text Source #

The version of the bot to return metadata for.

describeBotVersionResponse_botId :: Lens' DescribeBotVersionResponse (Maybe Text) Source #

The identifier of the bot that contains the version.

describeBotVersionResponse_botName :: Lens' DescribeBotVersionResponse (Maybe Text) Source #

The name of the bot that contains the version.

describeBotVersionResponse_botStatus :: Lens' DescribeBotVersionResponse (Maybe BotStatus) Source #

The current status of the bot. When the status is Available, the bot version is ready for use.

describeBotVersionResponse_botVersion :: Lens' DescribeBotVersionResponse (Maybe Text) Source #

The version of the bot to describe.

describeBotVersionResponse_creationDateTime :: Lens' DescribeBotVersionResponse (Maybe UTCTime) Source #

A timestamp of the date and time that the bot version was created.

describeBotVersionResponse_dataPrivacy :: Lens' DescribeBotVersionResponse (Maybe DataPrivacy) Source #

Data privacy settings for the bot version.

describeBotVersionResponse_description :: Lens' DescribeBotVersionResponse (Maybe Text) Source #

The description specified for the bot.

describeBotVersionResponse_failureReasons :: Lens' DescribeBotVersionResponse (Maybe [Text]) Source #

If the botStatus is Failed, this contains a list of reasons that the version couldn't be built.

describeBotVersionResponse_idleSessionTTLInSeconds :: Lens' DescribeBotVersionResponse (Maybe Natural) Source #

The number of seconds that a session with the bot remains active before it is discarded by Amazon Lex.

describeBotVersionResponse_roleArn :: Lens' DescribeBotVersionResponse (Maybe Text) Source #

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

describeBotVersionResponse_httpStatus :: Lens' DescribeBotVersionResponse Int Source #

The response's http status code.

DescribeCustomVocabularyMetadata

describeCustomVocabularyMetadata_botId :: Lens' DescribeCustomVocabularyMetadata Text Source #

The unique identifier of the bot that contains the custom vocabulary.

describeCustomVocabularyMetadata_botVersion :: Lens' DescribeCustomVocabularyMetadata Text Source #

The bot version of the bot to return metadata for.

describeCustomVocabularyMetadata_localeId :: Lens' DescribeCustomVocabularyMetadata Text Source #

The locale to return the custom vocabulary information for. The locale must be en_GB.

describeCustomVocabularyMetadataResponse_botId :: Lens' DescribeCustomVocabularyMetadataResponse (Maybe Text) Source #

The identifier of the bot that contains the custom vocabulary.

describeCustomVocabularyMetadataResponse_botVersion :: Lens' DescribeCustomVocabularyMetadataResponse (Maybe Text) Source #

The version of the bot that contains the custom vocabulary to describe.

describeCustomVocabularyMetadataResponse_creationDateTime :: Lens' DescribeCustomVocabularyMetadataResponse (Maybe UTCTime) Source #

The date and time that the custom vocabulary was created.

describeCustomVocabularyMetadataResponse_customVocabularyStatus :: Lens' DescribeCustomVocabularyMetadataResponse (Maybe CustomVocabularyStatus) Source #

The status of the custom vocabulary. If the status is Ready the custom vocabulary is ready to use.

describeCustomVocabularyMetadataResponse_lastUpdatedDateTime :: Lens' DescribeCustomVocabularyMetadataResponse (Maybe UTCTime) Source #

The date and time that the custom vocabulary was last updated.

describeCustomVocabularyMetadataResponse_localeId :: Lens' DescribeCustomVocabularyMetadataResponse (Maybe Text) Source #

The locale that contains the custom vocabulary to describe.

describeCustomVocabularyMetadataResponse_httpStatus :: Lens' DescribeCustomVocabularyMetadataResponse Int Source #

The response's http status code.

DescribeExport

describeExport_exportId :: Lens' DescribeExport Text Source #

The unique identifier of the export to describe.

describeExportResponse_creationDateTime :: Lens' DescribeExportResponse (Maybe UTCTime) Source #

The date and time that the export was created.

describeExportResponse_downloadUrl :: Lens' DescribeExportResponse (Maybe Text) Source #

A pre-signed S3 URL that points to the bot or bot locale archive. The URL is only available for 5 minutes after calling the DescribeExport operation.

describeExportResponse_exportId :: Lens' DescribeExportResponse (Maybe Text) Source #

The unique identifier of the described export.

describeExportResponse_exportStatus :: Lens' DescribeExportResponse (Maybe ExportStatus) Source #

The status of the export. When the status is Complete the export archive file is available for download.

describeExportResponse_failureReasons :: Lens' DescribeExportResponse (Maybe [Text]) Source #

If the exportStatus is failed, contains one or more reasons why the export could not be completed.

describeExportResponse_fileFormat :: Lens' DescribeExportResponse (Maybe ImportExportFileFormat) Source #

The file format used in the files that describe the resource.

describeExportResponse_lastUpdatedDateTime :: Lens' DescribeExportResponse (Maybe UTCTime) Source #

The last date and time that the export was updated.

describeExportResponse_resourceSpecification :: Lens' DescribeExportResponse (Maybe ExportResourceSpecification) Source #

The bot, bot ID, and optional locale ID of the exported bot or bot locale.

describeExportResponse_httpStatus :: Lens' DescribeExportResponse Int Source #

The response's http status code.

DescribeImport

describeImport_importId :: Lens' DescribeImport Text Source #

The unique identifier of the import to describe.

describeImportResponse_creationDateTime :: Lens' DescribeImportResponse (Maybe UTCTime) Source #

The date and time that the import was created.

describeImportResponse_failureReasons :: Lens' DescribeImportResponse (Maybe [Text]) Source #

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

describeImportResponse_importId :: Lens' DescribeImportResponse (Maybe Text) Source #

The unique identifier of the described import.

describeImportResponse_importStatus :: Lens' DescribeImportResponse (Maybe ImportStatus) Source #

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

describeImportResponse_importedResourceId :: Lens' DescribeImportResponse (Maybe Text) Source #

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

describeImportResponse_importedResourceName :: Lens' DescribeImportResponse (Maybe Text) Source #

The name of the imported resource.

describeImportResponse_lastUpdatedDateTime :: Lens' DescribeImportResponse (Maybe UTCTime) Source #

The date and time that the import was last updated.

describeImportResponse_mergeStrategy :: Lens' DescribeImportResponse (Maybe MergeStrategy) Source #

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.

describeImportResponse_resourceSpecification :: Lens' DescribeImportResponse (Maybe ImportResourceSpecification) Source #

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

describeImportResponse_httpStatus :: Lens' DescribeImportResponse Int Source #

The response's http status code.

DescribeIntent

describeIntent_intentId :: Lens' DescribeIntent Text Source #

The identifier of the intent to describe.

describeIntent_botId :: Lens' DescribeIntent Text Source #

The identifier of the bot associated with the intent.

describeIntent_botVersion :: Lens' DescribeIntent Text Source #

The version of the bot associated with the intent.

describeIntent_localeId :: Lens' DescribeIntent Text Source #

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.

describeIntentResponse_botId :: Lens' DescribeIntentResponse (Maybe Text) Source #

The identifier of the bot associated with the intent.

describeIntentResponse_botVersion :: Lens' DescribeIntentResponse (Maybe Text) Source #

The version of the bot associated with the intent.

describeIntentResponse_creationDateTime :: Lens' DescribeIntentResponse (Maybe UTCTime) Source #

A timestamp of the date and time that the intent was created.

describeIntentResponse_description :: Lens' DescribeIntentResponse (Maybe Text) Source #

The description of the intent.

describeIntentResponse_dialogCodeHook :: Lens' DescribeIntentResponse (Maybe DialogCodeHookSettings) Source #

The Lambda function called during each turn of a conversation with the intent.

describeIntentResponse_fulfillmentCodeHook :: Lens' DescribeIntentResponse (Maybe FulfillmentCodeHookSettings) Source #

The Lambda function called when the intent is complete and ready for fulfillment.

describeIntentResponse_initialResponseSetting :: Lens' DescribeIntentResponse (Maybe InitialResponseSetting) Source #

describeIntentResponse_inputContexts :: Lens' DescribeIntentResponse (Maybe [InputContext]) Source #

A list of contexts that must be active for the intent to be considered for sending to the user.

describeIntentResponse_intentClosingSetting :: Lens' DescribeIntentResponse (Maybe IntentClosingSetting) Source #

The response that Amazon Lex sends to when the intent is closed.

describeIntentResponse_intentConfirmationSetting :: Lens' DescribeIntentResponse (Maybe IntentConfirmationSetting) Source #

Prompts that Amazon Lex sends to the user to confirm completion of an intent.

describeIntentResponse_intentId :: Lens' DescribeIntentResponse (Maybe Text) Source #

The unique identifier assigned to the intent when it was created.

describeIntentResponse_intentName :: Lens' DescribeIntentResponse (Maybe Text) Source #

The name specified for the intent.

describeIntentResponse_kendraConfiguration :: Lens' DescribeIntentResponse (Maybe KendraConfiguration) Source #

Configuration information required to use the AMAZON.KendraSearchIntent intent.

describeIntentResponse_lastUpdatedDateTime :: Lens' DescribeIntentResponse (Maybe UTCTime) Source #

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

describeIntentResponse_localeId :: Lens' DescribeIntentResponse (Maybe Text) Source #

The language and locale specified for the intent.

describeIntentResponse_outputContexts :: Lens' DescribeIntentResponse (Maybe [OutputContext]) Source #

A list of contexts that are activated when the intent is fulfilled.

describeIntentResponse_parentIntentSignature :: Lens' DescribeIntentResponse (Maybe Text) Source #

The identifier of the built-in intent that this intent is derived from, if any.

describeIntentResponse_sampleUtterances :: Lens' DescribeIntentResponse (Maybe [SampleUtterance]) Source #

User utterances that trigger this intent.

describeIntentResponse_slotPriorities :: Lens' DescribeIntentResponse (Maybe [SlotPriority]) Source #

The list that determines the priority that slots should be elicited from the user.

describeIntentResponse_httpStatus :: Lens' DescribeIntentResponse Int Source #

The response's http status code.

DescribeResourcePolicy

describeResourcePolicy_resourceArn :: Lens' DescribeResourcePolicy Text Source #

The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.

describeResourcePolicyResponse_policy :: Lens' DescribeResourcePolicyResponse (Maybe Text) Source #

The JSON structure that contains the resource policy. For more information about the contents of a JSON policy document, see IAM JSON policy reference .

describeResourcePolicyResponse_resourceArn :: Lens' DescribeResourcePolicyResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.

describeResourcePolicyResponse_revisionId :: Lens' DescribeResourcePolicyResponse (Maybe Text) Source #

The current revision of the resource policy. Use the revision ID to make sure that you are updating the most current version of a resource policy when you add a policy statement to a resource, delete a resource, or update a resource.

describeResourcePolicyResponse_httpStatus :: Lens' DescribeResourcePolicyResponse Int Source #

The response's http status code.

DescribeSlot

describeSlot_slotId :: Lens' DescribeSlot Text Source #

The unique identifier for the slot.

describeSlot_botId :: Lens' DescribeSlot Text Source #

The identifier of the bot associated with the slot.

describeSlot_botVersion :: Lens' DescribeSlot Text Source #

The version of the bot associated with the slot.

describeSlot_localeId :: Lens' DescribeSlot Text Source #

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.

describeSlot_intentId :: Lens' DescribeSlot Text Source #

The identifier of the intent that contains the slot.

describeSlotResponse_botId :: Lens' DescribeSlotResponse (Maybe Text) Source #

The identifier of the bot associated with the slot.

describeSlotResponse_botVersion :: Lens' DescribeSlotResponse (Maybe Text) Source #

The version of the bot associated with the slot.

describeSlotResponse_creationDateTime :: Lens' DescribeSlotResponse (Maybe UTCTime) Source #

A timestamp of the date and time that the slot was created.

describeSlotResponse_description :: Lens' DescribeSlotResponse (Maybe Text) Source #

The description specified for the slot.

describeSlotResponse_intentId :: Lens' DescribeSlotResponse (Maybe Text) Source #

The identifier of the intent associated with the slot.

describeSlotResponse_lastUpdatedDateTime :: Lens' DescribeSlotResponse (Maybe UTCTime) Source #

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

describeSlotResponse_localeId :: Lens' DescribeSlotResponse (Maybe Text) Source #

The language and locale specified for the slot.

describeSlotResponse_multipleValuesSetting :: Lens' DescribeSlotResponse (Maybe MultipleValuesSetting) Source #

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

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

describeSlotResponse_obfuscationSetting :: Lens' DescribeSlotResponse (Maybe ObfuscationSetting) Source #

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

describeSlotResponse_slotId :: Lens' DescribeSlotResponse (Maybe Text) Source #

The unique identifier generated for the slot.

describeSlotResponse_slotName :: Lens' DescribeSlotResponse (Maybe Text) Source #

The name specified for the slot.

describeSlotResponse_slotTypeId :: Lens' DescribeSlotResponse (Maybe Text) Source #

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

describeSlotResponse_subSlotSetting :: Lens' DescribeSlotResponse (Maybe SubSlotSetting) Source #

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

describeSlotResponse_valueElicitationSetting :: Lens' DescribeSlotResponse (Maybe SlotValueElicitationSetting) Source #

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

describeSlotResponse_httpStatus :: Lens' DescribeSlotResponse Int Source #

The response's http status code.

DescribeSlotType

describeSlotType_slotTypeId :: Lens' DescribeSlotType Text Source #

The identifier of the slot type.

describeSlotType_botId :: Lens' DescribeSlotType Text Source #

The identifier of the bot associated with the slot type.

describeSlotType_botVersion :: Lens' DescribeSlotType Text Source #

The version of the bot associated with the slot type.

describeSlotType_localeId :: Lens' DescribeSlotType Text Source #

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.

describeSlotTypeResponse_botId :: Lens' DescribeSlotTypeResponse (Maybe Text) Source #

The identifier of the bot associated with the slot type.

describeSlotTypeResponse_botVersion :: Lens' DescribeSlotTypeResponse (Maybe Text) Source #

The version of the bot associated with the slot type.

describeSlotTypeResponse_compositeSlotTypeSetting :: Lens' DescribeSlotTypeResponse (Maybe CompositeSlotTypeSetting) Source #

Specifications for a composite slot type.

describeSlotTypeResponse_creationDateTime :: Lens' DescribeSlotTypeResponse (Maybe UTCTime) Source #

A timestamp of the date and time that the slot type was created.

describeSlotTypeResponse_description :: Lens' DescribeSlotTypeResponse (Maybe Text) Source #

The description specified for the slot type.

describeSlotTypeResponse_externalSourceSetting :: Lens' DescribeSlotTypeResponse (Maybe ExternalSourceSetting) Source #

Undocumented member.

describeSlotTypeResponse_lastUpdatedDateTime :: Lens' DescribeSlotTypeResponse (Maybe UTCTime) Source #

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

describeSlotTypeResponse_localeId :: Lens' DescribeSlotTypeResponse (Maybe Text) Source #

The language and locale specified for the slot type.

describeSlotTypeResponse_parentSlotTypeSignature :: Lens' DescribeSlotTypeResponse (Maybe Text) Source #

The built in slot type used as a parent to this slot type.

describeSlotTypeResponse_slotTypeId :: Lens' DescribeSlotTypeResponse (Maybe Text) Source #

The unique identifier for the slot type.

describeSlotTypeResponse_slotTypeName :: Lens' DescribeSlotTypeResponse (Maybe Text) Source #

The name specified for the slot type.

describeSlotTypeResponse_slotTypeValues :: Lens' DescribeSlotTypeResponse (Maybe (NonEmpty SlotTypeValue)) Source #

The values that the slot type can take. Includes any synonyms for the slot type values.

describeSlotTypeResponse_valueSelectionSetting :: Lens' DescribeSlotTypeResponse (Maybe SlotValueSelectionSetting) Source #

The strategy that Amazon Lex uses to choose a value from a list of possible values.

describeSlotTypeResponse_httpStatus :: Lens' DescribeSlotTypeResponse Int Source #

The response's http status code.

ListAggregatedUtterances

listAggregatedUtterances_botAliasId :: Lens' ListAggregatedUtterances (Maybe Text) Source #

The identifier of the bot alias associated with this request. If you specify the bot alias, you can't specify the bot version.

listAggregatedUtterances_botVersion :: Lens' ListAggregatedUtterances (Maybe Text) Source #

The identifier of the bot version associated with this request. If you specify the bot version, you can't specify the bot alias.

listAggregatedUtterances_filters :: Lens' ListAggregatedUtterances (Maybe (NonEmpty AggregatedUtterancesFilter)) Source #

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.

listAggregatedUtterances_maxResults :: Lens' ListAggregatedUtterances (Maybe Natural) Source #

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.

listAggregatedUtterances_nextToken :: Lens' ListAggregatedUtterances (Maybe Text) Source #

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.

listAggregatedUtterances_sortBy :: Lens' ListAggregatedUtterances (Maybe AggregatedUtterancesSortBy) Source #

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.

listAggregatedUtterances_botId :: Lens' ListAggregatedUtterances Text Source #

The unique identifier of the bot associated with this request.

listAggregatedUtterances_localeId :: Lens' ListAggregatedUtterances Text Source #

The identifier of the language and locale where the utterances were collected. For more information, see Supported languages.

listAggregatedUtterances_aggregationDuration :: Lens' ListAggregatedUtterances UtteranceAggregationDuration Source #

The time window for aggregating the utterance information. You can specify a time between one hour and two weeks.

listAggregatedUtterancesResponse_aggregatedUtterancesSummaries :: Lens' ListAggregatedUtterancesResponse (Maybe [AggregatedUtterancesSummary]) Source #

Summaries of the aggregated utterance data. Each response contains information about the number of times that the utterance was seen during the time period, whether it was detected or missed, and when it was seen during the time period.

listAggregatedUtterancesResponse_aggregationDuration :: Lens' ListAggregatedUtterancesResponse (Maybe UtteranceAggregationDuration) Source #

The time period used to aggregate the utterance data.

listAggregatedUtterancesResponse_aggregationLastRefreshedDateTime :: Lens' ListAggregatedUtterancesResponse (Maybe UTCTime) Source #

The last date and time that the aggregated data was collected. The time period depends on the length of the aggregation window.

Hours - for 1 hour time window, every half hour; otherwise every hour.
Days - every 6 hours
Weeks - for a one week time window, every 12 hours; otherwise, every day

listAggregatedUtterancesResponse_aggregationWindowEndTime :: Lens' ListAggregatedUtterancesResponse (Maybe UTCTime) Source #

The date and time that the aggregation window ends. Only data collected between the start time and the end time are returned in the results.

listAggregatedUtterancesResponse_aggregationWindowStartTime :: Lens' ListAggregatedUtterancesResponse (Maybe UTCTime) Source #

The date and time that the aggregation window begins. Only data collected after this time is returned in the results.

listAggregatedUtterancesResponse_botAliasId :: Lens' ListAggregatedUtterancesResponse (Maybe Text) Source #

The identifier of the bot alias that contains the utterances. If you specified the bot version, the bot alias ID isn't returned.

listAggregatedUtterancesResponse_botId :: Lens' ListAggregatedUtterancesResponse (Maybe Text) Source #

The identifier of the bot that contains the utterances.

listAggregatedUtterancesResponse_botVersion :: Lens' ListAggregatedUtterancesResponse (Maybe Text) Source #

The identifier of the bot version that contains the utterances. If you specified the bot alias, the bot version isn't returned.

listAggregatedUtterancesResponse_localeId :: Lens' ListAggregatedUtterancesResponse (Maybe Text) Source #

The identifier of the language and locale that the utterances are in.

listAggregatedUtterancesResponse_nextToken :: Lens' ListAggregatedUtterancesResponse (Maybe Text) Source #

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

listAggregatedUtterancesResponse_httpStatus :: Lens' ListAggregatedUtterancesResponse Int Source #

The response's http status code.

ListBotAliases

listBotAliases_maxResults :: Lens' ListBotAliases (Maybe Natural) Source #

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.

listBotAliases_nextToken :: Lens' ListBotAliases (Maybe Text) Source #

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.

listBotAliases_botId :: Lens' ListBotAliases Text Source #

The identifier of the bot to list aliases for.

listBotAliasesResponse_botAliasSummaries :: Lens' ListBotAliasesResponse (Maybe [BotAliasSummary]) Source #

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

listBotAliasesResponse_botId :: Lens' ListBotAliasesResponse (Maybe Text) Source #

The identifier of the bot associated with the aliases.

listBotAliasesResponse_nextToken :: Lens' ListBotAliasesResponse (Maybe Text) Source #

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

listBotAliasesResponse_httpStatus :: Lens' ListBotAliasesResponse Int Source #

The response's http status code.

ListBotLocales

listBotLocales_filters :: Lens' ListBotLocales (Maybe (NonEmpty BotLocaleFilter)) Source #

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.

listBotLocales_maxResults :: Lens' ListBotLocales (Maybe Natural) Source #

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.

listBotLocales_nextToken :: Lens' ListBotLocales (Maybe Text) Source #

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.

listBotLocales_sortBy :: Lens' ListBotLocales (Maybe BotLocaleSortBy) Source #

Specifies sorting parameters for the list of locales. You can sort by locale name in ascending or descending order.

listBotLocales_botId :: Lens' ListBotLocales Text Source #

The identifier of the bot to list locales for.

listBotLocales_botVersion :: Lens' ListBotLocales Text Source #

The version of the bot to list locales for.

listBotLocalesResponse_botId :: Lens' ListBotLocalesResponse (Maybe Text) Source #

The identifier of the bot to list locales for.

listBotLocalesResponse_botLocaleSummaries :: Lens' ListBotLocalesResponse (Maybe [BotLocaleSummary]) Source #

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

listBotLocalesResponse_botVersion :: Lens' ListBotLocalesResponse (Maybe Text) Source #

The version of the bot.

listBotLocalesResponse_nextToken :: Lens' ListBotLocalesResponse (Maybe Text) Source #

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

listBotLocalesResponse_httpStatus :: Lens' ListBotLocalesResponse Int Source #

The response's http status code.

ListBotRecommendations

listBotRecommendations_maxResults :: Lens' ListBotRecommendations (Maybe Natural) Source #

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.

listBotRecommendations_nextToken :: Lens' ListBotRecommendations (Maybe Text) Source #

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.

listBotRecommendations_botId :: Lens' ListBotRecommendations Text Source #

The unique identifier of the bot that contains the bot recommendation list.

listBotRecommendations_botVersion :: Lens' ListBotRecommendations Text Source #

The version of the bot that contains the bot recommendation list.

listBotRecommendations_localeId :: Lens' ListBotRecommendations Text Source #

The identifier of the language and locale of the bot recommendation list.

listBotRecommendationsResponse_botId :: Lens' ListBotRecommendationsResponse (Maybe Text) Source #

The unique identifier of the bot that contains the bot recommendation list.

listBotRecommendationsResponse_botRecommendationSummaries :: Lens' ListBotRecommendationsResponse (Maybe [BotRecommendationSummary]) Source #

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

listBotRecommendationsResponse_botVersion :: Lens' ListBotRecommendationsResponse (Maybe Text) Source #

The version of the bot that contains the bot recommendation list.

listBotRecommendationsResponse_localeId :: Lens' ListBotRecommendationsResponse (Maybe Text) Source #

The identifier of the language and locale of the bot recommendation list.

listBotRecommendationsResponse_nextToken :: Lens' ListBotRecommendationsResponse (Maybe Text) Source #

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

listBotRecommendationsResponse_httpStatus :: Lens' ListBotRecommendationsResponse Int Source #

The response's http status code.

ListBotVersions

listBotVersions_maxResults :: Lens' ListBotVersions (Maybe Natural) Source #

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.

listBotVersions_nextToken :: Lens' ListBotVersions (Maybe Text) Source #

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.

listBotVersions_sortBy :: Lens' ListBotVersions (Maybe BotVersionSortBy) Source #

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.

listBotVersions_botId :: Lens' ListBotVersions Text Source #

The identifier of the bot to list versions for.

listBotVersionsResponse_botId :: Lens' ListBotVersionsResponse (Maybe Text) Source #

The identifier of the bot to list versions for.

listBotVersionsResponse_botVersionSummaries :: Lens' ListBotVersionsResponse (Maybe [BotVersionSummary]) Source #

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

listBotVersionsResponse_nextToken :: Lens' ListBotVersionsResponse (Maybe Text) Source #

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

listBotVersionsResponse_httpStatus :: Lens' ListBotVersionsResponse Int Source #

The response's http status code.

ListBots

listBots_filters :: Lens' ListBots (Maybe (NonEmpty BotFilter)) Source #

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.

listBots_maxResults :: Lens' ListBots (Maybe Natural) Source #

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.

listBots_nextToken :: Lens' ListBots (Maybe Text) Source #

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.

listBots_sortBy :: Lens' ListBots (Maybe BotSortBy) Source #

Specifies sorting parameters for the list of bots. You can specify that the list be sorted by bot name in ascending or descending order.

listBotsResponse_botSummaries :: Lens' ListBotsResponse (Maybe [BotSummary]) Source #

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

listBotsResponse_nextToken :: Lens' ListBotsResponse (Maybe Text) Source #

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

listBotsResponse_httpStatus :: Lens' ListBotsResponse Int Source #

The response's http status code.

ListBuiltInIntents

listBuiltInIntents_maxResults :: Lens' ListBuiltInIntents (Maybe Natural) Source #

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.

listBuiltInIntents_nextToken :: Lens' ListBuiltInIntents (Maybe Text) Source #

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.

listBuiltInIntents_sortBy :: Lens' ListBuiltInIntents (Maybe BuiltInIntentSortBy) Source #

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.

listBuiltInIntents_localeId :: Lens' ListBuiltInIntents Text Source #

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.

listBuiltInIntentsResponse_builtInIntentSummaries :: Lens' ListBuiltInIntentsResponse (Maybe [BuiltInIntentSummary]) Source #

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

listBuiltInIntentsResponse_localeId :: Lens' ListBuiltInIntentsResponse (Maybe Text) Source #

The language and locale of the intents in the list.

listBuiltInIntentsResponse_nextToken :: Lens' ListBuiltInIntentsResponse (Maybe Text) Source #

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

listBuiltInIntentsResponse_httpStatus :: Lens' ListBuiltInIntentsResponse Int Source #

The response's http status code.

ListBuiltInSlotTypes

listBuiltInSlotTypes_maxResults :: Lens' ListBuiltInSlotTypes (Maybe Natural) Source #

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.

listBuiltInSlotTypes_nextToken :: Lens' ListBuiltInSlotTypes (Maybe Text) Source #

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.

listBuiltInSlotTypes_sortBy :: Lens' ListBuiltInSlotTypes (Maybe BuiltInSlotTypeSortBy) Source #

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.

listBuiltInSlotTypes_localeId :: Lens' ListBuiltInSlotTypes Text Source #

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.

listBuiltInSlotTypesResponse_builtInSlotTypeSummaries :: Lens' ListBuiltInSlotTypesResponse (Maybe [BuiltInSlotTypeSummary]) Source #

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

listBuiltInSlotTypesResponse_localeId :: Lens' ListBuiltInSlotTypesResponse (Maybe Text) Source #

The language and locale of the slot types in the list.

listBuiltInSlotTypesResponse_nextToken :: Lens' ListBuiltInSlotTypesResponse (Maybe Text) Source #

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

listBuiltInSlotTypesResponse_httpStatus :: Lens' ListBuiltInSlotTypesResponse Int Source #

The response's http status code.

ListCustomVocabularyItems

listCustomVocabularyItems_maxResults :: Lens' ListCustomVocabularyItems (Maybe Natural) Source #

The maximum results to the list custom vocabulary request.

listCustomVocabularyItems_nextToken :: Lens' ListCustomVocabularyItems (Maybe Text) Source #

The nextToken identifier to the list custom vocabulary request.

listCustomVocabularyItems_botId :: Lens' ListCustomVocabularyItems Text Source #

The unique identifier of the bot to the list custom vocabulary request.

listCustomVocabularyItems_botVersion :: Lens' ListCustomVocabularyItems Text Source #

The bot version of the bot to the list custom vocabulary request.

listCustomVocabularyItems_localeId :: Lens' ListCustomVocabularyItems Text Source #

The locale identifier of the bot to the list custom vocabulary request.

listCustomVocabularyItemsResponse_botId :: Lens' ListCustomVocabularyItemsResponse (Maybe Text) Source #

The unique identifier of the bot to the list custom vocabulary response.

listCustomVocabularyItemsResponse_botVersion :: Lens' ListCustomVocabularyItemsResponse (Maybe Text) Source #

The bot version of the bot to the list custom vocabulary response.

listCustomVocabularyItemsResponse_customVocabularyItems :: Lens' ListCustomVocabularyItemsResponse (Maybe [CustomVocabularyItem]) Source #

The custom vocabulary items from the list custom vocabulary response.

listCustomVocabularyItemsResponse_localeId :: Lens' ListCustomVocabularyItemsResponse (Maybe Text) Source #

The locale identifier of the bot to the list custom vocabulary response.

listCustomVocabularyItemsResponse_nextToken :: Lens' ListCustomVocabularyItemsResponse (Maybe Text) Source #

The nextToken identifier to the list custom vocabulary response.

listCustomVocabularyItemsResponse_httpStatus :: Lens' ListCustomVocabularyItemsResponse Int Source #

The response's http status code.

ListExports

listExports_botId :: Lens' ListExports (Maybe Text) Source #

The unique identifier that Amazon Lex assigned to the bot.

listExports_botVersion :: Lens' ListExports (Maybe Text) Source #

The version of the bot to list exports for.

listExports_filters :: Lens' ListExports (Maybe (NonEmpty ExportFilter)) Source #

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.

listExports_localeId :: Lens' ListExports (Maybe Text) Source #

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.

listExports_maxResults :: Lens' ListExports (Maybe Natural) Source #

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.

listExports_nextToken :: Lens' ListExports (Maybe Text) Source #

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.

listExports_sortBy :: Lens' ListExports (Maybe ExportSortBy) Source #

Determines the field that the list of exports is sorted by. You can sort by the LastUpdatedDateTime field in ascending or descending order.

listExportsResponse_botId :: Lens' ListExportsResponse (Maybe Text) Source #

The unique identifier assigned to the bot by Amazon Lex.

listExportsResponse_botVersion :: Lens' ListExportsResponse (Maybe Text) Source #

The version of the bot that was exported.

listExportsResponse_exportSummaries :: Lens' ListExportsResponse (Maybe [ExportSummary]) Source #

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

listExportsResponse_localeId :: Lens' ListExportsResponse (Maybe Text) Source #

The locale specified in the request.

listExportsResponse_nextToken :: Lens' ListExportsResponse (Maybe Text) Source #

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

listExportsResponse_httpStatus :: Lens' ListExportsResponse Int Source #

The response's http status code.

ListImports

listImports_botId :: Lens' ListImports (Maybe Text) Source #

The unique identifier that Amazon Lex assigned to the bot.

listImports_botVersion :: Lens' ListImports (Maybe Text) Source #

The version of the bot to list imports for.

listImports_filters :: Lens' ListImports (Maybe (NonEmpty ImportFilter)) Source #

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.

listImports_localeId :: Lens' ListImports (Maybe Text) Source #

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.

listImports_maxResults :: Lens' ListImports (Maybe Natural) Source #

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.

listImports_nextToken :: Lens' ListImports (Maybe Text) Source #

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.

listImports_sortBy :: Lens' ListImports (Maybe ImportSortBy) Source #

Determines the field that the list of imports is sorted by. You can sort by the LastUpdatedDateTime field in ascending or descending order.

listImportsResponse_botId :: Lens' ListImportsResponse (Maybe Text) Source #

The unique identifier assigned by Amazon Lex to the bot.

listImportsResponse_botVersion :: Lens' ListImportsResponse (Maybe Text) Source #

The version of the bot that was imported. It will always be DRAFT.

listImportsResponse_importSummaries :: Lens' ListImportsResponse (Maybe [ImportSummary]) Source #

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

listImportsResponse_localeId :: Lens' ListImportsResponse (Maybe Text) Source #

The locale specified in the request.

listImportsResponse_nextToken :: Lens' ListImportsResponse (Maybe Text) Source #

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

listImportsResponse_httpStatus :: Lens' ListImportsResponse Int Source #

The response's http status code.

ListIntents

listIntents_filters :: Lens' ListIntents (Maybe (NonEmpty IntentFilter)) Source #

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.

listIntents_maxResults :: Lens' ListIntents (Maybe Natural) Source #

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.

listIntents_nextToken :: Lens' ListIntents (Maybe Text) Source #

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.

listIntents_sortBy :: Lens' ListIntents (Maybe IntentSortBy) Source #

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.

listIntents_botId :: Lens' ListIntents Text Source #

The unique identifier of the bot that contains the intent.

listIntents_botVersion :: Lens' ListIntents Text Source #

The version of the bot that contains the intent.

listIntents_localeId :: Lens' ListIntents Text Source #

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.

listIntentsResponse_botId :: Lens' ListIntentsResponse (Maybe Text) Source #

The identifier of the bot that contains the intent.

listIntentsResponse_botVersion :: Lens' ListIntentsResponse (Maybe Text) Source #

The version of the bot that contains the intent.

listIntentsResponse_intentSummaries :: Lens' ListIntentsResponse (Maybe [IntentSummary]) Source #

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

listIntentsResponse_localeId :: Lens' ListIntentsResponse (Maybe Text) Source #

The language and locale of the intents in the list.

listIntentsResponse_nextToken :: Lens' ListIntentsResponse (Maybe Text) Source #

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

listIntentsResponse_httpStatus :: Lens' ListIntentsResponse Int Source #

The response's http status code.

ListRecommendedIntents

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.

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.

The unique identifier of the bot associated with the recommended intents.

The version of the bot that contains the recommended intents.

The identifier of the language and locale of the recommended intents.

The identifier of the bot recommendation that contains the recommended intents.

The unique identifier of the bot associated with the recommended intent.

The identifier of the bot recommendation that contains the recommended intent.

The version of the bot that contains the intent.

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.

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

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

The response's http status code.

ListSlotTypes

listSlotTypes_filters :: Lens' ListSlotTypes (Maybe (NonEmpty SlotTypeFilter)) Source #

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.

listSlotTypes_maxResults :: Lens' ListSlotTypes (Maybe Natural) Source #

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.

listSlotTypes_nextToken :: Lens' ListSlotTypes (Maybe Text) Source #

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.

listSlotTypes_sortBy :: Lens' ListSlotTypes (Maybe SlotTypeSortBy) Source #

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.

listSlotTypes_botId :: Lens' ListSlotTypes Text Source #

The unique identifier of the bot that contains the slot types.

listSlotTypes_botVersion :: Lens' ListSlotTypes Text Source #

The version of the bot that contains the slot type.

listSlotTypes_localeId :: Lens' ListSlotTypes Text Source #

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.

listSlotTypesResponse_botId :: Lens' ListSlotTypesResponse (Maybe Text) Source #

The identifier of the bot that contains the slot types.

listSlotTypesResponse_botVersion :: Lens' ListSlotTypesResponse (Maybe Text) Source #

The version of the bot that contains the slot types.

listSlotTypesResponse_localeId :: Lens' ListSlotTypesResponse (Maybe Text) Source #

The language and local of the slot types in the list.

listSlotTypesResponse_nextToken :: Lens' ListSlotTypesResponse (Maybe Text) Source #

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

listSlotTypesResponse_slotTypeSummaries :: Lens' ListSlotTypesResponse (Maybe [SlotTypeSummary]) Source #

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

listSlotTypesResponse_httpStatus :: Lens' ListSlotTypesResponse Int Source #

The response's http status code.

ListSlots

listSlots_filters :: Lens' ListSlots (Maybe (NonEmpty SlotFilter)) Source #

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.

listSlots_maxResults :: Lens' ListSlots (Maybe Natural) Source #

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.

listSlots_nextToken :: Lens' ListSlots (Maybe Text) Source #

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.

listSlots_sortBy :: Lens' ListSlots (Maybe SlotSortBy) Source #

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.

listSlots_botId :: Lens' ListSlots Text Source #

The identifier of the bot that contains the slot.

listSlots_botVersion :: Lens' ListSlots Text Source #

The version of the bot that contains the slot.

listSlots_localeId :: Lens' ListSlots Text Source #

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.

listSlots_intentId :: Lens' ListSlots Text Source #

The unique identifier of the intent that contains the slot.

listSlotsResponse_botId :: Lens' ListSlotsResponse (Maybe Text) Source #

The identifier of the bot that contains the slots.

listSlotsResponse_botVersion :: Lens' ListSlotsResponse (Maybe Text) Source #

The version of the bot that contains the slots.

listSlotsResponse_intentId :: Lens' ListSlotsResponse (Maybe Text) Source #

The identifier of the intent that contains the slots.

listSlotsResponse_localeId :: Lens' ListSlotsResponse (Maybe Text) Source #

The language and locale of the slots in the list.

listSlotsResponse_nextToken :: Lens' ListSlotsResponse (Maybe Text) Source #

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

listSlotsResponse_slotSummaries :: Lens' ListSlotsResponse (Maybe [SlotSummary]) Source #

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

listSlotsResponse_httpStatus :: Lens' ListSlotsResponse Int Source #

The response's http status code.

ListTagsForResource

listTagsForResource_resourceARN :: Lens' ListTagsForResource Text Source #

The Amazon Resource Name (ARN) of the resource to get a list of tags for.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text)) Source #

The tags associated with a resource.

listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #

The response's http status code.

SearchAssociatedTranscripts

searchAssociatedTranscripts_maxResults :: Lens' SearchAssociatedTranscripts (Maybe Natural) Source #

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.

searchAssociatedTranscripts_nextIndex :: Lens' SearchAssociatedTranscripts (Maybe Natural) Source #

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.

searchAssociatedTranscripts_searchOrder :: Lens' SearchAssociatedTranscripts (Maybe SearchOrder) Source #

How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.

searchAssociatedTranscripts_botId :: Lens' SearchAssociatedTranscripts Text Source #

The unique identifier of the bot associated with the transcripts that you are searching.

searchAssociatedTranscripts_botVersion :: Lens' SearchAssociatedTranscripts Text Source #

The version of the bot containing the transcripts that you are searching.

searchAssociatedTranscripts_localeId :: Lens' SearchAssociatedTranscripts Text Source #

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

searchAssociatedTranscripts_botRecommendationId :: Lens' SearchAssociatedTranscripts Text Source #

The unique identifier of the bot recommendation associated with the transcripts to search.

searchAssociatedTranscripts_filters :: Lens' SearchAssociatedTranscripts (NonEmpty AssociatedTranscriptFilter) Source #

A list of filter objects.

searchAssociatedTranscriptsResponse_associatedTranscripts :: Lens' SearchAssociatedTranscriptsResponse (Maybe [AssociatedTranscript]) Source #

The object that contains the associated transcript that meet the criteria you specified.

searchAssociatedTranscriptsResponse_botId :: Lens' SearchAssociatedTranscriptsResponse (Maybe Text) Source #

The unique identifier of the bot associated with the transcripts that you are searching.

searchAssociatedTranscriptsResponse_botRecommendationId :: Lens' SearchAssociatedTranscriptsResponse (Maybe Text) Source #

The unique identifier of the bot recommendation associated with the transcripts to search.

searchAssociatedTranscriptsResponse_botVersion :: Lens' SearchAssociatedTranscriptsResponse (Maybe Text) Source #

The version of the bot containing the transcripts that you are searching.

searchAssociatedTranscriptsResponse_localeId :: Lens' SearchAssociatedTranscriptsResponse (Maybe Text) Source #

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

searchAssociatedTranscriptsResponse_nextIndex :: Lens' SearchAssociatedTranscriptsResponse (Maybe Natural) Source #

A index that indicates whether there are more results to return in a response to the SearchAssociatedTranscripts operation. If the nextIndex field is present, you send the contents as the nextIndex parameter of a SearchAssociatedTranscriptsRequest operation to get the next page of results.

searchAssociatedTranscriptsResponse_totalResults :: Lens' SearchAssociatedTranscriptsResponse (Maybe Natural) Source #

The total number of transcripts returned by the search.

searchAssociatedTranscriptsResponse_httpStatus :: Lens' SearchAssociatedTranscriptsResponse Int Source #

The response's http status code.

StartBotRecommendation

startBotRecommendation_encryptionSetting :: Lens' StartBotRecommendation (Maybe EncryptionSetting) Source #

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.

startBotRecommendation_botId :: Lens' StartBotRecommendation Text Source #

The unique identifier of the bot containing the bot recommendation.

startBotRecommendation_botVersion :: Lens' StartBotRecommendation Text Source #

The version of the bot containing the bot recommendation.

startBotRecommendation_localeId :: Lens' StartBotRecommendation Text Source #

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

startBotRecommendation_transcriptSourceSetting :: Lens' StartBotRecommendation TranscriptSourceSetting Source #

The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.

startBotRecommendationResponse_botId :: Lens' StartBotRecommendationResponse (Maybe Text) Source #

The unique identifier of the bot containing the bot recommendation.

startBotRecommendationResponse_botRecommendationId :: Lens' StartBotRecommendationResponse (Maybe Text) Source #

The identifier of the bot recommendation that you have created.

startBotRecommendationResponse_botRecommendationStatus :: Lens' StartBotRecommendationResponse (Maybe BotRecommendationStatus) Source #

The status of the bot recommendation.

If the status is Failed, then the reasons for the failure are listed in the failureReasons field.

startBotRecommendationResponse_botVersion :: Lens' StartBotRecommendationResponse (Maybe Text) Source #

The version of the bot containing the bot recommendation.

startBotRecommendationResponse_creationDateTime :: Lens' StartBotRecommendationResponse (Maybe UTCTime) Source #

A timestamp of the date and time that the bot recommendation was created.

startBotRecommendationResponse_encryptionSetting :: Lens' StartBotRecommendationResponse (Maybe EncryptionSetting) Source #

The object representing the passwords that were used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.

startBotRecommendationResponse_localeId :: Lens' StartBotRecommendationResponse (Maybe Text) Source #

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

startBotRecommendationResponse_transcriptSourceSetting :: Lens' StartBotRecommendationResponse (Maybe TranscriptSourceSetting) Source #

The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.

startBotRecommendationResponse_httpStatus :: Lens' StartBotRecommendationResponse Int Source #

The response's http status code.

StartImport

startImport_filePassword :: Lens' StartImport (Maybe Text) Source #

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.

startImport_importId :: Lens' StartImport Text Source #

The unique identifier for the import. It is included in the response from the CreateUploadUrl operation.

startImport_resourceSpecification :: Lens' StartImport ImportResourceSpecification Source #

Parameters for creating the bot, bot locale or custom vocabulary.

startImport_mergeStrategy :: Lens' StartImport MergeStrategy Source #

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.

startImportResponse_creationDateTime :: Lens' StartImportResponse (Maybe UTCTime) Source #

The date and time that the import request was created.

startImportResponse_importId :: Lens' StartImportResponse (Maybe Text) Source #

A unique identifier for the import.

startImportResponse_importStatus :: Lens' StartImportResponse (Maybe ImportStatus) Source #

The current status of the import. When the status is Complete the bot, bot alias, or custom vocabulary is ready to use.

startImportResponse_mergeStrategy :: Lens' StartImportResponse (Maybe MergeStrategy) Source #

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.

startImportResponse_resourceSpecification :: Lens' StartImportResponse (Maybe ImportResourceSpecification) Source #

The parameters used when importing the resource.

startImportResponse_httpStatus :: Lens' StartImportResponse Int Source #

The response's http status code.

StopBotRecommendation

stopBotRecommendation_botId :: Lens' StopBotRecommendation Text Source #

The unique identifier of the bot containing the bot recommendation to be stopped.

stopBotRecommendation_botVersion :: Lens' StopBotRecommendation Text Source #

The version of the bot containing the bot recommendation.

stopBotRecommendation_localeId :: Lens' StopBotRecommendation Text Source #

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

stopBotRecommendation_botRecommendationId :: Lens' StopBotRecommendation Text Source #

The unique identifier of the bot recommendation to be stopped.

stopBotRecommendationResponse_botId :: Lens' StopBotRecommendationResponse (Maybe Text) Source #

The unique identifier of the bot containing the bot recommendation that is being stopped.

stopBotRecommendationResponse_botRecommendationId :: Lens' StopBotRecommendationResponse (Maybe Text) Source #

The unique identifier of the bot recommendation that is being stopped.

stopBotRecommendationResponse_botRecommendationStatus :: Lens' StopBotRecommendationResponse (Maybe BotRecommendationStatus) Source #

The status of the bot recommendation. If the status is Failed, then the reasons for the failure are listed in the failureReasons field.

stopBotRecommendationResponse_botVersion :: Lens' StopBotRecommendationResponse (Maybe Text) Source #

The version of the bot containing the recommendation that is being stopped.

stopBotRecommendationResponse_localeId :: Lens' StopBotRecommendationResponse (Maybe Text) Source #

The identifier of the language and locale of the bot response to stop. The string must match one of the supported locales. For more information, see Supported languages

stopBotRecommendationResponse_httpStatus :: Lens' StopBotRecommendationResponse Int Source #

The response's http status code.

TagResource

tagResource_resourceARN :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) of the bot, bot alias, or bot channel to tag.

tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #

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.

tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #

The response's http status code.

UntagResource

untagResource_resourceARN :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) of the resource to remove the tags from.

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

A list of tag keys to remove from the resource. If a tag key does not exist on the resource, it is ignored.

untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int Source #

The response's http status code.

UpdateBot

updateBot_description :: Lens' UpdateBot (Maybe Text) Source #

A description of the bot.

updateBot_botId :: Lens' UpdateBot Text Source #

The unique identifier of the bot to update. This identifier is returned by the CreateBot operation.

updateBot_botName :: Lens' UpdateBot Text Source #

The new name of the bot. The name must be unique in the account that creates the bot.

updateBot_roleArn :: Lens' UpdateBot Text Source #

The Amazon Resource Name (ARN) of an IAM role that has permissions to access the bot.

updateBot_dataPrivacy :: Lens' UpdateBot DataPrivacy Source #

Provides information on additional privacy protections Amazon Lex should use with the bot's data.

updateBot_idleSessionTTLInSeconds :: Lens' UpdateBot Natural Source #

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.

updateBotResponse_botId :: Lens' UpdateBotResponse (Maybe Text) Source #

The unique identifier of the bot that was updated.

updateBotResponse_botName :: Lens' UpdateBotResponse (Maybe Text) Source #

The name of the bot after the update.

updateBotResponse_botStatus :: Lens' UpdateBotResponse (Maybe BotStatus) Source #

Shows the current status of the bot. The bot is first in the Creating status. Once the bot is read for use, it changes to the Available status. After the bot is created, you can use the DRAFT version of the bot.

updateBotResponse_creationDateTime :: Lens' UpdateBotResponse (Maybe UTCTime) Source #

A timestamp of the date and time that the bot was created.

updateBotResponse_dataPrivacy :: Lens' UpdateBotResponse (Maybe DataPrivacy) Source #

The data privacy settings for the bot after the update.

updateBotResponse_description :: Lens' UpdateBotResponse (Maybe Text) Source #

The description of the bot after the update.

updateBotResponse_idleSessionTTLInSeconds :: Lens' UpdateBotResponse (Maybe Natural) Source #

The session timeout, in seconds, for the bot after the update.

updateBotResponse_lastUpdatedDateTime :: Lens' UpdateBotResponse (Maybe UTCTime) Source #

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

updateBotResponse_roleArn :: Lens' UpdateBotResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM role used by the bot after the update.

updateBotResponse_httpStatus :: Lens' UpdateBotResponse Int Source #

The response's http status code.

UpdateBotAlias

updateBotAlias_botAliasLocaleSettings :: Lens' UpdateBotAlias (Maybe (HashMap Text BotAliasLocaleSettings)) Source #

The new Lambda functions to use in each locale for the bot alias.

updateBotAlias_botVersion :: Lens' UpdateBotAlias (Maybe Text) Source #

The new bot version to assign to the bot alias.

updateBotAlias_conversationLogSettings :: Lens' UpdateBotAlias (Maybe ConversationLogSettings) Source #

The new settings for storing conversation logs in Amazon CloudWatch Logs and Amazon S3 buckets.

updateBotAlias_description :: Lens' UpdateBotAlias (Maybe Text) Source #

The new description to assign to the bot alias.

updateBotAlias_sentimentAnalysisSettings :: Lens' UpdateBotAlias (Maybe SentimentAnalysisSettings) Source #

Undocumented member.

updateBotAlias_botAliasId :: Lens' UpdateBotAlias Text Source #

The unique identifier of the bot alias.

updateBotAlias_botAliasName :: Lens' UpdateBotAlias Text Source #

The new name to assign to the bot alias.

updateBotAlias_botId :: Lens' UpdateBotAlias Text Source #

The identifier of the bot with the updated alias.

updateBotAliasResponse_botAliasId :: Lens' UpdateBotAliasResponse (Maybe Text) Source #

The identifier of the updated bot alias.

updateBotAliasResponse_botAliasLocaleSettings :: Lens' UpdateBotAliasResponse (Maybe (HashMap Text BotAliasLocaleSettings)) Source #

The updated Lambda functions to use in each locale for the bot alias.

updateBotAliasResponse_botAliasName :: Lens' UpdateBotAliasResponse (Maybe Text) Source #

The updated name of the bot alias.

updateBotAliasResponse_botAliasStatus :: Lens' UpdateBotAliasResponse (Maybe BotAliasStatus) Source #

The current status of the bot alias. When the status is Available the alias is ready for use.

updateBotAliasResponse_botId :: Lens' UpdateBotAliasResponse (Maybe Text) Source #

The identifier of the bot with the updated alias.

updateBotAliasResponse_botVersion :: Lens' UpdateBotAliasResponse (Maybe Text) Source #

The updated version of the bot that the alias points to.

updateBotAliasResponse_conversationLogSettings :: Lens' UpdateBotAliasResponse (Maybe ConversationLogSettings) Source #

The updated settings for storing conversation logs in Amazon CloudWatch Logs and Amazon S3 buckets.

updateBotAliasResponse_creationDateTime :: Lens' UpdateBotAliasResponse (Maybe UTCTime) Source #

A timestamp of the date and time that the bot was created.

updateBotAliasResponse_description :: Lens' UpdateBotAliasResponse (Maybe Text) Source #

The updated description of the bot alias.

updateBotAliasResponse_lastUpdatedDateTime :: Lens' UpdateBotAliasResponse (Maybe UTCTime) Source #

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

updateBotAliasResponse_sentimentAnalysisSettings :: Lens' UpdateBotAliasResponse (Maybe SentimentAnalysisSettings) Source #

Undocumented member.

updateBotAliasResponse_httpStatus :: Lens' UpdateBotAliasResponse Int Source #

The response's http status code.

UpdateBotLocale

updateBotLocale_description :: Lens' UpdateBotLocale (Maybe Text) Source #

The new description of the locale.

updateBotLocale_voiceSettings :: Lens' UpdateBotLocale (Maybe VoiceSettings) Source #

The new Amazon Polly voice Amazon Lex should use for voice interaction with the user.

updateBotLocale_botId :: Lens' UpdateBotLocale Text Source #

The unique identifier of the bot that contains the locale.

updateBotLocale_botVersion :: Lens' UpdateBotLocale Text Source #

The version of the bot that contains the locale to be updated. The version can only be the DRAFT version.

updateBotLocale_localeId :: Lens' UpdateBotLocale Text Source #

The identifier of the language and locale to update. The string must match one of the supported locales. For more information, see Supported languages.

updateBotLocale_nluIntentConfidenceThreshold :: Lens' UpdateBotLocale Double Source #

The new confidence threshold where Amazon Lex inserts the AMAZON.FallbackIntent and AMAZON.KendraSearchIntent intents in the list of possible intents for an utterance.

updateBotLocaleResponse_botId :: Lens' UpdateBotLocaleResponse (Maybe Text) Source #

The identifier of the bot that contains the updated locale.

updateBotLocaleResponse_botLocaleStatus :: Lens' UpdateBotLocaleResponse (Maybe BotLocaleStatus) Source #

The current status of the locale. When the bot status is Built the locale is ready for use.

updateBotLocaleResponse_botVersion :: Lens' UpdateBotLocaleResponse (Maybe Text) Source #

The version of the bot that contains the updated locale.

updateBotLocaleResponse_creationDateTime :: Lens' UpdateBotLocaleResponse (Maybe UTCTime) Source #

A timestamp of the date and time that the locale was created.

updateBotLocaleResponse_description :: Lens' UpdateBotLocaleResponse (Maybe Text) Source #

The updated description of the locale.

updateBotLocaleResponse_failureReasons :: Lens' UpdateBotLocaleResponse (Maybe [Text]) Source #

If the botLocaleStatus is Failed, the failureReasons field lists the errors that occurred while building the bot.

updateBotLocaleResponse_lastUpdatedDateTime :: Lens' UpdateBotLocaleResponse (Maybe UTCTime) Source #

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

updateBotLocaleResponse_localeId :: Lens' UpdateBotLocaleResponse (Maybe Text) Source #

The language and locale of the updated bot locale.

updateBotLocaleResponse_localeName :: Lens' UpdateBotLocaleResponse (Maybe Text) Source #

The updated locale name for the locale.

updateBotLocaleResponse_nluIntentConfidenceThreshold :: Lens' UpdateBotLocaleResponse (Maybe Double) Source #

The updated confidence threshold for inserting the AMAZON.FallbackIntent and AMAZON.KendraSearchIntent intents in the list of possible intents for an utterance.

updateBotLocaleResponse_recommendedActions :: Lens' UpdateBotLocaleResponse (Maybe [Text]) Source #

Recommended actions to take to resolve an error in the failureReasons field.

updateBotLocaleResponse_voiceSettings :: Lens' UpdateBotLocaleResponse (Maybe VoiceSettings) Source #

The updated Amazon Polly voice to use for voice interaction with the user.

updateBotLocaleResponse_httpStatus :: Lens' UpdateBotLocaleResponse Int Source #

The response's http status code.

UpdateBotRecommendation

updateBotRecommendation_botId :: Lens' UpdateBotRecommendation Text Source #

The unique identifier of the bot containing the bot recommendation to be updated.

updateBotRecommendation_botVersion :: Lens' UpdateBotRecommendation Text Source #

The version of the bot containing the bot recommendation to be updated.

updateBotRecommendation_localeId :: Lens' UpdateBotRecommendation Text Source #

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

updateBotRecommendation_botRecommendationId :: Lens' UpdateBotRecommendation Text Source #

The unique identifier of the bot recommendation to be updated.

updateBotRecommendation_encryptionSetting :: Lens' UpdateBotRecommendation EncryptionSetting Source #

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.

updateBotRecommendationResponse_botId :: Lens' UpdateBotRecommendationResponse (Maybe Text) Source #

The unique identifier of the bot containing the bot recommendation that has been updated.

updateBotRecommendationResponse_botRecommendationId :: Lens' UpdateBotRecommendationResponse (Maybe Text) Source #

The unique identifier of the bot recommendation to be updated.

updateBotRecommendationResponse_botRecommendationStatus :: Lens' UpdateBotRecommendationResponse (Maybe BotRecommendationStatus) Source #

The status of the bot recommendation.

If the status is Failed, then the reasons for the failure are listed in the failureReasons field.

updateBotRecommendationResponse_botVersion :: Lens' UpdateBotRecommendationResponse (Maybe Text) Source #

The version of the bot containing the bot recommendation that has been updated.

updateBotRecommendationResponse_creationDateTime :: Lens' UpdateBotRecommendationResponse (Maybe UTCTime) Source #

A timestamp of the date and time that the bot recommendation was created.

updateBotRecommendationResponse_encryptionSetting :: Lens' UpdateBotRecommendationResponse (Maybe EncryptionSetting) Source #

The object representing the passwords that were used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.

updateBotRecommendationResponse_lastUpdatedDateTime :: Lens' UpdateBotRecommendationResponse (Maybe UTCTime) Source #

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

updateBotRecommendationResponse_localeId :: Lens' UpdateBotRecommendationResponse (Maybe Text) Source #

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

updateBotRecommendationResponse_transcriptSourceSetting :: Lens' UpdateBotRecommendationResponse (Maybe TranscriptSourceSetting) Source #

The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.

updateBotRecommendationResponse_httpStatus :: Lens' UpdateBotRecommendationResponse Int Source #

The response's http status code.

UpdateExport

updateExport_filePassword :: Lens' UpdateExport (Maybe Text) Source #

The new password to use to encrypt the export zip archive.

updateExport_exportId :: Lens' UpdateExport Text Source #

The unique identifier Amazon Lex assigned to the export.

updateExportResponse_creationDateTime :: Lens' UpdateExportResponse (Maybe UTCTime) Source #

The date and time that the export was created.

updateExportResponse_exportId :: Lens' UpdateExportResponse (Maybe Text) Source #

The unique identifier Amazon Lex assigned to the export.

updateExportResponse_exportStatus :: Lens' UpdateExportResponse (Maybe ExportStatus) Source #

The status of the export. When the status is Completed the export archive is available for download.

updateExportResponse_fileFormat :: Lens' UpdateExportResponse (Maybe ImportExportFileFormat) Source #

The file format used for the files that define the resource. The TSV format is required to export a custom vocabulary only; otherwise use LexJson format.

updateExportResponse_lastUpdatedDateTime :: Lens' UpdateExportResponse (Maybe UTCTime) Source #

The date and time that the export was last updated.

updateExportResponse_resourceSpecification :: Lens' UpdateExportResponse (Maybe ExportResourceSpecification) Source #

A description of the type of resource that was exported, either a bot or a bot locale.

updateExportResponse_httpStatus :: Lens' UpdateExportResponse Int Source #

The response's http status code.

UpdateIntent

updateIntent_description :: Lens' UpdateIntent (Maybe Text) Source #

The new description of the intent.

updateIntent_dialogCodeHook :: Lens' UpdateIntent (Maybe DialogCodeHookSettings) Source #

The new Lambda function to use between each turn of the conversation with the bot.

updateIntent_fulfillmentCodeHook :: Lens' UpdateIntent (Maybe FulfillmentCodeHookSettings) Source #

The new Lambda function to call when all of the intents required slots are provided and the intent is ready for fulfillment.

updateIntent_initialResponseSetting :: Lens' UpdateIntent (Maybe InitialResponseSetting) Source #

updateIntent_inputContexts :: Lens' UpdateIntent (Maybe [InputContext]) Source #

A new list of contexts that must be active in order for Amazon Lex to consider the intent.

updateIntent_intentClosingSetting :: Lens' UpdateIntent (Maybe IntentClosingSetting) Source #

The new response that Amazon Lex sends the user when the intent is closed.

updateIntent_intentConfirmationSetting :: Lens' UpdateIntent (Maybe IntentConfirmationSetting) Source #

New prompts that Amazon Lex sends to the user to confirm the completion of an intent.

updateIntent_kendraConfiguration :: Lens' UpdateIntent (Maybe KendraConfiguration) Source #

New configuration settings for connecting to an Amazon Kendra index.

updateIntent_outputContexts :: Lens' UpdateIntent (Maybe [OutputContext]) Source #

A new list of contexts that Amazon Lex activates when the intent is fulfilled.

updateIntent_parentIntentSignature :: Lens' UpdateIntent (Maybe Text) Source #

The signature of the new built-in intent to use as the parent of this intent.

updateIntent_sampleUtterances :: Lens' UpdateIntent (Maybe [SampleUtterance]) Source #

New utterances used to invoke the intent.

updateIntent_slotPriorities :: Lens' UpdateIntent (Maybe [SlotPriority]) Source #

A new list of slots and their priorities that are contained by the intent.

updateIntent_intentId :: Lens' UpdateIntent Text Source #

The unique identifier of the intent to update.

updateIntent_intentName :: Lens' UpdateIntent Text Source #

The new name for the intent.

updateIntent_botId :: Lens' UpdateIntent Text Source #

The identifier of the bot that contains the intent.

updateIntent_botVersion :: Lens' UpdateIntent Text Source #

The version of the bot that contains the intent. Must be DRAFT.

updateIntent_localeId :: Lens' UpdateIntent Text Source #

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.

updateIntentResponse_botId :: Lens' UpdateIntentResponse (Maybe Text) Source #

The identifier of the bot that contains the intent.

updateIntentResponse_botVersion :: Lens' UpdateIntentResponse (Maybe Text) Source #

The version of the bot that contains the intent. Will always be DRAFT.

updateIntentResponse_creationDateTime :: Lens' UpdateIntentResponse (Maybe UTCTime) Source #

A timestamp of when the intent was created.

updateIntentResponse_description :: Lens' UpdateIntentResponse (Maybe Text) Source #

The updated description of the intent.

updateIntentResponse_dialogCodeHook :: Lens' UpdateIntentResponse (Maybe DialogCodeHookSettings) Source #

The updated Lambda function called during each turn of the conversation with the user.

updateIntentResponse_fulfillmentCodeHook :: Lens' UpdateIntentResponse (Maybe FulfillmentCodeHookSettings) Source #

The updated Lambda function called when the intent is ready for fulfillment.

updateIntentResponse_initialResponseSetting :: Lens' UpdateIntentResponse (Maybe InitialResponseSetting) Source #

updateIntentResponse_inputContexts :: Lens' UpdateIntentResponse (Maybe [InputContext]) Source #

The updated list of contexts that must be active for the intent to be considered by Amazon Lex.

updateIntentResponse_intentClosingSetting :: Lens' UpdateIntentResponse (Maybe IntentClosingSetting) Source #

The updated response that Amazon Lex sends the user when the intent is closed.

updateIntentResponse_intentConfirmationSetting :: Lens' UpdateIntentResponse (Maybe IntentConfirmationSetting) Source #

The updated prompts that Amazon Lex sends to the user to confirm the completion of an intent.

updateIntentResponse_intentId :: Lens' UpdateIntentResponse (Maybe Text) Source #

The identifier of the intent that was updated.

updateIntentResponse_intentName :: Lens' UpdateIntentResponse (Maybe Text) Source #

The updated name of the intent.

updateIntentResponse_kendraConfiguration :: Lens' UpdateIntentResponse (Maybe KendraConfiguration) Source #

The updated configuration for connecting to an Amazon Kendra index with the AMAZON.KendraSearchIntent intent.

updateIntentResponse_lastUpdatedDateTime :: Lens' UpdateIntentResponse (Maybe UTCTime) Source #

A timestamp of the last time that the intent was modified.

updateIntentResponse_localeId :: Lens' UpdateIntentResponse (Maybe Text) Source #

The updated language and locale of the intent.

updateIntentResponse_outputContexts :: Lens' UpdateIntentResponse (Maybe [OutputContext]) Source #

The updated list of contexts that Amazon Lex activates when the intent is fulfilled.

updateIntentResponse_parentIntentSignature :: Lens' UpdateIntentResponse (Maybe Text) Source #

The updated built-in intent that is the parent of this intent.

updateIntentResponse_sampleUtterances :: Lens' UpdateIntentResponse (Maybe [SampleUtterance]) Source #

The updated list of sample utterances for the intent.

updateIntentResponse_slotPriorities :: Lens' UpdateIntentResponse (Maybe [SlotPriority]) Source #

The updated list of slots and their priorities that are elicited from the user for the intent.

updateIntentResponse_httpStatus :: Lens' UpdateIntentResponse Int Source #

The response's http status code.

UpdateResourcePolicy

updateResourcePolicy_expectedRevisionId :: Lens' UpdateResourcePolicy (Maybe Text) Source #

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.

updateResourcePolicy_resourceArn :: Lens' UpdateResourcePolicy Text Source #

The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.

updateResourcePolicy_policy :: Lens' UpdateResourcePolicy Text Source #

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.

updateResourcePolicyResponse_resourceArn :: Lens' UpdateResourcePolicyResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.

updateResourcePolicyResponse_revisionId :: Lens' UpdateResourcePolicyResponse (Maybe Text) Source #

The current revision of the resource policy. Use the revision ID to make sure that you are updating the most current version of a resource policy when you add a policy statement to a resource, delete a resource, or update a resource.

updateResourcePolicyResponse_httpStatus :: Lens' UpdateResourcePolicyResponse Int Source #

The response's http status code.

UpdateSlot

updateSlot_description :: Lens' UpdateSlot (Maybe Text) Source #

The new description for the slot.

updateSlot_multipleValuesSetting :: Lens' UpdateSlot (Maybe MultipleValuesSetting) Source #

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.

updateSlot_obfuscationSetting :: Lens' UpdateSlot (Maybe ObfuscationSetting) Source #

New settings that determine how slot values are formatted in Amazon CloudWatch logs.

updateSlot_slotTypeId :: Lens' UpdateSlot (Maybe Text) Source #

The unique identifier of the new slot type to associate with this slot.

updateSlot_subSlotSetting :: Lens' UpdateSlot (Maybe SubSlotSetting) Source #

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

updateSlot_slotId :: Lens' UpdateSlot Text Source #

The unique identifier for the slot to update.

updateSlot_slotName :: Lens' UpdateSlot Text Source #

The new name for the slot.

updateSlot_valueElicitationSetting :: Lens' UpdateSlot SlotValueElicitationSetting Source #

A new set of prompts that Amazon Lex sends to the user to elicit a response the provides a value for the slot.

updateSlot_botId :: Lens' UpdateSlot Text Source #

The unique identifier of the bot that contains the slot.

updateSlot_botVersion :: Lens' UpdateSlot Text Source #

The version of the bot that contains the slot. Must always be DRAFT.

updateSlot_localeId :: Lens' UpdateSlot Text Source #

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.

updateSlot_intentId :: Lens' UpdateSlot Text Source #

The identifier of the intent that contains the slot.

updateSlotResponse_botId :: Lens' UpdateSlotResponse (Maybe Text) Source #

The identifier of the bot that contains the slot.

updateSlotResponse_botVersion :: Lens' UpdateSlotResponse (Maybe Text) Source #

The identifier of the slot version that contains the slot. Will always be DRAFT.

updateSlotResponse_creationDateTime :: Lens' UpdateSlotResponse (Maybe UTCTime) Source #

The timestamp of the date and time that the slot was created.

updateSlotResponse_description :: Lens' UpdateSlotResponse (Maybe Text) Source #

The updated description of the bot.

updateSlotResponse_intentId :: Lens' UpdateSlotResponse (Maybe Text) Source #

The intent that contains the slot.

updateSlotResponse_lastUpdatedDateTime :: Lens' UpdateSlotResponse (Maybe UTCTime) Source #

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

updateSlotResponse_localeId :: Lens' UpdateSlotResponse (Maybe Text) Source #

The locale that contains the slot.

updateSlotResponse_multipleValuesSetting :: Lens' UpdateSlotResponse (Maybe MultipleValuesSetting) Source #

Indicates whether the slot accepts multiple values in one response.

updateSlotResponse_obfuscationSetting :: Lens' UpdateSlotResponse (Maybe ObfuscationSetting) Source #

The updated setting that determines whether the slot value is obfuscated in the Amazon CloudWatch logs.

updateSlotResponse_slotId :: Lens' UpdateSlotResponse (Maybe Text) Source #

The unique identifier of the slot that was updated.

updateSlotResponse_slotName :: Lens' UpdateSlotResponse (Maybe Text) Source #

The updated name of the slot.

updateSlotResponse_slotTypeId :: Lens' UpdateSlotResponse (Maybe Text) Source #

The updated identifier of the slot type that provides values for the slot.

updateSlotResponse_subSlotSetting :: Lens' UpdateSlotResponse (Maybe SubSlotSetting) Source #

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

updateSlotResponse_valueElicitationSetting :: Lens' UpdateSlotResponse (Maybe SlotValueElicitationSetting) Source #

The updated prompts that Amazon Lex sends to the user to elicit a response that provides a value for the slot.

updateSlotResponse_httpStatus :: Lens' UpdateSlotResponse Int Source #

The response's http status code.

UpdateSlotType

updateSlotType_compositeSlotTypeSetting :: Lens' UpdateSlotType (Maybe CompositeSlotTypeSetting) Source #

Specifications for a composite slot type.

updateSlotType_description :: Lens' UpdateSlotType (Maybe Text) Source #

The new description of the slot type.

updateSlotType_externalSourceSetting :: Lens' UpdateSlotType (Maybe ExternalSourceSetting) Source #

Undocumented member.

updateSlotType_parentSlotTypeSignature :: Lens' UpdateSlotType (Maybe Text) Source #

The new built-in slot type that should be used as the parent of this slot type.

updateSlotType_slotTypeValues :: Lens' UpdateSlotType (Maybe (NonEmpty SlotTypeValue)) Source #

A new list of values and their optional synonyms that define the values that the slot type can take.

updateSlotType_valueSelectionSetting :: Lens' UpdateSlotType (Maybe SlotValueSelectionSetting) Source #

The strategy that Amazon Lex should use when deciding on a value from the list of slot type values.

updateSlotType_slotTypeId :: Lens' UpdateSlotType Text Source #

The unique identifier of the slot type to update.

updateSlotType_slotTypeName :: Lens' UpdateSlotType Text Source #

The new name of the slot type.

updateSlotType_botId :: Lens' UpdateSlotType Text Source #

The identifier of the bot that contains the slot type.

updateSlotType_botVersion :: Lens' UpdateSlotType Text Source #

The version of the bot that contains the slot type. Must be DRAFT.

updateSlotType_localeId :: Lens' UpdateSlotType Text Source #

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.

updateSlotTypeResponse_botId :: Lens' UpdateSlotTypeResponse (Maybe Text) Source #

The identifier of the bot that contains the slot type.

updateSlotTypeResponse_botVersion :: Lens' UpdateSlotTypeResponse (Maybe Text) Source #

The version of the bot that contains the slot type. This is always DRAFT.

updateSlotTypeResponse_compositeSlotTypeSetting :: Lens' UpdateSlotTypeResponse (Maybe CompositeSlotTypeSetting) Source #

Specifications for a composite slot type.

updateSlotTypeResponse_creationDateTime :: Lens' UpdateSlotTypeResponse (Maybe UTCTime) Source #

The timestamp of the date and time that the slot type was created.

updateSlotTypeResponse_description :: Lens' UpdateSlotTypeResponse (Maybe Text) Source #

The updated description of the slot type.

updateSlotTypeResponse_externalSourceSetting :: Lens' UpdateSlotTypeResponse (Maybe ExternalSourceSetting) Source #

Undocumented member.

updateSlotTypeResponse_lastUpdatedDateTime :: Lens' UpdateSlotTypeResponse (Maybe UTCTime) Source #

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

updateSlotTypeResponse_localeId :: Lens' UpdateSlotTypeResponse (Maybe Text) Source #

The language and locale of the updated slot type.

updateSlotTypeResponse_parentSlotTypeSignature :: Lens' UpdateSlotTypeResponse (Maybe Text) Source #

The updated signature of the built-in slot type that is the parent of this slot type.

updateSlotTypeResponse_slotTypeId :: Lens' UpdateSlotTypeResponse (Maybe Text) Source #

The unique identifier of the updated slot type.

updateSlotTypeResponse_slotTypeName :: Lens' UpdateSlotTypeResponse (Maybe Text) Source #

The updated name of the slot type.

updateSlotTypeResponse_slotTypeValues :: Lens' UpdateSlotTypeResponse (Maybe (NonEmpty SlotTypeValue)) Source #

The updated values that the slot type provides.

updateSlotTypeResponse_valueSelectionSetting :: Lens' UpdateSlotTypeResponse (Maybe SlotValueSelectionSetting) Source #

The updated strategy that Amazon Lex uses to determine which value to select from the slot type.

updateSlotTypeResponse_httpStatus :: Lens' UpdateSlotTypeResponse Int Source #

The response's http status code.

Types

AdvancedRecognitionSetting

advancedRecognitionSetting_audioRecognitionStrategy :: Lens' AdvancedRecognitionSetting (Maybe AudioRecognitionStrategy) Source #

Enables using the slot values as a custom vocabulary for recognizing user utterances.

AggregatedUtterancesFilter

aggregatedUtterancesFilter_name :: Lens' AggregatedUtterancesFilter AggregatedUtterancesFilterName Source #

The name of the field to filter the utterance list.

aggregatedUtterancesFilter_values :: Lens' AggregatedUtterancesFilter (NonEmpty Text) Source #

The value to use for filtering the list of bots.

aggregatedUtterancesFilter_operator :: Lens' AggregatedUtterancesFilter AggregatedUtterancesFilterOperator Source #

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

AggregatedUtterancesSortBy

aggregatedUtterancesSortBy_attribute :: Lens' AggregatedUtterancesSortBy AggregatedUtterancesSortAttribute Source #

The utterance attribute to sort by.

aggregatedUtterancesSortBy_order :: Lens' AggregatedUtterancesSortBy SortOrder Source #

Specifies whether to sort the aggregated utterances in ascending or descending order.

AggregatedUtterancesSummary

aggregatedUtterancesSummary_containsDataFromDeletedResources :: Lens' AggregatedUtterancesSummary (Maybe Bool) Source #

Aggregated utterance data may contain utterances from versions of your bot that have since been deleted. When the aggregated contains this kind of data, this field is set to true.

aggregatedUtterancesSummary_hitCount :: Lens' AggregatedUtterancesSummary (Maybe Int) Source #

The number of times that the utterance was detected by Amazon Lex during the time period. When an utterance is detected, it activates an intent or a slot.

aggregatedUtterancesSummary_missedCount :: Lens' AggregatedUtterancesSummary (Maybe Int) Source #

The number of times that the utterance was missed by Amazon Lex An utterance is missed when it doesn't activate an intent or slot.

aggregatedUtterancesSummary_utterance :: Lens' AggregatedUtterancesSummary (Maybe Text) Source #

The text of the utterance. If the utterance was used with the RecognizeUtterance operation, the text is the transcription of the audio utterance.

aggregatedUtterancesSummary_utteranceFirstRecordedInAggregationDuration :: Lens' AggregatedUtterancesSummary (Maybe UTCTime) Source #

The date and time that the utterance was first recorded in the time window for aggregation. An utterance may have been sent to Amazon Lex before that time, but only utterances within the time window are counted.

aggregatedUtterancesSummary_utteranceLastRecordedInAggregationDuration :: Lens' AggregatedUtterancesSummary (Maybe UTCTime) Source #

The last date and time that an utterance was recorded in the time window for aggregation. An utterance may be sent to Amazon Lex after that time, but only utterances within the time window are counted.

AllowedInputTypes

allowedInputTypes_allowAudioInput :: Lens' AllowedInputTypes Bool Source #

Indicates whether audio input is allowed.

allowedInputTypes_allowDTMFInput :: Lens' AllowedInputTypes Bool Source #

Indicates whether DTMF input is allowed.

AssociatedTranscript

associatedTranscript_transcript :: Lens' AssociatedTranscript (Maybe Text) Source #

The content of the transcript that meets the search filter criteria. For the JSON format of the transcript, see Output transcript format.

AssociatedTranscriptFilter

associatedTranscriptFilter_name :: Lens' AssociatedTranscriptFilter AssociatedTranscriptFilterName Source #

The name of the field to use for filtering. The allowed names are IntentId and SlotTypeId.

associatedTranscriptFilter_values :: Lens' AssociatedTranscriptFilter (NonEmpty Text) Source #

The values to use to filter the transcript.

AudioAndDTMFInputSpecification

audioAndDTMFInputSpecification_audioSpecification :: Lens' AudioAndDTMFInputSpecification (Maybe AudioSpecification) Source #

Specifies the settings on audio input.

audioAndDTMFInputSpecification_dtmfSpecification :: Lens' AudioAndDTMFInputSpecification (Maybe DTMFSpecification) Source #

Specifies the settings on DTMF input.

audioAndDTMFInputSpecification_startTimeoutMs :: Lens' AudioAndDTMFInputSpecification Natural Source #

Time for which a bot waits before assuming that the customer isn't going to speak or press a key. This timeout is shared between Audio and DTMF inputs.

AudioLogDestination

audioLogDestination_s3Bucket :: Lens' AudioLogDestination S3BucketLogDestination Source #

The Amazon S3 bucket where the audio log files are stored. The IAM role specified in the roleArn parameter of the CreateBot operation must have permission to write to this bucket.

AudioLogSetting

audioLogSetting_enabled :: Lens' AudioLogSetting Bool Source #

Determines whether audio logging in enabled for the bot.

audioLogSetting_destination :: Lens' AudioLogSetting AudioLogDestination Source #

Undocumented member.

AudioSpecification

audioSpecification_maxLengthMs :: Lens' AudioSpecification Natural Source #

Time for how long Amazon Lex waits before speech input is truncated and the speech is returned to application.

audioSpecification_endTimeoutMs :: Lens' AudioSpecification Natural Source #

Time for which a bot waits after the customer stops speaking to assume the utterance is finished.

BotAliasHistoryEvent

botAliasHistoryEvent_botVersion :: Lens' BotAliasHistoryEvent (Maybe Text) Source #

The version of the bot that was used in the event.

botAliasHistoryEvent_endDate :: Lens' BotAliasHistoryEvent (Maybe UTCTime) Source #

The date and time that the event ended.

botAliasHistoryEvent_startDate :: Lens' BotAliasHistoryEvent (Maybe UTCTime) Source #

The date and time that the event started.

BotAliasLocaleSettings

botAliasLocaleSettings_codeHookSpecification :: Lens' BotAliasLocaleSettings (Maybe CodeHookSpecification) Source #

Specifies the Lambda function that should be used in the locale.

botAliasLocaleSettings_enabled :: Lens' BotAliasLocaleSettings Bool Source #

Determines whether the locale is enabled for the bot. If the value is false, the locale isn't available for use.

BotAliasSummary

botAliasSummary_botAliasId :: Lens' BotAliasSummary (Maybe Text) Source #

The unique identifier assigned to the bot alias. You can use this ID to get detailed information about the alias using the DescribeBotAlias operation.

botAliasSummary_botAliasName :: Lens' BotAliasSummary (Maybe Text) Source #

The name of the bot alias.

botAliasSummary_botAliasStatus :: Lens' BotAliasSummary (Maybe BotAliasStatus) Source #

The current state of the bot alias. If the status is Available, the alias is ready for use.

botAliasSummary_botVersion :: Lens' BotAliasSummary (Maybe Text) Source #

The version of the bot that the bot alias references.

botAliasSummary_creationDateTime :: Lens' BotAliasSummary (Maybe UTCTime) Source #

A timestamp of the date and time that the bot alias was created.

botAliasSummary_description :: Lens' BotAliasSummary (Maybe Text) Source #

The description of the bot alias.

botAliasSummary_lastUpdatedDateTime :: Lens' BotAliasSummary (Maybe UTCTime) Source #

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

BotExportSpecification

botExportSpecification_botId :: Lens' BotExportSpecification Text Source #

The identifier of the bot assigned by Amazon Lex.

botExportSpecification_botVersion :: Lens' BotExportSpecification Text Source #

The version of the bot that was exported. This will be either DRAFT or the version number.

BotFilter

botFilter_name :: Lens' BotFilter BotFilterName Source #

The name of the field to filter the list of bots.

botFilter_values :: Lens' BotFilter (NonEmpty Text) Source #

The value to use for filtering the list of bots.

botFilter_operator :: Lens' BotFilter BotFilterOperator Source #

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

BotImportSpecification

botImportSpecification_botTags :: Lens' BotImportSpecification (Maybe (HashMap Text Text)) Source #

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.

botImportSpecification_idleSessionTTLInSeconds :: Lens' BotImportSpecification (Maybe Natural) Source #

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.

botImportSpecification_testBotAliasTags :: Lens' BotImportSpecification (Maybe (HashMap Text Text)) Source #

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.

botImportSpecification_botName :: Lens' BotImportSpecification Text Source #

The name that Amazon Lex should use for the bot.

botImportSpecification_roleArn :: Lens' BotImportSpecification Text Source #

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

botImportSpecification_dataPrivacy :: Lens' BotImportSpecification DataPrivacy Source #

Undocumented member.

BotLocaleExportSpecification

botLocaleExportSpecification_botId :: Lens' BotLocaleExportSpecification Text Source #

The identifier of the bot to create the locale for.

botLocaleExportSpecification_botVersion :: Lens' BotLocaleExportSpecification Text Source #

The version of the bot to export.

botLocaleExportSpecification_localeId :: Lens' BotLocaleExportSpecification Text Source #

The identifier of the language and locale to export. The string must match one of the locales in the bot.

BotLocaleFilter

botLocaleFilter_name :: Lens' BotLocaleFilter BotLocaleFilterName Source #

The name of the field to filter the list of bots.

botLocaleFilter_values :: Lens' BotLocaleFilter (NonEmpty Text) Source #

The value to use for filtering the list of bots.

botLocaleFilter_operator :: Lens' BotLocaleFilter BotLocaleFilterOperator Source #

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

BotLocaleHistoryEvent

botLocaleHistoryEvent_event :: Lens' BotLocaleHistoryEvent Text Source #

A description of the event that occurred.

botLocaleHistoryEvent_eventDate :: Lens' BotLocaleHistoryEvent UTCTime Source #

A timestamp of the date and time that the event occurred.

BotLocaleImportSpecification

botLocaleImportSpecification_nluIntentConfidenceThreshold :: Lens' BotLocaleImportSpecification (Maybe Double) Source #

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
```

botLocaleImportSpecification_voiceSettings :: Lens' BotLocaleImportSpecification (Maybe VoiceSettings) Source #

Undocumented member.

botLocaleImportSpecification_botId :: Lens' BotLocaleImportSpecification Text Source #

The identifier of the bot to import the locale to.

botLocaleImportSpecification_botVersion :: Lens' BotLocaleImportSpecification Text Source #

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

botLocaleImportSpecification_localeId :: Lens' BotLocaleImportSpecification Text Source #

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.

BotLocaleSortBy

botLocaleSortBy_attribute :: Lens' BotLocaleSortBy BotLocaleSortAttribute Source #

The bot locale attribute to sort by.

botLocaleSortBy_order :: Lens' BotLocaleSortBy SortOrder Source #

Specifies whether to sort the bot locales in ascending or descending order.

BotLocaleSummary

botLocaleSummary_botLocaleStatus :: Lens' BotLocaleSummary (Maybe BotLocaleStatus) Source #

The current status of the bot locale. When the status is Built the locale is ready for use.

botLocaleSummary_description :: Lens' BotLocaleSummary (Maybe Text) Source #

The description of the bot locale.

botLocaleSummary_lastBuildSubmittedDateTime :: Lens' BotLocaleSummary (Maybe UTCTime) Source #

A timestamp of the date and time that the bot locale was last built.

botLocaleSummary_lastUpdatedDateTime :: Lens' BotLocaleSummary (Maybe UTCTime) Source #

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

botLocaleSummary_localeId :: Lens' BotLocaleSummary (Maybe Text) Source #

The language and locale of the bot locale.

botLocaleSummary_localeName :: Lens' BotLocaleSummary (Maybe Text) Source #

The name of the bot locale.

BotRecommendationResultStatistics

botRecommendationResultStatistics_intents :: Lens' BotRecommendationResultStatistics (Maybe IntentStatistics) Source #

Statistical information about about the intents associated with the bot recommendation results.

botRecommendationResultStatistics_slotTypes :: Lens' BotRecommendationResultStatistics (Maybe SlotTypeStatistics) Source #

Statistical information about the slot types associated with the bot recommendation results.

BotRecommendationResults

botRecommendationResults_associatedTranscriptsUrl :: Lens' BotRecommendationResults (Maybe Text) Source #

The presigned url link of the associated transcript.

botRecommendationResults_botLocaleExportUrl :: Lens' BotRecommendationResults (Maybe Text) Source #

The presigned URL link of the recommended bot definition.

botRecommendationResults_statistics :: Lens' BotRecommendationResults (Maybe BotRecommendationResultStatistics) Source #

The statistical summary of the bot recommendation results.

BotRecommendationSummary

botRecommendationSummary_creationDateTime :: Lens' BotRecommendationSummary (Maybe UTCTime) Source #

A timestamp of the date and time that the bot recommendation was created.

botRecommendationSummary_lastUpdatedDateTime :: Lens' BotRecommendationSummary (Maybe UTCTime) Source #

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

botRecommendationSummary_botRecommendationStatus :: Lens' BotRecommendationSummary BotRecommendationStatus Source #

The status of the bot recommendation.

If the status is Failed, then the reasons for the failure are listed in the failureReasons field.

botRecommendationSummary_botRecommendationId :: Lens' BotRecommendationSummary Text Source #

The unique identifier of the bot recommendation to be updated.

BotSortBy

botSortBy_attribute :: Lens' BotSortBy BotSortAttribute Source #

The attribute to use to sort the list of bots.

botSortBy_order :: Lens' BotSortBy SortOrder Source #

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

BotSummary

botSummary_botId :: Lens' BotSummary (Maybe Text) Source #

The unique identifier assigned to the bot. Use this ID to get detailed information about the bot with the DescribeBot operation.

botSummary_botName :: Lens' BotSummary (Maybe Text) Source #

The name of the bot.

botSummary_botStatus :: Lens' BotSummary (Maybe BotStatus) Source #

The current status of the bot. When the status is Available the bot is ready for use.

botSummary_description :: Lens' BotSummary (Maybe Text) Source #

The description of the bot.

botSummary_lastUpdatedDateTime :: Lens' BotSummary (Maybe UTCTime) Source #

The date and time that the bot was last updated.

botSummary_latestBotVersion :: Lens' BotSummary (Maybe Text) Source #

The latest numerical version in use for the bot.

BotVersionLocaleDetails

botVersionLocaleDetails_sourceBotVersion :: Lens' BotVersionLocaleDetails Text Source #

The version of a bot used for a bot locale.

BotVersionSortBy

botVersionSortBy_attribute :: Lens' BotVersionSortBy BotVersionSortAttribute Source #

The attribute to use to sort the list of versions.

botVersionSortBy_order :: Lens' BotVersionSortBy SortOrder Source #

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

BotVersionSummary

botVersionSummary_botName :: Lens' BotVersionSummary (Maybe Text) Source #

The name of the bot associated with the version.

botVersionSummary_botStatus :: Lens' BotVersionSummary (Maybe BotStatus) Source #

The status of the bot. When the status is available, the version of the bot is ready for use.

botVersionSummary_botVersion :: Lens' BotVersionSummary (Maybe Text) Source #

The numeric version of the bot, or DRAFT to indicate that this is the version of the bot that can be updated..

botVersionSummary_creationDateTime :: Lens' BotVersionSummary (Maybe UTCTime) Source #

A timestamp of the date and time that the version was created.

botVersionSummary_description :: Lens' BotVersionSummary (Maybe Text) Source #

The description of the version.

BuiltInIntentSortBy

builtInIntentSortBy_attribute :: Lens' BuiltInIntentSortBy BuiltInIntentSortAttribute Source #

The attribute to use to sort the list of built-in intents.

builtInIntentSortBy_order :: Lens' BuiltInIntentSortBy SortOrder Source #

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

BuiltInIntentSummary

builtInIntentSummary_description :: Lens' BuiltInIntentSummary (Maybe Text) Source #

The description of the intent.

builtInIntentSummary_intentSignature :: Lens' BuiltInIntentSummary (Maybe Text) Source #

The signature of the built-in intent. Use this to specify the parent intent of a derived intent.

BuiltInSlotTypeSortBy

builtInSlotTypeSortBy_attribute :: Lens' BuiltInSlotTypeSortBy BuiltInSlotTypeSortAttribute Source #

The attribute to use to sort the list of built-in intents.

builtInSlotTypeSortBy_order :: Lens' BuiltInSlotTypeSortBy SortOrder Source #

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

BuiltInSlotTypeSummary

builtInSlotTypeSummary_description :: Lens' BuiltInSlotTypeSummary (Maybe Text) Source #

The description of the built-in slot type.

builtInSlotTypeSummary_slotTypeSignature :: Lens' BuiltInSlotTypeSummary (Maybe Text) Source #

The signature of the built-in slot type. Use this to specify the parent slot type of a derived slot type.

Button

button_text :: Lens' Button Text Source #

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

button_value :: Lens' Button Text Source #

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

CloudWatchLogGroupLogDestination

cloudWatchLogGroupLogDestination_cloudWatchLogGroupArn :: Lens' CloudWatchLogGroupLogDestination Text Source #

The Amazon Resource Name (ARN) of the log group where text and metadata logs are delivered.

cloudWatchLogGroupLogDestination_logPrefix :: Lens' CloudWatchLogGroupLogDestination Text Source #

The prefix of the log stream name within the log group that you specified

CodeHookSpecification

codeHookSpecification_lambdaCodeHook :: Lens' CodeHookSpecification LambdaCodeHook Source #

Undocumented member.

CompositeSlotTypeSetting

compositeSlotTypeSetting_subSlots :: Lens' CompositeSlotTypeSetting (Maybe [SubSlotTypeComposition]) Source #

Subslots in the composite slot.

Condition

condition_expressionString :: Lens' Condition Text Source #

The expression string that is evaluated.

ConditionalBranch

conditionalBranch_response :: Lens' ConditionalBranch (Maybe ResponseSpecification) Source #

Undocumented member.

conditionalBranch_name :: Lens' ConditionalBranch Text Source #

The name of the branch.

conditionalBranch_condition :: Lens' ConditionalBranch Condition Source #

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

conditionalBranch_nextStep :: Lens' ConditionalBranch DialogState Source #

The next step in the conversation.

ConditionalSpecification

conditionalSpecification_active :: Lens' ConditionalSpecification Bool Source #

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

conditionalSpecification_conditionalBranches :: Lens' ConditionalSpecification (NonEmpty ConditionalBranch) Source #

A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.

conditionalSpecification_defaultBranch :: Lens' ConditionalSpecification DefaultConditionalBranch Source #

The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.

ConversationLogSettings

conversationLogSettings_audioLogSettings :: Lens' ConversationLogSettings (Maybe (NonEmpty AudioLogSetting)) Source #

The Amazon S3 settings for logging audio to an S3 bucket.

conversationLogSettings_textLogSettings :: Lens' ConversationLogSettings (Maybe (NonEmpty TextLogSetting)) Source #

The Amazon CloudWatch Logs settings for logging text and metadata.

CustomPayload

customPayload_value :: Lens' CustomPayload Text Source #

The string that is sent to your application.

CustomVocabularyEntryId

customVocabularyEntryId_itemId :: Lens' CustomVocabularyEntryId Text Source #

The unique item identifier for the custom vocabulary items.

CustomVocabularyExportSpecification

customVocabularyExportSpecification_botId :: Lens' CustomVocabularyExportSpecification Text Source #

The identifier of the bot that contains the custom vocabulary to export.

customVocabularyExportSpecification_botVersion :: Lens' CustomVocabularyExportSpecification Text Source #

The version of the bot that contains the custom vocabulary to export.

customVocabularyExportSpecification_localeId :: Lens' CustomVocabularyExportSpecification Text Source #

The locale of the bot that contains the custom vocabulary to export.

CustomVocabularyImportSpecification

customVocabularyImportSpecification_botId :: Lens' CustomVocabularyImportSpecification Text Source #

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

customVocabularyImportSpecification_botVersion :: Lens' CustomVocabularyImportSpecification Text Source #

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

customVocabularyImportSpecification_localeId :: Lens' CustomVocabularyImportSpecification Text Source #

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

CustomVocabularyItem

customVocabularyItem_displayAs :: Lens' CustomVocabularyItem (Maybe Text) Source #

The display as value for the custom vocabulary item from the custom vocabulary list.

customVocabularyItem_weight :: Lens' CustomVocabularyItem (Maybe Natural) Source #

The weight assigned for the custom vocabulary item from the custom vocabulary list.

customVocabularyItem_itemId :: Lens' CustomVocabularyItem Text Source #

The unique item identifer for the custom vocabulary item from the custom vocabulary list.

customVocabularyItem_phrase :: Lens' CustomVocabularyItem Text Source #

The unique phrase for the custom vocabulary item from the custom vocabulary list.

DTMFSpecification

dTMFSpecification_maxLength :: Lens' DTMFSpecification Natural Source #

The maximum number of DTMF digits allowed in an utterance.

dTMFSpecification_endTimeoutMs :: Lens' DTMFSpecification Natural Source #

How long the bot should wait after the last DTMF character input before assuming that the input has concluded.

dTMFSpecification_deletionCharacter :: Lens' DTMFSpecification Text Source #

The DTMF character that clears the accumulated DTMF digits and immediately ends the input.

dTMFSpecification_endCharacter :: Lens' DTMFSpecification Text Source #

The DTMF character that immediately ends input. If the user does not press this character, the input ends after the end timeout.

DataPrivacy

dataPrivacy_childDirected :: Lens' DataPrivacy Bool Source #

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.

DateRangeFilter

dateRangeFilter_startDateTime :: Lens' DateRangeFilter UTCTime Source #

A timestamp indicating the start date for the date range filter.

dateRangeFilter_endDateTime :: Lens' DateRangeFilter UTCTime Source #

A timestamp indicating the end date for the date range filter.

DefaultConditionalBranch

defaultConditionalBranch_nextStep :: Lens' DefaultConditionalBranch (Maybe DialogState) Source #

The next step in the conversation.

defaultConditionalBranch_response :: Lens' DefaultConditionalBranch (Maybe ResponseSpecification) Source #

Undocumented member.

DialogAction

dialogAction_slotToElicit :: Lens' DialogAction (Maybe Text) Source #

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

dialogAction_suppressNextMessage :: Lens' DialogAction (Maybe Bool) Source #

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

dialogAction_type :: Lens' DialogAction DialogActionType Source #

The action that the bot should execute.

DialogCodeHookInvocationSetting

dialogCodeHookInvocationSetting_invocationLabel :: Lens' DialogCodeHookInvocationSetting (Maybe Text) Source #

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

dialogCodeHookInvocationSetting_enableCodeHookInvocation :: Lens' DialogCodeHookInvocationSetting Bool Source #

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

dialogCodeHookInvocationSetting_active :: Lens' DialogCodeHookInvocationSetting Bool Source #

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

dialogCodeHookInvocationSetting_postCodeHookSpecification :: Lens' DialogCodeHookInvocationSetting PostDialogCodeHookInvocationSpecification Source #

Contains the responses and actions that Amazon Lex takes after the Lambda function is complete.

DialogCodeHookSettings

dialogCodeHookSettings_enabled :: Lens' DialogCodeHookSettings Bool Source #

Enables the dialog code hook so that it processes user requests.

DialogState

dialogState_dialogAction :: Lens' DialogState (Maybe DialogAction) Source #

Undocumented member.

dialogState_intent :: Lens' DialogState (Maybe IntentOverride) Source #

Undocumented member.

dialogState_sessionAttributes :: Lens' DialogState (Maybe (HashMap Text Text)) Source #

Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

ElicitationCodeHookInvocationSetting

elicitationCodeHookInvocationSetting_invocationLabel :: Lens' ElicitationCodeHookInvocationSetting (Maybe Text) Source #

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

elicitationCodeHookInvocationSetting_enableCodeHookInvocation :: Lens' ElicitationCodeHookInvocationSetting Bool Source #

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

EncryptionSetting

encryptionSetting_associatedTranscriptsPassword :: Lens' EncryptionSetting (Maybe Text) Source #

The password used to encrypt the associated transcript file.

encryptionSetting_botLocaleExportPassword :: Lens' EncryptionSetting (Maybe Text) Source #

The password used to encrypt the recommended bot recommendation file.

encryptionSetting_kmsKeyArn :: Lens' EncryptionSetting (Maybe Text) Source #

The KMS key ARN used to encrypt the metadata associated with the bot recommendation.

ExportFilter

exportFilter_name :: Lens' ExportFilter ExportFilterName Source #

The name of the field to use for filtering.

exportFilter_values :: Lens' ExportFilter (NonEmpty Text) Source #

The values to use to filter the response. The values must be Bot, BotLocale, or CustomVocabulary.

exportFilter_operator :: Lens' ExportFilter ExportFilterOperator Source #

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

ExportResourceSpecification

exportResourceSpecification_botExportSpecification :: Lens' ExportResourceSpecification (Maybe BotExportSpecification) Source #

Parameters for exporting a bot.

exportResourceSpecification_botLocaleExportSpecification :: Lens' ExportResourceSpecification (Maybe BotLocaleExportSpecification) Source #

Parameters for exporting a bot locale.

exportResourceSpecification_customVocabularyExportSpecification :: Lens' ExportResourceSpecification (Maybe CustomVocabularyExportSpecification) Source #

The parameters required to export a custom vocabulary.

ExportSortBy

exportSortBy_attribute :: Lens' ExportSortBy ExportSortAttribute Source #

The export field to use for sorting.

exportSortBy_order :: Lens' ExportSortBy SortOrder Source #

The order to sort the list.

ExportSummary

exportSummary_creationDateTime :: Lens' ExportSummary (Maybe UTCTime) Source #

The date and time that the export was created.

exportSummary_exportId :: Lens' ExportSummary (Maybe Text) Source #

The unique identifier that Amazon Lex assigned to the export.

exportSummary_exportStatus :: Lens' ExportSummary (Maybe ExportStatus) Source #

The status of the export. When the status is Completed the export is ready to download.

exportSummary_fileFormat :: Lens' ExportSummary (Maybe ImportExportFileFormat) Source #

The file format used in the export files.

exportSummary_lastUpdatedDateTime :: Lens' ExportSummary (Maybe UTCTime) Source #

The date and time that the export was last updated.

exportSummary_resourceSpecification :: Lens' ExportSummary (Maybe ExportResourceSpecification) Source #

Information about the bot or bot locale that was exported.

ExternalSourceSetting

externalSourceSetting_grammarSlotTypeSetting :: Lens' ExternalSourceSetting (Maybe GrammarSlotTypeSetting) Source #

Settings required for a slot type based on a grammar that you provide.

FailedCustomVocabularyItem

failedCustomVocabularyItem_errorCode :: Lens' FailedCustomVocabularyItem (Maybe ErrorCode) Source #

The unique error code for the failed custom vocabulary item from the custom vocabulary list.

failedCustomVocabularyItem_errorMessage :: Lens' FailedCustomVocabularyItem (Maybe Text) Source #

The error message for the failed custom vocabulary item from the custom vocabulary list.

failedCustomVocabularyItem_itemId :: Lens' FailedCustomVocabularyItem (Maybe Text) Source #

The unique item identifer for the failed custom vocabulary item from the custom vocabulary list.

FulfillmentCodeHookSettings

fulfillmentCodeHookSettings_active :: Lens' FulfillmentCodeHookSettings (Maybe Bool) Source #

Determines whether the fulfillment code hook is used. When active is false, the code hook doesn't run.

fulfillmentCodeHookSettings_fulfillmentUpdatesSpecification :: Lens' FulfillmentCodeHookSettings (Maybe FulfillmentUpdatesSpecification) Source #

Provides settings for update messages sent to the user for long-running Lambda fulfillment functions. Fulfillment updates can be used only with streaming conversations.

fulfillmentCodeHookSettings_postFulfillmentStatusSpecification :: Lens' FulfillmentCodeHookSettings (Maybe PostFulfillmentStatusSpecification) Source #

Provides settings for messages sent to the user for after the Lambda fulfillment function completes. Post-fulfillment messages can be sent for both streaming and non-streaming conversations.

fulfillmentCodeHookSettings_enabled :: Lens' FulfillmentCodeHookSettings Bool Source #

Indicates whether a Lambda function should be invoked to fulfill a specific intent.

FulfillmentStartResponseSpecification

fulfillmentStartResponseSpecification_allowInterrupt :: Lens' FulfillmentStartResponseSpecification (Maybe Bool) Source #

Determines whether the user can interrupt the start message while it is playing.

fulfillmentStartResponseSpecification_delayInSeconds :: Lens' FulfillmentStartResponseSpecification Natural Source #

The delay between when the Lambda fulfillment function starts running and the start message is played. If the Lambda function returns before the delay is over, the start message isn't played.

fulfillmentStartResponseSpecification_messageGroups :: Lens' FulfillmentStartResponseSpecification (NonEmpty MessageGroup) Source #

One to 5 message groups that contain start messages. Amazon Lex chooses one of the messages to play to the user.

FulfillmentUpdateResponseSpecification

fulfillmentUpdateResponseSpecification_allowInterrupt :: Lens' FulfillmentUpdateResponseSpecification (Maybe Bool) Source #

Determines whether the user can interrupt an update message while it is playing.

fulfillmentUpdateResponseSpecification_frequencyInSeconds :: Lens' FulfillmentUpdateResponseSpecification Natural Source #

The frequency that a message is sent to the user. When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user. If the fulfillment Lambda returns before the first period ends, an update message is not played to the user.

fulfillmentUpdateResponseSpecification_messageGroups :: Lens' FulfillmentUpdateResponseSpecification (NonEmpty MessageGroup) Source #

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

FulfillmentUpdatesSpecification

fulfillmentUpdatesSpecification_startResponse :: Lens' FulfillmentUpdatesSpecification (Maybe FulfillmentStartResponseSpecification) Source #

Provides configuration information for the message sent to users when the fulfillment Lambda functions starts running.

fulfillmentUpdatesSpecification_timeoutInSeconds :: Lens' FulfillmentUpdatesSpecification (Maybe Natural) Source #

The length of time that the fulfillment Lambda function should run before it times out.

fulfillmentUpdatesSpecification_updateResponse :: Lens' FulfillmentUpdatesSpecification (Maybe FulfillmentUpdateResponseSpecification) Source #

Provides configuration information for messages sent periodically to the user while the fulfillment Lambda function is running.

fulfillmentUpdatesSpecification_active :: Lens' FulfillmentUpdatesSpecification Bool Source #

Determines whether fulfillment updates are sent to the user. When this field is true, updates are sent.

If the active field is set to true, the startResponse, updateResponse, and timeoutInSeconds fields are required.

GrammarSlotTypeSetting

grammarSlotTypeSetting_source :: Lens' GrammarSlotTypeSetting (Maybe GrammarSlotTypeSource) Source #

The source of the grammar used to create the slot type.

GrammarSlotTypeSource

grammarSlotTypeSource_kmsKeyArn :: Lens' GrammarSlotTypeSource (Maybe Text) Source #

The Amazon KMS key required to decrypt the contents of the grammar, if any.

grammarSlotTypeSource_s3BucketName :: Lens' GrammarSlotTypeSource Text Source #

The name of the S3 bucket that contains the grammar source.

grammarSlotTypeSource_s3ObjectKey :: Lens' GrammarSlotTypeSource Text Source #

The path to the grammar in the S3 bucket.

ImageResponseCard

imageResponseCard_buttons :: Lens' ImageResponseCard (Maybe [Button]) Source #

A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

imageResponseCard_imageUrl :: Lens' ImageResponseCard (Maybe Text) Source #

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

imageResponseCard_subtitle :: Lens' ImageResponseCard (Maybe Text) Source #

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

imageResponseCard_title :: Lens' ImageResponseCard Text Source #

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

ImportFilter

importFilter_name :: Lens' ImportFilter ImportFilterName Source #

The name of the field to use for filtering.

importFilter_values :: Lens' ImportFilter (NonEmpty Text) Source #

The values to use to filter the response. The values must be Bot, BotLocale, or CustomVocabulary.

importFilter_operator :: Lens' ImportFilter ImportFilterOperator Source #

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

ImportResourceSpecification

importResourceSpecification_botImportSpecification :: Lens' ImportResourceSpecification (Maybe BotImportSpecification) Source #

Parameters for importing a bot.

importResourceSpecification_botLocaleImportSpecification :: Lens' ImportResourceSpecification (Maybe BotLocaleImportSpecification) Source #

Parameters for importing a bot locale.

importResourceSpecification_customVocabularyImportSpecification :: Lens' ImportResourceSpecification (Maybe CustomVocabularyImportSpecification) Source #

Undocumented member.

ImportSortBy

importSortBy_attribute :: Lens' ImportSortBy ImportSortAttribute Source #

The export field to use for sorting.

importSortBy_order :: Lens' ImportSortBy SortOrder Source #

The order to sort the list.

ImportSummary

importSummary_creationDateTime :: Lens' ImportSummary (Maybe UTCTime) Source #

The date and time that the import was created.

importSummary_importId :: Lens' ImportSummary (Maybe Text) Source #

The unique identifier that Amazon Lex assigned to the import.

importSummary_importStatus :: Lens' ImportSummary (Maybe ImportStatus) Source #

The status of the resource. When the status is Completed the resource is ready to build.

importSummary_importedResourceId :: Lens' ImportSummary (Maybe Text) Source #

The unique identifier that Amazon Lex assigned to the imported resource.

importSummary_importedResourceName :: Lens' ImportSummary (Maybe Text) Source #

The name that you gave the imported resource.

importSummary_importedResourceType :: Lens' ImportSummary (Maybe ImportResourceType) Source #

The type of resource that was imported.

importSummary_lastUpdatedDateTime :: Lens' ImportSummary (Maybe UTCTime) Source #

The date and time that the import was last updated.

importSummary_mergeStrategy :: Lens' ImportSummary (Maybe MergeStrategy) Source #

The strategy used to merge existing bot or bot locale definitions with the imported definition.

InitialResponseSetting

initialResponseSetting_codeHook :: Lens' InitialResponseSetting (Maybe DialogCodeHookInvocationSetting) Source #

Undocumented member.

initialResponseSetting_conditional :: Lens' InitialResponseSetting (Maybe ConditionalSpecification) Source #

Undocumented member.

initialResponseSetting_initialResponse :: Lens' InitialResponseSetting (Maybe ResponseSpecification) Source #

Undocumented member.

initialResponseSetting_nextStep :: Lens' InitialResponseSetting (Maybe DialogState) Source #

The next step in the conversation.

InputContext

inputContext_name :: Lens' InputContext Text Source #

The name of the context.

IntentClosingSetting

intentClosingSetting_active :: Lens' IntentClosingSetting (Maybe Bool) Source #

Specifies whether an intent's closing response is used. When this field is false, the closing response isn't sent to the user. If the active field isn't specified, the default is true.

intentClosingSetting_closingResponse :: Lens' IntentClosingSetting (Maybe ResponseSpecification) Source #

The response that Amazon Lex sends to the user when the intent is complete.

intentClosingSetting_conditional :: Lens' IntentClosingSetting (Maybe ConditionalSpecification) Source #

A list of conditional branches associated with the intent's closing response. These branches are executed when the nextStep attribute is set to EvalutateConditional.

intentClosingSetting_nextStep :: Lens' IntentClosingSetting (Maybe DialogState) Source #

Specifies the next step that the bot executes after playing the intent's closing response.

IntentConfirmationSetting

intentConfirmationSetting_active :: Lens' IntentConfirmationSetting (Maybe Bool) Source #

Specifies whether the intent's confirmation is sent to the user. When this field is false, confirmation and declination responses aren't sent. If the active field isn't specified, the default is true.

intentConfirmationSetting_codeHook :: Lens' IntentConfirmationSetting (Maybe DialogCodeHookInvocationSetting) Source #

The DialogCodeHookInvocationSetting object associated with intent's confirmation step. The dialog code hook is triggered based on these invocation settings when the confirmation next step or declination next step or failure next step is InvokeDialogCodeHook.

intentConfirmationSetting_confirmationConditional :: Lens' IntentConfirmationSetting (Maybe ConditionalSpecification) Source #

A list of conditional branches to evaluate after the intent is closed.

intentConfirmationSetting_confirmationNextStep :: Lens' IntentConfirmationSetting (Maybe DialogState) Source #

Specifies the next step that the bot executes when the customer confirms the intent.

intentConfirmationSetting_confirmationResponse :: Lens' IntentConfirmationSetting (Maybe ResponseSpecification) Source #

Undocumented member.

intentConfirmationSetting_declinationConditional :: Lens' IntentConfirmationSetting (Maybe ConditionalSpecification) Source #

A list of conditional branches to evaluate after the intent is declined.

intentConfirmationSetting_declinationNextStep :: Lens' IntentConfirmationSetting (Maybe DialogState) Source #

Specifies the next step that the bot executes when the customer declines the intent.

intentConfirmationSetting_declinationResponse :: Lens' IntentConfirmationSetting (Maybe ResponseSpecification) Source #

When the user answers "no" to the question defined in promptSpecification, Amazon Lex responds with this response to acknowledge that the intent was canceled.

intentConfirmationSetting_elicitationCodeHook :: Lens' IntentConfirmationSetting (Maybe ElicitationCodeHookInvocationSetting) Source #

The DialogCodeHookInvocationSetting used when the code hook is invoked during confirmation prompt retries.

intentConfirmationSetting_failureConditional :: Lens' IntentConfirmationSetting (Maybe ConditionalSpecification) Source #

Undocumented member.

intentConfirmationSetting_failureNextStep :: Lens' IntentConfirmationSetting (Maybe DialogState) Source #

The next step to take in the conversation if the confirmation step fails.

intentConfirmationSetting_failureResponse :: Lens' IntentConfirmationSetting (Maybe ResponseSpecification) Source #

Undocumented member.

intentConfirmationSetting_promptSpecification :: Lens' IntentConfirmationSetting PromptSpecification Source #

Prompts the user to confirm the intent. This question should have a yes or no answer.

Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the OrderPizza intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information.

IntentFilter

intentFilter_name :: Lens' IntentFilter IntentFilterName Source #

The name of the field to use for the filter.

intentFilter_values :: Lens' IntentFilter (NonEmpty Text) Source #

The value to use for the filter.

intentFilter_operator :: Lens' IntentFilter IntentFilterOperator Source #

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

IntentOverride

intentOverride_name :: Lens' IntentOverride (Maybe Text) Source #

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

intentOverride_slots :: Lens' IntentOverride (Maybe (HashMap Text SlotValueOverride)) Source #

A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.,

IntentSortBy

intentSortBy_attribute :: Lens' IntentSortBy IntentSortAttribute Source #

The attribute to use to sort the list of intents.

intentSortBy_order :: Lens' IntentSortBy SortOrder Source #

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

IntentStatistics

intentStatistics_discoveredIntentCount :: Lens' IntentStatistics (Maybe Int) Source #

The number of recommended intents associated with the bot recommendation.

IntentSummary

intentSummary_description :: Lens' IntentSummary (Maybe Text) Source #

The description of the intent.

intentSummary_inputContexts :: Lens' IntentSummary (Maybe [InputContext]) Source #

The input contexts that must be active for this intent to be considered for recognition.

intentSummary_intentId :: Lens' IntentSummary (Maybe Text) Source #

The unique identifier assigned to the intent. Use this ID to get detailed information about the intent with the DescribeIntent operation.

intentSummary_intentName :: Lens' IntentSummary (Maybe Text) Source #

The name of the intent.

intentSummary_lastUpdatedDateTime :: Lens' IntentSummary (Maybe UTCTime) Source #

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

intentSummary_outputContexts :: Lens' IntentSummary (Maybe [OutputContext]) Source #

The output contexts that are activated when this intent is fulfilled.

intentSummary_parentIntentSignature :: Lens' IntentSummary (Maybe Text) Source #

If this intent is derived from a built-in intent, the name of the parent intent.

KendraConfiguration

kendraConfiguration_queryFilterString :: Lens' KendraConfiguration (Maybe Text) Source #

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

kendraConfiguration_queryFilterStringEnabled :: Lens' KendraConfiguration (Maybe Bool) Source #

Determines whether the AMAZON.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index.

kendraConfiguration_kendraIndex :: Lens' KendraConfiguration Text Source #

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.

LambdaCodeHook

lambdaCodeHook_lambdaARN :: Lens' LambdaCodeHook Text Source #

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

lambdaCodeHook_codeHookInterfaceVersion :: Lens' LambdaCodeHook Text Source #

The version of the request-response that you want Amazon Lex to use to invoke your Lambda function.

LexTranscriptFilter

lexTranscriptFilter_dateRangeFilter :: Lens' LexTranscriptFilter (Maybe DateRangeFilter) Source #

The object that contains a date range filter that will be applied to the transcript. Specify this object if you want Amazon Lex to only read the files that are within the date range.

Message

message_customPayload :: Lens' Message (Maybe CustomPayload) Source #

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

message_imageResponseCard :: Lens' Message (Maybe ImageResponseCard) Source #

A message that defines a response card that the client application can show to the user.

message_plainTextMessage :: Lens' Message (Maybe PlainTextMessage) Source #

A message in plain text format.

message_ssmlMessage :: Lens' Message (Maybe SSMLMessage) Source #

A message in Speech Synthesis Markup Language (SSML).

MessageGroup

messageGroup_variations :: Lens' MessageGroup (Maybe [Message]) Source #

Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

messageGroup_message :: Lens' MessageGroup Message Source #

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

MultipleValuesSetting

multipleValuesSetting_allowMultipleValues :: Lens' MultipleValuesSetting (Maybe Bool) Source #

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

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

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

NewCustomVocabularyItem

newCustomVocabularyItem_displayAs :: Lens' NewCustomVocabularyItem (Maybe Text) Source #

The display as value assigned to the new custom vocabulary item from the custom vocabulary list.

newCustomVocabularyItem_weight :: Lens' NewCustomVocabularyItem (Maybe Natural) Source #

The weight assigned to the new custom vocabulary item from the custom vocabulary list.

newCustomVocabularyItem_phrase :: Lens' NewCustomVocabularyItem Text Source #

The unique phrase for the new custom vocabulary item from the custom vocabulary list.

ObfuscationSetting

obfuscationSetting_obfuscationSettingType :: Lens' ObfuscationSetting ObfuscationSettingType Source #

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

OutputContext

outputContext_name :: Lens' OutputContext Text Source #

The name of the output context.

outputContext_timeToLiveInSeconds :: Lens' OutputContext Natural Source #

The amount of time, in seconds, that the output context should remain active. The time is figured from the first time the context is sent to the user.

outputContext_turnsToLive :: Lens' OutputContext Natural Source #

The number of conversation turns that the output context should remain active. The number of turns is counted from the first time that the context is sent to the user.

PathFormat

pathFormat_objectPrefixes :: Lens' PathFormat (Maybe (NonEmpty Text)) Source #

A list of Amazon S3 prefixes that points to sub-folders in the Amazon S3 bucket. Specify this list if you only want Lex to read the files under this set of sub-folders.

PlainTextMessage

plainTextMessage_value :: Lens' PlainTextMessage Text Source #

The message to send to the user.

PostDialogCodeHookInvocationSpecification

postDialogCodeHookInvocationSpecification_failureConditional :: Lens' PostDialogCodeHookInvocationSpecification (Maybe ConditionalSpecification) Source #

A list of conditional branches to evaluate after the dialog code hook throws an exception or returns with the State field of the Intent object set to Failed.

postDialogCodeHookInvocationSpecification_failureNextStep :: Lens' PostDialogCodeHookInvocationSpecification (Maybe DialogState) Source #

Specifies the next step the bot runs after the dialog code hook throws an exception or returns with the State field of the Intent object set to Failed.

postDialogCodeHookInvocationSpecification_failureResponse :: Lens' PostDialogCodeHookInvocationSpecification (Maybe ResponseSpecification) Source #

Undocumented member.

postDialogCodeHookInvocationSpecification_successConditional :: Lens' PostDialogCodeHookInvocationSpecification (Maybe ConditionalSpecification) Source #

A list of conditional branches to evaluate after the dialog code hook finishes successfully.

postDialogCodeHookInvocationSpecification_successNextStep :: Lens' PostDialogCodeHookInvocationSpecification (Maybe DialogState) Source #

Specifics the next step the bot runs after the dialog code hook finishes successfully.

postDialogCodeHookInvocationSpecification_successResponse :: Lens' PostDialogCodeHookInvocationSpecification (Maybe ResponseSpecification) Source #

Undocumented member.

postDialogCodeHookInvocationSpecification_timeoutConditional :: Lens' PostDialogCodeHookInvocationSpecification (Maybe ConditionalSpecification) Source #

A list of conditional branches to evaluate if the code hook times out.

postDialogCodeHookInvocationSpecification_timeoutNextStep :: Lens' PostDialogCodeHookInvocationSpecification (Maybe DialogState) Source #

Specifies the next step that the bot runs when the code hook times out.

postDialogCodeHookInvocationSpecification_timeoutResponse :: Lens' PostDialogCodeHookInvocationSpecification (Maybe ResponseSpecification) Source #

Undocumented member.

PostFulfillmentStatusSpecification

postFulfillmentStatusSpecification_failureConditional :: Lens' PostFulfillmentStatusSpecification (Maybe ConditionalSpecification) Source #

A list of conditional branches to evaluate after the fulfillment code hook throws an exception or returns with the State field of the Intent object set to Failed.

postFulfillmentStatusSpecification_failureNextStep :: Lens' PostFulfillmentStatusSpecification (Maybe DialogState) Source #

Specifies the next step the bot runs after the fulfillment code hook throws an exception or returns with the State field of the Intent object set to Failed.

postFulfillmentStatusSpecification_failureResponse :: Lens' PostFulfillmentStatusSpecification (Maybe ResponseSpecification) Source #

Undocumented member.

postFulfillmentStatusSpecification_successConditional :: Lens' PostFulfillmentStatusSpecification (Maybe ConditionalSpecification) Source #

A list of conditional branches to evaluate after the fulfillment code hook finishes successfully.

postFulfillmentStatusSpecification_successNextStep :: Lens' PostFulfillmentStatusSpecification (Maybe DialogState) Source #

Specifies the next step in the conversation that Amazon Lex invokes when the fulfillment code hook completes successfully.

postFulfillmentStatusSpecification_successResponse :: Lens' PostFulfillmentStatusSpecification (Maybe ResponseSpecification) Source #

Undocumented member.

postFulfillmentStatusSpecification_timeoutConditional :: Lens' PostFulfillmentStatusSpecification (Maybe ConditionalSpecification) Source #

A list of conditional branches to evaluate if the fulfillment code hook times out.

postFulfillmentStatusSpecification_timeoutNextStep :: Lens' PostFulfillmentStatusSpecification (Maybe DialogState) Source #

Specifies the next step that the bot runs when the fulfillment code hook times out.

postFulfillmentStatusSpecification_timeoutResponse :: Lens' PostFulfillmentStatusSpecification (Maybe ResponseSpecification) Source #

Undocumented member.

Principal

principal_arn :: Lens' Principal (Maybe Text) Source #

The Amazon Resource Name (ARN) of the principal.

principal_service :: Lens' Principal (Maybe Text) Source #

The name of the AWS service that should allowed or denied access to an Amazon Lex action.

PromptAttemptSpecification

promptAttemptSpecification_allowInterrupt :: Lens' PromptAttemptSpecification (Maybe Bool) Source #

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

promptAttemptSpecification_audioAndDTMFInputSpecification :: Lens' PromptAttemptSpecification (Maybe AudioAndDTMFInputSpecification) Source #

Specifies the settings on audio and DTMF input.

promptAttemptSpecification_textInputSpecification :: Lens' PromptAttemptSpecification (Maybe TextInputSpecification) Source #

Specifies the settings on text input.

promptAttemptSpecification_allowedInputTypes :: Lens' PromptAttemptSpecification AllowedInputTypes Source #

Indicates the allowed input types of the prompt attempt.

PromptSpecification

promptSpecification_allowInterrupt :: Lens' PromptSpecification (Maybe Bool) Source #

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

promptSpecification_messageSelectionStrategy :: Lens' PromptSpecification (Maybe MessageSelectionStrategy) Source #

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

promptSpecification_promptAttemptsSpecification :: Lens' PromptSpecification (Maybe (HashMap PromptAttempt PromptAttemptSpecification)) Source #

Specifies the advanced settings on each attempt of the prompt.

promptSpecification_messageGroups :: Lens' PromptSpecification (NonEmpty MessageGroup) Source #

A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.

promptSpecification_maxRetries :: Lens' PromptSpecification Natural Source #

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

RecommendedIntentSummary

The unique identifier of a recommended intent associated with the bot recommendation.

The name of a recommended intent associated with the bot recommendation.

The count of sample utterances of a recommended intent that is associated with a bot recommendation.

RelativeAggregationDuration

relativeAggregationDuration_timeDimension :: Lens' RelativeAggregationDuration TimeDimension Source #

The type of time period that the timeValue field represents.

relativeAggregationDuration_timeValue :: Lens' RelativeAggregationDuration Natural Source #

The period of the time window to gather statistics for. The valid value depends on the setting of the timeDimension field.

Hours - 1/3/6/12/24
Days - 3
Weeks - 1/2

ResponseSpecification

responseSpecification_allowInterrupt :: Lens' ResponseSpecification (Maybe Bool) Source #

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

responseSpecification_messageGroups :: Lens' ResponseSpecification (NonEmpty MessageGroup) Source #

A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

S3BucketLogDestination

s3BucketLogDestination_kmsKeyArn :: Lens' S3BucketLogDestination (Maybe Text) Source #

The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket.

s3BucketLogDestination_s3BucketArn :: Lens' S3BucketLogDestination Text Source #

The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.

s3BucketLogDestination_logPrefix :: Lens' S3BucketLogDestination Text Source #

The S3 prefix to assign to audio log files.

S3BucketTranscriptSource

s3BucketTranscriptSource_kmsKeyArn :: Lens' S3BucketTranscriptSource (Maybe Text) Source #

The ARN of the KMS key that customer use to encrypt their Amazon S3 bucket. Only use this field if your bucket is encrypted using a customer managed KMS key.

s3BucketTranscriptSource_pathFormat :: Lens' S3BucketTranscriptSource (Maybe PathFormat) Source #

The object that contains a path format that will be applied when Amazon Lex reads the transcript file in the bucket you provide. Specify this object if you only want Lex to read a subset of files in your Amazon S3 bucket.

s3BucketTranscriptSource_transcriptFilter :: Lens' S3BucketTranscriptSource (Maybe TranscriptFilter) Source #

The object that contains the filter which will be applied when Amazon Lex reads through the Amazon S3 bucket. Specify this object if you want Amazon Lex to read only a subset of the Amazon S3 bucket based on the filter you provide.

s3BucketTranscriptSource_s3BucketName :: Lens' S3BucketTranscriptSource Text Source #

The name of the bucket containing the transcript and the associated metadata.

s3BucketTranscriptSource_transcriptFormat :: Lens' S3BucketTranscriptSource TranscriptFormat Source #

The format of the transcript content. Currently, Genie only supports the Amazon Lex transcript format.

SSMLMessage

sSMLMessage_value :: Lens' SSMLMessage Text Source #

The SSML text that defines the prompt.

SampleUtterance

sampleUtterance_utterance :: Lens' SampleUtterance Text Source #

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

SampleValue

sampleValue_value :: Lens' SampleValue Text Source #

The value that can be used for a slot type.

SentimentAnalysisSettings

sentimentAnalysisSettings_detectSentiment :: Lens' SentimentAnalysisSettings Bool Source #

Sets whether Amazon Lex uses Amazon Comprehend to detect the sentiment of user utterances.

SlotCaptureSetting

slotCaptureSetting_captureConditional :: Lens' SlotCaptureSetting (Maybe ConditionalSpecification) Source #

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

slotCaptureSetting_captureNextStep :: Lens' SlotCaptureSetting (Maybe DialogState) Source #

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

slotCaptureSetting_captureResponse :: Lens' SlotCaptureSetting (Maybe ResponseSpecification) Source #

Undocumented member.

slotCaptureSetting_codeHook :: Lens' SlotCaptureSetting (Maybe DialogCodeHookInvocationSetting) Source #

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

slotCaptureSetting_elicitationCodeHook :: Lens' SlotCaptureSetting (Maybe ElicitationCodeHookInvocationSetting) Source #

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

slotCaptureSetting_failureConditional :: Lens' SlotCaptureSetting (Maybe ConditionalSpecification) Source #

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

slotCaptureSetting_failureNextStep :: Lens' SlotCaptureSetting (Maybe DialogState) Source #

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

slotCaptureSetting_failureResponse :: Lens' SlotCaptureSetting (Maybe ResponseSpecification) Source #

Undocumented member.

SlotDefaultValue

slotDefaultValue_defaultValue :: Lens' SlotDefaultValue Text Source #

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

SlotDefaultValueSpecification

slotDefaultValueSpecification_defaultValueList :: Lens' SlotDefaultValueSpecification [SlotDefaultValue] Source #

A list of default values. Amazon Lex chooses the default value to use in the order that they are presented in the list.

SlotFilter

slotFilter_name :: Lens' SlotFilter SlotFilterName Source #

The name of the field to use for filtering.

slotFilter_values :: Lens' SlotFilter (NonEmpty Text) Source #

The value to use to filter the response.

slotFilter_operator :: Lens' SlotFilter SlotFilterOperator Source #

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

SlotPriority

slotPriority_priority :: Lens' SlotPriority Natural Source #

The priority that a slot should be elicited.

slotPriority_slotId :: Lens' SlotPriority Text Source #

The unique identifier of the slot.

SlotSortBy

slotSortBy_attribute :: Lens' SlotSortBy SlotSortAttribute Source #

The attribute to use to sort the list.

slotSortBy_order :: Lens' SlotSortBy SortOrder Source #

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

SlotSummary

slotSummary_description :: Lens' SlotSummary (Maybe Text) Source #

The description of the slot.

slotSummary_lastUpdatedDateTime :: Lens' SlotSummary (Maybe UTCTime) Source #

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

slotSummary_slotConstraint :: Lens' SlotSummary (Maybe SlotConstraint) Source #

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

slotSummary_slotId :: Lens' SlotSummary (Maybe Text) Source #

The unique identifier of the slot.

slotSummary_slotName :: Lens' SlotSummary (Maybe Text) Source #

The name given to the slot.

slotSummary_slotTypeId :: Lens' SlotSummary (Maybe Text) Source #

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

slotSummary_valueElicitationPromptSpecification :: Lens' SlotSummary (Maybe PromptSpecification) Source #

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

SlotTypeFilter

slotTypeFilter_name :: Lens' SlotTypeFilter SlotTypeFilterName Source #

The name of the field to use for filtering.

slotTypeFilter_values :: Lens' SlotTypeFilter (NonEmpty Text) Source #

The value to use to filter the response.

slotTypeFilter_operator :: Lens' SlotTypeFilter SlotTypeFilterOperator Source #

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

SlotTypeSortBy

slotTypeSortBy_attribute :: Lens' SlotTypeSortBy SlotTypeSortAttribute Source #

The attribute to use to sort the list of slot types.

slotTypeSortBy_order :: Lens' SlotTypeSortBy SortOrder Source #

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

SlotTypeStatistics

slotTypeStatistics_discoveredSlotTypeCount :: Lens' SlotTypeStatistics (Maybe Int) Source #

The number of recommended slot types associated with the bot recommendation.

SlotTypeSummary

slotTypeSummary_description :: Lens' SlotTypeSummary (Maybe Text) Source #

The description of the slot type.

slotTypeSummary_lastUpdatedDateTime :: Lens' SlotTypeSummary (Maybe UTCTime) Source #

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

slotTypeSummary_parentSlotTypeSignature :: Lens' SlotTypeSummary (Maybe Text) Source #

If the slot type is derived from a built-on slot type, the name of the parent slot type.

slotTypeSummary_slotTypeCategory :: Lens' SlotTypeSummary (Maybe SlotTypeCategory) Source #

Indicates the type of the slot type.

Custom - A slot type that you created using custom values. For more information, see Creating custom slot types.
Extended - A slot type created by extending the AMAZON.AlphaNumeric built-in slot type. For more information, see AMAZON.AlphaNumeric.
ExternalGrammar - A slot type using a custom GRXML grammar to define values. For more information, see Using a custom grammar slot type.

slotTypeSummary_slotTypeId :: Lens' SlotTypeSummary (Maybe Text) Source #

The unique identifier assigned to the slot type.

slotTypeSummary_slotTypeName :: Lens' SlotTypeSummary (Maybe Text) Source #

The name of the slot type.

SlotTypeValue

slotTypeValue_sampleValue :: Lens' SlotTypeValue (Maybe SampleValue) Source #

The value of the slot type entry.

slotTypeValue_synonyms :: Lens' SlotTypeValue (Maybe (NonEmpty SampleValue)) Source #

Additional values related to the slot type entry.

SlotValue

slotValue_interpretedValue :: Lens' SlotValue (Maybe Text) Source #

The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the resolvedValues list.

SlotValueElicitationSetting

slotValueElicitationSetting_defaultValueSpecification :: Lens' SlotValueElicitationSetting (Maybe SlotDefaultValueSpecification) Source #

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

slotValueElicitationSetting_promptSpecification :: Lens' SlotValueElicitationSetting (Maybe PromptSpecification) Source #

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

slotValueElicitationSetting_sampleUtterances :: Lens' SlotValueElicitationSetting (Maybe [SampleUtterance]) Source #

If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of understanding user utterances.

slotValueElicitationSetting_slotCaptureSetting :: Lens' SlotValueElicitationSetting (Maybe SlotCaptureSetting) Source #

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

slotValueElicitationSetting_waitAndContinueSpecification :: Lens' SlotValueElicitationSetting (Maybe WaitAndContinueSpecification) Source #

Undocumented member.

slotValueElicitationSetting_slotConstraint :: Lens' SlotValueElicitationSetting SlotConstraint Source #

Specifies whether the slot is required or optional.

SlotValueOverride

slotValueOverride_shape :: Lens' SlotValueOverride (Maybe SlotShape) Source #

When the shape value is List, it indicates that the values field contains a list of slot values. When the value is Scalar, it indicates that the value field contains a single value.

slotValueOverride_value :: Lens' SlotValueOverride (Maybe SlotValue) Source #

The current value of the slot.

slotValueOverride_values :: Lens' SlotValueOverride (Maybe [SlotValueOverride]) Source #

A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

SlotValueRegexFilter

slotValueRegexFilter_pattern :: Lens' SlotValueRegexFilter Text Source #

A regular expression used to validate the value of a slot.

Use a standard regular expression. Amazon Lex supports the following characters in the regular expression:

A-Z, a-z
0-9
Unicode characters ("\ u<Unicode>")

Represent Unicode characters with four digits, for example "\u0041" or "\u005A".

The following regular expression operators are not supported:

Infinite repeaters: *, +, or {x,} with no upper bound.
Wild card (.)

SlotValueSelectionSetting

slotValueSelectionSetting_advancedRecognitionSetting :: Lens' SlotValueSelectionSetting (Maybe AdvancedRecognitionSetting) Source #

Provides settings that enable advanced recognition settings for slot values.

slotValueSelectionSetting_regexFilter :: Lens' SlotValueSelectionSetting (Maybe SlotValueRegexFilter) Source #

A regular expression used to validate the value of a slot.

slotValueSelectionSetting_resolutionStrategy :: Lens' SlotValueSelectionSetting SlotValueResolutionStrategy Source #

Determines the slot resolution strategy that Amazon Lex uses to return slot type 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 as the slot type value. If there is no resolution list, null is returned.

If you don't specify the valueSelectionStrategy, the default is OriginalValue.

Specifications

specifications_slotTypeId :: Lens' Specifications Text Source #

The unique identifier assigned to the slot type.

specifications_valueElicitationSetting :: Lens' Specifications SubSlotValueElicitationSetting Source #

Specifies the elicitation setting details for constituent sub slots of a composite slot.

StillWaitingResponseSpecification

stillWaitingResponseSpecification_allowInterrupt :: Lens' StillWaitingResponseSpecification (Maybe Bool) Source #

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

stillWaitingResponseSpecification_messageGroups :: Lens' StillWaitingResponseSpecification (NonEmpty MessageGroup) Source #

One or more message groups, each containing one or more messages, that define the prompts that Amazon Lex sends to the user.

stillWaitingResponseSpecification_frequencyInSeconds :: Lens' StillWaitingResponseSpecification Natural Source #

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

stillWaitingResponseSpecification_timeoutInSeconds :: Lens' StillWaitingResponseSpecification Natural Source #

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

SubSlotSetting

subSlotSetting_expression :: Lens' SubSlotSetting (Maybe Text) Source #

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

subSlotSetting_slotSpecifications :: Lens' SubSlotSetting (Maybe (HashMap Text Specifications)) Source #

Specifications for the constituent sub slots of a composite slot.

SubSlotTypeComposition

subSlotTypeComposition_name :: Lens' SubSlotTypeComposition Text Source #

Name of a constituent sub slot inside a composite slot.

subSlotTypeComposition_slotTypeId :: Lens' SubSlotTypeComposition Text Source #

The unique identifier assigned to a slot type. This refers to either a built-in slot type or the unique slotTypeId of a custom slot type.

SubSlotValueElicitationSetting

subSlotValueElicitationSetting_defaultValueSpecification :: Lens' SubSlotValueElicitationSetting (Maybe SlotDefaultValueSpecification) Source #

Undocumented member.

subSlotValueElicitationSetting_sampleUtterances :: Lens' SubSlotValueElicitationSetting (Maybe [SampleUtterance]) Source #

If you know a specific pattern that users might respond to an Amazon Lex request for a sub slot value, you can provide those utterances to improve accuracy. This is optional. In most cases Amazon Lex is capable of understanding user utterances. This is similar to SampleUtterances for slots.

subSlotValueElicitationSetting_waitAndContinueSpecification :: Lens' SubSlotValueElicitationSetting (Maybe WaitAndContinueSpecification) Source #

Undocumented member.

subSlotValueElicitationSetting_promptSpecification :: Lens' SubSlotValueElicitationSetting PromptSpecification Source #

Undocumented member.

TextInputSpecification

textInputSpecification_startTimeoutMs :: Lens' TextInputSpecification Natural Source #

Time for which a bot waits before re-prompting a customer for text input.

TextLogDestination

textLogDestination_cloudWatch :: Lens' TextLogDestination CloudWatchLogGroupLogDestination Source #

Defines the Amazon CloudWatch Logs log group where text and metadata logs are delivered.

TextLogSetting

textLogSetting_enabled :: Lens' TextLogSetting Bool Source #

Determines whether conversation logs should be stored for an alias.

textLogSetting_destination :: Lens' TextLogSetting TextLogDestination Source #

Undocumented member.

TranscriptFilter

transcriptFilter_lexTranscriptFilter :: Lens' TranscriptFilter (Maybe LexTranscriptFilter) Source #

The object representing the filter that Amazon Lex will use to select the appropriate transcript when the transcript format is the Amazon Lex format.

TranscriptSourceSetting

transcriptSourceSetting_s3BucketTranscriptSource :: Lens' TranscriptSourceSetting (Maybe S3BucketTranscriptSource) Source #

Indicates the setting of the Amazon S3 bucket where the transcript is stored.

UtteranceAggregationDuration

utteranceAggregationDuration_relativeAggregationDuration :: Lens' UtteranceAggregationDuration RelativeAggregationDuration Source #

The desired time window for aggregating utterances.

VoiceSettings

voiceSettings_engine :: Lens' VoiceSettings (Maybe VoiceEngine) Source #

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.

voiceSettings_voiceId :: Lens' VoiceSettings Text Source #

The identifier of the Amazon Polly voice to use.

WaitAndContinueSpecification

waitAndContinueSpecification_active :: Lens' WaitAndContinueSpecification (Maybe Bool) Source #

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

waitAndContinueSpecification_stillWaitingResponse :: Lens' WaitAndContinueSpecification (Maybe StillWaitingResponseSpecification) Source #

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

waitAndContinueSpecification_waitingResponse :: Lens' WaitAndContinueSpecification ResponseSpecification Source #

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

waitAndContinueSpecification_continueResponse :: Lens' WaitAndContinueSpecification ResponseSpecification Source #

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