| 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
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- StartMigration
- DeleteIntentVersion
- GetBotAliases (Paginated)
- DeleteBotChannelAssociation
- CreateSlotTypeVersion
- ListTagsForResource
- GetIntent
- PutIntent
- DeleteIntent
- GetBuiltinIntents (Paginated)
- PutBot
- DeleteBot
- GetImport
- GetIntentVersions (Paginated)
- GetBuiltinIntent
- PutBotAlias
- GetBotVersions (Paginated)
- GetBotChannelAssociations (Paginated)
- DeleteBotAlias
- GetSlotTypes (Paginated)
- GetMigrations
- DeleteUtterances
- GetBots (Paginated)
- GetBot
- CreateBotVersion
- DeleteSlotTypeVersion
- DeleteBotVersion
- GetSlotType
- GetExport
- GetMigration
- CreateIntentVersion
- DeleteSlotType
- StartImport
- GetBotChannelAssociation
- PutSlotType
- GetBuiltinSlotTypes (Paginated)
- TagResource
- GetUtterancesView
- GetSlotTypeVersions (Paginated)
- UntagResource
- GetIntents (Paginated)
- GetBotAlias
- Types
- 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
Derived from API version 2017-04-19 of the AWS service descriptions, licensed under Apache 2.0.
Amazon Lex Build-Time Actions
Amazon Lex is an AWS service for building conversational voice and text interfaces. Use these actions to create, update, and delete conversational bots for new and existing client applications.
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
- data StartMigration = StartMigration' Text Text Text Text MigrationStrategy
- newStartMigration :: Text -> Text -> Text -> Text -> MigrationStrategy -> StartMigration
- data StartMigrationResponse = StartMigrationResponse' (Maybe Text) (Maybe MigrationStrategy) (Maybe POSIX) (Maybe Text) (Maybe Locale) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newStartMigrationResponse :: Int -> StartMigrationResponse
- data DeleteIntentVersion = DeleteIntentVersion' Text Text
- newDeleteIntentVersion :: Text -> Text -> DeleteIntentVersion
- data DeleteIntentVersionResponse = DeleteIntentVersionResponse' {
- newDeleteIntentVersionResponse :: DeleteIntentVersionResponse
- data GetBotAliases = GetBotAliases' (Maybe Text) (Maybe Text) (Maybe Natural) Text
- newGetBotAliases :: Text -> GetBotAliases
- data GetBotAliasesResponse = GetBotAliasesResponse' (Maybe Text) (Maybe [BotAliasMetadata]) Int
- newGetBotAliasesResponse :: Int -> GetBotAliasesResponse
- data DeleteBotChannelAssociation = DeleteBotChannelAssociation' Text Text Text
- newDeleteBotChannelAssociation :: Text -> Text -> Text -> DeleteBotChannelAssociation
- data DeleteBotChannelAssociationResponse = DeleteBotChannelAssociationResponse' {
- newDeleteBotChannelAssociationResponse :: DeleteBotChannelAssociationResponse
- data CreateSlotTypeVersion = CreateSlotTypeVersion' (Maybe Text) Text
- newCreateSlotTypeVersion :: Text -> CreateSlotTypeVersion
- data CreateSlotTypeVersionResponse = CreateSlotTypeVersionResponse' (Maybe Text) (Maybe [SlotTypeConfiguration]) (Maybe Text) (Maybe SlotValueSelectionStrategy) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe [EnumerationValue]) Int
- newCreateSlotTypeVersionResponse :: Int -> CreateSlotTypeVersionResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe [Tag]) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data GetIntent = GetIntent' Text Text
- newGetIntent :: Text -> Text -> GetIntent
- data GetIntentResponse = GetIntentResponse' (Maybe FulfillmentActivity) (Maybe [Slot]) (Maybe Statement) (Maybe Text) (Maybe Statement) (Maybe [Text]) (Maybe Text) (Maybe POSIX) (Maybe KendraConfiguration) (Maybe Text) (Maybe Text) (Maybe [InputContext]) (Maybe FollowUpPrompt) (Maybe POSIX) (Maybe [OutputContext]) (Maybe Prompt) (Maybe CodeHook) (Maybe Text) Int
- newGetIntentResponse :: Int -> GetIntentResponse
- data PutIntent = PutIntent' (Maybe FulfillmentActivity) (Maybe [Slot]) (Maybe Statement) (Maybe Text) (Maybe Statement) (Maybe [Text]) (Maybe Text) (Maybe KendraConfiguration) (Maybe [InputContext]) (Maybe FollowUpPrompt) (Maybe [OutputContext]) (Maybe Prompt) (Maybe Bool) (Maybe CodeHook) (Maybe Text) Text
- newPutIntent :: Text -> PutIntent
- data PutIntentResponse = PutIntentResponse' (Maybe FulfillmentActivity) (Maybe [Slot]) (Maybe Statement) (Maybe Text) (Maybe Statement) (Maybe [Text]) (Maybe Text) (Maybe POSIX) (Maybe KendraConfiguration) (Maybe Text) (Maybe Text) (Maybe [InputContext]) (Maybe FollowUpPrompt) (Maybe POSIX) (Maybe [OutputContext]) (Maybe Prompt) (Maybe Bool) (Maybe CodeHook) (Maybe Text) Int
- newPutIntentResponse :: Int -> PutIntentResponse
- data DeleteIntent = DeleteIntent' Text
- newDeleteIntent :: Text -> DeleteIntent
- data DeleteIntentResponse = DeleteIntentResponse' {
- newDeleteIntentResponse :: DeleteIntentResponse
- data GetBuiltinIntents = GetBuiltinIntents' (Maybe Locale) (Maybe Text) (Maybe Text) (Maybe Natural)
- newGetBuiltinIntents :: GetBuiltinIntents
- data GetBuiltinIntentsResponse = GetBuiltinIntentsResponse' (Maybe [BuiltinIntentMetadata]) (Maybe Text) Int
- newGetBuiltinIntentsResponse :: Int -> GetBuiltinIntentsResponse
- data PutBot = PutBot' (Maybe Statement) (Maybe [Intent]) (Maybe Text) (Maybe Bool) (Maybe Double) (Maybe Bool) (Maybe ProcessBehavior) (Maybe Natural) (Maybe Prompt) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe [Tag]) Text Locale Bool
- newPutBot :: Text -> Locale -> Bool -> PutBot
- data PutBotResponse = PutBotResponse' (Maybe Text) (Maybe LexStatus) (Maybe Statement) (Maybe [Intent]) (Maybe Text) (Maybe Bool) (Maybe Double) (Maybe Bool) (Maybe Locale) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Prompt) (Maybe Text) (Maybe POSIX) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe [Tag]) Int
- newPutBotResponse :: Int -> PutBotResponse
- data DeleteBot = DeleteBot' Text
- newDeleteBot :: Text -> DeleteBot
- data DeleteBotResponse = DeleteBotResponse' {
- newDeleteBotResponse :: DeleteBotResponse
- data GetImport = GetImport' Text
- newGetImport :: Text -> GetImport
- data GetImportResponse = GetImportResponse' (Maybe [Text]) (Maybe ResourceType) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe MergeStrategy) (Maybe ImportStatus) Int
- newGetImportResponse :: Int -> GetImportResponse
- data GetIntentVersions = GetIntentVersions' (Maybe Text) (Maybe Natural) Text
- newGetIntentVersions :: Text -> GetIntentVersions
- data GetIntentVersionsResponse = GetIntentVersionsResponse' (Maybe [IntentMetadata]) (Maybe Text) Int
- newGetIntentVersionsResponse :: Int -> GetIntentVersionsResponse
- data GetBuiltinIntent = GetBuiltinIntent' Text
- newGetBuiltinIntent :: Text -> GetBuiltinIntent
- data GetBuiltinIntentResponse = GetBuiltinIntentResponse' (Maybe Text) (Maybe [BuiltinIntentSlot]) (Maybe [Locale]) Int
- newGetBuiltinIntentResponse :: Int -> GetBuiltinIntentResponse
- data PutBotAlias = PutBotAlias' (Maybe Text) (Maybe ConversationLogsRequest) (Maybe Text) (Maybe [Tag]) Text Text Text
- newPutBotAlias :: Text -> Text -> Text -> PutBotAlias
- data PutBotAliasResponse = PutBotAliasResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe ConversationLogsResponse) (Maybe POSIX) (Maybe Text) (Maybe [Tag]) Int
- newPutBotAliasResponse :: Int -> PutBotAliasResponse
- data GetBotVersions = GetBotVersions' (Maybe Text) (Maybe Natural) Text
- newGetBotVersions :: Text -> GetBotVersions
- data GetBotVersionsResponse = GetBotVersionsResponse' (Maybe [BotMetadata]) (Maybe Text) Int
- newGetBotVersionsResponse :: Int -> GetBotVersionsResponse
- data GetBotChannelAssociations = GetBotChannelAssociations' (Maybe Text) (Maybe Text) (Maybe Natural) Text Text
- newGetBotChannelAssociations :: Text -> Text -> GetBotChannelAssociations
- data GetBotChannelAssociationsResponse = GetBotChannelAssociationsResponse' (Maybe [BotChannelAssociation]) (Maybe Text) Int
- newGetBotChannelAssociationsResponse :: Int -> GetBotChannelAssociationsResponse
- data DeleteBotAlias = DeleteBotAlias' Text Text
- newDeleteBotAlias :: Text -> Text -> DeleteBotAlias
- data DeleteBotAliasResponse = DeleteBotAliasResponse' {
- newDeleteBotAliasResponse :: DeleteBotAliasResponse
- data GetSlotTypes = GetSlotTypes' (Maybe Text) (Maybe Text) (Maybe Natural)
- newGetSlotTypes :: GetSlotTypes
- data GetSlotTypesResponse = GetSlotTypesResponse' (Maybe Text) (Maybe [SlotTypeMetadata]) Int
- newGetSlotTypesResponse :: Int -> GetSlotTypesResponse
- data GetMigrations = GetMigrations' (Maybe SortOrder) (Maybe MigrationSortAttribute) (Maybe Text) (Maybe MigrationStatus) (Maybe Text) (Maybe Natural)
- newGetMigrations :: GetMigrations
- data GetMigrationsResponse = GetMigrationsResponse' (Maybe [MigrationSummary]) (Maybe Text) Int
- newGetMigrationsResponse :: Int -> GetMigrationsResponse
- data DeleteUtterances = DeleteUtterances' Text Text
- newDeleteUtterances :: Text -> Text -> DeleteUtterances
- data DeleteUtterancesResponse = DeleteUtterancesResponse' {
- newDeleteUtterancesResponse :: DeleteUtterancesResponse
- data GetBots = GetBots' (Maybe Text) (Maybe Text) (Maybe Natural)
- newGetBots :: GetBots
- data GetBotsResponse = GetBotsResponse' (Maybe [BotMetadata]) (Maybe Text) Int
- newGetBotsResponse :: Int -> GetBotsResponse
- data GetBot = GetBot' Text Text
- newGetBot :: Text -> Text -> GetBot
- data GetBotResponse = GetBotResponse' (Maybe Text) (Maybe LexStatus) (Maybe Statement) (Maybe [Intent]) (Maybe Text) (Maybe Bool) (Maybe Double) (Maybe Bool) (Maybe Locale) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Prompt) (Maybe Text) (Maybe POSIX) (Maybe Bool) (Maybe Text) Int
- newGetBotResponse :: Int -> GetBotResponse
- data CreateBotVersion = CreateBotVersion' (Maybe Text) Text
- newCreateBotVersion :: Text -> CreateBotVersion
- data CreateBotVersionResponse = CreateBotVersionResponse' (Maybe Text) (Maybe LexStatus) (Maybe Statement) (Maybe [Intent]) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Locale) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Prompt) (Maybe Text) (Maybe POSIX) (Maybe Bool) (Maybe Text) Int
- newCreateBotVersionResponse :: Int -> CreateBotVersionResponse
- data DeleteSlotTypeVersion = DeleteSlotTypeVersion' Text Text
- newDeleteSlotTypeVersion :: Text -> Text -> DeleteSlotTypeVersion
- data DeleteSlotTypeVersionResponse = DeleteSlotTypeVersionResponse' {
- newDeleteSlotTypeVersionResponse :: DeleteSlotTypeVersionResponse
- data DeleteBotVersion = DeleteBotVersion' Text Text
- newDeleteBotVersion :: Text -> Text -> DeleteBotVersion
- data DeleteBotVersionResponse = DeleteBotVersionResponse' {
- newDeleteBotVersionResponse :: DeleteBotVersionResponse
- data GetSlotType = GetSlotType' Text Text
- newGetSlotType :: Text -> Text -> GetSlotType
- data GetSlotTypeResponse = GetSlotTypeResponse' (Maybe Text) (Maybe [SlotTypeConfiguration]) (Maybe Text) (Maybe SlotValueSelectionStrategy) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe [EnumerationValue]) Int
- newGetSlotTypeResponse :: Int -> GetSlotTypeResponse
- data GetExport = GetExport' Text Text ResourceType ExportType
- newGetExport :: Text -> Text -> ResourceType -> ExportType -> GetExport
- data GetExportResponse = GetExportResponse' (Maybe Text) (Maybe ResourceType) (Maybe ExportStatus) (Maybe Text) (Maybe ExportType) (Maybe Text) (Maybe Text) Int
- newGetExportResponse :: Int -> GetExportResponse
- data GetMigration = GetMigration' Text
- newGetMigration :: Text -> GetMigration
- data GetMigrationResponse = GetMigrationResponse' (Maybe Text) (Maybe MigrationStrategy) (Maybe POSIX) (Maybe [MigrationAlert]) (Maybe MigrationStatus) (Maybe Text) (Maybe Locale) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newGetMigrationResponse :: Int -> GetMigrationResponse
- data CreateIntentVersion = CreateIntentVersion' (Maybe Text) Text
- newCreateIntentVersion :: Text -> CreateIntentVersion
- data CreateIntentVersionResponse = CreateIntentVersionResponse' (Maybe FulfillmentActivity) (Maybe [Slot]) (Maybe Statement) (Maybe Text) (Maybe Statement) (Maybe [Text]) (Maybe Text) (Maybe POSIX) (Maybe KendraConfiguration) (Maybe Text) (Maybe Text) (Maybe [InputContext]) (Maybe FollowUpPrompt) (Maybe POSIX) (Maybe [OutputContext]) (Maybe Prompt) (Maybe CodeHook) (Maybe Text) Int
- newCreateIntentVersionResponse :: Int -> CreateIntentVersionResponse
- data DeleteSlotType = DeleteSlotType' Text
- newDeleteSlotType :: Text -> DeleteSlotType
- data DeleteSlotTypeResponse = DeleteSlotTypeResponse' {
- newDeleteSlotTypeResponse :: DeleteSlotTypeResponse
- data StartImport = StartImport' (Maybe [Tag]) Base64 ResourceType MergeStrategy
- newStartImport :: ByteString -> ResourceType -> MergeStrategy -> StartImport
- data StartImportResponse = StartImportResponse' (Maybe ResourceType) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe MergeStrategy) (Maybe ImportStatus) (Maybe [Tag]) Int
- newStartImportResponse :: Int -> StartImportResponse
- data GetBotChannelAssociation = GetBotChannelAssociation' Text Text Text
- newGetBotChannelAssociation :: Text -> Text -> Text -> GetBotChannelAssociation
- data GetBotChannelAssociationResponse = GetBotChannelAssociationResponse' (Maybe Text) (Maybe ChannelStatus) (Maybe Text) (Maybe Text) (Maybe (Sensitive (HashMap Text Text))) (Maybe POSIX) (Maybe Text) (Maybe ChannelType) (Maybe Text) Int
- newGetBotChannelAssociationResponse :: Int -> GetBotChannelAssociationResponse
- data PutSlotType = PutSlotType' (Maybe Text) (Maybe [SlotTypeConfiguration]) (Maybe Text) (Maybe SlotValueSelectionStrategy) (Maybe Bool) (Maybe Text) (Maybe [EnumerationValue]) Text
- newPutSlotType :: Text -> PutSlotType
- data PutSlotTypeResponse = PutSlotTypeResponse' (Maybe Text) (Maybe [SlotTypeConfiguration]) (Maybe Text) (Maybe SlotValueSelectionStrategy) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Bool) (Maybe Text) (Maybe [EnumerationValue]) Int
- newPutSlotTypeResponse :: Int -> PutSlotTypeResponse
- data GetBuiltinSlotTypes = GetBuiltinSlotTypes' (Maybe Locale) (Maybe Text) (Maybe Text) (Maybe Natural)
- newGetBuiltinSlotTypes :: GetBuiltinSlotTypes
- data GetBuiltinSlotTypesResponse = GetBuiltinSlotTypesResponse' (Maybe Text) (Maybe [BuiltinSlotTypeMetadata]) Int
- newGetBuiltinSlotTypesResponse :: Int -> GetBuiltinSlotTypesResponse
- data TagResource = TagResource' Text [Tag]
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data GetUtterancesView = GetUtterancesView' Text (NonEmpty Text) StatusType
- newGetUtterancesView :: Text -> NonEmpty Text -> StatusType -> GetUtterancesView
- data GetUtterancesViewResponse = GetUtterancesViewResponse' (Maybe Text) (Maybe [UtteranceList]) Int
- newGetUtterancesViewResponse :: Int -> GetUtterancesViewResponse
- data GetSlotTypeVersions = GetSlotTypeVersions' (Maybe Text) (Maybe Natural) Text
- newGetSlotTypeVersions :: Text -> GetSlotTypeVersions
- data GetSlotTypeVersionsResponse = GetSlotTypeVersionsResponse' (Maybe Text) (Maybe [SlotTypeMetadata]) Int
- newGetSlotTypeVersionsResponse :: Int -> GetSlotTypeVersionsResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data GetIntents = GetIntents' (Maybe Text) (Maybe Text) (Maybe Natural)
- newGetIntents :: GetIntents
- data GetIntentsResponse = GetIntentsResponse' (Maybe [IntentMetadata]) (Maybe Text) Int
- newGetIntentsResponse :: Int -> GetIntentsResponse
- data GetBotAlias = GetBotAlias' Text Text
- newGetBotAlias :: Text -> Text -> GetBotAlias
- data GetBotAliasResponse = GetBotAliasResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe ConversationLogsResponse) (Maybe POSIX) (Maybe Text) Int
- newGetBotAliasResponse :: Int -> GetBotAliasResponse
- 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' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe ConversationLogsResponse) (Maybe POSIX) (Maybe Text)
- newBotAliasMetadata :: BotAliasMetadata
- data BotChannelAssociation = BotChannelAssociation' (Maybe Text) (Maybe ChannelStatus) (Maybe Text) (Maybe Text) (Maybe (Sensitive (HashMap Text Text))) (Maybe POSIX) (Maybe Text) (Maybe ChannelType) (Maybe Text)
- newBotChannelAssociation :: BotChannelAssociation
- data BotMetadata = BotMetadata' (Maybe LexStatus) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text)
- newBotMetadata :: BotMetadata
- data BuiltinIntentMetadata = BuiltinIntentMetadata' (Maybe Text) (Maybe [Locale])
- newBuiltinIntentMetadata :: BuiltinIntentMetadata
- data BuiltinIntentSlot = BuiltinIntentSlot' (Maybe Text)
- newBuiltinIntentSlot :: BuiltinIntentSlot
- data BuiltinSlotTypeMetadata = BuiltinSlotTypeMetadata' (Maybe Text) (Maybe [Locale])
- newBuiltinSlotTypeMetadata :: BuiltinSlotTypeMetadata
- data CodeHook = CodeHook' Text Text
- newCodeHook :: Text -> Text -> CodeHook
- data ConversationLogsRequest = ConversationLogsRequest' [LogSettingsRequest] Text
- newConversationLogsRequest :: Text -> ConversationLogsRequest
- data ConversationLogsResponse = ConversationLogsResponse' (Maybe Text) (Maybe [LogSettingsResponse])
- newConversationLogsResponse :: ConversationLogsResponse
- data EnumerationValue = EnumerationValue' (Maybe [Text]) Text
- newEnumerationValue :: Text -> EnumerationValue
- data FollowUpPrompt = FollowUpPrompt' Prompt Statement
- newFollowUpPrompt :: Prompt -> Statement -> FollowUpPrompt
- data FulfillmentActivity = FulfillmentActivity' (Maybe CodeHook) FulfillmentActivityType
- newFulfillmentActivity :: FulfillmentActivityType -> FulfillmentActivity
- data InputContext = InputContext' Text
- newInputContext :: Text -> InputContext
- data Intent = Intent' Text Text
- newIntent :: Text -> Text -> Intent
- data IntentMetadata = IntentMetadata' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text)
- newIntentMetadata :: IntentMetadata
- data KendraConfiguration = KendraConfiguration' (Maybe Text) Text Text
- newKendraConfiguration :: Text -> Text -> KendraConfiguration
- data LogSettingsRequest = LogSettingsRequest' (Maybe Text) LogType Destination Text
- newLogSettingsRequest :: LogType -> Destination -> Text -> LogSettingsRequest
- data LogSettingsResponse = LogSettingsResponse' (Maybe Destination) (Maybe Text) (Maybe LogType) (Maybe Text) (Maybe Text)
- newLogSettingsResponse :: LogSettingsResponse
- data Message = Message' (Maybe Natural) ContentType Text
- newMessage :: ContentType -> Text -> Message
- data MigrationAlert = MigrationAlert' (Maybe [Text]) (Maybe [Text]) (Maybe MigrationAlertType) (Maybe Text)
- newMigrationAlert :: MigrationAlert
- data MigrationSummary = MigrationSummary' (Maybe Text) (Maybe MigrationStrategy) (Maybe POSIX) (Maybe MigrationStatus) (Maybe Text) (Maybe Locale) (Maybe Text) (Maybe Text) (Maybe Text)
- newMigrationSummary :: MigrationSummary
- data OutputContext = OutputContext' Text Natural Natural
- newOutputContext :: Text -> Natural -> Natural -> OutputContext
- data Prompt = Prompt' (Maybe Text) (NonEmpty Message) Natural
- newPrompt :: NonEmpty Message -> Natural -> Prompt
- data Slot = Slot' (Maybe Text) (Maybe Prompt) (Maybe Text) (Maybe Natural) (Maybe ObfuscationSetting) (Maybe SlotDefaultValueSpec) (Maybe Text) (Maybe [Text]) (Maybe Text) Text SlotConstraint
- newSlot :: Text -> SlotConstraint -> Slot
- data SlotDefaultValue = SlotDefaultValue' Text
- newSlotDefaultValue :: Text -> SlotDefaultValue
- data SlotDefaultValueSpec = SlotDefaultValueSpec' [SlotDefaultValue]
- newSlotDefaultValueSpec :: SlotDefaultValueSpec
- data SlotTypeConfiguration = SlotTypeConfiguration' (Maybe SlotTypeRegexConfiguration)
- newSlotTypeConfiguration :: SlotTypeConfiguration
- data SlotTypeMetadata = SlotTypeMetadata' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text)
- newSlotTypeMetadata :: SlotTypeMetadata
- data SlotTypeRegexConfiguration = SlotTypeRegexConfiguration' Text
- newSlotTypeRegexConfiguration :: Text -> SlotTypeRegexConfiguration
- data Statement = Statement' (Maybe Text) (NonEmpty Message)
- newStatement :: NonEmpty Message -> Statement
- data Tag = Tag' Text Text
- newTag :: Text -> Text -> Tag
- data UtteranceData = UtteranceData' (Maybe POSIX) (Maybe Int) (Maybe Text) (Maybe POSIX) (Maybe Int)
- newUtteranceData :: UtteranceData
- data UtteranceList = UtteranceList' (Maybe Text) (Maybe [UtteranceData])
- newUtteranceList :: UtteranceList
Service Configuration
defaultService :: Service Source #
API version 2017-04-19 of the Amazon Lex Model Building Service SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by LexModels.
AccessDeniedException
_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
_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
_ConflictException :: AsError a => Getting (First ServiceError) a ServiceError Source #
There was a conflict processing the request. Try your request again.
NotFoundException
_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
_InternalFailureException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An internal Amazon Lex error occurred. Try your request again.
BadRequestException
_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
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request exceeded a limit. Try your request again.
ResourceInUseException
_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 } }
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
StartMigration
data StartMigration Source #
See: newStartMigration smart constructor.
Constructors
| StartMigration' Text Text Text Text MigrationStrategy |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> MigrationStrategy | |
| -> StartMigration |
Create a value of StartMigration 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:v1BotName:StartMigration', startMigration_v1BotName - The name of the Amazon Lex V1 bot that you are migrating to Amazon Lex
V2.
$sel:v1BotVersion:StartMigration', startMigration_v1BotVersion - The version of the bot to migrate to Amazon Lex V2. You can migrate the
$LATEST version as well as any numbered version.
$sel:v2BotName:StartMigration', startMigration_v2BotName - The name of the Amazon Lex V2 bot that you are migrating the Amazon Lex
V1 bot to.
- If the Amazon Lex V2 bot doesn't exist, you must use the
CREATE_NEWmigration strategy. - If the Amazon Lex V2 bot exists, you must use the
UPDATE_EXISTINGmigration strategy to change the contents of the Amazon Lex V2 bot.
$sel:v2BotRole:StartMigration', startMigration_v2BotRole - The IAM role that Amazon Lex uses to run the Amazon Lex V2 bot.
$sel:migrationStrategy:StartMigration', startMigration_migrationStrategy - The strategy used to conduct the migration.
CREATE_NEW- Creates a new Amazon Lex V2 bot and migrates the Amazon Lex V1 bot to the new bot.UPDATE_EXISTING- Overwrites the existing Amazon Lex V2 bot metadata and the locale being migrated. It doesn't change any other locales in the Amazon Lex V2 bot. If the locale doesn't exist, a new locale is created in the Amazon Lex V2 bot.
data StartMigrationResponse Source #
See: newStartMigrationResponse smart constructor.
Constructors
| StartMigrationResponse' (Maybe Text) (Maybe MigrationStrategy) (Maybe POSIX) (Maybe Text) (Maybe Locale) (Maybe Text) (Maybe Text) (Maybe Text) Int |
Instances
newStartMigrationResponse Source #
Create a value of StartMigrationResponse 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:StartMigration', startMigrationResponse_v1BotVersion - The version of the bot to migrate to Amazon Lex V2.
$sel:migrationStrategy:StartMigration', startMigrationResponse_migrationStrategy - The strategy used to conduct the migration.
$sel:migrationTimestamp:StartMigrationResponse', startMigrationResponse_migrationTimestamp - The date and time that the migration started.
$sel:v2BotId:StartMigrationResponse', startMigrationResponse_v2BotId - The unique identifier for the Amazon Lex V2 bot.
$sel:v1BotLocale:StartMigrationResponse', startMigrationResponse_v1BotLocale - The locale used for the Amazon Lex V1 bot.
$sel:v1BotName:StartMigration', startMigrationResponse_v1BotName - The name of the Amazon Lex V1 bot that you are migrating to Amazon Lex
V2.
$sel:v2BotRole:StartMigration', startMigrationResponse_v2BotRole - The IAM role that Amazon Lex uses to run the Amazon Lex V2 bot.
$sel:migrationId:StartMigrationResponse', startMigrationResponse_migrationId - The unique identifier that Amazon Lex assigned to the migration.
$sel:httpStatus:StartMigrationResponse', startMigrationResponse_httpStatus - The response's http status code.
DeleteIntentVersion
data DeleteIntentVersion Source #
See: newDeleteIntentVersion smart constructor.
Constructors
| DeleteIntentVersion' Text Text |
Instances
newDeleteIntentVersion Source #
Arguments
| :: Text | |
| -> Text | |
| -> DeleteIntentVersion |
Create a value of DeleteIntentVersion 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:DeleteIntentVersion', deleteIntentVersion_name - The name of the intent.
$sel:version:DeleteIntentVersion', deleteIntentVersion_version - The version of the intent to delete. You cannot delete the $LATEST
version of the intent. To delete the $LATEST version, use the
DeleteIntent operation.
data DeleteIntentVersionResponse Source #
See: newDeleteIntentVersionResponse smart constructor.
Constructors
| DeleteIntentVersionResponse' | |
Instances
newDeleteIntentVersionResponse :: DeleteIntentVersionResponse Source #
Create a value of DeleteIntentVersionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
GetBotAliases (Paginated)
data GetBotAliases Source #
See: newGetBotAliases smart constructor.
Instances
Arguments
| :: Text | |
| -> GetBotAliases |
Create a value of GetBotAliases 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:nameContains:GetBotAliases', getBotAliases_nameContains - Substring to match in bot alias names. An alias will be returned if any
part of its name matches the substring. For example, "xyz" matches
both "xyzabc" and "abcxyz."
$sel:nextToken:GetBotAliases', getBotAliases_nextToken - A pagination token for fetching the next page of aliases. If the
response to this call is truncated, Amazon Lex returns a pagination
token in the response. To fetch the next page of aliases, specify the
pagination token in the next request.
$sel:maxResults:GetBotAliases', getBotAliases_maxResults - The maximum number of aliases to return in the response. The default is
50. .
$sel:botName:GetBotAliases', getBotAliases_botName - The name of the bot.
data GetBotAliasesResponse Source #
See: newGetBotAliasesResponse smart constructor.
Constructors
| GetBotAliasesResponse' (Maybe Text) (Maybe [BotAliasMetadata]) Int |
Instances
newGetBotAliasesResponse Source #
Create a value of GetBotAliasesResponse 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:nextToken:GetBotAliases', getBotAliasesResponse_nextToken - A pagination token for fetching next page of aliases. If the response to
this call is truncated, Amazon Lex returns a pagination token in the
response. To fetch the next page of aliases, specify the pagination
token in the next request.
$sel:botAliases:GetBotAliasesResponse', getBotAliasesResponse_botAliases - An array of BotAliasMetadata objects, each describing a bot alias.
$sel:httpStatus:GetBotAliasesResponse', getBotAliasesResponse_httpStatus - The response's http status code.
DeleteBotChannelAssociation
data DeleteBotChannelAssociation Source #
See: newDeleteBotChannelAssociation smart constructor.
Constructors
| DeleteBotChannelAssociation' Text Text Text |
Instances
newDeleteBotChannelAssociation Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> DeleteBotChannelAssociation |
Create a value of DeleteBotChannelAssociation 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:DeleteBotChannelAssociation', deleteBotChannelAssociation_name - The name of the association. The name is case sensitive.
$sel:botName:DeleteBotChannelAssociation', deleteBotChannelAssociation_botName - The name of the Amazon Lex bot.
$sel:botAlias:DeleteBotChannelAssociation', deleteBotChannelAssociation_botAlias - An alias that points to the specific version of the Amazon Lex bot to
which this association is being made.
data DeleteBotChannelAssociationResponse Source #
See: newDeleteBotChannelAssociationResponse smart constructor.
Constructors
| DeleteBotChannelAssociationResponse' | |
Instances
newDeleteBotChannelAssociationResponse :: DeleteBotChannelAssociationResponse Source #
Create a value of DeleteBotChannelAssociationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
CreateSlotTypeVersion
data CreateSlotTypeVersion Source #
See: newCreateSlotTypeVersion smart constructor.
Constructors
| CreateSlotTypeVersion' (Maybe Text) Text |
Instances
newCreateSlotTypeVersion Source #
Arguments
| :: Text | |
| -> CreateSlotTypeVersion |
Create a value of CreateSlotTypeVersion 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:CreateSlotTypeVersion', createSlotTypeVersion_checksum - Checksum for the $LATEST version of the slot type that you want to
publish. If you specify a checksum and the $LATEST version of the slot
type has a different checksum, Amazon Lex returns a
PreconditionFailedException exception and doesn't publish the new
version. If you don't specify a checksum, Amazon Lex publishes the
$LATEST version.
$sel:name:CreateSlotTypeVersion', createSlotTypeVersion_name - The name of the slot type that you want to create a new version for. The
name is case sensitive.
data CreateSlotTypeVersionResponse Source #
See: newCreateSlotTypeVersionResponse smart constructor.
Constructors
| CreateSlotTypeVersionResponse' (Maybe Text) (Maybe [SlotTypeConfiguration]) (Maybe Text) (Maybe SlotValueSelectionStrategy) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe [EnumerationValue]) Int |
Instances
newCreateSlotTypeVersionResponse Source #
Create a value of CreateSlotTypeVersionResponse 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:parentSlotTypeSignature:CreateSlotTypeVersionResponse', createSlotTypeVersionResponse_parentSlotTypeSignature - The built-in slot type used a the parent of the slot type.
$sel:slotTypeConfigurations:CreateSlotTypeVersionResponse', createSlotTypeVersionResponse_slotTypeConfigurations - Configuration information that extends the parent built-in slot type.
$sel:checksum:CreateSlotTypeVersion', createSlotTypeVersionResponse_checksum - Checksum of the $LATEST version of the slot type.
$sel:valueSelectionStrategy:CreateSlotTypeVersionResponse', createSlotTypeVersionResponse_valueSelectionStrategy - The strategy that Amazon Lex uses to determine the value of the slot.
For more information, see PutSlotType.
$sel:createdDate:CreateSlotTypeVersionResponse', createSlotTypeVersionResponse_createdDate - The date that the slot type was created.
$sel:name:CreateSlotTypeVersion', createSlotTypeVersionResponse_name - The name of the slot type.
$sel:version:CreateSlotTypeVersionResponse', createSlotTypeVersionResponse_version - The version assigned to the new slot type version.
$sel:lastUpdatedDate:CreateSlotTypeVersionResponse', createSlotTypeVersionResponse_lastUpdatedDate - The date that the slot type was updated. When you create a resource, the
creation date and last update date are the same.
$sel:description:CreateSlotTypeVersionResponse', createSlotTypeVersionResponse_description - A description of the slot type.
$sel:enumerationValues:CreateSlotTypeVersionResponse', createSlotTypeVersionResponse_enumerationValues - A list of EnumerationValue objects that defines the values that the
slot type can take.
$sel:httpStatus:CreateSlotTypeVersionResponse', createSlotTypeVersionResponse_httpStatus - The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource smart constructor.
Constructors
| ListTagsForResource' Text |
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
Create a value of ListTagsForResource 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:resourceArn:ListTagsForResource', listTagsForResource_resourceArn - The Amazon Resource Name (ARN) of the resource to get a list of tags
for.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse smart constructor.
Constructors
| ListTagsForResourceResponse' (Maybe [Tag]) Int |
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse 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:tags:ListTagsForResourceResponse', listTagsForResourceResponse_tags - The tags associated with a resource.
$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.
GetIntent
See: newGetIntent smart constructor.
Constructors
| GetIntent' Text Text |
Instances
Create a value of GetIntent 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:GetIntent', getIntent_name - The name of the intent. The name is case sensitive.
$sel:version:GetIntent', getIntent_version - The version of the intent.
data GetIntentResponse Source #
See: newGetIntentResponse smart constructor.
Constructors
| GetIntentResponse' (Maybe FulfillmentActivity) (Maybe [Slot]) (Maybe Statement) (Maybe Text) (Maybe Statement) (Maybe [Text]) (Maybe Text) (Maybe POSIX) (Maybe KendraConfiguration) (Maybe Text) (Maybe Text) (Maybe [InputContext]) (Maybe FollowUpPrompt) (Maybe POSIX) (Maybe [OutputContext]) (Maybe Prompt) (Maybe CodeHook) (Maybe Text) Int |
Instances
Arguments
| :: Int | |
| -> GetIntentResponse |
Create a value of GetIntentResponse 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:fulfillmentActivity:GetIntentResponse', getIntentResponse_fulfillmentActivity - Describes how the intent is fulfilled. For more information, see
PutIntent.
$sel:slots:GetIntentResponse', getIntentResponse_slots - An array of intent slots configured for the intent.
$sel:rejectionStatement:GetIntentResponse', getIntentResponse_rejectionStatement - If the user answers "no" to the question defined in
confirmationPrompt, Amazon Lex responds with this statement to
acknowledge that the intent was canceled.
$sel:checksum:GetIntentResponse', getIntentResponse_checksum - Checksum of the intent.
$sel:conclusionStatement:GetIntentResponse', getIntentResponse_conclusionStatement - After the Lambda function specified in the fulfillmentActivity element
fulfills the intent, Amazon Lex conveys this statement to the user.
$sel:sampleUtterances:GetIntentResponse', getIntentResponse_sampleUtterances - An array of sample utterances configured for the intent.
$sel:parentIntentSignature:GetIntentResponse', getIntentResponse_parentIntentSignature - A unique identifier for a built-in intent.
$sel:createdDate:GetIntentResponse', getIntentResponse_createdDate - The date that the intent was created.
$sel:kendraConfiguration:GetIntentResponse', getIntentResponse_kendraConfiguration - Configuration information, if any, to connect to an Amazon Kendra index
with the AMAZON.KendraSearchIntent intent.
$sel:name:GetIntent', getIntentResponse_name - The name of the intent.
$sel:version:GetIntent', getIntentResponse_version - The version of the intent.
$sel:inputContexts:GetIntentResponse', getIntentResponse_inputContexts - An array of InputContext objects that lists the contexts that must be
active for Amazon Lex to choose the intent in a conversation with the
user.
$sel:followUpPrompt:GetIntentResponse', getIntentResponse_followUpPrompt - If defined in the bot, Amazon Lex uses this prompt to solicit additional
user activity after the intent is fulfilled. For more information, see
PutIntent.
$sel:lastUpdatedDate:GetIntentResponse', getIntentResponse_lastUpdatedDate - The date that the intent was updated. When you create a resource, the
creation date and the last updated date are the same.
$sel:outputContexts:GetIntentResponse', getIntentResponse_outputContexts - An array of OutputContext objects that lists the contexts that the
intent activates when the intent is fulfilled.
$sel:confirmationPrompt:GetIntentResponse', getIntentResponse_confirmationPrompt - If defined in the bot, Amazon Lex uses prompt to confirm the intent
before fulfilling the user's request. For more information, see
PutIntent.
$sel:dialogCodeHook:GetIntentResponse', getIntentResponse_dialogCodeHook - If defined in the bot, Amazon Amazon Lex invokes this Lambda function
for each user input. For more information, see PutIntent.
$sel:description:GetIntentResponse', getIntentResponse_description - A description of the intent.
$sel:httpStatus:GetIntentResponse', getIntentResponse_httpStatus - The response's http status code.
PutIntent
See: newPutIntent smart constructor.
Constructors
| PutIntent' (Maybe FulfillmentActivity) (Maybe [Slot]) (Maybe Statement) (Maybe Text) (Maybe Statement) (Maybe [Text]) (Maybe Text) (Maybe KendraConfiguration) (Maybe [InputContext]) (Maybe FollowUpPrompt) (Maybe [OutputContext]) (Maybe Prompt) (Maybe Bool) (Maybe CodeHook) (Maybe Text) Text |
Instances
Create a value of PutIntent 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:fulfillmentActivity:PutIntent', putIntent_fulfillmentActivity - Required. Describes how the intent is fulfilled. For example, after a
user provides all of the information for a pizza order,
fulfillmentActivity defines how the bot places an order with a local
pizza store.
You might configure Amazon Lex to return all of the intent information to the client application, or direct it to invoke a Lambda function that can process the intent (for example, place an order with a pizzeria).
$sel:slots:PutIntent', putIntent_slots - An array of intent slots. At runtime, Amazon Lex elicits required slot
values from the user using prompts defined in the slots. For more
information, see how-it-works.
$sel:rejectionStatement:PutIntent', putIntent_rejectionStatement - When the user answers "no" to the question defined in
confirmationPrompt, Amazon Lex responds with this statement to
acknowledge that the intent was canceled.
You must provide both the rejectionStatement and the
confirmationPrompt, or neither.
$sel:checksum:PutIntent', putIntent_checksum - Identifies a specific revision of the $LATEST version.
When you create a new intent, leave the checksum field blank. If you
specify a checksum you get a BadRequestException exception.
When you want to update a intent, set the checksum field to the
checksum of the most recent revision of the $LATEST version. If you
don't specify the checksum field, or if the checksum does not match
the $LATEST version, you get a PreconditionFailedException
exception.
$sel:conclusionStatement:PutIntent', putIntent_conclusionStatement - The statement that you want Amazon Lex to convey to the user after the
intent is successfully fulfilled by the Lambda function.
This element is relevant only if you provide a Lambda function in the
fulfillmentActivity. If you return the intent to the client
application, you can't specify this element.
The followUpPrompt and conclusionStatement are mutually exclusive.
You can specify only one.
$sel:sampleUtterances:PutIntent', putIntent_sampleUtterances - An array of utterances (strings) that a user might say to signal the
intent. For example, "I want {PizzaSize} pizza", "Order {Quantity}
{PizzaSize} pizzas".
In each utterance, a slot name is enclosed in curly braces.
$sel:parentIntentSignature:PutIntent', putIntent_parentIntentSignature - A unique identifier for the built-in intent to base this intent on. To
find the signature for an intent, see
Standard Built-in Intents
in the Alexa Skills Kit.
$sel:kendraConfiguration:PutIntent', putIntent_kendraConfiguration - Configuration information required to use the
AMAZON.KendraSearchIntent intent to connect to an Amazon Kendra index.
For more information, see
AMAZON.KendraSearchIntent.
$sel:inputContexts:PutIntent', putIntent_inputContexts - An array of InputContext objects that lists the contexts that must be
active for Amazon Lex to choose the intent in a conversation with the
user.
$sel:followUpPrompt:PutIntent', putIntent_followUpPrompt - Amazon Lex uses this prompt to solicit additional activity after
fulfilling an intent. For example, after the OrderPizza intent is
fulfilled, you might prompt the user to order a drink.
The action that Amazon Lex takes depends on the user's response, as follows:
- If the user says "Yes" it responds with the clarification prompt that is configured for the bot.
- if the user says "Yes" and continues with an utterance that triggers an intent it starts a conversation for the intent.
- If the user says "No" it responds with the rejection statement configured for the the follow-up prompt.
- If it doesn't recognize the utterance it repeats the follow-up prompt again.
The followUpPrompt field and the conclusionStatement field are
mutually exclusive. You can specify only one.
$sel:outputContexts:PutIntent', putIntent_outputContexts - An array of OutputContext objects that lists the contexts that the
intent activates when the intent is fulfilled.
$sel:confirmationPrompt:PutIntent', putIntent_confirmationPrompt - Prompts the user to confirm the intent. This question should have a yes
or no answer.
Amazon Lex uses this prompt to ensure that the user acknowledges that
the intent is ready for fulfillment. For example, with the OrderPizza
intent, you might want to confirm that the order is correct before
placing it. For other intents, such as intents that simply respond to
user questions, you might not need to ask the user for confirmation
before providing the information.
You you must provide both the rejectionStatement and the
confirmationPrompt, or neither.
$sel:createVersion:PutIntent', putIntent_createVersion - When set to true a new numbered version of the intent is created. This
is the same as calling the CreateIntentVersion operation. If you do
not specify createVersion, the default is false.
$sel:dialogCodeHook:PutIntent', putIntent_dialogCodeHook - Specifies a Lambda function to invoke for each user input. You can
invoke this Lambda function to personalize user interaction.
For example, suppose your bot determines that the user is John. Your
Lambda function might retrieve John's information from a backend
database and prepopulate some of the values. For example, if you find
that John is gluten intolerant, you might set the corresponding intent
slot, GlutenIntolerant, to true. You might find John's phone number
and set the corresponding session attribute.
$sel:description:PutIntent', putIntent_description - A description of the intent.
$sel:name:PutIntent', putIntent_name - The name of the intent. The name is not case sensitive.
The name can't match a built-in intent name, or a built-in intent name
with "AMAZON." removed. For example, because there is a built-in
intent called AMAZON.HelpIntent, you can't create a custom intent
called HelpIntent.
For a list of built-in intents, see Standard Built-in Intents in the Alexa Skills Kit.
data PutIntentResponse Source #
See: newPutIntentResponse smart constructor.
Constructors
| PutIntentResponse' (Maybe FulfillmentActivity) (Maybe [Slot]) (Maybe Statement) (Maybe Text) (Maybe Statement) (Maybe [Text]) (Maybe Text) (Maybe POSIX) (Maybe KendraConfiguration) (Maybe Text) (Maybe Text) (Maybe [InputContext]) (Maybe FollowUpPrompt) (Maybe POSIX) (Maybe [OutputContext]) (Maybe Prompt) (Maybe Bool) (Maybe CodeHook) (Maybe Text) Int |
Instances
Arguments
| :: Int | |
| -> PutIntentResponse |
Create a value of PutIntentResponse 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:fulfillmentActivity:PutIntent', putIntentResponse_fulfillmentActivity - If defined in the intent, Amazon Lex invokes this Lambda function to
fulfill the intent after the user provides all of the information
required by the intent.
$sel:slots:PutIntent', putIntentResponse_slots - An array of intent slots that are configured for the intent.
$sel:rejectionStatement:PutIntent', putIntentResponse_rejectionStatement - If the user answers "no" to the question defined in
confirmationPrompt Amazon Lex responds with this statement to
acknowledge that the intent was canceled.
$sel:checksum:PutIntent', putIntentResponse_checksum - Checksum of the $LATESTversion of the intent created or updated.
$sel:conclusionStatement:PutIntent', putIntentResponse_conclusionStatement - After the Lambda function specified in thefulfillmentActivityintent
fulfills the intent, Amazon Lex conveys this statement to the user.
$sel:sampleUtterances:PutIntent', putIntentResponse_sampleUtterances - An array of sample utterances that are configured for the intent.
$sel:parentIntentSignature:PutIntent', putIntentResponse_parentIntentSignature - A unique identifier for the built-in intent that this intent is based
on.
$sel:createdDate:PutIntentResponse', putIntentResponse_createdDate - The date that the intent was created.
$sel:kendraConfiguration:PutIntent', putIntentResponse_kendraConfiguration - Configuration information, if any, required to connect to an Amazon
Kendra index and use the AMAZON.KendraSearchIntent intent.
$sel:name:PutIntent', putIntentResponse_name - The name of the intent.
$sel:version:PutIntentResponse', putIntentResponse_version - The version of the intent. For a new intent, the version is always
$LATEST.
$sel:inputContexts:PutIntent', putIntentResponse_inputContexts - An array of InputContext objects that lists the contexts that must be
active for Amazon Lex to choose the intent in a conversation with the
user.
$sel:followUpPrompt:PutIntent', putIntentResponse_followUpPrompt - If defined in the intent, Amazon Lex uses this prompt to solicit
additional user activity after the intent is fulfilled.
$sel:lastUpdatedDate:PutIntentResponse', putIntentResponse_lastUpdatedDate - The date that the intent was updated. When you create a resource, the
creation date and last update dates are the same.
$sel:outputContexts:PutIntent', putIntentResponse_outputContexts - An array of OutputContext objects that lists the contexts that the
intent activates when the intent is fulfilled.
$sel:confirmationPrompt:PutIntent', putIntentResponse_confirmationPrompt - If defined in the intent, Amazon Lex prompts the user to confirm the
intent before fulfilling it.
$sel:createVersion:PutIntent', putIntentResponse_createVersion - True if a new version of the intent was created. If the
createVersion field was not specified in the request, the
createVersion field is set to false in the response.
$sel:dialogCodeHook:PutIntent', putIntentResponse_dialogCodeHook - If defined in the intent, Amazon Lex invokes this Lambda function for
each user input.
$sel:description:PutIntent', putIntentResponse_description - A description of the intent.
$sel:httpStatus:PutIntentResponse', putIntentResponse_httpStatus - The response's http status code.
DeleteIntent
data DeleteIntent Source #
See: newDeleteIntent smart constructor.
Constructors
| DeleteIntent' Text |
Instances
Arguments
| :: Text | |
| -> DeleteIntent |
Create a value of DeleteIntent 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:DeleteIntent', deleteIntent_name - The name of the intent. The name is case sensitive.
data DeleteIntentResponse Source #
See: newDeleteIntentResponse smart constructor.
Constructors
| DeleteIntentResponse' | |
Instances
newDeleteIntentResponse :: DeleteIntentResponse Source #
Create a value of DeleteIntentResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
GetBuiltinIntents (Paginated)
data GetBuiltinIntents Source #
See: newGetBuiltinIntents smart constructor.
Instances
newGetBuiltinIntents :: GetBuiltinIntents Source #
Create a value of GetBuiltinIntents 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:locale:GetBuiltinIntents', getBuiltinIntents_locale - A list of locales that the intent supports.
$sel:nextToken:GetBuiltinIntents', getBuiltinIntents_nextToken - A pagination token that fetches the next page of intents. If this API
call is truncated, Amazon Lex returns a pagination token in the
response. To fetch the next page of intents, use the pagination token in
the next request.
$sel:signatureContains:GetBuiltinIntents', getBuiltinIntents_signatureContains - Substring to match in built-in intent signatures. An intent will be
returned if any part of its signature matches the substring. For
example, "xyz" matches both "xyzabc" and "abcxyz." To find the
signature for an intent, see
Standard Built-in Intents
in the Alexa Skills Kit.
$sel:maxResults:GetBuiltinIntents', getBuiltinIntents_maxResults - The maximum number of intents to return in the response. The default is
10.
data GetBuiltinIntentsResponse Source #
See: newGetBuiltinIntentsResponse smart constructor.
Constructors
| GetBuiltinIntentsResponse' (Maybe [BuiltinIntentMetadata]) (Maybe Text) Int |
Instances
newGetBuiltinIntentsResponse Source #
Create a value of GetBuiltinIntentsResponse 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:intents:GetBuiltinIntentsResponse', getBuiltinIntentsResponse_intents - An array of builtinIntentMetadata objects, one for each intent in the
response.
$sel:nextToken:GetBuiltinIntents', getBuiltinIntentsResponse_nextToken - A pagination token that fetches the next page of intents. If the
response to this API call is truncated, Amazon Lex returns a pagination
token in the response. To fetch the next page of intents, specify the
pagination token in the next request.
$sel:httpStatus:GetBuiltinIntentsResponse', getBuiltinIntentsResponse_httpStatus - The response's http status code.
PutBot
See: newPutBot smart constructor.
Constructors
| PutBot' (Maybe Statement) (Maybe [Intent]) (Maybe Text) (Maybe Bool) (Maybe Double) (Maybe Bool) (Maybe ProcessBehavior) (Maybe Natural) (Maybe Prompt) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe [Tag]) Text Locale Bool |
Instances
Create a value of PutBot 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:abortStatement:PutBot', putBot_abortStatement - When Amazon Lex can't understand the user's input in context, it tries
to elicit the information a few times. After that, Amazon Lex sends the
message defined in abortStatement to the user, and then cancels the
conversation. To set the number of retries, use the
valueElicitationPrompt field for the slot type.
For example, in a pizza ordering bot, Amazon Lex might ask a user "What type of crust would you like?" If the user's response is not one of the expected responses (for example, "thin crust, "deep dish," etc.), Amazon Lex tries to elicit a correct response a few more times.
For example, in a pizza ordering application, OrderPizza might be one
of the intents. This intent might require the CrustType slot. You
specify the valueElicitationPrompt field when you create the
CrustType slot.
If you have defined a fallback intent the cancel statement will not be sent to the user, the fallback intent is used instead. For more information, see AMAZON.FallbackIntent.
$sel:intents:PutBot', putBot_intents - An array of Intent objects. Each intent represents a command that a
user can express. For example, a pizza ordering bot might support an
OrderPizza intent. For more information, see how-it-works.
$sel:checksum:PutBot', putBot_checksum - Identifies a specific revision of the $LATEST version.
When you create a new bot, leave the checksum field blank. If you
specify a checksum you get a BadRequestException exception.
When you want to update a bot, set the checksum field to the checksum
of the most recent revision of the $LATEST version. If you don't
specify the checksum field, or if the checksum does not match the
$LATEST version, you get a PreconditionFailedException exception.
$sel:enableModelImprovements:PutBot', putBot_enableModelImprovements - Set to true to enable access to natural language understanding
improvements.
When you set the enableModelImprovements parameter to true you can
use the nluIntentConfidenceThreshold parameter to configure confidence
scores. For more information, see
Confidence Scores.
You can only set the enableModelImprovements parameter in certain
Regions. If you set the parameter to true, your bot has access to
accuracy improvements.
The Regions where you can set the enableModelImprovements parameter to
true are:
- US East (N. Virginia) (us-east-1)
- US West (Oregon) (us-west-2)
- Asia Pacific (Sydney) (ap-southeast-2)
- EU (Ireland) (eu-west-1)
In other Regions, the enableModelImprovements parameter is set to
true by default. In these Regions setting the parameter to false
throws a ValidationException exception.
$sel:nluIntentConfidenceThreshold:PutBot', putBot_nluIntentConfidenceThreshold - Determines the threshold where Amazon Lex will insert the
AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when
returning alternative intents in a
PostContent
or
PostText
response. AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are
only inserted if they are configured for the bot.
You must set the enableModelImprovements parameter to true to use
confidence scores in the following regions.
- US East (N. Virginia) (us-east-1)
- US West (Oregon) (us-west-2)
- Asia Pacific (Sydney) (ap-southeast-2)
- EU (Ireland) (eu-west-1)
In other Regions, the enableModelImprovements parameter is set to
true by default.
For example, suppose a bot is configured with the confidence threshold
of 0.80 and the AMAZON.FallbackIntent. Amazon Lex returns three
alternative intents with the following confidence scores: IntentA
(0.70), IntentB (0.60), IntentC (0.50). The response from the PostText
operation would be:
- AMAZON.FallbackIntent
- IntentA
- IntentB
- IntentC
$sel:detectSentiment:PutBot', putBot_detectSentiment - When set to true user utterances are sent to Amazon Comprehend for
sentiment analysis. If you don't specify detectSentiment, the default
is false.
$sel:processBehavior:PutBot', putBot_processBehavior - If you set the processBehavior element to BUILD, Amazon Lex builds
the bot so that it can be run. If you set the element to SAVE Amazon
Lex saves the bot, but doesn't build it.
If you don't specify this value, the default value is BUILD.
$sel:idleSessionTTLInSeconds:PutBot', putBot_idleSessionTTLInSeconds - The maximum time in seconds that Amazon Lex retains the data gathered in
a conversation.
A user interaction session remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.
For example, suppose that a user chooses the OrderPizza intent, but gets sidetracked halfway through placing an order. If the user doesn't complete the order within the specified time, Amazon Lex discards the slot information that it gathered, and the user must start over.
If you don't include the idleSessionTTLInSeconds element in a
PutBot operation request, Amazon Lex uses the default value. This is
also true if the request replaces an existing bot.
The default is 300 seconds (5 minutes).
$sel:clarificationPrompt:PutBot', putBot_clarificationPrompt - When Amazon Lex doesn't understand the user's intent, it uses this
message to get clarification. To specify how many times Amazon Lex
should repeat the clarification prompt, use the maxAttempts field. If
Amazon Lex still doesn't understand, it sends the message in the
abortStatement field.
When you create a clarification prompt, make sure that it suggests the correct response from the user. for example, for a bot that orders pizza and drinks, you might create this clarification prompt: "What would you like to do? You can say 'Order a pizza' or 'Order a drink.'"
If you have defined a fallback intent, it will be invoked if the
clarification prompt is repeated the number of times defined in the
maxAttempts field. For more information, see
AMAZON.FallbackIntent.
If you don't define a clarification prompt, at runtime Amazon Lex will return a 400 Bad Request exception in three cases:
- Follow-up prompt - When the user responds to a follow-up prompt but does not provide an intent. For example, in response to a follow-up prompt that says "Would you like anything else today?" the user says "Yes." Amazon Lex will return a 400 Bad Request exception because it does not have a clarification prompt to send to the user to get an intent.
- Lambda function - When using a Lambda function, you return an
ElicitIntentdialog type. Since Amazon Lex does not have a clarification prompt to get an intent from the user, it returns a 400 Bad Request exception. - PutSession operation - When using the
PutSessionoperation, you send anElicitIntentdialog type. Since Amazon Lex does not have a clarification prompt to get an intent from the user, it returns a 400 Bad Request exception.
$sel:voiceId:PutBot', putBot_voiceId - The Amazon Polly voice ID that you want Amazon Lex to use for voice
interactions with the user. The locale configured for the voice must
match the locale of the bot. For more information, see
Voices in Amazon Polly
in the Amazon Polly Developer Guide.
$sel:createVersion:PutBot', putBot_createVersion - When set to true a new numbered version of the bot is created. This is
the same as calling the CreateBotVersion operation. If you don't
specify createVersion, the default is false.
$sel:description:PutBot', putBot_description - A description of the bot.
$sel:tags:PutBot', putBot_tags - A list of tags to add to the bot. You can only add tags when you create
a bot, you can't use the PutBot operation to update the tags on a
bot. To update tags, use the TagResource operation.
$sel:name:PutBot', putBot_name - The name of the bot. The name is not case sensitive.
$sel:locale:PutBot', putBot_locale - Specifies the target locale for the bot. Any intent used in the bot must
be compatible with the locale of the bot.
The default is en-US.
$sel:childDirected:PutBot', putBot_childDirected - For each Amazon Lex bot created with the Amazon Lex Model Building
Service, you must specify whether your use of Amazon Lex is related to a
website, program, or other application that is directed or targeted, in
whole or in part, to children under age 13 and subject to the
Children's Online Privacy Protection Act (COPPA) by specifying true
or false in the childDirected field. By specifying true in the
childDirected field, you confirm that your use of Amazon Lex is
related to a website, program, or other application that is directed or
targeted, in whole or in part, to children under age 13 and subject to
COPPA. By specifying false in the childDirected field, you confirm
that your use of Amazon Lex is not related to a website, program, or
other application that is directed or targeted, in whole or in part, to
children under age 13 and subject to COPPA. You may not specify a
default value for the childDirected field that does not accurately
reflect whether your use of Amazon Lex is related to a website, program,
or other application that is directed or targeted, in whole or in part,
to children under age 13 and subject to COPPA.
If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.
data PutBotResponse Source #
See: newPutBotResponse smart constructor.
Constructors
| PutBotResponse' (Maybe Text) (Maybe LexStatus) (Maybe Statement) (Maybe [Intent]) (Maybe Text) (Maybe Bool) (Maybe Double) (Maybe Bool) (Maybe Locale) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Prompt) (Maybe Text) (Maybe POSIX) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe [Tag]) Int |
Instances
Arguments
| :: Int | |
| -> PutBotResponse |
Create a value of PutBotResponse 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:PutBotResponse', putBotResponse_failureReason - If status is FAILED, Amazon Lex provides the reason that it failed
to build the bot.
$sel:status:PutBotResponse', putBotResponse_status - When you send a request to create a bot with processBehavior set to
BUILD, Amazon Lex sets the status response element to BUILDING.
In the READY_BASIC_TESTING state you can test the bot with user inputs
that exactly match the utterances configured for the bot's intents and
values in the slot types.
If Amazon Lex can't build the bot, Amazon Lex sets status to
FAILED. Amazon Lex returns the reason for the failure in the
failureReason response element.
When you set processBehavior to SAVE, Amazon Lex sets the status
code to NOT BUILT.
When the bot is in the READY state you can test and publish the bot.
$sel:abortStatement:PutBot', putBotResponse_abortStatement - The message that Amazon Lex uses to cancel a conversation. For more
information, see PutBot.
$sel:intents:PutBot', putBotResponse_intents - An array of Intent objects. For more information, see PutBot.
$sel:checksum:PutBot', putBotResponse_checksum - Checksum of the bot that you created.
$sel:enableModelImprovements:PutBot', putBotResponse_enableModelImprovements - Indicates whether the bot uses accuracy improvements. true indicates
that the bot is using the improvements, otherwise, false.
$sel:nluIntentConfidenceThreshold:PutBot', putBotResponse_nluIntentConfidenceThreshold - The score that determines where Amazon Lex inserts the
AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when
returning alternative intents in a
PostContent
or
PostText
response. AMAZON.FallbackIntent is inserted if the confidence score
for all intents is below this value. AMAZON.KendraSearchIntent is only
inserted if it is configured for the bot.
$sel:detectSentiment:PutBot', putBotResponse_detectSentiment - true if the bot is configured to send user utterances to Amazon
Comprehend for sentiment analysis. If the detectSentiment field was
not specified in the request, the detectSentiment field is false in
the response.
$sel:locale:PutBot', putBotResponse_locale - The target locale for the bot.
$sel:createdDate:PutBotResponse', putBotResponse_createdDate - The date that the bot was created.
$sel:name:PutBot', putBotResponse_name - The name of the bot.
$sel:version:PutBotResponse', putBotResponse_version - The version of the bot. For a new bot, the version is always $LATEST.
$sel:idleSessionTTLInSeconds:PutBot', putBotResponse_idleSessionTTLInSeconds - The maximum length of time that Amazon Lex retains the data gathered in
a conversation. For more information, see PutBot.
$sel:clarificationPrompt:PutBot', putBotResponse_clarificationPrompt - The prompts that Amazon Lex uses when it doesn't understand the user's
intent. For more information, see PutBot.
$sel:voiceId:PutBot', putBotResponse_voiceId - The Amazon Polly voice ID that Amazon Lex uses for voice interaction
with the user. For more information, see PutBot.
$sel:lastUpdatedDate:PutBotResponse', putBotResponse_lastUpdatedDate - The date that the bot was updated. When you create a resource, the
creation date and last updated date are the same.
$sel:createVersion:PutBot', putBotResponse_createVersion - True if a new version of the bot was created. If the createVersion
field was not specified in the request, the createVersion field is set
to false in the response.
$sel:childDirected:PutBot', putBotResponse_childDirected - For each Amazon Lex bot created with the Amazon Lex Model Building
Service, you must specify whether your use of Amazon Lex is related to a
website, program, or other application that is directed or targeted, in
whole or in part, to children under age 13 and subject to the
Children's Online Privacy Protection Act (COPPA) by specifying true
or false in the childDirected field. By specifying true in the
childDirected field, you confirm that your use of Amazon Lex is
related to a website, program, or other application that is directed or
targeted, in whole or in part, to children under age 13 and subject to
COPPA. By specifying false in the childDirected field, you confirm
that your use of Amazon Lex is not related to a website, program, or
other application that is directed or targeted, in whole or in part, to
children under age 13 and subject to COPPA. You may not specify a
default value for the childDirected field that does not accurately
reflect whether your use of Amazon Lex is related to a website, program,
or other application that is directed or targeted, in whole or in part,
to children under age 13 and subject to COPPA.
If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.
$sel:description:PutBot', putBotResponse_description - A description of the bot.
$sel:tags:PutBot', putBotResponse_tags - A list of tags associated with the bot.
$sel:httpStatus:PutBotResponse', putBotResponse_httpStatus - The response's http status code.
DeleteBot
See: newDeleteBot smart constructor.
Constructors
| DeleteBot' Text |
Instances
| Eq DeleteBot Source # | |
| Read DeleteBot Source # | |
| Show DeleteBot Source # | |
| Generic DeleteBot Source # | |
| NFData DeleteBot Source # | |
Defined in Amazonka.LexModels.DeleteBot | |
| Hashable DeleteBot Source # | |
Defined in Amazonka.LexModels.DeleteBot | |
| AWSRequest DeleteBot Source # | |
Defined in Amazonka.LexModels.DeleteBot Associated Types type AWSResponse DeleteBot # Methods request :: DeleteBot -> Request DeleteBot # response :: MonadResource m => Logger -> Service -> Proxy DeleteBot -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteBot))) # | |
| ToHeaders DeleteBot Source # | |
Defined in Amazonka.LexModels.DeleteBot | |
| ToPath DeleteBot Source # | |
Defined in Amazonka.LexModels.DeleteBot Methods toPath :: DeleteBot -> ByteString # | |
| ToQuery DeleteBot Source # | |
Defined in Amazonka.LexModels.DeleteBot Methods toQuery :: DeleteBot -> QueryString # | |
| type Rep DeleteBot Source # | |
Defined in Amazonka.LexModels.DeleteBot | |
| type AWSResponse DeleteBot Source # | |
Defined in Amazonka.LexModels.DeleteBot | |
Create a value of DeleteBot 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:DeleteBot', deleteBot_name - The name of the bot. The name is case sensitive.
data DeleteBotResponse Source #
See: newDeleteBotResponse smart constructor.
Constructors
| DeleteBotResponse' | |
Instances
| Eq DeleteBotResponse Source # | |
Defined in Amazonka.LexModels.DeleteBot Methods (==) :: DeleteBotResponse -> DeleteBotResponse -> Bool # (/=) :: DeleteBotResponse -> DeleteBotResponse -> Bool # | |
| Read DeleteBotResponse Source # | |
Defined in Amazonka.LexModels.DeleteBot Methods readsPrec :: Int -> ReadS DeleteBotResponse # readList :: ReadS [DeleteBotResponse] # | |
| Show DeleteBotResponse Source # | |
Defined in Amazonka.LexModels.DeleteBot Methods showsPrec :: Int -> DeleteBotResponse -> ShowS # show :: DeleteBotResponse -> String # showList :: [DeleteBotResponse] -> ShowS # | |
| Generic DeleteBotResponse Source # | |
Defined in Amazonka.LexModels.DeleteBot Associated Types type Rep DeleteBotResponse :: Type -> Type # Methods from :: DeleteBotResponse -> Rep DeleteBotResponse x # to :: Rep DeleteBotResponse x -> DeleteBotResponse # | |
| NFData DeleteBotResponse Source # | |
Defined in Amazonka.LexModels.DeleteBot Methods rnf :: DeleteBotResponse -> () # | |
| type Rep DeleteBotResponse Source # | |
newDeleteBotResponse :: DeleteBotResponse Source #
Create a value of DeleteBotResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
GetImport
See: newGetImport smart constructor.
Constructors
| GetImport' Text |
Instances
| Eq GetImport Source # | |
| Read GetImport Source # | |
| Show GetImport Source # | |
| Generic GetImport Source # | |
| NFData GetImport Source # | |
Defined in Amazonka.LexModels.GetImport | |
| Hashable GetImport Source # | |
Defined in Amazonka.LexModels.GetImport | |
| AWSRequest GetImport Source # | |
Defined in Amazonka.LexModels.GetImport Associated Types type AWSResponse GetImport # Methods request :: GetImport -> Request GetImport # response :: MonadResource m => Logger -> Service -> Proxy GetImport -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetImport))) # | |
| ToHeaders GetImport Source # | |
Defined in Amazonka.LexModels.GetImport | |
| ToPath GetImport Source # | |
Defined in Amazonka.LexModels.GetImport Methods toPath :: GetImport -> ByteString # | |
| ToQuery GetImport Source # | |
Defined in Amazonka.LexModels.GetImport Methods toQuery :: GetImport -> QueryString # | |
| type Rep GetImport Source # | |
Defined in Amazonka.LexModels.GetImport | |
| type AWSResponse GetImport Source # | |
Defined in Amazonka.LexModels.GetImport | |
Create a value of GetImport 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:importId:GetImport', getImport_importId - The identifier of the import job information to return.
data GetImportResponse Source #
See: newGetImportResponse smart constructor.
Constructors
| GetImportResponse' (Maybe [Text]) (Maybe ResourceType) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe MergeStrategy) (Maybe ImportStatus) Int |
Instances
Arguments
| :: Int | |
| -> GetImportResponse |
Create a value of GetImportResponse 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:GetImportResponse', getImportResponse_failureReason - A string that describes why an import job failed to complete.
$sel:resourceType:GetImportResponse', getImportResponse_resourceType - The type of resource imported.
$sel:importId:GetImport', getImportResponse_importId - The identifier for the specific import job.
$sel:createdDate:GetImportResponse', getImportResponse_createdDate - A timestamp for the date and time that the import job was created.
$sel:name:GetImportResponse', getImportResponse_name - The name given to the import job.
$sel:mergeStrategy:GetImportResponse', getImportResponse_mergeStrategy - The action taken when there was a conflict between an existing resource
and a resource in the import file.
$sel:importStatus:GetImportResponse', getImportResponse_importStatus - The status of the import job. If the status is FAILED, you can get the
reason for the failure from the failureReason field.
$sel:httpStatus:GetImportResponse', getImportResponse_httpStatus - The response's http status code.
GetIntentVersions (Paginated)
data GetIntentVersions Source #
See: newGetIntentVersions smart constructor.
Instances
Arguments
| :: Text | |
| -> GetIntentVersions |
Create a value of GetIntentVersions 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:nextToken:GetIntentVersions', getIntentVersions_nextToken - A pagination token for fetching the next page of intent versions. If the
response to this call is truncated, Amazon Lex returns a pagination
token in the response. To fetch the next page of versions, specify the
pagination token in the next request.
$sel:maxResults:GetIntentVersions', getIntentVersions_maxResults - The maximum number of intent versions to return in the response. The
default is 10.
$sel:name:GetIntentVersions', getIntentVersions_name - The name of the intent for which versions should be returned.
data GetIntentVersionsResponse Source #
See: newGetIntentVersionsResponse smart constructor.
Constructors
| GetIntentVersionsResponse' (Maybe [IntentMetadata]) (Maybe Text) Int |
Instances
newGetIntentVersionsResponse Source #
Create a value of GetIntentVersionsResponse 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:intents:GetIntentVersionsResponse', getIntentVersionsResponse_intents - An array of IntentMetadata objects, one for each numbered version of
the intent plus one for the $LATEST version.
$sel:nextToken:GetIntentVersions', getIntentVersionsResponse_nextToken - A pagination token for fetching the next page of intent versions. If the
response to this call is truncated, Amazon Lex returns a pagination
token in the response. To fetch the next page of versions, specify the
pagination token in the next request.
$sel:httpStatus:GetIntentVersionsResponse', getIntentVersionsResponse_httpStatus - The response's http status code.
GetBuiltinIntent
data GetBuiltinIntent Source #
See: newGetBuiltinIntent smart constructor.
Constructors
| GetBuiltinIntent' Text |
Instances
Arguments
| :: Text | |
| -> GetBuiltinIntent |
Create a value of GetBuiltinIntent 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:GetBuiltinIntent', getBuiltinIntent_signature - The unique identifier for a built-in intent. To find the signature for
an intent, see
Standard Built-in Intents
in the Alexa Skills Kit.
data GetBuiltinIntentResponse Source #
See: newGetBuiltinIntentResponse smart constructor.
Constructors
| GetBuiltinIntentResponse' (Maybe Text) (Maybe [BuiltinIntentSlot]) (Maybe [Locale]) Int |
Instances
newGetBuiltinIntentResponse Source #
Create a value of GetBuiltinIntentResponse 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:GetBuiltinIntent', getBuiltinIntentResponse_signature - The unique identifier for a built-in intent.
$sel:slots:GetBuiltinIntentResponse', getBuiltinIntentResponse_slots - An array of BuiltinIntentSlot objects, one entry for each slot type in
the intent.
$sel:supportedLocales:GetBuiltinIntentResponse', getBuiltinIntentResponse_supportedLocales - A list of locales that the intent supports.
$sel:httpStatus:GetBuiltinIntentResponse', getBuiltinIntentResponse_httpStatus - The response's http status code.
PutBotAlias
data PutBotAlias Source #
See: newPutBotAlias smart constructor.
Constructors
| PutBotAlias' (Maybe Text) (Maybe ConversationLogsRequest) (Maybe Text) (Maybe [Tag]) Text Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> PutBotAlias |
Create a value of PutBotAlias 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:PutBotAlias', putBotAlias_checksum - Identifies a specific revision of the $LATEST version.
When you create a new bot alias, leave the checksum field blank. If
you specify a checksum you get a BadRequestException exception.
When you want to update a bot alias, set the checksum field to the
checksum of the most recent revision of the $LATEST version. If you
don't specify the checksum field, or if the checksum does not match
the $LATEST version, you get a PreconditionFailedException
exception.
$sel:conversationLogs:PutBotAlias', putBotAlias_conversationLogs - Settings for conversation logs for the alias.
$sel:description:PutBotAlias', putBotAlias_description - A description of the alias.
$sel:tags:PutBotAlias', putBotAlias_tags - A list of tags to add to the bot alias. You can only add tags when you
create an alias, you can't use the PutBotAlias operation to update
the tags on a bot alias. To update tags, use the TagResource
operation.
$sel:name:PutBotAlias', putBotAlias_name - The name of the alias. The name is not case sensitive.
$sel:botVersion:PutBotAlias', putBotAlias_botVersion - The version of the bot.
$sel:botName:PutBotAlias', putBotAlias_botName - The name of the bot.
data PutBotAliasResponse Source #
See: newPutBotAliasResponse smart constructor.
Constructors
| PutBotAliasResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe ConversationLogsResponse) (Maybe POSIX) (Maybe Text) (Maybe [Tag]) Int |
Instances
newPutBotAliasResponse Source #
Arguments
| :: Int | |
| -> PutBotAliasResponse |
Create a value of PutBotAliasResponse 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:PutBotAlias', putBotAliasResponse_checksum - The checksum for the current version of the alias.
$sel:botVersion:PutBotAlias', putBotAliasResponse_botVersion - The version of the bot that the alias points to.
$sel:botName:PutBotAlias', putBotAliasResponse_botName - The name of the bot that the alias points to.
$sel:createdDate:PutBotAliasResponse', putBotAliasResponse_createdDate - The date that the bot alias was created.
$sel:name:PutBotAlias', putBotAliasResponse_name - The name of the alias.
$sel:conversationLogs:PutBotAlias', putBotAliasResponse_conversationLogs - The settings that determine how Amazon Lex uses conversation logs for
the alias.
$sel:lastUpdatedDate:PutBotAliasResponse', putBotAliasResponse_lastUpdatedDate - The date that the bot alias was updated. When you create a resource, the
creation date and the last updated date are the same.
$sel:description:PutBotAlias', putBotAliasResponse_description - A description of the alias.
$sel:tags:PutBotAlias', putBotAliasResponse_tags - A list of tags associated with a bot.
$sel:httpStatus:PutBotAliasResponse', putBotAliasResponse_httpStatus - The response's http status code.
GetBotVersions (Paginated)
data GetBotVersions Source #
See: newGetBotVersions smart constructor.
Instances
Arguments
| :: Text | |
| -> GetBotVersions |
Create a value of GetBotVersions 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:nextToken:GetBotVersions', getBotVersions_nextToken - A pagination token for fetching the next page of bot versions. If the
response to this call is truncated, Amazon Lex returns a pagination
token in the response. To fetch the next page of versions, specify the
pagination token in the next request.
$sel:maxResults:GetBotVersions', getBotVersions_maxResults - The maximum number of bot versions to return in the response. The
default is 10.
$sel:name:GetBotVersions', getBotVersions_name - The name of the bot for which versions should be returned.
data GetBotVersionsResponse Source #
See: newGetBotVersionsResponse smart constructor.
Constructors
| GetBotVersionsResponse' (Maybe [BotMetadata]) (Maybe Text) Int |
Instances
newGetBotVersionsResponse Source #
Create a value of GetBotVersionsResponse 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:bots:GetBotVersionsResponse', getBotVersionsResponse_bots - An array of BotMetadata objects, one for each numbered version of the
bot plus one for the $LATEST version.
$sel:nextToken:GetBotVersions', getBotVersionsResponse_nextToken - A pagination token for fetching the next page of bot versions. If the
response to this call is truncated, Amazon Lex returns a pagination
token in the response. To fetch the next page of versions, specify the
pagination token in the next request.
$sel:httpStatus:GetBotVersionsResponse', getBotVersionsResponse_httpStatus - The response's http status code.
GetBotChannelAssociations (Paginated)
data GetBotChannelAssociations Source #
See: newGetBotChannelAssociations smart constructor.
Instances
newGetBotChannelAssociations Source #
Arguments
| :: Text | |
| -> Text | |
| -> GetBotChannelAssociations |
Create a value of GetBotChannelAssociations 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:nameContains:GetBotChannelAssociations', getBotChannelAssociations_nameContains - Substring to match in channel association names. An association will be
returned if any part of its name matches the substring. For example,
"xyz" matches both "xyzabc" and "abcxyz." To return all bot
channel associations, use a hyphen ("-") as the nameContains
parameter.
$sel:nextToken:GetBotChannelAssociations', getBotChannelAssociations_nextToken - A pagination token for fetching the next page of associations. If the
response to this call is truncated, Amazon Lex returns a pagination
token in the response. To fetch the next page of associations, specify
the pagination token in the next request.
$sel:maxResults:GetBotChannelAssociations', getBotChannelAssociations_maxResults - The maximum number of associations to return in the response. The
default is 50.
$sel:botName:GetBotChannelAssociations', getBotChannelAssociations_botName - The name of the Amazon Lex bot in the association.
$sel:botAlias:GetBotChannelAssociations', getBotChannelAssociations_botAlias - An alias pointing to the specific version of the Amazon Lex bot to which
this association is being made.
data GetBotChannelAssociationsResponse Source #
See: newGetBotChannelAssociationsResponse smart constructor.
Constructors
| GetBotChannelAssociationsResponse' (Maybe [BotChannelAssociation]) (Maybe Text) Int |
Instances
newGetBotChannelAssociationsResponse Source #
Arguments
| :: Int | |
| -> GetBotChannelAssociationsResponse |
Create a value of GetBotChannelAssociationsResponse 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:botChannelAssociations:GetBotChannelAssociationsResponse', getBotChannelAssociationsResponse_botChannelAssociations - An array of objects, one for each association, that provides information
about the Amazon Lex bot and its association with the channel.
$sel:nextToken:GetBotChannelAssociations', getBotChannelAssociationsResponse_nextToken - A pagination token that fetches the next page of associations. If the
response to this call is truncated, Amazon Lex returns a pagination
token in the response. To fetch the next page of associations, specify
the pagination token in the next request.
$sel:httpStatus:GetBotChannelAssociationsResponse', getBotChannelAssociationsResponse_httpStatus - The response's http status code.
DeleteBotAlias
data DeleteBotAlias Source #
See: newDeleteBotAlias smart constructor.
Constructors
| DeleteBotAlias' Text Text |
Instances
Create a value of DeleteBotAlias 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:DeleteBotAlias', deleteBotAlias_name - The name of the alias to delete. The name is case sensitive.
$sel:botName:DeleteBotAlias', deleteBotAlias_botName - The name of the bot that the alias points to.
data DeleteBotAliasResponse Source #
See: newDeleteBotAliasResponse smart constructor.
Constructors
| DeleteBotAliasResponse' | |
Instances
| Eq DeleteBotAliasResponse Source # | |
Defined in Amazonka.LexModels.DeleteBotAlias Methods (==) :: DeleteBotAliasResponse -> DeleteBotAliasResponse -> Bool # (/=) :: DeleteBotAliasResponse -> DeleteBotAliasResponse -> Bool # | |
| Read DeleteBotAliasResponse Source # | |
Defined in Amazonka.LexModels.DeleteBotAlias | |
| Show DeleteBotAliasResponse Source # | |
Defined in Amazonka.LexModels.DeleteBotAlias Methods showsPrec :: Int -> DeleteBotAliasResponse -> ShowS # show :: DeleteBotAliasResponse -> String # showList :: [DeleteBotAliasResponse] -> ShowS # | |
| Generic DeleteBotAliasResponse Source # | |
Defined in Amazonka.LexModels.DeleteBotAlias Associated Types type Rep DeleteBotAliasResponse :: Type -> Type # Methods from :: DeleteBotAliasResponse -> Rep DeleteBotAliasResponse x # to :: Rep DeleteBotAliasResponse x -> DeleteBotAliasResponse # | |
| NFData DeleteBotAliasResponse Source # | |
Defined in Amazonka.LexModels.DeleteBotAlias Methods rnf :: DeleteBotAliasResponse -> () # | |
| type Rep DeleteBotAliasResponse Source # | |
newDeleteBotAliasResponse :: DeleteBotAliasResponse Source #
Create a value of DeleteBotAliasResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
GetSlotTypes (Paginated)
data GetSlotTypes Source #
See: newGetSlotTypes smart constructor.
Instances
newGetSlotTypes :: GetSlotTypes Source #
Create a value of GetSlotTypes 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:nameContains:GetSlotTypes', getSlotTypes_nameContains - Substring to match in slot type names. A slot type will be returned if
any part of its name matches the substring. For example, "xyz" matches
both "xyzabc" and "abcxyz."
$sel:nextToken:GetSlotTypes', getSlotTypes_nextToken - A pagination token that fetches the next page of slot types. If the
response to this API call is truncated, Amazon Lex returns a pagination
token in the response. To fetch next page of slot types, specify the
pagination token in the next request.
$sel:maxResults:GetSlotTypes', getSlotTypes_maxResults - The maximum number of slot types to return in the response. The default
is 10.
data GetSlotTypesResponse Source #
See: newGetSlotTypesResponse smart constructor.
Constructors
| GetSlotTypesResponse' (Maybe Text) (Maybe [SlotTypeMetadata]) Int |
Instances
newGetSlotTypesResponse Source #
Arguments
| :: Int | |
| -> GetSlotTypesResponse |
Create a value of GetSlotTypesResponse 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:nextToken:GetSlotTypes', getSlotTypesResponse_nextToken - If the response is truncated, it includes a pagination token that you
can specify in your next request to fetch the next page of slot types.
$sel:slotTypes:GetSlotTypesResponse', getSlotTypesResponse_slotTypes - An array of objects, one for each slot type, that provides information
such as the name of the slot type, the version, and a description.
$sel:httpStatus:GetSlotTypesResponse', getSlotTypesResponse_httpStatus - The response's http status code.
GetMigrations
data GetMigrations Source #
See: newGetMigrations smart constructor.
Constructors
| GetMigrations' (Maybe SortOrder) (Maybe MigrationSortAttribute) (Maybe Text) (Maybe MigrationStatus) (Maybe Text) (Maybe Natural) |
Instances
newGetMigrations :: GetMigrations Source #
Create a value of GetMigrations 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:sortByOrder:GetMigrations', getMigrations_sortByOrder - The order so sort the list.
$sel:sortByAttribute:GetMigrations', getMigrations_sortByAttribute - The field to sort the list of migrations by. You can sort by the Amazon
Lex V1 bot name or the date and time that the migration was started.
$sel:nextToken:GetMigrations', getMigrations_nextToken - A pagination token that fetches the next page of migrations. If the
response to this operation is truncated, Amazon Lex returns a pagination
token in the response. To fetch the next page of migrations, specify the
pagination token in the request.
$sel:migrationStatusEquals:GetMigrations', getMigrations_migrationStatusEquals - Filters the list to contain only migrations in the specified state.
$sel:v1BotNameContains:GetMigrations', getMigrations_v1BotNameContains - Filters the list to contain only bots whose name contains the specified
string. The string is matched anywhere in bot name.
$sel:maxResults:GetMigrations', getMigrations_maxResults - The maximum number of migrations to return in the response. The default
is 10.
data GetMigrationsResponse Source #
See: newGetMigrationsResponse smart constructor.
Constructors
| GetMigrationsResponse' (Maybe [MigrationSummary]) (Maybe Text) Int |
Instances
newGetMigrationsResponse Source #
Create a value of GetMigrationsResponse 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:migrationSummaries:GetMigrationsResponse', getMigrationsResponse_migrationSummaries - An array of summaries for migrations from Amazon Lex V1 to Amazon Lex
V2. To see details of the migration, use the migrationId from the
summary in a call to the operation.
$sel:nextToken:GetMigrations', getMigrationsResponse_nextToken - If the response is truncated, it includes a pagination token that you
can specify in your next request to fetch the next page of migrations.
$sel:httpStatus:GetMigrationsResponse', getMigrationsResponse_httpStatus - The response's http status code.
DeleteUtterances
data DeleteUtterances Source #
See: newDeleteUtterances smart constructor.
Constructors
| DeleteUtterances' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DeleteUtterances |
Create a value of DeleteUtterances 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:botName:DeleteUtterances', deleteUtterances_botName - The name of the bot that stored the utterances.
$sel:userId:DeleteUtterances', deleteUtterances_userId - The unique identifier for the user that made the utterances. This is the
user ID that was sent in the
PostContent
or
PostText
operation request that contained the utterance.
data DeleteUtterancesResponse Source #
See: newDeleteUtterancesResponse smart constructor.
Constructors
| DeleteUtterancesResponse' | |
Instances
newDeleteUtterancesResponse :: DeleteUtterancesResponse Source #
Create a value of DeleteUtterancesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
GetBots (Paginated)
See: newGetBots smart constructor.
Instances
newGetBots :: GetBots Source #
Create a value of GetBots 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:nameContains:GetBots', getBots_nameContains - Substring to match in bot names. A bot will be returned if any part of
its name matches the substring. For example, "xyz" matches both
"xyzabc" and "abcxyz."
$sel:nextToken:GetBots', getBots_nextToken - A pagination token that fetches the next page of bots. If the response
to this call is truncated, Amazon Lex returns a pagination token in the
response. To fetch the next page of bots, specify the pagination token
in the next request.
$sel:maxResults:GetBots', getBots_maxResults - The maximum number of bots to return in the response that the request
will return. The default is 10.
data GetBotsResponse Source #
See: newGetBotsResponse smart constructor.
Constructors
| GetBotsResponse' (Maybe [BotMetadata]) (Maybe Text) Int |
Instances
Arguments
| :: Int | |
| -> GetBotsResponse |
Create a value of GetBotsResponse 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:bots:GetBotsResponse', getBotsResponse_bots - An array of botMetadata objects, with one entry for each bot.
$sel:nextToken:GetBots', getBotsResponse_nextToken - If the response is truncated, it includes a pagination token that you
can specify in your next request to fetch the next page of bots.
$sel:httpStatus:GetBotsResponse', getBotsResponse_httpStatus - The response's http status code.
GetBot
See: newGetBot smart constructor.
Instances
Create a value of GetBot 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:GetBot', getBot_name - The name of the bot. The name is case sensitive.
$sel:versionOrAlias:GetBot', getBot_versionOrAlias - The version or alias of the bot.
data GetBotResponse Source #
See: newGetBotResponse smart constructor.
Constructors
| GetBotResponse' (Maybe Text) (Maybe LexStatus) (Maybe Statement) (Maybe [Intent]) (Maybe Text) (Maybe Bool) (Maybe Double) (Maybe Bool) (Maybe Locale) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Prompt) (Maybe Text) (Maybe POSIX) (Maybe Bool) (Maybe Text) Int |
Instances
Arguments
| :: Int | |
| -> GetBotResponse |
Create a value of GetBotResponse 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:GetBotResponse', getBotResponse_failureReason - If status is FAILED, Amazon Lex explains why it failed to build the
bot.
$sel:status:GetBotResponse', getBotResponse_status - The status of the bot.
When the status is BUILDING Amazon Lex is building the bot for testing
and use.
If the status of the bot is READY_BASIC_TESTING, you can test the bot
using the exact utterances specified in the bot's intents. When the bot
is ready for full testing or to run, the status is READY.
If there was a problem with building the bot, the status is FAILED and
the failureReason field explains why the bot did not build.
If the bot was saved but not built, the status is NOT_BUILT.
$sel:abortStatement:GetBotResponse', getBotResponse_abortStatement - The message that Amazon Lex returns when the user elects to end the
conversation without completing it. For more information, see PutBot.
$sel:intents:GetBotResponse', getBotResponse_intents - An array of intent objects. For more information, see PutBot.
$sel:checksum:GetBotResponse', getBotResponse_checksum - Checksum of the bot used to identify a specific revision of the bot's
$LATEST version.
$sel:enableModelImprovements:GetBotResponse', getBotResponse_enableModelImprovements - Indicates whether the bot uses accuracy improvements. true indicates
that the bot is using the improvements, otherwise, false.
$sel:nluIntentConfidenceThreshold:GetBotResponse', getBotResponse_nluIntentConfidenceThreshold - The score that determines where Amazon Lex inserts the
AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when
returning alternative intents in a
PostContent
or
PostText
response. AMAZON.FallbackIntent is inserted if the confidence score
for all intents is below this value. AMAZON.KendraSearchIntent is only
inserted if it is configured for the bot.
$sel:detectSentiment:GetBotResponse', getBotResponse_detectSentiment - Indicates whether user utterances should be sent to Amazon Comprehend
for sentiment analysis.
$sel:locale:GetBotResponse', getBotResponse_locale - The target locale for the bot.
$sel:createdDate:GetBotResponse', getBotResponse_createdDate - The date that the bot was created.
$sel:name:GetBot', getBotResponse_name - The name of the bot.
$sel:version:GetBotResponse', getBotResponse_version - The version of the bot. For a new bot, the version is always $LATEST.
$sel:idleSessionTTLInSeconds:GetBotResponse', getBotResponse_idleSessionTTLInSeconds - The maximum time in seconds that Amazon Lex retains the data gathered in
a conversation. For more information, see PutBot.
$sel:clarificationPrompt:GetBotResponse', getBotResponse_clarificationPrompt - The message Amazon Lex uses when it doesn't understand the user's
request. For more information, see PutBot.
$sel:voiceId:GetBotResponse', getBotResponse_voiceId - The Amazon Polly voice ID that Amazon Lex uses for voice interaction
with the user. For more information, see PutBot.
$sel:lastUpdatedDate:GetBotResponse', getBotResponse_lastUpdatedDate - The date that the bot was updated. When you create a resource, the
creation date and last updated date are the same.
$sel:childDirected:GetBotResponse', getBotResponse_childDirected - For each Amazon Lex bot created with the Amazon Lex Model Building
Service, you must specify whether your use of Amazon Lex is related to a
website, program, or other application that is directed or targeted, in
whole or in part, to children under age 13 and subject to the
Children's Online Privacy Protection Act (COPPA) by specifying true
or false in the childDirected field. By specifying true in the
childDirected field, you confirm that your use of Amazon Lex is
related to a website, program, or other application that is directed or
targeted, in whole or in part, to children under age 13 and subject to
COPPA. By specifying false in the childDirected field, you confirm
that your use of Amazon Lex is not related to a website, program, or
other application that is directed or targeted, in whole or in part, to
children under age 13 and subject to COPPA. You may not specify a
default value for the childDirected field that does not accurately
reflect whether your use of Amazon Lex is related to a website, program,
or other application that is directed or targeted, in whole or in part,
to children under age 13 and subject to COPPA.
If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.
$sel:description:GetBotResponse', getBotResponse_description - A description of the bot.
$sel:httpStatus:GetBotResponse', getBotResponse_httpStatus - The response's http status code.
CreateBotVersion
data CreateBotVersion Source #
See: newCreateBotVersion smart constructor.
Constructors
| CreateBotVersion' (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> CreateBotVersion |
Create a value of CreateBotVersion 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:CreateBotVersion', createBotVersion_checksum - Identifies a specific revision of the $LATEST version of the bot. If
you specify a checksum and the $LATEST version of the bot has a
different checksum, a PreconditionFailedException exception is
returned and Amazon Lex doesn't publish a new version. If you don't
specify a checksum, Amazon Lex publishes the $LATEST version.
$sel:name:CreateBotVersion', createBotVersion_name - The name of the bot that you want to create a new version of. The name
is case sensitive.
data CreateBotVersionResponse Source #
See: newCreateBotVersionResponse smart constructor.
Constructors
| CreateBotVersionResponse' (Maybe Text) (Maybe LexStatus) (Maybe Statement) (Maybe [Intent]) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Locale) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Prompt) (Maybe Text) (Maybe POSIX) (Maybe Bool) (Maybe Text) Int |
Instances
newCreateBotVersionResponse Source #
Create a value of CreateBotVersionResponse 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:CreateBotVersionResponse', createBotVersionResponse_failureReason - If status is FAILED, Amazon Lex provides the reason that it failed
to build the bot.
$sel:status:CreateBotVersionResponse', createBotVersionResponse_status - When you send a request to create or update a bot, Amazon Lex sets the
status response element to BUILDING. After Amazon Lex builds the
bot, it sets status to READY. If Amazon Lex can't build the bot, it
sets status to FAILED. Amazon Lex returns the reason for the failure
in the failureReason response element.
$sel:abortStatement:CreateBotVersionResponse', createBotVersionResponse_abortStatement - The message that Amazon Lex uses to cancel a conversation. For more
information, see PutBot.
$sel:intents:CreateBotVersionResponse', createBotVersionResponse_intents - An array of Intent objects. For more information, see PutBot.
$sel:checksum:CreateBotVersion', createBotVersionResponse_checksum - Checksum identifying the version of the bot that was created.
$sel:enableModelImprovements:CreateBotVersionResponse', createBotVersionResponse_enableModelImprovements - Indicates whether the bot uses accuracy improvements. true indicates
that the bot is using the improvements, otherwise, false.
$sel:detectSentiment:CreateBotVersionResponse', createBotVersionResponse_detectSentiment - Indicates whether utterances entered by the user should be sent to
Amazon Comprehend for sentiment analysis.
$sel:locale:CreateBotVersionResponse', createBotVersionResponse_locale - Specifies the target locale for the bot.
$sel:createdDate:CreateBotVersionResponse', createBotVersionResponse_createdDate - The date when the bot version was created.
$sel:name:CreateBotVersion', createBotVersionResponse_name - The name of the bot.
$sel:version:CreateBotVersionResponse', createBotVersionResponse_version - The version of the bot.
$sel:idleSessionTTLInSeconds:CreateBotVersionResponse', createBotVersionResponse_idleSessionTTLInSeconds - The maximum time in seconds that Amazon Lex retains the data gathered in
a conversation. For more information, see PutBot.
$sel:clarificationPrompt:CreateBotVersionResponse', createBotVersionResponse_clarificationPrompt - The message that Amazon Lex uses when it doesn't understand the user's
request. For more information, see PutBot.
$sel:voiceId:CreateBotVersionResponse', createBotVersionResponse_voiceId - The Amazon Polly voice ID that Amazon Lex uses for voice interactions
with the user.
$sel:lastUpdatedDate:CreateBotVersionResponse', createBotVersionResponse_lastUpdatedDate - The date when the $LATEST version of this bot was updated.
$sel:childDirected:CreateBotVersionResponse', createBotVersionResponse_childDirected - For each Amazon Lex bot created with the Amazon Lex Model Building
Service, you must specify whether your use of Amazon Lex is related to a
website, program, or other application that is directed or targeted, in
whole or in part, to children under age 13 and subject to the
Children's Online Privacy Protection Act (COPPA) by specifying true
or false in the childDirected field. By specifying true in the
childDirected field, you confirm that your use of Amazon Lex is
related to a website, program, or other application that is directed or
targeted, in whole or in part, to children under age 13 and subject to
COPPA. By specifying false in the childDirected field, you confirm
that your use of Amazon Lex is not related to a website, program, or
other application that is directed or targeted, in whole or in part, to
children under age 13 and subject to COPPA. You may not specify a
default value for the childDirected field that does not accurately
reflect whether your use of Amazon Lex is related to a website, program,
or other application that is directed or targeted, in whole or in part,
to children under age 13 and subject to COPPA.
If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.
$sel:description:CreateBotVersionResponse', createBotVersionResponse_description - A description of the bot.
$sel:httpStatus:CreateBotVersionResponse', createBotVersionResponse_httpStatus - The response's http status code.
DeleteSlotTypeVersion
data DeleteSlotTypeVersion Source #
See: newDeleteSlotTypeVersion smart constructor.
Constructors
| DeleteSlotTypeVersion' Text Text |
Instances
newDeleteSlotTypeVersion Source #
Arguments
| :: Text | |
| -> Text | |
| -> DeleteSlotTypeVersion |
Create a value of DeleteSlotTypeVersion 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:DeleteSlotTypeVersion', deleteSlotTypeVersion_name - The name of the slot type.
$sel:version:DeleteSlotTypeVersion', deleteSlotTypeVersion_version - The version of the slot type to delete. You cannot delete the $LATEST
version of the slot type. To delete the $LATEST version, use the
DeleteSlotType operation.
data DeleteSlotTypeVersionResponse Source #
See: newDeleteSlotTypeVersionResponse smart constructor.
Constructors
| DeleteSlotTypeVersionResponse' | |
Instances
| Eq DeleteSlotTypeVersionResponse Source # | |
Defined in Amazonka.LexModels.DeleteSlotTypeVersion | |
| Read DeleteSlotTypeVersionResponse Source # | |
| Show DeleteSlotTypeVersionResponse Source # | |
Defined in Amazonka.LexModels.DeleteSlotTypeVersion Methods showsPrec :: Int -> DeleteSlotTypeVersionResponse -> ShowS # show :: DeleteSlotTypeVersionResponse -> String # showList :: [DeleteSlotTypeVersionResponse] -> ShowS # | |
| Generic DeleteSlotTypeVersionResponse Source # | |
Defined in Amazonka.LexModels.DeleteSlotTypeVersion Associated Types type Rep DeleteSlotTypeVersionResponse :: Type -> Type # | |
| NFData DeleteSlotTypeVersionResponse Source # | |
Defined in Amazonka.LexModels.DeleteSlotTypeVersion Methods rnf :: DeleteSlotTypeVersionResponse -> () # | |
| type Rep DeleteSlotTypeVersionResponse Source # | |
Defined in Amazonka.LexModels.DeleteSlotTypeVersion | |
newDeleteSlotTypeVersionResponse :: DeleteSlotTypeVersionResponse Source #
Create a value of DeleteSlotTypeVersionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteBotVersion
data DeleteBotVersion Source #
See: newDeleteBotVersion smart constructor.
Constructors
| DeleteBotVersion' Text Text |
Instances
Create a value of DeleteBotVersion 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:DeleteBotVersion', deleteBotVersion_name - The name of the bot.
$sel:version:DeleteBotVersion', deleteBotVersion_version - The version of the bot to delete. You cannot delete the $LATEST
version of the bot. To delete the $LATEST version, use the DeleteBot
operation.
data DeleteBotVersionResponse Source #
See: newDeleteBotVersionResponse smart constructor.
Constructors
| DeleteBotVersionResponse' | |
Instances
newDeleteBotVersionResponse :: DeleteBotVersionResponse Source #
Create a value of DeleteBotVersionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
GetSlotType
data GetSlotType Source #
See: newGetSlotType smart constructor.
Constructors
| GetSlotType' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> GetSlotType |
Create a value of GetSlotType 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:GetSlotType', getSlotType_name - The name of the slot type. The name is case sensitive.
$sel:version:GetSlotType', getSlotType_version - The version of the slot type.
data GetSlotTypeResponse Source #
See: newGetSlotTypeResponse smart constructor.
Constructors
| GetSlotTypeResponse' (Maybe Text) (Maybe [SlotTypeConfiguration]) (Maybe Text) (Maybe SlotValueSelectionStrategy) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe [EnumerationValue]) Int |
Instances
newGetSlotTypeResponse Source #
Arguments
| :: Int | |
| -> GetSlotTypeResponse |
Create a value of GetSlotTypeResponse 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:parentSlotTypeSignature:GetSlotTypeResponse', getSlotTypeResponse_parentSlotTypeSignature - The built-in slot type used as a parent for the slot type.
$sel:slotTypeConfigurations:GetSlotTypeResponse', getSlotTypeResponse_slotTypeConfigurations - Configuration information that extends the parent built-in slot type.
$sel:checksum:GetSlotTypeResponse', getSlotTypeResponse_checksum - Checksum of the $LATEST version of the slot type.
$sel:valueSelectionStrategy:GetSlotTypeResponse', getSlotTypeResponse_valueSelectionStrategy - The strategy that Amazon Lex uses to determine the value of the slot.
For more information, see PutSlotType.
$sel:createdDate:GetSlotTypeResponse', getSlotTypeResponse_createdDate - The date that the slot type was created.
$sel:name:GetSlotType', getSlotTypeResponse_name - The name of the slot type.
$sel:version:GetSlotType', getSlotTypeResponse_version - The version of the slot type.
$sel:lastUpdatedDate:GetSlotTypeResponse', getSlotTypeResponse_lastUpdatedDate - The date that the slot type was updated. When you create a resource, the
creation date and last update date are the same.
$sel:description:GetSlotTypeResponse', getSlotTypeResponse_description - A description of the slot type.
$sel:enumerationValues:GetSlotTypeResponse', getSlotTypeResponse_enumerationValues - A list of EnumerationValue objects that defines the values that the
slot type can take.
$sel:httpStatus:GetSlotTypeResponse', getSlotTypeResponse_httpStatus - The response's http status code.
GetExport
See: newGetExport smart constructor.
Constructors
| GetExport' Text Text ResourceType ExportType |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> ResourceType | |
| -> ExportType | |
| -> GetExport |
Create a value of GetExport 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:GetExport', getExport_name - The name of the bot to export.
$sel:version:GetExport', getExport_version - The version of the bot to export.
$sel:resourceType:GetExport', getExport_resourceType - The type of resource to export.
$sel:exportType:GetExport', getExport_exportType - The format of the exported data.
data GetExportResponse Source #
See: newGetExportResponse smart constructor.
Constructors
| GetExportResponse' (Maybe Text) (Maybe ResourceType) (Maybe ExportStatus) (Maybe Text) (Maybe ExportType) (Maybe Text) (Maybe Text) Int |
Instances
Arguments
| :: Int | |
| -> GetExportResponse |
Create a value of GetExportResponse 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:GetExportResponse', getExportResponse_failureReason - If status is FAILED, Amazon Lex provides the reason that it failed
to export the resource.
$sel:resourceType:GetExport', getExportResponse_resourceType - The type of the exported resource.
$sel:exportStatus:GetExportResponse', getExportResponse_exportStatus - The status of the export.
IN_PROGRESS- The export is in progress.READY- The export is complete.FAILED- The export could not be completed.
$sel:url:GetExportResponse', getExportResponse_url - An S3 pre-signed URL that provides the location of the exported
resource. The exported resource is a ZIP archive that contains the
exported resource in JSON format. The structure of the archive may
change. Your code should not rely on the archive structure.
$sel:exportType:GetExport', getExportResponse_exportType - The format of the exported data.
$sel:name:GetExport', getExportResponse_name - The name of the bot being exported.
$sel:version:GetExport', getExportResponse_version - The version of the bot being exported.
$sel:httpStatus:GetExportResponse', getExportResponse_httpStatus - The response's http status code.
GetMigration
data GetMigration Source #
See: newGetMigration smart constructor.
Constructors
| GetMigration' Text |
Instances
Arguments
| :: Text | |
| -> GetMigration |
Create a value of GetMigration 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:migrationId:GetMigration', getMigration_migrationId - The unique identifier of the migration to view. The migrationID is
returned by the operation.
data GetMigrationResponse Source #
See: newGetMigrationResponse smart constructor.
Constructors
| GetMigrationResponse' (Maybe Text) (Maybe MigrationStrategy) (Maybe POSIX) (Maybe [MigrationAlert]) (Maybe MigrationStatus) (Maybe Text) (Maybe Locale) (Maybe Text) (Maybe Text) (Maybe Text) Int |
Instances
newGetMigrationResponse Source #
Arguments
| :: Int | |
| -> GetMigrationResponse |
Create a value of GetMigrationResponse 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:GetMigrationResponse', getMigrationResponse_v1BotVersion - The version of the Amazon Lex V1 bot migrated to Amazon Lex V2.
$sel:migrationStrategy:GetMigrationResponse', getMigrationResponse_migrationStrategy - The strategy used to conduct the migration.
CREATE_NEW- Creates a new Amazon Lex V2 bot and migrates the Amazon Lex V1 bot to the new bot.UPDATE_EXISTING- Overwrites the existing Amazon Lex V2 bot metadata and the locale being migrated. It doesn't change any other locales in the Amazon Lex V2 bot. If the locale doesn't exist, a new locale is created in the Amazon Lex V2 bot.
$sel:migrationTimestamp:GetMigrationResponse', getMigrationResponse_migrationTimestamp - The date and time that the migration started.
$sel:alerts:GetMigrationResponse', getMigrationResponse_alerts - A list of alerts and warnings that indicate issues with the migration
for the Amazon Lex V1 bot to Amazon Lex V2. You receive a warning when
an Amazon Lex V1 feature has a different implementation if Amazon Lex
V2.
For more information, see Migrating a bot in the Amazon Lex V2 developer guide.
$sel:migrationStatus:GetMigrationResponse', getMigrationResponse_migrationStatus - Indicates the status of the migration. When the status is COMPLETE the
migration is finished and 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:GetMigrationResponse', getMigrationResponse_v2BotId - The unique identifier of the Amazon Lex V2 bot that the Amazon Lex V1 is
being migrated to.
$sel:v1BotLocale:GetMigrationResponse', getMigrationResponse_v1BotLocale - The locale of the Amazon Lex V1 bot migrated to Amazon Lex V2.
$sel:v1BotName:GetMigrationResponse', getMigrationResponse_v1BotName - The name of the Amazon Lex V1 bot migrated to Amazon Lex V2.
$sel:v2BotRole:GetMigrationResponse', getMigrationResponse_v2BotRole - The IAM role that Amazon Lex uses to run the Amazon Lex V2 bot.
$sel:migrationId:GetMigration', getMigrationResponse_migrationId - The unique identifier of the migration. This is the same as the
identifier used when calling the GetMigration operation.
$sel:httpStatus:GetMigrationResponse', getMigrationResponse_httpStatus - The response's http status code.
CreateIntentVersion
data CreateIntentVersion Source #
See: newCreateIntentVersion smart constructor.
Constructors
| CreateIntentVersion' (Maybe Text) Text |
Instances
newCreateIntentVersion Source #
Arguments
| :: Text | |
| -> CreateIntentVersion |
Create a value of CreateIntentVersion 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:CreateIntentVersion', createIntentVersion_checksum - Checksum of the $LATEST version of the intent that should be used to
create the new version. If you specify a checksum and the $LATEST
version of the intent has a different checksum, Amazon Lex returns a
PreconditionFailedException exception and doesn't publish a new
version. If you don't specify a checksum, Amazon Lex publishes the
$LATEST version.
$sel:name:CreateIntentVersion', createIntentVersion_name - The name of the intent that you want to create a new version of. The
name is case sensitive.
data CreateIntentVersionResponse Source #
See: newCreateIntentVersionResponse smart constructor.
Constructors
| CreateIntentVersionResponse' (Maybe FulfillmentActivity) (Maybe [Slot]) (Maybe Statement) (Maybe Text) (Maybe Statement) (Maybe [Text]) (Maybe Text) (Maybe POSIX) (Maybe KendraConfiguration) (Maybe Text) (Maybe Text) (Maybe [InputContext]) (Maybe FollowUpPrompt) (Maybe POSIX) (Maybe [OutputContext]) (Maybe Prompt) (Maybe CodeHook) (Maybe Text) Int |
Instances
newCreateIntentVersionResponse Source #
Create a value of CreateIntentVersionResponse 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:fulfillmentActivity:CreateIntentVersionResponse', createIntentVersionResponse_fulfillmentActivity - Describes how the intent is fulfilled.
$sel:slots:CreateIntentVersionResponse', createIntentVersionResponse_slots - An array of slot types that defines the information required to fulfill
the intent.
$sel:rejectionStatement:CreateIntentVersionResponse', createIntentVersionResponse_rejectionStatement - If the user answers "no" to the question defined in
confirmationPrompt, Amazon Lex responds with this statement to
acknowledge that the intent was canceled.
$sel:checksum:CreateIntentVersion', createIntentVersionResponse_checksum - Checksum of the intent version created.
$sel:conclusionStatement:CreateIntentVersionResponse', createIntentVersionResponse_conclusionStatement - After the Lambda function specified in the fulfillmentActivity field
fulfills the intent, Amazon Lex conveys this statement to the user.
$sel:sampleUtterances:CreateIntentVersionResponse', createIntentVersionResponse_sampleUtterances - An array of sample utterances configured for the intent.
$sel:parentIntentSignature:CreateIntentVersionResponse', createIntentVersionResponse_parentIntentSignature - A unique identifier for a built-in intent.
$sel:createdDate:CreateIntentVersionResponse', createIntentVersionResponse_createdDate - The date that the intent was created.
$sel:kendraConfiguration:CreateIntentVersionResponse', createIntentVersionResponse_kendraConfiguration - Configuration information, if any, for connecting an Amazon Kendra index
with the AMAZON.KendraSearchIntent intent.
$sel:name:CreateIntentVersion', createIntentVersionResponse_name - The name of the intent.
$sel:version:CreateIntentVersionResponse', createIntentVersionResponse_version - The version number assigned to the new version of the intent.
$sel:inputContexts:CreateIntentVersionResponse', createIntentVersionResponse_inputContexts - An array of InputContext objects that lists the contexts that must be
active for Amazon Lex to choose the intent in a conversation with the
user.
$sel:followUpPrompt:CreateIntentVersionResponse', createIntentVersionResponse_followUpPrompt - If defined, Amazon Lex uses this prompt to solicit additional user
activity after the intent is fulfilled.
$sel:lastUpdatedDate:CreateIntentVersionResponse', createIntentVersionResponse_lastUpdatedDate - The date that the intent was updated.
$sel:outputContexts:CreateIntentVersionResponse', createIntentVersionResponse_outputContexts - An array of OutputContext objects that lists the contexts that the
intent activates when the intent is fulfilled.
$sel:confirmationPrompt:CreateIntentVersionResponse', createIntentVersionResponse_confirmationPrompt - If defined, the prompt that Amazon Lex uses to confirm the user's
intent before fulfilling it.
$sel:dialogCodeHook:CreateIntentVersionResponse', createIntentVersionResponse_dialogCodeHook - If defined, Amazon Lex invokes this Lambda function for each user input.
$sel:description:CreateIntentVersionResponse', createIntentVersionResponse_description - A description of the intent.
$sel:httpStatus:CreateIntentVersionResponse', createIntentVersionResponse_httpStatus - The response's http status code.
DeleteSlotType
data DeleteSlotType Source #
See: newDeleteSlotType smart constructor.
Constructors
| DeleteSlotType' Text |
Instances
Arguments
| :: Text | |
| -> DeleteSlotType |
Create a value of DeleteSlotType 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:DeleteSlotType', deleteSlotType_name - The name of the slot type. The name is case sensitive.
data DeleteSlotTypeResponse Source #
See: newDeleteSlotTypeResponse smart constructor.
Constructors
| DeleteSlotTypeResponse' | |
Instances
| Eq DeleteSlotTypeResponse Source # | |
Defined in Amazonka.LexModels.DeleteSlotType Methods (==) :: DeleteSlotTypeResponse -> DeleteSlotTypeResponse -> Bool # (/=) :: DeleteSlotTypeResponse -> DeleteSlotTypeResponse -> Bool # | |
| Read DeleteSlotTypeResponse Source # | |
Defined in Amazonka.LexModels.DeleteSlotType | |
| Show DeleteSlotTypeResponse Source # | |
Defined in Amazonka.LexModels.DeleteSlotType Methods showsPrec :: Int -> DeleteSlotTypeResponse -> ShowS # show :: DeleteSlotTypeResponse -> String # showList :: [DeleteSlotTypeResponse] -> ShowS # | |
| Generic DeleteSlotTypeResponse Source # | |
Defined in Amazonka.LexModels.DeleteSlotType Associated Types type Rep DeleteSlotTypeResponse :: Type -> Type # Methods from :: DeleteSlotTypeResponse -> Rep DeleteSlotTypeResponse x # to :: Rep DeleteSlotTypeResponse x -> DeleteSlotTypeResponse # | |
| NFData DeleteSlotTypeResponse Source # | |
Defined in Amazonka.LexModels.DeleteSlotType Methods rnf :: DeleteSlotTypeResponse -> () # | |
| type Rep DeleteSlotTypeResponse Source # | |
newDeleteSlotTypeResponse :: DeleteSlotTypeResponse Source #
Create a value of DeleteSlotTypeResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
StartImport
data StartImport Source #
See: newStartImport smart constructor.
Constructors
| StartImport' (Maybe [Tag]) Base64 ResourceType MergeStrategy |
Instances
Arguments
| :: ByteString | |
| -> ResourceType | |
| -> MergeStrategy | |
| -> StartImport |
Create a value of StartImport 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:tags:StartImport', startImport_tags - A list of tags to add to the imported bot. You can only add tags when
you import a bot, you can't add tags to an intent or slot type.
$sel:payload:StartImport', startImport_payload - A zip archive in binary format. The archive should contain one file, a
JSON file containing the resource to import. The resource should match
the type specified in the resourceType field.--
-- Note: This Lens automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens accepts and returns only raw unencoded data.
$sel:resourceType:StartImport', startImport_resourceType - Specifies the type of resource to export. Each resource also exports any
resources that it depends on.
- A bot exports dependent intents.
- An intent exports dependent slot types.
$sel:mergeStrategy:StartImport', startImport_mergeStrategy - Specifies the action that the StartImport operation should take when
there is an existing resource with the same name.
FAIL_ON_CONFLICT - The import operation is stopped on the first conflict between a resource in the import file and an existing resource. The name of the resource causing the conflict is in the
failureReasonfield of the response to theGetImportoperation.OVERWRITE_LATEST - The import operation proceeds even if there is a conflict with an existing resource. The $LASTEST version of the existing resource is overwritten with the data from the import file.
data StartImportResponse Source #
See: newStartImportResponse smart constructor.
Constructors
| StartImportResponse' (Maybe ResourceType) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe MergeStrategy) (Maybe ImportStatus) (Maybe [Tag]) Int |
Instances
newStartImportResponse Source #
Arguments
| :: Int | |
| -> StartImportResponse |
Create a value of StartImportResponse 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:resourceType:StartImport', startImportResponse_resourceType - The type of resource to import.
$sel:importId:StartImportResponse', startImportResponse_importId - The identifier for the specific import job.
$sel:createdDate:StartImportResponse', startImportResponse_createdDate - A timestamp for the date and time that the import job was requested.
$sel:name:StartImportResponse', startImportResponse_name - The name given to the import job.
$sel:mergeStrategy:StartImport', startImportResponse_mergeStrategy - The action to take when there is a merge conflict.
$sel:importStatus:StartImportResponse', startImportResponse_importStatus - The status of the import job. If the status is FAILED, you can get the
reason for the failure using the GetImport operation.
$sel:tags:StartImport', startImportResponse_tags - A list of tags added to the imported bot.
$sel:httpStatus:StartImportResponse', startImportResponse_httpStatus - The response's http status code.
GetBotChannelAssociation
data GetBotChannelAssociation Source #
See: newGetBotChannelAssociation smart constructor.
Constructors
| GetBotChannelAssociation' Text Text Text |
Instances
newGetBotChannelAssociation Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> GetBotChannelAssociation |
Create a value of GetBotChannelAssociation 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:GetBotChannelAssociation', getBotChannelAssociation_name - The name of the association between the bot and the channel. The name is
case sensitive.
$sel:botName:GetBotChannelAssociation', getBotChannelAssociation_botName - The name of the Amazon Lex bot.
$sel:botAlias:GetBotChannelAssociation', getBotChannelAssociation_botAlias - An alias pointing to the specific version of the Amazon Lex bot to which
this association is being made.
data GetBotChannelAssociationResponse Source #
See: newGetBotChannelAssociationResponse smart constructor.
Constructors
| GetBotChannelAssociationResponse' (Maybe Text) (Maybe ChannelStatus) (Maybe Text) (Maybe Text) (Maybe (Sensitive (HashMap Text Text))) (Maybe POSIX) (Maybe Text) (Maybe ChannelType) (Maybe Text) Int |
Instances
newGetBotChannelAssociationResponse Source #
Create a value of GetBotChannelAssociationResponse 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:GetBotChannelAssociationResponse', getBotChannelAssociationResponse_failureReason - If status is FAILED, Amazon Lex provides the reason that it failed
to create the association.
$sel:status:GetBotChannelAssociationResponse', getBotChannelAssociationResponse_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:GetBotChannelAssociation', getBotChannelAssociationResponse_botAlias - An alias pointing to the specific version of the Amazon Lex bot to which
this association is being made.
$sel:botName:GetBotChannelAssociation', getBotChannelAssociationResponse_botName - The name of the Amazon Lex bot.
$sel:botConfiguration:GetBotChannelAssociationResponse', getBotChannelAssociationResponse_botConfiguration - Provides information that the messaging platform needs to communicate
with the Amazon Lex bot.
$sel:createdDate:GetBotChannelAssociationResponse', getBotChannelAssociationResponse_createdDate - The date that the association between the bot and the channel was
created.
$sel:name:GetBotChannelAssociation', getBotChannelAssociationResponse_name - The name of the association between the bot and the channel.
$sel:type':GetBotChannelAssociationResponse', getBotChannelAssociationResponse_type - The type of the messaging platform.
$sel:description:GetBotChannelAssociationResponse', getBotChannelAssociationResponse_description - A description of the association between the bot and the channel.
$sel:httpStatus:GetBotChannelAssociationResponse', getBotChannelAssociationResponse_httpStatus - The response's http status code.
PutSlotType
data PutSlotType Source #
See: newPutSlotType smart constructor.
Constructors
| PutSlotType' (Maybe Text) (Maybe [SlotTypeConfiguration]) (Maybe Text) (Maybe SlotValueSelectionStrategy) (Maybe Bool) (Maybe Text) (Maybe [EnumerationValue]) Text |
Instances
Arguments
| :: Text | |
| -> PutSlotType |
Create a value of PutSlotType 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:parentSlotTypeSignature:PutSlotType', putSlotType_parentSlotTypeSignature - The built-in slot type used as the parent of the slot type. When you
define a parent slot type, the new slot type has all of the same
configuration as the parent.
Only AMAZON.AlphaNumeric is supported.
$sel:slotTypeConfigurations:PutSlotType', putSlotType_slotTypeConfigurations - Configuration information that extends the parent built-in slot type.
The configuration is added to the settings for the parent slot type.
$sel:checksum:PutSlotType', putSlotType_checksum - Identifies a specific revision of the $LATEST version.
When you create a new slot type, leave the checksum field blank. If
you specify a checksum you get a BadRequestException exception.
When you want to update a slot type, set the checksum field to the
checksum of the most recent revision of the $LATEST version. If you
don't specify the checksum field, or if the checksum does not match
the $LATEST version, you get a PreconditionFailedException
exception.
$sel:valueSelectionStrategy:PutSlotType', putSlotType_valueSelectionStrategy - Determines the slot resolution strategy that Amazon Lex uses to return
slot type values. The field can be set to one of the following values:
ORIGINAL_VALUE- Returns the value entered by the user, if the user value is similar to the slot value.TOP_RESOLUTION- If there is a resolution list for the slot, return the first value in the resolution list as the slot type value. If there is no resolution list, null is returned.
If you don't specify the valueSelectionStrategy, the default is
ORIGINAL_VALUE.
$sel:createVersion:PutSlotType', putSlotType_createVersion - When set to true a new numbered version of the slot type is created.
This is the same as calling the CreateSlotTypeVersion operation. If
you do not specify createVersion, the default is false.
$sel:description:PutSlotType', putSlotType_description - A description of the slot type.
$sel:enumerationValues:PutSlotType', putSlotType_enumerationValues - A list of EnumerationValue objects that defines the values that the
slot type can take. Each value can have a list of synonyms, which are
additional values that help train the machine learning model about the
values that it resolves for a slot.
A regular expression slot type doesn't require enumeration values. All other slot types require a list of enumeration values.
When Amazon Lex resolves a slot value, it generates a resolution list
that contains up to five possible values for the slot. If you are using
a Lambda function, this resolution list is passed to the function. If
you are not using a Lambda function you can choose to return the value
that the user entered or the first value in the resolution list as the
slot value. The valueSelectionStrategy field indicates the option to
use.
$sel:name:PutSlotType', putSlotType_name - The name of the slot type. The name is not case sensitive.
The name can't match a built-in slot type name, or a built-in slot type
name with "AMAZON." removed. For example, because there is a built-in
slot type called AMAZON.DATE, you can't create a custom slot type
called DATE.
For a list of built-in slot types, see Slot Type Reference in the Alexa Skills Kit.
data PutSlotTypeResponse Source #
See: newPutSlotTypeResponse smart constructor.
Constructors
| PutSlotTypeResponse' (Maybe Text) (Maybe [SlotTypeConfiguration]) (Maybe Text) (Maybe SlotValueSelectionStrategy) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Bool) (Maybe Text) (Maybe [EnumerationValue]) Int |
Instances
newPutSlotTypeResponse Source #
Arguments
| :: Int | |
| -> PutSlotTypeResponse |
Create a value of PutSlotTypeResponse 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:parentSlotTypeSignature:PutSlotType', putSlotTypeResponse_parentSlotTypeSignature - The built-in slot type used as the parent of the slot type.
$sel:slotTypeConfigurations:PutSlotType', putSlotTypeResponse_slotTypeConfigurations - Configuration information that extends the parent built-in slot type.
$sel:checksum:PutSlotType', putSlotTypeResponse_checksum - Checksum of the $LATEST version of the slot type.
$sel:valueSelectionStrategy:PutSlotType', putSlotTypeResponse_valueSelectionStrategy - The slot resolution strategy that Amazon Lex uses to determine the value
of the slot. For more information, see PutSlotType.
$sel:createdDate:PutSlotTypeResponse', putSlotTypeResponse_createdDate - The date that the slot type was created.
$sel:name:PutSlotType', putSlotTypeResponse_name - The name of the slot type.
$sel:version:PutSlotTypeResponse', putSlotTypeResponse_version - The version of the slot type. For a new slot type, the version is always
$LATEST.
$sel:lastUpdatedDate:PutSlotTypeResponse', putSlotTypeResponse_lastUpdatedDate - The date that the slot type was updated. When you create a slot type,
the creation date and last update date are the same.
$sel:createVersion:PutSlotType', putSlotTypeResponse_createVersion - True if a new version of the slot type was created. If the
createVersion field was not specified in the request, the
createVersion field is set to false in the response.
$sel:description:PutSlotType', putSlotTypeResponse_description - A description of the slot type.
$sel:enumerationValues:PutSlotType', putSlotTypeResponse_enumerationValues - A list of EnumerationValue objects that defines the values that the
slot type can take.
$sel:httpStatus:PutSlotTypeResponse', putSlotTypeResponse_httpStatus - The response's http status code.
GetBuiltinSlotTypes (Paginated)
data GetBuiltinSlotTypes Source #
See: newGetBuiltinSlotTypes smart constructor.
Instances
newGetBuiltinSlotTypes :: GetBuiltinSlotTypes Source #
Create a value of GetBuiltinSlotTypes 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:locale:GetBuiltinSlotTypes', getBuiltinSlotTypes_locale - A list of locales that the slot type supports.
$sel:nextToken:GetBuiltinSlotTypes', getBuiltinSlotTypes_nextToken - A pagination token that fetches the next page of slot types. If the
response to this API call is truncated, Amazon Lex returns a pagination
token in the response. To fetch the next page of slot types, specify the
pagination token in the next request.
$sel:signatureContains:GetBuiltinSlotTypes', getBuiltinSlotTypes_signatureContains - Substring to match in built-in slot type signatures. A slot type will be
returned if any part of its signature matches the substring. For
example, "xyz" matches both "xyzabc" and "abcxyz."
$sel:maxResults:GetBuiltinSlotTypes', getBuiltinSlotTypes_maxResults - The maximum number of slot types to return in the response. The default
is 10.
data GetBuiltinSlotTypesResponse Source #
See: newGetBuiltinSlotTypesResponse smart constructor.
Constructors
| GetBuiltinSlotTypesResponse' (Maybe Text) (Maybe [BuiltinSlotTypeMetadata]) Int |
Instances
newGetBuiltinSlotTypesResponse Source #
Create a value of GetBuiltinSlotTypesResponse 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:nextToken:GetBuiltinSlotTypes', getBuiltinSlotTypesResponse_nextToken - If the response is truncated, the response includes a pagination token
that you can use in your next request to fetch the next page of slot
types.
$sel:slotTypes:GetBuiltinSlotTypesResponse', getBuiltinSlotTypesResponse_slotTypes - An array of BuiltInSlotTypeMetadata objects, one entry for each slot
type returned.
$sel:httpStatus:GetBuiltinSlotTypesResponse', getBuiltinSlotTypesResponse_httpStatus - The response's http status code.
TagResource
data TagResource Source #
See: newTagResource smart constructor.
Constructors
| TagResource' Text [Tag] |
Instances
Arguments
| :: Text | |
| -> TagResource |
Create a value of TagResource 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:resourceArn:TagResource', tagResource_resourceArn - The Amazon Resource Name (ARN) of the bot, bot alias, or bot channel to
tag.
$sel:tags:TagResource', tagResource_tags - A list of tag keys to add to the resource. If a tag key already exists,
the existing value is replaced with the new value.
data TagResourceResponse Source #
See: newTagResourceResponse smart constructor.
Constructors
| TagResourceResponse' Int |
Instances
newTagResourceResponse Source #
Arguments
| :: Int | |
| -> TagResourceResponse |
Create a value of TagResourceResponse 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:httpStatus:TagResourceResponse', tagResourceResponse_httpStatus - The response's http status code.
GetUtterancesView
data GetUtterancesView Source #
See: newGetUtterancesView smart constructor.
Constructors
| GetUtterancesView' Text (NonEmpty Text) StatusType |
Instances
Arguments
| :: Text | |
| -> NonEmpty Text | |
| -> StatusType | |
| -> GetUtterancesView |
Create a value of GetUtterancesView 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:botName:GetUtterancesView', getUtterancesView_botName - The name of the bot for which utterance information should be returned.
$sel:botVersions:GetUtterancesView', getUtterancesView_botVersions - An array of bot versions for which utterance information should be
returned. The limit is 5 versions per request.
$sel:statusType:GetUtterancesView', getUtterancesView_statusType - To return utterances that were recognized and handled, use Detected.
To return utterances that were not recognized, use Missed.
data GetUtterancesViewResponse Source #
See: newGetUtterancesViewResponse smart constructor.
Constructors
| GetUtterancesViewResponse' (Maybe Text) (Maybe [UtteranceList]) Int |
Instances
newGetUtterancesViewResponse Source #
Create a value of GetUtterancesViewResponse 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:botName:GetUtterancesView', getUtterancesViewResponse_botName - The name of the bot for which utterance information was returned.
$sel:utterances:GetUtterancesViewResponse', getUtterancesViewResponse_utterances - An array of UtteranceList objects, each containing a list of
UtteranceData objects describing the utterances that were processed by
your bot. The response contains a maximum of 100 UtteranceData objects
for each version. Amazon Lex returns the most frequent utterances
received by the bot in the last 15 days.
$sel:httpStatus:GetUtterancesViewResponse', getUtterancesViewResponse_httpStatus - The response's http status code.
GetSlotTypeVersions (Paginated)
data GetSlotTypeVersions Source #
See: newGetSlotTypeVersions smart constructor.
Instances
newGetSlotTypeVersions Source #
Arguments
| :: Text | |
| -> GetSlotTypeVersions |
Create a value of GetSlotTypeVersions 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:nextToken:GetSlotTypeVersions', getSlotTypeVersions_nextToken - A pagination token for fetching the next page of slot type versions. If
the response to this call is truncated, Amazon Lex returns a pagination
token in the response. To fetch the next page of versions, specify the
pagination token in the next request.
$sel:maxResults:GetSlotTypeVersions', getSlotTypeVersions_maxResults - The maximum number of slot type versions to return in the response. The
default is 10.
$sel:name:GetSlotTypeVersions', getSlotTypeVersions_name - The name of the slot type for which versions should be returned.
data GetSlotTypeVersionsResponse Source #
See: newGetSlotTypeVersionsResponse smart constructor.
Constructors
| GetSlotTypeVersionsResponse' (Maybe Text) (Maybe [SlotTypeMetadata]) Int |
Instances
newGetSlotTypeVersionsResponse Source #
Create a value of GetSlotTypeVersionsResponse 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:nextToken:GetSlotTypeVersions', getSlotTypeVersionsResponse_nextToken - A pagination token for fetching the next page of slot type versions. If
the response to this call is truncated, Amazon Lex returns a pagination
token in the response. To fetch the next page of versions, specify the
pagination token in the next request.
$sel:slotTypes:GetSlotTypeVersionsResponse', getSlotTypeVersionsResponse_slotTypes - An array of SlotTypeMetadata objects, one for each numbered version of
the slot type plus one for the $LATEST version.
$sel:httpStatus:GetSlotTypeVersionsResponse', getSlotTypeVersionsResponse_httpStatus - The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text [Text] |
Instances
Arguments
| :: Text | |
| -> UntagResource |
Create a value of UntagResource 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:resourceArn:UntagResource', untagResource_resourceArn - The Amazon Resource Name (ARN) of the resource to remove the tags from.
$sel:tagKeys:UntagResource', untagResource_tagKeys - A list of tag keys to remove from the resource. If a tag key does not
exist on the resource, it is ignored.
data UntagResourceResponse Source #
See: newUntagResourceResponse smart constructor.
Constructors
| UntagResourceResponse' Int |
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse 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:httpStatus:UntagResourceResponse', untagResourceResponse_httpStatus - The response's http status code.
GetIntents (Paginated)
data GetIntents Source #
See: newGetIntents smart constructor.
Instances
newGetIntents :: GetIntents Source #
Create a value of GetIntents 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:nameContains:GetIntents', getIntents_nameContains - Substring to match in intent names. An intent will be returned if any
part of its name matches the substring. For example, "xyz" matches
both "xyzabc" and "abcxyz."
$sel:nextToken:GetIntents', getIntents_nextToken - A pagination token that fetches the next page of intents. If the
response to this API call is truncated, Amazon Lex returns a pagination
token in the response. To fetch the next page of intents, specify the
pagination token in the next request.
$sel:maxResults:GetIntents', getIntents_maxResults - The maximum number of intents to return in the response. The default is
10.
data GetIntentsResponse Source #
See: newGetIntentsResponse smart constructor.
Constructors
| GetIntentsResponse' (Maybe [IntentMetadata]) (Maybe Text) Int |
Instances
newGetIntentsResponse Source #
Arguments
| :: Int | |
| -> GetIntentsResponse |
Create a value of GetIntentsResponse 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:intents:GetIntentsResponse', getIntentsResponse_intents - An array of Intent objects. For more information, see PutBot.
$sel:nextToken:GetIntents', getIntentsResponse_nextToken - If the response is truncated, the response includes a pagination token
that you can specify in your next request to fetch the next page of
intents.
$sel:httpStatus:GetIntentsResponse', getIntentsResponse_httpStatus - The response's http status code.
GetBotAlias
data GetBotAlias Source #
See: newGetBotAlias smart constructor.
Constructors
| GetBotAlias' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> GetBotAlias |
Create a value of GetBotAlias 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:GetBotAlias', getBotAlias_name - The name of the bot alias. The name is case sensitive.
$sel:botName:GetBotAlias', getBotAlias_botName - The name of the bot.
data GetBotAliasResponse Source #
See: newGetBotAliasResponse smart constructor.
Constructors
| GetBotAliasResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe ConversationLogsResponse) (Maybe POSIX) (Maybe Text) Int |
Instances
newGetBotAliasResponse Source #
Arguments
| :: Int | |
| -> GetBotAliasResponse |
Create a value of GetBotAliasResponse 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:GetBotAliasResponse', getBotAliasResponse_checksum - Checksum of the bot alias.
$sel:botVersion:GetBotAliasResponse', getBotAliasResponse_botVersion - The version of the bot that the alias points to.
$sel:botName:GetBotAlias', getBotAliasResponse_botName - The name of the bot that the alias points to.
$sel:createdDate:GetBotAliasResponse', getBotAliasResponse_createdDate - The date that the bot alias was created.
$sel:name:GetBotAlias', getBotAliasResponse_name - The name of the bot alias.
$sel:conversationLogs:GetBotAliasResponse', getBotAliasResponse_conversationLogs - The settings that determine how Amazon Lex uses conversation logs for
the alias.
$sel:lastUpdatedDate:GetBotAliasResponse', getBotAliasResponse_lastUpdatedDate - The date that the bot alias was updated. When you create a resource, the
creation date and the last updated date are the same.
$sel:description:GetBotAliasResponse', getBotAliasResponse_description - A description of the bot alias.
$sel:httpStatus:GetBotAliasResponse', getBotAliasResponse_httpStatus - The response's http status code.
Types
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' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe ConversationLogsResponse) (Maybe POSIX) (Maybe Text) |
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.
BotChannelAssociation
data BotChannelAssociation Source #
Represents an association between an Amazon Lex bot and an external messaging platform.
See: newBotChannelAssociation smart constructor.
Constructors
| BotChannelAssociation' (Maybe Text) (Maybe ChannelStatus) (Maybe Text) (Maybe Text) (Maybe (Sensitive (HashMap Text Text))) (Maybe POSIX) (Maybe Text) (Maybe ChannelType) (Maybe Text) |
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.
BotMetadata
data BotMetadata Source #
Provides information about a bot. .
See: newBotMetadata smart constructor.
Constructors
| BotMetadata' (Maybe LexStatus) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) |
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.
BuiltinIntentMetadata
data BuiltinIntentMetadata Source #
Provides metadata for a built-in intent.
See: newBuiltinIntentMetadata smart constructor.
Constructors
| BuiltinIntentMetadata' (Maybe Text) (Maybe [Locale]) |
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.
BuiltinIntentSlot
data BuiltinIntentSlot Source #
Provides information about a slot used in a built-in intent.
See: newBuiltinIntentSlot smart constructor.
Constructors
| BuiltinIntentSlot' (Maybe Text) |
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.
BuiltinSlotTypeMetadata
data BuiltinSlotTypeMetadata Source #
Provides information about a built in slot type.
See: newBuiltinSlotTypeMetadata smart constructor.
Constructors
| BuiltinSlotTypeMetadata' (Maybe Text) (Maybe [Locale]) |
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.
CodeHook
Specifies a Lambda function that verifies requests to a bot or fulfills the user's request to a bot..
See: newCodeHook smart constructor.
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.
ConversationLogsRequest
data ConversationLogsRequest Source #
Provides the settings needed for conversation logs.
See: newConversationLogsRequest smart constructor.
Constructors
| ConversationLogsRequest' [LogSettingsRequest] Text |
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.
ConversationLogsResponse
data ConversationLogsResponse Source #
Contains information about conversation log settings.
See: newConversationLogsResponse smart constructor.
Constructors
| ConversationLogsResponse' (Maybe Text) (Maybe [LogSettingsResponse]) |
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.
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' (Maybe [Text]) Text |
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.
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' Prompt Statement |
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.
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' (Maybe CodeHook) FulfillmentActivityType |
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.
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' Text |
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.
Intent
Identifies the specific version of an intent.
See: newIntent smart constructor.
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.
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.
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' (Maybe Text) Text Text |
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.
LogSettingsRequest
data LogSettingsRequest Source #
Settings used to configure delivery mode and destination for conversation logs.
See: newLogSettingsRequest smart constructor.
Constructors
| LogSettingsRequest' (Maybe Text) LogType Destination Text |
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.
LogSettingsResponse
data LogSettingsResponse Source #
The settings for conversation logs.
See: newLogSettingsResponse smart constructor.
Constructors
| LogSettingsResponse' (Maybe Destination) (Maybe Text) (Maybe LogType) (Maybe Text) (Maybe Text) |
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.
Message
The message object that provides the message text and its type.
See: newMessage smart constructor.
Constructors
| Message' (Maybe Natural) ContentType Text |
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.
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' (Maybe [Text]) (Maybe [Text]) (Maybe MigrationAlertType) (Maybe Text) |
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.
MigrationSummary
data MigrationSummary Source #
Provides information about migrating a bot from Amazon Lex V1 to Amazon Lex V2.
See: newMigrationSummary smart constructor.
Constructors
| MigrationSummary' (Maybe Text) (Maybe MigrationStrategy) (Maybe POSIX) (Maybe MigrationStatus) (Maybe Text) (Maybe Locale) (Maybe Text) (Maybe Text) (Maybe Text) |
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.
OutputContext
data OutputContext Source #
The specification of an output context that is set when an intent is fulfilled.
See: newOutputContext smart constructor.
Constructors
| OutputContext' Text Natural Natural |
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.
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.
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.
Slot
Identifies the version of a specific slot.
See: newSlot smart constructor.
Constructors
| Slot' (Maybe Text) (Maybe Prompt) (Maybe Text) (Maybe Natural) (Maybe ObfuscationSetting) (Maybe SlotDefaultValueSpec) (Maybe Text) (Maybe [Text]) (Maybe Text) Text SlotConstraint |
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.
SlotDefaultValue
data SlotDefaultValue Source #
A default value for a slot.
See: newSlotDefaultValue smart constructor.
Constructors
| SlotDefaultValue' Text |
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."
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' [SlotDefaultValue] |
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.
SlotTypeConfiguration
data SlotTypeConfiguration Source #
Provides configuration information for a slot type.
See: newSlotTypeConfiguration smart constructor.
Constructors
| SlotTypeConfiguration' (Maybe SlotTypeRegexConfiguration) |
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.
SlotTypeMetadata
data SlotTypeMetadata Source #
Provides information about a slot type..
See: newSlotTypeMetadata smart constructor.
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.
SlotTypeRegexConfiguration
data SlotTypeRegexConfiguration Source #
Provides a regular expression used to validate the value of a slot.
See: newSlotTypeRegexConfiguration smart constructor.
Constructors
| SlotTypeRegexConfiguration' Text |
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 (.)
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' (Maybe Text) (NonEmpty Message) |
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.
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.
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.
UtteranceData
data UtteranceData Source #
Provides information about a single utterance that was made to your bot.
See: newUtteranceData smart constructor.
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.
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' (Maybe Text) (Maybe [UtteranceData]) |
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.