origin_endpoints

Creates, updates, deletes, gets or lists an origin_endpoints resource.

Overview

Name	origin_endpoints
Type	Resource
Id	aws.mediapackagev2.origin_endpoints

Fields

The following fields are returned by SELECT queries:

get_origin_endpoint

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. (pattern: <code>[a-zA-Z0-9_-]+</code>)
channel_name	string	The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. (pattern: <code>[a-zA-Z0-9_-]+</code>)
container_type	string	The type of container attached to this origin endpoint. (TS, CMAF, ISM)
created_at	string (date-time)	The date and time the origin endpoint was created.
dash_manifests	array	A DASH manifest configuration.
description	string	The description for your origin endpoint.
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>)
force_endpoint_error_configuration	object	The failover settings for the endpoint.
hls_manifests	array	An HTTP live streaming (HLS) manifest configuration.
low_latency_hls_manifests	array	A low-latency HLS manifest configuration.
modified_at	string (date-time)	The date and time the origin endpoint was modified.
mss_manifests	array	The Microsoft Smooth Streaming (MSS) manifest configurations associated with this origin endpoint.
origin_endpoint_name	string	The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel. (pattern: <code>[a-zA-Z0-9_-]+</code>)
reset_at	string (date-time)	The time that the origin endpoint was last reset.
segment	object	The segment configuration, including the segment name, duration, and other configuration values.
startover_window_seconds	integer	The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window.
stream_name_output_mode	string	The output mode for stream names in egress manifests for this origin endpoint. (INDEX, PASSTHROUGH_NAME)
tags	object	The comma-separated list of tag key:value pairs assigned to the origin endpoint.
uri_separator	string	The separator character used in generated URIs for this origin endpoint. (UNDERSCORE, HYPHEN)

list_origin_endpoints

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. (pattern: <code>[a-zA-Z0-9_-]+</code>)
channel_name	string	The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. (pattern: <code>[a-zA-Z0-9_-]+</code>)
container_type	string	The type of container attached to this origin endpoint. A container type is a file format that encapsulates one or more media streams, such as audio and video, into a single file. (TS, CMAF, ISM)
created_at	string (date-time)	The date and time the origin endpoint was created.
dash_manifests	array	A DASH manifest configuration.
description	string	Any descriptive information that you want to add to the origin endpoint for future identification purposes.
force_endpoint_error_configuration	object	The failover settings for the endpoint.
hls_manifests	array	An HTTP live streaming (HLS) manifest configuration.
low_latency_hls_manifests	array	A low-latency HLS manifest configuration.
modified_at	string (date-time)	The date and time the origin endpoint was modified.
mss_manifests	array	A list of Microsoft Smooth Streaming (MSS) manifest configurations associated with the origin endpoint. Each configuration represents a different MSS streaming option available from this endpoint.
origin_endpoint_name	string	The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel. (pattern: <code>[a-zA-Z0-9_-]+</code>)
stream_name_output_mode	string	The output mode for stream names in egress manifests for this origin endpoint. (INDEX, PASSTHROUGH_NAME)
uri_separator	string	The separator character used in generated URIs for this origin endpoint. (UNDERSCORE, HYPHEN)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_origin_endpoint	select	channel_group_name, channel_name, origin_endpoint_name, region		Retrieves the specified origin endpoint that's configured in AWS Elemental MediaPackage to obtain its playback URL and to view the packaging settings that it's currently using.
list_origin_endpoints	select	channel_group_name, channel_name, region	maxResults, nextToken	Retrieves all origin endpoints in a specific channel that are configured in AWS Elemental MediaPackage.
create_origin_endpoint	insert	channel_group_name, channel_name, region, OriginEndpointName, ContainerType	x-amzn-client-token	The endpoint is attached to a channel, and represents the output of the live content. You can associate multiple endpoints to a single channel. Each endpoint gives players and downstream CDNs (such as Amazon CloudFront) access to the content for playback. Content can't be served from a channel until it has an endpoint. You can create only one endpoint with each request.
update_origin_endpoint	update	channel_group_name, channel_name, origin_endpoint_name, region, ContainerType	x-amzn-update-if-match	Update the specified origin endpoint. Edit the packaging preferences on an endpoint to optimize the viewing experience. You can't edit the name of the endpoint. Any edits you make that impact the video output may not be reflected for a few minutes.
delete_origin_endpoint	delete	channel_group_name, channel_name, origin_endpoint_name, region		Origin endpoints can serve content until they're deleted. Delete the endpoint if it should no longer respond to playback requests. You must delete all endpoints from a channel before you can delete the channel.
cancel_harvest_job	exec	channel_group_name, channel_name, origin_endpoint_name, harvest_job_name, region	x-amzn-update-if-match	Cancels an in-progress harvest job.
reset_origin_endpoint_state	exec	channel_group_name, channel_name, origin_endpoint_name, region		Resetting the origin endpoint can help to resolve unexpected behavior and other content packaging issues. It also helps to preserve special events when you don't want the previous content to be available for viewing. A reset clears out all previous content from the origin endpoint. MediaPackage might return old content from this endpoint in the first 30 seconds after the endpoint reset. For best results, when possible, wait 30 seconds from endpoint reset to send playback requests to this endpoint.

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 of the channel group that contains the channel with the origin endpoint that you are resetting.
channel_name	string	The name of the channel with the origin endpoint that you are resetting.
harvest_job_name	string	The name of the harvest job to cancel. This name must be unique within the channel and cannot be changed after the harvest job is submitted.
origin_endpoint_name	string	The name of the origin endpoint that you are resetting.
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 current Entity Tag (ETag) associated with the harvest job. Used for concurrency control.

