/AWS1/CL_CHS=>LISTCHANNELMEMBERSHIPS()
¶
About ListChannelMemberships¶
Lists all channel memberships in a channel.
The x-amz-chime-bearer
request header is mandatory. Use the
ARN of the AppInstanceUser
or AppInstanceBot
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.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_CHANNELARN
TYPE /AWS1/CHSCHIMEARN
/AWS1/CHSCHIMEARN
¶
The maximum number of channel memberships that you want returned.
IV_CHIMEBEARER
TYPE /AWS1/CHSCHIMEARN
/AWS1/CHSCHIMEARN
¶
The ARN of the
AppInstanceUser
orAppInstanceBot
that makes the API call.
Optional arguments:¶
IV_TYPE
TYPE /AWS1/CHSCHANNELMEMBERSHIPTYPE
/AWS1/CHSCHANNELMEMBERSHIPTYPE
¶
The membership type of a user,
DEFAULT
orHIDDEN
. Default members are returned as part ofListChannelMemberships
if no type is specified. Hidden members are only returned if the type filter inListChannelMemberships
equalsHIDDEN
.
IV_MAXRESULTS
TYPE /AWS1/CHSMAXRESULTS
/AWS1/CHSMAXRESULTS
¶
The maximum number of channel memberships that you want returned.
IV_NEXTTOKEN
TYPE /AWS1/CHSNEXTTOKEN
/AWS1/CHSNEXTTOKEN
¶
The token passed by previous API calls until all requested channel memberships are returned.
IV_SUBCHANNELID
TYPE /AWS1/CHSSUBCHANNELID
/AWS1/CHSSUBCHANNELID
¶
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.