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.ConnectParticipant.SendMessage

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Sends a message. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.

The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.

Synopsis

Creating a Request

data SendMessage Source #

See: newSendMessage smart constructor.

Constructors

SendMessage'
Fields clientToken :: Maybe Text A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. contentType :: Text The type of the content. Supported types are text/plain. content :: Text The content of the message. connectionToken :: Text The authentication token associated with the connection.

Instances

Instances details

Eq SendMessage Source #
Instance details Defined in Amazonka.ConnectParticipant.SendMessage Methods (==) :: SendMessage -> SendMessage -> Bool # (/=) :: SendMessage -> SendMessage -> Bool #
Read SendMessage Source #
Instance details Defined in Amazonka.ConnectParticipant.SendMessage Methods readsPrec :: Int -> ReadS SendMessage # readList :: ReadS [SendMessage] # readPrec :: ReadPrec SendMessage # readListPrec :: ReadPrec [SendMessage] #
Show SendMessage Source #
Instance details Defined in Amazonka.ConnectParticipant.SendMessage Methods showsPrec :: Int -> SendMessage -> ShowS # show :: SendMessage -> String # showList :: [SendMessage] -> ShowS #
Generic SendMessage Source #
Instance details Defined in Amazonka.ConnectParticipant.SendMessage Associated Types type Rep SendMessage :: Type -> Type # Methods from :: SendMessage -> Rep SendMessage x # to :: Rep SendMessage x -> SendMessage #
NFData SendMessage Source #
Instance details Defined in Amazonka.ConnectParticipant.SendMessage Methods rnf :: SendMessage -> () #
Hashable SendMessage Source #
Instance details Defined in Amazonka.ConnectParticipant.SendMessage Methods hashWithSalt :: Int -> SendMessage -> Int # hash :: SendMessage -> Int #
ToJSON SendMessage Source #
Instance details Defined in Amazonka.ConnectParticipant.SendMessage Methods toJSON :: SendMessage -> Value # toEncoding :: SendMessage -> Encoding # toJSONList :: [SendMessage] -> Value # toEncodingList :: [SendMessage] -> Encoding #
AWSRequest SendMessage Source #
Instance details Defined in Amazonka.ConnectParticipant.SendMessage Associated Types type AWSResponse SendMessage # Methods request :: SendMessage -> Request SendMessage # response :: MonadResource m => Logger -> Service -> Proxy SendMessage -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SendMessage))) #
ToHeaders SendMessage Source #
Instance details Defined in Amazonka.ConnectParticipant.SendMessage Methods toHeaders :: SendMessage -> [Header] #
ToPath SendMessage Source #
Instance details Defined in Amazonka.ConnectParticipant.SendMessage Methods toPath :: SendMessage -> ByteString #
ToQuery SendMessage Source #
Instance details Defined in Amazonka.ConnectParticipant.SendMessage Methods toQuery :: SendMessage -> QueryString #
type Rep SendMessage Source #
Instance details Defined in Amazonka.ConnectParticipant.SendMessage type Rep SendMessage = D1 ('MetaData "SendMessage" "Amazonka.ConnectParticipant.SendMessage" "libZSservicesZSamazonka-connectparticipantZSamazonka-connectparticipant" 'False) (C1 ('MetaCons "SendMessage'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "contentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "connectionToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse SendMessage Source #
Instance details Defined in Amazonka.ConnectParticipant.SendMessage type AWSResponse SendMessage = SendMessageResponse

newSendMessage Source #

Arguments

:: Text	`$sel:contentType:SendMessage'`
-> Text	`$sel:content:SendMessage'`
-> Text	`$sel:connectionToken:SendMessage'`
-> SendMessage

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

$sel:contentType:SendMessage', sendMessage_contentType - The type of the content. Supported types are text/plain.

$sel:content:SendMessage', sendMessage_content - The content of the message.

$sel:connectionToken:SendMessage', sendMessage_connectionToken - The authentication token associated with the connection.

Request Lenses

sendMessage_clientToken :: Lens' SendMessage (Maybe Text) Source #

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

sendMessage_contentType :: Lens' SendMessage Text Source #

The type of the content. Supported types are text/plain.

sendMessage_content :: Lens' SendMessage Text Source #

The content of the message.

sendMessage_connectionToken :: Lens' SendMessage Text Source #

The authentication token associated with the connection.

Destructuring the Response

data SendMessageResponse Source #

See: newSendMessageResponse smart constructor.

Constructors

SendMessageResponse'
Fields absoluteTime :: Maybe Text The time when the message was sent. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z. id :: Maybe Text The ID of the message. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq SendMessageResponse Source #
Instance details Defined in Amazonka.ConnectParticipant.SendMessage Methods (==) :: SendMessageResponse -> SendMessageResponse -> Bool # (/=) :: SendMessageResponse -> SendMessageResponse -> Bool #
Read SendMessageResponse Source #
Instance details Defined in Amazonka.ConnectParticipant.SendMessage Methods readsPrec :: Int -> ReadS SendMessageResponse # readList :: ReadS [SendMessageResponse] # readPrec :: ReadPrec SendMessageResponse # readListPrec :: ReadPrec [SendMessageResponse] #
Show SendMessageResponse Source #
Instance details Defined in Amazonka.ConnectParticipant.SendMessage Methods showsPrec :: Int -> SendMessageResponse -> ShowS # show :: SendMessageResponse -> String # showList :: [SendMessageResponse] -> ShowS #
Generic SendMessageResponse Source #
Instance details Defined in Amazonka.ConnectParticipant.SendMessage Associated Types type Rep SendMessageResponse :: Type -> Type # Methods from :: SendMessageResponse -> Rep SendMessageResponse x # to :: Rep SendMessageResponse x -> SendMessageResponse #
NFData SendMessageResponse Source #
Instance details Defined in Amazonka.ConnectParticipant.SendMessage Methods rnf :: SendMessageResponse -> () #
type Rep SendMessageResponse Source #
Instance details Defined in Amazonka.ConnectParticipant.SendMessage type Rep SendMessageResponse = D1 ('MetaData "SendMessageResponse" "Amazonka.ConnectParticipant.SendMessage" "libZSservicesZSamazonka-connectparticipantZSamazonka-connectparticipant" 'False) (C1 ('MetaCons "SendMessageResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "absoluteTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newSendMessageResponse Source #

Arguments

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

Create a value of SendMessageResponse 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:absoluteTime:SendMessageResponse', sendMessageResponse_absoluteTime - The time when the message was sent.

It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.

$sel:id:SendMessageResponse', sendMessageResponse_id - The ID of the message.

$sel:httpStatus:SendMessageResponse', sendMessageResponse_httpStatus - The response's http status code.

Response Lenses

sendMessageResponse_absoluteTime :: Lens' SendMessageResponse (Maybe Text) Source #

The time when the message was sent.

It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.

sendMessageResponse_id :: Lens' SendMessageResponse (Maybe Text) Source #

The ID of the message.

sendMessageResponse_httpStatus :: Lens' SendMessageResponse Int Source #

The response's http status code.