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 channel memberships in a channel.
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.
If you want to list the channels to which a specific app instance user belongs, see the ListChannelMembershipsForAppInstanceUser API.
Synopsis
- data ListChannelMemberships = ListChannelMemberships' {}
- newListChannelMemberships :: Text -> Text -> ListChannelMemberships
- listChannelMemberships_maxResults :: Lens' ListChannelMemberships (Maybe Natural)
- listChannelMemberships_nextToken :: Lens' ListChannelMemberships (Maybe Text)
- listChannelMemberships_subChannelId :: Lens' ListChannelMemberships (Maybe Text)
- listChannelMemberships_type :: Lens' ListChannelMemberships (Maybe ChannelMembershipType)
- listChannelMemberships_channelArn :: Lens' ListChannelMemberships Text
- listChannelMemberships_chimeBearer :: Lens' ListChannelMemberships Text
- data ListChannelMembershipsResponse = ListChannelMembershipsResponse' {}
- newListChannelMembershipsResponse :: Int -> ListChannelMembershipsResponse
- listChannelMembershipsResponse_channelArn :: Lens' ListChannelMembershipsResponse (Maybe Text)
- listChannelMembershipsResponse_channelMemberships :: Lens' ListChannelMembershipsResponse (Maybe [ChannelMembershipSummary])
- listChannelMembershipsResponse_nextToken :: Lens' ListChannelMembershipsResponse (Maybe Text)
- listChannelMembershipsResponse_httpStatus :: Lens' ListChannelMembershipsResponse Int
Creating a Request
data ListChannelMemberships Source #
See: newListChannelMemberships
smart constructor.
ListChannelMemberships' | |
|
Instances
newListChannelMemberships Source #
:: Text | |
-> Text | |
-> ListChannelMemberships |
Create a value of ListChannelMemberships
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:ListChannelMemberships'
, listChannelMemberships_maxResults
- The maximum number of channel memberships that you want returned.
ListChannelMemberships
, listChannelMemberships_nextToken
- The token passed by previous API calls until all requested channel
memberships are returned.
ListChannelMemberships
, listChannelMemberships_subChannelId
- The ID of the SubChannel in the request.
Only required when listing a user's memberships in a particular sub-channel of an elastic channel.
ListChannelMemberships
, listChannelMemberships_type
- The membership type of a user, DEFAULT
or HIDDEN
. Default members
are returned as part of ListChannelMemberships
if no type is
specified. Hidden members are only returned if the type filter in
ListChannelMemberships
equals HIDDEN
.
ListChannelMemberships
, listChannelMemberships_channelArn
- The maximum number of channel memberships that you want returned.
$sel:chimeBearer:ListChannelMemberships'
, listChannelMemberships_chimeBearer
- The AppInstanceUserArn
of the user that makes the API call.
Request Lenses
listChannelMemberships_maxResults :: Lens' ListChannelMemberships (Maybe Natural) Source #
The maximum number of channel memberships that you want returned.
listChannelMemberships_nextToken :: Lens' ListChannelMemberships (Maybe Text) Source #
The token passed by previous API calls until all requested channel memberships are returned.
listChannelMemberships_subChannelId :: Lens' ListChannelMemberships (Maybe Text) Source #
The ID of the SubChannel in the request.
Only required when listing a user's memberships in a particular sub-channel of an elastic channel.
listChannelMemberships_type :: Lens' ListChannelMemberships (Maybe ChannelMembershipType) Source #
The membership type of a user, DEFAULT
or HIDDEN
. Default members
are returned as part of ListChannelMemberships
if no type is
specified. Hidden members are only returned if the type filter in
ListChannelMemberships
equals HIDDEN
.
listChannelMemberships_channelArn :: Lens' ListChannelMemberships Text Source #
The maximum number of channel memberships that you want returned.
listChannelMemberships_chimeBearer :: Lens' ListChannelMemberships Text Source #
The AppInstanceUserArn
of the user that makes the API call.
Destructuring the Response
data ListChannelMembershipsResponse Source #
See: newListChannelMembershipsResponse
smart constructor.
ListChannelMembershipsResponse' | |
|
Instances
newListChannelMembershipsResponse Source #
Create a value of ListChannelMembershipsResponse
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:
ListChannelMemberships
, listChannelMembershipsResponse_channelArn
- The ARN of the channel.
$sel:channelMemberships:ListChannelMembershipsResponse'
, listChannelMembershipsResponse_channelMemberships
- The information for the requested channel memberships.
ListChannelMemberships
, listChannelMembershipsResponse_nextToken
- The token passed by previous API calls until all requested channel
memberships are returned.
$sel:httpStatus:ListChannelMembershipsResponse'
, listChannelMembershipsResponse_httpStatus
- The response's http status code.
Response Lenses
listChannelMembershipsResponse_channelArn :: Lens' ListChannelMembershipsResponse (Maybe Text) Source #
The ARN of the channel.
listChannelMembershipsResponse_channelMemberships :: Lens' ListChannelMembershipsResponse (Maybe [ChannelMembershipSummary]) Source #
The information for the requested channel memberships.
listChannelMembershipsResponse_nextToken :: Lens' ListChannelMembershipsResponse (Maybe Text) Source #
The token passed by previous API calls until all requested channel memberships are returned.
listChannelMembershipsResponse_httpStatus :: Lens' ListChannelMembershipsResponse Int Source #
The response's http status code.