| 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.ChimeSDKMessaging.SearchChannels
Description
Allows ChimeBearer to search channels by channel members.
AppInstanceUsers can search across the channels that they belong to.
AppInstanceAdmins can search across all channels.
Synopsis
- data SearchChannels = SearchChannels' {}
- newSearchChannels :: NonEmpty SearchField -> SearchChannels
- searchChannels_chimeBearer :: Lens' SearchChannels (Maybe Text)
- searchChannels_maxResults :: Lens' SearchChannels (Maybe Natural)
- searchChannels_nextToken :: Lens' SearchChannels (Maybe Text)
- searchChannels_fields :: Lens' SearchChannels (NonEmpty SearchField)
- data SearchChannelsResponse = SearchChannelsResponse' {
- channels :: Maybe [ChannelSummary]
- nextToken :: Maybe (Sensitive Text)
- httpStatus :: Int
- newSearchChannelsResponse :: Int -> SearchChannelsResponse
- searchChannelsResponse_channels :: Lens' SearchChannelsResponse (Maybe [ChannelSummary])
- searchChannelsResponse_nextToken :: Lens' SearchChannelsResponse (Maybe Text)
- searchChannelsResponse_httpStatus :: Lens' SearchChannelsResponse Int
Creating a Request
data SearchChannels Source #
See: newSearchChannels smart constructor.
Constructors
| SearchChannels' | |
Fields
| |
Instances
Arguments
| :: NonEmpty SearchField | |
| -> SearchChannels |
Create a value of SearchChannels 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:SearchChannels', searchChannels_chimeBearer - The AppInstanceUserArn of the user making the API call.
$sel:maxResults:SearchChannels', searchChannels_maxResults - The maximum number of channels that you want returned.
SearchChannels, searchChannels_nextToken - The token returned from previous API requests until the number of
channels is reached.
$sel:fields:SearchChannels', searchChannels_fields - A list of the Field objects in the channel being searched.
Request Lenses
searchChannels_chimeBearer :: Lens' SearchChannels (Maybe Text) Source #
The AppInstanceUserArn of the user making the API call.
searchChannels_maxResults :: Lens' SearchChannels (Maybe Natural) Source #
The maximum number of channels that you want returned.
searchChannels_nextToken :: Lens' SearchChannels (Maybe Text) Source #
The token returned from previous API requests until the number of channels is reached.
searchChannels_fields :: Lens' SearchChannels (NonEmpty SearchField) Source #
A list of the Field objects in the channel being searched.
Destructuring the Response
data SearchChannelsResponse Source #
See: newSearchChannelsResponse smart constructor.
Constructors
| SearchChannelsResponse' | |
Fields
| |
Instances
newSearchChannelsResponse Source #
Create a value of SearchChannelsResponse 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:channels:SearchChannelsResponse', searchChannelsResponse_channels - A list of the channels in the request.
SearchChannels, searchChannelsResponse_nextToken - The token returned from previous API responses until the number of
channels is reached.
$sel:httpStatus:SearchChannelsResponse', searchChannelsResponse_httpStatus - The response's http status code.
Response Lenses
searchChannelsResponse_channels :: Lens' SearchChannelsResponse (Maybe [ChannelSummary]) Source #
A list of the channels in the request.
searchChannelsResponse_nextToken :: Lens' SearchChannelsResponse (Maybe Text) Source #
The token returned from previous API responses until the number of channels is reached.
searchChannelsResponse_httpStatus :: Lens' SearchChannelsResponse Int Source #
The response's http status code.