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.SendEvent

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Sends an event.

ConnectionToken is used for invoking this API instead of ParticipantToken.

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

Synopsis

data SendEvent = SendEvent' {
- clientToken :: Maybe Text
- content :: Maybe Text
- contentType :: Text
- connectionToken :: Text
}
newSendEvent :: Text -> Text -> SendEvent
sendEvent_clientToken :: Lens' SendEvent (Maybe Text)
sendEvent_content :: Lens' SendEvent (Maybe Text)
sendEvent_contentType :: Lens' SendEvent Text
sendEvent_connectionToken :: Lens' SendEvent Text
data SendEventResponse = SendEventResponse' {
- absoluteTime :: Maybe Text
- id :: Maybe Text
- httpStatus :: Int
}
newSendEventResponse :: Int -> SendEventResponse
sendEventResponse_absoluteTime :: Lens' SendEventResponse (Maybe Text)
sendEventResponse_id :: Lens' SendEventResponse (Maybe Text)
sendEventResponse_httpStatus :: Lens' SendEventResponse Int

Creating a Request

data SendEvent Source #

See: newSendEvent smart constructor.

Constructors

SendEvent'

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.
content :: Maybe Text
The content of the event to be sent (for example, message text). For content related to message receipts, this is supported in the form of a JSON string.
Sample Content: "{\"messageId\":\"11111111-aaaa-bbbb-cccc-EXAMPLE01234\"}"
contentType :: Text
The content type of the request. Supported types are:
- application/vnd.amazonaws.connect.event.typing
- application/vnd.amazonaws.connect.event.connection.acknowledged
- application/vnd.amazonaws.connect.event.message.delivered
- application/vnd.amazonaws.connect.event.message.read
connectionToken :: Text
The authentication token associated with the participant's connection.

Instances

Instances details

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

newSendEvent Source #

Arguments

:: Text	`SendEvent`
-> Text	`SendEvent`
-> SendEvent

Create a value of SendEvent 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:SendEvent', sendEvent_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.

SendEvent, sendEvent_content - The content of the event to be sent (for example, message text). For content related to message receipts, this is supported in the form of a JSON string.

Sample Content: "{\"messageId\":\"11111111-aaaa-bbbb-cccc-EXAMPLE01234\"}"

SendEvent, sendEvent_contentType - The content type of the request. Supported types are:

application/vnd.amazonaws.connect.event.typing
application/vnd.amazonaws.connect.event.connection.acknowledged
application/vnd.amazonaws.connect.event.message.delivered
application/vnd.amazonaws.connect.event.message.read

SendEvent, sendEvent_connectionToken - The authentication token associated with the participant's connection.

Request Lenses

sendEvent_clientToken :: Lens' SendEvent (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.

sendEvent_content :: Lens' SendEvent (Maybe Text) Source #

The content of the event to be sent (for example, message text). For content related to message receipts, this is supported in the form of a JSON string.

Sample Content: "{\"messageId\":\"11111111-aaaa-bbbb-cccc-EXAMPLE01234\"}"

sendEvent_contentType :: Lens' SendEvent Text Source #

The content type of the request. Supported types are:

application/vnd.amazonaws.connect.event.typing
application/vnd.amazonaws.connect.event.connection.acknowledged
application/vnd.amazonaws.connect.event.message.delivered
application/vnd.amazonaws.connect.event.message.read

sendEvent_connectionToken :: Lens' SendEvent Text Source #

The authentication token associated with the participant's connection.

Destructuring the Response

data SendEventResponse Source #

See: newSendEventResponse smart constructor.

Constructors

SendEventResponse'
Fields absoluteTime :: Maybe Text The time when the event 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 response. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic SendEventResponse Source #
Instance details Defined in Amazonka.ConnectParticipant.SendEvent Associated Types type Rep SendEventResponse :: Type -> Type # Methods from :: SendEventResponse -> Rep SendEventResponse x # to :: Rep SendEventResponse x -> SendEventResponse #
Read SendEventResponse Source #
Instance details Defined in Amazonka.ConnectParticipant.SendEvent Methods readsPrec :: Int -> ReadS SendEventResponse # readList :: ReadS [SendEventResponse] # readPrec :: ReadPrec SendEventResponse # readListPrec :: ReadPrec [SendEventResponse] #
Show SendEventResponse Source #
Instance details Defined in Amazonka.ConnectParticipant.SendEvent Methods showsPrec :: Int -> SendEventResponse -> ShowS # show :: SendEventResponse -> String # showList :: [SendEventResponse] -> ShowS #
NFData SendEventResponse Source #
Instance details Defined in Amazonka.ConnectParticipant.SendEvent Methods rnf :: SendEventResponse -> () #
Eq SendEventResponse Source #
Instance details Defined in Amazonka.ConnectParticipant.SendEvent Methods (==) :: SendEventResponse -> SendEventResponse -> Bool # (/=) :: SendEventResponse -> SendEventResponse -> Bool #
type Rep SendEventResponse Source #
Instance details Defined in Amazonka.ConnectParticipant.SendEvent type Rep SendEventResponse = D1 ('MetaData "SendEventResponse" "Amazonka.ConnectParticipant.SendEvent" "amazonka-connectparticipant-2.0-I4GmkIlwxQUGg1dW7eNFQJ" 'False) (C1 ('MetaCons "SendEventResponse'" '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))))

newSendEventResponse Source #

Arguments

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

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

SendEventResponse, sendEventResponse_absoluteTime - The time when the event was sent.

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

SendEventResponse, sendEventResponse_id - The ID of the response.

$sel:httpStatus:SendEventResponse', sendEventResponse_httpStatus - The response's http status code.

Response Lenses

sendEventResponse_absoluteTime :: Lens' SendEventResponse (Maybe Text) Source #

The time when the event was sent.

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

sendEventResponse_id :: Lens' SendEventResponse (Maybe Text) Source #

The ID of the response.

sendEventResponse_httpStatus :: Lens' SendEventResponse Int Source #

The response's http status code.