AWS Elemental MediaPackage v2
This guide is intended for creating AWS Elemental MediaPackage resources in MediaPackage Version 2 (v2) starting from May 2023. To get started with…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
This guide is intended for creating AWS Elemental MediaPackage resources in MediaPackage Version 2 (v2) starting from May 2023. To get started with MediaPackage v2, create your MediaPackage resources. There isn't an automated process to migrate your resources from MediaPackage v1 to MediaPackage v2. The names of the entities that you use to access this API, like URLs and ARNs, all have the versioning information added, like "v2", to distinguish from the prior version. If you used MediaPackage prior to this release, you can't use the MediaPackage v2 CLI or the MediaPackage v2 API to access any MediaPackage v1 resources. If you created resources in MediaPackage v1, use video on demand (VOD) workflows, and aren't looking to migrate to MediaPackage v2 yet, see the MediaPackage v1 Live API Reference . This is the AWS Elemental MediaPackage v2 Live REST API Reference. It describes all the MediaPackage API operations for live content in detail, and provides sample requests, responses, and errors for the supported web services protocols. We assume that you have the IAM permissions that you need to use MediaPackage via the REST API. We also assume that you are familiar with the features and operations of MediaPackage, as described in the AWS Elemental MediaPackage User Guide.
Endpoints 30
Harvest job
- GETGet harvest job
/channelGroup/:ChannelGroupName/channel/:ChannelName/originEndpoint/:OriginEndpointName/harvestJob/:HarvestJobNameRetrieves the details of a specific harvest job. - PUTCancel harvest job
/channelGroup/:ChannelGroupName/channel/:ChannelName/originEndpoint/:OriginEndpointName/harvestJob/:HarvestJobNameCancels an in-progress harvest job. - POSTCreate harvest job
/channelGroup/:ChannelGroupName/channel/:ChannelName/originEndpoint/:OriginEndpointName/harvestJobCreates a new harvest job to export content from a MediaPackage v2 channel to an S3 bucket. - GETList harvest jobs
/channelGroup/:ChannelGroupName/harvestJob?channelName=string&originEndpointName=string&includeStatus=string&maxResults=0&nextToken=stringRetrieves a list of harvest jobs that match the specified criteria.
Channel
- GETList channels
/channelGroup/:ChannelGroupName/channel?maxResults=0&nextToken=stringRetrieves all channels in a specific channel group that are configured in AWS Elemental MediaPackage. - POSTCreate channel
/channelGroup/:ChannelGroupName/channelCreate a channel to start receiving content streams. The channel represents the input to MediaPackage for incoming live content from an encoder such as AWS… - GETGet channel
/channelGroup/:ChannelGroupName/channel/:ChannelName/Retrieves the specified channel that's configured in AWS Elemental MediaPackage. - PUTUpdate channel
/channelGroup/:ChannelGroupName/channel/:ChannelName/Update the specified channel. You can edit if MediaPackage sends ingest or egress access logs to the CloudWatch log group, if content will be encrypted, the… - DELETEDelete channel
/channelGroup/:ChannelGroupName/channel/:ChannelName/Delete a channel to stop AWS Elemental MediaPackage from receiving further content. You must delete the channel's origin endpoints before you can delete the… - POSTReset channel state
/channelGroup/:ChannelGroupName/channel/:ChannelName/resetResetting the channel can help to clear errors from misconfigurations in the encoder. A reset refreshes the ingest stream and removes previous content. Be…
Channel group
- GETList channel groups
/channelGroup?maxResults=0&nextToken=stringRetrieves all channel groups that are configured in Elemental MediaPackage. - POSTCreate channel group
/channelGroupCreate a channel group to group your channels and origin endpoints. A channel group is the top-level resource that consists of channels and origin endpoints… - GETGet channel group
/channelGroup/:ChannelGroupNameRetrieves the specified channel group that's configured in AWS Elemental MediaPackage. - PUTUpdate channel group
/channelGroup/:ChannelGroupNameUpdate the specified channel group. You can edit the description on a channel group for easier identification later from the AWS Elemental MediaPackage… - DELETEDelete channel group
/channelGroup/:ChannelGroupNameDelete a channel group. You must delete the channel group's channels and origin endpoints before you can delete the channel group. If you delete a channel…
Origin endpoint
- GETList origin endpoints
/channelGroup/:ChannelGroupName/channel/:ChannelName/originEndpoint?maxResults=0&nextToken=stringRetrieves all origin endpoints in a specific channel that are configured in AWS Elemental MediaPackage. - POSTCreate origin endpoint
/channelGroup/:ChannelGroupName/channel/:ChannelName/originEndpointThe 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… - GETGet origin endpoint
/channelGroup/:ChannelGroupName/channel/:ChannelName/originEndpoint/:OriginEndpointNameRetrieves the specified origin endpoint that's configured in AWS Elemental MediaPackage to obtain its playback URL and to view the packaging settings that… - PUTUpdate origin endpoint
/channelGroup/:ChannelGroupName/channel/:ChannelName/originEndpoint/:OriginEndpointNameUpdate the specified origin endpoint. Edit the packaging preferences on an endpoint to optimize the viewing experience. You can't edit the name of the… - DELETEDelete origin endpoint
/channelGroup/:ChannelGroupName/channel/:ChannelName/originEndpoint/:OriginEndpointNameOrigin endpoints can serve content until they're deleted. Delete the endpoint if it should no longer respond to playback requests. You must delete all… - POSTReset origin endpoint state
/channelGroup/:ChannelGroupName/channel/:ChannelName/originEndpoint/:OriginEndpointName/resetResetting the origin endpoint can help to resolve unexpected behavior and other content packaging issues. It also helps to preserve special events when you…
Channel policy
- GETGet channel policy
/channelGroup/:ChannelGroupName/channel/:ChannelName/policyRetrieves the specified channel policy that's configured in AWS Elemental MediaPackage. With policies, you can specify who has access to AWS resources and… - PUTPut channel policy
/channelGroup/:ChannelGroupName/channel/:ChannelName/policyAttaches an IAM policy to the specified channel. With policies, you can specify who has access to AWS resources and what actions they can perform on those… - DELETEDelete channel policy
/channelGroup/:ChannelGroupName/channel/:ChannelName/policyDelete a channel policy.
Origin endpoint policy
- GETGet origin endpoint policy
/channelGroup/:ChannelGroupName/channel/:ChannelName/originEndpoint/:OriginEndpointName/policyRetrieves the specified origin endpoint policy that's configured in AWS Elemental MediaPackage. - POSTPut origin endpoint policy
/channelGroup/:ChannelGroupName/channel/:ChannelName/originEndpoint/:OriginEndpointName/policyAttaches an IAM policy to the specified origin endpoint. You can attach only one policy with each request. - DELETEDelete origin endpoint policy
/channelGroup/:ChannelGroupName/channel/:ChannelName/originEndpoint/:OriginEndpointName/policyDelete an origin endpoint policy.
- GETList tags for resource
/tags/:ResourceArnLists the tags assigned to a resource. - POSTTag resource
/tags/:ResourceArnAssigns one of more tags (key-value pairs) to the specified MediaPackage resource. Tags can help you organize and categorize your resources. You can also use… - DELETEUntag resource
/tags/:ResourceArn?tagKeys=Removes one or more tags from the specified resource.
API details
- Base URL
https://mediapackagev2.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 30 operations on 14 pathsGET 11POST 8DELETE 6PUT 5
- Main resources
- Channel 6Origin endpoint 6Channel group 5Harvest job 4Channel policy 3Origin endpoint policy 3
- Description format
- AWS Smithy model, API version
2022-12-25 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the AWS Elemental MediaPackage v2 in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Elemental MediaPackage v2 collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get harvest job” (GET /channelGroup/:ChannelGroupName/channel/:ChannelName/originEndpoint/:OriginEndpointName/harvestJob/:HarvestJobName), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the AWS Elemental MediaPackage v2?
This guide is intended for creating AWS Elemental MediaPackage resources in MediaPackage Version 2 (v2) starting from May 2023. To get started with… It is listed under Media & content and has 30 endpoints.
Who publishes the AWS Elemental MediaPackage v2?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the AWS Elemental MediaPackage v2?
Requests go to https://mediapackagev2.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the AWS Elemental MediaPackage v2?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the AWS Elemental MediaPackage v2 have?
30 operations on 14 paths (11 GET, 8 POST, 6 DELETE, 5 PUT). The largest groups are Channel, Origin endpoint, Channel group, Harvest job.
Is forking the AWS Elemental MediaPackage v2 free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.