SELECT examples

get_origin_endpoint

Retrieves the specified origin endpoint that's configured in AWS Elemental MediaPackage to obtain its playback URL and to view the packaging settings that it's currently using.

SELECT
arn,
channel_group_name,
channel_name,
container_type,
created_at,
dash_manifests,
description,
e_tag,
force_endpoint_error_configuration,
hls_manifests,
low_latency_hls_manifests,
modified_at,
mss_manifests,
origin_endpoint_name,
reset_at,
segment,
startover_window_seconds,
stream_name_output_mode,
tags,
uri_separator
FROM aws.mediapackagev2.origin_endpoints
WHERE channel_group_name = '{{ channel_group_name }}' -- required
AND channel_name = '{{ channel_name }}' -- required
AND origin_endpoint_name = '{{ origin_endpoint_name }}' -- required
AND region = '{{ region }}' -- required
;

list_origin_endpoints

Retrieves all origin endpoints in a specific channel that are configured in AWS Elemental MediaPackage.

SELECT
arn,
channel_group_name,
channel_name,
container_type,
created_at,
dash_manifests,
description,
force_endpoint_error_configuration,
hls_manifests,
low_latency_hls_manifests,
modified_at,
mss_manifests,
origin_endpoint_name,
stream_name_output_mode,
uri_separator
FROM aws.mediapackagev2.origin_endpoints
WHERE channel_group_name = '{{ channel_group_name }}' -- required
AND channel_name = '{{ channel_name }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_origin_endpoint

The endpoint is attached to a channel, and represents the output of the live content. You can associate multiple endpoints to a single channel. Each endpoint gives players and downstream CDNs (such as Amazon CloudFront) access to the content for playback. Content can't be served from a channel until it has an endpoint. You can create only one endpoint with each request.

