channels

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

Overview

Name	channels
Type	Resource
Id	aws.mediapackage.channels

Fields

The following fields are returned by SELECT queries:

describe_channel

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) assigned to the Channel.
created_at	string	The date and time the Channel was created.
description	string	A short text description of the Channel.
egress_access_logs	object	Configure egress access logging.
hls_ingest	object	An HTTP Live Streaming (HLS) ingest resource configuration.
id	string	The ID of the Channel.
ingress_access_logs	object	Configure ingress access logging.
tags	object

list_channels

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) assigned to the Channel.
created_at	string	The date and time the Channel was created.
description	string	A short text description of the Channel.
egress_access_logs	object	Configure egress access logging.
hls_ingest	object	An HTTP Live Streaming (HLS) ingest resource configuration.
id	string	The ID of the Channel.
ingress_access_logs	object	Configure ingress access logging.
tags	object

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_channel	select	id, region		Gets details about a Channel.
list_channels	select	region	maxResults, nextToken	Returns a collection of Channels.
create_channel	insert	region		Creates a new Channel.
update_channel	update	id, region		Updates an existing Channel.
delete_channel	delete	id, region		Deletes an existing Channel.

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
id	string	The ID of the Channel to delete.
region	string	AWS region (default: us-east-1)
maxResults	integer	Upper bound on number of records to return.
nextToken	string	A token used to resume pagination from the end of a previous request.

SELECT examples

describe_channel

Gets details about a Channel.

SELECT
arn,
created_at,
description,
egress_access_logs,
hls_ingest,
id,
ingress_access_logs,
tags
FROM aws.mediapackage.channels
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
;

list_channels

Returns a collection of Channels.

SELECT
arn,
created_at,
description,
egress_access_logs,
hls_ingest,
id,
ingress_access_logs,
tags
FROM aws.mediapackage.channels
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_channel

Creates a new Channel.

INSERT INTO aws.mediapackage.channels (
Description,
Id,
Tags,
region
)
SELECT 
'{{ Description }}',
'{{ Id }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
arn,
created_at,
description,
egress_access_logs,
hls_ingest,
id,
ingress_access_logs,
tags
;

Manifest

# Description fields are for documentation purposes
- name: channels
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the channels resource.
  - name: Description
    value: "{{ Description }}"
  - name: Id
    value: "{{ Id }}"
  - name: Tags
    value: "{{ Tags }}"
    description: |
      A collection of tags associated with a resource

UPDATE examples

update_channel

Updates an existing Channel.

UPDATE aws.mediapackage.channels
SET 
Description = '{{ Description }}'
WHERE 
id = '{{ id }}' --required
AND region = '{{ region }}' --required
RETURNING
arn,
created_at,
description,
egress_access_logs,
hls_ingest,
id,
ingress_access_logs,
tags;

DELETE examples

delete_channel

Deletes an existing Channel.

DELETE FROM aws.mediapackage.channels
WHERE id = '{{ id }}' --required
AND region = '{{ region }}' --required
;