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.IVSChat.CreateChatToken

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an encrypted token that is used by a chat participant to establish an individual WebSocket chat connection to a room. When the token is used to connect to chat, the connection is valid for the session duration specified in the request. The token becomes invalid at the token-expiration timestamp included in the response.

Use the capabilities field to permit an end user to send messages or moderate a room.

The attributes field securely attaches structured data to the chat session; the data is included within each message sent by the end user and received by other participants in the room. Common use cases for attributes include passing end-user profile data like an icon, display name, colors, badges, and other display features.

Encryption keys are owned by Amazon IVS Chat and never used directly by your application.

Synopsis

data CreateChatToken = CreateChatToken' {
- attributes :: Maybe (HashMap Text Text)
- capabilities :: Maybe [ChatTokenCapability]
- sessionDurationInMinutes :: Maybe Natural
- roomIdentifier :: Text
- userId :: Text
}
newCreateChatToken :: Text -> Text -> CreateChatToken
createChatToken_attributes :: Lens' CreateChatToken (Maybe (HashMap Text Text))
createChatToken_capabilities :: Lens' CreateChatToken (Maybe [ChatTokenCapability])
createChatToken_sessionDurationInMinutes :: Lens' CreateChatToken (Maybe Natural)
createChatToken_roomIdentifier :: Lens' CreateChatToken Text
createChatToken_userId :: Lens' CreateChatToken Text
data CreateChatTokenResponse = CreateChatTokenResponse' {
- sessionExpirationTime :: Maybe ISO8601
- token :: Maybe Text
- tokenExpirationTime :: Maybe ISO8601
- httpStatus :: Int
}
newCreateChatTokenResponse :: Int -> CreateChatTokenResponse
createChatTokenResponse_sessionExpirationTime :: Lens' CreateChatTokenResponse (Maybe UTCTime)
createChatTokenResponse_token :: Lens' CreateChatTokenResponse (Maybe Text)
createChatTokenResponse_tokenExpirationTime :: Lens' CreateChatTokenResponse (Maybe UTCTime)
createChatTokenResponse_httpStatus :: Lens' CreateChatTokenResponse Int

Creating a Request

data CreateChatToken Source #

See: newCreateChatToken smart constructor.

Constructors

CreateChatToken'

Fields

attributes :: Maybe (HashMap Text Text)
Application-provided attributes to encode into the token and attach to a chat session. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total.
capabilities :: Maybe [ChatTokenCapability]
Set of capabilities that the user is allowed to perform in the room. Default: None (the capability to view messages is implicitly included in all requests).
sessionDurationInMinutes :: Maybe Natural
Session duration (in minutes), after which the session expires. Default: 60 (1 hour).
roomIdentifier :: Text
Identifier of the room that the client is trying to access. Currently this must be an ARN.
userId :: Text
Application-provided ID that uniquely identifies the user associated with this token. This can be any UTF-8 encoded text.

Instances

Instances details

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

newCreateChatToken Source #

Arguments

:: Text	`$sel:roomIdentifier:CreateChatToken'`
-> Text	`$sel:userId:CreateChatToken'`
-> CreateChatToken

Create a value of CreateChatToken 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:attributes:CreateChatToken', createChatToken_attributes - Application-provided attributes to encode into the token and attach to a chat session. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total.

$sel:capabilities:CreateChatToken', createChatToken_capabilities - Set of capabilities that the user is allowed to perform in the room. Default: None (the capability to view messages is implicitly included in all requests).

$sel:sessionDurationInMinutes:CreateChatToken', createChatToken_sessionDurationInMinutes - Session duration (in minutes), after which the session expires. Default: 60 (1 hour).

$sel:roomIdentifier:CreateChatToken', createChatToken_roomIdentifier - Identifier of the room that the client is trying to access. Currently this must be an ARN.

$sel:userId:CreateChatToken', createChatToken_userId - Application-provided ID that uniquely identifies the user associated with this token. This can be any UTF-8 encoded text.

Request Lenses

createChatToken_attributes :: Lens' CreateChatToken (Maybe (HashMap Text Text)) Source #

Application-provided attributes to encode into the token and attach to a chat session. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total.

createChatToken_capabilities :: Lens' CreateChatToken (Maybe [ChatTokenCapability]) Source #

Set of capabilities that the user is allowed to perform in the room. Default: None (the capability to view messages is implicitly included in all requests).

createChatToken_sessionDurationInMinutes :: Lens' CreateChatToken (Maybe Natural) Source #

