Skip to content

/AWS1/CL_CHS=>DESCRIBECHANNELMEMBERSHIP()

About DescribeChannelMembership

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

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.

Method Signature

IMPORTING

Required arguments:

IV_CHANNELARN TYPE /AWS1/CHSCHIMEARN /AWS1/CHSCHIMEARN

The ARN of the channel.

IV_MEMBERARN TYPE /AWS1/CHSCHIMEARN /AWS1/CHSCHIMEARN

The AppInstanceUserArn of the member.

IV_CHIMEBEARER TYPE /AWS1/CHSCHIMEARN /AWS1/CHSCHIMEARN

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

Optional arguments:

IV_SUBCHANNELID TYPE /AWS1/CHSSUBCHANNELID /AWS1/CHSSUBCHANNELID

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

Only required to get a user’s SubChannel membership details.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_CHSDSCCHANNELMEMBER01 /AWS1/CL_CHSDSCCHANNELMEMBER01