@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSMediaPackageV2
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSMediaPackageV2 instead.
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
CreateChannelResult |
createChannel (CreateChannelRequest createChannelRequest)
Create a channel to start receiving content streams.
|
CreateChannelGroupResult |
createChannelGroup (CreateChannelGroupRequest createChannelGroupRequest)
Create a channel group to group your channels and origin endpoints.
|
CreateOriginEndpointResult |
createOriginEndpoint (CreateOriginEndpointRequest createOriginEndpointRequest)
The endpoint is attached to a channel, and represents the output of the live content.
|
DeleteChannelResult |
deleteChannel (DeleteChannelRequest deleteChannelRequest)
Delete a channel to stop AWS Elemental MediaPackage from receiving further content.
|
DeleteChannelGroupResult |
deleteChannelGroup (DeleteChannelGroupRequest deleteChannelGroupRequest)
Delete a channel group.
|
DeleteChannelPolicyResult |
deleteChannelPolicy (DeleteChannelPolicyRequest deleteChannelPolicyRequest)
Delete a channel policy.
|
DeleteOriginEndpointResult |
deleteOriginEndpoint (DeleteOriginEndpointRequest deleteOriginEndpointRequest)
Origin endpoints can serve content until they're deleted.
|
DeleteOriginEndpointPolicyResult |
deleteOriginEndpointPolicy (DeleteOriginEndpointPolicyRequest deleteOriginEndpointPolicyRequest)
Delete an origin endpoint policy.
|
ResponseMetadata |
getCachedResponseMetadata (AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetChannelResult |
getChannel (GetChannelRequest getChannelRequest)
Retrieves the specified channel that's configured in AWS Elemental MediaPackage, including the origin endpoints
that are associated with it.
|
GetChannelGroupResult |
getChannelGroup (GetChannelGroupRequest getChannelGroupRequest)
Retrieves the specified channel group that's configured in AWS Elemental MediaPackage, including the channels and
origin endpoints that are associated with it.
|
GetChannelPolicyResult |
getChannelPolicy (GetChannelPolicyRequest getChannelPolicyRequest)
Retrieves the specified channel policy that's configured in AWS Elemental MediaPackage.
|
GetOriginEndpointResult |
getOriginEndpoint (GetOriginEndpointRequest getOriginEndpointRequest)
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.
|
GetOriginEndpointPolicyResult |
getOriginEndpointPolicy (GetOriginEndpointPolicyRequest getOriginEndpointPolicyRequest)
Retrieves the specified origin endpoint policy that's configured in AWS Elemental MediaPackage.
|
ListChannelGroupsResult |
listChannelGroups (ListChannelGroupsRequest listChannelGroupsRequest)
Retrieves all channel groups that are configured in AWS Elemental MediaPackage, including the channels and origin
endpoints that are associated with it.
|
ListChannelsResult |
listChannels (ListChannelsRequest listChannelsRequest)
Retrieves all channels in a specific channel group that are configured in AWS Elemental MediaPackage, including
the origin endpoints that are associated with it.
|
ListOriginEndpointsResult |
listOriginEndpoints (ListOriginEndpointsRequest listOriginEndpointsRequest)
Retrieves all origin endpoints in a specific channel that are configured in AWS Elemental MediaPackage.
|
ListTagsForResourceResult |
listTagsForResource (ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags assigned to a resource.
|
PutChannelPolicyResult |
putChannelPolicy (PutChannelPolicyRequest putChannelPolicyRequest)
Attaches an IAM policy to the specified channel.
|
PutOriginEndpointPolicyResult |
putOriginEndpointPolicy (PutOriginEndpointPolicyRequest putOriginEndpointPolicyRequest)
Attaches an IAM policy to the specified origin endpoint.
|
void |
shutdown ()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource (TagResourceRequest tagResourceRequest)
Assigns one of more tags (key-value pairs) to the specified MediaPackage resource.
|
UntagResourceResult |
untagResource (UntagResourceRequest untagResourceRequest)
Removes one or more tags from the specified resource.
|
UpdateChannelResult |
updateChannel (UpdateChannelRequest updateChannelRequest)
Update the specified channel.
|
UpdateChannelGroupResult |
updateChannelGroup (UpdateChannelGroupRequest updateChannelGroupRequest)
Update the specified channel group.
|
UpdateOriginEndpointResult |
updateOriginEndpoint (UpdateOriginEndpointRequest updateOriginEndpointRequest)
Update the specified origin endpoint.
|
static final String ENDPOINT_PREFIX
CreateChannelResult createChannel(CreateChannelRequest createChannelRequest)
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.
createChannelRequest - ThrottlingException - The request throughput limit was exceeded.ConflictException - Updating or deleting this resource can cause an inconsistent state.InternalServerException - Indicates that an error from the service occurred while trying to process a request.AccessDeniedException - You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access Management in the IAM User Guide.ValidationException - The input failed to meet the constraints specified by the AWS service.ResourceNotFoundException - The specified resource doesn't exist.ServiceQuotaExceededException - The request would cause a service quota to be exceeded.CreateChannelGroupResult createChannelGroup(CreateChannelGroupRequest createChannelGroupRequest)
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.
createChannelGroupRequest - ThrottlingException - The request throughput limit was exceeded.ConflictException - Updating or deleting this resource can cause an inconsistent state.InternalServerException - Indicates that an error from the service occurred while trying to process a request.AccessDeniedException - You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access Management in the IAM User Guide.ValidationException - The input failed to meet the constraints specified by the AWS service.ResourceNotFoundException - The specified resource doesn't exist.ServiceQuotaExceededException - The request would cause a service quota to be exceeded.CreateOriginEndpointResult createOriginEndpoint(CreateOriginEndpointRequest createOriginEndpointRequest)
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.
createOriginEndpointRequest - ThrottlingException - The request throughput limit was exceeded.ConflictException - Updating or deleting this resource can cause an inconsistent state.InternalServerException - Indicates that an error from the service occurred while trying to process a request.AccessDeniedException - You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access Management in the IAM User Guide.ValidationException - The input failed to meet the constraints specified by the AWS service.ResourceNotFoundException - The specified resource doesn't exist.ServiceQuotaExceededException - The request would cause a service quota to be exceeded.DeleteChannelResult deleteChannel(DeleteChannelRequest deleteChannelRequest)
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.
deleteChannelRequest - ThrottlingException - The request throughput limit was exceeded.ConflictException - Updating or deleting this resource can cause an inconsistent state.InternalServerException - Indicates that an error from the service occurred while trying to process a request.AccessDeniedException - You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access Management in the IAM User Guide.ValidationException - The input failed to meet the constraints specified by the AWS service.DeleteChannelGroupResult deleteChannelGroup(DeleteChannelGroupRequest deleteChannelGroupRequest)
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.
deleteChannelGroupRequest - ThrottlingException - The request throughput limit was exceeded.ConflictException - Updating or deleting this resource can cause an inconsistent state.InternalServerException - Indicates that an error from the service occurred while trying to process a request.AccessDeniedException - You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access Management in the IAM User Guide.ValidationException - The input failed to meet the constraints specified by the AWS service.DeleteChannelPolicyResult deleteChannelPolicy(DeleteChannelPolicyRequest deleteChannelPolicyRequest)
Delete a channel policy.
deleteChannelPolicyRequest - ThrottlingException - The request throughput limit was exceeded.ConflictException - Updating or deleting this resource can cause an inconsistent state.InternalServerException - Indicates that an error from the service occurred while trying to process a request.AccessDeniedException - You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access Management in the IAM User Guide.ValidationException - The input failed to meet the constraints specified by the AWS service.DeleteOriginEndpointResult deleteOriginEndpoint(DeleteOriginEndpointRequest deleteOriginEndpointRequest)
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.
deleteOriginEndpointRequest - ThrottlingException - The request throughput limit was exceeded.InternalServerException - Indicates that an error from the service occurred while trying to process a request.AccessDeniedException - You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access Management in the IAM User Guide.ValidationException - The input failed to meet the constraints specified by the AWS service.DeleteOriginEndpointPolicyResult deleteOriginEndpointPolicy(DeleteOriginEndpointPolicyRequest deleteOriginEndpointPolicyRequest)
Delete an origin endpoint policy.
deleteOriginEndpointPolicyRequest - ThrottlingException - The request throughput limit was exceeded.ConflictException - Updating or deleting this resource can cause an inconsistent state.InternalServerException - Indicates that an error from the service occurred while trying to process a request.AccessDeniedException - You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access Management in the IAM User Guide.ValidationException - The input failed to meet the constraints specified by the AWS service.GetChannelResult getChannel(GetChannelRequest getChannelRequest)
Retrieves the specified channel that's configured in AWS Elemental MediaPackage, including the origin endpoints that are associated with it.
getChannelRequest - ThrottlingException - The request throughput limit was exceeded.InternalServerException - Indicates that an error from the service occurred while trying to process a request.AccessDeniedException - You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access Management in the IAM User Guide.ValidationException - The input failed to meet the constraints specified by the AWS service.ResourceNotFoundException - The specified resource doesn't exist.GetChannelGroupResult getChannelGroup(GetChannelGroupRequest getChannelGroupRequest)
Retrieves the specified channel group that's configured in AWS Elemental MediaPackage, including the channels and origin endpoints that are associated with it.
getChannelGroupRequest - ThrottlingException - The request throughput limit was exceeded.InternalServerException - Indicates that an error from the service occurred while trying to process a request.AccessDeniedException - You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access Management in the IAM User Guide.ValidationException - The input failed to meet the constraints specified by the AWS service.ResourceNotFoundException - The specified resource doesn't exist.GetChannelPolicyResult getChannelPolicy(GetChannelPolicyRequest getChannelPolicyRequest)
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.
getChannelPolicyRequest - ThrottlingException - The request throughput limit was exceeded.InternalServerException - Indicates that an error from the service occurred while trying to process a request.AccessDeniedException - You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access Management in the IAM User Guide.ValidationException - The input failed to meet the constraints specified by the AWS service.ResourceNotFoundException - The specified resource doesn't exist.GetOriginEndpointResult getOriginEndpoint(GetOriginEndpointRequest getOriginEndpointRequest)
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.
getOriginEndpointRequest - ThrottlingException - The request throughput limit was exceeded.InternalServerException - Indicates that an error from the service occurred while trying to process a request.AccessDeniedException - You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access Management in the IAM User Guide.ValidationException - The input failed to meet the constraints specified by the AWS service.ResourceNotFoundException - The specified resource doesn't exist.GetOriginEndpointPolicyResult getOriginEndpointPolicy(GetOriginEndpointPolicyRequest getOriginEndpointPolicyRequest)
Retrieves the specified origin endpoint policy that's configured in AWS Elemental MediaPackage.
getOriginEndpointPolicyRequest - ThrottlingException - The request throughput limit was exceeded.InternalServerException - Indicates that an error from the service occurred while trying to process a request.AccessDeniedException - You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access Management in the IAM User Guide.ValidationException - The input failed to meet the constraints specified by the AWS service.ResourceNotFoundException - The specified resource doesn't exist.ListChannelGroupsResult listChannelGroups(ListChannelGroupsRequest listChannelGroupsRequest)
Retrieves all channel groups that are configured in AWS Elemental MediaPackage, including the channels and origin endpoints that are associated with it.
listChannelGroupsRequest - ThrottlingException - The request throughput limit was exceeded.InternalServerException - Indicates that an error from the service occurred while trying to process a request.AccessDeniedException - You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access Management in the IAM User Guide.ValidationException - The input failed to meet the constraints specified by the AWS service.ListChannelsResult listChannels(ListChannelsRequest listChannelsRequest)
Retrieves all channels in a specific channel group that are configured in AWS Elemental MediaPackage, including the origin endpoints that are associated with it.
listChannelsRequest - ThrottlingException - The request throughput limit was exceeded.InternalServerException - Indicates that an error from the service occurred while trying to process a request.AccessDeniedException - You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access Management in the IAM User Guide.ValidationException - The input failed to meet the constraints specified by the AWS service.ResourceNotFoundException - The specified resource doesn't exist.ListOriginEndpointsResult listOriginEndpoints(ListOriginEndpointsRequest listOriginEndpointsRequest)
Retrieves all origin endpoints in a specific channel that are configured in AWS Elemental MediaPackage.
listOriginEndpointsRequest - ThrottlingException - The request throughput limit was exceeded.InternalServerException - Indicates that an error from the service occurred while trying to process a request.AccessDeniedException - You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access Management in the IAM User Guide.ValidationException - The input failed to meet the constraints specified by the AWS service.ResourceNotFoundException - The specified resource doesn't exist.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags assigned to a resource.
listTagsForResourceRequest - ValidationException - The input failed to meet the constraints specified by the AWS service.PutChannelPolicyResult putChannelPolicy(PutChannelPolicyRequest putChannelPolicyRequest)
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.
putChannelPolicyRequest - ThrottlingException - The request throughput limit was exceeded.ConflictException - Updating or deleting this resource can cause an inconsistent state.InternalServerException - Indicates that an error from the service occurred while trying to process a request.AccessDeniedException - You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access Management in the IAM User Guide.ValidationException - The input failed to meet the constraints specified by the AWS service.ResourceNotFoundException - The specified resource doesn't exist.PutOriginEndpointPolicyResult putOriginEndpointPolicy(PutOriginEndpointPolicyRequest putOriginEndpointPolicyRequest)
Attaches an IAM policy to the specified origin endpoint. You can attach only one policy with each request.
putOriginEndpointPolicyRequest - ThrottlingException - The request throughput limit was exceeded.ConflictException - Updating or deleting this resource can cause an inconsistent state.InternalServerException - Indicates that an error from the service occurred while trying to process a request.AccessDeniedException - You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access Management in the IAM User Guide.ValidationException - The input failed to meet the constraints specified by the AWS service.ResourceNotFoundException - The specified resource doesn't exist.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
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.
tagResourceRequest - ValidationException - The input failed to meet the constraints specified by the AWS service.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes one or more tags from the specified resource.
untagResourceRequest - ValidationException - The input failed to meet the constraints specified by the AWS service.UpdateChannelResult updateChannel(UpdateChannelRequest updateChannelRequest)
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.
updateChannelRequest - ThrottlingException - The request throughput limit was exceeded.ConflictException - Updating or deleting this resource can cause an inconsistent state.InternalServerException - Indicates that an error from the service occurred while trying to process a request.AccessDeniedException - You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access Management in the IAM User Guide.ValidationException - The input failed to meet the constraints specified by the AWS service.ResourceNotFoundException - The specified resource doesn't exist.UpdateChannelGroupResult updateChannelGroup(UpdateChannelGroupRequest updateChannelGroupRequest)
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.
updateChannelGroupRequest - ThrottlingException - The request throughput limit was exceeded.ConflictException - Updating or deleting this resource can cause an inconsistent state.InternalServerException - Indicates that an error from the service occurred while trying to process a request.AccessDeniedException - You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access Management in the IAM User Guide.ValidationException - The input failed to meet the constraints specified by the AWS service.ResourceNotFoundException - The specified resource doesn't exist.UpdateOriginEndpointResult updateOriginEndpoint(UpdateOriginEndpointRequest updateOriginEndpointRequest)
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.
updateOriginEndpointRequest - ThrottlingException - The request throughput limit was exceeded.ConflictException - Updating or deleting this resource can cause an inconsistent state.InternalServerException - Indicates that an error from the service occurred while trying to process a request.AccessDeniedException - You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access Management in the IAM User Guide.ValidationException - The input failed to meet the constraints specified by the AWS service.ResourceNotFoundException - The specified resource doesn't exist.ServiceQuotaExceededException - The request would cause a service quota to be exceeded.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request - The originally executed request.