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.Chime.ListChannelMembershipsForAppInstanceUser
Description
Lists all channels that a particular AppInstanceUser
is a part of.
Only an AppInstanceAdmin
can call the API with a user ARN that is not
their own.
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 ListChannelMembershipsForAppInstanceUser = ListChannelMembershipsForAppInstanceUser' {}
- newListChannelMembershipsForAppInstanceUser :: ListChannelMembershipsForAppInstanceUser
- listChannelMembershipsForAppInstanceUser_appInstanceUserArn :: Lens' ListChannelMembershipsForAppInstanceUser (Maybe Text)
- listChannelMembershipsForAppInstanceUser_chimeBearer :: Lens' ListChannelMembershipsForAppInstanceUser (Maybe Text)
- listChannelMembershipsForAppInstanceUser_nextToken :: Lens' ListChannelMembershipsForAppInstanceUser (Maybe Text)
- listChannelMembershipsForAppInstanceUser_maxResults :: Lens' ListChannelMembershipsForAppInstanceUser (Maybe Natural)
- data ListChannelMembershipsForAppInstanceUserResponse = ListChannelMembershipsForAppInstanceUserResponse' {}
- newListChannelMembershipsForAppInstanceUserResponse :: Int -> ListChannelMembershipsForAppInstanceUserResponse
- listChannelMembershipsForAppInstanceUserResponse_channelMemberships :: Lens' ListChannelMembershipsForAppInstanceUserResponse (Maybe [ChannelMembershipForAppInstanceUserSummary])
- listChannelMembershipsForAppInstanceUserResponse_nextToken :: Lens' ListChannelMembershipsForAppInstanceUserResponse (Maybe Text)
- listChannelMembershipsForAppInstanceUserResponse_httpStatus :: Lens' ListChannelMembershipsForAppInstanceUserResponse Int
Creating a Request
data ListChannelMembershipsForAppInstanceUser Source #
See: newListChannelMembershipsForAppInstanceUser
smart constructor.
Constructors
ListChannelMembershipsForAppInstanceUser' | |
Fields
|
Instances
newListChannelMembershipsForAppInstanceUser :: ListChannelMembershipsForAppInstanceUser Source #
Create a value of ListChannelMembershipsForAppInstanceUser
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:appInstanceUserArn:ListChannelMembershipsForAppInstanceUser'
, listChannelMembershipsForAppInstanceUser_appInstanceUserArn
- The ARN of the AppInstanceUser
s
$sel:chimeBearer:ListChannelMembershipsForAppInstanceUser'
, listChannelMembershipsForAppInstanceUser_chimeBearer
- The AppInstanceUserArn
of the user that makes the API call.
$sel:nextToken:ListChannelMembershipsForAppInstanceUser'
, listChannelMembershipsForAppInstanceUser_nextToken
- The token returned from previous API requests until the number of
channel memberships is reached.
$sel:maxResults:ListChannelMembershipsForAppInstanceUser'
, listChannelMembershipsForAppInstanceUser_maxResults
- The maximum number of users that you want returned.
Request Lenses
listChannelMembershipsForAppInstanceUser_appInstanceUserArn :: Lens' ListChannelMembershipsForAppInstanceUser (Maybe Text) Source #
The ARN of the AppInstanceUser
s
listChannelMembershipsForAppInstanceUser_chimeBearer :: Lens' ListChannelMembershipsForAppInstanceUser (Maybe Text) Source #
The AppInstanceUserArn
of the user that makes the API call.
listChannelMembershipsForAppInstanceUser_nextToken :: Lens' ListChannelMembershipsForAppInstanceUser (Maybe Text) Source #
The token returned from previous API requests until the number of channel memberships is reached.
listChannelMembershipsForAppInstanceUser_maxResults :: Lens' ListChannelMembershipsForAppInstanceUser (Maybe Natural) Source #
The maximum number of users that you want returned.
Destructuring the Response
data ListChannelMembershipsForAppInstanceUserResponse Source #
See: newListChannelMembershipsForAppInstanceUserResponse
smart constructor.
Constructors
ListChannelMembershipsForAppInstanceUserResponse' | |
Fields
|
Instances
newListChannelMembershipsForAppInstanceUserResponse Source #
Arguments
:: Int |
|
-> ListChannelMembershipsForAppInstanceUserResponse |
Create a value of ListChannelMembershipsForAppInstanceUserResponse
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:channelMemberships:ListChannelMembershipsForAppInstanceUserResponse'
, listChannelMembershipsForAppInstanceUserResponse_channelMemberships
- The token passed by previous API calls until all requested users are
returned.
$sel:nextToken:ListChannelMembershipsForAppInstanceUser'
, listChannelMembershipsForAppInstanceUserResponse_nextToken
- The token passed by previous API calls until all requested users are
returned.
$sel:httpStatus:ListChannelMembershipsForAppInstanceUserResponse'
, listChannelMembershipsForAppInstanceUserResponse_httpStatus
- The response's http status code.
Response Lenses
listChannelMembershipsForAppInstanceUserResponse_channelMemberships :: Lens' ListChannelMembershipsForAppInstanceUserResponse (Maybe [ChannelMembershipForAppInstanceUserSummary]) Source #
The token passed by previous API calls until all requested users are returned.
listChannelMembershipsForAppInstanceUserResponse_nextToken :: Lens' ListChannelMembershipsForAppInstanceUserResponse (Maybe Text) Source #
The token passed by previous API calls until all requested users are returned.
listChannelMembershipsForAppInstanceUserResponse_httpStatus :: Lens' ListChannelMembershipsForAppInstanceUserResponse Int Source #
The response's http status code.