vod_sources

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

Overview

Name	vod_sources
Type	Resource
Id	aws.mediatailor.vod_sources

Fields

The following fields are returned by SELECT queries:

describe_vod_source

Name	Datatype	Description
ad_break_opportunities	array	The ad break opportunities within the VOD source.
arn	string	The ARN of the VOD source.
creation_time	string (date-time)	The timestamp that indicates when the VOD source was created.
http_package_configurations	array	The VOD source's HTTP package configuration settings.
last_modified_time	string (date-time)	The last modified time of the VOD source.
source_location_name	string	The name of the source location associated with the VOD source.
tags	object	The tags assigned to the VOD 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.
vod_source_name	string	The name of the VOD source.

list_vod_sources

Name	Datatype	Description
arn	string	The ARN for the VOD source.
creation_time	string (date-time)	The timestamp that indicates when the VOD 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 VOD source was last modified.
source_location_name	string	The name of the source location that the VOD source is associated with.
tags	object	The tags assigned to the VOD 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.
vod_source_name	string	The name of the VOD source.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_vod_source	select	source_location_name, vod_source_name, region		Provides details about a specific video on demand (VOD) source in a specific source location.
list_vod_sources	select	source_location_name, region	maxResults, nextToken	Lists the VOD sources contained in a source location. A source represents a piece of content.
create_vod_source	insert	source_location_name, vod_source_name, region, HttpPackageConfigurations		The VOD source configuration parameters.
update_vod_source	update	source_location_name, vod_source_name, region, HttpPackageConfigurations		Updates a VOD source's configuration.
delete_vod_source	delete	source_location_name, vod_source_name, region		The video on demand (VOD) 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
region	string	AWS region (default: us-east-1)
source_location_name	string	The name of the source location associated with this VOD Source.
vod_source_name	string	The name of the VOD source.
maxResults	integer	The maximum number of VOD sources that you want MediaTailor to return in response to the current request. If there are more than MaxResults VOD 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 ListVodSources 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_vod_source

Provides details about a specific video on demand (VOD) source in a specific source location.

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

list_vod_sources

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

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

INSERT examples

create_vod_source

The VOD source configuration parameters.

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

Manifest

# Description fields are for documentation purposes
- name: vod_sources
props:
  - name: source_location_name
    value: "{{ source_location_name }}"
    description: Required parameter for the vod_sources resource.
  - name: vod_source_name
    value: "{{ vod_source_name }}"
    description: Required parameter for the vod_sources resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the vod_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_vod_source

Updates a VOD source's configuration.

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

DELETE examples

delete_vod_source

The video on demand (VOD) source to delete.

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