AWS.MediaPackageV2 — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Note: 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.

Sending a Request Using MediaPackageV2

var mediapackagev2 = new AWS.MediaPackageV2();
mediapackagev2.createChannel(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the MediaPackageV2 object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var mediapackagev2 = new AWS.MediaPackageV2({apiVersion: '2022-12-25'});

You can also set the API version globally in AWS.config.apiVersions using the mediapackagev2 service identifier:

AWS.config.apiVersions = {
  mediapackagev2: '2022-12-25',
  // other service API versions
};

var mediapackagev2 = new AWS.MediaPackageV2();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, setupRequestListeners, defineService

Constructor Details

new AWS.MediaPackageV2(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

createChannel(params = {}, callback) ⇒ AWS.Request

Create a channel to start receiving content streams. The channel represents the input to MediaPackage for incoming live content from an encoder such as AWS Elemental MediaLive. The channel receives content, and after packaging it, outputs it through an origin endpoint to downstream devices (such as video players or CDNs) that request the content. You can create only one channel with each request. We recommend that you spread out channels between channel groups, such as putting redundant channels in the same AWS Region in different channel groups.

createChannelGroup(params = {}, callback) ⇒ AWS.Request

Create 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 that are associated with it and that provides predictable URLs for stream delivery. All channels and origin endpoints within the channel group are guaranteed to share the DNS. You can create only one channel group with each request.

createOriginEndpoint(params = {}, callback) ⇒ AWS.Request

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.

deleteChannel(params = {}, callback) ⇒ AWS.Request

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 channel.

deleteChannelGroup(params = {}, callback) ⇒ AWS.Request

Delete 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 group, you'll lose access to the egress domain and will have to create a new channel group to replace it.

deleteChannelPolicy(params = {}, callback) ⇒ AWS.Request

deleteOriginEndpoint(params = {}, callback) ⇒ AWS.Request

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.

deleteOriginEndpointPolicy(params = {}, callback) ⇒ AWS.Request

Delete an origin endpoint policy.

getChannel(params = {}, callback) ⇒ AWS.Request

Retrieves the specified channel that's configured in AWS Elemental MediaPackage, including the origin endpoints that are associated with it.

getChannelGroup(params = {}, callback) ⇒ AWS.Request

Retrieves the specified channel group that's configured in AWS Elemental MediaPackage, including the channels and origin endpoints that are associated with it.

getChannelPolicy(params = {}, callback) ⇒ AWS.Request

Retrieves the specified channel policy that's configured in AWS Elemental MediaPackage. With policies, you can specify who has access to AWS resources and what actions they can perform on those resources.

getOriginEndpoint(params = {}, callback) ⇒ AWS.Request

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.

getOriginEndpointPolicy(params = {}, callback) ⇒ AWS.Request

Retrieves the specified origin endpoint policy that's configured in AWS Elemental MediaPackage.

listChannelGroups(params = {}, callback) ⇒ AWS.Request

Retrieves all channel groups that are configured in AWS Elemental MediaPackage, including the channels and origin endpoints that are associated with it.

listChannels(params = {}, callback) ⇒ AWS.Request

Retrieves all channels in a specific channel group that are configured in AWS Elemental MediaPackage, including the origin endpoints that are associated with it.

listOriginEndpoints(params = {}, callback) ⇒ AWS.Request

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

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Lists the tags assigned to a resource.

putChannelPolicy(params = {}, callback) ⇒ AWS.Request

Attaches 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 resources. You can attach only one policy with each request.

putOriginEndpointPolicy(params = {}, callback) ⇒ AWS.Request

Attaches an IAM policy to the specified origin endpoint. You can attach only one policy with each request.

tagResource(params = {}, callback) ⇒ AWS.Request

Assigns 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 them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the TagResource operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes one or more tags from the specified resource.

updateChannel(params = {}, callback) ⇒ AWS.Request

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 description on a channel, and your channel's policy settings. You can't edit the name of the channel or CloudFront distribution details.

Any edits you make that impact the video output may not be reflected for a few minutes.

updateChannelGroup(params = {}, callback) ⇒ AWS.Request

Update the specified channel group. You can edit the description on a channel group for easier identification later from the AWS Elemental MediaPackage console. You can't edit the name of the channel group.

Any edits you make that impact the video output may not be reflected for a few minutes.

updateOriginEndpoint(params = {}, callback) ⇒ AWS.Request

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.

waitFor(state, params = {}, callback) ⇒ AWS.Request

Waits for a given MediaPackageV2 resource. The final callback or'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.