signaling_channels

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

Overview

Name	signaling_channels
Type	Resource
Id	aws.kinesisvideo.signaling_channels

Fields

The following fields are returned by SELECT queries:

describe_signaling_channel

Name	Datatype	Description
channel_arn	string	The Amazon Resource Name (ARN) of the signaling channel. (pattern: <code>arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+</code>)
channel_name	string	The name of the signaling channel. (pattern: <code>[a-zA-Z0-9_.-]+</code>)
channel_status	string	Current status of the signaling channel. (CREATING, ACTIVE, UPDATING, DELETING)
channel_type	string	The type of the signaling channel. (SINGLE_MASTER, FULL_MESH)
creation_time	string (date-time)	The time at which the signaling channel was created.
single_master_configuration	object	A structure that contains the configuration for the SINGLE_MASTER channel type.
version	string	The current version of the signaling channel. (pattern: <code>[a-zA-Z0-9]+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_signaling_channel	select	region		Returns the most current information about the signaling channel. You must specify either the name or the Amazon Resource Name (ARN) of the channel that you want to describe.
create_signaling_channel	insert	region, ChannelName		Creates a signaling channel. CreateSignalingChannel is an asynchronous operation.
update_signaling_channel	update	region, ChannelARN, CurrentVersion		Updates the existing signaling channel. This is an asynchronous operation and takes time to complete. If the MessageTtlSeconds value is updated (either increased or reduced), it only applies to new messages sent via this channel after it's been updated. Existing messages are still expired as per the previous MessageTtlSeconds value.
delete_signaling_channel	delete	region		Deletes a specified signaling channel. DeleteSignalingChannel is an asynchronous operation. If you don't specify the channel's current version, the most recent version is deleted.
list_signaling_channels	exec	region		Returns an array of ChannelInfo objects. Each object describes a signaling channel. To retrieve only those channels that satisfy a specific condition, you can specify a ChannelNameCondition.

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)

SELECT examples

describe_signaling_channel

Returns the most current information about the signaling channel. You must specify either the name or the Amazon Resource Name (ARN) of the channel that you want to describe.

SELECT
channel_arn,
channel_name,
channel_status,
channel_type,
creation_time,
single_master_configuration,
version
FROM aws.kinesisvideo.signaling_channels
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_signaling_channel

Creates a signaling channel. CreateSignalingChannel is an asynchronous operation.

INSERT INTO aws.kinesisvideo.signaling_channels (
ChannelName,
ChannelType,
SingleMasterConfiguration,
Tags,
region
)
SELECT 
'{{ ChannelName }}' /* required */,
'{{ ChannelType }}',
'{{ SingleMasterConfiguration }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
channel_arn
;

Manifest

# Description fields are for documentation purposes
- name: signaling_channels
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the signaling_channels resource.
  - name: ChannelName
    value: "{{ ChannelName }}"
  - name: ChannelType
    value: "{{ ChannelType }}"
    valid_values: ['SINGLE_MASTER', 'FULL_MESH']
  - name: SingleMasterConfiguration
    description: |
      A structure that contains the configuration for the SINGLE_MASTER channel type.
    value:
      MessageTtlSeconds: {{ MessageTtlSeconds }}
  - name: Tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_signaling_channel

Updates the existing signaling channel. This is an asynchronous operation and takes time to complete. If the MessageTtlSeconds value is updated (either increased or reduced), it only applies to new messages sent via this channel after it's been updated. Existing messages are still expired as per the previous MessageTtlSeconds value.

UPDATE aws.kinesisvideo.signaling_channels
SET 
ChannelARN = '{{ ChannelARN }}',
CurrentVersion = '{{ CurrentVersion }}',
SingleMasterConfiguration = '{{ SingleMasterConfiguration }}'
WHERE 
region = '{{ region }}' --required
AND ChannelARN = '{{ ChannelARN }}' --required
AND CurrentVersion = '{{ CurrentVersion }}' --required;

DELETE examples

delete_signaling_channel

Deletes a specified signaling channel. DeleteSignalingChannel is an asynchronous operation. If you don't specify the channel's current version, the most recent version is deleted.

DELETE FROM aws.kinesisvideo.signaling_channels
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

list_signaling_channels

Returns an array of ChannelInfo objects. Each object describes a signaling channel. To retrieve only those channels that satisfy a specific condition, you can specify a ChannelNameCondition.

EXEC aws.kinesisvideo.signaling_channels.list_signaling_channels 
@region='{{ region }}' --required 
@@json=
'{
"MaxResults": {{ MaxResults }}, 
"NextToken": "{{ NextToken }}", 
"ChannelNameCondition": "{{ ChannelNameCondition }}"
}'
;