AWS SDK for C++AWS SDK for C++ Version 1.11.643 |
#include <Mediapackagev2Client.h>
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.
Definition at line 39 of file Mediapackagev2Client.h.
Definition at line 42 of file Mediapackagev2Client.h.
Definition at line 46 of file Mediapackagev2Client.h.
Definition at line 47 of file Mediapackagev2Client.h.
Aws::mediapackagev2::Mediapackagev2ClientConfiguration()
,
nullptr
Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
nullptr
,
Aws::mediapackagev2::Mediapackagev2ClientConfiguration()
Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
nullptr
,
Aws::mediapackagev2::Mediapackagev2ClientConfiguration()
Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used
Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used
nullptr
An Async wrapper for CancelHarvestJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 117 of file Mediapackagev2Client.h.
A Callable wrapper for CancelHarvestJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 108 of file Mediapackagev2Client.h.
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.
nullptr
An Async wrapper for CreateChannel that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 149 of file Mediapackagev2Client.h.
A Callable wrapper for CreateChannel that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 140 of file Mediapackagev2Client.h.
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.
nullptr
An Async wrapper for CreateChannelGroup that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 179 of file Mediapackagev2Client.h.
A Callable wrapper for CreateChannelGroup that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 170 of file Mediapackagev2Client.h.
Creates a new harvest job to export content from a MediaPackage v2 channel to an S3 bucket.
nullptr
An Async wrapper for CreateHarvestJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 205 of file Mediapackagev2Client.h.
A Callable wrapper for CreateHarvestJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 196 of file Mediapackagev2Client.h.
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.
nullptr
An Async wrapper for CreateOriginEndpoint that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 235 of file Mediapackagev2Client.h.
A Callable wrapper for CreateOriginEndpoint that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 226 of file Mediapackagev2Client.h.
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.
nullptr
An Async wrapper for DeleteChannel that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 262 of file Mediapackagev2Client.h.
A Callable wrapper for DeleteChannel that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 253 of file Mediapackagev2Client.h.
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.
nullptr
An Async wrapper for DeleteChannelGroup that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 290 of file Mediapackagev2Client.h.
A Callable wrapper for DeleteChannelGroup that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 281 of file Mediapackagev2Client.h.
nullptr
An Async wrapper for DeleteChannelPolicy that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 315 of file Mediapackagev2Client.h.
A Callable wrapper for DeleteChannelPolicy that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 306 of file Mediapackagev2Client.h.
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.
nullptr
An Async wrapper for DeleteOriginEndpoint that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 343 of file Mediapackagev2Client.h.
A Callable wrapper for DeleteOriginEndpoint that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 334 of file Mediapackagev2Client.h.
nullptr
An Async wrapper for DeleteOriginEndpointPolicy that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 368 of file Mediapackagev2Client.h.
A Callable wrapper for DeleteOriginEndpointPolicy that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 359 of file Mediapackagev2Client.h.
Retrieves the specified channel that's configured in AWS Elemental MediaPackage.
nullptr
An Async wrapper for GetChannel that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 394 of file Mediapackagev2Client.h.
A Callable wrapper for GetChannel that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 385 of file Mediapackagev2Client.h.
Retrieves the specified channel group that's configured in AWS Elemental MediaPackage.
nullptr
An Async wrapper for GetChannelGroup that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 420 of file Mediapackagev2Client.h.
A Callable wrapper for GetChannelGroup that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 411 of file Mediapackagev2Client.h.
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.
nullptr
An Async wrapper for GetChannelPolicy that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 447 of file Mediapackagev2Client.h.
A Callable wrapper for GetChannelPolicy that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 438 of file Mediapackagev2Client.h.
nullptr
An Async wrapper for GetHarvestJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 473 of file Mediapackagev2Client.h.
A Callable wrapper for GetHarvestJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 464 of file Mediapackagev2Client.h.
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.
nullptr
An Async wrapper for GetOriginEndpoint that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 500 of file Mediapackagev2Client.h.
A Callable wrapper for GetOriginEndpoint that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 491 of file Mediapackagev2Client.h.
Retrieves the specified origin endpoint policy that's configured in AWS Elemental MediaPackage.
nullptr
An Async wrapper for GetOriginEndpointPolicy that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 526 of file Mediapackagev2Client.h.
A Callable wrapper for GetOriginEndpointPolicy that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 517 of file Mediapackagev2Client.h.
{}
)
const
Retrieves all channel groups that are configured in Elemental MediaPackage.
nullptr
,
{}
An Async wrapper for ListChannelGroups that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 552 of file Mediapackagev2Client.h.
{}
)
const
A Callable wrapper for ListChannelGroups that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 543 of file Mediapackagev2Client.h.
Retrieves all channels in a specific channel group that are configured in AWS Elemental MediaPackage.
nullptr
An Async wrapper for ListChannels that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 578 of file Mediapackagev2Client.h.
A Callable wrapper for ListChannels that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 569 of file Mediapackagev2Client.h.
nullptr
An Async wrapper for ListHarvestJobs that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 604 of file Mediapackagev2Client.h.
A Callable wrapper for ListHarvestJobs that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 595 of file Mediapackagev2Client.h.
Retrieves all origin endpoints in a specific channel that are configured in AWS Elemental MediaPackage.
nullptr
An Async wrapper for ListOriginEndpoints that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 630 of file Mediapackagev2Client.h.
A Callable wrapper for ListOriginEndpoints that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 621 of file Mediapackagev2Client.h.
nullptr
An Async wrapper for ListTagsForResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 655 of file Mediapackagev2Client.h.
A Callable wrapper for ListTagsForResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 646 of file Mediapackagev2Client.h.
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.
nullptr
An Async wrapper for PutChannelPolicy that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 683 of file Mediapackagev2Client.h.
A Callable wrapper for PutChannelPolicy that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 674 of file Mediapackagev2Client.h.
Attaches an IAM policy to the specified origin endpoint. You can attach only one policy with each request.
nullptr
An Async wrapper for PutOriginEndpointPolicy that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 709 of file Mediapackagev2Client.h.
A Callable wrapper for PutOriginEndpointPolicy that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 700 of file Mediapackagev2Client.h.
Resetting the channel can help to clear errors from misconfigurations in the encoder. A reset refreshes the ingest stream and removes previous content.
Be sure to stop the encoder before you reset the channel, and wait at least 30 seconds before you restart the encoder.
nullptr
An Async wrapper for ResetChannelState that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 737 of file Mediapackagev2Client.h.
A Callable wrapper for ResetChannelState that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 728 of file Mediapackagev2Client.h.
Resetting the origin endpoint can help to resolve unexpected behavior and other content packaging issues. It also helps to preserve special events when you don't want the previous content to be available for viewing. A reset clears out all previous content from the origin endpoint.
MediaPackage might return old content from this endpoint in the first 30 seconds after the endpoint reset. For best results, when possible, wait 30 seconds from endpoint reset to send playback requests to this endpoint.
nullptr
An Async wrapper for ResetOriginEndpointState that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 768 of file Mediapackagev2Client.h.
A Callable wrapper for ResetOriginEndpointState that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 759 of file Mediapackagev2Client.h.
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.
nullptr
An Async wrapper for TagResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 801 of file Mediapackagev2Client.h.
A Callable wrapper for TagResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 792 of file Mediapackagev2Client.h.
nullptr
An Async wrapper for UntagResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 827 of file Mediapackagev2Client.h.
A Callable wrapper for UntagResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 818 of file Mediapackagev2Client.h.
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.
nullptr
An Async wrapper for UpdateChannel that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 857 of file Mediapackagev2Client.h.
A Callable wrapper for UpdateChannel that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 848 of file Mediapackagev2Client.h.
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.
nullptr
An Async wrapper for UpdateChannelGroup that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 886 of file Mediapackagev2Client.h.
A Callable wrapper for UpdateChannelGroup that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 877 of file Mediapackagev2Client.h.
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.
nullptr
An Async wrapper for UpdateOriginEndpoint that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 914 of file Mediapackagev2Client.h.
A Callable wrapper for UpdateOriginEndpoint that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 905 of file Mediapackagev2Client.h.
Definition at line 921 of file Mediapackagev2Client.h.