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

Amazonka.LexV2Models.DescribeIntent

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns metadata about an intent.

Synopsis

data DescribeIntent = DescribeIntent' {
- intentId :: Text
- botId :: Text
- botVersion :: Text
- localeId :: Text
}
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.

Constructors

DescribeIntent'
Fields intentId :: Text The identifier of the intent to describe. botId :: Text The identifier of the bot associated with the intent. botVersion :: Text The version of the bot associated with the intent. localeId :: Text 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.

Instances

Instances details

ToHeaders DescribeIntent Source #
Instance details Defined in Amazonka.LexV2Models.DescribeIntent Methods toHeaders :: DescribeIntent -> [Header] #
ToPath DescribeIntent Source #
Instance details Defined in Amazonka.LexV2Models.DescribeIntent Methods toPath :: DescribeIntent -> ByteString #
ToQuery DescribeIntent Source #
Instance details Defined in Amazonka.LexV2Models.DescribeIntent Methods toQuery :: DescribeIntent -> QueryString #
AWSRequest DescribeIntent Source #
Instance details Defined in Amazonka.LexV2Models.DescribeIntent Associated Types type AWSResponse DescribeIntent # Methods request :: (Service -> Service) -> DescribeIntent -> Request DescribeIntent # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeIntent -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeIntent))) #
Generic DescribeIntent Source #
Instance details Defined in Amazonka.LexV2Models.DescribeIntent Associated Types type Rep DescribeIntent :: Type -> Type # Methods from :: DescribeIntent -> Rep DescribeIntent x # to :: Rep DescribeIntent x -> DescribeIntent #
Read DescribeIntent Source #
Instance details Defined in Amazonka.LexV2Models.DescribeIntent Methods readsPrec :: Int -> ReadS DescribeIntent # readList :: ReadS [DescribeIntent] # readPrec :: ReadPrec DescribeIntent # readListPrec :: ReadPrec [DescribeIntent] #
Show DescribeIntent Source #
Instance details Defined in Amazonka.LexV2Models.DescribeIntent Methods showsPrec :: Int -> DescribeIntent -> ShowS # show :: DescribeIntent -> String # showList :: [DescribeIntent] -> ShowS #
NFData DescribeIntent Source #
Instance details Defined in Amazonka.LexV2Models.DescribeIntent Methods rnf :: DescribeIntent -> () #
Eq DescribeIntent Source #
Instance details Defined in Amazonka.LexV2Models.DescribeIntent Methods (==) :: DescribeIntent -> DescribeIntent -> Bool # (/=) :: DescribeIntent -> DescribeIntent -> Bool #
Hashable DescribeIntent Source #
Instance details Defined in Amazonka.LexV2Models.DescribeIntent Methods hashWithSalt :: Int -> DescribeIntent -> Int # hash :: DescribeIntent -> Int #
type AWSResponse DescribeIntent Source #
Instance details Defined in Amazonka.LexV2Models.DescribeIntent type AWSResponse DescribeIntent = DescribeIntentResponse
type Rep DescribeIntent Source #
Instance details Defined in Amazonka.LexV2Models.DescribeIntent type Rep DescribeIntent = D1 ('MetaData "DescribeIntent" "Amazonka.LexV2Models.DescribeIntent" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "DescribeIntent'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "intentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "botId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "botVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "localeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDescribeIntent Source #

Arguments

:: Text	`DescribeIntent`
-> Text	`DescribeIntent`
-> Text	`DescribeIntent`
-> Text	`DescribeIntent`
-> 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.

Constructors

DescribeIntentResponse'

Fields

botId :: Maybe Text
The identifier of the bot associated with the intent.
botVersion :: Maybe Text
The version of the bot associated with the intent.
creationDateTime :: Maybe POSIX
A timestamp of the date and time that the intent was created.
description :: Maybe Text
The description of the intent.
dialogCodeHook :: Maybe DialogCodeHookSettings
The Lambda function called during each turn of a conversation with the intent.
fulfillmentCodeHook :: Maybe FulfillmentCodeHookSettings
The Lambda function called when the intent is complete and ready for fulfillment.
initialResponseSetting :: Maybe InitialResponseSetting
inputContexts :: Maybe [InputContext]
A list of contexts that must be active for the intent to be considered for sending to the user.
intentClosingSetting :: Maybe IntentClosingSetting
The response that Amazon Lex sends to when the intent is closed.
intentConfirmationSetting :: Maybe IntentConfirmationSetting
Prompts that Amazon Lex sends to the user to confirm completion of an intent.
intentId :: Maybe Text
The unique identifier assigned to the intent when it was created.
intentName :: Maybe Text
The name specified for the intent.
kendraConfiguration :: Maybe KendraConfiguration
Configuration information required to use the AMAZON.KendraSearchIntent intent.
lastUpdatedDateTime :: Maybe POSIX
A timestamp of the date and time that the intent was last updated.
localeId :: Maybe Text
The language and locale specified for the intent.
outputContexts :: Maybe [OutputContext]
A list of contexts that are activated when the intent is fulfilled.
parentIntentSignature :: Maybe Text
The identifier of the built-in intent that this intent is derived from, if any.
sampleUtterances :: Maybe [SampleUtterance]
User utterances that trigger this intent.
slotPriorities :: Maybe [SlotPriority]
The list that determines the priority that slots should be elicited from the user.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeIntentResponse Source #
Instance details Defined in Amazonka.LexV2Models.DescribeIntent Associated Types type Rep DescribeIntentResponse :: Type -> Type # Methods from :: DescribeIntentResponse -> Rep DescribeIntentResponse x # to :: Rep DescribeIntentResponse x -> DescribeIntentResponse #
Read DescribeIntentResponse Source #
Instance details Defined in Amazonka.LexV2Models.DescribeIntent Methods readsPrec :: Int -> ReadS DescribeIntentResponse # readList :: ReadS [DescribeIntentResponse] # readPrec :: ReadPrec DescribeIntentResponse # readListPrec :: ReadPrec [DescribeIntentResponse] #
Show DescribeIntentResponse Source #
Instance details Defined in Amazonka.LexV2Models.DescribeIntent Methods showsPrec :: Int -> DescribeIntentResponse -> ShowS # show :: DescribeIntentResponse -> String # showList :: [DescribeIntentResponse] -> ShowS #
NFData DescribeIntentResponse Source #
Instance details Defined in Amazonka.LexV2Models.DescribeIntent Methods rnf :: DescribeIntentResponse -> () #
Eq DescribeIntentResponse Source #
Instance details Defined in Amazonka.LexV2Models.DescribeIntent Methods (==) :: DescribeIntentResponse -> DescribeIntentResponse -> Bool # (/=) :: DescribeIntentResponse -> DescribeIntentResponse -> Bool #
type Rep DescribeIntentResponse Source #
Instance details Defined in Amazonka.LexV2Models.DescribeIntent type Rep DescribeIntentResponse = D1 ('MetaData "DescribeIntentResponse" "Amazonka.LexV2Models.DescribeIntent" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "DescribeIntentResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "botId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "botVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "creationDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "dialogCodeHook") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DialogCodeHookSettings))))) :: ((S1 ('MetaSel ('Just "fulfillmentCodeHook") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FulfillmentCodeHookSettings)) :: S1 ('MetaSel ('Just "initialResponseSetting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InitialResponseSetting))) :: (S1 ('MetaSel ('Just "inputContexts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [InputContext])) :: (S1 ('MetaSel ('Just "intentClosingSetting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IntentClosingSetting)) :: S1 ('MetaSel ('Just "intentConfirmationSetting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IntentConfirmationSetting)))))) :: (((S1 ('MetaSel ('Just "intentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "intentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "kendraConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KendraConfiguration)) :: (S1 ('MetaSel ('Just "lastUpdatedDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "localeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "outputContexts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [OutputContext])) :: S1 ('MetaSel ('Just "parentIntentSignature") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "sampleUtterances") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SampleUtterance])) :: (S1 ('MetaSel ('Just "slotPriorities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SlotPriority])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))))

newDescribeIntentResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeIntentResponse'`
-> DescribeIntentResponse

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.