INSERT INTO aws.mediapackagev2.origin_endpoints (
OriginEndpointName,
ContainerType,
Segment,
Description,
StartoverWindowSeconds,
HlsManifests,
LowLatencyHlsManifests,
DashManifests,
MssManifests,
ForceEndpointErrorConfiguration,
UriSeparator,
StreamNameOutputMode,
Tags,
channel_group_name,
channel_name,
region,
`x-amzn-client-token`
)
SELECT 
'{{ OriginEndpointName }}' /* required */,
'{{ ContainerType }}' /* required */,
'{{ Segment }}',
'{{ Description }}',
{{ StartoverWindowSeconds }},
'{{ HlsManifests }}',
'{{ LowLatencyHlsManifests }}',
'{{ DashManifests }}',
'{{ MssManifests }}',
'{{ ForceEndpointErrorConfiguration }}',
'{{ UriSeparator }}',
'{{ StreamNameOutputMode }}',
'{{ Tags }}',
'{{ channel_group_name }}',
'{{ channel_name }}',
'{{ region }}',
'{{ x-amzn-client-token }}'
RETURNING
arn,
channel_group_name,
channel_name,
container_type,
created_at,
dash_manifests,
description,
e_tag,
force_endpoint_error_configuration,
hls_manifests,
low_latency_hls_manifests,
modified_at,
mss_manifests,
origin_endpoint_name,
segment,
startover_window_seconds,
stream_name_output_mode,
tags,
uri_separator
;

Manifest

