channel_memberships_for_app_instance_users

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

Overview

Name	channel_memberships_for_app_instance_users
Type	Resource
Id	aws.chime_sdk_messaging.channel_memberships_for_app_instance_users

Fields

The following fields are returned by SELECT queries:

list_channel_memberships_for_app_instance_user

Name	Datatype	Description
channel_memberships	array	The information for the requested channel memberships.
next_token	string	The token passed by previous API calls until all requested users are returned. (pattern: <code>.*</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_channel_memberships_for_app_instance_user	select	x-amz-chime-bearer, region	app-instance-user-arn, max-results, next-token	Lists all channels that an AppInstanceUser or AppInstanceBot is a part of. Only an AppInstanceAdmin can call the API with a user ARN that is not their own. 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
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.
app-instance-user-arn	string	The ARN of the user or bot.
max-results	integer	The maximum number of users that you want returned.
next-token	string	The token returned from previous API requests until the number of channel memberships is reached.

SELECT examples

list_channel_memberships_for_app_instance_user

Lists all channels that an AppInstanceUser or AppInstanceBot is a part of. Only an AppInstanceAdmin can call the API with a user ARN that is not their own. 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
channel_memberships,
next_token
FROM aws.chime_sdk_messaging.channel_memberships_for_app_instance_users
WHERE `x-amz-chime-bearer` = '{{ x-amz-chime-bearer }}' -- required
AND region = '{{ region }}' -- required
AND `app-instance-user-arn` = '{{ app-instance-user-arn }}'
AND `max-results` = '{{ max-results }}'
AND `next-token` = '{{ next-token }}'
;