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 |
Lists all the SubChannels in an elastic channel when given a channel ID. Available only to the app instance admins and channel moderators of elastic channels.
Synopsis
- data ListSubChannels = ListSubChannels' {
- maxResults :: Maybe Natural
- nextToken :: Maybe (Sensitive Text)
- channelArn :: Text
- chimeBearer :: Text
- newListSubChannels :: Text -> Text -> ListSubChannels
- listSubChannels_maxResults :: Lens' ListSubChannels (Maybe Natural)
- listSubChannels_nextToken :: Lens' ListSubChannels (Maybe Text)
- listSubChannels_channelArn :: Lens' ListSubChannels Text
- listSubChannels_chimeBearer :: Lens' ListSubChannels Text
- data ListSubChannelsResponse = ListSubChannelsResponse' {
- channelArn :: Maybe Text
- nextToken :: Maybe (Sensitive Text)
- subChannels :: Maybe [SubChannelSummary]
- httpStatus :: Int
- newListSubChannelsResponse :: Int -> ListSubChannelsResponse
- listSubChannelsResponse_channelArn :: Lens' ListSubChannelsResponse (Maybe Text)
- listSubChannelsResponse_nextToken :: Lens' ListSubChannelsResponse (Maybe Text)
- listSubChannelsResponse_subChannels :: Lens' ListSubChannelsResponse (Maybe [SubChannelSummary])
- listSubChannelsResponse_httpStatus :: Lens' ListSubChannelsResponse Int
Creating a Request
data ListSubChannels Source #
See: newListSubChannels
smart constructor.
ListSubChannels' | |
|
Instances
Create a value of ListSubChannels
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:maxResults:ListSubChannels'
, listSubChannels_maxResults
- The maximum number of sub-channels that you want to return.
ListSubChannels
, listSubChannels_nextToken
- The token passed by previous API calls until all requested sub-channels
are returned.
ListSubChannels
, listSubChannels_channelArn
- The ARN of elastic channel.
$sel:chimeBearer:ListSubChannels'
, listSubChannels_chimeBearer
- The AppInstanceUserArn
of the user making the API call.
Request Lenses
listSubChannels_maxResults :: Lens' ListSubChannels (Maybe Natural) Source #
The maximum number of sub-channels that you want to return.
listSubChannels_nextToken :: Lens' ListSubChannels (Maybe Text) Source #
The token passed by previous API calls until all requested sub-channels are returned.
listSubChannels_channelArn :: Lens' ListSubChannels Text Source #
The ARN of elastic channel.
listSubChannels_chimeBearer :: Lens' ListSubChannels Text Source #
The AppInstanceUserArn
of the user making the API call.
Destructuring the Response
data ListSubChannelsResponse Source #
See: newListSubChannelsResponse
smart constructor.
ListSubChannelsResponse' | |
|
Instances
newListSubChannelsResponse Source #
Create a value of ListSubChannelsResponse
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:
ListSubChannels
, listSubChannelsResponse_channelArn
- The ARN of elastic channel.
ListSubChannels
, listSubChannelsResponse_nextToken
- The token passed by previous API calls until all requested sub-channels
are returned.
$sel:subChannels:ListSubChannelsResponse'
, listSubChannelsResponse_subChannels
- The information about each sub-channel.
$sel:httpStatus:ListSubChannelsResponse'
, listSubChannelsResponse_httpStatus
- The response's http status code.
Response Lenses
listSubChannelsResponse_channelArn :: Lens' ListSubChannelsResponse (Maybe Text) Source #
The ARN of elastic channel.
listSubChannelsResponse_nextToken :: Lens' ListSubChannelsResponse (Maybe Text) Source #
The token passed by previous API calls until all requested sub-channels are returned.
listSubChannelsResponse_subChannels :: Lens' ListSubChannelsResponse (Maybe [SubChannelSummary]) Source #
The information about each sub-channel.
listSubChannelsResponse_httpStatus :: Lens' ListSubChannelsResponse Int Source #
The response's http status code.