The Origin Endpoints API from Amazon MediaPackage — 2 operation(s) for origin endpoints.
openapi: 3.0.0
info:
version: 2017-10-12
x-release: v4
title: AWS Elemental MediaPackage Channels Origin Endpoints API
description: AWS Elemental MediaPackage
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: mediapackage
x-aws-signingName: mediapackage
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/mediapackage-2017-10-12.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://mediapackage.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The MediaPackage multi-region endpoint
- url: https://mediapackage.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The MediaPackage multi-region endpoint
- url: http://mediapackage.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The MediaPackage endpoint for China (Beijing) and China (Ningxia)
- url: https://mediapackage.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The MediaPackage endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Origin Endpoints
paths:
/origin_endpoints:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: CreateOriginEndpoint
description: Creates a new OriginEndpoint record.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateOriginEndpointResponse'
examples:
CreateOriginEndpoint200Example:
summary: Default CreateOriginEndpoint 200 response
x-microcks-default: true
value:
Arn: arn:aws:service:us-east-1:123456789012:resource/example
Authorization: example-value
ChannelId: id-abc123
CmafPackage: example-value
CreatedAt: example-value
'480':
description: UnprocessableEntityException
content:
application/json:
schema:
$ref: '#/components/schemas/UnprocessableEntityException'
examples:
CreateOriginEndpoint480Example:
summary: Default CreateOriginEndpoint 480 response
x-microcks-default: true
value: {}
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
CreateOriginEndpoint481Example:
summary: Default CreateOriginEndpoint 481 response
x-microcks-default: true
value: {}
'482':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
examples:
CreateOriginEndpoint482Example:
summary: Default CreateOriginEndpoint 482 response
x-microcks-default: true
value: {}
'483':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
examples:
CreateOriginEndpoint483Example:
summary: Default CreateOriginEndpoint 483 response
x-microcks-default: true
value: {}
'484':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
examples:
CreateOriginEndpoint484Example:
summary: Default CreateOriginEndpoint 484 response
x-microcks-default: true
value: {}
'485':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
examples:
CreateOriginEndpoint485Example:
summary: Default CreateOriginEndpoint 485 response
x-microcks-default: true
value: {}
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- channelId
- id
properties:
authorization:
description: CDN Authorization credentials
type: object
properties:
CdnIdentifierSecret:
allOf:
- $ref: '#/components/schemas/__string'
- xml:
name: cdnIdentifierSecret
description: 'The Amazon Resource Name (ARN) for the secret in Secrets Manager that your Content Distribution Network (CDN) uses for authorization to access your endpoint.
'
SecretsRoleArn:
allOf:
- $ref: '#/components/schemas/__string'
- xml:
name: secretsRoleArn
description: 'The Amazon Resource Name (ARN) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager.
'
channelId:
description: 'The ID of the Channel that the OriginEndpoint will be associated with.
This cannot be changed after the OriginEndpoint is created.
'
type: string
cmafPackage:
description: A Common Media Application Format (CMAF) packaging configuration.
type: object
properties:
Encryption:
allOf:
- $ref: '#/components/schemas/CmafEncryption'
- xml:
name: encryption
HlsManifests:
allOf:
- $ref: '#/components/schemas/__listOfHlsManifestCreateOrUpdateParameters'
- xml:
name: hlsManifests
description: A list of HLS manifest configurations
SegmentDurationSeconds:
allOf:
- $ref: '#/components/schemas/__integer'
- xml:
name: segmentDurationSeconds
description: 'Duration (in seconds) of each segment. Actual segments will be
rounded to the nearest multiple of the source segment duration.
'
SegmentPrefix:
allOf:
- $ref: '#/components/schemas/__string'
- xml:
name: segmentPrefix
description: An optional custom string that is prepended to the name of each segment. If not specified, it defaults to the ChannelId.
StreamSelection:
allOf:
- $ref: '#/components/schemas/StreamSelection'
- xml:
name: streamSelection
dashPackage:
description: A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.
type: object
properties:
AdTriggers:
allOf:
- $ref: '#/components/schemas/AdTriggers'
- xml:
name: adTriggers
AdsOnDeliveryRestrictions:
allOf:
- $ref: '#/components/schemas/AdsOnDeliveryRestrictions'
- xml:
name: adsOnDeliveryRestrictions
Encryption:
allOf:
- $ref: '#/components/schemas/DashEncryption'
- xml:
name: encryption
IncludeIframeOnlyStream:
allOf:
- $ref: '#/components/schemas/__boolean'
- xml:
name: includeIframeOnlyStream
description: When enabled, an I-Frame only stream will be included in the output.
ManifestLayout:
allOf:
- $ref: '#/components/schemas/ManifestLayout'
- xml:
name: manifestLayout
description: Determines the position of some tags in the Media Presentation Description (MPD). When set to FULL, elements like SegmentTemplate and ContentProtection are included in each Representation. When set to COMPACT, duplicate elements are combined and presented at the AdaptationSet level.
ManifestWindowSeconds:
allOf:
- $ref: '#/components/schemas/__integer'
- xml:
name: manifestWindowSeconds
description: Time window (in seconds) contained in each manifest.
MinBufferTimeSeconds:
allOf:
- $ref: '#/components/schemas/__integer'
- xml:
name: minBufferTimeSeconds
description: Minimum duration (in seconds) that a player will buffer media before starting the presentation.
MinUpdatePeriodSeconds:
allOf:
- $ref: '#/components/schemas/__integer'
- xml:
name: minUpdatePeriodSeconds
description: Minimum duration (in seconds) between potential changes to the Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD).
PeriodTriggers:
allOf:
- $ref: '#/components/schemas/__listOf__PeriodTriggersElement'
- xml:
name: periodTriggers
description: 'A list of triggers that controls when the outgoing Dynamic Adaptive Streaming over HTTP (DASH)
Media Presentation Description (MPD) will be partitioned into multiple periods. If empty, the content will not
be partitioned into more than one period. If the list contains "ADS", new periods will be created where
the Channel source contains SCTE-35 ad markers.
'
Profile:
allOf:
- $ref: '#/components/schemas/Profile'
- xml:
name: profile
description: The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to "HBBTV_1_5", HbbTV 1.5 compliant output is enabled. When set to "DVB-DASH_2014", DVB-DASH 2014 compliant output is enabled.
SegmentDurationSeconds:
allOf:
- $ref: '#/components/schemas/__integer'
- xml:
name: segmentDurationSeconds
description: 'Duration (in seconds) of each segment. Actual segments will be
rounded to the nearest multiple of the source segment duration.
'
SegmentTemplateFormat:
allOf:
- $ref: '#/components/schemas/SegmentTemplateFormat'
- xml:
name: segmentTemplateFormat
description: Determines the type of SegmentTemplate included in the Media Presentation Description (MPD). When set to NUMBER_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Number$ media URLs. When set to TIME_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Time$ media URLs. When set to NUMBER_WITH_DURATION, only a duration is included in each SegmentTemplate, with $Number$ media URLs.
StreamSelection:
allOf:
- $ref: '#/components/schemas/StreamSelection'
- xml:
name: streamSelection
SuggestedPresentationDelaySeconds:
allOf:
- $ref: '#/components/schemas/__integer'
- xml:
name: suggestedPresentationDelaySeconds
description: Duration (in seconds) to delay live content before presentation.
UtcTiming:
allOf:
- $ref: '#/components/schemas/UtcTiming'
- xml:
name: utcTiming
description: Determines the type of UTCTiming included in the Media Presentation Description (MPD)
UtcTimingUri:
allOf:
- $ref: '#/components/schemas/__string'
- xml:
name: utcTimingUri
description: Specifies the value attribute of the UTCTiming field when utcTiming is set to HTTP-ISO, HTTP-HEAD or HTTP-XSDATE
description:
description: A short text description of the OriginEndpoint.
type: string
hlsPackage:
description: An HTTP Live Streaming (HLS) packaging configuration.
type: object
properties:
AdMarkers:
allOf:
- $ref: '#/components/schemas/AdMarkers'
- xml:
name: adMarkers
description: "This setting controls how ad markers are included in the packaged OriginEndpoint.\n\"NONE\" will omit all SCTE-35 ad markers from the output.\n\"PASSTHROUGH\" causes the manifest to contain a copy of the SCTE-35 ad\nmarkers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest.\n\"SCTE35_ENHANCED\" generates ad markers and blackout tags based on SCTE-35\nmessages in the input source.\n\"DATERANGE\" inserts EXT-X-DATERANGE tags to signal ad and program transition events \nin HLS and CMAF manifests. For this option, you must set a programDateTimeIntervalSeconds value \nthat is greater than 0.\n"
AdTriggers:
allOf:
- $ref: '#/components/schemas/AdTriggers'
- xml:
name: adTriggers
AdsOnDeliveryRestrictions:
allOf:
- $ref: '#/components/schemas/AdsOnDeliveryRestrictions'
- xml:
name: adsOnDeliveryRestrictions
Encryption:
allOf:
- $ref: '#/components/schemas/HlsEncryption'
- xml:
name: encryption
IncludeDvbSubtitles:
allOf:
- $ref: '#/components/schemas/__boolean'
- xml:
name: includeDvbSubtitles
description: When enabled, MediaPackage passes through digital video broadcasting (DVB) subtitles into the output.
IncludeIframeOnlyStream:
allOf:
- $ref: '#/components/schemas/__boolean'
- xml:
name: includeIframeOnlyStream
description: When enabled, an I-Frame only stream will be included in the output.
PlaylistType:
allOf:
- $ref: '#/components/schemas/PlaylistType'
- xml:
name: playlistType
description: 'The HTTP Live Streaming (HLS) playlist type.
When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE
entry will be included in the media playlist.
'
PlaylistWindowSeconds:
allOf:
- $ref: '#/components/schemas/__integer'
- xml:
name: playlistWindowSeconds
description: Time window (in seconds) contained in each parent manifest.
ProgramDateTimeIntervalSeconds:
allOf:
- $ref: '#/components/schemas/__integer'
- xml:
name: programDateTimeIntervalSeconds
description: 'The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag
inserted into manifests. Additionally, when an interval is specified
ID3Timed Metadata messages will be generated every 5 seconds using the
ingest time of the content.
If the interval is not specified, or set to 0, then
no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no
ID3Timed Metadata messages will be generated. Note that irrespective
of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input,
it will be passed through to HLS output.
'
SegmentDurationSeconds:
allOf:
- $ref: '#/components/schemas/__integer'
- xml:
name: segmentDurationSeconds
description: 'Duration (in seconds) of each fragment. Actual fragments will be
rounded to the nearest multiple of the source fragment duration.
'
StreamSelection:
allOf:
- $ref: '#/components/schemas/StreamSelection'
- xml:
name: streamSelection
UseAudioRenditionGroup:
allOf:
- $ref: '#/components/schemas/__boolean'
- xml:
name: useAudioRenditionGroup
description: When enabled, audio streams will be placed in rendition groups in the output.
id:
description: 'The ID of the OriginEndpoint. The ID must be unique within the region
and it cannot be changed after the OriginEndpoint is created.
'
type: string
manifestName:
description: A short string that will be used as the filename of the OriginEndpoint URL (defaults to "index").
type: string
mssPackage:
description: A Microsoft Smooth Streaming (MSS) packaging configuration.
type: object
properties:
Encryption:
allOf:
- $ref: '#/components/schemas/MssEncryption'
- xml:
name: encryption
ManifestWindowSeconds:
allOf:
- $ref: '#/components/schemas/__integer'
- xml:
name: manifestWindowSeconds
description: The time window (in seconds) contained in each manifest.
SegmentDurationSeconds:
allOf:
- $ref: '#/components/schemas/__integer'
- xml:
name: segmentDurationSeconds
description: The duration (in seconds) of each segment.
StreamSelection:
allOf:
- $ref: '#/components/schemas/StreamSelection'
- xml:
name: streamSelection
origination:
description: 'Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint
may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be
requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination
'
enum:
- ALLOW
- DENY
type: string
startoverWindowSeconds:
description: 'Maximum duration (seconds) of content to retain for startover playback.
If not specified, startover playback will be disabled for the OriginEndpoint.
'
type: integer
tags:
description: A collection of tags associated with a resource
type: object
additionalProperties:
$ref: '#/components/schemas/__string'
timeDelaySeconds:
description: 'Amount of delay (seconds) to enforce on the playback of live content.
If not specified, there will be no time delay in effect for the OriginEndpoint.
'
type: integer
whitelist:
description: A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.
type: array
items:
$ref: '#/components/schemas/__string'
summary: Amazon MediaPackage Create Origin Endpoint
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Origin Endpoints
get:
operationId: ListOriginEndpoints
description: Returns a collection of OriginEndpoint records.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListOriginEndpointsResponse'
examples:
ListOriginEndpoints200Example:
summary: Default ListOriginEndpoints 200 response
x-microcks-default: true
value:
NextToken: example-value
OriginEndpoints: example-value
'480':
description: UnprocessableEntityException
content:
application/json:
schema:
$ref: '#/components/schemas/UnprocessableEntityException'
examples:
ListOriginEndpoints480Example:
summary: Default ListOriginEndpoints 480 response
x-microcks-default: true
value: {}
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
ListOriginEndpoints481Example:
summary: Default ListOriginEndpoints 481 response
x-microcks-default: true
value: {}
'482':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
examples:
ListOriginEndpoints482Example:
summary: Default ListOriginEndpoints 482 response
x-microcks-default: true
value: {}
'483':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
examples:
ListOriginEndpoints483Example:
summary: Default ListOriginEndpoints 483 response
x-microcks-default: true
value: {}
'484':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
examples:
ListOriginEndpoints484Example:
summary: Default ListOriginEndpoints 484 response
x-microcks-default: true
value: {}
'485':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
examples:
ListOriginEndpoints485Example:
summary: Default ListOriginEndpoints 485 response
x-microcks-default: true
value: {}
parameters:
- name: channelId
in: query
required: false
description: When specified, the request will return only OriginEndpoints associated with the given Channel ID.
schema:
type: string
- name: maxResults
in: query
required: false
description: The upper bound on the number of records to return.
schema:
type: integer
minimum: 1
maximum: 1000
- name: nextToken
in: query
required: false
description: A token used to resume pagination from the end of a previous request.
schema:
type: string
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
summary: Amazon MediaPackage List Origin Endpoints
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Origin Endpoints
/origin_endpoints/{id}:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
delete:
operationId: DeleteOriginEndpoint
description: Deletes an existing OriginEndpoint.
responses:
'202':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteOriginEndpointResponse'
examples:
DeleteOriginEndpoint202Example:
summary: Default DeleteOriginEndpoint 202 response
x-microcks-default: true
value: {}
'480':
description: UnprocessableEntityException
content:
application/json:
schema:
$ref: '#/components/schemas/UnprocessableEntityException'
examples:
DeleteOriginEndpoint480Example:
summary: Default DeleteOriginEndpoint 480 response
x-microcks-default: true
value: {}
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
DeleteOriginEndpoint481Example:
summary: Default DeleteOriginEndpoint 481 response
x-microcks-default: true
value: {}
'482':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
examples:
DeleteOriginEndpoint482Example:
summary: Default DeleteOriginEndpoint 482 response
x-microcks-default: true
value: {}
'483':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
examples:
DeleteOriginEndpoint483Example:
summary: Default DeleteOriginEndpoint 483 response
x-microcks-default: true
value: {}
'484':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
examples:
DeleteOriginEndpoint484Example:
summary: Default DeleteOriginEndpoint 484 response
x-microcks-default: true
value: {}
'485':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
examples:
DeleteOriginEndpoint485Example:
summary: Default DeleteOriginEndpoint 485 response
x-microcks-default: true
value: {}
parameters:
- name: id
in: path
r
# --- truncated at 32 KB (103 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-mediapackage/refs/heads/main/openapi/amazon-mediapackage-origin-endpoints-api-openapi.yml