libZSservicesZSamazonka-chimeZSamazonka-chime
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Chime.SendChannelMessage

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

Creating a Request

data SendChannelMessage Source #

See: newSendChannelMessage smart constructor.

Constructors

SendChannelMessage' 

Fields

Instances

Instances details
Eq SendChannelMessage Source # 
Instance details

Defined in Amazonka.Chime.SendChannelMessage

Show SendChannelMessage Source # 
Instance details

Defined in Amazonka.Chime.SendChannelMessage

Generic SendChannelMessage Source # 
Instance details

Defined in Amazonka.Chime.SendChannelMessage

Associated Types

type Rep SendChannelMessage :: Type -> Type #

NFData SendChannelMessage Source # 
Instance details

Defined in Amazonka.Chime.SendChannelMessage

Methods

rnf :: SendChannelMessage -> () #

Hashable SendChannelMessage Source # 
Instance details

Defined in Amazonka.Chime.SendChannelMessage

ToJSON SendChannelMessage Source # 
Instance details

Defined in Amazonka.Chime.SendChannelMessage

AWSRequest SendChannelMessage Source # 
Instance details

Defined in Amazonka.Chime.SendChannelMessage

Associated Types

type AWSResponse SendChannelMessage #

ToHeaders SendChannelMessage Source # 
Instance details

Defined in Amazonka.Chime.SendChannelMessage

ToPath SendChannelMessage Source # 
Instance details

Defined in Amazonka.Chime.SendChannelMessage

ToQuery SendChannelMessage Source # 
Instance details

Defined in Amazonka.Chime.SendChannelMessage

type Rep SendChannelMessage Source # 
Instance details

Defined in Amazonka.Chime.SendChannelMessage

type AWSResponse SendChannelMessage Source # 
Instance details

Defined in Amazonka.Chime.SendChannelMessage

newSendChannelMessage Source #

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_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

Instances

Instances details
Eq SendChannelMessageResponse Source # 
Instance details

Defined in Amazonka.Chime.SendChannelMessage

Read SendChannelMessageResponse Source # 
Instance details

Defined in Amazonka.Chime.SendChannelMessage

Show SendChannelMessageResponse Source # 
Instance details

Defined in Amazonka.Chime.SendChannelMessage

Generic SendChannelMessageResponse Source # 
Instance details

Defined in Amazonka.Chime.SendChannelMessage

Associated Types

type Rep SendChannelMessageResponse :: Type -> Type #

NFData SendChannelMessageResponse Source # 
Instance details

Defined in Amazonka.Chime.SendChannelMessage

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 #

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