sub_channels

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

Overview

Name	sub_channels
Type	Resource
Id	aws.chime_sdk_messaging.sub_channels

Fields

The following fields are returned by SELECT queries:

list_sub_channels

Name	Datatype	Description
channel_arn	string	The ARN of elastic channel. (pattern: <code>arn:[a-z0-9-.]{1,63}:[a-z0-9-.]{0,63}:[a-z0-9-.]{0,63}:[a-z0-9-.]{0,63}:[^/].{0,1023}</code>)
next_token	string	The token passed by previous API calls until all requested sub-channels are returned. (pattern: <code>.*</code>)
sub_channels	array	The information about each sub-channel.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_sub_channels	select	channel_arn, x-amz-chime-bearer, region	max-results, next-token	Lists all the SubChannels in an elastic channel when given a channel ID. Available only to the app instance admins and channel moderators of elastic channels.

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
channel_arn	string	The ARN of elastic channel.
region	string	AWS region (default: us-east-1)
x-amz-chime-bearer	string	The AppInstanceUserArn of the user making the API call.
max-results	integer	The maximum number of sub-channels that you want to return.
next-token	string	The token passed by previous API calls until all requested sub-channels are returned.

SELECT examples

list_sub_channels

Lists all the SubChannels in an elastic channel when given a channel ID. Available only to the app instance admins and channel moderators of elastic channels.

SELECT
channel_arn,
next_token,
sub_channels
FROM aws.chime_sdk_messaging.sub_channels
WHERE channel_arn = '{{ channel_arn }}' -- required
AND `x-amz-chime-bearer` = '{{ x-amz-chime-bearer }}' -- required
AND region = '{{ region }}' -- required
AND `max-results` = '{{ max-results }}'
AND `next-token` = '{{ next-token }}'
;