describeChannelMembership method

Future<DescribeChannelMembershipResponse> describeChannelMembership({
  1. required String channelArn,
  2. required String chimeBearer,
  3. required String memberArn,
  4. String? subChannelId,
})

Returns the full details of a user's channel membership.

May throw BadRequestException. May throw ForbiddenException. May throw NotFoundException. May throw ServiceFailureException. May throw ServiceUnavailableException. May throw ThrottledClientException. May throw UnauthorizedClientException.

Parameter channelArn : The ARN of the channel.

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

Parameter memberArn : The AppInstanceUserArn of the member.

Parameter subChannelId : The ID of the SubChannel in the request. The response contains an ElasticChannelConfiguration object.

Implementation

Future<DescribeChannelMembershipResponse> describeChannelMembership({
  required String channelArn,
  required String chimeBearer,
  required String memberArn,
  String? subChannelId,
}) async {
  final headers = <String, String>{
    'x-amz-chime-bearer': chimeBearer.toString(),
  };
  final $query = <String, List<String>>{
    if (subChannelId != null) 'sub-channel-id': [subChannelId],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri:
        '/channels/${Uri.encodeComponent(channelArn)}/memberships/${Uri.encodeComponent(memberArn)}',
    queryParams: $query,
    headers: headers,
    exceptionFnMap: _exceptionFns,
  );
  return DescribeChannelMembershipResponse.fromJson(response);
}