channels_moderated_by_app_instance_users

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

Overview

Name	channels_moderated_by_app_instance_users
Type	Resource
Id	aws.chime_sdk_messaging.channels_moderated_by_app_instance_users

Fields

The following fields are returned by SELECT queries:

list_channels_moderated_by_app_instance_user

Name	Datatype	Description
channels	array	The moderated channels in the request.
next_token	string	The token returned from previous API requests until the number of channels moderated by the user is reached. (pattern: <code>.*</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_channels_moderated_by_app_instance_user	select	x-amz-chime-bearer, region	app-instance-user-arn, max-results, next-token	A list of the channels moderated by an AppInstanceUser. 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 in the moderated channel.
max-results	integer	The maximum number of channels in the request.
next-token	string	The token returned from previous API requests until the number of channels moderated by the user is reached.

SELECT examples

list_channels_moderated_by_app_instance_user

A list of the channels moderated by an AppInstanceUser. 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
channels,
next_token
FROM aws.chime_sdk_messaging.channels_moderated_by_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 }}'
;