Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.LexRuntime.GetSession

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Synopsis

data GetSession = GetSession' {
- checkpointLabelFilter :: Maybe Text
- botName :: Text
- botAlias :: Text
- userId :: Text
}
newGetSession :: Text -> Text -> Text -> GetSession
getSession_checkpointLabelFilter :: Lens' GetSession (Maybe Text)
getSession_botName :: Lens' GetSession Text
getSession_botAlias :: Lens' GetSession Text
getSession_userId :: Lens' GetSession Text
data GetSessionResponse = GetSessionResponse' {
- activeContexts :: Maybe (Sensitive [ActiveContext])
- sessionId :: Maybe Text
- recentIntentSummaryView :: Maybe [IntentSummary]
- dialogAction :: Maybe DialogAction
- sessionAttributes :: Maybe (Sensitive (HashMap Text Text))
- httpStatus :: Int
}
newGetSessionResponse :: Int -> GetSessionResponse
getSessionResponse_activeContexts :: Lens' GetSessionResponse (Maybe [ActiveContext])
getSessionResponse_sessionId :: Lens' GetSessionResponse (Maybe Text)
getSessionResponse_recentIntentSummaryView :: Lens' GetSessionResponse (Maybe [IntentSummary])
getSessionResponse_dialogAction :: Lens' GetSessionResponse (Maybe DialogAction)
getSessionResponse_sessionAttributes :: Lens' GetSessionResponse (Maybe (HashMap Text Text))
getSessionResponse_httpStatus :: Lens' GetSessionResponse Int

Creating a Request

data GetSession Source #

See: newGetSession smart constructor.

Constructors

GetSession'

Fields

checkpointLabelFilter :: Maybe Text
A string used to filter the intents returned in the recentIntentSummaryView structure.
When you specify a filter, only intents with their checkpointLabel field set to that string are returned.
botName :: Text
The name of the bot that contains the session data.
botAlias :: Text
The alias in use for the bot that contains the session data.
userId :: Text
The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot.

Instances

Instances details

