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.ChimeSDKMessaging.SendChannelMessage

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Sends a message to a particular channel that the member is a part of.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Also, STANDARD messages can contain 4KB of data and the 1KB of metadata. CONTROL messages can contain 30 bytes of data and no metadata.

Synopsis

data SendChannelMessage = SendChannelMessage' {
- messageAttributes :: Maybe (HashMap Text MessageAttributeValue)
- metadata :: Maybe (Sensitive Text)
- pushNotification :: Maybe PushNotificationConfiguration
- subChannelId :: Maybe Text
- channelArn :: Text
- content :: Sensitive Text
- type' :: ChannelMessageType
- persistence :: ChannelMessagePersistenceType
- clientRequestToken :: Sensitive Text
- chimeBearer :: Text
}
newSendChannelMessage :: Text -> Text -> ChannelMessageType -> ChannelMessagePersistenceType -> Text -> Text -> SendChannelMessage
sendChannelMessage_messageAttributes :: Lens' SendChannelMessage (Maybe (HashMap Text MessageAttributeValue))
sendChannelMessage_metadata :: Lens' SendChannelMessage (Maybe Text)
sendChannelMessage_pushNotification :: Lens' SendChannelMessage (Maybe PushNotificationConfiguration)
sendChannelMessage_subChannelId :: Lens' SendChannelMessage (Maybe Text)
sendChannelMessage_channelArn :: Lens' SendChannelMessage Text
sendChannelMessage_content :: Lens' SendChannelMessage Text
sendChannelMessage_type :: Lens' SendChannelMessage ChannelMessageType
sendChannelMessage_persistence :: Lens' SendChannelMessage ChannelMessagePersistenceType
sendChannelMessage_clientRequestToken :: Lens' SendChannelMessage Text
sendChannelMessage_chimeBearer :: Lens' SendChannelMessage Text
data SendChannelMessageResponse = SendChannelMessageResponse' {
- channelArn :: Maybe Text
- messageId :: Maybe Text
- status :: Maybe ChannelMessageStatusStructure
- subChannelId :: Maybe Text
- httpStatus :: Int
}
newSendChannelMessageResponse :: Int -> SendChannelMessageResponse
sendChannelMessageResponse_channelArn :: Lens' SendChannelMessageResponse (Maybe Text)
sendChannelMessageResponse_messageId :: Lens' SendChannelMessageResponse (Maybe Text)
sendChannelMessageResponse_status :: Lens' SendChannelMessageResponse (Maybe ChannelMessageStatusStructure)
sendChannelMessageResponse_subChannelId :: Lens' SendChannelMessageResponse (Maybe Text)
sendChannelMessageResponse_httpStatus :: Lens' SendChannelMessageResponse Int

Creating a Request

data SendChannelMessage Source #

See: newSendChannelMessage smart constructor.

Constructors

SendChannelMessage'

Fields

messageAttributes :: Maybe (HashMap Text MessageAttributeValue)
The attributes for the message, used for message filtering along with a FilterRule defined in the PushNotificationPreferences.
metadata :: Maybe (Sensitive Text)
The optional metadata for each message.
pushNotification :: Maybe PushNotificationConfiguration
The push notification configuration of the message.
subChannelId :: Maybe Text
The ID of the SubChannel in the request.
channelArn :: Text
The ARN of the channel.
content :: Sensitive Text
The content of the message.
type' :: ChannelMessageType
The type of message, STANDARD or CONTROL.
persistence :: ChannelMessagePersistenceType
Boolean that controls whether the message is persisted on the back end. Required.
clientRequestToken :: Sensitive Text
The Idempotency token for each client request.
chimeBearer :: Text
The AppInstanceUserArn of the user that makes the API call.

Instances

Instances details

