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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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

data ListChannelMessages = ListChannelMessages' {
- nextToken :: Maybe (Sensitive Text)
- notBefore :: Maybe POSIX
- sortOrder :: Maybe SortOrder
- maxResults :: Maybe Natural
- notAfter :: Maybe POSIX
- channelArn :: Text
- chimeBearer :: Text
}
newListChannelMessages :: Text -> Text -> ListChannelMessages
listChannelMessages_nextToken :: Lens' ListChannelMessages (Maybe Text)
listChannelMessages_notBefore :: Lens' ListChannelMessages (Maybe UTCTime)
listChannelMessages_sortOrder :: Lens' ListChannelMessages (Maybe SortOrder)
listChannelMessages_maxResults :: Lens' ListChannelMessages (Maybe Natural)
listChannelMessages_notAfter :: Lens' ListChannelMessages (Maybe UTCTime)
listChannelMessages_channelArn :: Lens' ListChannelMessages Text
listChannelMessages_chimeBearer :: Lens' ListChannelMessages Text
data ListChannelMessagesResponse = ListChannelMessagesResponse' {
- channelArn :: Maybe Text
- nextToken :: Maybe (Sensitive Text)
- channelMessages :: Maybe [ChannelMessageSummary]
- httpStatus :: Int
}
newListChannelMessagesResponse :: Int -> ListChannelMessagesResponse
listChannelMessagesResponse_channelArn :: Lens' ListChannelMessagesResponse (Maybe Text)
listChannelMessagesResponse_nextToken :: Lens' ListChannelMessagesResponse (Maybe Text)
listChannelMessagesResponse_channelMessages :: Lens' ListChannelMessagesResponse (Maybe [ChannelMessageSummary])
listChannelMessagesResponse_httpStatus :: Lens' ListChannelMessagesResponse Int

Creating a Request

data ListChannelMessages Source #

See: newListChannelMessages smart constructor.

Constructors

ListChannelMessages'

Fields

nextToken :: Maybe (Sensitive Text)
The token passed by previous API calls until all requested messages are returned.
notBefore :: Maybe POSIX
The initial or starting time stamp for your requested messages.
sortOrder :: Maybe SortOrder
The order in which you want messages sorted. Default is Descending, based on time created.
maxResults :: Maybe Natural
The maximum number of messages that you want returned.
notAfter :: Maybe POSIX
The final or ending time stamp for your requested messages.
channelArn :: Text
The ARN of the channel.
chimeBearer :: Text
The AppInstanceUserArn of the user that makes the API call.

Instances

Instances details

Eq ListChannelMessages Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelMessages Methods (==) :: ListChannelMessages -> ListChannelMessages -> Bool # (/=) :: ListChannelMessages -> ListChannelMessages -> Bool #
Show ListChannelMessages Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelMessages Methods showsPrec :: Int -> ListChannelMessages -> ShowS # show :: ListChannelMessages -> String # showList :: [ListChannelMessages] -> ShowS #
Generic ListChannelMessages Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelMessages Associated Types type Rep ListChannelMessages :: Type -> Type # Methods from :: ListChannelMessages -> Rep ListChannelMessages x # to :: Rep ListChannelMessages x -> ListChannelMessages #
NFData ListChannelMessages Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelMessages Methods rnf :: ListChannelMessages -> () #
Hashable ListChannelMessages Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelMessages Methods hashWithSalt :: Int -> ListChannelMessages -> Int # hash :: ListChannelMessages -> Int #
AWSRequest ListChannelMessages Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelMessages Associated Types type AWSResponse ListChannelMessages # Methods request :: ListChannelMessages -> Request ListChannelMessages # response :: MonadResource m => Logger -> Service -> Proxy ListChannelMessages -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListChannelMessages))) #
ToHeaders ListChannelMessages Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelMessages Methods toHeaders :: ListChannelMessages -> [Header] #
ToPath ListChannelMessages Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelMessages Methods toPath :: ListChannelMessages -> ByteString #
ToQuery ListChannelMessages Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelMessages Methods toQuery :: ListChannelMessages -> QueryString #
type Rep ListChannelMessages Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelMessages type Rep ListChannelMessages = D1 ('MetaData "ListChannelMessages" "Amazonka.ChimeSDKMessaging.ListChannelMessages" "libZSservicesZSamazonka-chime-sdk-messagingZSamazonka-chime-sdk-messaging" 'False) (C1 ('MetaCons "ListChannelMessages'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: (S1 ('MetaSel ('Just "notBefore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "sortOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SortOrder)))) :: ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "notAfter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "channelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "chimeBearer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse ListChannelMessages Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelMessages type AWSResponse ListChannelMessages = ListChannelMessagesResponse

newListChannelMessages Source #

Arguments

:: Text	`$sel:channelArn:ListChannelMessages'`
-> Text	`$sel:chimeBearer:ListChannelMessages'`
-> ListChannelMessages

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

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

Request Lenses

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.

listChannelMessages_channelArn :: Lens' ListChannelMessages Text Source #

The ARN of the channel.

listChannelMessages_chimeBearer :: Lens' ListChannelMessages Text Source #

The AppInstanceUserArn of the user that makes the API call.

Destructuring the Response

data ListChannelMessagesResponse Source #

See: newListChannelMessagesResponse smart constructor.

Constructors

ListChannelMessagesResponse'
Fields channelArn :: Maybe Text The ARN of the channel containing the requested messages. nextToken :: Maybe (Sensitive Text) The token passed by previous API calls until all requested messages are returned. channelMessages :: Maybe [ChannelMessageSummary] The information about, and content of, each requested message. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq ListChannelMessagesResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelMessages Methods (==) :: ListChannelMessagesResponse -> ListChannelMessagesResponse -> Bool # (/=) :: ListChannelMessagesResponse -> ListChannelMessagesResponse -> Bool #
Show ListChannelMessagesResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelMessages Methods showsPrec :: Int -> ListChannelMessagesResponse -> ShowS # show :: ListChannelMessagesResponse -> String # showList :: [ListChannelMessagesResponse] -> ShowS #
Generic ListChannelMessagesResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelMessages Associated Types type Rep ListChannelMessagesResponse :: Type -> Type # Methods from :: ListChannelMessagesResponse -> Rep ListChannelMessagesResponse x # to :: Rep ListChannelMessagesResponse x -> ListChannelMessagesResponse #
NFData ListChannelMessagesResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelMessages Methods rnf :: ListChannelMessagesResponse -> () #
type Rep ListChannelMessagesResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelMessages type Rep ListChannelMessagesResponse = D1 ('MetaData "ListChannelMessagesResponse" "Amazonka.ChimeSDKMessaging.ListChannelMessages" "libZSservicesZSamazonka-chime-sdk-messagingZSamazonka-chime-sdk-messaging" '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 #

Arguments

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

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.

listChannelMessagesResponse_httpStatus :: Lens' ListChannelMessagesResponse Int Source #

The response's http status code.