Eq GetSession Source #
Instance details Defined in Amazonka.LexRuntime.GetSession Methods (==) :: GetSession -> GetSession -> Bool # (/=) :: GetSession -> GetSession -> Bool #
Read GetSession Source #
Instance details Defined in Amazonka.LexRuntime.GetSession Methods readsPrec :: Int -> ReadS GetSession # readList :: ReadS [GetSession] # readPrec :: ReadPrec GetSession # readListPrec :: ReadPrec [GetSession] #
Show GetSession Source #
Instance details Defined in Amazonka.LexRuntime.GetSession Methods showsPrec :: Int -> GetSession -> ShowS # show :: GetSession -> String # showList :: [GetSession] -> ShowS #
Generic GetSession Source #
Instance details Defined in Amazonka.LexRuntime.GetSession Associated Types type Rep GetSession :: Type -> Type # Methods from :: GetSession -> Rep GetSession x # to :: Rep GetSession x -> GetSession #
NFData GetSession Source #
Instance details Defined in Amazonka.LexRuntime.GetSession Methods rnf :: GetSession -> () #
Hashable GetSession Source #
Instance details Defined in Amazonka.LexRuntime.GetSession Methods hashWithSalt :: Int -> GetSession -> Int # hash :: GetSession -> Int #
AWSRequest GetSession Source #
Instance details Defined in Amazonka.LexRuntime.GetSession Associated Types type AWSResponse GetSession # Methods request :: GetSession -> Request GetSession # response :: MonadResource m => Logger -> Service -> Proxy GetSession -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetSession))) #
ToHeaders GetSession Source #
Instance details Defined in Amazonka.LexRuntime.GetSession Methods toHeaders :: GetSession -> [Header] #
ToPath GetSession Source #
Instance details Defined in Amazonka.LexRuntime.GetSession Methods toPath :: GetSession -> ByteString #
ToQuery GetSession Source #
Instance details Defined in Amazonka.LexRuntime.GetSession Methods toQuery :: GetSession -> QueryString #
type Rep GetSession Source #
Instance details Defined in Amazonka.LexRuntime.GetSession type Rep GetSession = D1 ('MetaData "GetSession" "Amazonka.LexRuntime.GetSession" "libZSservicesZSamazonka-lex-runtimeZSamazonka-lex-runtime" 'False) (C1 ('MetaCons "GetSession'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "checkpointLabelFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "botName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "botAlias") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse GetSession Source #
Instance details Defined in Amazonka.LexRuntime.GetSession type AWSResponse GetSession = GetSessionResponse

newGetSession Source #

Arguments

:: Text	`$sel:botName:GetSession'`
-> Text	`$sel:botAlias:GetSession'`
-> Text	`$sel:userId:GetSession'`
-> GetSession

Create a value of GetSession 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:

$sel:checkpointLabelFilter:GetSession', getSession_checkpointLabelFilter - A string used to filter the intents returned in the recentIntentSummaryView structure.

When you specify a filter, only intents with their checkpointLabel field set to that string are returned.

$sel:botName:GetSession', getSession_botName - The name of the bot that contains the session data.

$sel:botAlias:GetSession', getSession_botAlias - The alias in use for the bot that contains the session data.

$sel:userId:GetSession', getSession_userId - The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot.

Request Lenses

getSession_checkpointLabelFilter :: Lens' GetSession (Maybe Text) Source #

A string used to filter the intents returned in the recentIntentSummaryView structure.

When you specify a filter, only intents with their checkpointLabel field set to that string are returned.

getSession_botName :: Lens' GetSession Text Source #

The name of the bot that contains the session data.

getSession_botAlias :: Lens' GetSession Text Source #

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

getSession_userId :: Lens' GetSession Text Source #

The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot.

Destructuring the Response

data GetSessionResponse Source #

See: newGetSessionResponse smart constructor.

Constructors

GetSessionResponse'

Fields

activeContexts :: Maybe (Sensitive [ActiveContext])
A list of active contexts for the session. A context can be set when an intent is fulfilled or by calling the PostContent, PostText, or PutSession operation.
You can use a context to control the intents that can follow up an intent, or to modify the operation of your application.
sessionId :: Maybe Text
A unique identifier for the session.
recentIntentSummaryView :: Maybe [IntentSummary]
An array of information about the intents used in the session. The array can contain a maximum of three summaries. If more than three intents are used in the session, the recentIntentSummaryView operation contains information about the last three intents used.
If you set the checkpointLabelFilter parameter in the request, the array contains only the intents with the specified label.
dialogAction :: Maybe DialogAction
Describes the current state of the bot.
sessionAttributes :: Maybe (Sensitive (HashMap Text Text))
Map of key/value pairs representing the session-specific context information. It contains application information passed between Amazon Lex and a client application.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq GetSessionResponse Source #
Instance details Defined in Amazonka.LexRuntime.GetSession Methods (==) :: GetSessionResponse -> GetSessionResponse -> Bool # (/=) :: GetSessionResponse -> GetSessionResponse -> Bool #
Show GetSessionResponse Source #
Instance details Defined in Amazonka.LexRuntime.GetSession Methods showsPrec :: Int -> GetSessionResponse -> ShowS # show :: GetSessionResponse -> String # showList :: [GetSessionResponse] -> ShowS #
Generic GetSessionResponse Source #
Instance details Defined in Amazonka.LexRuntime.GetSession Associated Types type Rep GetSessionResponse :: Type -> Type # Methods from :: GetSessionResponse -> Rep GetSessionResponse x # to :: Rep GetSessionResponse x -> GetSessionResponse #
NFData GetSessionResponse Source #
Instance details Defined in Amazonka.LexRuntime.GetSession Methods rnf :: GetSessionResponse -> () #
type Rep GetSessionResponse Source #
Instance details Defined in Amazonka.LexRuntime.GetSession type Rep GetSessionResponse = D1 ('MetaData "GetSessionResponse" "Amazonka.LexRuntime.GetSession" "libZSservicesZSamazonka-lex-runtimeZSamazonka-lex-runtime" 'False) (C1 ('MetaCons "GetSessionResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "activeContexts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive [ActiveContext]))) :: (S1 ('MetaSel ('Just "sessionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "recentIntentSummaryView") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [IntentSummary])))) :: (S1 ('MetaSel ('Just "dialogAction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DialogAction)) :: (S1 ('MetaSel ('Just "sessionAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive (HashMap Text Text)))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newGetSessionResponse Source #

Arguments

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

Create a value of GetSessionResponse 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:

$sel:activeContexts:GetSessionResponse', getSessionResponse_activeContexts - A list of active contexts for the session. A context can be set when an intent is fulfilled or by calling the PostContent, PostText, or PutSession operation.

You can use a context to control the intents that can follow up an intent, or to modify the operation of your application.

$sel:sessionId:GetSessionResponse', getSessionResponse_sessionId - A unique identifier for the session.

$sel:recentIntentSummaryView:GetSessionResponse', getSessionResponse_recentIntentSummaryView - An array of information about the intents used in the session. The array can contain a maximum of three summaries. If more than three intents are used in the session, the recentIntentSummaryView operation contains information about the last three intents used.

If you set the checkpointLabelFilter parameter in the request, the array contains only the intents with the specified label.

$sel:dialogAction:GetSessionResponse', getSessionResponse_dialogAction - Describes the current state of the bot.

$sel:sessionAttributes:GetSessionResponse', getSessionResponse_sessionAttributes - Map of key/value pairs representing the session-specific context information. It contains application information passed between Amazon Lex and a client application.

$sel:httpStatus:GetSessionResponse', getSessionResponse_httpStatus - The response's http status code.

Response Lenses

getSessionResponse_activeContexts :: Lens' GetSessionResponse (Maybe [ActiveContext]) Source #

A list of active contexts for the session. A context can be set when an intent is fulfilled or by calling the PostContent, PostText, or PutSession operation.

You can use a context to control the intents that can follow up an intent, or to modify the operation of your application.

getSessionResponse_sessionId :: Lens' GetSessionResponse (Maybe Text) Source #

A unique identifier for the session.

getSessionResponse_recentIntentSummaryView :: Lens' GetSessionResponse (Maybe [IntentSummary]) Source #

An array of information about the intents used in the session. The array can contain a maximum of three summaries. If more than three intents are used in the session, the recentIntentSummaryView operation contains information about the last three intents used.

If you set the checkpointLabelFilter parameter in the request, the array contains only the intents with the specified label.

getSessionResponse_dialogAction :: Lens' GetSessionResponse (Maybe DialogAction) Source #

Describes the current state of the bot.

getSessionResponse_sessionAttributes :: Lens' GetSessionResponse (Maybe (HashMap Text Text)) Source #

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

getSessionResponse_httpStatus :: Lens' GetSessionResponse Int Source #

The response's http status code.