channel_membership_for_app_instance_users

Creates, updates, deletes, gets or lists a channel_membership_for_app_instance_users resource.

Overview

Name	channel_membership_for_app_instance_users
Type	Resource
Id	aws.chime_sdk_messaging.channel_membership_for_app_instance_users

Fields

The following fields are returned by SELECT queries:

describe_channel_membership_for_app_instance_user

Name	Datatype	Description
app_instance_user_membership_summary	object	Returns the channel membership data for an AppInstance.
channel_summary	object	Summary of the details of a Channel.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_channel_membership_for_app_instance_user	select	channel_arn, app-instance-user-arn, x-amz-chime-bearer, region		Returns the details of a channel based on the membership of the specified AppInstanceUser or AppInstanceBot. 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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
app-instance-user-arn	string	The ARN of the user or bot in a channel.
channel_arn	string	The ARN of the channel to which the user belongs.
region	string	AWS region (default: us-east-1)
x-amz-chime-bearer	string	The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

SELECT examples

describe_channel_membership_for_app_instance_user

Returns the details of a channel based on the membership of the specified AppInstanceUser or AppInstanceBot. 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.

SELECT
app_instance_user_membership_summary,
channel_summary
FROM aws.chime_sdk_messaging.channel_membership_for_app_instance_users
WHERE channel_arn = '{{ channel_arn }}' -- required
AND `app-instance-user-arn` = '{{ app-instance-user-arn }}' -- required
AND `x-amz-chime-bearer` = '{{ x-amz-chime-bearer }}' -- required
AND region = '{{ region }}' -- required
;