{ "version":"2.0", "metadata":{ "apiVersion":"2020-08-07", "endpointPrefix":"runtime-v2-lex", "jsonVersion":"1.1", "protocol":"rest-json", "protocolSettings":{"h2":"eventstream"}, "serviceAbbreviation":"Lex Runtime V2", "serviceFullName":"Amazon Lex Runtime V2", "serviceId":"Lex Runtime V2", "signatureVersion":"v4", "signingName":"lex", "uid":"runtime.lex.v2-2020-08-07" }, "operations":{ "DeleteSession":{ "name":"DeleteSession", "http":{ "method":"DELETE", "requestUri":"/bots/{botId}/botAliases/{botAliasId}/botLocales/{localeId}/sessions/{sessionId}" }, "input":{"shape":"DeleteSessionRequest"}, "output":{"shape":"DeleteSessionResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"} ], "documentation":"

Removes session information for a specified bot, alias, and user ID.

You can use this operation to restart a conversation with a bot. When you remove a session, the entire history of the session is removed so that you can start again.

You don't need to delete a session. Sessions have a time limit and will expire. Set the session time limit when you create the bot. The default is 5 minutes, but you can specify anything between 1 minute and 24 hours.

If you specify a bot or alias ID that doesn't exist, you receive a `BadRequestException.`

If the locale doesn't exist in the bot, or if the locale hasn't been enables for the alias, you receive a `BadRequestException`.

" }, "GetSession":{ "name":"GetSession", "http":{ "method":"GET", "requestUri":"/bots/{botId}/botAliases/{botAliasId}/botLocales/{localeId}/sessions/{sessionId}" }, "input":{"shape":"GetSessionRequest"}, "output":{"shape":"GetSessionResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Returns session information for a specified bot, alias, and user.

For example, you can use this operation to retrieve session information for a user that has left a long-running session in use.

If the bot, alias, or session identifier doesn't exist, Amazon Lex V2 returns a `BadRequestException`. If the locale doesn't exist or is not enabled for the alias, you receive a `BadRequestException`.

" }, "PutSession":{ "name":"PutSession", "http":{ "method":"POST", "requestUri":"/bots/{botId}/botAliases/{botAliasId}/botLocales/{localeId}/sessions/{sessionId}" }, "input":{"shape":"PutSessionRequest"}, "output":{"shape":"PutSessionResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"DependencyFailedException"}, {"shape":"BadGatewayException"} ], "documentation":"

Creates a new session or modifies an existing session with an Amazon Lex V2 bot. Use this operation to enable your application to set the state of the bot.

" }, "RecognizeText":{ "name":"RecognizeText", "http":{ "method":"POST", "requestUri":"/bots/{botId}/botAliases/{botAliasId}/botLocales/{localeId}/sessions/{sessionId}/text" }, "input":{"shape":"RecognizeTextRequest"}, "output":{"shape":"RecognizeTextResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"DependencyFailedException"}, {"shape":"BadGatewayException"} ], "documentation":"

Sends user input to Amazon Lex V2. Client applications use this API to send requests to Amazon Lex V2 at runtime. Amazon Lex V2 then interprets the user input using the machine learning model that it build for the bot.

In response, Amazon Lex V2 returns the next message to convey to the user and an optional response card to display.

If the optional post-fulfillment response is specified, the messages are returned as follows. For more information, see PostFulfillmentStatusSpecification.

- Success message - Returned if the Lambda function completes successfully and the intent state is fulfilled or ready fulfillment if the message is present.

- Failed message - The failed message is returned if the Lambda function throws an exception or if the Lambda function returns a failed intent state without a message.

- Timeout message - If you don't configure a timeout message and a timeout, and the Lambda function doesn't return within 30 seconds, the timeout message is returned. If you configure a timeout, the timeout message is returned when the period times out.

For more information, see Completion message.

" }, "RecognizeUtterance":{ "name":"RecognizeUtterance", "http":{ "method":"POST", "requestUri":"/bots/{botId}/botAliases/{botAliasId}/botLocales/{localeId}/sessions/{sessionId}/utterance" }, "input":{"shape":"RecognizeUtteranceRequest"}, "output":{"shape":"RecognizeUtteranceResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"DependencyFailedException"}, {"shape":"BadGatewayException"} ], "documentation":"

Sends user input to Amazon Lex V2. You can send text or speech. Clients use this API to send text and audio requests to Amazon Lex V2 at runtime. Amazon Lex V2 interprets the user input using the machine learning model built for the bot.

The following request fields must be compressed with gzip and then base64 encoded before you send them to Amazon Lex V2.

- requestAttributes

- sessionState

The following response fields are compressed using gzip and then base64 encoded by Amazon Lex V2. Before you can use these fields, you must decode and decompress them.

- inputTranscript

- interpretations

- messages

- requestAttributes

- sessionState

The example contains a Java application that compresses and encodes a Java object to send to Amazon Lex V2, and a second that decodes and decompresses a response from Amazon Lex V2.

If the optional post-fulfillment response is specified, the messages are returned as follows. For more information, see PostFulfillmentStatusSpecification.

- Success message - Returned if the Lambda function completes successfully and the intent state is fulfilled or ready fulfillment if the message is present.

- Failed message - The failed message is returned if the Lambda function throws an exception or if the Lambda function returns a failed intent state without a message.

- Timeout message - If you don't configure a timeout message and a timeout, and the Lambda function doesn't return within 30 seconds, the timeout message is returned. If you configure a timeout, the timeout message is returned when the period times out.

For more information, see Completion message.

", "authtype":"v4-unsigned-body" }, "StartConversation":{ "name":"StartConversation", "http":{ "method":"POST", "requestUri":"/bots/{botId}/botAliases/{botAliasId}/botLocales/{localeId}/sessions/{sessionId}/conversation" }, "input":{"shape":"StartConversationRequest"}, "output":{"shape":"StartConversationResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Starts an HTTP/2 bidirectional event stream that enables you to send audio, text, or DTMF input in real time. After your application starts a conversation, users send input to Amazon Lex V2 as a stream of events. Amazon Lex V2 processes the incoming events and responds with streaming text or audio events.

Audio input must be in the following format: `audio/lpcm sample-rate=8000 sample-size-bits=16 channel-count=1; is-big-endian=false`.

If the optional post-fulfillment response is specified, the messages are returned as follows. For more information, see PostFulfillmentStatusSpecification.

- Success message - Returned if the Lambda function completes successfully and the intent state is fulfilled or ready fulfillment if the message is present.

- Failed message - The failed message is returned if the Lambda function throws an exception or if the Lambda function returns a failed intent state without a message.

- Timeout message - If you don't configure a timeout message and a timeout, and the Lambda function doesn't return within 30 seconds, the timeout message is returned. If you configure a timeout, the timeout message is returned when the period times out.

For more information, see Completion message.

If the optional update message is configured, it is played at the specified frequency while the Lambda function is running and the update message state is active. If the fulfillment update message is not active, the Lambda function runs with a 30 second timeout.

For more information, see Update message

The `StartConversation` operation is supported only in the following SDKs:

- AWS SDK for C++

- AWS SDK for Java V2

- AWS SDK for Ruby V3

" } }, "shapes":{ "AccessDeniedException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

", "error":{"httpStatusCode":403}, "exception":true }, "ActiveContext":{ "type":"structure", "required":[ "name", "timeToLive", "contextAttributes" ], "members":{ "name":{ "shape":"ActiveContextName", "documentation":"

The name of the context.

" }, "timeToLive":{ "shape":"ActiveContextTimeToLive", "documentation":"

Indicates the number of turns or seconds that the context is active. Once the time to live expires, the context is no longer returned in a response.

" }, "contextAttributes":{ "shape":"ActiveContextParametersMap", "documentation":"

A list of contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request.

If you don't specify a list of contexts, Amazon Lex V2 will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared.

" } }, "documentation":"

Contains information about the contexts that a user is using in a session. You can configure Amazon Lex V2 to set a context when an intent is fulfilled, or you can set a context using the , , or operations.

Use a context to indicate to Amazon Lex V2 intents that should be used as follow-up intents. For example, if the active context is `order-fulfilled`, only intents that have `order-fulfilled` configured as a trigger are considered for follow up.

" }, "ActiveContextName":{ "type":"string", "max":100, "min":1, "pattern":"^([A-Za-z0-9]_?)+$" }, "ActiveContextParametersMap":{ "type":"map", "key":{"shape":"ParameterName"}, "value":{"shape":"Text"}, "max":10, "min":0 }, "ActiveContextTimeToLive":{ "type":"structure", "required":[ "timeToLiveInSeconds", "turnsToLive" ], "members":{ "timeToLiveInSeconds":{ "shape":"ActiveContextTimeToLiveInSeconds", "documentation":"

The number of seconds that the context is active. You can specify between 5 and 86400 seconds (24 hours).

" }, "turnsToLive":{ "shape":"ActiveContextTurnsToLive", "documentation":"

The number of turns that the context is active. You can specify up to 20 turns. Each request and response from the bot is a turn.

" } }, "documentation":"

The time that a context is active. You can specify the time to live in seconds or in conversation turns.

" }, "ActiveContextTimeToLiveInSeconds":{ "type":"integer", "max":86400, "min":5 }, "ActiveContextTurnsToLive":{ "type":"integer", "max":20, "min":1 }, "ActiveContextsList":{ "type":"list", "member":{"shape":"ActiveContext"}, "max":20, "min":0 }, "AttachmentTitle":{ "type":"string", "max":250, "min":1 }, "AttachmentUrl":{ "type":"string", "max":250, "min":1 }, "AudioChunk":{"type":"blob"}, "AudioInputEvent":{ "type":"structure", "required":["contentType"], "members":{ "audioChunk":{ "shape":"AudioChunk", "documentation":"

An encoded stream of audio.

" }, "contentType":{ "shape":"NonEmptyString", "documentation":"

The encoding used for the audio chunk. You must use 8 KHz PCM 16-bit mono-channel little-endian format. The value of the field should be:

`audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false`

" }, "eventId":{ "shape":"EventId", "documentation":"

A unique identifier that your application assigns to the event. You can use this to identify events in logs.

" }, "clientTimestampMillis":{ "shape":"EpochMillis", "documentation":"

A timestamp set by the client of the date and time that the event was sent to Amazon Lex V2.

" } }, "documentation":"

Represents a chunk of audio sent from the client application to Amazon Lex V2. The audio is all or part of an utterance from the user.

Amazon Lex V2 accumulates audio chunks until it recognizes a natural pause in speech before processing the input.

", "event":true }, "AudioResponseEvent":{ "type":"structure", "members":{ "audioChunk":{ "shape":"AudioChunk", "documentation":"

A chunk of the audio to play.

" }, "contentType":{ "shape":"NonEmptyString", "documentation":"

The encoding of the audio chunk. This is the same as the encoding configure in the `contentType` field of the `ConfigurationEvent`.

" }, "eventId":{ "shape":"EventId", "documentation":"

A unique identifier of the event sent by Amazon Lex V2. The identifier is in the form `RESPONSE-N`, where N is a number starting with one and incremented for each event sent by Amazon Lex V2 in the current session.

" } }, "documentation":"

An event sent from Amazon Lex V2 to your client application containing audio to play to the user.

", "event":true }, "BadGatewayException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

", "error":{"httpStatusCode":502}, "exception":true }, "BlobStream":{ "type":"blob", "streaming":true }, "Boolean":{"type":"boolean"}, "BotAliasIdentifier":{"type":"string"}, "BotIdentifier":{ "type":"string", "max":10, "min":10, "pattern":"^[0-9a-zA-Z]+$" }, "Button":{ "type":"structure", "required":[ "text", "value" ], "members":{ "text":{ "shape":"ButtonText", "documentation":"

The text that is displayed on the button.

" }, "value":{ "shape":"ButtonValue", "documentation":"

The value returned to Amazon Lex V2 when a user chooses the button.

" } }, "documentation":"

A button that appears on a response card show to the user.

" }, "ButtonText":{ "type":"string", "max":50, "min":1 }, "ButtonValue":{ "type":"string", "max":50, "min":1 }, "ButtonsList":{ "type":"list", "member":{"shape":"Button"}, "max":5, "min":0 }, "ConfidenceScore":{ "type":"structure", "members":{ "score":{ "shape":"Double", "documentation":"

A score that indicates how confident Amazon Lex V2 is that an intent satisfies the user's intent. Ranges between 0.00 and 1.00. Higher scores indicate higher confidence.

" } }, "documentation":"

Provides a score that indicates the confidence that Amazon Lex V2 has that an intent is the one that satisfies the user's intent.

" }, "ConfigurationEvent":{ "type":"structure", "required":["responseContentType"], "members":{ "requestAttributes":{ "shape":"StringMap", "documentation":"

Request-specific information passed between the client application and Amazon Lex V2.

The namespace `x-amz-lex:` is reserved for special attributes. Don't create any request attributes for prefix `x-amz-lex:`.

" }, "responseContentType":{ "shape":"NonEmptyString", "documentation":"

The message that Amazon Lex V2 returns in the response can be either text or speech based on the `responseContentType` value.

- If the value is `text/plain;charset=utf-8`, Amazon Lex V2 returns text in the response.

- If the value begins with `audio/`, Amazon Lex V2 returns speech in the response. Amazon Lex V2 uses Amazon Polly to generate the speech using the configuration that you specified in the `requestContentType` parameter. For example, if you specify `audio/mpeg` as the value, Amazon Lex V2 returns speech in the MPEG format.

- If the value is `audio/pcm`, the speech returned is audio/pcm in 16-bit, little-endian format.

- The following are the accepted values:

  - audio/mpeg

  - audio/ogg

  - audio/pcm

  - audio/* (defaults to mpeg)

  - text/plain; charset=utf-8

" }, "sessionState":{"shape":"SessionState"}, "welcomeMessages":{ "shape":"Messages", "documentation":"

A list of messages to send to the user.

If you set the `welcomeMessage` field, you must also set the `DialogAction` structure's `type` field.

" }, "disablePlayback":{ "shape":"Boolean", "documentation":"

Determines whether Amazon Lex V2 should send audio responses to the client application.

Set this field to false when the client is operating in a playback mode where audio responses are played to the user. If the client isn't operating in playback mode, such as a text chat application, set this to true so that Amazon Lex V2 doesn't wait for the prompt to finish playing on the client.

" }, "eventId":{ "shape":"EventId", "documentation":"

A unique identifier that your application assigns to the event. You can use this to identify events in logs.

" }, "clientTimestampMillis":{ "shape":"EpochMillis", "documentation":"

A timestamp set by the client of the date and time that the event was sent to Amazon Lex V2.

" } }, "documentation":"

The initial event sent from the application to Amazon Lex V2 to configure the conversation, including session and request attributes and the response content type.

", "event":true }, "ConfirmationState":{ "type":"string", "enum":[ "Confirmed", "Denied", "None" ] }, "ConflictException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

", "error":{"httpStatusCode":409}, "exception":true }, "ConversationMode":{ "type":"string", "enum":[ "AUDIO", "TEXT" ] }, "DTMFInputEvent":{ "type":"structure", "required":["inputCharacter"], "members":{ "inputCharacter":{ "shape":"DTMFRegex", "documentation":"

The DTMF character that the user pressed. The allowed characters are A - D, 0 - 9, # and *.

" }, "eventId":{ "shape":"EventId", "documentation":"

A unique identifier that your application assigns to the event. You can use this to identify events in logs.

" }, "clientTimestampMillis":{ "shape":"EpochMillis", "documentation":"

A timestamp set by the client of the date and time that the event was sent to Amazon Lex V2.

" } }, "documentation":"

A DTMF character sent from the client application. DTMF characters are typically sent from a phone keypad to represent numbers. For example, you can have Amazon Lex V2 process a credit card number input from a phone.

", "event":true }, "DTMFRegex":{ "type":"string", "max":1, "min":1, "pattern":"^[A-D0-9#*]{1}$", "sensitive":true }, "DeleteSessionRequest":{ "type":"structure", "required":[ "botId", "botAliasId", "sessionId", "localeId" ], "members":{ "botId":{ "shape":"BotIdentifier", "documentation":"

The identifier of the bot that contains the session data.

", "location":"uri", "locationName":"botId" }, "botAliasId":{ "shape":"BotAliasIdentifier", "documentation":"

The alias identifier in use for the bot that contains the session data.

", "location":"uri", "locationName":"botAliasId" }, "localeId":{ "shape":"LocaleId", "documentation":"

The locale where the session is in use.

", "location":"uri", "locationName":"localeId" }, "sessionId":{ "shape":"SessionId", "documentation":"

The identifier of the session to delete.

", "location":"uri", "locationName":"sessionId" } } }, "DeleteSessionResponse":{ "type":"structure", "members":{ "botId":{ "shape":"BotIdentifier", "documentation":"

The identifier of the bot that contained the session data.

" }, "botAliasId":{ "shape":"BotAliasIdentifier", "documentation":"

The alias identifier in use for the bot that contained the session data.

" }, "localeId":{ "shape":"LocaleId", "documentation":"

The locale where the session was used.

" }, "sessionId":{ "shape":"SessionId", "documentation":"

The identifier of the deleted session.

" } } }, "DependencyFailedException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

", "error":{"httpStatusCode":424}, "exception":true }, "DialogAction":{ "type":"structure", "required":["type"], "members":{ "type":{ "shape":"DialogActionType", "documentation":"

The next action that the bot should take in its interaction with the user. The following values are possible:

- `Close` – Indicates that there will not be a response from the user. For example, the statement \"Your order has been placed\" does not require a response.

- `ConfirmIntent` – The next action is asking the user if the intent is complete and ready to be fulfilled. This is a yes/no question such as \"Place the order?\"

- `Delegate` – The next action is determined by Amazon Lex V2.

- `ElicitIntent` – The next action is to elicit an intent from the user.

- `ElicitSlot` – The next action is to elicit a slot value from the user.

" }, "slotToElicit":{ "shape":"NonEmptyString", "documentation":"

The name of the slot that should be elicited from the user.

" }, "slotElicitationStyle":{ "shape":"StyleType", "documentation":"

Configures the slot to use spell-by-letter or spell-by-word style. When you use a style on a slot, users can spell out their input to make it clear to your bot.

- Spell by letter - \"b\" \"o\" \"b\"

- Spell by word - \"b as in boy\" \"o as in oscar\" \"b as in boy\"

For more information, see Using spelling to enter slot values .

" }, "subSlotToElicit":{ "shape":"ElicitSubSlot", "documentation":"

The name of the constituent sub slot of the composite slot specified in slotToElicit that should be elicited from the user.

" } }, "documentation":"

The next action that Amazon Lex V2 should take.

" }, "DialogActionType":{ "type":"string", "enum":[ "Close", "ConfirmIntent", "Delegate", "ElicitIntent", "ElicitSlot", "None" ] }, "DisconnectionEvent":{ "type":"structure", "members":{ "eventId":{ "shape":"EventId", "documentation":"

A unique identifier that your application assigns to the event. You can use this to identify events in logs.

" }, "clientTimestampMillis":{ "shape":"EpochMillis", "documentation":"

A timestamp set by the client of the date and time that the event was sent to Amazon Lex V2.

" } }, "documentation":"

A notification from the client that it is disconnecting from Amazon Lex V2. Sending a `DisconnectionEvent` event is optional, but can help identify a conversation in logs.

", "event":true }, "Double":{"type":"double"}, "ElicitSubSlot":{ "type":"structure", "required":["name"], "members":{ "name":{ "shape":"NonEmptyString", "documentation":"

The name of the slot that should be elicited from the user.

" }, "subSlotToElicit":{ "shape":"ElicitSubSlot", "documentation":"

The field is not supported.

" } }, "documentation":"

The specific constituent sub slot of the composite slot to elicit in dialog action.

" }, "EpochMillis":{"type":"long"}, "EventId":{ "type":"string", "max":100, "min":2, "pattern":"[0-9a-zA-Z._:-]+" }, "GetSessionRequest":{ "type":"structure", "required":[ "botId", "botAliasId", "localeId", "sessionId" ], "members":{ "botId":{ "shape":"BotIdentifier", "documentation":"

The identifier of the bot that contains the session data.

", "location":"uri", "locationName":"botId" }, "botAliasId":{ "shape":"BotAliasIdentifier", "documentation":"

The alias identifier in use for the bot that contains the session data.

", "location":"uri", "locationName":"botAliasId" }, "localeId":{ "shape":"LocaleId", "documentation":"

The locale where the session is in use.

", "location":"uri", "locationName":"localeId" }, "sessionId":{ "shape":"SessionId", "documentation":"

The identifier of the session to return.

", "location":"uri", "locationName":"sessionId" } } }, "GetSessionResponse":{ "type":"structure", "members":{ "sessionId":{ "shape":"NonEmptyString", "documentation":"

The identifier of the returned session.

" }, "messages":{ "shape":"Messages", "documentation":"

A list of messages that were last sent to the user. The messages are ordered based on the order that your returned the messages from your Lambda function or the order that messages are defined in the bot.

" }, "interpretations":{ "shape":"Interpretations", "documentation":"

A list of intents that Amazon Lex V2 determined might satisfy the user's utterance.

Each interpretation includes the intent, a score that indicates how confident Amazon Lex V2 is that the interpretation is the correct one, and an optional sentiment response that indicates the sentiment expressed in the utterance.

" }, "sessionState":{ "shape":"SessionState", "documentation":"

Represents the current state of the dialog between the user and the bot.

You can use this to determine the progress of the conversation and what the next action might be.

" } } }, "HeartbeatEvent":{ "type":"structure", "members":{ "eventId":{ "shape":"EventId", "documentation":"

A unique identifier of the event sent by Amazon Lex V2. The identifier is in the form `RESPONSE-N`, where N is a number starting with one and incremented for each event sent by Amazon Lex V2 in the current session.

" } }, "documentation":"

Event that Amazon Lex V2 sends to indicate that the stream is still open between the client application and Amazon Lex V2

", "event":true }, "ImageResponseCard":{ "type":"structure", "required":["title"], "members":{ "title":{ "shape":"AttachmentTitle", "documentation":"

The title to display on the response card. The format of the title is determined by the platform displaying the response card.

" }, "subtitle":{ "shape":"AttachmentTitle", "documentation":"

The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

" }, "imageUrl":{ "shape":"AttachmentUrl", "documentation":"

The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

" }, "buttons":{ "shape":"ButtonsList", "documentation":"

A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

" } }, "documentation":"

A card that is shown to the user by a messaging platform. You define the contents of the card, the card is displayed by the platform.

When you use a response card, the response from the user is constrained to the text associated with a button on the card.

" }, "InputMode":{ "type":"string", "enum":[ "Text", "Speech", "DTMF" ] }, "Intent":{ "type":"structure", "required":["name"], "members":{ "name":{ "shape":"NonEmptyString", "documentation":"

The name of the intent.

" }, "slots":{ "shape":"Slots", "documentation":"

A map of all of the slots for the intent. The name of the slot maps to the value of the slot. If a slot has not been filled, the value is null.

" }, "state":{ "shape":"IntentState", "documentation":"

Indicates the fulfillment state for the intent. The meanings of each value are as follows:

- `Failed` – The bot failed to fulfill the intent.

- `Fulfilled` – The bot has completed fulfillment of the intent.

- `FulfillmentInProgress` – The bot is in the middle of fulfilling the intent.

- `InProgress` – The bot is in the middle of eliciting the slot values that are necessary to fulfill the intent.

- `ReadyForFulfillment` – The bot has elicited all the slot values for the intent and is ready to fulfill the intent.

- `Waiting` – The bot is waiting for a response from the user (limited to streaming conversations).

" }, "confirmationState":{ "shape":"ConfirmationState", "documentation":"

Indicates whether the intent has been `Confirmed`, `Denied`, or `None` if the confirmation stage has not yet been reached.

" } }, "documentation":"

The current intent that Amazon Lex V2 is attempting to fulfill.

" }, "IntentResultEvent":{ "type":"structure", "members":{ "inputMode":{ "shape":"InputMode", "documentation":"

Indicates whether the input to the operation was text, speech, or from a touch-tone keypad.

" }, "interpretations":{ "shape":"Interpretations", "documentation":"

A list of intents that Amazon Lex V2 determined might satisfy the user's utterance.

Each interpretation includes the intent, a score that indicates how confident Amazon Lex V2 is that the interpretation is the correct one, and an optional sentiment response that indicates the sentiment expressed in the utterance.

" }, "sessionState":{"shape":"SessionState"}, "requestAttributes":{ "shape":"StringMap", "documentation":"

The attributes sent in the request.

" }, "sessionId":{ "shape":"SessionId", "documentation":"

The identifier of the session in use.

" }, "eventId":{ "shape":"EventId", "documentation":"

A unique identifier of the event sent by Amazon Lex V2. The identifier is in the form `RESPONSE-N`, where N is a number starting with one and incremented for each event sent by Amazon Lex V2 in the current session.

" }, "recognizedBotMember":{ "shape":"RecognizedBotMember", "documentation":"

The bot member that is processing the intent.

" } }, "documentation":"

Contains the current state of the conversation between the client application and Amazon Lex V2.

", "event":true }, "IntentState":{ "type":"string", "enum":[ "Failed", "Fulfilled", "InProgress", "ReadyForFulfillment", "Waiting", "FulfillmentInProgress" ] }, "InternalServerException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

", "error":{"httpStatusCode":500}, "exception":true, "fault":true }, "Interpretation":{ "type":"structure", "members":{ "nluConfidence":{ "shape":"ConfidenceScore", "documentation":"

Determines the threshold where Amazon Lex V2 will insert the `AMAZON.FallbackIntent`, `AMAZON.KendraSearchIntent`, or both when returning alternative intents in a response. `AMAZON.FallbackIntent` and `AMAZON.KendraSearchIntent` are only inserted if they are configured for the bot.

" }, "sentimentResponse":{ "shape":"SentimentResponse", "documentation":"

The sentiment expressed in an utterance.

When the bot is configured to send utterances to Amazon Comprehend for sentiment analysis, this field contains the result of the analysis.

" }, "intent":{ "shape":"Intent", "documentation":"

A list of intents that might satisfy the user's utterance. The intents are ordered by the confidence score.

" }, "interpretationSource":{ "shape":"InterpretationSource", "documentation":"

Specifies the service that interpreted the input.

" } }, "documentation":"

An object containing information about an intent that Amazon Lex V2 determined might satisfy the user's utterance. The intents are ordered by the confidence score.

" }, "InterpretationSource":{ "type":"string", "enum":[ "Bedrock", "Lex" ] }, "Interpretations":{ "type":"list", "member":{"shape":"Interpretation"}, "max":5 }, "LocaleId":{ "type":"string", "min":1 }, "Message":{ "type":"structure", "required":["contentType"], "members":{ "content":{ "shape":"Text", "documentation":"

The text of the message.

" }, "contentType":{ "shape":"MessageContentType", "documentation":"

Indicates the type of response.

" }, "imageResponseCard":{"shape":"ImageResponseCard"} }, "documentation":"

Container for text that is returned to the customer..

" }, "MessageContentType":{ "type":"string", "enum":[ "CustomPayload", "ImageResponseCard", "PlainText", "SSML" ] }, "Messages":{ "type":"list", "member":{"shape":"Message"}, "max":10 }, "Name":{ "type":"string", "max":100, "min":1, "pattern":"^([0-9a-zA-Z][_-]?)+$" }, "NonEmptyString":{ "type":"string", "min":1 }, "ParameterName":{ "type":"string", "max":100, "min":1 }, "PlaybackCompletionEvent":{ "type":"structure", "members":{ "eventId":{ "shape":"EventId", "documentation":"

A unique identifier that your application assigns to the event. You can use this to identify events in logs.

" }, "clientTimestampMillis":{ "shape":"EpochMillis", "documentation":"

A timestamp set by the client of the date and time that the event was sent to Amazon Lex V2.

" } }, "documentation":"

Event sent from the client application to Amazon Lex V2 to indicate that playback of audio is complete and that Amazon Lex V2 should start processing the user's input.

", "event":true }, "PlaybackInterruptionEvent":{ "type":"structure", "members":{ "eventReason":{ "shape":"PlaybackInterruptionReason", "documentation":"

Indicates the type of user input that Amazon Lex V2 detected.

" }, "causedByEventId":{ "shape":"EventId", "documentation":"

The identifier of the event that contained the audio, DTMF, or text that caused the interruption.

" }, "eventId":{ "shape":"EventId", "documentation":"

A unique identifier of the event sent by Amazon Lex V2. The identifier is in the form `RESPONSE-N`, where N is a number starting with one and incremented for each event sent by Amazon Lex V2 in the current session.

" } }, "documentation":"

Event sent from Amazon Lex V2 to indicate to the client application should stop playback of audio. For example, if the client is playing a prompt that asks for the user's telephone number, the user might start to say the phone number before the prompt is complete. Amazon Lex V2 sends this event to the client application to indicate that the user is responding and that Amazon Lex V2 is processing their input.

", "event":true }, "PlaybackInterruptionReason":{ "type":"string", "enum":[ "DTMF_START_DETECTED", "TEXT_DETECTED", "VOICE_START_DETECTED" ] }, "PutSessionRequest":{ "type":"structure", "required":[ "botId", "botAliasId", "localeId", "sessionState", "sessionId" ], "members":{ "botId":{ "shape":"BotIdentifier", "documentation":"

The identifier of the bot that receives the session data.

", "location":"uri", "locationName":"botId" }, "botAliasId":{ "shape":"BotAliasIdentifier", "documentation":"

The alias identifier of the bot that receives the session data.

", "location":"uri", "locationName":"botAliasId" }, "localeId":{ "shape":"LocaleId", "documentation":"

The locale where the session is in use.

", "location":"uri", "locationName":"localeId" }, "sessionId":{ "shape":"SessionId", "documentation":"

The identifier of the session that receives the session data.

", "location":"uri", "locationName":"sessionId" }, "messages":{ "shape":"Messages", "documentation":"

A list of messages to send to the user. Messages are sent in the order that they are defined in the list.

" }, "sessionState":{ "shape":"SessionState", "documentation":"

Sets the state of the session with the user. You can use this to set the current intent, attributes, context, and dialog action. Use the dialog action to determine the next step that Amazon Lex V2 should use in the conversation with the user.

" }, "requestAttributes":{ "shape":"StringMap", "documentation":"

Request-specific information passed between Amazon Lex V2 and the client application.

The namespace `x-amz-lex:` is reserved for special attributes. Don't create any request attributes with the prefix `x-amz-lex:`.

" }, "responseContentType":{ "shape":"NonEmptyString", "documentation":"

The message that Amazon Lex V2 returns in the response can be either text or speech depending on the value of this parameter.

- If the value is `text/plain; charset=utf-8`, Amazon Lex V2 returns text in the response.

", "location":"header", "locationName":"ResponseContentType" } } }, "PutSessionResponse":{ "type":"structure", "members":{ "contentType":{ "shape":"NonEmptyString", "documentation":"

The type of response. Same as the type specified in the `responseContentType` field in the request.

", "location":"header", "locationName":"Content-Type" }, "messages":{ "shape":"NonEmptyString", "documentation":"

A list of messages that were last sent to the user. The messages are ordered based on how you return the messages from you Lambda function or the order that the messages are defined in the bot.

", "location":"header", "locationName":"x-amz-lex-messages" }, "sessionState":{ "shape":"NonEmptyString", "documentation":"

A base-64-encoded gzipped field that represents the current state of the dialog between the user and the bot. Use this to determine the progress of the conversation and what the next action may be.

", "location":"header", "locationName":"x-amz-lex-session-state" }, "requestAttributes":{ "shape":"NonEmptyString", "documentation":"

A base-64-encoded gzipped field that provides request-specific information passed between the client application and Amazon Lex V2. These are the same as the `requestAttribute` parameter in the call to the `PutSession` operation.

", "location":"header", "locationName":"x-amz-lex-request-attributes" }, "sessionId":{ "shape":"SessionId", "documentation":"

The identifier of the session that received the data.

", "location":"header", "locationName":"x-amz-lex-session-id" }, "audioStream":{ "shape":"BlobStream", "documentation":"

If the requested content type was audio, the audio version of the message to convey to the user.

" } }, "payload":"audioStream" }, "RecognizeTextRequest":{ "type":"structure", "required":[ "botId", "botAliasId", "localeId", "text", "sessionId" ], "members":{ "botId":{ "shape":"BotIdentifier", "documentation":"

The identifier of the bot that processes the request.

", "location":"uri", "locationName":"botId" }, "botAliasId":{ "shape":"BotAliasIdentifier", "documentation":"

The alias identifier in use for the bot that processes the request.

", "location":"uri", "locationName":"botAliasId" }, "localeId":{ "shape":"LocaleId", "documentation":"

The locale where the session is in use.

", "location":"uri", "locationName":"localeId" }, "sessionId":{ "shape":"SessionId", "documentation":"

The identifier of the user session that is having the conversation.

", "location":"uri", "locationName":"sessionId" }, "text":{ "shape":"Text", "documentation":"

The text that the user entered. Amazon Lex V2 interprets this text.

" }, "sessionState":{ "shape":"SessionState", "documentation":"

The current state of the dialog between the user and the bot.

" }, "requestAttributes":{ "shape":"StringMap", "documentation":"

Request-specific information passed between the client application and Amazon Lex V2

The namespace `x-amz-lex:` is reserved for special attributes. Don't create any request attributes with the prefix `x-amz-lex:`.

" } } }, "RecognizeTextResponse":{ "type":"structure", "members":{ "messages":{ "shape":"Messages", "documentation":"

A list of messages last sent to the user. The messages are ordered based on the order that you returned the messages from your Lambda function or the order that the messages are defined in the bot.

" }, "sessionState":{ "shape":"SessionState", "documentation":"

Represents the current state of the dialog between the user and the bot.

Use this to determine the progress of the conversation and what the next action may be.

" }, "interpretations":{ "shape":"Interpretations", "documentation":"

A list of intents that Amazon Lex V2 determined might satisfy the user's utterance.

Each interpretation includes the intent, a score that indicates now confident Amazon Lex V2 is that the interpretation is the correct one, and an optional sentiment response that indicates the sentiment expressed in the utterance.

" }, "requestAttributes":{ "shape":"StringMap", "documentation":"

The attributes sent in the request.

" }, "sessionId":{ "shape":"SessionId", "documentation":"

The identifier of the session in use.

" }, "recognizedBotMember":{ "shape":"RecognizedBotMember", "documentation":"

The bot member that recognized the text.

" } } }, "RecognizeUtteranceRequest":{ "type":"structure", "required":[ "botId", "botAliasId", "localeId", "requestContentType", "sessionId" ], "members":{ "botId":{ "shape":"BotIdentifier", "documentation":"

The identifier of the bot that should receive the request.

", "location":"uri", "locationName":"botId" }, "botAliasId":{ "shape":"BotAliasIdentifier", "documentation":"

The alias identifier in use for the bot that should receive the request.

", "location":"uri", "locationName":"botAliasId" }, "localeId":{ "shape":"LocaleId", "documentation":"

The locale where the session is in use.

", "location":"uri", "locationName":"localeId" }, "sessionId":{ "shape":"SessionId", "documentation":"

The identifier of the session in use.

", "location":"uri", "locationName":"sessionId" }, "sessionState":{ "shape":"SensitiveNonEmptyString", "documentation":"

Sets the state of the session with the user. You can use this to set the current intent, attributes, context, and dialog action. Use the dialog action to determine the next step that Amazon Lex V2 should use in the conversation with the user.

The `sessionState` field must be compressed using gzip and then base64 encoded before sending to Amazon Lex V2.

", "location":"header", "locationName":"x-amz-lex-session-state" }, "requestAttributes":{ "shape":"SensitiveNonEmptyString", "documentation":"

Request-specific information passed between the client application and Amazon Lex V2

The namespace `x-amz-lex:` is reserved for special attributes. Don't create any request attributes for prefix `x-amz-lex:`.

The `requestAttributes` field must be compressed using gzip and then base64 encoded before sending to Amazon Lex V2.

", "location":"header", "locationName":"x-amz-lex-request-attributes" }, "requestContentType":{ "shape":"NonEmptyString", "documentation":"

Indicates the format for audio input or that the content is text. The header 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

", "location":"header", "locationName":"Content-Type" }, "responseContentType":{ "shape":"NonEmptyString", "documentation":"

The message that Amazon Lex V2 returns in the response can be either text or speech based on the `responseContentType` value.

- If the value is `text/plain;charset=utf-8`, Amazon Lex V2 returns text in the response.

- If the value begins with `audio/`, Amazon Lex V2 returns speech in the response. Amazon Lex V2 uses Amazon Polly to generate the speech using the configuration that you specified in the `responseContentType` parameter. For example, if you specify `audio/mpeg` as the value, Amazon Lex V2 returns speech in the MPEG format.

- If the value is `audio/pcm`, the speech returned is `audio/pcm` at 16 KHz in 16-bit, little-endian format.

- The following are the accepted values:

  - audio/mpeg

  - audio/ogg

  - audio/pcm (16 KHz)

  - audio/* (defaults to mpeg)

  - text/plain; charset=utf-8

", "location":"header", "locationName":"Response-Content-Type" }, "inputStream":{ "shape":"BlobStream", "documentation":"

User input in PCM or Opus audio format or text format as described in the `requestContentType` parameter.

" } }, "payload":"inputStream" }, "RecognizeUtteranceResponse":{ "type":"structure", "members":{ "inputMode":{ "shape":"NonEmptyString", "documentation":"

Indicates whether the input mode to the operation was text, speech, or from a touch-tone keypad.

", "location":"header", "locationName":"x-amz-lex-input-mode" }, "contentType":{ "shape":"NonEmptyString", "documentation":"

Content type as specified in the `responseContentType` in the request.

", "location":"header", "locationName":"Content-Type" }, "messages":{ "shape":"NonEmptyString", "documentation":"

A list of messages that were last sent to the user. The messages are ordered based on the order that you returned the messages from your Lambda function or the order that the messages are defined in the bot.

The `messages` field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents. See the example for a simple function to decode and decompress the contents.

", "location":"header", "locationName":"x-amz-lex-messages" }, "interpretations":{ "shape":"NonEmptyString", "documentation":"

A list of intents that Amazon Lex V2 determined might satisfy the user's utterance.

Each interpretation includes the intent, a score that indicates how confident Amazon Lex V2 is that the interpretation is the correct one, and an optional sentiment response that indicates the sentiment expressed in the utterance.

The `interpretations` field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents. See the example for a simple function to decode and decompress the contents.

", "location":"header", "locationName":"x-amz-lex-interpretations" }, "sessionState":{ "shape":"NonEmptyString", "documentation":"

Represents the current state of the dialog between the user and the bot.

Use this to determine the progress of the conversation and what the next action might be.

The `sessionState` field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents. See the example for a simple function to decode and decompress the contents.

", "location":"header", "locationName":"x-amz-lex-session-state" }, "requestAttributes":{ "shape":"NonEmptyString", "documentation":"

The attributes sent in the request.

The `requestAttributes` field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents.

", "location":"header", "locationName":"x-amz-lex-request-attributes" }, "sessionId":{ "shape":"SessionId", "documentation":"

The identifier of the session in use.

", "location":"header", "locationName":"x-amz-lex-session-id" }, "inputTranscript":{ "shape":"NonEmptyString", "documentation":"

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 V2 is correctly processing the audio that you send.

The `inputTranscript` field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents. See the example for a simple function to decode and decompress the contents.

", "location":"header", "locationName":"x-amz-lex-input-transcript" }, "audioStream":{ "shape":"BlobStream", "documentation":"

The prompt or statement to send to the user. This is based on the bot configuration and context. For example, if Amazon Lex V2 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 V2 sends that message in the response.

" }, "recognizedBotMember":{ "shape":"NonEmptyString", "documentation":"

The bot member that recognized the utterance.

", "location":"header", "locationName":"x-amz-lex-recognized-bot-member" } }, "payload":"audioStream" }, "RecognizedBotMember":{ "type":"structure", "required":["botId"], "members":{ "botId":{ "shape":"BotIdentifier", "documentation":"

The identifier of the bot member that processes the request.

" }, "botName":{ "shape":"Name", "documentation":"

The name of the bot member that processes the request.

" } }, "documentation":"

The bot member that processes the request.

" }, "ResourceNotFoundException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

", "error":{"httpStatusCode":404}, "exception":true }, "RuntimeHintDetails":{ "type":"structure", "members":{ "runtimeHintValues":{ "shape":"RuntimeHintValuesList", "documentation":"

One or more strings that Amazon Lex V2 should look for in the input to the bot. Each phrase is given preference when deciding on slot values.

" }, "subSlotHints":{ "shape":"SlotHintsSlotMap", "documentation":"

A map of constituent sub slot names inside a composite slot in the intent and the phrases that should be added for each sub slot. Inside each composite slot hints, this structure provides a mechanism to add granular sub slot phrases. Only sub slot hints are supported for composite slots. The intent name, composite slot name and the constituent sub slot names must exist.

" } }, "documentation":"

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

" }, "RuntimeHintPhrase":{ "type":"string", "max":140, "min":1 }, "RuntimeHintValue":{ "type":"structure", "required":["phrase"], "members":{ "phrase":{ "shape":"RuntimeHintPhrase", "documentation":"

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

" } }, "documentation":"

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

" }, "RuntimeHintValuesList":{ "type":"list", "member":{"shape":"RuntimeHintValue"}, "max":100, "min":1 }, "RuntimeHints":{ "type":"structure", "members":{ "slotHints":{ "shape":"SlotHintsIntentMap", "documentation":"

A list of the slots in the intent that should have runtime hints added, and the phrases that should be added for each slot.

The first level of the `slotHints` map is the name of the intent. The second level is the name of the slot within the intent. For more information, see Using hints to improve accuracy.

The intent name and slot name must exist.

" } }, "documentation":"

You can provide Amazon Lex V2 with hints to the phrases that a customer is likely to use for a slot. When a slot with hints is resolved, the phrases in the runtime hints are preferred in the resolution. You can provide hints for a maximum of 100 intents. You can provide a maximum of 100 slots.

Before you can use runtime hints with an existing bot, you must first rebuild the bot.

For more information, see Using runtime hints to improve recognition of slot values.

" }, "SensitiveNonEmptyString":{ "type":"string", "sensitive":true }, "SentimentResponse":{ "type":"structure", "members":{ "sentiment":{ "shape":"SentimentType", "documentation":"

The overall sentiment expressed in the user's response. This is the sentiment most likely expressed by the user based on the analysis by Amazon Comprehend.

" }, "sentimentScore":{"shape":"SentimentScore"} }, "documentation":"

Provides information about the sentiment expressed in a user's response in a conversation. Sentiments are determined using Amazon Comprehend. Sentiments are only returned if they are enabled for the bot.

For more information, see Determine Sentiment in the Amazon Comprehend developer guide.

" }, "SentimentScore":{ "type":"structure", "members":{ "positive":{ "shape":"Double", "documentation":"

The level of confidence that Amazon Comprehend has in the accuracy of its detection of the `POSITIVE` sentiment.

" }, "negative":{ "shape":"Double", "documentation":"

The level of confidence that Amazon Comprehend has in the accuracy of its detection of the `NEGATIVE` sentiment.

" }, "neutral":{ "shape":"Double", "documentation":"

The level of confidence that Amazon Comprehend has in the accuracy of its detection of the `NEUTRAL` sentiment.

" }, "mixed":{ "shape":"Double", "documentation":"

The level of confidence that Amazon Comprehend has in the accuracy of its detection of the `MIXED` sentiment.

" } }, "documentation":"

The individual sentiment responses for the utterance.

" }, "SentimentType":{ "type":"string", "enum":[ "MIXED", "NEGATIVE", "NEUTRAL", "POSITIVE" ] }, "SessionId":{ "type":"string", "max":100, "min":2, "pattern":"[0-9a-zA-Z._:-]+" }, "SessionState":{ "type":"structure", "members":{ "dialogAction":{ "shape":"DialogAction", "documentation":"

The next step that Amazon Lex V2 should take in the conversation with a user.

" }, "intent":{ "shape":"Intent", "documentation":"

The active intent that Amazon Lex V2 is processing.

" }, "activeContexts":{ "shape":"ActiveContextsList", "documentation":"

One or more contexts that indicate to Amazon Lex V2 the context of a request. When a context is active, Amazon Lex V2 considers intents with the matching context as a trigger as the next intent in a session.

" }, "sessionAttributes":{ "shape":"StringMap", "documentation":"

Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex V2 and a client application.

" }, "originatingRequestId":{ "shape":"NonEmptyString", "documentation":"

A unique identifier for a specific request.

" }, "runtimeHints":{ "shape":"RuntimeHints", "documentation":"

Hints for phrases that a customer is likely to use for a slot. Amazon Lex V2 uses the hints to help determine the correct value of a slot.

" } }, "documentation":"

The state of the user's session with Amazon Lex V2.

" }, "Shape":{ "type":"string", "enum":[ "Scalar", "List", "Composite" ] }, "Slot":{ "type":"structure", "members":{ "value":{ "shape":"Value", "documentation":"

The current value of the slot.

" }, "shape":{ "shape":"Shape", "documentation":"

When the `shape` value is `List`, it indicates that the `values` field contains a list of slot values. When the value is `Scalar`, it indicates that the `value` field contains a single value.

" }, "values":{ "shape":"Values", "documentation":"

A list of one or more values that the user provided for the slot. For example, if a for a slot that elicits pizza toppings, the values might be \"pepperoni\" and \"pineapple.\"

" }, "subSlots":{ "shape":"Slots", "documentation":"

The constituent sub slots of a composite slot.

" } }, "documentation":"

A value that Amazon Lex V2 uses to fulfill an intent.

" }, "SlotHintsIntentMap":{ "type":"map", "key":{"shape":"Name"}, "value":{"shape":"SlotHintsSlotMap"} }, "SlotHintsSlotMap":{ "type":"map", "key":{"shape":"Name"}, "value":{"shape":"RuntimeHintDetails"} }, "Slots":{ "type":"map", "key":{"shape":"NonEmptyString"}, "value":{"shape":"Slot"} }, "StartConversationRequest":{ "type":"structure", "required":[ "botId", "botAliasId", "localeId", "requestEventStream", "sessionId" ], "members":{ "botId":{ "shape":"BotIdentifier", "documentation":"

The identifier of the bot to process the request.

", "location":"uri", "locationName":"botId" }, "botAliasId":{ "shape":"BotAliasIdentifier", "documentation":"

The alias identifier in use for the bot that processes the request.

", "location":"uri", "locationName":"botAliasId" }, "localeId":{ "shape":"LocaleId", "documentation":"

The locale where the session is in use.

", "location":"uri", "locationName":"localeId" }, "sessionId":{ "shape":"SessionId", "documentation":"

The identifier of the user session that is having the conversation.

", "location":"uri", "locationName":"sessionId" }, "conversationMode":{ "shape":"ConversationMode", "documentation":"

The conversation type that you are using the Amazon Lex V2. If the conversation mode is `AUDIO` you can send both audio and DTMF information. If the mode is `TEXT` you can only send text.

", "location":"header", "locationName":"x-amz-lex-conversation-mode" }, "requestEventStream":{ "shape":"StartConversationRequestEventStream", "documentation":"

Represents the stream of events to Amazon Lex V2 from your application. The events are encoded as HTTP/2 data frames.

" } }, "payload":"requestEventStream" }, "StartConversationRequestEventStream":{ "type":"structure", "members":{ "ConfigurationEvent":{ "shape":"ConfigurationEvent", "documentation":"

Configuration information sent from your client application to Amazon Lex V2

" }, "AudioInputEvent":{ "shape":"AudioInputEvent", "documentation":"

Speech audio sent from your client application to Amazon Lex V2. Audio starts accumulating when Amazon Lex V2 identifies a voice and continues until a natural pause in the speech is found before processing.

" }, "DTMFInputEvent":{ "shape":"DTMFInputEvent", "documentation":"

DTMF information sent to Amazon Lex V2 by your application. Amazon Lex V2 accumulates the DMTF information from when the user sends the first character and ends

- when there's a pause longer that the value configured for the end timeout.

- when there's a digit that is the configured end character.

- when Amazon Lex V2 accumulates characters equal to the maximum DTMF character configuration.

" }, "TextInputEvent":{ "shape":"TextInputEvent", "documentation":"

Text sent from your client application to Amazon Lex V2. Each `TextInputEvent` is processed individually.

" }, "PlaybackCompletionEvent":{ "shape":"PlaybackCompletionEvent", "documentation":"

Event sent from the client application to Amazon Lex V2 to indicate that it has finished playing audio and that Amazon Lex V2 should start listening for user input.

" }, "DisconnectionEvent":{ "shape":"DisconnectionEvent", "documentation":"

Event sent from the client application to indicate to Amazon Lex V2 that the conversation is over.

" } }, "documentation":"

Represents a stream of events between your application and Amazon Lex V2.

", "eventstream":true }, "StartConversationResponse":{ "type":"structure", "members":{ "responseEventStream":{ "shape":"StartConversationResponseEventStream", "documentation":"

Represents the stream of events from Amazon Lex V2 to your application. The events are encoded as HTTP/2 data frames.

" } }, "payload":"responseEventStream" }, "StartConversationResponseEventStream":{ "type":"structure", "members":{ "PlaybackInterruptionEvent":{"shape":"PlaybackInterruptionEvent"}, "TranscriptEvent":{"shape":"TranscriptEvent"}, "IntentResultEvent":{ "shape":"IntentResultEvent", "documentation":"

Event sent from Amazon Lex V2 to the client application containing the current state of the conversation between the user and Amazon Lex V2.

" }, "TextResponseEvent":{"shape":"TextResponseEvent"}, "AudioResponseEvent":{"shape":"AudioResponseEvent"}, "HeartbeatEvent":{"shape":"HeartbeatEvent"}, "AccessDeniedException":{ "shape":"AccessDeniedException", "documentation":"

Exception thrown when the credentials passed with the request are invalid or expired. Also thrown when the credentials in the request do not have permission to access the `StartConversation` operation.

" }, "ResourceNotFoundException":{ "shape":"ResourceNotFoundException", "documentation":"

Exception thrown if one of the input parameters points to a resource that does not exist. For example, if the bot ID specified does not exist.

" }, "ValidationException":{ "shape":"ValidationException", "documentation":"

Exception thrown when one or more parameters could not be validated. The `message` contains the name of the field that isn't valid.

" }, "ThrottlingException":{ "shape":"ThrottlingException", "documentation":"

Exception thrown when your application exceeds the maximum number of concurrent requests.

" }, "InternalServerException":{ "shape":"InternalServerException", "documentation":"

An error occurred with Amazon Lex V2.

" }, "ConflictException":{ "shape":"ConflictException", "documentation":"

Exception thrown when two clients are using the same AWS account, Amazon Lex V2 bot, and session ID.

" }, "DependencyFailedException":{"shape":"DependencyFailedException"}, "BadGatewayException":{"shape":"BadGatewayException"} }, "documentation":"

Represents a stream of events between Amazon Lex V2 and your application.

", "eventstream":true }, "String":{"type":"string"}, "StringList":{ "type":"list", "member":{"shape":"NonEmptyString"} }, "StringMap":{ "type":"map", "key":{"shape":"NonEmptyString"}, "value":{"shape":"String"} }, "StyleType":{ "type":"string", "enum":[ "Default", "SpellByLetter", "SpellByWord" ] }, "Text":{ "type":"string", "max":1024, "min":1, "sensitive":true }, "TextInputEvent":{ "type":"structure", "required":["text"], "members":{ "text":{ "shape":"Text", "documentation":"

The text from the user. Amazon Lex V2 processes this as a complete statement.

" }, "eventId":{ "shape":"EventId", "documentation":"

A unique identifier that your application assigns to the event. You can use this to identify events in logs.

" }, "clientTimestampMillis":{ "shape":"EpochMillis", "documentation":"

A timestamp set by the client of the date and time that the event was sent to Amazon Lex V2.

" } }, "documentation":"

The event sent from your client application to Amazon Lex V2 with text input from the user.

", "event":true }, "TextResponseEvent":{ "type":"structure", "members":{ "messages":{ "shape":"Messages", "documentation":"

A list of messages to send to the user. Messages are ordered based on the order that you returned the messages from your Lambda function or the order that the messages are defined in the bot.

" }, "eventId":{ "shape":"EventId", "documentation":"

A unique identifier of the event sent by Amazon Lex V2. The identifier is in the form `RESPONSE-N`, where N is a number starting with one and incremented for each event sent by Amazon Lex V2 in the current session.

" } }, "documentation":"

The event sent from Amazon Lex V2 to your application with text to present to the user.

", "event":true }, "ThrottlingException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

", "error":{"httpStatusCode":429}, "exception":true }, "TranscriptEvent":{ "type":"structure", "members":{ "transcript":{ "shape":"String", "documentation":"

The transcript of the voice audio from the user.

" }, "eventId":{ "shape":"EventId", "documentation":"

A unique identifier of the event sent by Amazon Lex V2. The identifier is in the form `RESPONSE-N`, where N is a number starting with one and incremented for each event sent by Amazon Lex V2 in the current session.

" } }, "documentation":"

Event sent from Amazon Lex V2 to your client application that contains a transcript of voice audio.

", "event":true }, "ValidationException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

", "error":{"httpStatusCode":400}, "exception":true }, "Value":{ "type":"structure", "required":["interpretedValue"], "members":{ "originalValue":{ "shape":"NonEmptyString", "documentation":"

The part of the user's response to the slot elicitation that Amazon Lex V2 determines is relevant to the slot value.

" }, "interpretedValue":{ "shape":"NonEmptyString", "documentation":"

The value that Amazon Lex V2 determines for the slot, given the user input. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex V2 choose the first value in the `resolvedValues` list.

" }, "resolvedValues":{ "shape":"StringList", "documentation":"

A list of values that Amazon Lex V2 determines are possible resolutions for the user input. The first value matches the `interpretedValue`.

" } }, "documentation":"

Information about the value provided for a slot and Amazon Lex V2's interpretation.

" }, "Values":{ "type":"list", "member":{"shape":"Slot"} } }, "documentation":"

This section contains documentation for the Amazon Lex V2 Runtime V2 API operations.

" }