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.LexModels.GetIntent

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about an intent. In addition to the intent name, you must specify the intent version.

This operation requires permissions to perform the lex:GetIntent action.

Synopsis

data GetIntent = GetIntent' {
- name :: Text
- version :: Text
}
newGetIntent :: Text -> Text -> GetIntent
getIntent_name :: Lens' GetIntent Text
getIntent_version :: Lens' GetIntent Text
data GetIntentResponse = GetIntentResponse' {
- checksum :: Maybe Text
- conclusionStatement :: Maybe Statement
- confirmationPrompt :: Maybe Prompt
- createdDate :: Maybe POSIX
- description :: Maybe Text
- dialogCodeHook :: Maybe CodeHook
- followUpPrompt :: Maybe FollowUpPrompt
- fulfillmentActivity :: Maybe FulfillmentActivity
- inputContexts :: Maybe [InputContext]
- kendraConfiguration :: Maybe KendraConfiguration
- lastUpdatedDate :: Maybe POSIX
- name :: Maybe Text
- outputContexts :: Maybe [OutputContext]
- parentIntentSignature :: Maybe Text
- rejectionStatement :: Maybe Statement
- sampleUtterances :: Maybe [Text]
- slots :: Maybe [Slot]
- version :: Maybe Text
- httpStatus :: Int
}
newGetIntentResponse :: Int -> GetIntentResponse
getIntentResponse_checksum :: Lens' GetIntentResponse (Maybe Text)
getIntentResponse_conclusionStatement :: Lens' GetIntentResponse (Maybe Statement)
getIntentResponse_confirmationPrompt :: Lens' GetIntentResponse (Maybe Prompt)
getIntentResponse_createdDate :: Lens' GetIntentResponse (Maybe UTCTime)
getIntentResponse_description :: Lens' GetIntentResponse (Maybe Text)
getIntentResponse_dialogCodeHook :: Lens' GetIntentResponse (Maybe CodeHook)
getIntentResponse_followUpPrompt :: Lens' GetIntentResponse (Maybe FollowUpPrompt)
getIntentResponse_fulfillmentActivity :: Lens' GetIntentResponse (Maybe FulfillmentActivity)
getIntentResponse_inputContexts :: Lens' GetIntentResponse (Maybe [InputContext])
getIntentResponse_kendraConfiguration :: Lens' GetIntentResponse (Maybe KendraConfiguration)
getIntentResponse_lastUpdatedDate :: Lens' GetIntentResponse (Maybe UTCTime)
getIntentResponse_name :: Lens' GetIntentResponse (Maybe Text)
getIntentResponse_outputContexts :: Lens' GetIntentResponse (Maybe [OutputContext])
getIntentResponse_parentIntentSignature :: Lens' GetIntentResponse (Maybe Text)
getIntentResponse_rejectionStatement :: Lens' GetIntentResponse (Maybe Statement)
getIntentResponse_sampleUtterances :: Lens' GetIntentResponse (Maybe [Text])
getIntentResponse_slots :: Lens' GetIntentResponse (Maybe [Slot])
getIntentResponse_version :: Lens' GetIntentResponse (Maybe Text)
getIntentResponse_httpStatus :: Lens' GetIntentResponse Int

Creating a Request

data GetIntent Source #

See: newGetIntent smart constructor.

Constructors

GetIntent'
Fields name :: Text The name of the intent. The name is case sensitive. version :: Text The version of the intent.

Instances

Instances details

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

newGetIntent Source #

Arguments

:: Text	`GetIntent`
-> Text	`GetIntent`
-> GetIntent

Create a value of GetIntent with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetIntent, getIntent_name - The name of the intent. The name is case sensitive.

GetIntent, getIntent_version - The version of the intent.

Request Lenses

getIntent_name :: Lens' GetIntent Text Source #

The name of the intent. The name is case sensitive.

getIntent_version :: Lens' GetIntent Text Source #

The version of the intent.

Destructuring the Response

data GetIntentResponse Source #

See: newGetIntentResponse smart constructor.

Constructors

GetIntentResponse'

Fields

