| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.LexModels.Types
Contents
- Service Configuration
- Errors
- ChannelStatus
- ChannelType
- ContentType
- Destination
- ExportStatus
- ExportType
- FulfillmentActivityType
- ImportStatus
- LexStatus
- Locale
- LogType
- MergeStrategy
- MigrationAlertType
- MigrationSortAttribute
- MigrationStatus
- MigrationStrategy
- ObfuscationSetting
- ProcessBehavior
- ResourceType
- SlotConstraint
- SlotValueSelectionStrategy
- SortOrder
- StatusType
- BotAliasMetadata
- BotChannelAssociation
- BotMetadata
- BuiltinIntentMetadata
- BuiltinIntentSlot
- BuiltinSlotTypeMetadata
- CodeHook
- ConversationLogsRequest
- ConversationLogsResponse
- EnumerationValue
- FollowUpPrompt
- FulfillmentActivity
- InputContext
- Intent
- IntentMetadata
- KendraConfiguration
- LogSettingsRequest
- LogSettingsResponse
- Message
- MigrationAlert
- MigrationSummary
- OutputContext
- Prompt
- Slot
- SlotDefaultValue
- SlotDefaultValueSpec
- SlotTypeConfiguration
- SlotTypeMetadata
- SlotTypeRegexConfiguration
- Statement
- Tag
- UtteranceData
- UtteranceList
Description
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError
- _PreconditionFailedException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConflictException :: AsError a => Getting (First ServiceError) a ServiceError
- _NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalFailureException :: AsError a => Getting (First ServiceError) a ServiceError
- _BadRequestException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError
- newtype ChannelStatus where
- ChannelStatus' { }
- pattern ChannelStatus_CREATED :: ChannelStatus
- pattern ChannelStatus_FAILED :: ChannelStatus
- pattern ChannelStatus_IN_PROGRESS :: ChannelStatus
- newtype ChannelType where
- ChannelType' { }
- pattern ChannelType_Facebook :: ChannelType
- pattern ChannelType_Kik :: ChannelType
- pattern ChannelType_Slack :: ChannelType
- pattern ChannelType_Twilio_Sms :: ChannelType
- newtype ContentType where
- ContentType' { }
- pattern ContentType_CustomPayload :: ContentType
- pattern ContentType_PlainText :: ContentType
- pattern ContentType_SSML :: ContentType
- newtype Destination where
- Destination' { }
- pattern Destination_CLOUDWATCH_LOGS :: Destination
- pattern Destination_S3 :: Destination
- newtype ExportStatus where
- ExportStatus' { }
- pattern ExportStatus_FAILED :: ExportStatus
- pattern ExportStatus_IN_PROGRESS :: ExportStatus
- pattern ExportStatus_READY :: ExportStatus
- newtype ExportType where
- ExportType' { }
- pattern ExportType_ALEXA_SKILLS_KIT :: ExportType
- pattern ExportType_LEX :: ExportType
- newtype FulfillmentActivityType where
- newtype ImportStatus where
- ImportStatus' { }
- pattern ImportStatus_COMPLETE :: ImportStatus
- pattern ImportStatus_FAILED :: ImportStatus
- pattern ImportStatus_IN_PROGRESS :: ImportStatus
- newtype LexStatus where
- LexStatus' { }
- pattern LexStatus_BUILDING :: LexStatus
- pattern LexStatus_FAILED :: LexStatus
- pattern LexStatus_NOT_BUILT :: LexStatus
- pattern LexStatus_READY :: LexStatus
- pattern LexStatus_READY_BASIC_TESTING :: LexStatus
- newtype Locale where
- Locale' {
- fromLocale :: Text
- pattern Locale_De_DE :: Locale
- pattern Locale_En_AU :: Locale
- pattern Locale_En_GB :: Locale
- pattern Locale_En_IN :: Locale
- pattern Locale_En_US :: Locale
- pattern Locale_Es_419 :: Locale
- pattern Locale_Es_ES :: Locale
- pattern Locale_Es_US :: Locale
- pattern Locale_Fr_CA :: Locale
- pattern Locale_Fr_FR :: Locale
- pattern Locale_It_IT :: Locale
- pattern Locale_Ja_JP :: Locale
- pattern Locale_Ko_KR :: Locale
- Locale' {
- newtype LogType where
- LogType' {
- fromLogType :: Text
- pattern LogType_AUDIO :: LogType
- pattern LogType_TEXT :: LogType
- LogType' {
- newtype MergeStrategy where
- MergeStrategy' { }
- pattern MergeStrategy_FAIL_ON_CONFLICT :: MergeStrategy
- pattern MergeStrategy_OVERWRITE_LATEST :: MergeStrategy
- newtype MigrationAlertType where
- MigrationAlertType' { }
- pattern MigrationAlertType_ERROR :: MigrationAlertType
- pattern MigrationAlertType_WARN :: MigrationAlertType
- newtype MigrationSortAttribute where
- newtype MigrationStatus where
- MigrationStatus' { }
- pattern MigrationStatus_COMPLETED :: MigrationStatus
- pattern MigrationStatus_FAILED :: MigrationStatus
- pattern MigrationStatus_IN_PROGRESS :: MigrationStatus
- newtype MigrationStrategy where
- newtype ObfuscationSetting where
- newtype ProcessBehavior where
- ProcessBehavior' { }
- pattern ProcessBehavior_BUILD :: ProcessBehavior
- pattern ProcessBehavior_SAVE :: ProcessBehavior
- newtype ResourceType where
- ResourceType' { }
- pattern ResourceType_BOT :: ResourceType
- pattern ResourceType_INTENT :: ResourceType
- pattern ResourceType_SLOT_TYPE :: ResourceType
- newtype SlotConstraint where
- SlotConstraint' { }
- pattern SlotConstraint_Optional :: SlotConstraint
- pattern SlotConstraint_Required :: SlotConstraint
- newtype SlotValueSelectionStrategy where
- newtype SortOrder where
- SortOrder' { }
- pattern SortOrder_ASCENDING :: SortOrder
- pattern SortOrder_DESCENDING :: SortOrder
- newtype StatusType where
- StatusType' { }
- pattern StatusType_Detected :: StatusType
- pattern StatusType_Missed :: StatusType
- data BotAliasMetadata = BotAliasMetadata' {}
- newBotAliasMetadata :: BotAliasMetadata
- botAliasMetadata_checksum :: Lens' BotAliasMetadata (Maybe Text)
- botAliasMetadata_botVersion :: Lens' BotAliasMetadata (Maybe Text)
- botAliasMetadata_botName :: Lens' BotAliasMetadata (Maybe Text)
- botAliasMetadata_createdDate :: Lens' BotAliasMetadata (Maybe UTCTime)
- botAliasMetadata_name :: Lens' BotAliasMetadata (Maybe Text)
- botAliasMetadata_conversationLogs :: Lens' BotAliasMetadata (Maybe ConversationLogsResponse)
- botAliasMetadata_lastUpdatedDate :: Lens' BotAliasMetadata (Maybe UTCTime)
- botAliasMetadata_description :: Lens' BotAliasMetadata (Maybe Text)
- data BotChannelAssociation = BotChannelAssociation' {
- failureReason :: Maybe Text
- status :: Maybe ChannelStatus
- botAlias :: Maybe Text
- botName :: Maybe Text
- botConfiguration :: Maybe (Sensitive (HashMap Text Text))
- createdDate :: Maybe POSIX
- name :: Maybe Text
- type' :: Maybe ChannelType
- description :: Maybe Text
- newBotChannelAssociation :: BotChannelAssociation
- botChannelAssociation_failureReason :: Lens' BotChannelAssociation (Maybe Text)
- botChannelAssociation_status :: Lens' BotChannelAssociation (Maybe ChannelStatus)
- botChannelAssociation_botAlias :: Lens' BotChannelAssociation (Maybe Text)
- botChannelAssociation_botName :: Lens' BotChannelAssociation (Maybe Text)
- botChannelAssociation_botConfiguration :: Lens' BotChannelAssociation (Maybe (HashMap Text Text))
- botChannelAssociation_createdDate :: Lens' BotChannelAssociation (Maybe UTCTime)
- botChannelAssociation_name :: Lens' BotChannelAssociation (Maybe Text)
- botChannelAssociation_type :: Lens' BotChannelAssociation (Maybe ChannelType)
- botChannelAssociation_description :: Lens' BotChannelAssociation (Maybe Text)
- data BotMetadata = BotMetadata' {}
- newBotMetadata :: BotMetadata
- botMetadata_status :: Lens' BotMetadata (Maybe LexStatus)
- botMetadata_createdDate :: Lens' BotMetadata (Maybe UTCTime)
- botMetadata_name :: Lens' BotMetadata (Maybe Text)
- botMetadata_version :: Lens' BotMetadata (Maybe Text)
- botMetadata_lastUpdatedDate :: Lens' BotMetadata (Maybe UTCTime)
- botMetadata_description :: Lens' BotMetadata (Maybe Text)
- data BuiltinIntentMetadata = BuiltinIntentMetadata' {}
- newBuiltinIntentMetadata :: BuiltinIntentMetadata
- builtinIntentMetadata_signature :: Lens' BuiltinIntentMetadata (Maybe Text)
- builtinIntentMetadata_supportedLocales :: Lens' BuiltinIntentMetadata (Maybe [Locale])
- data BuiltinIntentSlot = BuiltinIntentSlot' {}
- newBuiltinIntentSlot :: BuiltinIntentSlot
- builtinIntentSlot_name :: Lens' BuiltinIntentSlot (Maybe Text)
- data BuiltinSlotTypeMetadata = BuiltinSlotTypeMetadata' {}
- newBuiltinSlotTypeMetadata :: BuiltinSlotTypeMetadata
- builtinSlotTypeMetadata_signature :: Lens' BuiltinSlotTypeMetadata (Maybe Text)
- builtinSlotTypeMetadata_supportedLocales :: Lens' BuiltinSlotTypeMetadata (Maybe [Locale])
- data CodeHook = CodeHook' {
- uri :: Text
- messageVersion :: Text
- newCodeHook :: Text -> Text -> CodeHook
- codeHook_uri :: Lens' CodeHook Text
- codeHook_messageVersion :: Lens' CodeHook Text
- data ConversationLogsRequest = ConversationLogsRequest' {}
- newConversationLogsRequest :: Text -> ConversationLogsRequest
- conversationLogsRequest_logSettings :: Lens' ConversationLogsRequest [LogSettingsRequest]
- conversationLogsRequest_iamRoleArn :: Lens' ConversationLogsRequest Text
- data ConversationLogsResponse = ConversationLogsResponse' {}
- newConversationLogsResponse :: ConversationLogsResponse
- conversationLogsResponse_iamRoleArn :: Lens' ConversationLogsResponse (Maybe Text)
- conversationLogsResponse_logSettings :: Lens' ConversationLogsResponse (Maybe [LogSettingsResponse])
- data EnumerationValue = EnumerationValue' {}
- newEnumerationValue :: Text -> EnumerationValue
- enumerationValue_synonyms :: Lens' EnumerationValue (Maybe [Text])
- enumerationValue_value :: Lens' EnumerationValue Text
- data FollowUpPrompt = FollowUpPrompt' {}
- newFollowUpPrompt :: Prompt -> Statement -> FollowUpPrompt
- followUpPrompt_prompt :: Lens' FollowUpPrompt Prompt
- followUpPrompt_rejectionStatement :: Lens' FollowUpPrompt Statement
- data FulfillmentActivity = FulfillmentActivity' {}
- newFulfillmentActivity :: FulfillmentActivityType -> FulfillmentActivity
- fulfillmentActivity_codeHook :: Lens' FulfillmentActivity (Maybe CodeHook)
- fulfillmentActivity_type :: Lens' FulfillmentActivity FulfillmentActivityType
- data InputContext = InputContext' {}
- newInputContext :: Text -> InputContext
- inputContext_name :: Lens' InputContext Text
- data Intent = Intent' {
- intentName :: Text
- intentVersion :: Text
- newIntent :: Text -> Text -> Intent
- intent_intentName :: Lens' Intent Text
- intent_intentVersion :: Lens' Intent Text
- data IntentMetadata = IntentMetadata' {
- createdDate :: Maybe POSIX
- name :: Maybe Text
- version :: Maybe Text
- lastUpdatedDate :: Maybe POSIX
- description :: Maybe Text
- newIntentMetadata :: IntentMetadata
- intentMetadata_createdDate :: Lens' IntentMetadata (Maybe UTCTime)
- intentMetadata_name :: Lens' IntentMetadata (Maybe Text)
- intentMetadata_version :: Lens' IntentMetadata (Maybe Text)
- intentMetadata_lastUpdatedDate :: Lens' IntentMetadata (Maybe UTCTime)
- intentMetadata_description :: Lens' IntentMetadata (Maybe Text)
- data KendraConfiguration = KendraConfiguration' {
- queryFilterString :: Maybe Text
- kendraIndex :: Text
- role' :: Text
- newKendraConfiguration :: Text -> Text -> KendraConfiguration
- kendraConfiguration_queryFilterString :: Lens' KendraConfiguration (Maybe Text)
- kendraConfiguration_kendraIndex :: Lens' KendraConfiguration Text
- kendraConfiguration_role :: Lens' KendraConfiguration Text
- data LogSettingsRequest = LogSettingsRequest' {}
- newLogSettingsRequest :: LogType -> Destination -> Text -> LogSettingsRequest
- logSettingsRequest_kmsKeyArn :: Lens' LogSettingsRequest (Maybe Text)
- logSettingsRequest_logType :: Lens' LogSettingsRequest LogType
- logSettingsRequest_destination :: Lens' LogSettingsRequest Destination
- logSettingsRequest_resourceArn :: Lens' LogSettingsRequest Text
- data LogSettingsResponse = LogSettingsResponse' {}
- newLogSettingsResponse :: LogSettingsResponse
- logSettingsResponse_destination :: Lens' LogSettingsResponse (Maybe Destination)
- logSettingsResponse_kmsKeyArn :: Lens' LogSettingsResponse (Maybe Text)
- logSettingsResponse_logType :: Lens' LogSettingsResponse (Maybe LogType)
- logSettingsResponse_resourceArn :: Lens' LogSettingsResponse (Maybe Text)
- logSettingsResponse_resourcePrefix :: Lens' LogSettingsResponse (Maybe Text)
- data Message = Message' {}
- newMessage :: ContentType -> Text -> Message
- message_groupNumber :: Lens' Message (Maybe Natural)
- message_contentType :: Lens' Message ContentType
- message_content :: Lens' Message Text
- data MigrationAlert = MigrationAlert' {}
- newMigrationAlert :: MigrationAlert
- migrationAlert_referenceURLs :: Lens' MigrationAlert (Maybe [Text])
- migrationAlert_details :: Lens' MigrationAlert (Maybe [Text])
- migrationAlert_type :: Lens' MigrationAlert (Maybe MigrationAlertType)
- migrationAlert_message :: Lens' MigrationAlert (Maybe Text)
- data MigrationSummary = MigrationSummary' {}
- newMigrationSummary :: MigrationSummary
- migrationSummary_v1BotVersion :: Lens' MigrationSummary (Maybe Text)
- migrationSummary_migrationStrategy :: Lens' MigrationSummary (Maybe MigrationStrategy)
- migrationSummary_migrationTimestamp :: Lens' MigrationSummary (Maybe UTCTime)
- migrationSummary_migrationStatus :: Lens' MigrationSummary (Maybe MigrationStatus)
- migrationSummary_v2BotId :: Lens' MigrationSummary (Maybe Text)
- migrationSummary_v1BotLocale :: Lens' MigrationSummary (Maybe Locale)
- migrationSummary_v1BotName :: Lens' MigrationSummary (Maybe Text)
- migrationSummary_v2BotRole :: Lens' MigrationSummary (Maybe Text)
- migrationSummary_migrationId :: Lens' MigrationSummary (Maybe Text)
- data OutputContext = OutputContext' {}
- newOutputContext :: Text -> Natural -> Natural -> OutputContext
- outputContext_name :: Lens' OutputContext Text
- outputContext_timeToLiveInSeconds :: Lens' OutputContext Natural
- outputContext_turnsToLive :: Lens' OutputContext Natural
- data Prompt = Prompt' {}
- newPrompt :: NonEmpty Message -> Natural -> Prompt
- prompt_responseCard :: Lens' Prompt (Maybe Text)
- prompt_messages :: Lens' Prompt (NonEmpty Message)
- prompt_maxAttempts :: Lens' Prompt Natural
- data Slot = Slot' {
- slotType :: Maybe Text
- valueElicitationPrompt :: Maybe Prompt
- responseCard :: Maybe Text
- priority :: Maybe Natural
- obfuscationSetting :: Maybe ObfuscationSetting
- defaultValueSpec :: Maybe SlotDefaultValueSpec
- slotTypeVersion :: Maybe Text
- sampleUtterances :: Maybe [Text]
- description :: Maybe Text
- name :: Text
- slotConstraint :: SlotConstraint
- newSlot :: Text -> SlotConstraint -> Slot
- slot_slotType :: Lens' Slot (Maybe Text)
- slot_valueElicitationPrompt :: Lens' Slot (Maybe Prompt)
- slot_responseCard :: Lens' Slot (Maybe Text)
- slot_priority :: Lens' Slot (Maybe Natural)
- slot_obfuscationSetting :: Lens' Slot (Maybe ObfuscationSetting)
- slot_defaultValueSpec :: Lens' Slot (Maybe SlotDefaultValueSpec)
- slot_slotTypeVersion :: Lens' Slot (Maybe Text)
- slot_sampleUtterances :: Lens' Slot (Maybe [Text])
- slot_description :: Lens' Slot (Maybe Text)
- slot_name :: Lens' Slot Text
- slot_slotConstraint :: Lens' Slot SlotConstraint
- data SlotDefaultValue = SlotDefaultValue' {
- defaultValue :: Text
- newSlotDefaultValue :: Text -> SlotDefaultValue
- slotDefaultValue_defaultValue :: Lens' SlotDefaultValue Text
- data SlotDefaultValueSpec = SlotDefaultValueSpec' {}
- newSlotDefaultValueSpec :: SlotDefaultValueSpec
- slotDefaultValueSpec_defaultValueList :: Lens' SlotDefaultValueSpec [SlotDefaultValue]
- data SlotTypeConfiguration = SlotTypeConfiguration' {}
- newSlotTypeConfiguration :: SlotTypeConfiguration
- slotTypeConfiguration_regexConfiguration :: Lens' SlotTypeConfiguration (Maybe SlotTypeRegexConfiguration)
- data SlotTypeMetadata = SlotTypeMetadata' {
- createdDate :: Maybe POSIX
- name :: Maybe Text
- version :: Maybe Text
- lastUpdatedDate :: Maybe POSIX
- description :: Maybe Text
- newSlotTypeMetadata :: SlotTypeMetadata
- slotTypeMetadata_createdDate :: Lens' SlotTypeMetadata (Maybe UTCTime)
- slotTypeMetadata_name :: Lens' SlotTypeMetadata (Maybe Text)
- slotTypeMetadata_version :: Lens' SlotTypeMetadata (Maybe Text)
- slotTypeMetadata_lastUpdatedDate :: Lens' SlotTypeMetadata (Maybe UTCTime)
- slotTypeMetadata_description :: Lens' SlotTypeMetadata (Maybe Text)
- data SlotTypeRegexConfiguration = SlotTypeRegexConfiguration' {}
- newSlotTypeRegexConfiguration :: Text -> SlotTypeRegexConfiguration
- slotTypeRegexConfiguration_pattern :: Lens' SlotTypeRegexConfiguration Text
- data Statement = Statement' {}
- newStatement :: NonEmpty Message -> Statement
- statement_responseCard :: Lens' Statement (Maybe Text)
- statement_messages :: Lens' Statement (NonEmpty Message)
- data Tag = Tag' {}
- newTag :: Text -> Text -> Tag
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
- data UtteranceData = UtteranceData' {}
- newUtteranceData :: UtteranceData
- utteranceData_firstUtteredDate :: Lens' UtteranceData (Maybe UTCTime)
- utteranceData_count :: Lens' UtteranceData (Maybe Int)
- utteranceData_utteranceString :: Lens' UtteranceData (Maybe Text)
- utteranceData_lastUtteredDate :: Lens' UtteranceData (Maybe UTCTime)
- utteranceData_distinctUsers :: Lens' UtteranceData (Maybe Int)
- data UtteranceList = UtteranceList' {
- botVersion :: Maybe Text
- utterances :: Maybe [UtteranceData]
- newUtteranceList :: UtteranceList
- utteranceList_botVersion :: Lens' UtteranceList (Maybe Text)
- utteranceList_utterances :: Lens' UtteranceList (Maybe [UtteranceData])
Service Configuration
defaultService :: Service Source #
API version 2017-04-19 of the Amazon Lex Model Building Service SDK configuration.
Errors
_AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Your IAM user or role does not have permission to call the Amazon Lex V2 APIs required to migrate your bot.
_PreconditionFailedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The checksum of the resource that you are trying to change does not match the checksum in the request. Check the resource's checksum and try again.
_ConflictException :: AsError a => Getting (First ServiceError) a ServiceError Source #
There was a conflict processing the request. Try your request again.
_NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource specified in the request was not found. Check the resource and try again.
_InternalFailureException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An internal Amazon Lex error occurred. Try your request again.
_BadRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request exceeded a limit. Try your request again.
_ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource that you are attempting to delete is referred to by another resource. Use this information to remove references to the resource that you are trying to delete.
The body of the exception contains a JSON object that describes the resource.
{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,"resourceReference": {"name": string, "version": string } }
ChannelStatus
newtype ChannelStatus Source #
Constructors
| ChannelStatus' | |
Fields | |
Bundled Patterns
| pattern ChannelStatus_CREATED :: ChannelStatus | |
| pattern ChannelStatus_FAILED :: ChannelStatus | |
| pattern ChannelStatus_IN_PROGRESS :: ChannelStatus |
Instances
ChannelType
newtype ChannelType Source #
Constructors
| ChannelType' | |
Fields | |
Bundled Patterns
| pattern ChannelType_Facebook :: ChannelType | |
| pattern ChannelType_Kik :: ChannelType | |
| pattern ChannelType_Slack :: ChannelType | |
| pattern ChannelType_Twilio_Sms :: ChannelType |
Instances
ContentType
newtype ContentType Source #
Constructors
| ContentType' | |
Fields | |
Bundled Patterns
| pattern ContentType_CustomPayload :: ContentType | |
| pattern ContentType_PlainText :: ContentType | |
| pattern ContentType_SSML :: ContentType |
Instances
Destination
newtype Destination Source #
Constructors
| Destination' | |
Fields | |
Bundled Patterns
| pattern Destination_CLOUDWATCH_LOGS :: Destination | |
| pattern Destination_S3 :: Destination |
Instances
ExportStatus
newtype ExportStatus Source #
Constructors
| ExportStatus' | |
Fields | |
Bundled Patterns
| pattern ExportStatus_FAILED :: ExportStatus | |
| pattern ExportStatus_IN_PROGRESS :: ExportStatus | |
| pattern ExportStatus_READY :: ExportStatus |
Instances
ExportType
newtype ExportType Source #
Constructors
| ExportType' | |
Fields | |
Bundled Patterns
| pattern ExportType_ALEXA_SKILLS_KIT :: ExportType | |
| pattern ExportType_LEX :: ExportType |
Instances
FulfillmentActivityType
newtype FulfillmentActivityType Source #
Constructors
| FulfillmentActivityType' | |
Fields | |
Bundled Patterns
| pattern FulfillmentActivityType_CodeHook :: FulfillmentActivityType | |
| pattern FulfillmentActivityType_ReturnIntent :: FulfillmentActivityType |
Instances
ImportStatus
newtype ImportStatus Source #
Constructors
| ImportStatus' | |
Fields | |
Bundled Patterns
| pattern ImportStatus_COMPLETE :: ImportStatus | |
| pattern ImportStatus_FAILED :: ImportStatus | |
| pattern ImportStatus_IN_PROGRESS :: ImportStatus |
Instances
LexStatus
Constructors
| LexStatus' | |
Fields | |
Bundled Patterns
| pattern LexStatus_BUILDING :: LexStatus | |
| pattern LexStatus_FAILED :: LexStatus | |
| pattern LexStatus_NOT_BUILT :: LexStatus | |
| pattern LexStatus_READY :: LexStatus | |
| pattern LexStatus_READY_BASIC_TESTING :: LexStatus |
Instances
Locale
Constructors
| Locale' | |
Fields
| |
Bundled Patterns
| pattern Locale_De_DE :: Locale | |
| pattern Locale_En_AU :: Locale | |
| pattern Locale_En_GB :: Locale | |
| pattern Locale_En_IN :: Locale | |
| pattern Locale_En_US :: Locale | |
| pattern Locale_Es_419 :: Locale | |
| pattern Locale_Es_ES :: Locale | |
| pattern Locale_Es_US :: Locale | |
| pattern Locale_Fr_CA :: Locale | |
| pattern Locale_Fr_FR :: Locale | |
| pattern Locale_It_IT :: Locale | |
| pattern Locale_Ja_JP :: Locale | |
| pattern Locale_Ko_KR :: Locale |
Instances
LogType
Constructors
| LogType' | |
Fields
| |
Bundled Patterns
| pattern LogType_AUDIO :: LogType | |
| pattern LogType_TEXT :: LogType |
Instances
MergeStrategy
newtype MergeStrategy Source #
Constructors
| MergeStrategy' | |
Fields | |
Bundled Patterns
| pattern MergeStrategy_FAIL_ON_CONFLICT :: MergeStrategy | |
| pattern MergeStrategy_OVERWRITE_LATEST :: MergeStrategy |
Instances
MigrationAlertType
newtype MigrationAlertType Source #
Constructors
| MigrationAlertType' | |
Fields | |
Bundled Patterns
| pattern MigrationAlertType_ERROR :: MigrationAlertType | |
| pattern MigrationAlertType_WARN :: MigrationAlertType |
Instances
MigrationSortAttribute
newtype MigrationSortAttribute Source #
Constructors
| MigrationSortAttribute' | |
Fields | |
Bundled Patterns
| pattern MigrationSortAttribute_MIGRATION_DATE_TIME :: MigrationSortAttribute | |
| pattern MigrationSortAttribute_V1_BOT_NAME :: MigrationSortAttribute |
Instances
MigrationStatus
newtype MigrationStatus Source #
Constructors
| MigrationStatus' | |
Fields | |
Bundled Patterns
| pattern MigrationStatus_COMPLETED :: MigrationStatus | |
| pattern MigrationStatus_FAILED :: MigrationStatus | |
| pattern MigrationStatus_IN_PROGRESS :: MigrationStatus |
Instances
MigrationStrategy
newtype MigrationStrategy Source #
Constructors
| MigrationStrategy' | |
Fields | |
Bundled Patterns
| pattern MigrationStrategy_CREATE_NEW :: MigrationStrategy | |
| pattern MigrationStrategy_UPDATE_EXISTING :: MigrationStrategy |
Instances
ObfuscationSetting
newtype ObfuscationSetting Source #
Constructors
| ObfuscationSetting' | |
Fields | |
Bundled Patterns
| pattern ObfuscationSetting_DEFAULT_OBFUSCATION :: ObfuscationSetting | |
| pattern ObfuscationSetting_NONE :: ObfuscationSetting |
Instances
ProcessBehavior
newtype ProcessBehavior Source #
Constructors
| ProcessBehavior' | |
Fields | |
Bundled Patterns
| pattern ProcessBehavior_BUILD :: ProcessBehavior | |
| pattern ProcessBehavior_SAVE :: ProcessBehavior |
Instances
ResourceType
newtype ResourceType Source #
Constructors
| ResourceType' | |
Fields | |
Bundled Patterns
| pattern ResourceType_BOT :: ResourceType | |
| pattern ResourceType_INTENT :: ResourceType | |
| pattern ResourceType_SLOT_TYPE :: ResourceType |
Instances
SlotConstraint
newtype SlotConstraint Source #
Constructors
| SlotConstraint' | |
Fields | |
Bundled Patterns
| pattern SlotConstraint_Optional :: SlotConstraint | |
| pattern SlotConstraint_Required :: SlotConstraint |
Instances
SlotValueSelectionStrategy
newtype SlotValueSelectionStrategy Source #
Constructors
| SlotValueSelectionStrategy' | |
Fields | |
Bundled Patterns
| pattern SlotValueSelectionStrategy_ORIGINAL_VALUE :: SlotValueSelectionStrategy | |
| pattern SlotValueSelectionStrategy_TOP_RESOLUTION :: SlotValueSelectionStrategy |
Instances
SortOrder
Constructors
| SortOrder' | |
Fields | |
Bundled Patterns
| pattern SortOrder_ASCENDING :: SortOrder | |
| pattern SortOrder_DESCENDING :: SortOrder |
Instances
StatusType
newtype StatusType Source #
Constructors
| StatusType' | |
Fields | |
Bundled Patterns
| pattern StatusType_Detected :: StatusType | |
| pattern StatusType_Missed :: StatusType |
Instances
BotAliasMetadata
data BotAliasMetadata Source #
Provides information about a bot alias.
See: newBotAliasMetadata smart constructor.
Constructors
| BotAliasMetadata' | |
Fields
| |
Instances
newBotAliasMetadata :: BotAliasMetadata Source #
Create a value of BotAliasMetadata with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:checksum:BotAliasMetadata', botAliasMetadata_checksum - Checksum of the bot alias.
$sel:botVersion:BotAliasMetadata', botAliasMetadata_botVersion - The version of the Amazon Lex bot to which the alias points.
$sel:botName:BotAliasMetadata', botAliasMetadata_botName - The name of the bot to which the alias points.
$sel:createdDate:BotAliasMetadata', botAliasMetadata_createdDate - The date that the bot alias was created.
$sel:name:BotAliasMetadata', botAliasMetadata_name - The name of the bot alias.
$sel:conversationLogs:BotAliasMetadata', botAliasMetadata_conversationLogs - Settings that determine how Amazon Lex uses conversation logs for the
alias.
$sel:lastUpdatedDate:BotAliasMetadata', botAliasMetadata_lastUpdatedDate - The date that the bot alias was updated. When you create a resource, the
creation date and last updated date are the same.
$sel:description:BotAliasMetadata', botAliasMetadata_description - A description of the bot alias.
botAliasMetadata_checksum :: Lens' BotAliasMetadata (Maybe Text) Source #
Checksum of the bot alias.
botAliasMetadata_botVersion :: Lens' BotAliasMetadata (Maybe Text) Source #
The version of the Amazon Lex bot to which the alias points.
botAliasMetadata_botName :: Lens' BotAliasMetadata (Maybe Text) Source #
The name of the bot to which the alias points.
botAliasMetadata_createdDate :: Lens' BotAliasMetadata (Maybe UTCTime) Source #
The date that the bot alias was created.
botAliasMetadata_name :: Lens' BotAliasMetadata (Maybe Text) Source #
The name of the bot alias.
botAliasMetadata_conversationLogs :: Lens' BotAliasMetadata (Maybe ConversationLogsResponse) Source #
Settings that determine how Amazon Lex uses conversation logs for the alias.
botAliasMetadata_lastUpdatedDate :: Lens' BotAliasMetadata (Maybe UTCTime) Source #
The date that the bot alias was updated. When you create a resource, the creation date and last updated date are the same.
botAliasMetadata_description :: Lens' BotAliasMetadata (Maybe Text) Source #
A description of the bot alias.
BotChannelAssociation
data BotChannelAssociation Source #
Represents an association between an Amazon Lex bot and an external messaging platform.
See: newBotChannelAssociation smart constructor.
Constructors
| BotChannelAssociation' | |
Fields
| |
Instances
newBotChannelAssociation :: BotChannelAssociation Source #
Create a value of BotChannelAssociation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:failureReason:BotChannelAssociation', botChannelAssociation_failureReason - If status is FAILED, Amazon Lex provides the reason that it failed
to create the association.
$sel:status:BotChannelAssociation', botChannelAssociation_status - The status of the bot channel.
CREATED- The channel has been created and is ready for use.IN_PROGRESS- Channel creation is in progress.FAILED- There was an error creating the channel. For information about the reason for the failure, see thefailureReasonfield.
$sel:botAlias:BotChannelAssociation', botChannelAssociation_botAlias - An alias pointing to the specific version of the Amazon Lex bot to which
this association is being made.
$sel:botName:BotChannelAssociation', botChannelAssociation_botName - The name of the Amazon Lex bot to which this association is being made.
Currently, Amazon Lex supports associations with Facebook and Slack, and Twilio.
$sel:botConfiguration:BotChannelAssociation', botChannelAssociation_botConfiguration - Provides information necessary to communicate with the messaging
platform.
$sel:createdDate:BotChannelAssociation', botChannelAssociation_createdDate - The date that the association between the Amazon Lex bot and the channel
was created.
$sel:name:BotChannelAssociation', botChannelAssociation_name - The name of the association between the bot and the channel.
$sel:type':BotChannelAssociation', botChannelAssociation_type - Specifies the type of association by indicating the type of channel
being established between the Amazon Lex bot and the external messaging
platform.
$sel:description:BotChannelAssociation', botChannelAssociation_description - A text description of the association you are creating.
botChannelAssociation_failureReason :: Lens' BotChannelAssociation (Maybe Text) Source #
If status is FAILED, Amazon Lex provides the reason that it failed
to create the association.
botChannelAssociation_status :: Lens' BotChannelAssociation (Maybe ChannelStatus) Source #
The status of the bot channel.
CREATED- The channel has been created and is ready for use.IN_PROGRESS- Channel creation is in progress.FAILED- There was an error creating the channel. For information about the reason for the failure, see thefailureReasonfield.
botChannelAssociation_botAlias :: Lens' BotChannelAssociation (Maybe Text) Source #
An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.
botChannelAssociation_botName :: Lens' BotChannelAssociation (Maybe Text) Source #
The name of the Amazon Lex bot to which this association is being made.
Currently, Amazon Lex supports associations with Facebook and Slack, and Twilio.
botChannelAssociation_botConfiguration :: Lens' BotChannelAssociation (Maybe (HashMap Text Text)) Source #
Provides information necessary to communicate with the messaging platform.
botChannelAssociation_createdDate :: Lens' BotChannelAssociation (Maybe UTCTime) Source #
The date that the association between the Amazon Lex bot and the channel was created.
botChannelAssociation_name :: Lens' BotChannelAssociation (Maybe Text) Source #
The name of the association between the bot and the channel.
botChannelAssociation_type :: Lens' BotChannelAssociation (Maybe ChannelType) Source #
Specifies the type of association by indicating the type of channel being established between the Amazon Lex bot and the external messaging platform.
botChannelAssociation_description :: Lens' BotChannelAssociation (Maybe Text) Source #
A text description of the association you are creating.
BotMetadata
data BotMetadata Source #
Provides information about a bot. .
See: newBotMetadata smart constructor.
Constructors
| BotMetadata' | |
Fields
| |
Instances
newBotMetadata :: BotMetadata Source #
Create a value of BotMetadata with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:BotMetadata', botMetadata_status - The status of the bot.
$sel:createdDate:BotMetadata', botMetadata_createdDate - The date that the bot was created.
$sel:name:BotMetadata', botMetadata_name - The name of the bot.
$sel:version:BotMetadata', botMetadata_version - The version of the bot. For a new bot, the version is always $LATEST.
$sel:lastUpdatedDate:BotMetadata', botMetadata_lastUpdatedDate - The date that the bot was updated. When you create a bot, the creation
date and last updated date are the same.
$sel:description:BotMetadata', botMetadata_description - A description of the bot.
botMetadata_status :: Lens' BotMetadata (Maybe LexStatus) Source #
The status of the bot.
botMetadata_createdDate :: Lens' BotMetadata (Maybe UTCTime) Source #
The date that the bot was created.
botMetadata_name :: Lens' BotMetadata (Maybe Text) Source #
The name of the bot.
botMetadata_version :: Lens' BotMetadata (Maybe Text) Source #
The version of the bot. For a new bot, the version is always $LATEST.
botMetadata_lastUpdatedDate :: Lens' BotMetadata (Maybe UTCTime) Source #
The date that the bot was updated. When you create a bot, the creation date and last updated date are the same.
botMetadata_description :: Lens' BotMetadata (Maybe Text) Source #
A description of the bot.
BuiltinIntentMetadata
data BuiltinIntentMetadata Source #
Provides metadata for a built-in intent.
See: newBuiltinIntentMetadata smart constructor.
Constructors
| BuiltinIntentMetadata' | |
Fields
| |
Instances
newBuiltinIntentMetadata :: BuiltinIntentMetadata Source #
Create a value of BuiltinIntentMetadata with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:signature:BuiltinIntentMetadata', builtinIntentMetadata_signature - A unique identifier for the built-in intent. To find the signature for
an intent, see
Standard Built-in Intents
in the Alexa Skills Kit.
$sel:supportedLocales:BuiltinIntentMetadata', builtinIntentMetadata_supportedLocales - A list of identifiers for the locales that the intent supports.
builtinIntentMetadata_signature :: Lens' BuiltinIntentMetadata (Maybe Text) Source #
A unique identifier for the built-in intent. To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit.
builtinIntentMetadata_supportedLocales :: Lens' BuiltinIntentMetadata (Maybe [Locale]) Source #
A list of identifiers for the locales that the intent supports.
BuiltinIntentSlot
data BuiltinIntentSlot Source #
Provides information about a slot used in a built-in intent.
See: newBuiltinIntentSlot smart constructor.
Constructors
| BuiltinIntentSlot' | |
Instances
newBuiltinIntentSlot :: BuiltinIntentSlot Source #
Create a value of BuiltinIntentSlot with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:BuiltinIntentSlot', builtinIntentSlot_name - A list of the slots defined for the intent.
builtinIntentSlot_name :: Lens' BuiltinIntentSlot (Maybe Text) Source #
A list of the slots defined for the intent.
BuiltinSlotTypeMetadata
data BuiltinSlotTypeMetadata Source #
Provides information about a built in slot type.
See: newBuiltinSlotTypeMetadata smart constructor.
Constructors
| BuiltinSlotTypeMetadata' | |
Fields
| |
Instances
newBuiltinSlotTypeMetadata :: BuiltinSlotTypeMetadata Source #
Create a value of BuiltinSlotTypeMetadata with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:signature:BuiltinSlotTypeMetadata', builtinSlotTypeMetadata_signature - A unique identifier for the built-in slot type. To find the signature
for a slot type, see
Slot Type Reference
in the Alexa Skills Kit.
$sel:supportedLocales:BuiltinSlotTypeMetadata', builtinSlotTypeMetadata_supportedLocales - A list of target locales for the slot.
builtinSlotTypeMetadata_signature :: Lens' BuiltinSlotTypeMetadata (Maybe Text) Source #
A unique identifier for the built-in slot type. To find the signature for a slot type, see Slot Type Reference in the Alexa Skills Kit.
builtinSlotTypeMetadata_supportedLocales :: Lens' BuiltinSlotTypeMetadata (Maybe [Locale]) Source #
A list of target locales for the slot.
CodeHook
Specifies a Lambda function that verifies requests to a bot or fulfills the user's request to a bot..
See: newCodeHook smart constructor.
Constructors
| CodeHook' | |
Fields
| |
Instances
| Eq CodeHook Source # | |
| Read CodeHook Source # | |
| Show CodeHook Source # | |
| Generic CodeHook Source # | |
| NFData CodeHook Source # | |
Defined in Amazonka.LexModels.Types.CodeHook | |
| Hashable CodeHook Source # | |
Defined in Amazonka.LexModels.Types.CodeHook | |
| ToJSON CodeHook Source # | |
Defined in Amazonka.LexModels.Types.CodeHook | |
| FromJSON CodeHook Source # | |
| type Rep CodeHook Source # | |
Defined in Amazonka.LexModels.Types.CodeHook type Rep CodeHook = D1 ('MetaData "CodeHook" "Amazonka.LexModels.Types.CodeHook" "libZSservicesZSamazonka-lex-modelsZSamazonka-lex-models" 'False) (C1 ('MetaCons "CodeHook'" 'PrefixI 'True) (S1 ('MetaSel ('Just "uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "messageVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of CodeHook with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:uri:CodeHook', codeHook_uri - The Amazon Resource Name (ARN) of the Lambda function.
$sel:messageVersion:CodeHook', codeHook_messageVersion - The version of the request-response that you want Amazon Lex to use to
invoke your Lambda function. For more information, see using-lambda.
codeHook_messageVersion :: Lens' CodeHook Text Source #
The version of the request-response that you want Amazon Lex to use to invoke your Lambda function. For more information, see using-lambda.
ConversationLogsRequest
data ConversationLogsRequest Source #
Provides the settings needed for conversation logs.
See: newConversationLogsRequest smart constructor.
Constructors
| ConversationLogsRequest' | |
Fields
| |
Instances
newConversationLogsRequest Source #
Create a value of ConversationLogsRequest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:logSettings:ConversationLogsRequest', conversationLogsRequest_logSettings - The settings for your conversation logs. You can log the conversation
text, conversation audio, or both.
$sel:iamRoleArn:ConversationLogsRequest', conversationLogsRequest_iamRoleArn - The Amazon Resource Name (ARN) of an IAM role with permission to write
to your CloudWatch Logs for text logs and your S3 bucket for audio logs.
If audio encryption is enabled, this role also provides access
permission for the AWS KMS key used for encrypting audio logs. For more
information, see
Creating an IAM Role and Policy for Conversation Logs.
conversationLogsRequest_logSettings :: Lens' ConversationLogsRequest [LogSettingsRequest] Source #
The settings for your conversation logs. You can log the conversation text, conversation audio, or both.
conversationLogsRequest_iamRoleArn :: Lens' ConversationLogsRequest Text Source #
The Amazon Resource Name (ARN) of an IAM role with permission to write to your CloudWatch Logs for text logs and your S3 bucket for audio logs. If audio encryption is enabled, this role also provides access permission for the AWS KMS key used for encrypting audio logs. For more information, see Creating an IAM Role and Policy for Conversation Logs.
ConversationLogsResponse
data ConversationLogsResponse Source #
Contains information about conversation log settings.
See: newConversationLogsResponse smart constructor.
Constructors
| ConversationLogsResponse' | |
Fields
| |
Instances
newConversationLogsResponse :: ConversationLogsResponse Source #
Create a value of ConversationLogsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:iamRoleArn:ConversationLogsResponse', conversationLogsResponse_iamRoleArn - The Amazon Resource Name (ARN) of the IAM role used to write your logs
to CloudWatch Logs or an S3 bucket.
$sel:logSettings:ConversationLogsResponse', conversationLogsResponse_logSettings - The settings for your conversation logs. You can log text, audio, or
both.
conversationLogsResponse_iamRoleArn :: Lens' ConversationLogsResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the IAM role used to write your logs to CloudWatch Logs or an S3 bucket.
conversationLogsResponse_logSettings :: Lens' ConversationLogsResponse (Maybe [LogSettingsResponse]) Source #
The settings for your conversation logs. You can log text, audio, or both.
EnumerationValue
data EnumerationValue Source #
Each slot type can have a set of values. Each enumeration value represents a value the slot type can take.
For example, a pizza ordering bot could have a slot type that specifies the type of crust that the pizza should have. The slot type could include the values
- thick
- thin
- stuffed
See: newEnumerationValue smart constructor.
Constructors
| EnumerationValue' | |
Instances
Arguments
| :: Text | |
| -> EnumerationValue |
Create a value of EnumerationValue with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:synonyms:EnumerationValue', enumerationValue_synonyms - Additional values related to the slot type value.
$sel:value:EnumerationValue', enumerationValue_value - The value of the slot type.
enumerationValue_synonyms :: Lens' EnumerationValue (Maybe [Text]) Source #
Additional values related to the slot type value.
enumerationValue_value :: Lens' EnumerationValue Text Source #
The value of the slot type.
FollowUpPrompt
data FollowUpPrompt Source #
A prompt for additional activity after an intent is fulfilled. For
example, after the OrderPizza intent is fulfilled, you might prompt
the user to find out whether the user wants to order drinks.
See: newFollowUpPrompt smart constructor.
Constructors
| FollowUpPrompt' | |
Fields
| |
Instances
Arguments
| :: Prompt | |
| -> Statement | |
| -> FollowUpPrompt |
Create a value of FollowUpPrompt with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:prompt:FollowUpPrompt', followUpPrompt_prompt - Prompts for information from the user.
$sel:rejectionStatement:FollowUpPrompt', followUpPrompt_rejectionStatement - If the user answers "no" to the question defined in the prompt
field, Amazon Lex responds with this statement to acknowledge that the
intent was canceled.
followUpPrompt_prompt :: Lens' FollowUpPrompt Prompt Source #
Prompts for information from the user.
followUpPrompt_rejectionStatement :: Lens' FollowUpPrompt Statement Source #
If the user answers "no" to the question defined in the prompt
field, Amazon Lex responds with this statement to acknowledge that the
intent was canceled.
FulfillmentActivity
data FulfillmentActivity Source #
Describes how the intent is fulfilled after the user provides all of the information required for the intent. You can provide a Lambda function to process the intent, or you can return the intent information to the client application. We recommend that you use a Lambda function so that the relevant logic lives in the Cloud and limit the client-side code primarily to presentation. If you need to update the logic, you only update the Lambda function; you don't need to upgrade your client application.
Consider the following examples:
- In a pizza ordering application, after the user provides all of the information for placing an order, you use a Lambda function to place an order with a pizzeria.
- In a gaming application, when a user says "pick up a rock," this information must go back to the client application so that it can perform the operation and update the graphics. In this case, you want Amazon Lex to return the intent data to the client.
See: newFulfillmentActivity smart constructor.
Constructors
| FulfillmentActivity' | |
Fields
| |
Instances
newFulfillmentActivity Source #
Create a value of FulfillmentActivity with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:codeHook:FulfillmentActivity', fulfillmentActivity_codeHook - A description of the Lambda function that is run to fulfill the intent.
$sel:type':FulfillmentActivity', fulfillmentActivity_type - How the intent should be fulfilled, either by running a Lambda function
or by returning the slot data to the client application.
fulfillmentActivity_codeHook :: Lens' FulfillmentActivity (Maybe CodeHook) Source #
A description of the Lambda function that is run to fulfill the intent.
fulfillmentActivity_type :: Lens' FulfillmentActivity FulfillmentActivityType Source #
How the intent should be fulfilled, either by running a Lambda function or by returning the slot data to the client application.
InputContext
data InputContext Source #
The name of a context that must be active for an intent to be selected by Amazon Lex.
See: newInputContext smart constructor.
Constructors
| InputContext' | |
Instances
Arguments
| :: Text | |
| -> InputContext |
Create a value of InputContext with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:InputContext', inputContext_name - The name of the context.
inputContext_name :: Lens' InputContext Text Source #
The name of the context.
Intent
Identifies the specific version of an intent.
See: newIntent smart constructor.
Constructors
| Intent' | |
Fields
| |
Instances
| Eq Intent Source # | |
| Read Intent Source # | |
| Show Intent Source # | |
| Generic Intent Source # | |
| NFData Intent Source # | |
Defined in Amazonka.LexModels.Types.Intent | |
| Hashable Intent Source # | |
Defined in Amazonka.LexModels.Types.Intent | |
| ToJSON Intent Source # | |
Defined in Amazonka.LexModels.Types.Intent | |
| FromJSON Intent Source # | |
| type Rep Intent Source # | |
Defined in Amazonka.LexModels.Types.Intent type Rep Intent = D1 ('MetaData "Intent" "Amazonka.LexModels.Types.Intent" "libZSservicesZSamazonka-lex-modelsZSamazonka-lex-models" 'False) (C1 ('MetaCons "Intent'" 'PrefixI 'True) (S1 ('MetaSel ('Just "intentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "intentVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Intent with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:intentName:Intent', intent_intentName - The name of the intent.
$sel:intentVersion:Intent', intent_intentVersion - The version of the intent.
IntentMetadata
data IntentMetadata Source #
Provides information about an intent.
See: newIntentMetadata smart constructor.
Constructors
| IntentMetadata' | |
Fields
| |
Instances
newIntentMetadata :: IntentMetadata Source #
Create a value of IntentMetadata with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:createdDate:IntentMetadata', intentMetadata_createdDate - The date that the intent was created.
$sel:name:IntentMetadata', intentMetadata_name - The name of the intent.
$sel:version:IntentMetadata', intentMetadata_version - The version of the intent.
$sel:lastUpdatedDate:IntentMetadata', intentMetadata_lastUpdatedDate - The date that the intent was updated. When you create an intent, the
creation date and last updated date are the same.
$sel:description:IntentMetadata', intentMetadata_description - A description of the intent.
intentMetadata_createdDate :: Lens' IntentMetadata (Maybe UTCTime) Source #
The date that the intent was created.
intentMetadata_name :: Lens' IntentMetadata (Maybe Text) Source #
The name of the intent.
intentMetadata_version :: Lens' IntentMetadata (Maybe Text) Source #
The version of the intent.
intentMetadata_lastUpdatedDate :: Lens' IntentMetadata (Maybe UTCTime) Source #
The date that the intent was updated. When you create an intent, the creation date and last updated date are the same.
intentMetadata_description :: Lens' IntentMetadata (Maybe Text) Source #
A description of the intent.
KendraConfiguration
data KendraConfiguration Source #
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. For more information, see AMAZON.KendraSearchIntent.
See: newKendraConfiguration smart constructor.
Constructors
| KendraConfiguration' | |
Fields
| |
Instances
newKendraConfiguration Source #
Arguments
| :: Text | |
| -> Text | |
| -> KendraConfiguration |
Create a value of KendraConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:queryFilterString:KendraConfiguration', kendraConfiguration_queryFilterString - A query filter that Amazon Lex sends to Amazon Kendra to filter the
response from the query. The filter is in the format defined by Amazon
Kendra. For more information, see
Filtering queries.
You can override this filter string with a new filter string at runtime.
$sel:kendraIndex:KendraConfiguration', kendraConfiguration_kendraIndex - The Amazon Resource Name (ARN) of the Amazon Kendra index that you want
the AMAZON.KendraSearchIntent intent to search. The index must be in the
same account and Region as the Amazon Lex bot. If the Amazon Kendra
index does not exist, you get an exception when you call the PutIntent
operation.
$sel:role':KendraConfiguration', kendraConfiguration_role - The Amazon Resource Name (ARN) of an IAM role that has permission to
search the Amazon Kendra index. The role must be in the same account and
Region as the Amazon Lex bot. If the role does not exist, you get an
exception when you call the PutIntent operation.
kendraConfiguration_queryFilterString :: Lens' KendraConfiguration (Maybe Text) Source #
A query filter that Amazon Lex sends to Amazon Kendra to filter the response from the query. The filter is in the format defined by Amazon Kendra. For more information, see Filtering queries.
You can override this filter string with a new filter string at runtime.
kendraConfiguration_kendraIndex :: Lens' KendraConfiguration Text Source #
The Amazon Resource Name (ARN) of the Amazon Kendra index that you want
the AMAZON.KendraSearchIntent intent to search. The index must be in the
same account and Region as the Amazon Lex bot. If the Amazon Kendra
index does not exist, you get an exception when you call the PutIntent
operation.
kendraConfiguration_role :: Lens' KendraConfiguration Text Source #
The Amazon Resource Name (ARN) of an IAM role that has permission to
search the Amazon Kendra index. The role must be in the same account and
Region as the Amazon Lex bot. If the role does not exist, you get an
exception when you call the PutIntent operation.
LogSettingsRequest
data LogSettingsRequest Source #
Settings used to configure delivery mode and destination for conversation logs.
See: newLogSettingsRequest smart constructor.
Constructors
| LogSettingsRequest' | |
Fields
| |
Instances
newLogSettingsRequest Source #
Arguments
| :: LogType | |
| -> Destination | |
| -> Text | |
| -> LogSettingsRequest |
Create a value of LogSettingsRequest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:kmsKeyArn:LogSettingsRequest', logSettingsRequest_kmsKeyArn - The Amazon Resource Name (ARN) of the AWS KMS customer managed key for
encrypting audio logs delivered to an S3 bucket. The key does not apply
to CloudWatch Logs and is optional for S3 buckets.
$sel:logType:LogSettingsRequest', logSettingsRequest_logType - The type of logging to enable. Text logs are delivered to a CloudWatch
Logs log group. Audio logs are delivered to an S3 bucket.
$sel:destination:LogSettingsRequest', logSettingsRequest_destination - Where the logs will be delivered. Text logs are delivered to a
CloudWatch Logs log group. Audio logs are delivered to an S3 bucket.
$sel:resourceArn:LogSettingsRequest', logSettingsRequest_resourceArn - The Amazon Resource Name (ARN) of the CloudWatch Logs log group or S3
bucket where the logs should be delivered.
logSettingsRequest_kmsKeyArn :: Lens' LogSettingsRequest (Maybe Text) Source #
The Amazon Resource Name (ARN) of the AWS KMS customer managed key for encrypting audio logs delivered to an S3 bucket. The key does not apply to CloudWatch Logs and is optional for S3 buckets.
logSettingsRequest_logType :: Lens' LogSettingsRequest LogType Source #
The type of logging to enable. Text logs are delivered to a CloudWatch Logs log group. Audio logs are delivered to an S3 bucket.
logSettingsRequest_destination :: Lens' LogSettingsRequest Destination Source #
Where the logs will be delivered. Text logs are delivered to a CloudWatch Logs log group. Audio logs are delivered to an S3 bucket.
logSettingsRequest_resourceArn :: Lens' LogSettingsRequest Text Source #
The Amazon Resource Name (ARN) of the CloudWatch Logs log group or S3 bucket where the logs should be delivered.
LogSettingsResponse
data LogSettingsResponse Source #
The settings for conversation logs.
See: newLogSettingsResponse smart constructor.
Constructors
| LogSettingsResponse' | |
Fields
| |
Instances
newLogSettingsResponse :: LogSettingsResponse Source #
Create a value of LogSettingsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:destination:LogSettingsResponse', logSettingsResponse_destination - The destination where logs are delivered.
$sel:kmsKeyArn:LogSettingsResponse', logSettingsResponse_kmsKeyArn - The Amazon Resource Name (ARN) of the key used to encrypt audio logs in
an S3 bucket.
$sel:logType:LogSettingsResponse', logSettingsResponse_logType - The type of logging that is enabled.
$sel:resourceArn:LogSettingsResponse', logSettingsResponse_resourceArn - The Amazon Resource Name (ARN) of the CloudWatch Logs log group or S3
bucket where the logs are delivered.
$sel:resourcePrefix:LogSettingsResponse', logSettingsResponse_resourcePrefix - The resource prefix is the first part of the S3 object key within the S3
bucket that you specified to contain audio logs. For CloudWatch Logs it
is the prefix of the log stream name within the log group that you
specified.
logSettingsResponse_destination :: Lens' LogSettingsResponse (Maybe Destination) Source #
The destination where logs are delivered.
logSettingsResponse_kmsKeyArn :: Lens' LogSettingsResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the key used to encrypt audio logs in an S3 bucket.
logSettingsResponse_logType :: Lens' LogSettingsResponse (Maybe LogType) Source #
The type of logging that is enabled.
logSettingsResponse_resourceArn :: Lens' LogSettingsResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the CloudWatch Logs log group or S3 bucket where the logs are delivered.
logSettingsResponse_resourcePrefix :: Lens' LogSettingsResponse (Maybe Text) Source #
The resource prefix is the first part of the S3 object key within the S3 bucket that you specified to contain audio logs. For CloudWatch Logs it is the prefix of the log stream name within the log group that you specified.
Message
The message object that provides the message text and its type.
See: newMessage smart constructor.
Constructors
| Message' | |
Fields
| |
Instances
| Eq Message Source # | |
| Read Message Source # | |
| Show Message Source # | |
| Generic Message Source # | |
| NFData Message Source # | |
Defined in Amazonka.LexModels.Types.Message | |
| Hashable Message Source # | |
Defined in Amazonka.LexModels.Types.Message | |
| ToJSON Message Source # | |
Defined in Amazonka.LexModels.Types.Message | |
| FromJSON Message Source # | |
| type Rep Message Source # | |
Defined in Amazonka.LexModels.Types.Message type Rep Message = D1 ('MetaData "Message" "Amazonka.LexModels.Types.Message" "libZSservicesZSamazonka-lex-modelsZSamazonka-lex-models" 'False) (C1 ('MetaCons "Message'" 'PrefixI 'True) (S1 ('MetaSel ('Just "groupNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "contentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ContentType) :*: S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) | |
Arguments
| :: ContentType | |
| -> Text | |
| -> Message |
Create a value of Message with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:groupNumber:Message', message_groupNumber - Identifies the message group that the message belongs to. When a group
is assigned to a message, Amazon Lex returns one message from each group
in the response.
$sel:contentType:Message', message_contentType - The content type of the message string.
$sel:content:Message', message_content - The text of the message.
message_groupNumber :: Lens' Message (Maybe Natural) Source #
Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.
message_contentType :: Lens' Message ContentType Source #
The content type of the message string.
MigrationAlert
data MigrationAlert Source #
Provides information about alerts and warnings that Amazon Lex sends during a migration. The alerts include information about how to resolve the issue.
See: newMigrationAlert smart constructor.
Constructors
| MigrationAlert' | |
Fields
| |
Instances
newMigrationAlert :: MigrationAlert Source #
Create a value of MigrationAlert with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:referenceURLs:MigrationAlert', migrationAlert_referenceURLs - A link to the Amazon Lex documentation that describes how to resolve the
alert.
$sel:details:MigrationAlert', migrationAlert_details - Additional details about the alert.
$sel:type':MigrationAlert', migrationAlert_type - The type of alert. There are two kinds of alerts:
ERROR- There was an issue with the migration that can't be resolved. The migration stops.WARN- There was an issue with the migration that requires manual changes to the new Amazon Lex V2 bot. The migration continues.
$sel:message:MigrationAlert', migrationAlert_message - A message that describes why the alert was issued.
migrationAlert_referenceURLs :: Lens' MigrationAlert (Maybe [Text]) Source #
A link to the Amazon Lex documentation that describes how to resolve the alert.
migrationAlert_details :: Lens' MigrationAlert (Maybe [Text]) Source #
Additional details about the alert.
migrationAlert_type :: Lens' MigrationAlert (Maybe MigrationAlertType) Source #
The type of alert. There are two kinds of alerts:
ERROR- There was an issue with the migration that can't be resolved. The migration stops.WARN- There was an issue with the migration that requires manual changes to the new Amazon Lex V2 bot. The migration continues.
migrationAlert_message :: Lens' MigrationAlert (Maybe Text) Source #
A message that describes why the alert was issued.
MigrationSummary
data MigrationSummary Source #
Provides information about migrating a bot from Amazon Lex V1 to Amazon Lex V2.
See: newMigrationSummary smart constructor.
Constructors
| MigrationSummary' | |
Fields
| |
Instances
newMigrationSummary :: MigrationSummary Source #
Create a value of MigrationSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:v1BotVersion:MigrationSummary', migrationSummary_v1BotVersion - The version of the Amazon Lex V1 bot that is the source of the
migration.
$sel:migrationStrategy:MigrationSummary', migrationSummary_migrationStrategy - The strategy used to conduct the migration.
$sel:migrationTimestamp:MigrationSummary', migrationSummary_migrationTimestamp - The date and time that the migration started.
$sel:migrationStatus:MigrationSummary', migrationSummary_migrationStatus - The status of the operation. When the status is COMPLETE the bot is
available in Amazon Lex V2. There may be alerts and warnings that need
to be resolved to complete the migration.
$sel:v2BotId:MigrationSummary', migrationSummary_v2BotId - The unique identifier of the Amazon Lex V2 that is the destination of
the migration.
$sel:v1BotLocale:MigrationSummary', migrationSummary_v1BotLocale - The locale of the Amazon Lex V1 bot that is the source of the migration.
$sel:v1BotName:MigrationSummary', migrationSummary_v1BotName - The name of the Amazon Lex V1 bot that is the source of the migration.
$sel:v2BotRole:MigrationSummary', migrationSummary_v2BotRole - The IAM role that Amazon Lex uses to run the Amazon Lex V2 bot.
$sel:migrationId:MigrationSummary', migrationSummary_migrationId - The unique identifier that Amazon Lex assigned to the migration.
migrationSummary_v1BotVersion :: Lens' MigrationSummary (Maybe Text) Source #
The version of the Amazon Lex V1 bot that is the source of the migration.
migrationSummary_migrationStrategy :: Lens' MigrationSummary (Maybe MigrationStrategy) Source #
The strategy used to conduct the migration.
migrationSummary_migrationTimestamp :: Lens' MigrationSummary (Maybe UTCTime) Source #
The date and time that the migration started.
migrationSummary_migrationStatus :: Lens' MigrationSummary (Maybe MigrationStatus) Source #
The status of the operation. When the status is COMPLETE the bot is
available in Amazon Lex V2. There may be alerts and warnings that need
to be resolved to complete the migration.
migrationSummary_v2BotId :: Lens' MigrationSummary (Maybe Text) Source #
The unique identifier of the Amazon Lex V2 that is the destination of the migration.
migrationSummary_v1BotLocale :: Lens' MigrationSummary (Maybe Locale) Source #
The locale of the Amazon Lex V1 bot that is the source of the migration.
migrationSummary_v1BotName :: Lens' MigrationSummary (Maybe Text) Source #
The name of the Amazon Lex V1 bot that is the source of the migration.
migrationSummary_v2BotRole :: Lens' MigrationSummary (Maybe Text) Source #
The IAM role that Amazon Lex uses to run the Amazon Lex V2 bot.
migrationSummary_migrationId :: Lens' MigrationSummary (Maybe Text) Source #
The unique identifier that Amazon Lex assigned to the migration.
OutputContext
data OutputContext Source #
The specification of an output context that is set when an intent is fulfilled.
See: newOutputContext smart constructor.
Constructors
| OutputContext' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Natural | |
| -> Natural | |
| -> OutputContext |
Create a value of OutputContext with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:OutputContext', outputContext_name - The name of the context.
$sel:timeToLiveInSeconds:OutputContext', outputContext_timeToLiveInSeconds - The number of seconds that the context should be active after it is
first sent in a PostContent or PostText response. You can set the
value between 5 and 86,400 seconds (24 hours).
$sel:turnsToLive:OutputContext', outputContext_turnsToLive - The number of conversation turns that the context should be active. A
conversation turn is one PostContent or PostText request and the
corresponding response from Amazon Lex.
outputContext_name :: Lens' OutputContext Text Source #
The name of the context.
outputContext_timeToLiveInSeconds :: Lens' OutputContext Natural Source #
The number of seconds that the context should be active after it is
first sent in a PostContent or PostText response. You can set the
value between 5 and 86,400 seconds (24 hours).
outputContext_turnsToLive :: Lens' OutputContext Natural Source #
The number of conversation turns that the context should be active. A
conversation turn is one PostContent or PostText request and the
corresponding response from Amazon Lex.
Prompt
Obtains information from the user. To define a prompt, provide one or more messages and specify the number of attempts to get information from the user. If you provide more than one message, Amazon Lex chooses one of the messages to use to prompt the user. For more information, see how-it-works.
See: newPrompt smart constructor.
Constructors
| Prompt' | |
Fields
| |
Instances
| Eq Prompt Source # | |
| Read Prompt Source # | |
| Show Prompt Source # | |
| Generic Prompt Source # | |
| NFData Prompt Source # | |
Defined in Amazonka.LexModels.Types.Prompt | |
| Hashable Prompt Source # | |
Defined in Amazonka.LexModels.Types.Prompt | |
| ToJSON Prompt Source # | |
Defined in Amazonka.LexModels.Types.Prompt | |
| FromJSON Prompt Source # | |
| type Rep Prompt Source # | |
Defined in Amazonka.LexModels.Types.Prompt type Rep Prompt = D1 ('MetaData "Prompt" "Amazonka.LexModels.Types.Prompt" "libZSservicesZSamazonka-lex-modelsZSamazonka-lex-models" 'False) (C1 ('MetaCons "Prompt'" 'PrefixI 'True) (S1 ('MetaSel ('Just "responseCard") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "messages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Message)) :*: S1 ('MetaSel ('Just "maxAttempts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural)))) | |
Create a value of Prompt with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:responseCard:Prompt', prompt_responseCard - A response card. Amazon Lex uses this prompt at runtime, in the
PostText API response. It substitutes session attributes and slot
values for placeholders in the response card. For more information, see
ex-resp-card.
$sel:messages:Prompt', prompt_messages - An array of objects, each of which provides a message string and its
type. You can specify the message string in plain text or in Speech
Synthesis Markup Language (SSML).
$sel:maxAttempts:Prompt', prompt_maxAttempts - The number of times to prompt the user for information.
prompt_responseCard :: Lens' Prompt (Maybe Text) Source #
A response card. Amazon Lex uses this prompt at runtime, in the
PostText API response. It substitutes session attributes and slot
values for placeholders in the response card. For more information, see
ex-resp-card.
prompt_messages :: Lens' Prompt (NonEmpty Message) Source #
An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).
prompt_maxAttempts :: Lens' Prompt Natural Source #
The number of times to prompt the user for information.
Slot
Identifies the version of a specific slot.
See: newSlot smart constructor.
Constructors
| Slot' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> SlotConstraint | |
| -> Slot |
Create a value of Slot with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:slotType:Slot', slot_slotType - The type of the slot, either a custom slot type that you defined or one
of the built-in slot types.
$sel:valueElicitationPrompt:Slot', slot_valueElicitationPrompt - The prompt that Amazon Lex uses to elicit the slot value from the user.
$sel:responseCard:Slot', slot_responseCard - A set of possible responses for the slot type used by text-based
clients. A user chooses an option from the response card, instead of
using text to reply.
$sel:priority:Slot', slot_priority - Directs Amazon Lex the order in which to elicit this slot value from the
user. For example, if the intent has two slots with priorities 1 and 2,
AWS Amazon Lex first elicits a value for the slot with priority 1.
If multiple slots share the same priority, the order in which Amazon Lex elicits values is arbitrary.
$sel:obfuscationSetting:Slot', slot_obfuscationSetting - Determines whether a slot is obfuscated in conversation logs and stored
utterances. When you obfuscate a slot, the value is replaced by the slot
name in curly braces ({}). For example, if the slot name is
"full_name", obfuscated values are replaced with "{full_name}". For
more information, see
Slot Obfuscation
.
$sel:defaultValueSpec:Slot', slot_defaultValueSpec - A list of default values for the slot. Default values are used when
Amazon Lex hasn't determined a value for a slot. You can specify
default values from context variables, session attributes, and defined
values.
$sel:slotTypeVersion:Slot', slot_slotTypeVersion - The version of the slot type.
$sel:sampleUtterances:Slot', slot_sampleUtterances - If you know a specific pattern with which users might respond to an
Amazon Lex request for a slot value, you can provide those utterances to
improve accuracy. This is optional. In most cases, Amazon Lex is capable
of understanding user utterances.
$sel:description:Slot', slot_description - A description of the slot.
$sel:name:Slot', slot_name - The name of the slot.
$sel:slotConstraint:Slot', slot_slotConstraint - Specifies whether the slot is required or optional.
slot_slotType :: Lens' Slot (Maybe Text) Source #
The type of the slot, either a custom slot type that you defined or one of the built-in slot types.
slot_valueElicitationPrompt :: Lens' Slot (Maybe Prompt) Source #
The prompt that Amazon Lex uses to elicit the slot value from the user.
slot_responseCard :: Lens' Slot (Maybe Text) Source #
A set of possible responses for the slot type used by text-based clients. A user chooses an option from the response card, instead of using text to reply.
slot_priority :: Lens' Slot (Maybe Natural) Source #
Directs Amazon Lex the order in which to elicit this slot value from the user. For example, if the intent has two slots with priorities 1 and 2, AWS Amazon Lex first elicits a value for the slot with priority 1.
If multiple slots share the same priority, the order in which Amazon Lex elicits values is arbitrary.
slot_obfuscationSetting :: Lens' Slot (Maybe ObfuscationSetting) Source #
Determines whether a slot is obfuscated in conversation logs and stored utterances. When you obfuscate a slot, the value is replaced by the slot name in curly braces ({}). For example, if the slot name is "full_name", obfuscated values are replaced with "{full_name}". For more information, see Slot Obfuscation .
slot_defaultValueSpec :: Lens' Slot (Maybe SlotDefaultValueSpec) Source #
A list of default values for the slot. Default values are used when Amazon Lex hasn't determined a value for a slot. You can specify default values from context variables, session attributes, and defined values.
slot_sampleUtterances :: Lens' Slot (Maybe [Text]) Source #
If you know a specific pattern with which users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of understanding user utterances.
slot_slotConstraint :: Lens' Slot SlotConstraint Source #
Specifies whether the slot is required or optional.
SlotDefaultValue
data SlotDefaultValue Source #
A default value for a slot.
See: newSlotDefaultValue smart constructor.
Constructors
| SlotDefaultValue' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> SlotDefaultValue |
Create a value of SlotDefaultValue with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:defaultValue:SlotDefaultValue', slotDefaultValue_defaultValue - The default value for the slot. You can specify one of the following:
#context-name.slot-name- The slot value "slot-name" in the context "context-name."{attribute}- The slot value of the session attribute "attribute."'value'- The discrete value "value."
slotDefaultValue_defaultValue :: Lens' SlotDefaultValue Text Source #
The default value for the slot. You can specify one of the following:
#context-name.slot-name- The slot value "slot-name" in the context "context-name."{attribute}- The slot value of the session attribute "attribute."'value'- The discrete value "value."
SlotDefaultValueSpec
data SlotDefaultValueSpec Source #
Contains the default values for a slot. Default values are used when Amazon Lex hasn't determined a value for a slot.
See: newSlotDefaultValueSpec smart constructor.
Constructors
| SlotDefaultValueSpec' | |
Fields
| |
Instances
newSlotDefaultValueSpec :: SlotDefaultValueSpec Source #
Create a value of SlotDefaultValueSpec with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:defaultValueList:SlotDefaultValueSpec', slotDefaultValueSpec_defaultValueList - The default values for a slot. You can specify more than one default.
For example, you can specify a default value to use from a matching
context variable, a session attribute, or a fixed value.
The default value chosen is selected based on the order that you specify them in the list. For example, if you specify a context variable and a fixed value in that order, Amazon Lex uses the context variable if it is available, else it uses the fixed value.
slotDefaultValueSpec_defaultValueList :: Lens' SlotDefaultValueSpec [SlotDefaultValue] Source #
The default values for a slot. You can specify more than one default. For example, you can specify a default value to use from a matching context variable, a session attribute, or a fixed value.
The default value chosen is selected based on the order that you specify them in the list. For example, if you specify a context variable and a fixed value in that order, Amazon Lex uses the context variable if it is available, else it uses the fixed value.
SlotTypeConfiguration
data SlotTypeConfiguration Source #
Provides configuration information for a slot type.
See: newSlotTypeConfiguration smart constructor.
Constructors
| SlotTypeConfiguration' | |
Fields
| |
Instances
newSlotTypeConfiguration :: SlotTypeConfiguration Source #
Create a value of SlotTypeConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:regexConfiguration:SlotTypeConfiguration', slotTypeConfiguration_regexConfiguration - A regular expression used to validate the value of a slot.
slotTypeConfiguration_regexConfiguration :: Lens' SlotTypeConfiguration (Maybe SlotTypeRegexConfiguration) Source #
A regular expression used to validate the value of a slot.
SlotTypeMetadata
data SlotTypeMetadata Source #
Provides information about a slot type..
See: newSlotTypeMetadata smart constructor.
Constructors
| SlotTypeMetadata' | |
Fields
| |
Instances
newSlotTypeMetadata :: SlotTypeMetadata Source #
Create a value of SlotTypeMetadata with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:createdDate:SlotTypeMetadata', slotTypeMetadata_createdDate - The date that the slot type was created.
$sel:name:SlotTypeMetadata', slotTypeMetadata_name - The name of the slot type.
$sel:version:SlotTypeMetadata', slotTypeMetadata_version - The version of the slot type.
$sel:lastUpdatedDate:SlotTypeMetadata', slotTypeMetadata_lastUpdatedDate - The date that the slot type was updated. When you create a resource, the
creation date and last updated date are the same.
$sel:description:SlotTypeMetadata', slotTypeMetadata_description - A description of the slot type.
slotTypeMetadata_createdDate :: Lens' SlotTypeMetadata (Maybe UTCTime) Source #
The date that the slot type was created.
slotTypeMetadata_name :: Lens' SlotTypeMetadata (Maybe Text) Source #
The name of the slot type.
slotTypeMetadata_version :: Lens' SlotTypeMetadata (Maybe Text) Source #
The version of the slot type.
slotTypeMetadata_lastUpdatedDate :: Lens' SlotTypeMetadata (Maybe UTCTime) Source #
The date that the slot type was updated. When you create a resource, the creation date and last updated date are the same.
slotTypeMetadata_description :: Lens' SlotTypeMetadata (Maybe Text) Source #
A description of the slot type.
SlotTypeRegexConfiguration
data SlotTypeRegexConfiguration Source #
Provides a regular expression used to validate the value of a slot.
See: newSlotTypeRegexConfiguration smart constructor.
Constructors
| SlotTypeRegexConfiguration' | |
Fields
| |
Instances
newSlotTypeRegexConfiguration Source #
Create a value of SlotTypeRegexConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:pattern':SlotTypeRegexConfiguration', slotTypeRegexConfiguration_pattern - A regular expression used to validate the value of a slot.
Use a standard regular expression. Amazon Lex supports the following characters in the regular expression:
- A-Z, a-z
- 0-9
- Unicode characters ("\ u<Unicode>")
Represent Unicode characters with four digits, for example "\u0041" or "\u005A".
The following regular expression operators are not supported:
- Infinite repeaters: *, +, or {x,} with no upper bound.
- Wild card (.)
slotTypeRegexConfiguration_pattern :: Lens' SlotTypeRegexConfiguration Text Source #
A regular expression used to validate the value of a slot.
Use a standard regular expression. Amazon Lex supports the following characters in the regular expression:
- A-Z, a-z
- 0-9
- Unicode characters ("\ u<Unicode>")
Represent Unicode characters with four digits, for example "\u0041" or "\u005A".
The following regular expression operators are not supported:
- Infinite repeaters: *, +, or {x,} with no upper bound.
- Wild card (.)
Statement
A collection of messages that convey information to the user. At runtime, Amazon Lex selects the message to convey.
See: newStatement smart constructor.
Constructors
| Statement' | |
Instances
| Eq Statement Source # | |
| Read Statement Source # | |
| Show Statement Source # | |
| Generic Statement Source # | |
| NFData Statement Source # | |
Defined in Amazonka.LexModels.Types.Statement | |
| Hashable Statement Source # | |
Defined in Amazonka.LexModels.Types.Statement | |
| ToJSON Statement Source # | |
Defined in Amazonka.LexModels.Types.Statement | |
| FromJSON Statement Source # | |
| type Rep Statement Source # | |
Defined in Amazonka.LexModels.Types.Statement type Rep Statement = D1 ('MetaData "Statement" "Amazonka.LexModels.Types.Statement" "libZSservicesZSamazonka-lex-modelsZSamazonka-lex-models" 'False) (C1 ('MetaCons "Statement'" 'PrefixI 'True) (S1 ('MetaSel ('Just "responseCard") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "messages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Message)))) | |
Create a value of Statement with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:responseCard:Statement', statement_responseCard - At runtime, if the client is using the
PostText
API, Amazon Lex includes the response card in the response. It
substitutes all of the session attributes and slot values for
placeholders in the response card.
$sel:messages:Statement', statement_messages - A collection of message objects.
statement_responseCard :: Lens' Statement (Maybe Text) Source #
At runtime, if the client is using the PostText API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.
Tag
A list of key/value pairs that identify a bot, bot alias, or bot channel. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
See: newTag smart constructor.
Constructors
| Tag' | |
Instances
| Eq Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| Generic Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.LexModels.Types.Tag | |
| Hashable Tag Source # | |
Defined in Amazonka.LexModels.Types.Tag | |
| ToJSON Tag Source # | |
Defined in Amazonka.LexModels.Types.Tag | |
| FromJSON Tag Source # | |
| type Rep Tag Source # | |
Defined in Amazonka.LexModels.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.LexModels.Types.Tag" "libZSservicesZSamazonka-lex-modelsZSamazonka-lex-models" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Tag with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:Tag', tag_key - The key for the tag. Keys are not case-sensitive and must be unique.
$sel:value:Tag', tag_value - The value associated with a key. The value may be an empty string but it
can't be null.
tag_key :: Lens' Tag Text Source #
The key for the tag. Keys are not case-sensitive and must be unique.
tag_value :: Lens' Tag Text Source #
The value associated with a key. The value may be an empty string but it can't be null.
UtteranceData
data UtteranceData Source #
Provides information about a single utterance that was made to your bot.
See: newUtteranceData smart constructor.
Constructors
| UtteranceData' | |
Fields
| |
Instances
newUtteranceData :: UtteranceData Source #
Create a value of UtteranceData with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:firstUtteredDate:UtteranceData', utteranceData_firstUtteredDate - The date that the utterance was first recorded.
$sel:count:UtteranceData', utteranceData_count - The number of times that the utterance was processed.
$sel:utteranceString:UtteranceData', utteranceData_utteranceString - The text that was entered by the user or the text representation of an
audio clip.
$sel:lastUtteredDate:UtteranceData', utteranceData_lastUtteredDate - The date that the utterance was last recorded.
$sel:distinctUsers:UtteranceData', utteranceData_distinctUsers - The total number of individuals that used the utterance.
utteranceData_firstUtteredDate :: Lens' UtteranceData (Maybe UTCTime) Source #
The date that the utterance was first recorded.
utteranceData_count :: Lens' UtteranceData (Maybe Int) Source #
The number of times that the utterance was processed.
utteranceData_utteranceString :: Lens' UtteranceData (Maybe Text) Source #
The text that was entered by the user or the text representation of an audio clip.
utteranceData_lastUtteredDate :: Lens' UtteranceData (Maybe UTCTime) Source #
The date that the utterance was last recorded.
utteranceData_distinctUsers :: Lens' UtteranceData (Maybe Int) Source #
The total number of individuals that used the utterance.
UtteranceList
data UtteranceList Source #
Provides a list of utterances that have been made to a specific version of your bot. The list contains a maximum of 100 utterances.
See: newUtteranceList smart constructor.
Constructors
| UtteranceList' | |
Fields
| |
Instances
newUtteranceList :: UtteranceList Source #
Create a value of UtteranceList with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:botVersion:UtteranceList', utteranceList_botVersion - The version of the bot that processed the list.
$sel:utterances:UtteranceList', utteranceList_utterances - One or more UtteranceData objects that contain information about the
utterances that have been made to a bot. The maximum number of object is
100.
utteranceList_botVersion :: Lens' UtteranceList (Maybe Text) Source #
The version of the bot that processed the list.
utteranceList_utterances :: Lens' UtteranceList (Maybe [UtteranceData]) Source #
One or more UtteranceData objects that contain information about the utterances that have been made to a bot. The maximum number of object is 100.