MediaPackageV2

import { MediaPackageV2 } from "https://aws-api-bqtgftz736ft.deno.dev/v0.5/services/mediapackagev2.ts?docs=full";

class MediaPackageV2 {

constructor(apiFactory: client.ApiFactory);

async createChannel(params: CreateChannelRequest, opts?: client.RequestOptions): Promise<CreateChannelResponse>;

async createChannelGroup(params: CreateChannelGroupRequest, opts?: client.RequestOptions): Promise<CreateChannelGroupResponse>;

async createOriginEndpoint(params: CreateOriginEndpointRequest, opts?: client.RequestOptions): Promise<CreateOriginEndpointResponse>;

async deleteChannel(params: DeleteChannelRequest, opts?: client.RequestOptions): Promise<void>;

async deleteChannelGroup(params: DeleteChannelGroupRequest, opts?: client.RequestOptions): Promise<void>;

async deleteChannelPolicy(params: DeleteChannelPolicyRequest, opts?: client.RequestOptions): Promise<void>;

async deleteOriginEndpoint(params: DeleteOriginEndpointRequest, opts?: client.RequestOptions): Promise<void>;

async deleteOriginEndpointPolicy(params: DeleteOriginEndpointPolicyRequest, opts?: client.RequestOptions): Promise<void>;

async getChannel(params: GetChannelRequest, opts?: client.RequestOptions): Promise<GetChannelResponse>;

async getChannelGroup(params: GetChannelGroupRequest, opts?: client.RequestOptions): Promise<GetChannelGroupResponse>;

async getChannelPolicy(params: GetChannelPolicyRequest, opts?: client.RequestOptions): Promise<GetChannelPolicyResponse>;

async getOriginEndpoint(params: GetOriginEndpointRequest, opts?: client.RequestOptions): Promise<GetOriginEndpointResponse>;

async getOriginEndpointPolicy(params: GetOriginEndpointPolicyRequest, opts?: client.RequestOptions): Promise<GetOriginEndpointPolicyResponse>;

async listChannelGroups(params?: ListChannelGroupsRequest, opts?: client.RequestOptions): Promise<ListChannelGroupsResponse>;

async listChannels(params: ListChannelsRequest, opts?: client.RequestOptions): Promise<ListChannelsResponse>;

async listOriginEndpoints(params: ListOriginEndpointsRequest, opts?: client.RequestOptions): Promise<ListOriginEndpointsResponse>;

async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;

async putChannelPolicy(params: PutChannelPolicyRequest, opts?: client.RequestOptions): Promise<void>;

async putOriginEndpointPolicy(params: PutOriginEndpointPolicyRequest, opts?: client.RequestOptions): Promise<void>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async updateChannel(params: UpdateChannelRequest, opts?: client.RequestOptions): Promise<UpdateChannelResponse>;

async updateChannelGroup(params: UpdateChannelGroupRequest, opts?: client.RequestOptions): Promise<UpdateChannelGroupResponse>;

async updateOriginEndpoint(params: UpdateOriginEndpointRequest, opts?: client.RequestOptions): Promise<UpdateOriginEndpointResponse>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new MediaPackageV2(apiFactory: client.ApiFactory)

[src]

§Methods

createChannel(params: CreateChannelRequest, opts?: client.RequestOptions): Promise<CreateChannelResponse>

[src]

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: CreateChannelGroupRequest, opts?: client.RequestOptions): Promise<CreateChannelGroupResponse>

[src]

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: CreateOriginEndpointRequest, opts?: client.RequestOptions): Promise<CreateOriginEndpointResponse>

[src]

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: DeleteChannelRequest, opts?: client.RequestOptions): Promise<void>

[src]

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: DeleteChannelGroupRequest, opts?: client.RequestOptions): Promise<void>

[src]

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: DeleteChannelPolicyRequest, opts?: client.RequestOptions): Promise<void>

[src]

Delete a channel policy.

deleteOriginEndpoint(params: DeleteOriginEndpointRequest, opts?: client.RequestOptions): Promise<void>

[src]

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: DeleteOriginEndpointPolicyRequest, opts?: client.RequestOptions): Promise<void>

[src]

Delete an origin endpoint policy.

getChannel(params: GetChannelRequest, opts?: client.RequestOptions): Promise<GetChannelResponse>

[src]

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

getChannelGroup(params: GetChannelGroupRequest, opts?: client.RequestOptions): Promise<GetChannelGroupResponse>

[src]

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: GetChannelPolicyRequest, opts?: client.RequestOptions): Promise<GetChannelPolicyResponse>

[src]

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: GetOriginEndpointRequest, opts?: client.RequestOptions): Promise<GetOriginEndpointResponse>

[src]

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: GetOriginEndpointPolicyRequest, opts?: client.RequestOptions): Promise<GetOriginEndpointPolicyResponse>

[src]

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

listChannelGroups(params?: ListChannelGroupsRequest, opts?: client.RequestOptions): Promise<ListChannelGroupsResponse>

[src]

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

listChannels(params: ListChannelsRequest, opts?: client.RequestOptions): Promise<ListChannelsResponse>

[src]

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: ListOriginEndpointsRequest, opts?: client.RequestOptions): Promise<ListOriginEndpointsResponse>

[src]

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

listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>

[src]

Lists the tags assigned to a resource.

putChannelPolicy(params: PutChannelPolicyRequest, opts?: client.RequestOptions): Promise<void>

[src]

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: PutOriginEndpointPolicyRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

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: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Removes one or more tags from the specified resource.

updateChannel(params: UpdateChannelRequest, opts?: client.RequestOptions): Promise<UpdateChannelResponse>

[src]

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: UpdateChannelGroupRequest, opts?: client.RequestOptions): Promise<UpdateChannelGroupResponse>

[src]

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: UpdateOriginEndpointRequest, opts?: client.RequestOptions): Promise<UpdateOriginEndpointResponse>

[src]

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.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]