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.Wisdom.CreateSession

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new Wisdom session for each contact on which Wisdom is enabled.

Creating a Request

data CreateSession Source #

See: newCreateSession smart constructor.

Constructors

CreateSession'

Fields

clientToken :: Maybe Text
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
description :: Maybe Text
The description.
tags :: Maybe (HashMap Text Text)
The tags used to organize, track, or control access for this resource.
assistantId :: Text
The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
name :: Text
The name of the session.

Instances

Instances details

ToJSON CreateSession Source #
Instance details Defined in Amazonka.Wisdom.CreateSession Methods toJSON :: CreateSession -> Value # toEncoding :: CreateSession -> Encoding # toJSONList :: [CreateSession] -> Value # toEncodingList :: [CreateSession] -> Encoding #
ToHeaders CreateSession Source #
Instance details Defined in Amazonka.Wisdom.CreateSession Methods toHeaders :: CreateSession -> [Header] #
ToPath CreateSession Source #
Instance details Defined in Amazonka.Wisdom.CreateSession Methods toPath :: CreateSession -> ByteString #
ToQuery CreateSession Source #
Instance details Defined in Amazonka.Wisdom.CreateSession Methods toQuery :: CreateSession -> QueryString #
AWSRequest CreateSession Source #
Instance details Defined in Amazonka.Wisdom.CreateSession Associated Types type AWSResponse CreateSession # Methods request :: (Service -> Service) -> CreateSession -> Request CreateSession # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateSession -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateSession))) #
Generic CreateSession Source #
Instance details Defined in Amazonka.Wisdom.CreateSession Associated Types type Rep CreateSession :: Type -> Type # Methods from :: CreateSession -> Rep CreateSession x # to :: Rep CreateSession x -> CreateSession #
Read CreateSession Source #
Instance details Defined in Amazonka.Wisdom.CreateSession Methods readsPrec :: Int -> ReadS CreateSession # readList :: ReadS [CreateSession] # readPrec :: ReadPrec CreateSession # readListPrec :: ReadPrec [CreateSession] #
Show CreateSession Source #
Instance details Defined in Amazonka.Wisdom.CreateSession Methods showsPrec :: Int -> CreateSession -> ShowS # show :: CreateSession -> String # showList :: [CreateSession] -> ShowS #
NFData CreateSession Source #
Instance details Defined in Amazonka.Wisdom.CreateSession Methods rnf :: CreateSession -> () #
Eq CreateSession Source #
Instance details Defined in Amazonka.Wisdom.CreateSession Methods (==) :: CreateSession -> CreateSession -> Bool # (/=) :: CreateSession -> CreateSession -> Bool #
Hashable CreateSession Source #
Instance details Defined in Amazonka.Wisdom.CreateSession Methods hashWithSalt :: Int -> CreateSession -> Int # hash :: CreateSession -> Int #
type AWSResponse CreateSession Source #
Instance details Defined in Amazonka.Wisdom.CreateSession type AWSResponse CreateSession = CreateSessionResponse
type Rep CreateSession Source #
Instance details Defined in Amazonka.Wisdom.CreateSession type Rep CreateSession = D1 ('MetaData "CreateSession" "Amazonka.Wisdom.CreateSession" "amazonka-wisdom-2.0-D8ZGZ1sJNnDDHDNbH2yubp" 'False) (C1 ('MetaCons "CreateSession'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "assistantId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateSession Source #

Arguments

:: Text	`CreateSession`
-> Text	`CreateSession`
-> CreateSession

Create a value of CreateSession 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:clientToken:CreateSession', createSession_clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

CreateSession, createSession_description - The description.

CreateSession, createSession_tags - The tags used to organize, track, or control access for this resource.

CreateSession, createSession_assistantId - The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

CreateSession, createSession_name - The name of the session.

Request Lenses

createSession_clientToken :: Lens' CreateSession (Maybe Text) Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

createSession_description :: Lens' CreateSession (Maybe Text) Source #

The description.

createSession_tags :: Lens' CreateSession (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource.

createSession_assistantId :: Lens' CreateSession Text Source #

The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

createSession_name :: Lens' CreateSession Text Source #

The name of the session.

Destructuring the Response

data CreateSessionResponse Source #

See: newCreateSessionResponse smart constructor.

Constructors

CreateSessionResponse'
Fields session :: Maybe SessionData The session. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateSessionResponse Source #
Instance details Defined in Amazonka.Wisdom.CreateSession Associated Types type Rep CreateSessionResponse :: Type -> Type # Methods from :: CreateSessionResponse -> Rep CreateSessionResponse x # to :: Rep CreateSessionResponse x -> CreateSessionResponse #
Read CreateSessionResponse Source #
Instance details Defined in Amazonka.Wisdom.CreateSession Methods readsPrec :: Int -> ReadS CreateSessionResponse # readList :: ReadS [CreateSessionResponse] # readPrec :: ReadPrec CreateSessionResponse # readListPrec :: ReadPrec [CreateSessionResponse] #
Show CreateSessionResponse Source #
Instance details Defined in Amazonka.Wisdom.CreateSession Methods showsPrec :: Int -> CreateSessionResponse -> ShowS # show :: CreateSessionResponse -> String # showList :: [CreateSessionResponse] -> ShowS #
NFData CreateSessionResponse Source #
Instance details Defined in Amazonka.Wisdom.CreateSession Methods rnf :: CreateSessionResponse -> () #
Eq CreateSessionResponse Source #
Instance details Defined in Amazonka.Wisdom.CreateSession Methods (==) :: CreateSessionResponse -> CreateSessionResponse -> Bool # (/=) :: CreateSessionResponse -> CreateSessionResponse -> Bool #
type Rep CreateSessionResponse Source #
Instance details Defined in Amazonka.Wisdom.CreateSession type Rep CreateSessionResponse = D1 ('MetaData "CreateSessionResponse" "Amazonka.Wisdom.CreateSession" "amazonka-wisdom-2.0-D8ZGZ1sJNnDDHDNbH2yubp" 'False) (C1 ('MetaCons "CreateSessionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "session") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SessionData)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateSessionResponse Source #

Arguments

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

Create a value of CreateSessionResponse 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:session:CreateSessionResponse', createSessionResponse_session - The session.

$sel:httpStatus:CreateSessionResponse', createSessionResponse_httpStatus - The response's http status code.

Response Lenses

createSessionResponse_session :: Lens' CreateSessionResponse (Maybe SessionData) Source #

The session.

createSessionResponse_httpStatus :: Lens' CreateSessionResponse Int Source #

The response's http status code.