# Description fields are for documentation purposes
- name: origin_endpoints
props:
  - name: channel_group_name
    value: "{{ channel_group_name }}"
    description: Required parameter for the origin_endpoints resource.
  - name: channel_name
    value: "{{ channel_name }}"
    description: Required parameter for the origin_endpoints resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the origin_endpoints resource.
  - name: OriginEndpointName
    value: "{{ OriginEndpointName }}"
  - name: ContainerType
    value: "{{ ContainerType }}"
    valid_values: ['TS', 'CMAF', 'ISM']
  - name: Segment
    description: |
      The segment configuration, including the segment name, duration, and other configuration values.
    value:
      SegmentDurationSeconds: {{ SegmentDurationSeconds }}
      SegmentName: "{{ SegmentName }}"
      TsUseAudioRenditionGroup: {{ TsUseAudioRenditionGroup }}
      IncludeIframeOnlyStreams: {{ IncludeIframeOnlyStreams }}
      TsIncludeDvbSubtitles: {{ TsIncludeDvbSubtitles }}
      Scte:
        ScteFilter:
          - "{{ ScteFilter }}"
        ScteInSegments: "{{ ScteInSegments }}"
        CustomAdTypes:
          - "{{ CustomAdTypes }}"
      Encryption:
        ConstantInitializationVector: "{{ ConstantInitializationVector }}"
        EncryptionMethod:
          TsEncryptionMethod: "{{ TsEncryptionMethod }}"
          CmafEncryptionMethod: "{{ CmafEncryptionMethod }}"
          IsmEncryptionMethod: "{{ IsmEncryptionMethod }}"
        KeyRotationIntervalSeconds: {{ KeyRotationIntervalSeconds }}
        CmafExcludeSegmentDrmMetadata: {{ CmafExcludeSegmentDrmMetadata }}
        SpekeKeyProvider:
          EncryptionContractConfiguration:
            PresetSpeke20Audio: "{{ PresetSpeke20Audio }}"
            PresetSpeke20Video: "{{ PresetSpeke20Video }}"
          ResourceId: "{{ ResourceId }}"
          DrmSystems:
            - "{{ DrmSystems }}"
          RoleArn: "{{ RoleArn }}"
          Url: "{{ Url }}"
          CertificateArn: "{{ CertificateArn }}"
      OutputTimestampMode: "{{ OutputTimestampMode }}"
  - name: Description
    value: "{{ Description }}"
  - name: StartoverWindowSeconds
    value: {{ StartoverWindowSeconds }}
  - name: HlsManifests
    value:
      - ManifestName: "{{ ManifestName }}"
        ChildManifestName: "{{ ChildManifestName }}"
        ScteHls:
          AdMarkerHls: "{{ AdMarkerHls }}"
          ScteInManifests: "{{ ScteInManifests }}"
        StartTag:
          TimeOffset: {{ TimeOffset }}
          Precise: {{ Precise }}
        ManifestWindowSeconds: {{ ManifestWindowSeconds }}
        ProgramDateTimeIntervalSeconds: {{ ProgramDateTimeIntervalSeconds }}
        FilterConfiguration:
          ManifestFilter: "{{ ManifestFilter }}"
          DrmSettings: "{{ DrmSettings }}"
          Start: "{{ Start }}"
          End: "{{ End }}"
          TimeDelaySeconds: {{ TimeDelaySeconds }}
          ClipStartTime: "{{ ClipStartTime }}"
        UrlEncodeChildManifest: {{ UrlEncodeChildManifest }}
        UriPathType: "{{ UriPathType }}"
  - name: LowLatencyHlsManifests
    value:
      - ManifestName: "{{ ManifestName }}"
        ChildManifestName: "{{ ChildManifestName }}"
        ScteHls:
          AdMarkerHls: "{{ AdMarkerHls }}"
          ScteInManifests: "{{ ScteInManifests }}"
        StartTag:
          TimeOffset: {{ TimeOffset }}
          Precise: {{ Precise }}
        ManifestWindowSeconds: {{ ManifestWindowSeconds }}
        ProgramDateTimeIntervalSeconds: {{ ProgramDateTimeIntervalSeconds }}
        FilterConfiguration:
          ManifestFilter: "{{ ManifestFilter }}"
          DrmSettings: "{{ DrmSettings }}"
          Start: "{{ Start }}"
          End: "{{ End }}"
          TimeDelaySeconds: {{ TimeDelaySeconds }}
          ClipStartTime: "{{ ClipStartTime }}"
        UrlEncodeChildManifest: {{ UrlEncodeChildManifest }}
        UriPathType: "{{ UriPathType }}"
  - name: DashManifests
    value:
      - ManifestName: "{{ ManifestName }}"
        ManifestWindowSeconds: {{ ManifestWindowSeconds }}
        FilterConfiguration:
          ManifestFilter: "{{ ManifestFilter }}"
          DrmSettings: "{{ DrmSettings }}"
          Start: "{{ Start }}"
          End: "{{ End }}"
          TimeDelaySeconds: {{ TimeDelaySeconds }}
          ClipStartTime: "{{ ClipStartTime }}"
        MinUpdatePeriodSeconds: {{ MinUpdatePeriodSeconds }}
        MinBufferTimeSeconds: {{ MinBufferTimeSeconds }}
        SuggestedPresentationDelaySeconds: {{ SuggestedPresentationDelaySeconds }}
        SegmentTemplateFormat: "{{ SegmentTemplateFormat }}"
        PeriodTriggers: "{{ PeriodTriggers }}"
        ScteDash:
          AdMarkerDash: "{{ AdMarkerDash }}"
          ScteInManifests: "{{ ScteInManifests }}"
        DrmSignaling: "{{ DrmSignaling }}"
        UtcTiming:
          TimingMode: "{{ TimingMode }}"
          TimingSource: "{{ TimingSource }}"
        Profiles: "{{ Profiles }}"
        BaseUrls: "{{ BaseUrls }}"
        ProgramInformation:
          Title: "{{ Title }}"
          Source: "{{ Source }}"
          Copyright: "{{ Copyright }}"
          LanguageCode: "{{ LanguageCode }}"
          MoreInformationUrl: "{{ MoreInformationUrl }}"
        DvbSettings:
          FontDownload:
            Url: "{{ Url }}"
            MimeType: "{{ MimeType }}"
            FontFamily: "{{ FontFamily }}"
          ErrorMetrics:
            - ReportingUrl: "{{ ReportingUrl }}"
              Probability: {{ Probability }}
        Compactness: "{{ Compactness }}"
        AudioTimelinePattern: "{{ AudioTimelinePattern }}"
        SubtitleConfiguration:
          TtmlConfiguration:
            TtmlProfile: "{{ TtmlProfile }}"
        UriPathType: "{{ UriPathType }}"
        AvailabilityStartTimeConfiguration:
          FixedAvailabilityStartTime: "{{ FixedAvailabilityStartTime }}"
  - name: MssManifests
    value:
      - ManifestName: "{{ ManifestName }}"
        ManifestWindowSeconds: {{ ManifestWindowSeconds }}
        FilterConfiguration:
          ManifestFilter: "{{ ManifestFilter }}"
          DrmSettings: "{{ DrmSettings }}"
          Start: "{{ Start }}"
          End: "{{ End }}"
          TimeDelaySeconds: {{ TimeDelaySeconds }}
          ClipStartTime: "{{ ClipStartTime }}"
        ManifestLayout: "{{ ManifestLayout }}"
  - name: ForceEndpointErrorConfiguration
    description: |
      The failover settings for the endpoint.
    value:
      EndpointErrorConditions:
        - "{{ EndpointErrorConditions }}"
  - name: UriSeparator
    value: "{{ UriSeparator }}"
    valid_values: ['UNDERSCORE', 'HYPHEN']
  - name: StreamNameOutputMode
    value: "{{ StreamNameOutputMode }}"
    valid_values: ['INDEX', 'PASSTHROUGH_NAME']
  - 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_origin_endpoint

