live_sources

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

Overview

Name	live_sources
Type	Resource
Id	aws.mediatailor.live_sources

Fields

The following fields are returned by SELECT queries:

describe_live_source

Name	Datatype	Description
arn	string	The ARN of the live source.
creation_time	string (date-time)	The timestamp that indicates when the live source was created.
http_package_configurations	array	The VOD source's HTTP package configuration settings.
last_modified_time	string (date-time)	The timestamp that indicates when the live source was modified.
live_source_name	string	The name of the live source.
source_location_name	string	The name of the source location associated with the live source.
tags	object	The tags assigned to the live source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.

list_live_sources

Name	Datatype	Description
arn	string	The ARN for the live source.
creation_time	string (date-time)	The timestamp that indicates when the live source was created.
http_package_configurations	array	The VOD source's HTTP package configuration settings.
last_modified_time	string (date-time)	The timestamp that indicates when the live source was last modified.
live_source_name	string	The name that's used to refer to a live source.
source_location_name	string	The name of the source location.
tags	object	The tags assigned to the live source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_live_source	select	live_source_name, source_location_name, region		The live source to describe.
list_live_sources	select	source_location_name, region	maxResults, nextToken	Lists the live sources contained in a source location. A source represents a piece of content.
create_live_source	insert	live_source_name, source_location_name, region, HttpPackageConfigurations		The live source configuration.
update_live_source	update	live_source_name, source_location_name, region, HttpPackageConfigurations		Updates a live source's configuration.
delete_live_source	delete	live_source_name, source_location_name, region		The live source to delete.

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
live_source_name	string	The name of the live source.
region	string	AWS region (default: us-east-1)
source_location_name	string	The name of the source location associated with this Live Source.
maxResults	integer	The maximum number of live sources that you want MediaTailor to return in response to the current request. If there are more than MaxResults live sources, use the value of NextToken in the response to get the next page of results. The default value is 100. MediaTailor uses DynamoDB-based pagination, which means that a response might contain fewer than MaxResults items, including 0 items, even when more results are available. To retrieve all results, you must continue making requests using the NextToken value from each response until the response no longer includes a NextToken value.
nextToken	string	Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results. For the first ListLiveSources request, omit this value. For subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request. Continue making requests until the response no longer includes a NextToken value, which indicates that all results have been retrieved.

SELECT examples

describe_live_source

The live source to describe.

SELECT
arn,
creation_time,
http_package_configurations,
last_modified_time,
live_source_name,
source_location_name,
tags
FROM aws.mediatailor.live_sources
WHERE live_source_name = '{{ live_source_name }}' -- required
AND source_location_name = '{{ source_location_name }}' -- required
AND region = '{{ region }}' -- required
;

list_live_sources

Lists the live sources contained in a source location. A source represents a piece of content.

SELECT
arn,
creation_time,
http_package_configurations,
last_modified_time,
live_source_name,
source_location_name,
tags
FROM aws.mediatailor.live_sources
WHERE source_location_name = '{{ source_location_name }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_live_source

The live source configuration.

INSERT INTO aws.mediatailor.live_sources (
HttpPackageConfigurations,
Tags,
live_source_name,
source_location_name,
region
)
SELECT 
'{{ HttpPackageConfigurations }}' /* required */,
'{{ Tags }}',
'{{ live_source_name }}',
'{{ source_location_name }}',
'{{ region }}'
RETURNING
arn,
creation_time,
http_package_configurations,
last_modified_time,
live_source_name,
source_location_name,
tags
;

Manifest

# Description fields are for documentation purposes
- name: live_sources
props:
  - name: live_source_name
    value: "{{ live_source_name }}"
    description: Required parameter for the live_sources resource.
  - name: source_location_name
    value: "{{ source_location_name }}"
    description: Required parameter for the live_sources resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the live_sources resource.
  - name: HttpPackageConfigurations
    description: |
      The VOD source's HTTP package configuration settings.
    value:
      - Path: "{{ Path }}"
        SourceGroup: "{{ SourceGroup }}"
        Type: "{{ Type }}"
  - name: Tags
    value: "{{ Tags }}"

UPDATE examples

update_live_source

Updates a live source's configuration.

UPDATE aws.mediatailor.live_sources
SET 
HttpPackageConfigurations = '{{ HttpPackageConfigurations }}'
WHERE 
live_source_name = '{{ live_source_name }}' --required
AND source_location_name = '{{ source_location_name }}' --required
AND region = '{{ region }}' --required
AND HttpPackageConfigurations = '{{ HttpPackageConfigurations }}' --required
RETURNING
arn,
creation_time,
http_package_configurations,
last_modified_time,
live_source_name,
source_location_name,
tags;

DELETE examples

delete_live_source

The live source to delete.

DELETE FROM aws.mediatailor.live_sources
WHERE live_source_name = '{{ live_source_name }}' --required
AND source_location_name = '{{ source_location_name }}' --required
AND region = '{{ region }}' --required
;