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

Description

List all the messages in a channel. Returns a paginated list of ChannelMessages. By default, sorted by creation timestamp in descending order.

Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do not appear in the results. This action always returns the latest version of an edited message.

Also, 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.

Synopsis

Creating a Request

data ListChannelMessages Source #

See: newListChannelMessages smart constructor.

Constructors

ListChannelMessages' 

Fields

Instances

Instances details
Eq ListChannelMessages Source # 
Instance details

Defined in Amazonka.Chime.ListChannelMessages

Show ListChannelMessages Source # 
Instance details

Defined in Amazonka.Chime.ListChannelMessages

Generic ListChannelMessages Source # 
Instance details

Defined in Amazonka.Chime.ListChannelMessages

Associated Types

type Rep ListChannelMessages :: Type -> Type #

NFData ListChannelMessages Source # 
Instance details

Defined in Amazonka.Chime.ListChannelMessages

Methods

rnf :: ListChannelMessages -> () #

Hashable ListChannelMessages Source # 
Instance details

Defined in Amazonka.Chime.ListChannelMessages

AWSRequest ListChannelMessages Source # 
Instance details

Defined in Amazonka.Chime.ListChannelMessages

Associated Types

type AWSResponse ListChannelMessages #

ToHeaders ListChannelMessages Source # 
Instance details

Defined in Amazonka.Chime.ListChannelMessages

ToPath ListChannelMessages Source # 
Instance details

Defined in Amazonka.Chime.ListChannelMessages

ToQuery ListChannelMessages Source # 
Instance details

Defined in Amazonka.Chime.ListChannelMessages

type Rep ListChannelMessages Source # 
Instance details

Defined in Amazonka.Chime.ListChannelMessages

type AWSResponse ListChannelMessages Source # 
Instance details

Defined in Amazonka.Chime.ListChannelMessages

newListChannelMessages Source #

Create a value of ListChannelMessages 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:ListChannelMessages', listChannelMessages_chimeBearer - The AppInstanceUserArn of the user that makes the API call.

$sel:nextToken:ListChannelMessages', listChannelMessages_nextToken - The token passed by previous API calls until all requested messages are returned.

$sel:notBefore:ListChannelMessages', listChannelMessages_notBefore - The initial or starting time stamp for your requested messages.

$sel:sortOrder:ListChannelMessages', listChannelMessages_sortOrder - The order in which you want messages sorted. Default is Descending, based on time created.

$sel:maxResults:ListChannelMessages', listChannelMessages_maxResults - The maximum number of messages that you want returned.

$sel:notAfter:ListChannelMessages', listChannelMessages_notAfter - The final or ending time stamp for your requested messages.

$sel:channelArn:ListChannelMessages', listChannelMessages_channelArn - The ARN of the channel.

Request Lenses

listChannelMessages_chimeBearer :: Lens' ListChannelMessages (Maybe Text) Source #

The AppInstanceUserArn of the user that makes the API call.

listChannelMessages_nextToken :: Lens' ListChannelMessages (Maybe Text) Source #

The token passed by previous API calls until all requested messages are returned.

listChannelMessages_notBefore :: Lens' ListChannelMessages (Maybe UTCTime) Source #

The initial or starting time stamp for your requested messages.

listChannelMessages_sortOrder :: Lens' ListChannelMessages (Maybe SortOrder) Source #

The order in which you want messages sorted. Default is Descending, based on time created.

listChannelMessages_maxResults :: Lens' ListChannelMessages (Maybe Natural) Source #

The maximum number of messages that you want returned.

listChannelMessages_notAfter :: Lens' ListChannelMessages (Maybe UTCTime) Source #

The final or ending time stamp for your requested messages.

Destructuring the Response

data ListChannelMessagesResponse Source #

See: newListChannelMessagesResponse smart constructor.

Constructors

ListChannelMessagesResponse' 

Fields

Instances

Instances details
Eq ListChannelMessagesResponse Source # 
Instance details

Defined in Amazonka.Chime.ListChannelMessages

Show ListChannelMessagesResponse Source # 
Instance details

Defined in Amazonka.Chime.ListChannelMessages

Generic ListChannelMessagesResponse Source # 
Instance details

Defined in Amazonka.Chime.ListChannelMessages

Associated Types

type Rep ListChannelMessagesResponse :: Type -> Type #

NFData ListChannelMessagesResponse Source # 
Instance details

Defined in Amazonka.Chime.ListChannelMessages

type Rep ListChannelMessagesResponse Source # 
Instance details

Defined in Amazonka.Chime.ListChannelMessages

type Rep ListChannelMessagesResponse = D1 ('MetaData "ListChannelMessagesResponse" "Amazonka.Chime.ListChannelMessages" "libZSservicesZSamazonka-chimeZSamazonka-chime" 'False) (C1 ('MetaCons "ListChannelMessagesResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "channelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) :*: (S1 ('MetaSel ('Just "channelMessages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ChannelMessageSummary])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListChannelMessagesResponse Source #

Create a value of ListChannelMessagesResponse 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:ListChannelMessages', listChannelMessagesResponse_channelArn - The ARN of the channel containing the requested messages.

$sel:nextToken:ListChannelMessages', listChannelMessagesResponse_nextToken - The token passed by previous API calls until all requested messages are returned.

$sel:channelMessages:ListChannelMessagesResponse', listChannelMessagesResponse_channelMessages - The information about, and content of, each requested message.

$sel:httpStatus:ListChannelMessagesResponse', listChannelMessagesResponse_httpStatus - The response's http status code.

Response Lenses

listChannelMessagesResponse_channelArn :: Lens' ListChannelMessagesResponse (Maybe Text) Source #

The ARN of the channel containing the requested messages.

listChannelMessagesResponse_nextToken :: Lens' ListChannelMessagesResponse (Maybe Text) Source #

The token passed by previous API calls until all requested messages are returned.

listChannelMessagesResponse_channelMessages :: Lens' ListChannelMessagesResponse (Maybe [ChannelMessageSummary]) Source #

The information about, and content of, each requested message.