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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Sends a message.

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. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
contentType :: Text
The type of the content. Supported types are text/plain, text/markdown, and application/json.
content :: Text
The content of the message.
- For text/plain and text/markdown, the Length Constraints are Minimum of 1, Maximum of 1024.
- For application/json, the Length Constraints are Minimum of 1, Maximum of 12000.
connectionToken :: Text
The authentication token associated with the connection.

Instances

Instances details

ToJSON SendMessage Source #
Instance details Defined in Amazonka.ConnectParticipant.SendMessage Methods toJSON :: SendMessage -> Value # toEncoding :: SendMessage -> Encoding # toJSONList :: [SendMessage] -> Value # toEncodingList :: [SendMessage] -> Encoding #
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 #
AWSRequest SendMessage Source #
Instance details Defined in Amazonka.ConnectParticipant.SendMessage Associated Types type AWSResponse SendMessage # Methods request :: (Service -> Service) -> SendMessage -> Request SendMessage # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy SendMessage -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SendMessage))) #
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 #
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 #
NFData SendMessage Source #
Instance details Defined in Amazonka.ConnectParticipant.SendMessage Methods rnf :: SendMessage -> () #
Eq SendMessage Source #
Instance details Defined in Amazonka.ConnectParticipant.SendMessage Methods (==) :: SendMessage -> SendMessage -> Bool # (/=) :: SendMessage -> SendMessage -> Bool #
Hashable SendMessage Source #
Instance details Defined in Amazonka.ConnectParticipant.SendMessage Methods hashWithSalt :: Int -> SendMessage -> Int # hash :: SendMessage -> Int #
type AWSResponse SendMessage Source #
Instance details Defined in Amazonka.ConnectParticipant.SendMessage type AWSResponse SendMessage = SendMessageResponse
type Rep SendMessage Source #
Instance details Defined in Amazonka.ConnectParticipant.SendMessage type Rep SendMessage = D1 ('MetaData "SendMessage" "Amazonka.ConnectParticipant.SendMessage" "amazonka-connectparticipant-2.0-I4GmkIlwxQUGg1dW7eNFQJ" '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))))

newSendMessage Source #

Arguments

:: Text	`SendMessage`
-> Text	`SendMessage`
-> Text	`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. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

SendMessage, sendMessage_contentType - The type of the content. Supported types are text/plain, text/markdown, and application/json.

SendMessage, sendMessage_content - The content of the message.

For text/plain and text/markdown, the Length Constraints are Minimum of 1, Maximum of 1024.
For application/json, the Length Constraints are Minimum of 1, Maximum of 12000.

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. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

sendMessage_contentType :: Lens' SendMessage Text Source #

The type of the content. Supported types are text/plain, text/markdown, and application/json.

sendMessage_content :: Lens' SendMessage Text Source #

The content of the message.

For text/plain and text/markdown, the Length Constraints are Minimum of 1, Maximum of 1024.
For application/json, the Length Constraints are Minimum of 1, Maximum of 12000.

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

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 #
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 #
NFData SendMessageResponse Source #
Instance details Defined in Amazonka.ConnectParticipant.SendMessage Methods rnf :: SendMessageResponse -> () #
Eq SendMessageResponse Source #
Instance details Defined in Amazonka.ConnectParticipant.SendMessage Methods (==) :: SendMessageResponse -> SendMessageResponse -> Bool # (/=) :: SendMessageResponse -> SendMessageResponse -> Bool #
type Rep SendMessageResponse Source #
Instance details Defined in Amazonka.ConnectParticipant.SendMessage type Rep SendMessageResponse = D1 ('MetaData "SendMessageResponse" "Amazonka.ConnectParticipant.SendMessage" "amazonka-connectparticipant-2.0-I4GmkIlwxQUGg1dW7eNFQJ" '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:

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.

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.