Skip to main content

channel_moderated_by_app_instance_users

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

Overview

Namechannel_moderated_by_app_instance_users
TypeResource
Idaws.chime_sdk_messaging.channel_moderated_by_app_instance_users

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
channel_summaryobjectSummary of the details of a Channel.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
describe_channel_moderated_by_app_instance_userselectchannel_arn, app-instance-user-arn, x-amz-chime-bearer, regionReturns the full details of a channel moderated by 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.

NameDatatypeDescription
app-instance-user-arnstringThe ARN of the user or bot in the moderated channel.
channel_arnstringThe ARN of the moderated channel.
regionstringAWS region (default: us-east-1)
x-amz-chime-bearerstringThe ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

SELECT examples

Returns the full details of a channel moderated by 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
channel_summary
FROM aws.chime_sdk_messaging.channel_moderated_by_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
;