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.Chime.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' {
- chimeBearer :: Maybe Text
- metadata :: Maybe (Sensitive Text)
- channelArn :: Text
- content :: Sensitive Text
- type' :: ChannelMessageType
- persistence :: ChannelMessagePersistenceType
- clientRequestToken :: Sensitive Text
}
newSendChannelMessage :: Text -> Text -> ChannelMessageType -> ChannelMessagePersistenceType -> Text -> SendChannelMessage
sendChannelMessage_chimeBearer :: Lens' SendChannelMessage (Maybe Text)
sendChannelMessage_metadata :: 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
data SendChannelMessageResponse = SendChannelMessageResponse' {
- channelArn :: Maybe Text
- messageId :: Maybe Text
- httpStatus :: Int
}
newSendChannelMessageResponse :: Int -> SendChannelMessageResponse
sendChannelMessageResponse_channelArn :: Lens' SendChannelMessageResponse (Maybe Text)
sendChannelMessageResponse_messageId :: Lens' SendChannelMessageResponse (Maybe Text)
sendChannelMessageResponse_httpStatus :: Lens' SendChannelMessageResponse Int

Creating a Request

data SendChannelMessage Source #

See: newSendChannelMessage smart constructor.

Constructors

SendChannelMessage'

Fields

chimeBearer :: Maybe Text
The AppInstanceUserArn of the user that makes the API call.
metadata :: Maybe (Sensitive Text)
The optional metadata for each message.
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.

Instances

Instances details

Eq SendChannelMessage Source #
Instance details Defined in Amazonka.Chime.SendChannelMessage Methods (==) :: SendChannelMessage -> SendChannelMessage -> Bool # (/=) :: SendChannelMessage -> SendChannelMessage -> Bool #
Show SendChannelMessage Source #
Instance details Defined in Amazonka.Chime.SendChannelMessage Methods showsPrec :: Int -> SendChannelMessage -> ShowS # show :: SendChannelMessage -> String # showList :: [SendChannelMessage] -> ShowS #
Generic SendChannelMessage Source #
Instance details Defined in Amazonka.Chime.SendChannelMessage Associated Types type Rep SendChannelMessage :: Type -> Type # Methods from :: SendChannelMessage -> Rep SendChannelMessage x # to :: Rep SendChannelMessage x -> SendChannelMessage #
NFData SendChannelMessage Source #
Instance details Defined in Amazonka.Chime.SendChannelMessage Methods rnf :: SendChannelMessage -> () #
Hashable SendChannelMessage Source #
Instance details Defined in Amazonka.Chime.SendChannelMessage Methods hashWithSalt :: Int -> SendChannelMessage -> Int # hash :: SendChannelMessage -> Int #
ToJSON SendChannelMessage Source #
Instance details Defined in Amazonka.Chime.SendChannelMessage Methods toJSON :: SendChannelMessage -> Value # toEncoding :: SendChannelMessage -> Encoding # toJSONList :: [SendChannelMessage] -> Value # toEncodingList :: [SendChannelMessage] -> Encoding #
AWSRequest SendChannelMessage Source #
Instance details Defined in Amazonka.Chime.SendChannelMessage Associated Types type AWSResponse SendChannelMessage # Methods request :: SendChannelMessage -> Request SendChannelMessage # response :: MonadResource m => Logger -> Service -> Proxy SendChannelMessage -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SendChannelMessage))) #
ToHeaders SendChannelMessage Source #
Instance details Defined in Amazonka.Chime.SendChannelMessage Methods toHeaders :: SendChannelMessage -> [Header] #
ToPath SendChannelMessage Source #
Instance details Defined in Amazonka.Chime.SendChannelMessage Methods toPath :: SendChannelMessage -> ByteString #
ToQuery SendChannelMessage Source #
Instance details Defined in Amazonka.Chime.SendChannelMessage Methods toQuery :: SendChannelMessage -> QueryString #
type Rep SendChannelMessage Source #
Instance details Defined in Amazonka.Chime.SendChannelMessage type Rep SendChannelMessage = D1 ('MetaData "SendChannelMessage" "Amazonka.Chime.SendChannelMessage" "libZSservicesZSamazonka-chimeZSamazonka-chime" 'False) (C1 ('MetaCons "SendChannelMessage'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "chimeBearer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "metadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive 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))))))
type AWSResponse SendChannelMessage Source #
Instance details Defined in Amazonka.Chime.SendChannelMessage type AWSResponse SendChannelMessage = SendChannelMessageResponse

newSendChannelMessage Source #

Arguments

:: Text	`$sel:channelArn:SendChannelMessage'`
-> Text	`$sel:content:SendChannelMessage'`
-> ChannelMessageType	`$sel:type':SendChannelMessage'`
-> ChannelMessagePersistenceType	`$sel:persistence:SendChannelMessage'`
-> Text	`$sel:clientRequestToken: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:

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

$sel:metadata:SendChannelMessage', sendChannelMessage_metadata - The optional metadata for each message.

$sel:channelArn:SendChannelMessage', sendChannelMessage_channelArn - The ARN of the channel.

$sel:content:SendChannelMessage', sendChannelMessage_content - The content of the message.

$sel:type':SendChannelMessage', sendChannelMessage_type - The type of message, STANDARD or CONTROL.

$sel:persistence: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.

Request Lenses

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

The AppInstanceUserArn of the user that makes the API call.

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

The optional metadata for each message.

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.

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. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq SendChannelMessageResponse Source #
Instance details Defined in Amazonka.Chime.SendChannelMessage Methods (==) :: SendChannelMessageResponse -> SendChannelMessageResponse -> Bool # (/=) :: SendChannelMessageResponse -> SendChannelMessageResponse -> Bool #
Read SendChannelMessageResponse Source #
Instance details Defined in Amazonka.Chime.SendChannelMessage Methods readsPrec :: Int -> ReadS SendChannelMessageResponse # readList :: ReadS [SendChannelMessageResponse] # readPrec :: ReadPrec SendChannelMessageResponse # readListPrec :: ReadPrec [SendChannelMessageResponse] #
Show SendChannelMessageResponse Source #
Instance details Defined in Amazonka.Chime.SendChannelMessage Methods showsPrec :: Int -> SendChannelMessageResponse -> ShowS # show :: SendChannelMessageResponse -> String # showList :: [SendChannelMessageResponse] -> ShowS #
Generic SendChannelMessageResponse Source #
Instance details Defined in Amazonka.Chime.SendChannelMessage Associated Types type Rep SendChannelMessageResponse :: Type -> Type # Methods from :: SendChannelMessageResponse -> Rep SendChannelMessageResponse x # to :: Rep SendChannelMessageResponse x -> SendChannelMessageResponse #
NFData SendChannelMessageResponse Source #
Instance details Defined in Amazonka.Chime.SendChannelMessage Methods rnf :: SendChannelMessageResponse -> () #
type Rep SendChannelMessageResponse Source #
Instance details Defined in Amazonka.Chime.SendChannelMessage type Rep SendChannelMessageResponse = D1 ('MetaData "SendChannelMessageResponse" "Amazonka.Chime.SendChannelMessage" "libZSservicesZSamazonka-chimeZSamazonka-chime" '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 "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:

$sel:channelArn:SendChannelMessage', sendChannelMessageResponse_channelArn - The ARN of the channel.

$sel:messageId:SendChannelMessageResponse', sendChannelMessageResponse_messageId - The ID string assigned to each message.

$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_httpStatus :: Lens' SendChannelMessageResponse Int Source #

The response's http status code.