AWS Elemental MediaPackage is a video origination and just-in-time packaging service that reliably prepares and protects video for delivery over the internet, creating multiple output formats from a single video input.
openapi: 3.0.0
info:
version: 2017-10-12
x-release: v4
title: AWS Elemental MediaPackage
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: [email protected]
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
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/mediapackage/
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)
x-hasEquivalentPaths: true
paths:
"/channels/{id}/configure_logs":
put:
operationId: ConfigureLogs
description: Changes the Channel's properities to configure log subscription
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ConfigureLogsResponse"
examples:
ConfigureLogs200Example:
summary: Default ConfigureLogs 200 response
x-microcks-default: true
value:
Arn: arn:aws:service:us-east-1:123456789012:resource/example
CreatedAt: example-value
Description: Example description
EgressAccessLogs: example-value
HlsIngest: example-value
"480":
description: UnprocessableEntityException
content:
application/json:
schema:
$ref: "#/components/schemas/UnprocessableEntityException"
examples:
ConfigureLogs480Example:
summary: Default ConfigureLogs 480 response
x-microcks-default: true
value: {}
"481":
description: InternalServerErrorException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerErrorException"
examples:
ConfigureLogs481Example:
summary: Default ConfigureLogs 481 response
x-microcks-default: true
value: {}
"482":
description: ForbiddenException
content:
application/json:
schema:
$ref: "#/components/schemas/ForbiddenException"
examples:
ConfigureLogs482Example:
summary: Default ConfigureLogs 482 response
x-microcks-default: true
value: {}
"483":
description: NotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/NotFoundException"
examples:
ConfigureLogs483Example:
summary: Default ConfigureLogs 483 response
x-microcks-default: true
value: {}
"484":
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: "#/components/schemas/ServiceUnavailableException"
examples:
ConfigureLogs484Example:
summary: Default ConfigureLogs 484 response
x-microcks-default: true
value: {}
"485":
description: TooManyRequestsException
content:
application/json:
schema:
$ref: "#/components/schemas/TooManyRequestsException"
examples:
ConfigureLogs485Example:
summary: Default ConfigureLogs 485 response
x-microcks-default: true
value: {}
parameters:
- name: id
in: path
required: true
description: The ID of the channel to log subscription.
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
egressAccessLogs:
description: Configure egress access logging.
type: object
properties:
LogGroupName:
allOf:
- $ref: "#/components/schemas/__string"
- xml:
name: logGroupName
description: Customize the log group name.
ingressAccessLogs:
description: Configure ingress access logging.
type: object
properties:
LogGroupName:
allOf:
- $ref: "#/components/schemas/__string"
- xml:
name: logGroupName
description: Customize the log group name.
summary: Amazon MediaPackage Configure Logs
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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"
/channels:
post:
operationId: CreateChannel
description: Creates a new Channel.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/CreateChannelResponse"
examples:
CreateChannel200Example:
summary: Default CreateChannel 200 response
x-microcks-default: true
value:
Arn: arn:aws:service:us-east-1:123456789012:resource/example
CreatedAt: example-value
Description: Example description
EgressAccessLogs: example-value
HlsIngest: example-value
"480":
description: UnprocessableEntityException
content:
application/json:
schema:
$ref: "#/components/schemas/UnprocessableEntityException"
examples:
CreateChannel480Example:
summary: Default CreateChannel 480 response
x-microcks-default: true
value: {}
"481":
description: InternalServerErrorException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerErrorException"
examples:
CreateChannel481Example:
summary: Default CreateChannel 481 response
x-microcks-default: true
value: {}
"482":
description: ForbiddenException
content:
application/json:
schema:
$ref: "#/components/schemas/ForbiddenException"
examples:
CreateChannel482Example:
summary: Default CreateChannel 482 response
x-microcks-default: true
value: {}
"483":
description: NotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/NotFoundException"
examples:
CreateChannel483Example:
summary: Default CreateChannel 483 response
x-microcks-default: true
value: {}
"484":
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: "#/components/schemas/ServiceUnavailableException"
examples:
CreateChannel484Example:
summary: Default CreateChannel 484 response
x-microcks-default: true
value: {}
"485":
description: TooManyRequestsException
content:
application/json:
schema:
$ref: "#/components/schemas/TooManyRequestsException"
examples:
CreateChannel485Example:
summary: Default CreateChannel 485 response
x-microcks-default: true
value: {}
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- id
properties:
description:
description: A short text description of the Channel.
type: string
id:
description: |
The ID of the Channel. The ID must be unique within the region and it
cannot be changed after a Channel is created.
type: string
tags:
description: A collection of tags associated with a resource
type: object
additionalProperties:
$ref: "#/components/schemas/__string"
summary: Amazon MediaPackage Create Channel
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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"
get:
operationId: ListChannels
description: Returns a collection of Channels.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ListChannelsResponse"
examples:
ListChannels200Example:
summary: Default ListChannels 200 response
x-microcks-default: true
value:
Channels: example-value
NextToken: example-value
"480":
description: UnprocessableEntityException
content:
application/json:
schema:
$ref: "#/components/schemas/UnprocessableEntityException"
examples:
ListChannels480Example:
summary: Default ListChannels 480 response
x-microcks-default: true
value: {}
"481":
description: InternalServerErrorException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerErrorException"
examples:
ListChannels481Example:
summary: Default ListChannels 481 response
x-microcks-default: true
value: {}
"482":
description: ForbiddenException
content:
application/json:
schema:
$ref: "#/components/schemas/ForbiddenException"
examples:
ListChannels482Example:
summary: Default ListChannels 482 response
x-microcks-default: true
value: {}
"483":
description: NotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/NotFoundException"
examples:
ListChannels483Example:
summary: Default ListChannels 483 response
x-microcks-default: true
value: {}
"484":
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: "#/components/schemas/ServiceUnavailableException"
examples:
ListChannels484Example:
summary: Default ListChannels 484 response
x-microcks-default: true
value: {}
"485":
description: TooManyRequestsException
content:
application/json:
schema:
$ref: "#/components/schemas/TooManyRequestsException"
examples:
ListChannels485Example:
summary: Default ListChannels 485 response
x-microcks-default: true
value: {}
parameters:
- name: maxResults
in: query
required: false
description: Upper bound on 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 Channels
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/harvest_jobs:
post:
operationId: CreateHarvestJob
description: Creates a new HarvestJob record.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/CreateHarvestJobResponse"
examples:
CreateHarvestJob200Example:
summary: Default CreateHarvestJob 200 response
x-microcks-default: true
value:
Arn: arn:aws:service:us-east-1:123456789012:resource/example
ChannelId: id-abc123
CreatedAt: example-value
EndTime: example-value
Id: id-abc123
"480":
description: UnprocessableEntityException
content:
application/json:
schema:
$ref: "#/components/schemas/UnprocessableEntityException"
examples:
CreateHarvestJob480Example:
summary: Default CreateHarvestJob 480 response
x-microcks-default: true
value: {}
"481":
description: InternalServerErrorException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerErrorException"
examples:
CreateHarvestJob481Example:
summary: Default CreateHarvestJob 481 response
x-microcks-default: true
value: {}
"482":
description: ForbiddenException
content:
application/json:
schema:
$ref: "#/components/schemas/ForbiddenException"
examples:
CreateHarvestJob482Example:
summary: Default CreateHarvestJob 482 response
x-microcks-default: true
value: {}
"483":
description: NotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/NotFoundException"
examples:
CreateHarvestJob483Example:
summary: Default CreateHarvestJob 483 response
x-microcks-default: true
value: {}
"484":
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: "#/components/schemas/ServiceUnavailableException"
examples:
CreateHarvestJob484Example:
summary: Default CreateHarvestJob 484 response
x-microcks-default: true
value: {}
"485":
description: TooManyRequestsException
content:
application/json:
schema:
$ref: "#/components/schemas/TooManyRequestsException"
examples:
CreateHarvestJob485Example:
summary: Default CreateHarvestJob 485 response
x-microcks-default: true
value: {}
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- endTime
- id
- originEndpointId
- s3Destination
- startTime
properties:
endTime:
description: |
The end of the time-window which will be harvested
type: string
id:
description: |
The ID of the HarvestJob. The ID must be unique within the region
and it cannot be changed after the HarvestJob is submitted
type: string
originEndpointId:
description: |
The ID of the OriginEndpoint that the HarvestJob will harvest from.
This cannot be changed after the HarvestJob is submitted.
type: string
s3Destination:
description: |
Configuration parameters for where in an S3 bucket to place the harvested content
type: object
properties:
BucketName:
allOf:
- $ref: "#/components/schemas/__string"
- xml:
name: bucketName
description: |
The name of an S3 bucket within which harvested content will be exported
ManifestKey:
allOf:
- $ref: "#/components/schemas/__string"
- xml:
name: manifestKey
description: |
The key in the specified S3 bucket where the harvested top-level manifest will be placed.
RoleArn:
allOf:
- $ref: "#/components/schemas/__string"
- xml:
name: roleArn
description: |
The IAM role used to write to the specified S3 bucket
startTime:
description: |
The start of the time-window which will be harvested
type: string
summary: Amazon MediaPackage Create Harvest Job
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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"
get:
operationId: ListHarvestJobs
description: Returns a collection of HarvestJob records.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ListHarvestJobsResponse"
examples:
ListHarvestJobs200Example:
summary: Default ListHarvestJobs 200 response
x-microcks-default: true
value:
HarvestJobs: example-value
NextToken: example-value
"480":
description: UnprocessableEntityException
content:
application/json:
schema:
$ref: "#/components/schemas/UnprocessableEntityException"
examples:
ListHarvestJobs480Example:
summary: Default ListHarvestJobs 480 response
x-microcks-default: true
value: {}
"481":
description: InternalServerErrorException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerErrorException"
examples:
ListHarvestJobs481Example:
summary: Default ListHarvestJobs 481 response
x-microcks-default: true
value: {}
"482":
description: ForbiddenException
content:
application/json:
schema:
$ref: "#/components/schemas/ForbiddenException"
examples:
ListHarvestJobs482Example:
summary: Default ListHarvestJobs 482 response
x-microcks-default: true
value: {}
"483":
description: NotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/NotFoundException"
examples:
ListHarvestJobs483Example:
summary: Default ListHarvestJobs 483 response
x-microcks-default: true
value: {}
"484":
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: "#/components/schemas/ServiceUnavailableException"
examples:
ListHarvestJobs484Example:
summary: Default ListHarvestJobs 484 response
x-microcks-default: true
value: {}
"485":
description: TooManyRequestsException
content:
application/json:
schema:
$ref: "#/components/schemas/TooManyRequestsException"
examples:
ListHarvestJobs485Example:
summary: Default ListHarvestJobs 485 response
x-microcks-default: true
value: {}
parameters:
- name: includeChannelId
in: query
required: false
description: When specified, the request will return only HarvestJobs associated with the given Channel ID.
schema:
type: string
- name: includeStatus
in: query
required: false
description: When specified, the request will return only HarvestJobs in the given status.
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 Harvest Jobs
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/origin_endpoints:
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 seg
# --- truncated at 32 KB (187 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-mediapackage/refs/heads/main/openapi/amazon-mediapackage-openapi-original.yml