Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListChannelMemberships

Lists all channel memberships in a channel.

Note

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.

Request Syntax


GET /channels/channelArn/memberships?max-results=MaxResults&next-token=NextToken&sub-channel-id=SubChannelId&type=Type HTTP/1.1
x-amz-chime-bearer: ChimeBearer

URI Request Parameters

The request uses the following URI parameters.

channelArn

The maximum number of channel memberships that you want returned.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Required: Yes

ChimeBearer

The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Required: Yes

MaxResults

The maximum number of channel memberships that you want returned.

Valid Range: Minimum value of 1. Maximum value of 50.

NextToken

The token passed by previous API calls until all requested channel memberships are returned.

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

SubChannelId

The ID of the SubChannel in the request.

Note

Only required when listing a user's memberships in a particular sub-channel of an elastic channel.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [-_a-zA-Z0-9]*

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.

Valid Values: DEFAULT | HIDDEN

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ChannelArn": "string",
   "ChannelMemberships": [ 
      { 
         "Member": { 
            "Arn": "string",
            "Name": "string"
         }
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ChannelArn

The ARN of the channel.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

ChannelMemberships

The information for the requested channel memberships.

Type: Array of ChannelMembershipSummary objects

NextToken

The token passed by previous API calls until all requested channel memberships are returned.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401