checksum :: Maybe Text
Checksum of the intent.
conclusionStatement :: Maybe Statement
After the Lambda function specified in the fulfillmentActivity element fulfills the intent, Amazon Lex conveys this statement to the user.
confirmationPrompt :: Maybe Prompt
If defined in the bot, Amazon Lex uses prompt to confirm the intent before fulfilling the user's request. For more information, see PutIntent.
createdDate :: Maybe POSIX
The date that the intent was created.
description :: Maybe Text
A description of the intent.
dialogCodeHook :: Maybe CodeHook
If defined in the bot, Amazon Amazon Lex invokes this Lambda function for each user input. For more information, see PutIntent.
followUpPrompt :: Maybe FollowUpPrompt
If defined in the bot, Amazon Lex uses this prompt to solicit additional user activity after the intent is fulfilled. For more information, see PutIntent.
fulfillmentActivity :: Maybe FulfillmentActivity
Describes how the intent is fulfilled. For more information, see PutIntent.
inputContexts :: Maybe [InputContext]
An array of InputContext objects that lists the contexts that must be active for Amazon Lex to choose the intent in a conversation with the user.
kendraConfiguration :: Maybe KendraConfiguration
Configuration information, if any, to connect to an Amazon Kendra index with the AMAZON.KendraSearchIntent intent.
lastUpdatedDate :: Maybe POSIX
The date that the intent was updated. When you create a resource, the creation date and the last updated date are the same.
name :: Maybe Text
The name of the intent.
outputContexts :: Maybe [OutputContext]
An array of OutputContext objects that lists the contexts that the intent activates when the intent is fulfilled.
parentIntentSignature :: Maybe Text
A unique identifier for a built-in intent.
rejectionStatement :: Maybe Statement
If the user answers "no" to the question defined in confirmationPrompt, Amazon Lex responds with this statement to acknowledge that the intent was canceled.
sampleUtterances :: Maybe [Text]
An array of sample utterances configured for the intent.
slots :: Maybe [Slot]
An array of intent slots configured for the intent.
version :: Maybe Text
The version of the intent.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetIntentResponse Source #
Instance details Defined in Amazonka.LexModels.GetIntent Associated Types type Rep GetIntentResponse :: Type -> Type # Methods from :: GetIntentResponse -> Rep GetIntentResponse x # to :: Rep GetIntentResponse x -> GetIntentResponse #
Read GetIntentResponse Source #
Instance details Defined in Amazonka.LexModels.GetIntent Methods readsPrec :: Int -> ReadS GetIntentResponse # readList :: ReadS [GetIntentResponse] # readPrec :: ReadPrec GetIntentResponse # readListPrec :: ReadPrec [GetIntentResponse] #
Show GetIntentResponse Source #
Instance details Defined in Amazonka.LexModels.GetIntent Methods showsPrec :: Int -> GetIntentResponse -> ShowS # show :: GetIntentResponse -> String # showList :: [GetIntentResponse] -> ShowS #
NFData GetIntentResponse Source #
Instance details Defined in Amazonka.LexModels.GetIntent Methods rnf :: GetIntentResponse -> () #
Eq GetIntentResponse Source #
Instance details Defined in Amazonka.LexModels.GetIntent Methods (==) :: GetIntentResponse -> GetIntentResponse -> Bool # (/=) :: GetIntentResponse -> GetIntentResponse -> Bool #
type Rep GetIntentResponse Source #
Instance details Defined in Amazonka.LexModels.GetIntent type Rep GetIntentResponse = D1 ('MetaData "GetIntentResponse" "Amazonka.LexModels.GetIntent" "amazonka-lex-models-2.0-8Q1WIjnrCCIAMPuyNOCiG7" 'False) (C1 ('MetaCons "GetIntentResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "checksum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "conclusionStatement") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Statement))) :: (S1 ('MetaSel ('Just "confirmationPrompt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Prompt)) :: S1 ('MetaSel ('Just "createdDate") '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 CodeHook))) :: (S1 ('MetaSel ('Just "followUpPrompt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FollowUpPrompt)) :: (S1 ('MetaSel ('Just "fulfillmentActivity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FulfillmentActivity)) :: S1 ('MetaSel ('Just "inputContexts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [InputContext])))))) :: (((S1 ('MetaSel ('Just "kendraConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KendraConfiguration)) :: S1 ('MetaSel ('Just "lastUpdatedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "name") '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 "rejectionStatement") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Statement)) :: S1 ('MetaSel ('Just "sampleUtterances") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "slots") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Slot])) :: (S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))))

newGetIntentResponse Source #

Arguments

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

Create a value of GetIntentResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetIntentResponse, getIntentResponse_checksum - Checksum of the intent.

$sel:conclusionStatement:GetIntentResponse', getIntentResponse_conclusionStatement - After the Lambda function specified in the fulfillmentActivity element fulfills the intent, Amazon Lex conveys this statement to the user.

$sel:confirmationPrompt:GetIntentResponse', getIntentResponse_confirmationPrompt - If defined in the bot, Amazon Lex uses prompt to confirm the intent before fulfilling the user's request. For more information, see PutIntent.

GetIntentResponse, getIntentResponse_createdDate - The date that the intent was created.

GetIntentResponse, getIntentResponse_description - A description of the intent.

$sel:dialogCodeHook:GetIntentResponse', getIntentResponse_dialogCodeHook - If defined in the bot, Amazon Amazon Lex invokes this Lambda function for each user input. For more information, see PutIntent.

$sel:followUpPrompt:GetIntentResponse', getIntentResponse_followUpPrompt - If defined in the bot, Amazon Lex uses this prompt to solicit additional user activity after the intent is fulfilled. For more information, see PutIntent.

$sel:fulfillmentActivity:GetIntentResponse', getIntentResponse_fulfillmentActivity - Describes how the intent is fulfilled. For more information, see PutIntent.

$sel:inputContexts:GetIntentResponse', getIntentResponse_inputContexts - An array of InputContext objects that lists the contexts that must be active for Amazon Lex to choose the intent in a conversation with the user.

$sel:kendraConfiguration:GetIntentResponse', getIntentResponse_kendraConfiguration - Configuration information, if any, to connect to an Amazon Kendra index with the AMAZON.KendraSearchIntent intent.

GetIntentResponse, getIntentResponse_lastUpdatedDate - The date that the intent was updated. When you create a resource, the creation date and the last updated date are the same.

GetIntent, getIntentResponse_name - The name of the intent.

$sel:outputContexts:GetIntentResponse', getIntentResponse_outputContexts - An array of OutputContext objects that lists the contexts that the intent activates when the intent is fulfilled.

$sel:parentIntentSignature:GetIntentResponse', getIntentResponse_parentIntentSignature - A unique identifier for a built-in intent.

GetIntentResponse, getIntentResponse_rejectionStatement - If the user answers "no" to the question defined in confirmationPrompt, Amazon Lex responds with this statement to acknowledge that the intent was canceled.

GetIntentResponse, getIntentResponse_sampleUtterances - An array of sample utterances configured for the intent.

$sel:slots:GetIntentResponse', getIntentResponse_slots - An array of intent slots configured for the intent.

GetIntent, getIntentResponse_version - The version of the intent.

$sel:httpStatus:GetIntentResponse', getIntentResponse_httpStatus - The response's http status code.

Response Lenses

getIntentResponse_checksum :: Lens' GetIntentResponse (Maybe Text) Source #

Checksum of the intent.

getIntentResponse_conclusionStatement :: Lens' GetIntentResponse (Maybe Statement) Source #

After the Lambda function specified in the fulfillmentActivity element fulfills the intent, Amazon Lex conveys this statement to the user.

getIntentResponse_confirmationPrompt :: Lens' GetIntentResponse (Maybe Prompt) Source #

If defined in the bot, Amazon Lex uses prompt to confirm the intent before fulfilling the user's request. For more information, see PutIntent.

getIntentResponse_createdDate :: Lens' GetIntentResponse (Maybe UTCTime) Source #

The date that the intent was created.

getIntentResponse_description :: Lens' GetIntentResponse (Maybe Text) Source #

A description of the intent.

getIntentResponse_dialogCodeHook :: Lens' GetIntentResponse (Maybe CodeHook) Source #

If defined in the bot, Amazon Amazon Lex invokes this Lambda function for each user input. For more information, see PutIntent.

getIntentResponse_followUpPrompt :: Lens' GetIntentResponse (Maybe FollowUpPrompt) Source #

If defined in the bot, Amazon Lex uses this prompt to solicit additional user activity after the intent is fulfilled. For more information, see PutIntent.

getIntentResponse_fulfillmentActivity :: Lens' GetIntentResponse (Maybe FulfillmentActivity) Source #

Describes how the intent is fulfilled. For more information, see PutIntent.

getIntentResponse_inputContexts :: Lens' GetIntentResponse (Maybe [InputContext]) Source #

An array of InputContext objects that lists the contexts that must be active for Amazon Lex to choose the intent in a conversation with the user.

getIntentResponse_kendraConfiguration :: Lens' GetIntentResponse (Maybe KendraConfiguration) Source #

Configuration information, if any, to connect to an Amazon Kendra index with the AMAZON.KendraSearchIntent intent.

getIntentResponse_lastUpdatedDate :: Lens' GetIntentResponse (Maybe UTCTime) Source #

The date that the intent was updated. When you create a resource, the creation date and the last updated date are the same.

getIntentResponse_name :: Lens' GetIntentResponse (Maybe Text) Source #

The name of the intent.

getIntentResponse_outputContexts :: Lens' GetIntentResponse (Maybe [OutputContext]) Source #

An array of OutputContext objects that lists the contexts that the intent activates when the intent is fulfilled.

getIntentResponse_parentIntentSignature :: Lens' GetIntentResponse (Maybe Text) Source #

A unique identifier for a built-in intent.

getIntentResponse_rejectionStatement :: Lens' GetIntentResponse (Maybe Statement) Source #

If the user answers "no" to the question defined in confirmationPrompt, Amazon Lex responds with this statement to acknowledge that the intent was canceled.

getIntentResponse_sampleUtterances :: Lens' GetIntentResponse (Maybe [Text]) Source #

An array of sample utterances configured for the intent.

getIntentResponse_slots :: Lens' GetIntentResponse (Maybe [Slot]) Source #

An array of intent slots configured for the intent.

getIntentResponse_version :: Lens' GetIntentResponse (Maybe Text) Source #

The version of the intent.

getIntentResponse_httpStatus :: Lens' GetIntentResponse Int Source #

The response's http status code.