channel_groups

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

Overview

Name	channel_groups
Type	Resource
Id	aws.mediapackagev2.channel_groups

Fields

The following fields are returned by SELECT queries:

get_channel_group

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) associated with the resource.
channel_group_name	string	The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
created_at	string (date-time)	The date and time the channel group was created.
description	string	The description for your channel group.
e_tag	string	The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource. (pattern: <code>[\S]+</code>)
egress_domain	string	The output domain where the source stream should be sent. Integrate the domain with a downstream CDN (such as Amazon CloudFront) or playback device.
modified_at	string (date-time)	The date and time the channel group was modified.
tags	object	The comma-separated list of tag key:value pairs assigned to the channel group.

list_channel_groups

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) associated with the resource.
channel_group_name	string	The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
created_at	string (date-time)	The date and time the channel group was created.
description	string	Any descriptive information that you want to add to the channel group for future identification purposes.
modified_at	string (date-time)	The date and time the channel group was modified.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_channel_group	select	channel_group_name, region		Retrieves the specified channel group that's configured in AWS Elemental MediaPackage.
list_channel_groups	select	region	maxResults, nextToken	Retrieves all channel groups that are configured in Elemental MediaPackage.
create_channel_group	insert	region, ChannelGroupName	x-amzn-client-token	Create a channel group to group your channels and origin endpoints. A channel group is the top-level resource that consists of channels and origin endpoints that are associated with it and that provides predictable URLs for stream delivery. All channels and origin endpoints within the channel group are guaranteed to share the DNS. You can create only one channel group with each request.
update_channel_group	update	channel_group_name, region	x-amzn-update-if-match	Update the specified channel group. You can edit the description on a channel group for easier identification later from the AWS Elemental MediaPackage console. You can't edit the name of the channel group. Any edits you make that impact the video output may not be reflected for a few minutes.
delete_channel_group	delete	channel_group_name, region		Delete a channel group. You must delete the channel group's channels and origin endpoints before you can delete the channel group. If you delete a channel group, you'll lose access to the egress domain and will have to create a new channel group to replace it.

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_group_name	string	The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to return in the response.
nextToken	string	The pagination token from the GET list request. Use the token to fetch the next page of results.
x-amzn-client-token	string	A unique, case-sensitive token that you provide to ensure the idempotency of the request.
x-amzn-update-if-match	string	The expected current Entity Tag (ETag) for the resource. If the specified ETag does not match the resource's current entity tag, the update request will be rejected.

SELECT examples

get_channel_group

Retrieves the specified channel group that's configured in AWS Elemental MediaPackage.

SELECT
arn,
channel_group_name,
created_at,
description,
e_tag,
egress_domain,
modified_at,
tags
FROM aws.mediapackagev2.channel_groups
WHERE channel_group_name = '{{ channel_group_name }}' -- required
AND region = '{{ region }}' -- required
;

list_channel_groups

Retrieves all channel groups that are configured in Elemental MediaPackage.

SELECT
arn,
channel_group_name,
created_at,
description,
modified_at
FROM aws.mediapackagev2.channel_groups
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_channel_group

Create a channel group to group your channels and origin endpoints. A channel group is the top-level resource that consists of channels and origin endpoints that are associated with it and that provides predictable URLs for stream delivery. All channels and origin endpoints within the channel group are guaranteed to share the DNS. You can create only one channel group with each request.

INSERT INTO aws.mediapackagev2.channel_groups (
ChannelGroupName,
Description,
Tags,
region,
`x-amzn-client-token`
)
SELECT 
'{{ ChannelGroupName }}' /* required */,
'{{ Description }}',
'{{ Tags }}',
'{{ region }}',
'{{ x-amzn-client-token }}'
RETURNING
arn,
channel_group_name,
created_at,
description,
e_tag,
egress_domain,
modified_at,
tags
;

Manifest

# Description fields are for documentation purposes
- name: channel_groups
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the channel_groups resource.
  - name: ChannelGroupName
    value: "{{ ChannelGroupName }}"
  - name: Description
    value: "{{ Description }}"
  - name: Tags
    value: "{{ Tags }}"
  - name: x-amzn-client-token
    value: "{{ x-amzn-client-token }}"
    description: A unique, case-sensitive token that you provide to ensure the idempotency of the request.
    description: A unique, case-sensitive token that you provide to ensure the idempotency of the request.

UPDATE examples

update_channel_group

Update the specified channel group. You can edit the description on a channel group for easier identification later from the AWS Elemental MediaPackage console. You can't edit the name of the channel group. Any edits you make that impact the video output may not be reflected for a few minutes.

UPDATE aws.mediapackagev2.channel_groups
SET 
Description = '{{ Description }}'
WHERE 
channel_group_name = '{{ channel_group_name }}' --required
AND region = '{{ region }}' --required
AND `x-amzn-update-if-match` = '{{ x-amzn-update-if-match}}'
RETURNING
arn,
channel_group_name,
created_at,
description,
e_tag,
egress_domain,
modified_at,
tags;

DELETE examples

delete_channel_group

Delete a channel group. You must delete the channel group's channels and origin endpoints before you can delete the channel group. If you delete a channel group, you'll lose access to the egress domain and will have to create a new channel group to replace it.

DELETE FROM aws.mediapackagev2.channel_groups
WHERE channel_group_name = '{{ channel_group_name }}' --required
AND region = '{{ region }}' --required
;