Update the specified origin endpoint. Edit the packaging preferences on an endpoint to optimize the viewing experience. You can't edit the name of the endpoint. Any edits you make that impact the video output may not be reflected for a few minutes.

UPDATE aws.mediapackagev2.origin_endpoints
SET 
ContainerType = '{{ ContainerType }}',
Segment = '{{ Segment }}',
Description = '{{ Description }}',
StartoverWindowSeconds = {{ StartoverWindowSeconds }},
HlsManifests = '{{ HlsManifests }}',
LowLatencyHlsManifests = '{{ LowLatencyHlsManifests }}',
DashManifests = '{{ DashManifests }}',
MssManifests = '{{ MssManifests }}',
ForceEndpointErrorConfiguration = '{{ ForceEndpointErrorConfiguration }}',
UriSeparator = '{{ UriSeparator }}',
StreamNameOutputMode = '{{ StreamNameOutputMode }}'
WHERE 
channel_group_name = '{{ channel_group_name }}' --required
AND channel_name = '{{ channel_name }}' --required
AND origin_endpoint_name = '{{ origin_endpoint_name }}' --required
AND region = '{{ region }}' --required
AND ContainerType = '{{ ContainerType }}' --required
AND `x-amzn-update-if-match` = '{{ x-amzn-update-if-match}}'
RETURNING
arn,
channel_group_name,
channel_name,
container_type,
created_at,
dash_manifests,
description,
e_tag,
force_endpoint_error_configuration,
hls_manifests,
low_latency_hls_manifests,
modified_at,
mss_manifests,
origin_endpoint_name,
segment,
startover_window_seconds,
stream_name_output_mode,
tags,
uri_separator;

DELETE examples

delete_origin_endpoint

Origin endpoints can serve content until they're deleted. Delete the endpoint if it should no longer respond to playback requests. You must delete all endpoints from a channel before you can delete the channel.

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

Lifecycle Methods

cancel_harvest_job

Cancels an in-progress harvest job.

EXEC aws.mediapackagev2.origin_endpoints.cancel_harvest_job 
@channel_group_name='{{ channel_group_name }}' --required, 
@channel_name='{{ channel_name }}' --required, 
@origin_endpoint_name='{{ origin_endpoint_name }}' --required, 
@harvest_job_name='{{ harvest_job_name }}' --required, 
@region='{{ region }}' --required, 
@x-amzn-update-if-match='{{ x-amzn-update-if-match }}'
;

reset_origin_endpoint_state

Resetting the origin endpoint can help to resolve unexpected behavior and other content packaging issues. It also helps to preserve special events when you don't want the previous content to be available for viewing. A reset clears out all previous content from the origin endpoint. MediaPackage might return old content from this endpoint in the first 30 seconds after the endpoint reset. For best results, when possible, wait 30 seconds from endpoint reset to send playback requests to this endpoint.

EXEC aws.mediapackagev2.origin_endpoints.reset_origin_endpoint_state 
@channel_group_name='{{ channel_group_name }}' --required, 
@channel_name='{{ channel_name }}' --required, 
@origin_endpoint_name='{{ origin_endpoint_name }}' --required, 
@region='{{ region }}' --required
;