Module Awso_lexv2_models.ValuesSource

Sourceval service : Awso.Service.t
Sourceval apiVersion : string
Sourceval endpointPrefix : string
Sourceval serviceFullName : string
Sourceval signatureVersion : string
Sourceval protocol : string
Sourceval globalEndpoint : string
Sourceval serviceAbbreviation : string
Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t
Sourceval structure_to_value_aux : ('a * 'b option) list -> f:(('a * 'b) list -> 'c) -> [> `Structure of 'c ]
Sourceval structure_to_value : ('a * 'b option) list -> [> `Structure of ('a * 'b) list ]
Sourceval structure_to_wrapped_value : wrapper:'a -> response:'a -> ('b * 'c option) list -> [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]
Sourcemodule ActiveContextName : sig ... end
Sourcemodule ActiveContext : sig ... end

The active context used in the test execution.

Sourcemodule ActiveContextList : sig ... end
Sourcemodule AudioRecognitionStrategy : sig ... end

Provides settings that enable advanced recognition settings for slot values.

Sourcemodule TestSetAgentPrompt : sig ... end
Sourcemodule TestResultSlotName : sig ... end
Sourcemodule Name : sig ... end
Sourcemodule NonEmptyString : sig ... end
Sourcemodule ExecutionErrorDetails : sig ... end

Details about an error in an execution of a test set.

Sourcemodule AgentTurnResult : sig ... end

The information about the agent turn in a test set execution.

Sourcemodule AgentTurnSpecification : sig ... end

The specification of an agent turn.

Sourcemodule FilterValue : sig ... end
Sourcemodule FilterValues : sig ... end

Filters responses returned by the ListAggregatedUtterances operation.

Sourcemodule SortOrder : sig ... end

Specifies attributes for sorting a list of utterances.

Sourcemodule Utterance : sig ... end
Sourcemodule Timestamp : sig ... end
Sourcemodule MissedCount : sig ... end
Sourcemodule HitCount : sig ... end
Sourcemodule BoxedBoolean : sig ... end

Provides summary information for aggregated utterances. The ListAggregatedUtterances operations combines all instances of the same utterance into a single aggregated summary.

Sourcemodule AllowedInputTypes : sig ... end

Specifies the allowed input types.

Sourcemodule AmazonResourceName : sig ... end
Sourcemodule AnalysisScope : sig ... end
Sourcemodule AnalyticsSortOrder : sig ... end
Sourcemodule AnalyticsInterval : sig ... end
Sourcemodule AnalyticsBinByName : sig ... end

Contains the time metric, interval, and method by which to bin the analytics data.

Sourcemodule AnalyticsBinByList : sig ... end
Sourcemodule AnalyticsBinValue : sig ... end
Sourcemodule AnalyticsBinKey : sig ... end

An object containing the criterion by which to bin the results and the value that defines that bin.

Sourcemodule AnalyticsBinKeys : sig ... end
Sourcemodule AnalyticsChannel : sig ... end
Sourcemodule AnalyticsCommonFilterName : sig ... end
Sourcemodule AnalyticsFilterOperator : sig ... end
Sourcemodule AnalyticsFilterValue : sig ... end
Sourcemodule AnalyticsFilterValues : sig ... end
Sourcemodule AnalyticsGroupByValue : sig ... end
Sourcemodule AnalyticsIntentField : sig ... end
Sourcemodule AnalyticsIntentFilterName : sig ... end
Sourcemodule AnalyticsIntentFilter : sig ... end

Contains fields describing a condition by which to filter the intents. The expression may be understood as name operator values. For example: IntentName CO Book – The intent name contains the string "Book." BotVersion EQ 2 – The bot version is equal to two. The operators that each filter supports are listed below: BotAlias – EQ. BotVersion – EQ. LocaleId – EQ. Modality – EQ. Channel – EQ. SessionId – EQ. OriginatingRequestId – EQ. IntentName – EQ, CO. IntentEndState – EQ, CO.

Sourcemodule AnalyticsIntentFilters : sig ... end
Sourcemodule AnalyticsIntentGroupByKey : sig ... end

Contains the category by which the intent analytics were grouped and a member of that category.

Contains the category by which to group the intents.

Sourcemodule AnalyticsMetricStatistic : sig ... end
Sourcemodule AnalyticsIntentMetricName : sig ... end
Sourcemodule AnalyticsIntentMetric : sig ... end

Contains the metric and the summary statistic you want to calculate, and the order in which to sort the results, for the intents in the bot.

Sourcemodule AnalyticsMetricValue : sig ... end

An object containing the results for the intent metric you requested.

Sourcemodule AnalyticsIntentMetrics : sig ... end
Sourcemodule AnalyticsPath : sig ... end
Sourcemodule AnalyticsNodeType : sig ... end
Sourcemodule AnalyticsNodeLevel : sig ... end
Sourcemodule AnalyticsNodeCount : sig ... end

An object containing information about the requested path.

Sourcemodule AnalyticsIntentResult : sig ... end

An object containing the results for the intent metrics you requested and the bin and/or group(s) they refer to, if applicable.

Sourcemodule AnalyticsIntentResults : sig ... end
Sourcemodule AnalyticsIntentStageField : sig ... end

Contains fields describing a condition by which to filter the intent stages. The expression may be understood as name operator values. For example: IntentName CO Book – The intent name contains the string "Book." BotVersion EQ 2 – The bot version is equal to two. The operators that each filter supports are listed below: BotAlias – EQ. BotVersion – EQ. LocaleId – EQ. Modality – EQ. Channel – EQ. SessionId – EQ. OriginatingRequestId – EQ. IntentName – EQ, CO. IntentStageName – EQ, CO.

Contains the category by which the intent stage analytics and the values for that category were grouped.

Contains the category by which to group the intent stages.

Contains the metric and the summary statistic you want to calculate, and the order in which to sort the results, for the intent stages across the user sessions with the bot.

An object containing the results for an intent stage metric you requested.

An object containing the results for the intent stage metrics you requested and the bin and/or group they refer to, if applicable.

Sourcemodule AnalyticsLongValue : sig ... end
Sourcemodule AnalyticsModality : sig ... end
Sourcemodule AnalyticsPathFilter : sig ... end

Contains fields describing a condition by which to filter the paths. The expression may be understood as name operator values. For example: LocaleId EQ en – The locale is "en". BotVersion EQ 2 – The bot version is equal to two. The operators that each filter supports are listed below: BotAlias – EQ. BotVersion – EQ. LocaleId – EQ. Modality – EQ. Channel – EQ.

Sourcemodule AnalyticsPathFilters : sig ... end
Sourcemodule AnalyticsSessionField : sig ... end
Sourcemodule AnalyticsSessionFilter : sig ... end

Contains fields describing a condition by which to filter the sessions. The expression may be understood as name operator values. For example: LocaleId EQ en – The locale is "en". Duration GT 200 – The duration is greater than 200 seconds. The operators that each filter supports are listed below: BotAlias – EQ. BotVersion – EQ. LocaleId – EQ. Modality – EQ. Channel – EQ. Duration – EQ, GT, LT. conversationEndState – EQ, CO. SessionId – EQ. OriginatingRequestId – EQ. IntentPath – EQ.

Sourcemodule AnalyticsSessionFilters : sig ... end

Contains the category by which the session analytics were grouped and a member of that category.

Contains the category by which to group the sessions.

Sourcemodule AnalyticsSessionId : sig ... end
Sourcemodule AnalyticsSessionMetric : sig ... end

Contains the metric and the summary statistic you want to calculate, and the order in which to sort the results, for the user sessions with the bot.

An object containing the results for a session metric you requested.

Sourcemodule AnalyticsSessionMetrics : sig ... end
Sourcemodule AnalyticsSessionResult : sig ... end

An object containing the results for the session metrics you requested and the bin and/or group(s) they refer to, if applicable.

Sourcemodule AnalyticsSessionResults : sig ... end

An object that specifies the last used intent at the time of the utterance as an attribute to return.

An object containing the intent that the bot mapped the utterance to.

Sourcemodule AnalyticsUtteranceField : sig ... end
Sourcemodule AnalyticsUtteranceFilter : sig ... end

Contains fields describing a condition by which to filter the utterances. The expression may be understood as name operator values. For example: LocaleId EQ Book – The locale is the string "en". UtteranceText CO help – The text of the utterance contains the string "help". The operators that each filter supports are listed below: BotAlias – EQ. BotVersion – EQ. LocaleId – EQ. Modality – EQ. Channel – EQ. SessionId – EQ. OriginatingRequestId – EQ. UtteranceState – EQ. UtteranceText – EQ, CO.

Sourcemodule AnalyticsUtteranceFilters : sig ... end

Contains the category by which the utterance analytics were grouped and the values for that category.

Contains the category by which to group the utterances.

Sourcemodule AnalyticsUtteranceMetric : sig ... end

Contains the metric and the summary statistic you want to calculate, and the order in which to sort the results, for the utterances across the user sessions with the bot.

An object containing the results for the utterance metric you requested.

Sourcemodule AnalyticsUtteranceMetrics : sig ... end
Sourcemodule AnalyticsUtteranceResult : sig ... end

An object containing the results for the utterance metrics you requested and the bin and/or group(s) they refer to, if applicable.

Sourcemodule AnalyticsUtteranceResults : sig ... end
Sourcemodule AnswerField : sig ... end
Sourcemodule AssistedNluMode : sig ... end
Sourcemodule Transcript : sig ... end
Sourcemodule AssociatedTranscript : sig ... end

The object containing information that associates the recommended intent/slot type with a conversation.

Filters to search for the associated transcript.

Sourcemodule AssociatedTranscriptList : sig ... end
Sourcemodule AttachmentTitle : sig ... end
Sourcemodule AttachmentUrl : sig ... end
Sourcemodule TimeInMilliSeconds : sig ... end
Sourcemodule MaxUtteranceDigits : sig ... end
Sourcemodule DTMFCharacter : sig ... end
Sourcemodule DTMFSpecification : sig ... end

Specifies the DTMF input specifications.

Sourcemodule AudioSpecification : sig ... end

Specifies the audio input specifications.

Specifies the audio and DTMF input specification.

Sourcemodule AudioFileS3Location : sig ... end
Sourcemodule Boolean : sig ... end
Sourcemodule AudioFillerType : sig ... end
Sourcemodule AudioFillerSettings : sig ... end

Configuration that plays background filler audio during speech-to-speech interactions to mask processing delays and improve the perceived responsiveness of the bot. Audio filler requires unifiedSpeechSettings (speech-to-speech) to be enabled on the bot locale when enabled is true.

Sourcemodule S3BucketArn : sig ... end
Sourcemodule LogPrefix : sig ... end
Sourcemodule KmsKeyArn : sig ... end
Sourcemodule S3BucketLogDestination : sig ... end

Specifies an Amazon S3 bucket for logging audio conversations

Sourcemodule AudioLogDestination : sig ... end

The location of audio log files collected when conversation logging is enabled for a bot.

Sourcemodule AudioLogSetting : sig ... end

Settings for logging audio of conversations between Amazon Lex and a user. You specify whether to log audio and the Amazon S3 bucket where the audio file is stored.

Sourcemodule AudioLogSettingsList : sig ... end
Sourcemodule LocaleId : sig ... end
Sourcemodule Id : sig ... end
Sourcemodule Weight : sig ... end
Sourcemodule Phrase : sig ... end
Sourcemodule NewCustomVocabularyItem : sig ... end

The new custom vocabulary item from the custom vocabulary list.

Sourcemodule BotVersion : sig ... end

Create a batch of custom vocabulary items for a given bot locale's custom vocabulary.

Sourcemodule ExceptionMessage : sig ... end
Sourcemodule ValidationException : sig ... end

One of the input parameters in your request isn't valid. Check the parameters and try your request again.

Sourcemodule RetryAfterSeconds : sig ... end
Sourcemodule ThrottlingException : sig ... end

Your request rate is too high. Reduce the frequency of requests.

You have reached a quota for your bot.

Sourcemodule ResourceNotFoundException : sig ... end

You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.

Sourcemodule InternalServerException : sig ... end

The service encountered an unexpected condition. Try your request again.

Sourcemodule ItemId : sig ... end
Sourcemodule ErrorMessage : sig ... end
Sourcemodule ErrorCode : sig ... end

The unique failed custom vocabulary item from the custom vocabulary list.

Sourcemodule CustomVocabularyItem : sig ... end

The unique custom vocabulary item from the custom vocabulary list.

Sourcemodule CustomVocabularyItems : sig ... end

Create a batch of custom vocabulary items for a given bot locale's custom vocabulary.

Sourcemodule CustomVocabularyEntryId : sig ... end

The unique entry identifier for the custom vocabulary items.

Delete a batch of custom vocabulary items for a given bot locale's custom vocabulary.

Delete a batch of custom vocabulary items for a given bot locale's custom vocabulary.

Update a batch of custom vocabulary items for a given bot locale's custom vocabulary.

Update a batch of custom vocabulary items for a given bot locale's custom vocabulary.

Sourcemodule BedrockGuardrailVersion : sig ... end

The details on the Bedrock guardrail configuration.

Sourcemodule BedrockKnowledgeBaseArn : sig ... end

The exact response fields given by the Bedrock knowledge store.

Contains details about the configuration of a Amazon Bedrock knowledge base.

Sourcemodule BedrockModelArn : sig ... end
Sourcemodule BedrockModelCustomPrompt : sig ... end
Sourcemodule BedrockTraceStatus : sig ... end
Sourcemodule BedrockModelSpecification : sig ... end

Contains information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.

Sourcemodule BotAliasHistoryEvent : sig ... end

Provides a record of an event that affects a bot alias. For example, when the version of a bot that the alias points to changes.

Sourcemodule BotAliasHistoryEventsList : sig ... end
Sourcemodule BotAliasId : sig ... end
Sourcemodule LambdaARN : sig ... end
Sourcemodule CodeHookInterfaceVersion : sig ... end
Sourcemodule LambdaCodeHook : sig ... end

Specifies a Lambda function that verifies requests to a bot or fulfills the user's request to a bot.

Sourcemodule CodeHookSpecification : sig ... end

Contains information about code hooks that Amazon Lex calls during a conversation.

Sourcemodule BotAliasLocaleSettings : sig ... end

Specifies settings that are unique to a locale. For example, you can use different Lambda function depending on the bot's locale.

Sourcemodule BotAliasLocaleSettingsMap : sig ... end
Sourcemodule BotAliasName : sig ... end
Sourcemodule FailureReason : sig ... end
Sourcemodule FailureReasons : sig ... end
Sourcemodule BotAliasReplicationStatus : sig ... end
Sourcemodule BotAliasReplicaSummary : sig ... end

Contains information about all the aliases replication statuses applicable for global resiliency.

Sourcemodule BotAliasStatus : sig ... end
Sourcemodule Description : sig ... end
Sourcemodule BotAliasSummary : sig ... end

Summary information about bot aliases returned from the ListBotAliases operation.

Sourcemodule BotAliasSummaryList : sig ... end

The target Amazon S3 location for the test set execution using a bot alias.

Sourcemodule UUID : sig ... end
Sourcemodule BotAnalyzerStatus : sig ... end
Sourcemodule BotAnalyzerHistorySummary : sig ... end

Contains summary information about a historical bot analysis execution.

Sourcemodule BotAnalyzerHistoryList : sig ... end
Sourcemodule Priority : sig ... end
Sourcemodule IssueLocation : sig ... end

Specifies the location of an identified issue within the bot configuration.

Sourcemodule BotAnalyzerRecommendation : sig ... end

Contains a recommendation for bot optimization identified by the Bot Analyzer.

Sourcemodule BotExportSpecification : sig ... end

Provides the identity of a the bot that was exported.

Sourcemodule BotFilterOperator : sig ... end
Sourcemodule BotFilterName : sig ... end
Sourcemodule BotFilter : sig ... end

Filters the responses returned by the ListBots operation.

Sourcemodule BotFilters : sig ... end
Sourcemodule TagValue : sig ... end
Sourcemodule TagKey : sig ... end
Sourcemodule TagMap : sig ... end
Sourcemodule SessionTTL : sig ... end
Sourcemodule RoleArn : sig ... end
Sourcemodule ErrorLogSettings : sig ... end

Settings parameters for the error logs, whether it is enabled or disabled.

Sourcemodule ChildDirected : sig ... end
Sourcemodule DataPrivacy : sig ... end

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

Sourcemodule BotImportSpecification : sig ... end

Provides the bot parameters required for importing a bot.

Provides the bot locale parameters required for exporting a bot locale.

Sourcemodule BotLocaleFilterOperator : sig ... end
Sourcemodule BotLocaleFilterName : sig ... end
Sourcemodule BotLocaleFilter : sig ... end

Filters responses returned by the ListBotLocales operation.

Sourcemodule BotLocaleFilters : sig ... end
Sourcemodule BotLocaleHistoryEvent : sig ... end

Provides information about an event that occurred affecting the bot locale.

Sourcemodule VoiceId : sig ... end
Sourcemodule VoiceEngine : sig ... end
Sourcemodule VoiceSettings : sig ... end

Defines settings for using an Amazon Polly voice to communicate with a user. Valid values include: standard neural long-form generative

Sourcemodule SpeechFoundationModel : sig ... end

Configuration for a foundation model used for speech synthesis and recognition capabilities.

Sourcemodule UnifiedSpeechSettings : sig ... end

Unified configuration settings that combine speech recognition and synthesis capabilities.

Sourcemodule SpeechModelPreference : sig ... end
Sourcemodule SecretsManagerSecretArn : sig ... end
Sourcemodule DeepgramModelId : sig ... end
Sourcemodule DeepgramSpeechModelConfig : sig ... end

Configuration settings for integrating Deepgram speech-to-text models with Amazon Lex.

Sourcemodule SpeechModelConfig : sig ... end

Configuration settings that define which speech-to-text model to use for processing speech input.

Sourcemodule SpeechRecognitionSettings : sig ... end

Settings that control how Amazon Lex processes and recognizes speech input from users.

Sourcemodule DraftBotVersion : sig ... end
Sourcemodule ConfidenceThreshold : sig ... end

Provides the bot locale parameters required for importing a bot locale.

Sourcemodule BotLocaleSortAttribute : sig ... end
Sourcemodule BotLocaleSortBy : sig ... end

Specifies attributes for sorting a list of bot locales.

Sourcemodule BotLocaleStatus : sig ... end
Sourcemodule LocaleName : sig ... end
Sourcemodule BotLocaleSummary : sig ... end

Summary information about bot locales returned by the ListBotLocales operation.

Sourcemodule BotLocaleSummaryList : sig ... end
Sourcemodule BotMember : sig ... end

A bot that is a member of a network of bots.

Sourcemodule BotMembers : sig ... end
Sourcemodule Count : sig ... end
Sourcemodule SlotTypeStatistics : sig ... end

The object that contains the statistical summary of the recommended slot type associated with the bot recommendation.

Sourcemodule IntentStatistics : sig ... end

The object that contains the statistical summary of recommended intents associated with the bot recommendation.

A statistical summary of the bot recommendation results.

Sourcemodule PresignedS3Url : sig ... end
Sourcemodule BotRecommendationResults : sig ... end

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

Sourcemodule BotRecommendationStatus : sig ... end
Sourcemodule BotRecommendationSummary : sig ... end

A summary of the bot recommendation.

Sourcemodule BotReplicaStatus : sig ... end
Sourcemodule ReplicaRegion : sig ... end

The region that contains the replicated bots. Minimum value = 2, maximum value = 25.

Sourcemodule BotReplicaSummary : sig ... end

Contains summary information about all the replication statuses applicable for global resiliency.

Sourcemodule BotReplicaSummaryList : sig ... end
Sourcemodule BotSortAttribute : sig ... end
Sourcemodule BotSortBy : sig ... end

Specifies attributes for sorting a list of bots.

Sourcemodule BotStatus : sig ... end
Sourcemodule NumericalBotVersion : sig ... end
Sourcemodule BotType : sig ... end
Sourcemodule BotSummary : sig ... end

Summary information about a bot returned by the ListBots operation.

Sourcemodule BotSummaryList : sig ... end
Sourcemodule BotVersionLocaleDetails : sig ... end

The version of a bot used for a bot locale.

Sourcemodule BotVersionReplicaSortBy : sig ... end

The sort category for the version replicated bots.

Sourcemodule BotVersionReplicaSummary : sig ... end

Contains summary information for all the version replication statuses applicable for Global resiliency.

Sourcemodule BotVersionSortAttribute : sig ... end
Sourcemodule BotVersionSortBy : sig ... end

Specifies attributes for sorting a list of bot versions.

Sourcemodule BotVersionSummary : sig ... end

Summary information about a bot version returned by the ListBotVersions operation.

Sourcemodule BotVersionSummaryList : sig ... end
Sourcemodule BuildBotLocaleRequest : sig ... end

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

Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

Sourcemodule ConflictException : sig ... end

The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

Sourcemodule BuildBotLocaleResponse : sig ... end

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

Contains specifications for the sample utterance generation feature.

Contains specifications for the descriptive bot building feature.

Sourcemodule BuildtimeSettings : sig ... end

Contains specifications about the Amazon Lex build time generative AI capabilities from Amazon Bedrock that you can turn on for your bot.

Sourcemodule BuiltInIntentSortBy : sig ... end

Specifies attributes for sorting a list of built-in intents.

Sourcemodule IntentSignature : sig ... end
Sourcemodule BuiltInIntentSummary : sig ... end

Provides summary information about a built-in intent for the ListBuiltInIntents operation.

Sourcemodule BuiltInIntentSummaryList : sig ... end
Sourcemodule BuiltInOrCustomSlotTypeId : sig ... end
Sourcemodule BuiltInSlotTypeSortBy : sig ... end

Specifies attributes for sorting a list of built-in slot types.

Sourcemodule SlotTypeSignature : sig ... end
Sourcemodule BuiltInSlotTypeSummary : sig ... end

Provides summary information about a built-in slot type for the ListBuiltInSlotTypes operation.

Sourcemodule BuiltInsMaxResults : sig ... end
Sourcemodule ButtonValue : sig ... end
Sourcemodule ButtonText : sig ... end
Sourcemodule Button : sig ... end

Describes a button to use on a response card used to gather slot values from a user.

Sourcemodule ButtonsList : sig ... end
Sourcemodule CloudWatchLogGroupArn : sig ... end

The Amazon CloudWatch Logs log group where the text and metadata logs are delivered. The log group must exist before you enable logging.

Sourcemodule SubSlotTypeComposition : sig ... end

Subslot type composition.

Sourcemodule SubSlotTypeList : sig ... end
Sourcemodule CompositeSlotTypeSetting : sig ... end

A composite slot is a combination of two or more slots that capture multiple pieces of information in a single user input.

Sourcemodule ConditionExpression : sig ... end
Sourcemodule Condition : sig ... end

Provides an expression that evaluates to true or false.

Sourcemodule ConditionKey : sig ... end
Sourcemodule ConditionValue : sig ... end
Sourcemodule ConditionKeyValueMap : sig ... end
Sourcemodule ConditionOperator : sig ... end
Sourcemodule ConditionMap : sig ... end
Sourcemodule SSMLMessageValue : sig ... end
Sourcemodule SSMLMessage : sig ... end

Defines a Speech Synthesis Markup Language (SSML) prompt.

Sourcemodule PlainTextMessageValue : sig ... end
Sourcemodule PlainTextMessage : sig ... end

Defines an ASCII text message to send to the user.

Sourcemodule ImageResponseCard : sig ... end

A card that is shown to the user by a messaging platform. You define the contents of the card, the card is displayed by the platform. When you use a response card, the response from the user is constrained to the text associated with a button on the card.

Sourcemodule CustomPayloadValue : sig ... end
Sourcemodule CustomPayload : sig ... end

A custom response string that Amazon Lex sends to your application. You define the content and structure the string.

Sourcemodule Message : sig ... end

The object that provides message text and its type.

Sourcemodule MessageVariationsList : sig ... end
Sourcemodule MessageGroup : sig ... end

Provides one or more messages that Amazon Lex should send to the user.

Sourcemodule MessageGroupsList : sig ... end
Sourcemodule ResponseSpecification : sig ... end

Specifies a list of message groups that Amazon Lex uses to respond the user input.

Sourcemodule String_ : sig ... end
Sourcemodule StringMap : sig ... end
Sourcemodule SlotValue : sig ... end

The value to set in a slot.

Sourcemodule SlotShape : sig ... end
module SlotValueOverride : sig ... end

The slot values that Amazon Lex uses when it sets slot values in a dialog step.

module SlotValues : sig ... end
Sourcemodule SlotValueOverrideMap : sig ... end
Sourcemodule IntentOverride : sig ... end

Override settings to configure the intent state.

Sourcemodule DialogActionType : sig ... end
Sourcemodule DialogAction : sig ... end

Defines the action that the bot executes at runtime when the conversation reaches this step.

Sourcemodule DialogState : sig ... end

The current state of the conversation with the user.

Sourcemodule ConditionalBranch : sig ... end

A set of actions that Amazon Lex should run if the condition is matched.

Sourcemodule ConditionalBranches : sig ... end
Sourcemodule DefaultConditionalBranch : sig ... end

A set of actions that Amazon Lex should run if none of the other conditions are met.

Sourcemodule ConditionalSpecification : sig ... end

Provides a list of conditional branches. Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition.

Sourcemodule ContextTurnsToLive : sig ... end
Sourcemodule ConversationEndState : sig ... end
Sourcemodule TestResultMatchStatus : sig ... end

The item listing the evaluation of intent level success or failure.

The conversation level details of the conversation used in the test set.

The slots used for the slot resolution in the conversation.

Sourcemodule TestSetConversationId : sig ... end

The test result evaluation item at the conversation level.

The test set results data at the conversation level.

The selection to filter the test set results data at the conversation level.

Sourcemodule TextLogDestination : sig ... end

Defines the Amazon CloudWatch Logs destination log group for conversation text logs.

Sourcemodule TextLogSetting : sig ... end

Defines settings to enable text conversation logs.

Sourcemodule TextLogSettingsList : sig ... end
Sourcemodule ConversationLogSettings : sig ... end

Configures conversation logging that saves audio, text, and metadata for the conversations with your users.

The selected data source to filter the conversation log.

The data source that uses conversation logs.

Sourcemodule SentimentAnalysisSettings : sig ... end

Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.

Sourcemodule CreateBotAliasRequest : sig ... end

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

Sourcemodule CreateBotAliasResponse : sig ... end

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

Sourcemodule Enabled : sig ... end

Contains specifications for the assisted slot resolution feature.

Sourcemodule MaxDisambiguationIntents : sig ... end

Configures the Intent Disambiguation feature that helps resolve ambiguous user inputs when multiple intents could match. When enabled, the system presents clarifying questions to users, helping them specify their exact intent for improved conversation accuracy.

Configures the Assisted Natural Language Understanding (NLU) feature for your bot. This specification determines whether enhanced intent recognition and utterance understanding capabilities are active.

Sourcemodule RuntimeSettings : sig ... end

Contains specifications about the Amazon Lex runtime generative AI capabilities from Amazon Bedrock that you can turn on for your bot.

Sourcemodule GenerativeAISettings : sig ... end

Contains specifications about the generative AI capabilities from Amazon Bedrock that you can turn on for your bot.

Sourcemodule CreateBotLocaleRequest : sig ... end

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

Sourcemodule CreateBotLocaleResponse : sig ... end

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

Sourcemodule CreateBotReplicaRequest : sig ... end

Action to create a replication of the source bot in the secondary region.

Sourcemodule CreateBotReplicaResponse : sig ... end

Action to create a replication of the source bot in the secondary region.

Sourcemodule CreateBotRequest : sig ... end

Creates an Amazon Lex conversational bot.

Sourcemodule CreateBotResponse : sig ... end

Creates an Amazon Lex conversational bot.

Sourcemodule CreateBotVersionRequest : sig ... end

Creates an immutable version of the bot. When you create the first version of a bot, Amazon Lex sets the version number to 1. Subsequent bot versions increase in an increment of 1. The version number will always represent the total number of versions created of the bot, not the current number of versions. If a bot version is deleted, that bot version number will not be reused.

Sourcemodule CreateBotVersionResponse : sig ... end

Creates an immutable version of the bot. When you create the first version of a bot, Amazon Lex sets the version number to 1. Subsequent bot versions increase in an increment of 1. The version number will always represent the total number of versions created of the bot, not the current number of versions. If a bot version is deleted, that bot version number will not be reused.

Sourcemodule ImportExportFilePassword : sig ... end
Sourcemodule ImportExportFileFormat : sig ... end

Contains information about the test set that is exported.

Provides the parameters required for exporting a custom vocabulary.

Provides information about the bot or bot locale that you want to export. You can specify the botExportSpecification or the botLocaleExportSpecification, but not both.

Sourcemodule CreateExportRequest : sig ... end

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

Sourcemodule ExportStatus : sig ... end
Sourcemodule CreateExportResponse : sig ... end

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

Sourcemodule SampleUtterance : sig ... end

A sample utterance that invokes an intent or respond to a slot elicitation prompt.

Sourcemodule SampleUtterancesList : sig ... end
Sourcemodule QueryFilterString : sig ... end
Sourcemodule KendraIndexArn : sig ... end
Sourcemodule QnAKendraConfiguration : sig ... end

Contains details about the configuration of the Amazon Kendra index used for the AMAZON.QnAIntent.

Sourcemodule OSIndexName : sig ... end
Sourcemodule IncludeField : sig ... end
Sourcemodule OSIncludeFields : sig ... end
Sourcemodule QuestionField : sig ... end
Sourcemodule ExactResponseFields : sig ... end

Contains the names of the fields used for an exact response to the user.

Sourcemodule DomainEndpoint : sig ... end
Sourcemodule OpensearchConfiguration : sig ... end

Contains details about the configuration of the Amazon OpenSearch Service database used for the AMAZON.QnAIntent.

Sourcemodule DataSourceConfiguration : sig ... end

Contains details about the configuration of the knowledge store used for the AMAZON.QnAIntent. You must have already created the knowledge store and indexed the documents within it.

Sourcemodule QnAIntentConfiguration : sig ... end

Details about the the configuration of the built-in Amazon.QnAIntent.

Sourcemodule QInConnectAssistantARN : sig ... end

The configuration details of the Qinconnect assistant.

The configuration details of the Qinconnect intent.

Sourcemodule OutputContext : sig ... end

Describes a session context that is activated when an intent is fulfilled.

Sourcemodule OutputContextsList : sig ... end
Sourcemodule KendraConfiguration : sig ... end

Provides configuration information for the AMAZON.KendraSearchIntent intent. When you use this intent, Amazon Lex searches the specified Amazon Kendra index and returns documents from the index that match the user's utterance.

Sourcemodule PromptMaxRetries : sig ... end
Sourcemodule TextInputSpecification : sig ... end

Specifies the text input specifications.

Specifies the settings on a prompt attempt.

Sourcemodule PromptAttempt : sig ... end
Sourcemodule MessageSelectionStrategy : sig ... end
Sourcemodule PromptSpecification : sig ... end

Specifies a list of message groups that Amazon Lex sends to a user to elicit a response.

Settings that specify the dialog code hook that is called by Amazon Lex between eliciting slot values.

Specifies next steps to run after the dialog code hook finishes.

Settings that specify the dialog code hook that is called by Amazon Lex at a step of the conversation.

Sourcemodule IntentConfirmationSetting : sig ... end

Provides a prompt for making sure that the user is ready for the intent to be fulfilled.

Sourcemodule IntentClosingSetting : sig ... end

Provides a statement the Amazon Lex conveys to the user when the intent is successfully fulfilled.

Sourcemodule InputContext : sig ... end

A context that must be active for an intent to be selected by Amazon Lex.

Sourcemodule InputContextsList : sig ... end
Sourcemodule InitialResponseSetting : sig ... end

Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots.

Provides a setting that determines whether the post-fulfillment response is sent to the user. For more information, see https://docs.aws.amazon.com/lexv2/latest/dg/streaming-progress.html#progress-complete

Provides settings for a message that is sent periodically to the user while a fulfillment Lambda function is running.

Sourcemodule FulfillmentTimeout : sig ... end

Provides settings for a message that is sent to the user when a fulfillment Lambda function starts running.

Provides information for updating the user on the progress of fulfilling an intent.

Determines if a Lambda function should be invoked for a specific intent.

Sourcemodule DisplayName : sig ... end
Sourcemodule DialogCodeHookSettings : sig ... end

Settings that determine the Lambda function that Amazon Lex uses for processing user responses.

Sourcemodule CreateIntentRequest : sig ... end

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

Sourcemodule CreateIntentResponse : sig ... end

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

Sourcemodule Policy : sig ... end

Creates a new resource policy with the specified policy statements.

Sourcemodule RevisionId : sig ... end

Creates a new resource policy with the specified policy statements.

Sourcemodule ServicePrincipal : sig ... end
Sourcemodule PrincipalArn : sig ... end
Sourcemodule Principal : sig ... end

The IAM principal that you allowing or denying access to an Amazon Lex action. You must provide a service or an arn, but not both in the same statement. For more information, see AWS JSON policy elements: Principal .

Sourcemodule PrincipalList : sig ... end
Sourcemodule Operation : sig ... end
Sourcemodule OperationList : sig ... end
Sourcemodule Effect : sig ... end

Adds a new resource policy statement to a bot or bot alias. If a resource policy exists, the statement is added to the current resource policy. If a policy doesn't exist, a new policy is created. You can't create a resource policy statement that allows cross-account access. You need to add the CreateResourcePolicy or UpdateResourcePolicy action to the bot role in order to call the API.

Adds a new resource policy statement to a bot or bot alias. If a resource policy exists, the statement is added to the current resource policy. If a policy doesn't exist, a new policy is created. You can't create a resource policy statement that allows cross-account access. You need to add the CreateResourcePolicy or UpdateResourcePolicy action to the bot role in order to call the API.

Defines the messages that Amazon Lex sends to a user to remind them that the bot is waiting for a response.

Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.

Sourcemodule SlotDefaultValueString : sig ... end
Sourcemodule SlotDefaultValue : sig ... end

Specifies the default value to use when a user doesn't provide a value for a slot.

Sourcemodule SlotDefaultValueList : sig ... end

Defines a list of values that Amazon Lex should use as the default value for a slot.

Subslot elicitation settings. DefaultValueSpecification is a list of default values for a constituent sub slot in a composite 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. This is similar to DefaultValueSpecification for slots. PromptSpecification is the prompt that Amazon Lex uses to elicit the sub slot value from the user. This is similar to PromptSpecification for slots.

Sourcemodule Specifications : sig ... end

Subslot specifications.

Sourcemodule SubSlotSpecificationMap : sig ... end
Sourcemodule SubSlotExpression : sig ... end
Sourcemodule SubSlotSetting : sig ... end

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

Sourcemodule SlotResolutionStrategy : sig ... end
Sourcemodule SlotResolutionSetting : sig ... end

Contains information about whether assisted slot resolution is turned on for the slot or not.

Sourcemodule SlotConstraint : sig ... end
Sourcemodule SlotCaptureSetting : sig ... end

Settings used when Amazon Lex successfully captures a slot value from a user.

Specifies the elicitation setting details eliciting a slot.

Sourcemodule ObfuscationSettingType : sig ... end
Sourcemodule ObfuscationSetting : sig ... end

Determines whether Amazon Lex obscures slot values in conversation logs.

Sourcemodule MultipleValuesSetting : sig ... end

Indicates whether a slot can return multiple values.

Sourcemodule CreateSlotRequest : sig ... end

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

Sourcemodule CreateSlotResponse : sig ... end

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

Sourcemodule RegexPattern : sig ... end
Sourcemodule SlotValueRegexFilter : sig ... end

Provides a regular expression used to validate the value of a slot.

Sourcemodule SlotValueSelectionSetting : sig ... end

Contains settings used by Amazon Lex to select a slot value.

Sourcemodule Value : sig ... end
Sourcemodule SampleValue : sig ... end

Defines one of the values for a slot type.

Sourcemodule SynonymList : sig ... end
Sourcemodule SlotTypeValue : sig ... end

Each slot type can have a set of values. Each SlotTypeValue represents a value that the slot type can take.

Sourcemodule SlotTypeValues : sig ... end
Sourcemodule S3ObjectPath : sig ... end
Sourcemodule S3BucketName : sig ... end
Sourcemodule GrammarSlotTypeSource : sig ... end

Describes the Amazon S3 bucket name and location for the grammar that is the source for the slot type.

Sourcemodule GrammarSlotTypeSetting : sig ... end

Settings requried for a slot type based on a grammar that you provide.

Sourcemodule ExternalSourceSetting : sig ... end

Provides information about the external source of the slot type's definition.

Sourcemodule CreateSlotTypeRequest : sig ... end

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

Sourcemodule CreateSlotTypeResponse : sig ... end

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

Contains information about the bot alias used for the test set discrepancy report.

Contains information about the resource used for the test set discrepancy report.

Create a report that describes the differences between the bot and the test set.

Create a report that describes the differences between the bot and the test set.

Sourcemodule CreateUploadUrlRequest : sig ... end

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

Sourcemodule CreateUploadUrlResponse : sig ... end

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

Provides the parameters required for importing a custom vocabulary.

Sourcemodule CustomVocabularyStatus : sig ... end
Sourcemodule DateRangeFilter : sig ... end

The object used for specifying the data range that the customer wants Amazon Lex to read through in the input transcripts.

Sourcemodule SkipResourceInUseCheck : sig ... end
Sourcemodule DeleteBotAliasRequest : sig ... end

Deletes the specified bot alias.

Sourcemodule DeleteBotAliasResponse : sig ... end

Deletes the specified bot alias.

Permanently deletes the recommendations and analysis results for a specific bot analysis request. This operation is provided for GDPR compliance and cannot be undone. After deletion, the analysis results cannot be retrieved. The analysis request ID will still appear in the history list, but attempting to describe the recommendations will return a ResourceNotFoundException.

Permanently deletes the recommendations and analysis results for a specific bot analysis request. This operation is provided for GDPR compliance and cannot be undone. After deletion, the analysis results cannot be retrieved. The analysis request ID will still appear in the history list, but attempting to describe the recommendations will return a ResourceNotFoundException.

Sourcemodule DeleteBotLocaleRequest : sig ... end

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

Sourcemodule DeleteBotLocaleResponse : sig ... end

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

Sourcemodule DeleteBotReplicaRequest : sig ... end

The action to delete the replicated bot in the secondary region.

Sourcemodule DeleteBotReplicaResponse : sig ... end

The action to delete the replicated bot in the secondary region.

Sourcemodule DeleteBotRequest : sig ... end

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

Sourcemodule DeleteBotResponse : sig ... end

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

Sourcemodule DeleteBotVersionRequest : sig ... end

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

Sourcemodule DeleteBotVersionResponse : sig ... end

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

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

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

Sourcemodule DeleteExportRequest : sig ... end

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

Sourcemodule DeleteExportResponse : sig ... end

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

Sourcemodule DeleteImportRequest : sig ... end

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

Sourcemodule ImportStatus : sig ... end
Sourcemodule DeleteImportResponse : sig ... end

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

Sourcemodule DeleteIntentRequest : sig ... end

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

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

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

Deletes a policy statement from a resource policy. If you delete the last statement from a policy, the policy is deleted. If you specify a statement ID that doesn't exist in the policy, or if the bot or bot alias doesn't have a policy attached, Amazon Lex returns an exception. You need to add the DeleteResourcePolicy or UpdateResourcePolicy action to the bot role in order to call the API.

Deletes a policy statement from a resource policy. If you delete the last statement from a policy, the policy is deleted. If you specify a statement ID that doesn't exist in the policy, or if the bot or bot alias doesn't have a policy attached, Amazon Lex returns an exception. You need to add the DeleteResourcePolicy or UpdateResourcePolicy action to the bot role in order to call the API.

Sourcemodule DeleteSlotRequest : sig ... end

Deletes the specified slot from an intent.

Sourcemodule DeleteSlotTypeRequest : sig ... end

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

Sourcemodule DeleteTestSetRequest : sig ... end

The action to delete the selected test set.

Sourcemodule SessionId : sig ... end
Sourcemodule DeleteUtterancesRequest : sig ... end

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

Sourcemodule DeleteUtterancesResponse : sig ... end

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

Sourcemodule DescribeBotAliasRequest : sig ... end

Get information about a specific bot alias.

Sourcemodule ParentBotNetwork : sig ... end

A network of bots.

Sourcemodule ParentBotNetworks : sig ... end
Sourcemodule DescribeBotAliasResponse : sig ... end

Get information about a specific bot alias.

Sourcemodule NextToken : sig ... end
Sourcemodule MaxResults : sig ... end

Retrieves the analysis results and recommendations for bot optimization. The analysis must be in Available status before recommendations can be retrieved. Recommendations are returned with pagination support. Each recommendation includes the issue location, priority level, detailed description, and proposed fix.

Retrieves the analysis results and recommendations for bot optimization. The analysis must be in Available status before recommendations can be retrieved. Recommendations are returned with pagination support. Each recommendation includes the issue location, priority level, detailed description, and proposed fix.

Sourcemodule DescribeBotLocaleRequest : sig ... end

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

Sourcemodule ResourceCount : sig ... end
Sourcemodule RecommendedAction : sig ... end
Sourcemodule RecommendedActions : sig ... end
Sourcemodule DescribeBotLocaleResponse : sig ... end

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

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

Sourcemodule TranscriptFormat : sig ... end
Sourcemodule LexTranscriptFilter : sig ... end

The object that contains transcript filter details that are associated with a bot recommendation.

Sourcemodule TranscriptFilter : sig ... end

The object representing the filter that Amazon Lex will use to select the appropriate transcript.

Sourcemodule ObjectPrefix : sig ... end
Sourcemodule ObjectPrefixes : sig ... end
Sourcemodule PathFormat : sig ... end

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.

Sourcemodule S3BucketTranscriptSource : sig ... end

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

Sourcemodule TranscriptSourceSetting : sig ... end

Indicates the setting of the location where the transcript is stored.

Sourcemodule FilePassword : sig ... end
Sourcemodule EncryptionSetting : sig ... end

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

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

Sourcemodule DescribeBotReplicaRequest : sig ... end

Monitors the bot replication status through the UI console.

Monitors the bot replication status through the UI console.

Sourcemodule DescribeBotRequest : sig ... end

Provides metadata information about a bot.

Returns information about a request to generate a bot through natural language description, made through the StartBotResource API. Use the generatedBotLocaleUrl to retrieve the Amazon S3 object containing the bot locale configuration. You can then modify and import this configuration.

Sourcemodule GenerationStatus : sig ... end
Sourcemodule GenerationInput : sig ... end

Returns information about a request to generate a bot through natural language description, made through the StartBotResource API. Use the generatedBotLocaleUrl to retrieve the Amazon S3 object containing the bot locale configuration. You can then modify and import this configuration.

Sourcemodule DescribeBotResponse : sig ... end

Provides metadata information about a bot.

Sourcemodule DescribeBotVersionRequest : sig ... end

Provides metadata about a version of a bot.

Provides metadata about a version of a bot.

Provides metadata information about a custom vocabulary.

Provides metadata information about a custom vocabulary.

Sourcemodule DescribeExportRequest : sig ... end

Gets information about a specific export.

Sourcemodule DescribeExportResponse : sig ... end

Gets information about a specific export.

Sourcemodule DescribeImportRequest : sig ... end

Gets information about a specific import.

Sourcemodule MergeStrategy : sig ... end
Sourcemodule ImportedResourceId : sig ... end
Sourcemodule TestSetStorageLocation : sig ... end

Contains information about the location in which the test set is stored.

Sourcemodule TestSetModality : sig ... end

Contains information about the Amazon S3 location from which the test set is imported.

Contains information about the test set that is imported.

Provides information about the bot or bot locale that you want to import. You can specify the botImportSpecification or the botLocaleImportSpecification, but not both.

Sourcemodule DescribeImportResponse : sig ... end

Gets information about a specific import.

Sourcemodule DescribeIntentRequest : sig ... end

Returns metadata about an intent.

Sourcemodule PriorityValue : sig ... end
Sourcemodule SlotPriority : sig ... end

Sets the priority that Amazon Lex should use when eliciting slot values from a user.

Sourcemodule SlotPrioritiesList : sig ... end
Sourcemodule DescribeIntentResponse : sig ... end

Returns metadata about an intent.

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

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

Sourcemodule DescribeSlotRequest : sig ... end

Gets metadata information about a slot.

Sourcemodule DescribeSlotResponse : sig ... end

Gets metadata information about a slot.

Sourcemodule DescribeSlotTypeRequest : sig ... end

Gets metadata information about a slot type.

Sourcemodule DescribeSlotTypeResponse : sig ... end

Gets metadata information about a slot type.

Gets metadata information about the test execution.

Sourcemodule TestExecutionTarget : sig ... end

Contains information about the bot used for the test execution.

Sourcemodule TestExecutionStatus : sig ... end
Sourcemodule TestExecutionModality : sig ... end
Sourcemodule TestExecutionApiMode : sig ... end

Gets metadata information about the test execution.

Gets metadata information about the test set discrepancy report.

Contains information about discrepancy in a slot information between the test set and the bot.

Contains information about discrepancy in an intent information between the test set and the bot.

Sourcemodule TestSetDiscrepancyErrors : sig ... end

Contains details about the errors in the test set discrepancy report

Gets metadata information about the test set discrepancy report.

Gets metadata information about the test set generation.

Sourcemodule TestSetGenerationStatus : sig ... end

Contains information about the data source from which the test set is generated.

Gets metadata information about the test set generation.

Sourcemodule DescribeTestSetRequest : sig ... end

Gets metadata information about the test set.

Sourcemodule TestSetStatus : sig ... end
Sourcemodule DescribeTestSetResponse : sig ... end

Gets metadata information about the test set.

Sourcemodule ExportFilterOperator : sig ... end
Sourcemodule ExportFilterName : sig ... end
Sourcemodule ExportFilter : sig ... end

Filters the response form the ListExports operation

Sourcemodule ExportFilters : sig ... end
Sourcemodule ExportSortAttribute : sig ... end
Sourcemodule ExportSortBy : sig ... end

Provides information about sorting a list of exports.

Sourcemodule ExportSummary : sig ... end

Provides summary information about an export in an export list.

Sourcemodule ExportSummaryList : sig ... end
Sourcemodule GenerateBotElementRequest : sig ... end

Generates sample utterances for an intent.

Generates sample utterances for an intent.

Sourcemodule GenerationSortByAttribute : sig ... end
Sourcemodule GenerationSortBy : sig ... end

Specifies the attribute and method by which to sort the generation request information.

Sourcemodule GenerationSummary : sig ... end

Contains information about a generation request made for the bot locale.

Sourcemodule GenerationSummaryList : sig ... end

The pre-signed Amazon S3 URL to download the test execution result artifacts.

The pre-signed Amazon S3 URL to download the test execution result artifacts.

Sourcemodule ImportFilterOperator : sig ... end
Sourcemodule ImportFilterName : sig ... end
Sourcemodule ImportFilter : sig ... end

Filters the response from the ListImports operation.

Sourcemodule ImportFilters : sig ... end
Sourcemodule ImportResourceType : sig ... end
Sourcemodule ImportSortAttribute : sig ... end
Sourcemodule ImportSortBy : sig ... end

Provides information for sorting a list of imports.

Sourcemodule ImportSummary : sig ... end

Provides summary information about an import in an import list.

Sourcemodule ImportSummaryList : sig ... end
Sourcemodule RuntimeHintPhrase : sig ... end
Sourcemodule RuntimeHintValue : sig ... end

Provides the phrase that Amazon Lex should look for in the user's input to the bot.

Sourcemodule RuntimeHintValuesList : sig ... end
module RuntimeHintDetails : sig ... end

Provides an array of phrases that should be given preference when resolving values for a slot.

module SlotHintsSlotMap : sig ... end
Sourcemodule SlotHintsIntentMap : sig ... end
Sourcemodule RuntimeHints : sig ... end

You can provide Amazon Lex with hints to the phrases that a customer is likely to use for a slot. When a slot with hints is resolved, the phrases in the runtime hints are preferred in the resolution. You can provide hints for a maximum of 100 intents. You can provide a maximum of 100 slots. Before you can use runtime hints with an existing bot, you must first rebuild the bot. For more information, see Using runtime hints to improve recognition of slot values.

Specifications for the current state of the dialog between the user and the bot in the test set.

The number of items in the intent classification test.

Information for an intent that is classified by the test workbench.

Information for the results of the intent classification test.

Sourcemodule IntentFilterOperator : sig ... end
Sourcemodule IntentFilterName : sig ... end
Sourcemodule IntentFilter : sig ... end

Filters the response from the ListIntents operation.

Sourcemodule IntentFilters : sig ... end

Information about the counts for a slot resolution in the results of a test execution.

Information about the success and failure rate of slot resolution in the results of a test execution.

Information about intent-level slot resolution in a test result.

Indicates the success or failure of slots at the intent level.

Sourcemodule IntentSortAttribute : sig ... end
Sourcemodule IntentSortBy : sig ... end

Specifies attributes for sorting a list of intents.

Sourcemodule IntentState : sig ... end
Sourcemodule IntentSummary : sig ... end

Summary information about an intent returned by the ListIntents operation.

Sourcemodule IntentSummaryList : sig ... end
Sourcemodule InvokedIntentSample : sig ... end

An object containing the name of an intent that was invoked.

Sourcemodule InvokedIntentSamples : sig ... end
Sourcemodule TimeValue : sig ... end
Sourcemodule TimeDimension : sig ... end

Specifies the time window that utterance statistics are returned for. The time window is always relative to the last time that the that utterances were aggregated. For example, if the ListAggregatedUtterances operation is called at 1600, the time window is set to 1 hour, and the last refresh time was 1530, only utterances made between 1430 and 1530 are returned. You can choose the time window that statistics should be returned for. Hours - You can request utterance statistics for 1, 3, 6, 12, or 24 hour time windows. Statistics are refreshed every half hour for 1 hour time windows, and hourly for the other time windows. Days - You can request utterance statistics for 3 days. Statistics are refreshed every 6 hours. Weeks - You can see statistics for one or two weeks. Statistics are refreshed every 12 hours for one week time windows, and once per day for two week time windows.

Provides parameters for setting the time window and duration for aggregating utterance data.

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

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

The action to list the replicated bots created from the source bot alias.

The action to list the replicated bots created from the source bot alias.

Sourcemodule ListBotAliasesRequest : sig ... end

Gets a list of aliases for the specified bot.

Sourcemodule ListBotAliasesResponse : sig ... end

Gets a list of aliases for the specified bot.

Retrieves a list of historical bot analysis executions for a specific bot. You can filter the results by locale and bot version. The history includes all analysis executions regardless of their status, allowing you to track past analyses and their outcomes.

Retrieves a list of historical bot analysis executions for a specific bot. You can filter the results by locale and bot version. The history includes all analysis executions regardless of their status, allowing you to track past analyses and their outcomes.

Sourcemodule ListBotLocalesRequest : sig ... end

Gets a list of locales for the specified bot.

Sourcemodule ListBotLocalesResponse : sig ... end

Gets a list of locales for the specified bot.

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

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

Sourcemodule ListBotReplicasRequest : sig ... end

The action to list the replicated bots.

Sourcemodule ListBotReplicasResponse : sig ... end

The action to list the replicated bots.

Lists the generation requests made for a bot locale.

Lists the generation requests made for a bot locale.

Contains information about all the versions replication statuses applicable for Global Resiliency.

Contains information about all the versions replication statuses applicable for Global Resiliency.

Sourcemodule ListBotVersionsRequest : sig ... end

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

Sourcemodule ListBotVersionsResponse : sig ... end

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

Sourcemodule ListBotsRequest : sig ... end

Gets a list of available bots.

Sourcemodule ListBotsResponse : sig ... end

Gets a list of available bots.

Sourcemodule ListBuiltInIntentsRequest : sig ... end

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

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

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

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

Paginated list of custom vocabulary items for a given bot locale's custom vocabulary.

Paginated list of custom vocabulary items for a given bot locale's custom vocabulary.

Sourcemodule ListExportsRequest : sig ... end

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

Sourcemodule ListExportsResponse : sig ... end

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

Sourcemodule ListImportsRequest : sig ... end

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

Sourcemodule ListImportsResponse : sig ... end

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

Sourcemodule ListIntentMetricsRequest : sig ... end

Retrieves summary metrics for the intents in your bot. The following fields are required: metrics – A list of AnalyticsIntentMetric objects. In each object, use the name field to specify the metric to calculate, the statistic field to specify whether to calculate the Sum, Average, or Max number, and the order field to specify whether to sort the results in Ascending or Descending order. startDateTime and endDateTime – Define a time range for which you want to retrieve results. Of the optional fields, you can organize the results in the following ways: Use the filters field to filter the results, the groupBy field to specify categories by which to group the results, and the binBy field to specify time intervals by which to group the results. Use the maxResults field to limit the number of results to return in a single response and the nextToken field to return the next batch of results if the response does not return the full set of results. Note that an order field exists in both binBy and metrics. You can specify only one order in a given request.

Sourcemodule ListIntentMetricsResponse : sig ... end

Retrieves summary metrics for the intents in your bot. The following fields are required: metrics – A list of AnalyticsIntentMetric objects. In each object, use the name field to specify the metric to calculate, the statistic field to specify whether to calculate the Sum, Average, or Max number, and the order field to specify whether to sort the results in Ascending or Descending order. startDateTime and endDateTime – Define a time range for which you want to retrieve results. Of the optional fields, you can organize the results in the following ways: Use the filters field to filter the results, the groupBy field to specify categories by which to group the results, and the binBy field to specify time intervals by which to group the results. Use the maxResults field to limit the number of results to return in a single response and the nextToken field to return the next batch of results if the response does not return the full set of results. Note that an order field exists in both binBy and metrics. You can specify only one order in a given request.

Sourcemodule ListIntentPathsRequest : sig ... end

Retrieves summary statistics for a path of intents that users take over sessions with your bot. The following fields are required: startDateTime and endDateTime – Define a time range for which you want to retrieve results. intentPath – Define an order of intents for which you want to retrieve metrics. Separate intents in the path with a forward slash. For example, populate the intentPath field with /BookCar/BookHotel to see details about how many times users invoked the BookCar and BookHotel intents in that order. Use the optional filters field to filter the results.

Sourcemodule ListIntentPathsResponse : sig ... end

Retrieves summary statistics for a path of intents that users take over sessions with your bot. The following fields are required: startDateTime and endDateTime – Define a time range for which you want to retrieve results. intentPath – Define an order of intents for which you want to retrieve metrics. Separate intents in the path with a forward slash. For example, populate the intentPath field with /BookCar/BookHotel to see details about how many times users invoked the BookCar and BookHotel intents in that order. Use the optional filters field to filter the results.

Retrieves summary metrics for the stages within intents in your bot. The following fields are required: metrics – A list of AnalyticsIntentStageMetric objects. In each object, use the name field to specify the metric to calculate, the statistic field to specify whether to calculate the Sum, Average, or Max number, and the order field to specify whether to sort the results in Ascending or Descending order. startDateTime and endDateTime – Define a time range for which you want to retrieve results. Of the optional fields, you can organize the results in the following ways: Use the filters field to filter the results, the groupBy field to specify categories by which to group the results, and the binBy field to specify time intervals by which to group the results. Use the maxResults field to limit the number of results to return in a single response and the nextToken field to return the next batch of results if the response does not return the full set of results. Note that an order field exists in both binBy and metrics. You can only specify one order in a given request.

Retrieves summary metrics for the stages within intents in your bot. The following fields are required: metrics – A list of AnalyticsIntentStageMetric objects. In each object, use the name field to specify the metric to calculate, the statistic field to specify whether to calculate the Sum, Average, or Max number, and the order field to specify whether to sort the results in Ascending or Descending order. startDateTime and endDateTime – Define a time range for which you want to retrieve results. Of the optional fields, you can organize the results in the following ways: Use the filters field to filter the results, the groupBy field to specify categories by which to group the results, and the binBy field to specify time intervals by which to group the results. Use the maxResults field to limit the number of results to return in a single response and the nextToken field to return the next batch of results if the response does not return the full set of results. Note that an order field exists in both binBy and metrics. You can only specify one order in a given request.

Sourcemodule ListIntentsRequest : sig ... end

Get a list of intents that meet the specified criteria.

Sourcemodule ListIntentsResponse : sig ... end

Get a list of intents that meet the specified criteria.

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

Sourcemodule SampleUtterancesCount : sig ... end
Sourcemodule RecommendedIntentSummary : sig ... end

An object that contains a summary of a recommended intent.

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

Sourcemodule SessionDataSortBy : sig ... end

An object specifying the measure and method by which to sort the session analytics data.

Retrieves a list of metadata for individual user sessions with your bot. The startDateTime and endDateTime fields are required. These fields define a time range for which you want to retrieve results. Of the optional fields, you can organize the results in the following ways: Use the filters field to filter the results and the sortBy field to specify the values by which to sort the results. Use the maxResults field to limit the number of results to return in a single response and the nextToken field to return the next batch of results if the response does not return the full set of results.

Sourcemodule SessionSpecification : sig ... end

An object containing information about a specific session.

Sourcemodule SessionSpecifications : sig ... end

Retrieves a list of metadata for individual user sessions with your bot. The startDateTime and endDateTime fields are required. These fields define a time range for which you want to retrieve results. Of the optional fields, you can organize the results in the following ways: Use the filters field to filter the results and the sortBy field to specify the values by which to sort the results. Use the maxResults field to limit the number of results to return in a single response and the nextToken field to return the next batch of results if the response does not return the full set of results.

Sourcemodule ListSessionMetricsRequest : sig ... end

Retrieves summary metrics for the user sessions with your bot. The following fields are required: metrics – A list of AnalyticsSessionMetric objects. In each object, use the name field to specify the metric to calculate, the statistic field to specify whether to calculate the Sum, Average, or Max number, and the order field to specify whether to sort the results in Ascending or Descending order. startDateTime and endDateTime – Define a time range for which you want to retrieve results. Of the optional fields, you can organize the results in the following ways: Use the filters field to filter the results, the groupBy field to specify categories by which to group the results, and the binBy field to specify time intervals by which to group the results. Use the maxResults field to limit the number of results to return in a single response and the nextToken field to return the next batch of results if the response does not return the full set of results. Note that an order field exists in both binBy and metrics. Currently, you can specify it in either field, but not in both.

Retrieves summary metrics for the user sessions with your bot. The following fields are required: metrics – A list of AnalyticsSessionMetric objects. In each object, use the name field to specify the metric to calculate, the statistic field to specify whether to calculate the Sum, Average, or Max number, and the order field to specify whether to sort the results in Ascending or Descending order. startDateTime and endDateTime – Define a time range for which you want to retrieve results. Of the optional fields, you can organize the results in the following ways: Use the filters field to filter the results, the groupBy field to specify categories by which to group the results, and the binBy field to specify time intervals by which to group the results. Use the maxResults field to limit the number of results to return in a single response and the nextToken field to return the next batch of results if the response does not return the full set of results. Note that an order field exists in both binBy and metrics. Currently, you can specify it in either field, but not in both.

Sourcemodule SlotTypeSortAttribute : sig ... end
Sourcemodule SlotTypeSortBy : sig ... end

Specifies attributes for sorting a list of slot types.

Sourcemodule SlotTypeFilterOperator : sig ... end
Sourcemodule SlotTypeFilterName : sig ... end
Sourcemodule SlotTypeFilter : sig ... end

Filters the response from the ListSlotTypes operation.

Sourcemodule SlotTypeFilters : sig ... end
Sourcemodule ListSlotTypesRequest : sig ... end

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

Sourcemodule SlotTypeCategory : sig ... end
Sourcemodule SlotTypeSummary : sig ... end

Provides summary information about a slot type.

Sourcemodule SlotTypeSummaryList : sig ... end
Sourcemodule ListSlotTypesResponse : sig ... end

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

Sourcemodule SlotSortAttribute : sig ... end
Sourcemodule SlotSortBy : sig ... end

Specifies attributes for sorting a list of bots.

Sourcemodule SlotFilterOperator : sig ... end
Sourcemodule SlotFilterName : sig ... end
Sourcemodule SlotFilter : sig ... end

Filters the response from the ListSlots operation.

Sourcemodule SlotFilters : sig ... end
Sourcemodule ListSlotsRequest : sig ... end

Gets a list of slots that match the specified criteria.

Sourcemodule SlotSummary : sig ... end

Summary information about a slot, a value that the bot elicits from the user.

Sourcemodule SlotSummaryList : sig ... end
Sourcemodule ListSlotsResponse : sig ... end

Gets a list of slots that match the specified criteria.

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

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

Sourcemodule TestResultTypeFilter : sig ... end

Contains information about the method by which to filter the results of the test execution.

Gets a list of test execution result items.

module UserTurnSlotOutput : sig ... end

Contains information about a slot output by the test set execution.

module UserTurnSlotOutputList : sig ... end
module UserTurnSlotOutputMap : sig ... end
Sourcemodule UserTurnIntentOutput : sig ... end

Contains information about the intent that is output for the turn by the test execution.

Sourcemodule TestSetUtteranceText : sig ... end

Contains results that are output for the user turn by the test execution.

Contains information about the audio for an utterance.

Contains information about input of an utterance.

Contains information about the user messages in the turn in the input.

Sourcemodule UserTurnResult : sig ... end

Contains the results for the user turn by the test execution.

Sourcemodule TestSetTurnResult : sig ... end

Contains information about the results of the analysis of a turn in the test set.

Sourcemodule RecordNumber : sig ... end

Contains information about multiple utterances in the results of a test set execution.

Sourcemodule UtteranceLevelTestResults : sig ... end

Contains information about the utterances in the results of the test set execution.

Sourcemodule OverallTestResultItem : sig ... end

Information about the overall results for a test execution result.

Sourcemodule OverallTestResultItemList : sig ... end
Sourcemodule OverallTestResults : sig ... end

Information about the overall test results.

Sourcemodule TestExecutionResultItems : sig ... end

Contains the results of the test execution, grouped by type of results. See Test result details">Test results details for details about different types of results.

Gets a list of test execution result items.

Sourcemodule TestExecutionSortBy : sig ... end

Contains information about the method by which to sort the instances of test executions you have carried out.

Sourcemodule ListTestExecutionsRequest : sig ... end

The list of test set executions.

Sourcemodule TestExecutionSummary : sig ... end

Summarizes metadata about the test execution.

Sourcemodule TestExecutionSummaryList : sig ... end

The list of test set executions.

Sourcemodule ListTestSetRecordsRequest : sig ... end

The list of test set records.

Sourcemodule UserTurnSpecification : sig ... end

Contains information about the expected and input values for the user turn.

Sourcemodule TurnSpecification : sig ... end

Contains information about the messages in the turn.

Sourcemodule TurnNumber : sig ... end
Sourcemodule TestSetTurnRecord : sig ... end

Contains information about a turn in a test set.

Sourcemodule TestSetTurnRecordList : sig ... end

The list of test set records.

Sourcemodule TestSetSortAttribute : sig ... end
Sourcemodule TestSetSortBy : sig ... end

Contains information about the methods by which to sort the test set.

Sourcemodule ListTestSetsRequest : sig ... end

The list of the test sets

Sourcemodule TestSetSummary : sig ... end

Contains summary information about the test set.

Sourcemodule TestSetSummaryList : sig ... end
Sourcemodule ListTestSetsResponse : sig ... end

The list of the test sets

Sourcemodule UtteranceDataSortBy : sig ... end

An object specifying the measure and method by which to sort the utterance data.

To use this API operation, your IAM role must have permissions to perform the ListAggregatedUtterances operation, which provides access to utterance-related analytics. See Viewing utterance statistics for the IAM policy to apply to the IAM role. Retrieves a list of metadata for individual user utterances to your bot. The following fields are required: startDateTime and endDateTime – Define a time range for which you want to retrieve results. Of the optional fields, you can organize the results in the following ways: Use the filters field to filter the results and the sortBy field to specify the values by which to sort the results. Use the maxResults field to limit the number of results to return in a single response and the nextToken field to return the next batch of results if the response does not return the full set of results.

Sourcemodule UtteranceUnderstood : sig ... end
Sourcemodule UtteranceContentType : sig ... end
Sourcemodule UtteranceBotResponse : sig ... end

An object that contains a response to the utterance from the bot.

Sourcemodule UtteranceBotResponses : sig ... end
Sourcemodule UtteranceSpecification : sig ... end

An object containing information about a specific utterance.

Sourcemodule UtteranceSpecifications : sig ... end

To use this API operation, your IAM role must have permissions to perform the ListAggregatedUtterances operation, which provides access to utterance-related analytics. See Viewing utterance statistics for the IAM policy to apply to the IAM role. Retrieves a list of metadata for individual user utterances to your bot. The following fields are required: startDateTime and endDateTime – Define a time range for which you want to retrieve results. Of the optional fields, you can organize the results in the following ways: Use the filters field to filter the results and the sortBy field to specify the values by which to sort the results. Use the maxResults field to limit the number of results to return in a single response and the nextToken field to return the next batch of results if the response does not return the full set of results.

To use this API operation, your IAM role must have permissions to perform the ListAggregatedUtterances operation, which provides access to utterance-related analytics. See Viewing utterance statistics for the IAM policy to apply to the IAM role. Retrieves summary metrics for the utterances in your bot. The following fields are required: metrics – A list of AnalyticsUtteranceMetric objects. In each object, use the name field to specify the metric to calculate, the statistic field to specify whether to calculate the Sum, Average, or Max number, and the order field to specify whether to sort the results in Ascending or Descending order. startDateTime and endDateTime – Define a time range for which you want to retrieve results. Of the optional fields, you can organize the results in the following ways: Use the filters field to filter the results, the groupBy field to specify categories by which to group the results, and the binBy field to specify time intervals by which to group the results. Use the maxResults field to limit the number of results to return in a single response and the nextToken field to return the next batch of results if the response does not return the full set of results. Note that an order field exists in both binBy and metrics. Currently, you can specify it in either field, but not in both.

To use this API operation, your IAM role must have permissions to perform the ListAggregatedUtterances operation, which provides access to utterance-related analytics. See Viewing utterance statistics for the IAM policy to apply to the IAM role. Retrieves summary metrics for the utterances in your bot. The following fields are required: metrics – A list of AnalyticsUtteranceMetric objects. In each object, use the name field to specify the metric to calculate, the statistic field to specify whether to calculate the Sum, Average, or Max number, and the order field to specify whether to sort the results in Ascending or Descending order. startDateTime and endDateTime – Define a time range for which you want to retrieve results. Of the optional fields, you can organize the results in the following ways: Use the filters field to filter the results, the groupBy field to specify categories by which to group the results, and the binBy field to specify time intervals by which to group the results. Use the maxResults field to limit the number of results to return in a single response and the nextToken field to return the next batch of results if the response does not return the full set of results. Note that an order field exists in both binBy and metrics. Currently, you can specify it in either field, but not in both.

Sourcemodule NextIndex : sig ... end
Sourcemodule SearchOrder : sig ... end

Search for associated transcripts that meet the specified criteria.

Search for associated transcripts that meet the specified criteria.

Sourcemodule StartBotAnalyzerRequest : sig ... end

Initiates an asynchronous analysis of your bot configuration using AI-powered analysis to identify potential issues and recommend improvements based on AWS best practices. The analysis examines your bot's configuration, including intents, utterances, slots, and conversation flows, to provide actionable recommendations for optimization.

Sourcemodule StartBotAnalyzerResponse : sig ... end

Initiates an asynchronous analysis of your bot configuration using AI-powered analysis to identify potential issues and recommend improvements based on AWS best practices. The analysis examines your bot's configuration, including intents, utterances, slots, and conversation flows, to provide actionable recommendations for optimization.

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

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

Starts a request for the descriptive bot builder to generate a bot locale configuration based on the prompt you provide it. After you make this call, use the DescribeBotResourceGeneration operation to check on the status of the generation and for the generatedBotLocaleUrl when the generation is complete. Use that value to retrieve the Amazon S3 object containing the bot locale configuration. You can then modify and import this configuration.

Starts a request for the descriptive bot builder to generate a bot locale configuration based on the prompt you provide it. After you make this call, use the DescribeBotResourceGeneration operation to check on the status of the generation and for the generatedBotLocaleUrl when the generation is complete. Use that value to retrieve the Amazon S3 object containing the bot locale configuration. You can then modify and import this configuration.

Sourcemodule StartImportRequest : sig ... end

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

Sourcemodule StartImportResponse : sig ... end

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

Sourcemodule StartTestExecutionRequest : sig ... end

The action to start test set execution.

The action to start test set execution.

The action to start the generation of test set.

The action to start the generation of test set.

Sourcemodule StopBotAnalyzerRequest : sig ... end

Cancels an ongoing bot analysis execution. Once stopped, the analysis cannot be resumed and no recommendations will be generated.

Sourcemodule StopBotAnalyzerResponse : sig ... end

Cancels an ongoing bot analysis execution. Once stopped, the analysis cannot be resumed and no recommendations will be generated.

Stop an already running Bot Recommendation request.

Stop an already running Bot Recommendation request.

Sourcemodule TagKeyList : sig ... end
Sourcemodule TagResourceRequest : sig ... end

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

Sourcemodule TagResourceResponse : sig ... end

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

Sourcemodule UntagResourceRequest : sig ... end

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

Sourcemodule UntagResourceResponse : sig ... end

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

Sourcemodule UpdateBotAliasRequest : sig ... end

Updates the configuration of an existing bot alias.

Sourcemodule UpdateBotAliasResponse : sig ... end

Updates the configuration of an existing bot alias.

Sourcemodule UpdateBotLocaleRequest : sig ... end

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

Sourcemodule UpdateBotLocaleResponse : sig ... end

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

Updates an existing bot recommendation request.

Updates an existing bot recommendation request.

Sourcemodule UpdateBotRequest : sig ... end

Updates the configuration of an existing bot.

Sourcemodule UpdateBotResponse : sig ... end

Updates the configuration of an existing bot.

Sourcemodule UpdateExportRequest : sig ... end

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

Sourcemodule UpdateExportResponse : sig ... end

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

Sourcemodule UpdateIntentRequest : sig ... end

Updates the settings for an intent.

Sourcemodule UpdateIntentResponse : sig ... end

Updates the settings for an intent.

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

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

Sourcemodule UpdateSlotRequest : sig ... end

Updates the settings for a slot.

Sourcemodule UpdateSlotResponse : sig ... end

Updates the settings for a slot.

Sourcemodule UpdateSlotTypeRequest : sig ... end

Updates the configuration of an existing slot type.

Sourcemodule UpdateSlotTypeResponse : sig ... end

Updates the configuration of an existing slot type.

Sourcemodule UpdateTestSetRequest : sig ... end

The action to update the test set.

Sourcemodule UpdateTestSetResponse : sig ... end

The action to update the test set.