@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSMediaPackageV2Client extends AmazonWebServiceClient implements AWSMediaPackageV2
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.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
static AWSMediaPackageV2ClientBuilder |
builder() |
CreateChannelResult |
createChannel(CreateChannelRequest request)
Create a channel to start receiving content streams.
|
CreateChannelGroupResult |
createChannelGroup(CreateChannelGroupRequest request)
Create a channel group to group your channels and origin endpoints.
|
CreateOriginEndpointResult |
createOriginEndpoint(CreateOriginEndpointRequest request)
The endpoint is attached to a channel, and represents the output of the live content.
|
DeleteChannelResult |
deleteChannel(DeleteChannelRequest request)
Delete a channel to stop AWS Elemental MediaPackage from receiving further content.
|
DeleteChannelGroupResult |
deleteChannelGroup(DeleteChannelGroupRequest request)
Delete a channel group.
|
DeleteChannelPolicyResult |
deleteChannelPolicy(DeleteChannelPolicyRequest request)
Delete a channel policy.
|
DeleteOriginEndpointResult |
deleteOriginEndpoint(DeleteOriginEndpointRequest request)
Origin endpoints can serve content until they're deleted.
|
DeleteOriginEndpointPolicyResult |
deleteOriginEndpointPolicy(DeleteOriginEndpointPolicyRequest request)
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 request)
Retrieves the specified channel that's configured in AWS Elemental MediaPackage, including the origin endpoints
that are associated with it.
|
GetChannelGroupResult |
getChannelGroup(GetChannelGroupRequest request)
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 request)
Retrieves the specified channel policy that's configured in AWS Elemental MediaPackage.
|
GetOriginEndpointResult |
getOriginEndpoint(GetOriginEndpointRequest 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.
|
GetOriginEndpointPolicyResult |
getOriginEndpointPolicy(GetOriginEndpointPolicyRequest request)
Retrieves the specified origin endpoint policy that's configured in AWS Elemental MediaPackage.
|
ListChannelGroupsResult |
listChannelGroups(ListChannelGroupsRequest request)
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 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.
|
ListOriginEndpointsResult |
listOriginEndpoints(ListOriginEndpointsRequest request)
Retrieves all origin endpoints in a specific channel that are configured in AWS Elemental MediaPackage.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Lists the tags assigned to a resource.
|
PutChannelPolicyResult |
putChannelPolicy(PutChannelPolicyRequest request)
Attaches an IAM policy to the specified channel.
|
PutOriginEndpointPolicyResult |
putOriginEndpointPolicy(PutOriginEndpointPolicyRequest request)
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 request)
Assigns one of more tags (key-value pairs) to the specified MediaPackage resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes one or more tags from the specified resource.
|
UpdateChannelResult |
updateChannel(UpdateChannelRequest request)
Update the specified channel.
|
UpdateChannelGroupResult |
updateChannelGroup(UpdateChannelGroupRequest request)
Update the specified channel group.
|
UpdateOriginEndpointResult |
updateOriginEndpoint(UpdateOriginEndpointRequest request)
Update the specified origin endpoint.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
public static AWSMediaPackageV2ClientBuilder builder()
public CreateChannelResult createChannel(CreateChannelRequest 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.
createChannel
in interface AWSMediaPackageV2
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.public CreateChannelGroupResult createChannelGroup(CreateChannelGroupRequest 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.
createChannelGroup
in interface AWSMediaPackageV2
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.public CreateOriginEndpointResult createOriginEndpoint(CreateOriginEndpointRequest 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.
createOriginEndpoint
in interface AWSMediaPackageV2
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.public DeleteChannelResult deleteChannel(DeleteChannelRequest 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.
deleteChannel
in interface AWSMediaPackageV2
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.public DeleteChannelGroupResult deleteChannelGroup(DeleteChannelGroupRequest 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.
deleteChannelGroup
in interface AWSMediaPackageV2
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.public DeleteChannelPolicyResult deleteChannelPolicy(DeleteChannelPolicyRequest request)
Delete a channel policy.
deleteChannelPolicy
in interface AWSMediaPackageV2
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.public DeleteOriginEndpointResult deleteOriginEndpoint(DeleteOriginEndpointRequest 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.
deleteOriginEndpoint
in interface AWSMediaPackageV2
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.public DeleteOriginEndpointPolicyResult deleteOriginEndpointPolicy(DeleteOriginEndpointPolicyRequest request)
Delete an origin endpoint policy.
deleteOriginEndpointPolicy
in interface AWSMediaPackageV2
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.public GetChannelResult getChannel(GetChannelRequest request)
Retrieves the specified channel that's configured in AWS Elemental MediaPackage, including the origin endpoints that are associated with it.
getChannel
in interface AWSMediaPackageV2
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.public GetChannelGroupResult getChannelGroup(GetChannelGroupRequest request)
Retrieves the specified channel group that's configured in AWS Elemental MediaPackage, including the channels and origin endpoints that are associated with it.
getChannelGroup
in interface AWSMediaPackageV2
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.public GetChannelPolicyResult getChannelPolicy(GetChannelPolicyRequest 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.
getChannelPolicy
in interface AWSMediaPackageV2
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.public GetOriginEndpointResult getOriginEndpoint(GetOriginEndpointRequest 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.
getOriginEndpoint
in interface AWSMediaPackageV2
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.public GetOriginEndpointPolicyResult getOriginEndpointPolicy(GetOriginEndpointPolicyRequest request)
Retrieves the specified origin endpoint policy that's configured in AWS Elemental MediaPackage.
getOriginEndpointPolicy
in interface AWSMediaPackageV2
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.public ListChannelGroupsResult listChannelGroups(ListChannelGroupsRequest request)
Retrieves all channel groups that are configured in AWS Elemental MediaPackage, including the channels and origin endpoints that are associated with it.
listChannelGroups
in interface AWSMediaPackageV2
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.public ListChannelsResult listChannels(ListChannelsRequest 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.
listChannels
in interface AWSMediaPackageV2
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.public ListOriginEndpointsResult listOriginEndpoints(ListOriginEndpointsRequest request)
Retrieves all origin endpoints in a specific channel that are configured in AWS Elemental MediaPackage.
listOriginEndpoints
in interface AWSMediaPackageV2
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.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Lists the tags assigned to a resource.
listTagsForResource
in interface AWSMediaPackageV2
listTagsForResourceRequest
- ValidationException
- The input failed to meet the constraints specified by the AWS service.public PutChannelPolicyResult putChannelPolicy(PutChannelPolicyRequest 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.
putChannelPolicy
in interface AWSMediaPackageV2
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.public PutOriginEndpointPolicyResult putOriginEndpointPolicy(PutOriginEndpointPolicyRequest request)
Attaches an IAM policy to the specified origin endpoint. You can attach only one policy with each request.
putOriginEndpointPolicy
in interface AWSMediaPackageV2
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.public TagResourceResult tagResource(TagResourceRequest 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.
tagResource
in interface AWSMediaPackageV2
tagResourceRequest
- ValidationException
- The input failed to meet the constraints specified by the AWS service.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes one or more tags from the specified resource.
untagResource
in interface AWSMediaPackageV2
untagResourceRequest
- ValidationException
- The input failed to meet the constraints specified by the AWS service.public UpdateChannelResult updateChannel(UpdateChannelRequest 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.
updateChannel
in interface AWSMediaPackageV2
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.public UpdateChannelGroupResult updateChannelGroup(UpdateChannelGroupRequest 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.
updateChannelGroup
in interface AWSMediaPackageV2
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.public UpdateOriginEndpointResult updateOriginEndpoint(UpdateOriginEndpointRequest 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.
updateOriginEndpoint
in interface AWSMediaPackageV2
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.public 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 the request.
getCachedResponseMetadata
in interface AWSMediaPackageV2
request
- The originally executed requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AWSMediaPackageV2
shutdown
in class AmazonWebServiceClient