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 |
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
- data SendMessage = SendMessage' {
- clientToken :: Maybe Text
- contentType :: Text
- content :: Text
- connectionToken :: Text
- newSendMessage :: Text -> Text -> Text -> SendMessage
- sendMessage_clientToken :: Lens' SendMessage (Maybe Text)
- sendMessage_contentType :: Lens' SendMessage Text
- sendMessage_content :: Lens' SendMessage Text
- sendMessage_connectionToken :: Lens' SendMessage Text
- data SendMessageResponse = SendMessageResponse' {
- absoluteTime :: Maybe Text
- id :: Maybe Text
- httpStatus :: Int
- newSendMessageResponse :: Int -> SendMessageResponse
- sendMessageResponse_absoluteTime :: Lens' SendMessageResponse (Maybe Text)
- sendMessageResponse_id :: Lens' SendMessageResponse (Maybe Text)
- sendMessageResponse_httpStatus :: Lens' SendMessageResponse Int
Creating a Request
data SendMessage Source #
See: newSendMessage
smart constructor.
SendMessage' | |
|
Instances
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
andtext/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
andtext/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.
SendMessageResponse' | |
|
Instances
newSendMessageResponse Source #
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.