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

Creating a Request

data ListChannelMessages Source #

See: newListChannelMessages smart constructor.

Constructors

ListChannelMessages'

Fields

chimeBearer :: Maybe Text
The AppInstanceUserArn of the user that makes the API call.
maxResults :: Maybe Natural
The maximum number of messages that you want returned.
nextToken :: Maybe (Sensitive Text)
The token passed by previous API calls until all requested messages are returned.
notAfter :: Maybe POSIX
The final or ending time stamp for your requested messages.
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.
channelArn :: Text
The ARN of the channel.

Instances

Instances details

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

newListChannelMessages Source #

Arguments

:: Text	`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:chimeBearer:ListChannelMessages', listChannelMessages_chimeBearer - The AppInstanceUserArn of the user that makes the API call.

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

ListChannelMessages, listChannelMessages_nextToken - The token passed by previous API calls until all requested messages are returned.

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

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

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_maxResults :: Lens' ListChannelMessages (Maybe Natural) Source #

The maximum number of messages that you want returned.

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

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

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

The final or ending time stamp for your requested messages.

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_channelArn :: Lens' ListChannelMessages Text Source #

The ARN of the channel.

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. channelMessages :: Maybe [ChannelMessageSummary] The information about, and content of, each requested message. nextToken :: Maybe (Sensitive Text) The token passed by previous API calls until all requested messages are returned. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListChannelMessagesResponse Source #
Instance details Defined in Amazonka.Chime.ListChannelMessages Associated Types type Rep ListChannelMessagesResponse :: Type -> Type # Methods from :: ListChannelMessagesResponse -> Rep ListChannelMessagesResponse x # to :: Rep ListChannelMessagesResponse x -> ListChannelMessagesResponse #
Show ListChannelMessagesResponse Source #
Instance details Defined in Amazonka.Chime.ListChannelMessages Methods showsPrec :: Int -> ListChannelMessagesResponse -> ShowS # show :: ListChannelMessagesResponse -> String # showList :: [ListChannelMessagesResponse] -> ShowS #
NFData ListChannelMessagesResponse Source #
Instance details Defined in Amazonka.Chime.ListChannelMessages Methods rnf :: ListChannelMessagesResponse -> () #
Eq ListChannelMessagesResponse Source #
Instance details Defined in Amazonka.Chime.ListChannelMessages Methods (==) :: ListChannelMessagesResponse -> ListChannelMessagesResponse -> Bool # (/=) :: ListChannelMessagesResponse -> ListChannelMessagesResponse -> Bool #
type Rep ListChannelMessagesResponse Source #
Instance details Defined in Amazonka.Chime.ListChannelMessages type Rep ListChannelMessagesResponse = D1 ('MetaData "ListChannelMessagesResponse" "Amazonka.Chime.ListChannelMessages" "amazonka-chime-2.0-AQIuSSkHccQ9VXokPBc5Nb" 'False) (C1 ('MetaCons "ListChannelMessagesResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "channelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "channelMessages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ChannelMessageSummary]))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: 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:

ListChannelMessages, listChannelMessagesResponse_channelArn - The ARN of the channel containing the requested messages.

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

ListChannelMessages, listChannelMessagesResponse_nextToken - The token passed by previous API calls until all requested messages are returned.

$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_channelMessages :: Lens' ListChannelMessagesResponse (Maybe [ChannelMessageSummary]) Source #

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

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

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

listChannelMessagesResponse_httpStatus :: Lens' ListChannelMessagesResponse Int Source #

The response's http status code.