DescribeChannelMembershipForAppInstanceUser
Returns the details of a channel based on the membership of the specified
AppInstanceUser or AppInstanceBot.
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.
Request Syntax
GET /channels/{channelArn}?scope=app-instance-user-membership&app-instance-user-arn=AppInstanceUserArn HTTP/1.1
x-amz-chime-bearer: ChimeBearer
URI Request Parameters
The request uses the following URI parameters.
- AppInstanceUserArn
-
The ARN of the user or bot in a channel.
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
- channelArn
-
The ARN of the channel to which the user belongs.
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
AppInstanceUserorAppInstanceBotthat 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
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"ChannelMembership": {
"AppInstanceUserMembershipSummary": {
"ReadMarkerTimestamp": number,
"SubChannelId": "string",
"Type": "string"
},
"ChannelSummary": {
"ChannelArn": "string",
"LastMessageTimestamp": number,
"Metadata": "string",
"Mode": "string",
"Name": "string",
"Privacy": "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.
- ChannelMembership
-
The channel to which a user belongs.
Type: ChannelMembershipForAppInstanceUserSummary object
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