ToJSON SendChannelMessage Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.SendChannelMessage Methods toJSON :: SendChannelMessage -> Value # toEncoding :: SendChannelMessage -> Encoding # toJSONList :: [SendChannelMessage] -> Value # toEncodingList :: [SendChannelMessage] -> Encoding #
ToHeaders SendChannelMessage Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.SendChannelMessage Methods toHeaders :: SendChannelMessage -> [Header] #
ToPath SendChannelMessage Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.SendChannelMessage Methods toPath :: SendChannelMessage -> ByteString #
ToQuery SendChannelMessage Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.SendChannelMessage Methods toQuery :: SendChannelMessage -> QueryString #
AWSRequest SendChannelMessage Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.SendChannelMessage Associated Types type AWSResponse SendChannelMessage # Methods request :: (Service -> Service) -> SendChannelMessage -> Request SendChannelMessage # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy SendChannelMessage -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SendChannelMessage))) #
Generic SendChannelMessage Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.SendChannelMessage Associated Types type Rep SendChannelMessage :: Type -> Type # Methods from :: SendChannelMessage -> Rep SendChannelMessage x # to :: Rep SendChannelMessage x -> SendChannelMessage #
Show SendChannelMessage Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.SendChannelMessage Methods showsPrec :: Int -> SendChannelMessage -> ShowS # show :: SendChannelMessage -> String # showList :: [SendChannelMessage] -> ShowS #
NFData SendChannelMessage Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.SendChannelMessage Methods rnf :: SendChannelMessage -> () #
Eq SendChannelMessage Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.SendChannelMessage Methods (==) :: SendChannelMessage -> SendChannelMessage -> Bool # (/=) :: SendChannelMessage -> SendChannelMessage -> Bool #
Hashable SendChannelMessage Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.SendChannelMessage Methods hashWithSalt :: Int -> SendChannelMessage -> Int # hash :: SendChannelMessage -> Int #
type AWSResponse SendChannelMessage Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.SendChannelMessage type AWSResponse SendChannelMessage = SendChannelMessageResponse
type Rep SendChannelMessage Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.SendChannelMessage type Rep SendChannelMessage = D1 ('MetaData "SendChannelMessage" "Amazonka.ChimeSDKMessaging.SendChannelMessage" "amazonka-chime-sdk-messaging-2.0-BxY1AbjLoDB4AQUv82PCQZ" 'False) (C1 ('MetaCons "SendChannelMessage'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "messageAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text MessageAttributeValue))) :: S1 ('MetaSel ('Just "metadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) :: (S1 ('MetaSel ('Just "pushNotification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PushNotificationConfiguration)) :: (S1 ('MetaSel ('Just "subChannelId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "channelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) :: ((S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ChannelMessageType)) :: (S1 ('MetaSel ('Just "persistence") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ChannelMessagePersistenceType) :: (S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 ('MetaSel ('Just "chimeBearer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newSendChannelMessage Source #

Arguments

:: Text	`SendChannelMessage`
-> Text	`SendChannelMessage`
-> ChannelMessageType	`SendChannelMessage`
-> ChannelMessagePersistenceType	`SendChannelMessage`
-> Text	`$sel:clientRequestToken:SendChannelMessage'`
-> Text	`$sel:chimeBearer:SendChannelMessage'`
-> SendChannelMessage

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

SendChannelMessage, sendChannelMessage_messageAttributes - The attributes for the message, used for message filtering along with a FilterRule defined in the PushNotificationPreferences.

SendChannelMessage, sendChannelMessage_metadata - The optional metadata for each message.

SendChannelMessage, sendChannelMessage_pushNotification - The push notification configuration of the message.

SendChannelMessage, sendChannelMessage_subChannelId - The ID of the SubChannel in the request.

SendChannelMessage, sendChannelMessage_channelArn - The ARN of the channel.

SendChannelMessage, sendChannelMessage_content - The content of the message.

SendChannelMessage, sendChannelMessage_type - The type of message, STANDARD or CONTROL.

SendChannelMessage, sendChannelMessage_persistence - Boolean that controls whether the message is persisted on the back end. Required.

$sel:clientRequestToken:SendChannelMessage', sendChannelMessage_clientRequestToken - The Idempotency token for each client request.

$sel:chimeBearer:SendChannelMessage', sendChannelMessage_chimeBearer - The AppInstanceUserArn of the user that makes the API call.

Request Lenses

sendChannelMessage_messageAttributes :: Lens' SendChannelMessage (Maybe (HashMap Text MessageAttributeValue)) Source #

The attributes for the message, used for message filtering along with a FilterRule defined in the PushNotificationPreferences.

sendChannelMessage_metadata :: Lens' SendChannelMessage (Maybe Text) Source #

The optional metadata for each message.

sendChannelMessage_pushNotification :: Lens' SendChannelMessage (Maybe PushNotificationConfiguration) Source #

The push notification configuration of the message.

sendChannelMessage_subChannelId :: Lens' SendChannelMessage (Maybe Text) Source #

The ID of the SubChannel in the request.

sendChannelMessage_channelArn :: Lens' SendChannelMessage Text Source #

The ARN of the channel.

sendChannelMessage_content :: Lens' SendChannelMessage Text Source #

The content of the message.

sendChannelMessage_type :: Lens' SendChannelMessage ChannelMessageType Source #

The type of message, STANDARD or CONTROL.

sendChannelMessage_persistence :: Lens' SendChannelMessage ChannelMessagePersistenceType Source #

Boolean that controls whether the message is persisted on the back end. Required.

sendChannelMessage_clientRequestToken :: Lens' SendChannelMessage Text Source #

The Idempotency token for each client request.

sendChannelMessage_chimeBearer :: Lens' SendChannelMessage Text Source #

The AppInstanceUserArn of the user that makes the API call.

Destructuring the Response

data SendChannelMessageResponse Source #

See: newSendChannelMessageResponse smart constructor.

Constructors

SendChannelMessageResponse'
Fields channelArn :: Maybe Text The ARN of the channel. messageId :: Maybe Text The ID string assigned to each message. status :: Maybe ChannelMessageStatusStructure The status of the channel message. subChannelId :: Maybe Text The ID of the SubChannel in the response. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic SendChannelMessageResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.SendChannelMessage Associated Types type Rep SendChannelMessageResponse :: Type -> Type # Methods from :: SendChannelMessageResponse -> Rep SendChannelMessageResponse x # to :: Rep SendChannelMessageResponse x -> SendChannelMessageResponse #
Read SendChannelMessageResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.SendChannelMessage Methods readsPrec :: Int -> ReadS SendChannelMessageResponse # readList :: ReadS [SendChannelMessageResponse] # readPrec :: ReadPrec SendChannelMessageResponse # readListPrec :: ReadPrec [SendChannelMessageResponse] #
Show SendChannelMessageResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.SendChannelMessage Methods showsPrec :: Int -> SendChannelMessageResponse -> ShowS # show :: SendChannelMessageResponse -> String # showList :: [SendChannelMessageResponse] -> ShowS #
NFData SendChannelMessageResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.SendChannelMessage Methods rnf :: SendChannelMessageResponse -> () #
Eq SendChannelMessageResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.SendChannelMessage Methods (==) :: SendChannelMessageResponse -> SendChannelMessageResponse -> Bool # (/=) :: SendChannelMessageResponse -> SendChannelMessageResponse -> Bool #
type Rep SendChannelMessageResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.SendChannelMessage type Rep SendChannelMessageResponse = D1 ('MetaData "SendChannelMessageResponse" "Amazonka.ChimeSDKMessaging.SendChannelMessage" "amazonka-chime-sdk-messaging-2.0-BxY1AbjLoDB4AQUv82PCQZ" 'False) (C1 ('MetaCons "SendChannelMessageResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "channelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "messageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChannelMessageStatusStructure)) :: (S1 ('MetaSel ('Just "subChannelId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newSendChannelMessageResponse Source #

Arguments

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

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

SendChannelMessage, sendChannelMessageResponse_channelArn - The ARN of the channel.

SendChannelMessageResponse, sendChannelMessageResponse_messageId - The ID string assigned to each message.

SendChannelMessageResponse, sendChannelMessageResponse_status - The status of the channel message.

SendChannelMessage, sendChannelMessageResponse_subChannelId - The ID of the SubChannel in the response.

$sel:httpStatus:SendChannelMessageResponse', sendChannelMessageResponse_httpStatus - The response's http status code.

Response Lenses

sendChannelMessageResponse_channelArn :: Lens' SendChannelMessageResponse (Maybe Text) Source #

The ARN of the channel.

sendChannelMessageResponse_messageId :: Lens' SendChannelMessageResponse (Maybe Text) Source #

The ID string assigned to each message.

sendChannelMessageResponse_status :: Lens' SendChannelMessageResponse (Maybe ChannelMessageStatusStructure) Source #

The status of the channel message.

sendChannelMessageResponse_subChannelId :: Lens' SendChannelMessageResponse (Maybe Text) Source #

The ID of the SubChannel in the response.

sendChannelMessageResponse_httpStatus :: Lens' SendChannelMessageResponse Int Source #

The response's http status code.