channels_associated_with_channel_flows

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

Overview

Name	channels_associated_with_channel_flows
Type	Resource
Id	aws.chime_sdk_messaging.channels_associated_with_channel_flows

Fields

The following fields are returned by SELECT queries:

list_channels_associated_with_channel_flow

Name	Datatype	Description
channels	array	The information about each channel.
next_token	string	The token passed by previous API calls until all requested channels are returned. (pattern: <code>.*</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_channels_associated_with_channel_flow	select	channel-flow-arn, region	max-results, next-token	Lists all channels associated with a specified channel flow. You can associate a channel flow with multiple channels, but you can only associate a channel with one channel flow. This is a developer API.

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-flow-arn	string	The ARN of the channel flow.
region	string	AWS region (default: us-east-1)
max-results	integer	The maximum number of channels that you want to return.
next-token	string	The token passed by previous API calls until all requested channels are returned.

SELECT examples

list_channels_associated_with_channel_flow

Lists all channels associated with a specified channel flow. You can associate a channel flow with multiple channels, but you can only associate a channel with one channel flow. This is a developer API.

SELECT
channels,
next_token
FROM aws.chime_sdk_messaging.channels_associated_with_channel_flows
WHERE `channel-flow-arn` = '{{ channel-flow-arn }}' -- required
AND region = '{{ region }}' -- required
AND `max-results` = '{{ max-results }}'
AND `next-token` = '{{ next-token }}'
;