diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ ## Version -`1.5.0` +`1.6.0` ## Description diff --git a/amazonka-lex-runtime.cabal b/amazonka-lex-runtime.cabal --- a/amazonka-lex-runtime.cabal +++ b/amazonka-lex-runtime.cabal @@ -1,5 +1,5 @@ name: amazonka-lex-runtime -version: 1.5.0 +version: 1.6.0 synopsis: Amazon Lex Runtime Service SDK. homepage: https://github.com/brendanhay/amazonka bug-reports: https://github.com/brendanhay/amazonka/issues @@ -7,7 +7,7 @@ license-file: LICENSE author: Brendan Hay maintainer: Brendan Hay -copyright: Copyright (c) 2013-2017 Brendan Hay +copyright: Copyright (c) 2013-2018 Brendan Hay category: Network, AWS, Cloud, Distributed Computing build-type: Simple cabal-version: >= 1.10 @@ -55,7 +55,7 @@ , Network.AWS.LexRuntime.Types.Sum build-depends: - amazonka-core == 1.5.0.* + amazonka-core == 1.6.0.* , base >= 4.7 && < 5 test-suite amazonka-lex-runtime-test @@ -75,8 +75,8 @@ , Test.AWS.LexRuntime.Internal build-depends: - amazonka-core == 1.5.0.* - , amazonka-test == 1.5.0.* + amazonka-core == 1.6.0.* + , amazonka-test == 1.6.0.* , amazonka-lex-runtime , base , bytestring diff --git a/gen/Network/AWS/LexRuntime.hs b/gen/Network/AWS/LexRuntime.hs --- a/gen/Network/AWS/LexRuntime.hs +++ b/gen/Network/AWS/LexRuntime.hs @@ -5,7 +5,7 @@ -- | -- Module : Network.AWS.LexRuntime --- Copyright : (c) 2013-2017 Brendan Hay +-- Copyright : (c) 2013-2018 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated @@ -74,6 +74,9 @@ -- ** DialogState , DialogState (..) + + -- ** MessageFormatType + , MessageFormatType (..) -- ** Button , Button diff --git a/gen/Network/AWS/LexRuntime/PostContent.hs b/gen/Network/AWS/LexRuntime/PostContent.hs --- a/gen/Network/AWS/LexRuntime/PostContent.hs +++ b/gen/Network/AWS/LexRuntime/PostContent.hs @@ -12,7 +12,7 @@ -- | -- Module : Network.AWS.LexRuntime.PostContent --- Copyright : (c) 2013-2017 Brendan Hay +-- Copyright : (c) 2013-2018 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated @@ -78,6 +78,7 @@ , pcrsIntentName , pcrsDialogState , pcrsInputTranscript + , pcrsMessageFormat , pcrsMessage , pcrsSlotToElicit , pcrsContentType @@ -134,48 +135,48 @@ -> PostContent postContent pBotName_ pBotAlias_ pUserId_ pContentType_ pInputStream_ = PostContent' - { _pcAccept = Nothing - , _pcRequestAttributes = Nothing - , _pcSessionAttributes = Nothing - , _pcBotName = pBotName_ - , _pcBotAlias = pBotAlias_ - , _pcUserId = pUserId_ - , _pcContentType = pContentType_ - , _pcInputStream = pInputStream_ - } + { _pcAccept = Nothing + , _pcRequestAttributes = Nothing + , _pcSessionAttributes = Nothing + , _pcBotName = pBotName_ + , _pcBotAlias = pBotAlias_ + , _pcUserId = pUserId_ + , _pcContentType = pContentType_ + , _pcInputStream = pInputStream_ + } -- | You pass this value as the @Accept@ HTTP header. The message Amazon Lex returns in the response can be either text or speech based on the @Accept@ HTTP header value in the request. * If the value is @text/plain; charset=utf-8@ , Amazon Lex returns text in the response. * If the value begins with @audio/@ , Amazon Lex returns speech in the response. Amazon Lex uses Amazon Polly to generate the speech (using the configuration you specified in the @Accept@ header). For example, if you specify @audio/mpeg@ as the value, Amazon Lex returns speech in the MPEG format. The following are the accepted values: * audio/mpeg * audio/ogg * audio/pcm * text/plain; charset=utf-8 * audio/* (defaults to mpeg) pcAccept :: Lens' PostContent (Maybe Text) -pcAccept = lens _pcAccept (\ s a -> s{_pcAccept = a}); +pcAccept = lens _pcAccept (\ s a -> s{_pcAccept = a}) -- | You pass this value as the @x-amz-lex-request-attributes@ HTTP header. Request-specific information passed between Amazon Lex and a client application. The value must be a JSON serialized and base64 encoded map with string keys and values. The total size of the @requestAttributes@ and @sessionAttributes@ headers is limited to 12 KB. The namespace @x-amz-lex:@ is reserved for special attributes. Don't create any request attributes with the prefix @x-amz-lex:@ . For more information, see . pcRequestAttributes :: Lens' PostContent (Maybe Text) -pcRequestAttributes = lens _pcRequestAttributes (\ s a -> s{_pcRequestAttributes = a}) . mapping _Sensitive; +pcRequestAttributes = lens _pcRequestAttributes (\ s a -> s{_pcRequestAttributes = a}) . mapping _Sensitive -- | You pass this value as the @x-amz-lex-session-attributes@ HTTP header. Application-specific information passed between Amazon Lex and a client application. The value must be a JSON serialized and base64 encoded map with string keys and values. The total size of the @sessionAttributes@ and @requestAttributes@ headers is limited to 12 KB. For more information, see . pcSessionAttributes :: Lens' PostContent (Maybe Text) -pcSessionAttributes = lens _pcSessionAttributes (\ s a -> s{_pcSessionAttributes = a}) . mapping _Sensitive; +pcSessionAttributes = lens _pcSessionAttributes (\ s a -> s{_pcSessionAttributes = a}) . mapping _Sensitive -- | Name of the Amazon Lex bot. pcBotName :: Lens' PostContent Text -pcBotName = lens _pcBotName (\ s a -> s{_pcBotName = a}); +pcBotName = lens _pcBotName (\ s a -> s{_pcBotName = a}) -- | Alias of the Amazon Lex bot. pcBotAlias :: Lens' PostContent Text -pcBotAlias = lens _pcBotAlias (\ s a -> s{_pcBotAlias = a}); +pcBotAlias = lens _pcBotAlias (\ s a -> s{_pcBotAlias = a}) -- | The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot. At runtime, each request must contain the @userID@ field. To decide the user ID to use for your application, consider the following factors. * The @userID@ field must not contain any personally identifiable information of the user, for example, name, personal identification numbers, or other end user personal information. * If you want a user to start a conversation on one device and continue on another device, use a user-specific identifier. * If you want the same user to be able to have two independent conversations on two different devices, choose a device-specific identifier. * A user can't have two independent conversations with two different versions of the same bot. For example, a user can't have a conversation with the PROD and BETA versions of the same bot. If you anticipate that a user will need to have conversation with two different versions, for example, while testing, include the bot alias in the user ID to separate the two conversations. pcUserId :: Lens' PostContent Text -pcUserId = lens _pcUserId (\ s a -> s{_pcUserId = a}); +pcUserId = lens _pcUserId (\ s a -> s{_pcUserId = a}) -- | You pass this value as the @Content-Type@ HTTP header. Indicates the audio format or text. The header value must start with one of the following prefixes: * PCM format, audio data must be in little-endian byte order. * audio/l16; rate=16000; channels=1 * audio/x-l16; sample-rate=16000; channel-count=1 * audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false * Opus format * audio/x-cbr-opus-with-preamble; preamble-size=0; bit-rate=256000; frame-size-milliseconds=4 * Text format * text/plain; charset=utf-8 pcContentType :: Lens' PostContent Text -pcContentType = lens _pcContentType (\ s a -> s{_pcContentType = a}); +pcContentType = lens _pcContentType (\ s a -> s{_pcContentType = a}) -- | User input in PCM or Opus audio format or text format as described in the @Content-Type@ HTTP header. You can stream audio data to Amazon Lex or you can create a local buffer that captures all of the audio data before sending. In general, you get better performance if you stream audio data rather than buffering the data locally. pcInputStream :: Lens' PostContent HashedBody -pcInputStream = lens _pcInputStream (\ s a -> s{_pcInputStream = a}); +pcInputStream = lens _pcInputStream (\ s a -> s{_pcInputStream = a}) instance AWSRequest PostContent where type Rs PostContent = PostContentResponse @@ -188,6 +189,7 @@ (h .#? "x-amz-lex-intent-name") <*> (h .#? "x-amz-lex-dialog-state") <*> (h .#? "x-amz-lex-input-transcript") + <*> (h .#? "x-amz-lex-message-format") <*> (h .#? "x-amz-lex-message") <*> (h .#? "x-amz-lex-slot-to-elicit") <*> (h .#? "Content-Type") @@ -206,9 +208,7 @@ _pcRequestAttributes, "x-amz-lex-session-attributes" =# _pcSessionAttributes, - "Content-Type" =# _pcContentType, - "Content-Type" =# - ("application/x-amz-json-1.1" :: ByteString)] + "Content-Type" =# _pcContentType] instance ToPath PostContent where toPath PostContent'{..} @@ -226,6 +226,7 @@ , _pcrsIntentName :: !(Maybe Text) , _pcrsDialogState :: !(Maybe DialogState) , _pcrsInputTranscript :: !(Maybe Text) + , _pcrsMessageFormat :: !(Maybe MessageFormatType) , _pcrsMessage :: !(Maybe (Sensitive Text)) , _pcrsSlotToElicit :: !(Maybe Text) , _pcrsContentType :: !(Maybe Text) @@ -247,8 +248,10 @@ -- -- * 'pcrsInputTranscript' - The text used to process the request. If the input was an audio stream, the @inputTranscript@ field contains the text extracted from the audio stream. This is the text that is actually processed to recognize intents and slot values. You can use this information to determine if Amazon Lex is correctly processing the audio that you send. -- --- * 'pcrsMessage' - Message to convey to the user. It can come from the bot's configuration or a code hook (Lambda function). If the current intent is not configured with a code hook or if the code hook returned @Delegate@ as the @dialogAction.type@ in its response, then Amazon Lex decides the next course of action and selects an appropriate message from the bot configuration based on the current user interaction context. For example, if Amazon Lex is not able to understand the user input, it uses a clarification prompt message (For more information, see the Error Handling section in the Amazon Lex console). Another example: if the intent requires confirmation before fulfillment, then Amazon Lex uses the confirmation prompt message in the intent configuration. If the code hook returns a message, Amazon Lex passes it as-is in its response to the client. +-- * 'pcrsMessageFormat' - The format of the response message. One of the following values: * @PlainText@ - The message contains plain UTF-8 text. * @CustomPayload@ - The message is a custom format for the client. * @SSML@ - The message contains text formatted for voice output. * @Composite@ - The message contains an escaped JSON object containing one or more messages from the groups that messages were assigned to when the intent was created. -- +-- * 'pcrsMessage' - The message to convey to the user. The message can come from the bot's configuration or from a Lambda function. If the intent is not configured with a Lambda function, or if the Lambda function returned @Delegate@ as the @dialogAction.type@ its response, Amazon Lex decides on the next course of action and selects an appropriate message from the bot's configuration based on the current interaction context. For example, if Amazon Lex isn't able to understand user input, it uses a clarification prompt message. When you create an intent you can assign messages to groups. When messages are assigned to groups Amazon Lex returns one message from each group in the response. The message field is an escaped JSON string containing the messages. For more information about the structure of the JSON string returned, see 'msg-prompts-formats' . If the Lambda function returns a message, Amazon Lex passes it to the client in its response. +-- -- * 'pcrsSlotToElicit' - If the @dialogState@ value is @ElicitSlot@ , returns the name of the slot for which Amazon Lex is eliciting a value. -- -- * 'pcrsContentType' - Content type as specified in the @Accept@ HTTP header in the request. @@ -264,55 +267,60 @@ -> PostContentResponse postContentResponse pResponseStatus_ pAudioStream_ = PostContentResponse' - { _pcrsSlots = Nothing - , _pcrsIntentName = Nothing - , _pcrsDialogState = Nothing - , _pcrsInputTranscript = Nothing - , _pcrsMessage = Nothing - , _pcrsSlotToElicit = Nothing - , _pcrsContentType = Nothing - , _pcrsSessionAttributes = Nothing - , _pcrsResponseStatus = pResponseStatus_ - , _pcrsAudioStream = pAudioStream_ - } + { _pcrsSlots = Nothing + , _pcrsIntentName = Nothing + , _pcrsDialogState = Nothing + , _pcrsInputTranscript = Nothing + , _pcrsMessageFormat = Nothing + , _pcrsMessage = Nothing + , _pcrsSlotToElicit = Nothing + , _pcrsContentType = Nothing + , _pcrsSessionAttributes = Nothing + , _pcrsResponseStatus = pResponseStatus_ + , _pcrsAudioStream = pAudioStream_ + } -- | Map of zero or more intent slots (name/value pairs) Amazon Lex detected from the user input during the conversation. Amazon Lex creates a resolution list containing likely values for a slot. The value that it returns is determined by the @valueSelectionStrategy@ selected when the slot type was created or updated. If @valueSelectionStrategy@ is set to @ORIGINAL_VALUE@ , the value provided by the user is returned, if the user value is similar to the slot values. If @valueSelectionStrategy@ is set to @TOP_RESOLUTION@ Amazon Lex returns the first value in the resolution list or, if there is no resolution list, null. If you don't specify a @valueSelectionStrategy@ , the default is @ORIGINAL_VALUE@ . pcrsSlots :: Lens' PostContentResponse (Maybe Text) -pcrsSlots = lens _pcrsSlots (\ s a -> s{_pcrsSlots = a}); +pcrsSlots = lens _pcrsSlots (\ s a -> s{_pcrsSlots = a}) -- | Current user intent that Amazon Lex is aware of. pcrsIntentName :: Lens' PostContentResponse (Maybe Text) -pcrsIntentName = lens _pcrsIntentName (\ s a -> s{_pcrsIntentName = a}); +pcrsIntentName = lens _pcrsIntentName (\ s a -> s{_pcrsIntentName = a}) -- | Identifies the current state of the user interaction. Amazon Lex returns one of the following values as @dialogState@ . The client can optionally use this information to customize the user interface. * @ElicitIntent@ - Amazon Lex wants to elicit the user's intent. Consider the following examples: For example, a user might utter an intent ("I want to order a pizza"). If Amazon Lex cannot infer the user intent from this utterance, it will return this dialog state. * @ConfirmIntent@ - Amazon Lex is expecting a "yes" or "no" response. For example, Amazon Lex wants user confirmation before fulfilling an intent. Instead of a simple "yes" or "no" response, a user might respond with additional information. For example, "yes, but make it a thick crust pizza" or "no, I want to order a drink." Amazon Lex can process such additional information (in these examples, update the crust type slot or change the intent from OrderPizza to OrderDrink). * @ElicitSlot@ - Amazon Lex is expecting the value of a slot for the current intent. For example, suppose that in the response Amazon Lex sends this message: "What size pizza would you like?". A user might reply with the slot value (e.g., "medium"). The user might also provide additional information in the response (e.g., "medium thick crust pizza"). Amazon Lex can process such additional information appropriately. * @Fulfilled@ - Conveys that the Lambda function has successfully fulfilled the intent. * @ReadyForFulfillment@ - Conveys that the client has to fulfill the request. * @Failed@ - Conveys that the conversation with the user failed. This can happen for various reasons, including that the user does not provide an appropriate response to prompts from the service (you can configure how many times Amazon Lex can prompt a user for specific information), or if the Lambda function fails to fulfill the intent. pcrsDialogState :: Lens' PostContentResponse (Maybe DialogState) -pcrsDialogState = lens _pcrsDialogState (\ s a -> s{_pcrsDialogState = a}); +pcrsDialogState = lens _pcrsDialogState (\ s a -> s{_pcrsDialogState = a}) -- | The text used to process the request. If the input was an audio stream, the @inputTranscript@ field contains the text extracted from the audio stream. This is the text that is actually processed to recognize intents and slot values. You can use this information to determine if Amazon Lex is correctly processing the audio that you send. pcrsInputTranscript :: Lens' PostContentResponse (Maybe Text) -pcrsInputTranscript = lens _pcrsInputTranscript (\ s a -> s{_pcrsInputTranscript = a}); +pcrsInputTranscript = lens _pcrsInputTranscript (\ s a -> s{_pcrsInputTranscript = a}) --- | Message to convey to the user. It can come from the bot's configuration or a code hook (Lambda function). If the current intent is not configured with a code hook or if the code hook returned @Delegate@ as the @dialogAction.type@ in its response, then Amazon Lex decides the next course of action and selects an appropriate message from the bot configuration based on the current user interaction context. For example, if Amazon Lex is not able to understand the user input, it uses a clarification prompt message (For more information, see the Error Handling section in the Amazon Lex console). Another example: if the intent requires confirmation before fulfillment, then Amazon Lex uses the confirmation prompt message in the intent configuration. If the code hook returns a message, Amazon Lex passes it as-is in its response to the client. +-- | The format of the response message. One of the following values: * @PlainText@ - The message contains plain UTF-8 text. * @CustomPayload@ - The message is a custom format for the client. * @SSML@ - The message contains text formatted for voice output. * @Composite@ - The message contains an escaped JSON object containing one or more messages from the groups that messages were assigned to when the intent was created. +pcrsMessageFormat :: Lens' PostContentResponse (Maybe MessageFormatType) +pcrsMessageFormat = lens _pcrsMessageFormat (\ s a -> s{_pcrsMessageFormat = a}) + +-- | The message to convey to the user. The message can come from the bot's configuration or from a Lambda function. If the intent is not configured with a Lambda function, or if the Lambda function returned @Delegate@ as the @dialogAction.type@ its response, Amazon Lex decides on the next course of action and selects an appropriate message from the bot's configuration based on the current interaction context. For example, if Amazon Lex isn't able to understand user input, it uses a clarification prompt message. When you create an intent you can assign messages to groups. When messages are assigned to groups Amazon Lex returns one message from each group in the response. The message field is an escaped JSON string containing the messages. For more information about the structure of the JSON string returned, see 'msg-prompts-formats' . If the Lambda function returns a message, Amazon Lex passes it to the client in its response. pcrsMessage :: Lens' PostContentResponse (Maybe Text) -pcrsMessage = lens _pcrsMessage (\ s a -> s{_pcrsMessage = a}) . mapping _Sensitive; +pcrsMessage = lens _pcrsMessage (\ s a -> s{_pcrsMessage = a}) . mapping _Sensitive -- | If the @dialogState@ value is @ElicitSlot@ , returns the name of the slot for which Amazon Lex is eliciting a value. pcrsSlotToElicit :: Lens' PostContentResponse (Maybe Text) -pcrsSlotToElicit = lens _pcrsSlotToElicit (\ s a -> s{_pcrsSlotToElicit = a}); +pcrsSlotToElicit = lens _pcrsSlotToElicit (\ s a -> s{_pcrsSlotToElicit = a}) -- | Content type as specified in the @Accept@ HTTP header in the request. pcrsContentType :: Lens' PostContentResponse (Maybe Text) -pcrsContentType = lens _pcrsContentType (\ s a -> s{_pcrsContentType = a}); +pcrsContentType = lens _pcrsContentType (\ s a -> s{_pcrsContentType = a}) -- | Map of key/value pairs representing the session-specific context information. pcrsSessionAttributes :: Lens' PostContentResponse (Maybe Text) -pcrsSessionAttributes = lens _pcrsSessionAttributes (\ s a -> s{_pcrsSessionAttributes = a}); +pcrsSessionAttributes = lens _pcrsSessionAttributes (\ s a -> s{_pcrsSessionAttributes = a}) -- | -- | The response status code. pcrsResponseStatus :: Lens' PostContentResponse Int -pcrsResponseStatus = lens _pcrsResponseStatus (\ s a -> s{_pcrsResponseStatus = a}); +pcrsResponseStatus = lens _pcrsResponseStatus (\ s a -> s{_pcrsResponseStatus = a}) -- | The prompt (or statement) to convey to the user. This is based on the bot configuration and context. For example, if Amazon Lex did not understand the user intent, it sends the @clarificationPrompt@ configured for the bot. If the intent requires confirmation before taking the fulfillment action, it sends the @confirmationPrompt@ . Another example: Suppose that the Lambda function successfully fulfilled the intent, and sent a message to convey to the user. Then Amazon Lex sends that message in the response. pcrsAudioStream :: Lens' PostContentResponse RsBody -pcrsAudioStream = lens _pcrsAudioStream (\ s a -> s{_pcrsAudioStream = a}); +pcrsAudioStream = lens _pcrsAudioStream (\ s a -> s{_pcrsAudioStream = a}) diff --git a/gen/Network/AWS/LexRuntime/PostText.hs b/gen/Network/AWS/LexRuntime/PostText.hs --- a/gen/Network/AWS/LexRuntime/PostText.hs +++ b/gen/Network/AWS/LexRuntime/PostText.hs @@ -12,7 +12,7 @@ -- | -- Module : Network.AWS.LexRuntime.PostText --- Copyright : (c) 2013-2017 Brendan Hay +-- Copyright : (c) 2013-2018 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated @@ -74,6 +74,7 @@ , ptrsResponseCard , ptrsIntentName , ptrsDialogState + , ptrsMessageFormat , ptrsMessage , ptrsSlotToElicit , ptrsSessionAttributes @@ -121,38 +122,38 @@ -> PostText postText pBotName_ pBotAlias_ pUserId_ pInputText_ = PostText' - { _ptRequestAttributes = Nothing - , _ptSessionAttributes = Nothing - , _ptBotName = pBotName_ - , _ptBotAlias = pBotAlias_ - , _ptUserId = pUserId_ - , _ptInputText = _Sensitive # pInputText_ - } + { _ptRequestAttributes = Nothing + , _ptSessionAttributes = Nothing + , _ptBotName = pBotName_ + , _ptBotAlias = pBotAlias_ + , _ptUserId = pUserId_ + , _ptInputText = _Sensitive # pInputText_ + } -- | Request-specific information passed between Amazon Lex and a client application. The namespace @x-amz-lex:@ is reserved for special attributes. Don't create any request attributes with the prefix @x-amz-lex:@ . For more information, see . ptRequestAttributes :: Lens' PostText (Maybe (HashMap Text Text)) -ptRequestAttributes = lens _ptRequestAttributes (\ s a -> s{_ptRequestAttributes = a}) . mapping (_Sensitive . _Map); +ptRequestAttributes = lens _ptRequestAttributes (\ s a -> s{_ptRequestAttributes = a}) . mapping (_Sensitive . _Map) -- | Application-specific information passed between Amazon Lex and a client application. For more information, see . ptSessionAttributes :: Lens' PostText (Maybe (HashMap Text Text)) -ptSessionAttributes = lens _ptSessionAttributes (\ s a -> s{_ptSessionAttributes = a}) . mapping (_Sensitive . _Map); +ptSessionAttributes = lens _ptSessionAttributes (\ s a -> s{_ptSessionAttributes = a}) . mapping (_Sensitive . _Map) -- | The name of the Amazon Lex bot. ptBotName :: Lens' PostText Text -ptBotName = lens _ptBotName (\ s a -> s{_ptBotName = a}); +ptBotName = lens _ptBotName (\ s a -> s{_ptBotName = a}) -- | The alias of the Amazon Lex bot. ptBotAlias :: Lens' PostText Text -ptBotAlias = lens _ptBotAlias (\ s a -> s{_ptBotAlias = a}); +ptBotAlias = lens _ptBotAlias (\ s a -> s{_ptBotAlias = a}) -- | The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot. At runtime, each request must contain the @userID@ field. To decide the user ID to use for your application, consider the following factors. * The @userID@ field must not contain any personally identifiable information of the user, for example, name, personal identification numbers, or other end user personal information. * If you want a user to start a conversation on one device and continue on another device, use a user-specific identifier. * If you want the same user to be able to have two independent conversations on two different devices, choose a device-specific identifier. * A user can't have two independent conversations with two different versions of the same bot. For example, a user can't have a conversation with the PROD and BETA versions of the same bot. If you anticipate that a user will need to have conversation with two different versions, for example, while testing, include the bot alias in the user ID to separate the two conversations. ptUserId :: Lens' PostText Text -ptUserId = lens _ptUserId (\ s a -> s{_ptUserId = a}); +ptUserId = lens _ptUserId (\ s a -> s{_ptUserId = a}) -- | The text that the user entered (Amazon Lex interprets this text). ptInputText :: Lens' PostText Text -ptInputText = lens _ptInputText (\ s a -> s{_ptInputText = a}) . _Sensitive; +ptInputText = lens _ptInputText (\ s a -> s{_ptInputText = a}) . _Sensitive instance AWSRequest PostText where type Rs PostText = PostTextResponse @@ -164,6 +165,7 @@ (x .?> "slots" .!@ mempty) <*> (x .?> "responseCard") <*> (x .?> "intentName") <*> (x .?> "dialogState") + <*> (x .?> "messageFormat") <*> (x .?> "message") <*> (x .?> "slotToElicit") <*> (x .?> "sessionAttributes" .!@ mempty) @@ -203,6 +205,7 @@ , _ptrsResponseCard :: !(Maybe ResponseCard) , _ptrsIntentName :: !(Maybe Text) , _ptrsDialogState :: !(Maybe DialogState) + , _ptrsMessageFormat :: !(Maybe MessageFormatType) , _ptrsMessage :: !(Maybe (Sensitive Text)) , _ptrsSlotToElicit :: !(Maybe Text) , _ptrsSessionAttributes :: !(Maybe (Sensitive (Map Text Text))) @@ -222,8 +225,10 @@ -- -- * 'ptrsDialogState' - Identifies the current state of the user interaction. Amazon Lex returns one of the following values as @dialogState@ . The client can optionally use this information to customize the user interface. * @ElicitIntent@ - Amazon Lex wants to elicit user intent. For example, a user might utter an intent ("I want to order a pizza"). If Amazon Lex cannot infer the user intent from this utterance, it will return this dialogState. * @ConfirmIntent@ - Amazon Lex is expecting a "yes" or "no" response. For example, Amazon Lex wants user confirmation before fulfilling an intent. Instead of a simple "yes" or "no," a user might respond with additional information. For example, "yes, but make it thick crust pizza" or "no, I want to order a drink". Amazon Lex can process such additional information (in these examples, update the crust type slot value, or change intent from OrderPizza to OrderDrink). * @ElicitSlot@ - Amazon Lex is expecting a slot value for the current intent. For example, suppose that in the response Amazon Lex sends this message: "What size pizza would you like?". A user might reply with the slot value (e.g., "medium"). The user might also provide additional information in the response (e.g., "medium thick crust pizza"). Amazon Lex can process such additional information appropriately. * @Fulfilled@ - Conveys that the Lambda function configured for the intent has successfully fulfilled the intent. * @ReadyForFulfillment@ - Conveys that the client has to fulfill the intent. * @Failed@ - Conveys that the conversation with the user failed. This can happen for various reasons including that the user did not provide an appropriate response to prompts from the service (you can configure how many times Amazon Lex can prompt a user for specific information), or the Lambda function failed to fulfill the intent. -- --- * 'ptrsMessage' - A message to convey to the user. It can come from the bot's configuration or a code hook (Lambda function). If the current intent is not configured with a code hook or the code hook returned @Delegate@ as the @dialogAction.type@ in its response, then Amazon Lex decides the next course of action and selects an appropriate message from the bot configuration based on the current user interaction context. For example, if Amazon Lex is not able to understand the user input, it uses a clarification prompt message (for more information, see the Error Handling section in the Amazon Lex console). Another example: if the intent requires confirmation before fulfillment, then Amazon Lex uses the confirmation prompt message in the intent configuration. If the code hook returns a message, Amazon Lex passes it as-is in its response to the client. +-- * 'ptrsMessageFormat' - The format of the response message. One of the following values: * @PlainText@ - The message contains plain UTF-8 text. * @CustomPayload@ - The message is a custom format defined by the Lambda function. * @SSML@ - The message contains text formatted for voice output. * @Composite@ - The message contains an escaped JSON object containing one or more messages from the groups that messages were assigned to when the intent was created. -- +-- * 'ptrsMessage' - The message to convey to the user. The message can come from the bot's configuration or from a Lambda function. If the intent is not configured with a Lambda function, or if the Lambda function returned @Delegate@ as the @dialogAction.type@ its response, Amazon Lex decides on the next course of action and selects an appropriate message from the bot's configuration based on the current interaction context. For example, if Amazon Lex isn't able to understand user input, it uses a clarification prompt message. When you create an intent you can assign messages to groups. When messages are assigned to groups Amazon Lex returns one message from each group in the response. The message field is an escaped JSON string containing the messages. For more information about the structure of the JSON string returned, see 'msg-prompts-formats' . If the Lambda function returns a message, Amazon Lex passes it to the client in its response. +-- -- * 'ptrsSlotToElicit' - If the @dialogState@ value is @ElicitSlot@ , returns the name of the slot for which Amazon Lex is eliciting a value. -- -- * 'ptrsSessionAttributes' - A map of key-value pairs representing the session-specific context information. @@ -234,47 +239,52 @@ -> PostTextResponse postTextResponse pResponseStatus_ = PostTextResponse' - { _ptrsSlots = Nothing - , _ptrsResponseCard = Nothing - , _ptrsIntentName = Nothing - , _ptrsDialogState = Nothing - , _ptrsMessage = Nothing - , _ptrsSlotToElicit = Nothing - , _ptrsSessionAttributes = Nothing - , _ptrsResponseStatus = pResponseStatus_ - } + { _ptrsSlots = Nothing + , _ptrsResponseCard = Nothing + , _ptrsIntentName = Nothing + , _ptrsDialogState = Nothing + , _ptrsMessageFormat = Nothing + , _ptrsMessage = Nothing + , _ptrsSlotToElicit = Nothing + , _ptrsSessionAttributes = Nothing + , _ptrsResponseStatus = pResponseStatus_ + } -- | The intent slots that Amazon Lex detected from the user input in the conversation. Amazon Lex creates a resolution list containing likely values for a slot. The value that it returns is determined by the @valueSelectionStrategy@ selected when the slot type was created or updated. If @valueSelectionStrategy@ is set to @ORIGINAL_VALUE@ , the value provided by the user is returned, if the user value is similar to the slot values. If @valueSelectionStrategy@ is set to @TOP_RESOLUTION@ Amazon Lex returns the first value in the resolution list or, if there is no resolution list, null. If you don't specify a @valueSelectionStrategy@ , the default is @ORIGINAL_VALUE@ . ptrsSlots :: Lens' PostTextResponse (Maybe (HashMap Text Text)) -ptrsSlots = lens _ptrsSlots (\ s a -> s{_ptrsSlots = a}) . mapping (_Sensitive . _Map); +ptrsSlots = lens _ptrsSlots (\ s a -> s{_ptrsSlots = a}) . mapping (_Sensitive . _Map) -- | Represents the options that the user has to respond to the current prompt. Response Card can come from the bot configuration (in the Amazon Lex console, choose the settings button next to a slot) or from a code hook (Lambda function). ptrsResponseCard :: Lens' PostTextResponse (Maybe ResponseCard) -ptrsResponseCard = lens _ptrsResponseCard (\ s a -> s{_ptrsResponseCard = a}); +ptrsResponseCard = lens _ptrsResponseCard (\ s a -> s{_ptrsResponseCard = a}) -- | The current user intent that Amazon Lex is aware of. ptrsIntentName :: Lens' PostTextResponse (Maybe Text) -ptrsIntentName = lens _ptrsIntentName (\ s a -> s{_ptrsIntentName = a}); +ptrsIntentName = lens _ptrsIntentName (\ s a -> s{_ptrsIntentName = a}) -- | Identifies the current state of the user interaction. Amazon Lex returns one of the following values as @dialogState@ . The client can optionally use this information to customize the user interface. * @ElicitIntent@ - Amazon Lex wants to elicit user intent. For example, a user might utter an intent ("I want to order a pizza"). If Amazon Lex cannot infer the user intent from this utterance, it will return this dialogState. * @ConfirmIntent@ - Amazon Lex is expecting a "yes" or "no" response. For example, Amazon Lex wants user confirmation before fulfilling an intent. Instead of a simple "yes" or "no," a user might respond with additional information. For example, "yes, but make it thick crust pizza" or "no, I want to order a drink". Amazon Lex can process such additional information (in these examples, update the crust type slot value, or change intent from OrderPizza to OrderDrink). * @ElicitSlot@ - Amazon Lex is expecting a slot value for the current intent. For example, suppose that in the response Amazon Lex sends this message: "What size pizza would you like?". A user might reply with the slot value (e.g., "medium"). The user might also provide additional information in the response (e.g., "medium thick crust pizza"). Amazon Lex can process such additional information appropriately. * @Fulfilled@ - Conveys that the Lambda function configured for the intent has successfully fulfilled the intent. * @ReadyForFulfillment@ - Conveys that the client has to fulfill the intent. * @Failed@ - Conveys that the conversation with the user failed. This can happen for various reasons including that the user did not provide an appropriate response to prompts from the service (you can configure how many times Amazon Lex can prompt a user for specific information), or the Lambda function failed to fulfill the intent. ptrsDialogState :: Lens' PostTextResponse (Maybe DialogState) -ptrsDialogState = lens _ptrsDialogState (\ s a -> s{_ptrsDialogState = a}); +ptrsDialogState = lens _ptrsDialogState (\ s a -> s{_ptrsDialogState = a}) --- | A message to convey to the user. It can come from the bot's configuration or a code hook (Lambda function). If the current intent is not configured with a code hook or the code hook returned @Delegate@ as the @dialogAction.type@ in its response, then Amazon Lex decides the next course of action and selects an appropriate message from the bot configuration based on the current user interaction context. For example, if Amazon Lex is not able to understand the user input, it uses a clarification prompt message (for more information, see the Error Handling section in the Amazon Lex console). Another example: if the intent requires confirmation before fulfillment, then Amazon Lex uses the confirmation prompt message in the intent configuration. If the code hook returns a message, Amazon Lex passes it as-is in its response to the client. +-- | The format of the response message. One of the following values: * @PlainText@ - The message contains plain UTF-8 text. * @CustomPayload@ - The message is a custom format defined by the Lambda function. * @SSML@ - The message contains text formatted for voice output. * @Composite@ - The message contains an escaped JSON object containing one or more messages from the groups that messages were assigned to when the intent was created. +ptrsMessageFormat :: Lens' PostTextResponse (Maybe MessageFormatType) +ptrsMessageFormat = lens _ptrsMessageFormat (\ s a -> s{_ptrsMessageFormat = a}) + +-- | The message to convey to the user. The message can come from the bot's configuration or from a Lambda function. If the intent is not configured with a Lambda function, or if the Lambda function returned @Delegate@ as the @dialogAction.type@ its response, Amazon Lex decides on the next course of action and selects an appropriate message from the bot's configuration based on the current interaction context. For example, if Amazon Lex isn't able to understand user input, it uses a clarification prompt message. When you create an intent you can assign messages to groups. When messages are assigned to groups Amazon Lex returns one message from each group in the response. The message field is an escaped JSON string containing the messages. For more information about the structure of the JSON string returned, see 'msg-prompts-formats' . If the Lambda function returns a message, Amazon Lex passes it to the client in its response. ptrsMessage :: Lens' PostTextResponse (Maybe Text) -ptrsMessage = lens _ptrsMessage (\ s a -> s{_ptrsMessage = a}) . mapping _Sensitive; +ptrsMessage = lens _ptrsMessage (\ s a -> s{_ptrsMessage = a}) . mapping _Sensitive -- | If the @dialogState@ value is @ElicitSlot@ , returns the name of the slot for which Amazon Lex is eliciting a value. ptrsSlotToElicit :: Lens' PostTextResponse (Maybe Text) -ptrsSlotToElicit = lens _ptrsSlotToElicit (\ s a -> s{_ptrsSlotToElicit = a}); +ptrsSlotToElicit = lens _ptrsSlotToElicit (\ s a -> s{_ptrsSlotToElicit = a}) -- | A map of key-value pairs representing the session-specific context information. ptrsSessionAttributes :: Lens' PostTextResponse (Maybe (HashMap Text Text)) -ptrsSessionAttributes = lens _ptrsSessionAttributes (\ s a -> s{_ptrsSessionAttributes = a}) . mapping (_Sensitive . _Map); +ptrsSessionAttributes = lens _ptrsSessionAttributes (\ s a -> s{_ptrsSessionAttributes = a}) . mapping (_Sensitive . _Map) -- | -- | The response status code. ptrsResponseStatus :: Lens' PostTextResponse Int -ptrsResponseStatus = lens _ptrsResponseStatus (\ s a -> s{_ptrsResponseStatus = a}); +ptrsResponseStatus = lens _ptrsResponseStatus (\ s a -> s{_ptrsResponseStatus = a}) instance NFData PostTextResponse where diff --git a/gen/Network/AWS/LexRuntime/Types.hs b/gen/Network/AWS/LexRuntime/Types.hs --- a/gen/Network/AWS/LexRuntime/Types.hs +++ b/gen/Network/AWS/LexRuntime/Types.hs @@ -4,7 +4,7 @@ -- | -- Module : Network.AWS.LexRuntime.Types --- Copyright : (c) 2013-2017 Brendan Hay +-- Copyright : (c) 2013-2018 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated @@ -34,6 +34,9 @@ -- * DialogState , DialogState (..) + -- * MessageFormatType + , MessageFormatType (..) + -- * Button , Button , button @@ -67,24 +70,24 @@ lexRuntime :: Service lexRuntime = Service - { _svcAbbrev = "LexRuntime" - , _svcSigner = v4 - , _svcPrefix = "runtime.lex" - , _svcVersion = "2016-11-28" - , _svcEndpoint = defaultEndpoint lexRuntime - , _svcTimeout = Just 70 - , _svcCheck = statusSuccess - , _svcError = parseJSONError "LexRuntime" - , _svcRetry = retry - } + { _svcAbbrev = "LexRuntime" + , _svcSigner = v4 + , _svcPrefix = "runtime.lex" + , _svcVersion = "2016-11-28" + , _svcEndpoint = defaultEndpoint lexRuntime + , _svcTimeout = Just 70 + , _svcCheck = statusSuccess + , _svcError = parseJSONError "LexRuntime" + , _svcRetry = retry + } where retry = Exponential - { _retryBase = 5.0e-2 - , _retryGrowth = 2 - , _retryAttempts = 5 - , _retryCheck = check - } + { _retryBase = 5.0e-2 + , _retryGrowth = 2 + , _retryAttempts = 5 + , _retryCheck = check + } check e | has (hasCode "ThrottledException" . hasStatus 400) e = Just "throttled_exception" @@ -93,6 +96,8 @@ Just "throttling_exception" | has (hasCode "Throttling" . hasStatus 400) e = Just "throttling" | has (hasStatus 504) e = Just "gateway_timeout" + | has (hasCode "RequestThrottledException" . hasStatus 400) e = + Just "request_throttled_exception" | has (hasStatus 502) e = Just "bad_gateway" | has (hasStatus 503) e = Just "service_unavailable" | has (hasStatus 500) e = Just "general_server_error" diff --git a/gen/Network/AWS/LexRuntime/Types/Product.hs b/gen/Network/AWS/LexRuntime/Types/Product.hs --- a/gen/Network/AWS/LexRuntime/Types/Product.hs +++ b/gen/Network/AWS/LexRuntime/Types/Product.hs @@ -9,7 +9,7 @@ -- | -- Module : Network.AWS.LexRuntime.Types.Product --- Copyright : (c) 2013-2017 Brendan Hay +-- Copyright : (c) 2013-2018 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated @@ -48,11 +48,11 @@ -- | Text that is visible to the user on the button. bText :: Lens' Button Text -bText = lens _bText (\ s a -> s{_bText = a}); +bText = lens _bText (\ s a -> s{_bText = a}) -- | The value sent to Amazon Lex when a user chooses the button. For example, consider button text "NYC." When the user chooses the button, the value sent can be "New York City." bValue :: Lens' Button Text -bValue = lens _bValue (\ s a -> s{_bValue = a}); +bValue = lens _bValue (\ s a -> s{_bValue = a}) instance FromJSON Button where parseJSON @@ -94,33 +94,33 @@ :: GenericAttachment genericAttachment = GenericAttachment' - { _gaButtons = Nothing - , _gaSubTitle = Nothing - , _gaImageURL = Nothing - , _gaAttachmentLinkURL = Nothing - , _gaTitle = Nothing - } + { _gaButtons = Nothing + , _gaSubTitle = Nothing + , _gaImageURL = Nothing + , _gaAttachmentLinkURL = Nothing + , _gaTitle = Nothing + } -- | The list of options to show to the user. gaButtons :: Lens' GenericAttachment [Button] -gaButtons = lens _gaButtons (\ s a -> s{_gaButtons = a}) . _Default . _Coerce; +gaButtons = lens _gaButtons (\ s a -> s{_gaButtons = a}) . _Default . _Coerce -- | The subtitle shown below the title. gaSubTitle :: Lens' GenericAttachment (Maybe Text) -gaSubTitle = lens _gaSubTitle (\ s a -> s{_gaSubTitle = a}); +gaSubTitle = lens _gaSubTitle (\ s a -> s{_gaSubTitle = a}) -- | The URL of an image that is displayed to the user. gaImageURL :: Lens' GenericAttachment (Maybe Text) -gaImageURL = lens _gaImageURL (\ s a -> s{_gaImageURL = a}); +gaImageURL = lens _gaImageURL (\ s a -> s{_gaImageURL = a}) -- | The URL of an attachment to the response card. gaAttachmentLinkURL :: Lens' GenericAttachment (Maybe Text) -gaAttachmentLinkURL = lens _gaAttachmentLinkURL (\ s a -> s{_gaAttachmentLinkURL = a}); +gaAttachmentLinkURL = lens _gaAttachmentLinkURL (\ s a -> s{_gaAttachmentLinkURL = a}) -- | The title of the option. gaTitle :: Lens' GenericAttachment (Maybe Text) -gaTitle = lens _gaTitle (\ s a -> s{_gaTitle = a}); +gaTitle = lens _gaTitle (\ s a -> s{_gaTitle = a}) instance FromJSON GenericAttachment where parseJSON @@ -161,23 +161,23 @@ :: ResponseCard responseCard = ResponseCard' - { _rcGenericAttachments = Nothing - , _rcVersion = Nothing - , _rcContentType = Nothing - } + { _rcGenericAttachments = Nothing + , _rcVersion = Nothing + , _rcContentType = Nothing + } -- | An array of attachment objects representing options. rcGenericAttachments :: Lens' ResponseCard [GenericAttachment] -rcGenericAttachments = lens _rcGenericAttachments (\ s a -> s{_rcGenericAttachments = a}) . _Default . _Coerce; +rcGenericAttachments = lens _rcGenericAttachments (\ s a -> s{_rcGenericAttachments = a}) . _Default . _Coerce -- | The version of the response card format. rcVersion :: Lens' ResponseCard (Maybe Text) -rcVersion = lens _rcVersion (\ s a -> s{_rcVersion = a}); +rcVersion = lens _rcVersion (\ s a -> s{_rcVersion = a}) -- | The content type of the response. rcContentType :: Lens' ResponseCard (Maybe ContentType) -rcContentType = lens _rcContentType (\ s a -> s{_rcContentType = a}); +rcContentType = lens _rcContentType (\ s a -> s{_rcContentType = a}) instance FromJSON ResponseCard where parseJSON diff --git a/gen/Network/AWS/LexRuntime/Types/Sum.hs b/gen/Network/AWS/LexRuntime/Types/Sum.hs --- a/gen/Network/AWS/LexRuntime/Types/Sum.hs +++ b/gen/Network/AWS/LexRuntime/Types/Sum.hs @@ -9,7 +9,7 @@ -- | -- Module : Network.AWS.LexRuntime.Types.Sum --- Copyright : (c) 2013-2017 Brendan Hay +-- Copyright : (c) 2013-2018 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated @@ -81,3 +81,36 @@ instance FromJSON DialogState where parseJSON = parseJSONText "DialogState" + +data MessageFormatType + = Composite + | CustomPayload + | PlainText + | Ssml + deriving (Eq, Ord, Read, Show, Enum, Bounded, Data, Typeable, Generic) + + +instance FromText MessageFormatType where + parser = takeLowerText >>= \case + "composite" -> pure Composite + "custompayload" -> pure CustomPayload + "plaintext" -> pure PlainText + "ssml" -> pure Ssml + e -> fromTextError $ "Failure parsing MessageFormatType from value: '" <> e + <> "'. Accepted values: composite, custompayload, plaintext, ssml" + +instance ToText MessageFormatType where + toText = \case + Composite -> "Composite" + CustomPayload -> "CustomPayload" + PlainText -> "PlainText" + Ssml -> "SSML" + +instance Hashable MessageFormatType +instance NFData MessageFormatType +instance ToByteString MessageFormatType +instance ToQuery MessageFormatType +instance ToHeader MessageFormatType + +instance FromJSON MessageFormatType where + parseJSON = parseJSONText "MessageFormatType" diff --git a/gen/Network/AWS/LexRuntime/Waiters.hs b/gen/Network/AWS/LexRuntime/Waiters.hs --- a/gen/Network/AWS/LexRuntime/Waiters.hs +++ b/gen/Network/AWS/LexRuntime/Waiters.hs @@ -7,7 +7,7 @@ -- | -- Module : Network.AWS.LexRuntime.Waiters --- Copyright : (c) 2013-2017 Brendan Hay +-- Copyright : (c) 2013-2018 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated diff --git a/test/Main.hs b/test/Main.hs --- a/test/Main.hs +++ b/test/Main.hs @@ -2,7 +2,7 @@ -- | -- Module : Main --- Copyright : (c) 2013-2017 Brendan Hay +-- Copyright : (c) 2013-2018 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated diff --git a/test/Test/AWS/Gen/LexRuntime.hs b/test/Test/AWS/Gen/LexRuntime.hs --- a/test/Test/AWS/Gen/LexRuntime.hs +++ b/test/Test/AWS/Gen/LexRuntime.hs @@ -5,7 +5,7 @@ -- | -- Module : Test.AWS.Gen.LexRuntime --- Copyright : (c) 2013-2017 Brendan Hay +-- Copyright : (c) 2013-2018 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated diff --git a/test/Test/AWS/LexRuntime.hs b/test/Test/AWS/LexRuntime.hs --- a/test/Test/AWS/LexRuntime.hs +++ b/test/Test/AWS/LexRuntime.hs @@ -1,6 +1,6 @@ -- | -- Module : Test.AWS.LexRuntime --- Copyright : (c) 2013-2016 Brendan Hay +-- Copyright : (c) 2013-2018 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated diff --git a/test/Test/AWS/LexRuntime/Internal.hs b/test/Test/AWS/LexRuntime/Internal.hs --- a/test/Test/AWS/LexRuntime/Internal.hs +++ b/test/Test/AWS/LexRuntime/Internal.hs @@ -1,6 +1,6 @@ -- | -- Module : Test.AWS.LexRuntime.Internal --- Copyright : (c) 2013-2016 Brendan Hay +-- Copyright : (c) 2013-2018 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated