Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Returns metadata about an intent.
Synopsis
- data DescribeIntent = DescribeIntent' {}
- newDescribeIntent :: Text -> Text -> Text -> Text -> DescribeIntent
- describeIntent_intentId :: Lens' DescribeIntent Text
- describeIntent_botId :: Lens' DescribeIntent Text
- describeIntent_botVersion :: Lens' DescribeIntent Text
- describeIntent_localeId :: Lens' DescribeIntent Text
- data DescribeIntentResponse = DescribeIntentResponse' {
- botId :: Maybe Text
- botVersion :: Maybe Text
- creationDateTime :: Maybe POSIX
- description :: Maybe Text
- dialogCodeHook :: Maybe DialogCodeHookSettings
- fulfillmentCodeHook :: Maybe FulfillmentCodeHookSettings
- initialResponseSetting :: Maybe InitialResponseSetting
- inputContexts :: Maybe [InputContext]
- intentClosingSetting :: Maybe IntentClosingSetting
- intentConfirmationSetting :: Maybe IntentConfirmationSetting
- intentId :: Maybe Text
- intentName :: Maybe Text
- kendraConfiguration :: Maybe KendraConfiguration
- lastUpdatedDateTime :: Maybe POSIX
- localeId :: Maybe Text
- outputContexts :: Maybe [OutputContext]
- parentIntentSignature :: Maybe Text
- sampleUtterances :: Maybe [SampleUtterance]
- slotPriorities :: Maybe [SlotPriority]
- httpStatus :: Int
- newDescribeIntentResponse :: Int -> DescribeIntentResponse
- describeIntentResponse_botId :: Lens' DescribeIntentResponse (Maybe Text)
- describeIntentResponse_botVersion :: Lens' DescribeIntentResponse (Maybe Text)
- describeIntentResponse_creationDateTime :: Lens' DescribeIntentResponse (Maybe UTCTime)
- describeIntentResponse_description :: Lens' DescribeIntentResponse (Maybe Text)
- describeIntentResponse_dialogCodeHook :: Lens' DescribeIntentResponse (Maybe DialogCodeHookSettings)
- describeIntentResponse_fulfillmentCodeHook :: Lens' DescribeIntentResponse (Maybe FulfillmentCodeHookSettings)
- describeIntentResponse_initialResponseSetting :: Lens' DescribeIntentResponse (Maybe InitialResponseSetting)
- describeIntentResponse_inputContexts :: Lens' DescribeIntentResponse (Maybe [InputContext])
- describeIntentResponse_intentClosingSetting :: Lens' DescribeIntentResponse (Maybe IntentClosingSetting)
- describeIntentResponse_intentConfirmationSetting :: Lens' DescribeIntentResponse (Maybe IntentConfirmationSetting)
- describeIntentResponse_intentId :: Lens' DescribeIntentResponse (Maybe Text)
- describeIntentResponse_intentName :: Lens' DescribeIntentResponse (Maybe Text)
- describeIntentResponse_kendraConfiguration :: Lens' DescribeIntentResponse (Maybe KendraConfiguration)
- describeIntentResponse_lastUpdatedDateTime :: Lens' DescribeIntentResponse (Maybe UTCTime)
- describeIntentResponse_localeId :: Lens' DescribeIntentResponse (Maybe Text)
- describeIntentResponse_outputContexts :: Lens' DescribeIntentResponse (Maybe [OutputContext])
- describeIntentResponse_parentIntentSignature :: Lens' DescribeIntentResponse (Maybe Text)
- describeIntentResponse_sampleUtterances :: Lens' DescribeIntentResponse (Maybe [SampleUtterance])
- describeIntentResponse_slotPriorities :: Lens' DescribeIntentResponse (Maybe [SlotPriority])
- describeIntentResponse_httpStatus :: Lens' DescribeIntentResponse Int
Creating a Request
data DescribeIntent Source #
See: newDescribeIntent
smart constructor.
DescribeIntent' | |
|
Instances
:: Text | |
-> Text | |
-> Text | |
-> Text | |
-> DescribeIntent |
Create a value of DescribeIntent
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeIntent
, describeIntent_intentId
- The identifier of the intent to describe.
DescribeIntent
, describeIntent_botId
- The identifier of the bot associated with the intent.
DescribeIntent
, describeIntent_botVersion
- The version of the bot associated with the intent.
DescribeIntent
, describeIntent_localeId
- The identifier of the language and locale of the intent to describe. The
string must match one of the supported locales. For more information,
see
Supported languages.
Request Lenses
describeIntent_intentId :: Lens' DescribeIntent Text Source #
The identifier of the intent to describe.
describeIntent_botId :: Lens' DescribeIntent Text Source #
The identifier of the bot associated with the intent.
describeIntent_botVersion :: Lens' DescribeIntent Text Source #
The version of the bot associated with the intent.
describeIntent_localeId :: Lens' DescribeIntent Text Source #
The identifier of the language and locale of the intent to describe. The string must match one of the supported locales. For more information, see Supported languages.
Destructuring the Response
data DescribeIntentResponse Source #
See: newDescribeIntentResponse
smart constructor.
DescribeIntentResponse' | |
|
Instances
newDescribeIntentResponse Source #
Create a value of DescribeIntentResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeIntent
, describeIntentResponse_botId
- The identifier of the bot associated with the intent.
DescribeIntent
, describeIntentResponse_botVersion
- The version of the bot associated with the intent.
DescribeIntentResponse
, describeIntentResponse_creationDateTime
- A timestamp of the date and time that the intent was created.
DescribeIntentResponse
, describeIntentResponse_description
- The description of the intent.
$sel:dialogCodeHook:DescribeIntentResponse'
, describeIntentResponse_dialogCodeHook
- The Lambda function called during each turn of a conversation with the
intent.
$sel:fulfillmentCodeHook:DescribeIntentResponse'
, describeIntentResponse_fulfillmentCodeHook
- The Lambda function called when the intent is complete and ready for
fulfillment.
$sel:initialResponseSetting:DescribeIntentResponse'
, describeIntentResponse_initialResponseSetting
-
DescribeIntentResponse
, describeIntentResponse_inputContexts
- A list of contexts that must be active for the intent to be considered
for sending to the user.
$sel:intentClosingSetting:DescribeIntentResponse'
, describeIntentResponse_intentClosingSetting
- The response that Amazon Lex sends to when the intent is closed.
$sel:intentConfirmationSetting:DescribeIntentResponse'
, describeIntentResponse_intentConfirmationSetting
- Prompts that Amazon Lex sends to the user to confirm completion of an
intent.
DescribeIntent
, describeIntentResponse_intentId
- The unique identifier assigned to the intent when it was created.
DescribeIntentResponse
, describeIntentResponse_intentName
- The name specified for the intent.
$sel:kendraConfiguration:DescribeIntentResponse'
, describeIntentResponse_kendraConfiguration
- Configuration information required to use the
AMAZON.KendraSearchIntent
intent.
DescribeIntentResponse
, describeIntentResponse_lastUpdatedDateTime
- A timestamp of the date and time that the intent was last updated.
DescribeIntent
, describeIntentResponse_localeId
- The language and locale specified for the intent.
DescribeIntentResponse
, describeIntentResponse_outputContexts
- A list of contexts that are activated when the intent is fulfilled.
DescribeIntentResponse
, describeIntentResponse_parentIntentSignature
- The identifier of the built-in intent that this intent is derived from,
if any.
DescribeIntentResponse
, describeIntentResponse_sampleUtterances
- User utterances that trigger this intent.
$sel:slotPriorities:DescribeIntentResponse'
, describeIntentResponse_slotPriorities
- The list that determines the priority that slots should be elicited from
the user.
$sel:httpStatus:DescribeIntentResponse'
, describeIntentResponse_httpStatus
- The response's http status code.
Response Lenses
describeIntentResponse_botId :: Lens' DescribeIntentResponse (Maybe Text) Source #
The identifier of the bot associated with the intent.
describeIntentResponse_botVersion :: Lens' DescribeIntentResponse (Maybe Text) Source #
The version of the bot associated with the intent.
describeIntentResponse_creationDateTime :: Lens' DescribeIntentResponse (Maybe UTCTime) Source #
A timestamp of the date and time that the intent was created.
describeIntentResponse_description :: Lens' DescribeIntentResponse (Maybe Text) Source #
The description of the intent.
describeIntentResponse_dialogCodeHook :: Lens' DescribeIntentResponse (Maybe DialogCodeHookSettings) Source #
The Lambda function called during each turn of a conversation with the intent.
describeIntentResponse_fulfillmentCodeHook :: Lens' DescribeIntentResponse (Maybe FulfillmentCodeHookSettings) Source #
The Lambda function called when the intent is complete and ready for fulfillment.
describeIntentResponse_initialResponseSetting :: Lens' DescribeIntentResponse (Maybe InitialResponseSetting) Source #
describeIntentResponse_inputContexts :: Lens' DescribeIntentResponse (Maybe [InputContext]) Source #
A list of contexts that must be active for the intent to be considered for sending to the user.
describeIntentResponse_intentClosingSetting :: Lens' DescribeIntentResponse (Maybe IntentClosingSetting) Source #
The response that Amazon Lex sends to when the intent is closed.
describeIntentResponse_intentConfirmationSetting :: Lens' DescribeIntentResponse (Maybe IntentConfirmationSetting) Source #
Prompts that Amazon Lex sends to the user to confirm completion of an intent.
describeIntentResponse_intentId :: Lens' DescribeIntentResponse (Maybe Text) Source #
The unique identifier assigned to the intent when it was created.
describeIntentResponse_intentName :: Lens' DescribeIntentResponse (Maybe Text) Source #
The name specified for the intent.
describeIntentResponse_kendraConfiguration :: Lens' DescribeIntentResponse (Maybe KendraConfiguration) Source #
Configuration information required to use the
AMAZON.KendraSearchIntent
intent.
describeIntentResponse_lastUpdatedDateTime :: Lens' DescribeIntentResponse (Maybe UTCTime) Source #
A timestamp of the date and time that the intent was last updated.
describeIntentResponse_localeId :: Lens' DescribeIntentResponse (Maybe Text) Source #
The language and locale specified for the intent.
describeIntentResponse_outputContexts :: Lens' DescribeIntentResponse (Maybe [OutputContext]) Source #
A list of contexts that are activated when the intent is fulfilled.
describeIntentResponse_parentIntentSignature :: Lens' DescribeIntentResponse (Maybe Text) Source #
The identifier of the built-in intent that this intent is derived from, if any.
describeIntentResponse_sampleUtterances :: Lens' DescribeIntentResponse (Maybe [SampleUtterance]) Source #
User utterances that trigger this intent.
describeIntentResponse_slotPriorities :: Lens' DescribeIntentResponse (Maybe [SlotPriority]) Source #
The list that determines the priority that slots should be elicited from the user.
describeIntentResponse_httpStatus :: Lens' DescribeIntentResponse Int Source #
The response's http status code.