Session duration (in minutes), after which the session expires. Default: 60 (1 hour).

createChatToken_roomIdentifier :: Lens' CreateChatToken Text Source #

Identifier of the room that the client is trying to access. Currently this must be an ARN.

createChatToken_userId :: Lens' CreateChatToken Text Source #

Application-provided ID that uniquely identifies the user associated with this token. This can be any UTF-8 encoded text.

Destructuring the Response

data CreateChatTokenResponse Source #

See: newCreateChatTokenResponse smart constructor.

Constructors

CreateChatTokenResponse'

Fields

sessionExpirationTime :: Maybe ISO8601
Time after which an end user's session is no longer valid. This is an ISO 8601 timestamp; note that this is returned as a string.
token :: Maybe Text
The issued client token, encrypted.
tokenExpirationTime :: Maybe ISO8601
Time after which the token is no longer valid and cannot be used to connect to a room. This is an ISO 8601 timestamp; /note that this is returned as a string/.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic CreateChatTokenResponse Source #
Instance details Defined in Amazonka.IVSChat.CreateChatToken Associated Types type Rep CreateChatTokenResponse :: Type -> Type # Methods from :: CreateChatTokenResponse -> Rep CreateChatTokenResponse x # to :: Rep CreateChatTokenResponse x -> CreateChatTokenResponse #
Read CreateChatTokenResponse Source #
Instance details Defined in Amazonka.IVSChat.CreateChatToken Methods readsPrec :: Int -> ReadS CreateChatTokenResponse # readList :: ReadS [CreateChatTokenResponse] # readPrec :: ReadPrec CreateChatTokenResponse # readListPrec :: ReadPrec [CreateChatTokenResponse] #
Show CreateChatTokenResponse Source #
Instance details Defined in Amazonka.IVSChat.CreateChatToken Methods showsPrec :: Int -> CreateChatTokenResponse -> ShowS # show :: CreateChatTokenResponse -> String # showList :: [CreateChatTokenResponse] -> ShowS #
NFData CreateChatTokenResponse Source #
Instance details Defined in Amazonka.IVSChat.CreateChatToken Methods rnf :: CreateChatTokenResponse -> () #
Eq CreateChatTokenResponse Source #
Instance details Defined in Amazonka.IVSChat.CreateChatToken Methods (==) :: CreateChatTokenResponse -> CreateChatTokenResponse -> Bool # (/=) :: CreateChatTokenResponse -> CreateChatTokenResponse -> Bool #
type Rep CreateChatTokenResponse Source #
Instance details Defined in Amazonka.IVSChat.CreateChatToken type Rep CreateChatTokenResponse = D1 ('MetaData "CreateChatTokenResponse" "Amazonka.IVSChat.CreateChatToken" "amazonka-ivschat-2.0-AB4QlCKEEGt4izEWjWKMb2" 'False) (C1 ('MetaCons "CreateChatTokenResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "sessionExpirationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: S1 ('MetaSel ('Just "token") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "tokenExpirationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateChatTokenResponse Source #

Arguments

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

Create a value of CreateChatTokenResponse 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:sessionExpirationTime:CreateChatTokenResponse', createChatTokenResponse_sessionExpirationTime - Time after which an end user's session is no longer valid. This is an ISO 8601 timestamp; note that this is returned as a string.

$sel:token:CreateChatTokenResponse', createChatTokenResponse_token - The issued client token, encrypted.

$sel:tokenExpirationTime:CreateChatTokenResponse', createChatTokenResponse_tokenExpirationTime - Time after which the token is no longer valid and cannot be used to connect to a room. This is an ISO 8601 timestamp; /note that this is returned as a string/.

$sel:httpStatus:CreateChatTokenResponse', createChatTokenResponse_httpStatus - The response's http status code.

Response Lenses

createChatTokenResponse_sessionExpirationTime :: Lens' CreateChatTokenResponse (Maybe UTCTime) Source #

Time after which an end user's session is no longer valid. This is an ISO 8601 timestamp; note that this is returned as a string.

createChatTokenResponse_token :: Lens' CreateChatTokenResponse (Maybe Text) Source #

The issued client token, encrypted.

createChatTokenResponse_tokenExpirationTime :: Lens' CreateChatTokenResponse (Maybe UTCTime) Source #

Time after which the token is no longer valid and cannot be used to connect to a room. This is an ISO 8601 timestamp; /note that this is returned as a string/.

createChatTokenResponse_httpStatus :: Lens' CreateChatTokenResponse Int Source #

The response's http status code.