@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface MediaPackageV2AsyncClient extends AwsClient
builder()
method.
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 |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static MediaPackageV2AsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
MediaPackageV2AsyncClient. |
static MediaPackageV2AsyncClient |
create()
Create a
MediaPackageV2AsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreateChannelResponse> |
createChannel(Consumer<CreateChannelRequest.Builder> createChannelRequest)
Create a channel to start receiving content streams.
|
default CompletableFuture<CreateChannelResponse> |
createChannel(CreateChannelRequest createChannelRequest)
Create a channel to start receiving content streams.
|
default CompletableFuture<CreateChannelGroupResponse> |
createChannelGroup(Consumer<CreateChannelGroupRequest.Builder> createChannelGroupRequest)
Create a channel group to group your channels and origin endpoints.
|
default CompletableFuture<CreateChannelGroupResponse> |
createChannelGroup(CreateChannelGroupRequest createChannelGroupRequest)
Create a channel group to group your channels and origin endpoints.
|
default CompletableFuture<CreateOriginEndpointResponse> |
createOriginEndpoint(Consumer<CreateOriginEndpointRequest.Builder> createOriginEndpointRequest)
The endpoint is attached to a channel, and represents the output of the live content.
|
default CompletableFuture<CreateOriginEndpointResponse> |
createOriginEndpoint(CreateOriginEndpointRequest createOriginEndpointRequest)
The endpoint is attached to a channel, and represents the output of the live content.
|
default CompletableFuture<DeleteChannelResponse> |
deleteChannel(Consumer<DeleteChannelRequest.Builder> deleteChannelRequest)
Delete a channel to stop AWS Elemental MediaPackage from receiving further content.
|
default CompletableFuture<DeleteChannelResponse> |
deleteChannel(DeleteChannelRequest deleteChannelRequest)
Delete a channel to stop AWS Elemental MediaPackage from receiving further content.
|
default CompletableFuture<DeleteChannelGroupResponse> |
deleteChannelGroup(Consumer<DeleteChannelGroupRequest.Builder> deleteChannelGroupRequest)
Delete a channel group.
|
default CompletableFuture<DeleteChannelGroupResponse> |
deleteChannelGroup(DeleteChannelGroupRequest deleteChannelGroupRequest)
Delete a channel group.
|
default CompletableFuture<DeleteChannelPolicyResponse> |
deleteChannelPolicy(Consumer<DeleteChannelPolicyRequest.Builder> deleteChannelPolicyRequest)
Delete a channel policy.
|
default CompletableFuture<DeleteChannelPolicyResponse> |
deleteChannelPolicy(DeleteChannelPolicyRequest deleteChannelPolicyRequest)
Delete a channel policy.
|
default CompletableFuture<DeleteOriginEndpointResponse> |
deleteOriginEndpoint(Consumer<DeleteOriginEndpointRequest.Builder> deleteOriginEndpointRequest)
Origin endpoints can serve content until they're deleted.
|
default CompletableFuture<DeleteOriginEndpointResponse> |
deleteOriginEndpoint(DeleteOriginEndpointRequest deleteOriginEndpointRequest)
Origin endpoints can serve content until they're deleted.
|
default CompletableFuture<DeleteOriginEndpointPolicyResponse> |
deleteOriginEndpointPolicy(Consumer<DeleteOriginEndpointPolicyRequest.Builder> deleteOriginEndpointPolicyRequest)
Delete an origin endpoint policy.
|
default CompletableFuture<DeleteOriginEndpointPolicyResponse> |
deleteOriginEndpointPolicy(DeleteOriginEndpointPolicyRequest deleteOriginEndpointPolicyRequest)
Delete an origin endpoint policy.
|
default CompletableFuture<GetChannelResponse> |
getChannel(Consumer<GetChannelRequest.Builder> getChannelRequest)
Retrieves the specified channel that's configured in AWS Elemental MediaPackage, including the origin endpoints
that are associated with it.
|
default CompletableFuture<GetChannelResponse> |
getChannel(GetChannelRequest getChannelRequest)
Retrieves the specified channel that's configured in AWS Elemental MediaPackage, including the origin endpoints
that are associated with it.
|
default CompletableFuture<GetChannelGroupResponse> |
getChannelGroup(Consumer<GetChannelGroupRequest.Builder> getChannelGroupRequest)
Retrieves the specified channel group that's configured in AWS Elemental MediaPackage, including the channels and
origin endpoints that are associated with it.
|
default CompletableFuture<GetChannelGroupResponse> |
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.
|
default CompletableFuture<GetChannelPolicyResponse> |
getChannelPolicy(Consumer<GetChannelPolicyRequest.Builder> getChannelPolicyRequest)
Retrieves the specified channel policy that's configured in AWS Elemental MediaPackage.
|
default CompletableFuture<GetChannelPolicyResponse> |
getChannelPolicy(GetChannelPolicyRequest getChannelPolicyRequest)
Retrieves the specified channel policy that's configured in AWS Elemental MediaPackage.
|
default CompletableFuture<GetOriginEndpointResponse> |
getOriginEndpoint(Consumer<GetOriginEndpointRequest.Builder> 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.
|
default CompletableFuture<GetOriginEndpointResponse> |
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.
|
default CompletableFuture<GetOriginEndpointPolicyResponse> |
getOriginEndpointPolicy(Consumer<GetOriginEndpointPolicyRequest.Builder> getOriginEndpointPolicyRequest)
Retrieves the specified origin endpoint policy that's configured in AWS Elemental MediaPackage.
|
default CompletableFuture<GetOriginEndpointPolicyResponse> |
getOriginEndpointPolicy(GetOriginEndpointPolicyRequest getOriginEndpointPolicyRequest)
Retrieves the specified origin endpoint policy that's configured in AWS Elemental MediaPackage.
|
default CompletableFuture<ListChannelGroupsResponse> |
listChannelGroups(Consumer<ListChannelGroupsRequest.Builder> listChannelGroupsRequest)
Retrieves all channel groups that are configured in AWS Elemental MediaPackage, including the channels and origin
endpoints that are associated with it.
|
default CompletableFuture<ListChannelGroupsResponse> |
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.
|
default ListChannelGroupsPublisher |
listChannelGroupsPaginator(Consumer<ListChannelGroupsRequest.Builder> listChannelGroupsRequest)
Retrieves all channel groups that are configured in AWS Elemental MediaPackage, including the channels and origin
endpoints that are associated with it.
|
default ListChannelGroupsPublisher |
listChannelGroupsPaginator(ListChannelGroupsRequest listChannelGroupsRequest)
Retrieves all channel groups that are configured in AWS Elemental MediaPackage, including the channels and origin
endpoints that are associated with it.
|
default CompletableFuture<ListChannelsResponse> |
listChannels(Consumer<ListChannelsRequest.Builder> 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.
|
default CompletableFuture<ListChannelsResponse> |
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.
|
default ListChannelsPublisher |
listChannelsPaginator(Consumer<ListChannelsRequest.Builder> 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.
|
default ListChannelsPublisher |
listChannelsPaginator(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.
|
default CompletableFuture<ListOriginEndpointsResponse> |
listOriginEndpoints(Consumer<ListOriginEndpointsRequest.Builder> listOriginEndpointsRequest)
Retrieves all origin endpoints in a specific channel that are configured in AWS Elemental MediaPackage.
|
default CompletableFuture<ListOriginEndpointsResponse> |
listOriginEndpoints(ListOriginEndpointsRequest listOriginEndpointsRequest)
Retrieves all origin endpoints in a specific channel that are configured in AWS Elemental MediaPackage.
|
default ListOriginEndpointsPublisher |
listOriginEndpointsPaginator(Consumer<ListOriginEndpointsRequest.Builder> listOriginEndpointsRequest)
Retrieves all origin endpoints in a specific channel that are configured in AWS Elemental MediaPackage.
|
default ListOriginEndpointsPublisher |
listOriginEndpointsPaginator(ListOriginEndpointsRequest listOriginEndpointsRequest)
Retrieves all origin endpoints in a specific channel that are configured in AWS Elemental MediaPackage.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists the tags assigned to a resource.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags assigned to a resource.
|
default CompletableFuture<PutChannelPolicyResponse> |
putChannelPolicy(Consumer<PutChannelPolicyRequest.Builder> putChannelPolicyRequest)
Attaches an IAM policy to the specified channel.
|
default CompletableFuture<PutChannelPolicyResponse> |
putChannelPolicy(PutChannelPolicyRequest putChannelPolicyRequest)
Attaches an IAM policy to the specified channel.
|
default CompletableFuture<PutOriginEndpointPolicyResponse> |
putOriginEndpointPolicy(Consumer<PutOriginEndpointPolicyRequest.Builder> putOriginEndpointPolicyRequest)
Attaches an IAM policy to the specified origin endpoint.
|
default CompletableFuture<PutOriginEndpointPolicyResponse> |
putOriginEndpointPolicy(PutOriginEndpointPolicyRequest putOriginEndpointPolicyRequest)
Attaches an IAM policy to the specified origin endpoint.
|
default MediaPackageV2ServiceClientConfiguration |
serviceClientConfiguration() |
default CompletableFuture<TagResourceResponse> |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Assigns one of more tags (key-value pairs) to the specified MediaPackage resource.
|
default CompletableFuture<TagResourceResponse> |
tagResource(TagResourceRequest tagResourceRequest)
Assigns one of more tags (key-value pairs) to the specified MediaPackage resource.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes one or more tags from the specified resource.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(UntagResourceRequest untagResourceRequest)
Removes one or more tags from the specified resource.
|
default CompletableFuture<UpdateChannelResponse> |
updateChannel(Consumer<UpdateChannelRequest.Builder> updateChannelRequest)
Update the specified channel.
|
default CompletableFuture<UpdateChannelResponse> |
updateChannel(UpdateChannelRequest updateChannelRequest)
Update the specified channel.
|
default CompletableFuture<UpdateChannelGroupResponse> |
updateChannelGroup(Consumer<UpdateChannelGroupRequest.Builder> updateChannelGroupRequest)
Update the specified channel group.
|
default CompletableFuture<UpdateChannelGroupResponse> |
updateChannelGroup(UpdateChannelGroupRequest updateChannelGroupRequest)
Update the specified channel group.
|
default CompletableFuture<UpdateOriginEndpointResponse> |
updateOriginEndpoint(Consumer<UpdateOriginEndpointRequest.Builder> updateOriginEndpointRequest)
Update the specified origin endpoint.
|
default CompletableFuture<UpdateOriginEndpointResponse> |
updateOriginEndpoint(UpdateOriginEndpointRequest updateOriginEndpointRequest)
Update the specified origin endpoint.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default CompletableFuture<CreateChannelResponse> 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 - default CompletableFuture<CreateChannelResponse> createChannel(Consumer<CreateChannelRequest.Builder> 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.
This is a convenience which creates an instance of the CreateChannelRequest.Builder avoiding the need to
create one manually via CreateChannelRequest.builder()
createChannelRequest - A Consumer that will call methods on
CreateChannelRequest.Builder to create a
request.default CompletableFuture<CreateChannelGroupResponse> 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 - default CompletableFuture<CreateChannelGroupResponse> createChannelGroup(Consumer<CreateChannelGroupRequest.Builder> 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.
This is a convenience which creates an instance of the CreateChannelGroupRequest.Builder avoiding the
need to create one manually via CreateChannelGroupRequest.builder()
createChannelGroupRequest - A Consumer that will call methods on
CreateChannelGroupRequest.Builder to create a
request.default CompletableFuture<CreateOriginEndpointResponse> 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 - default CompletableFuture<CreateOriginEndpointResponse> createOriginEndpoint(Consumer<CreateOriginEndpointRequest.Builder> 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.
This is a convenience which creates an instance of the CreateOriginEndpointRequest.Builder avoiding the
need to create one manually via CreateOriginEndpointRequest.builder()
createOriginEndpointRequest - A Consumer that will call methods on
CreateOriginEndpointRequest.Builder to create
a request.default CompletableFuture<DeleteChannelResponse> 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 - default CompletableFuture<DeleteChannelResponse> deleteChannel(Consumer<DeleteChannelRequest.Builder> 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.
This is a convenience which creates an instance of the DeleteChannelRequest.Builder avoiding the need to
create one manually via DeleteChannelRequest.builder()
deleteChannelRequest - A Consumer that will call methods on
DeleteChannelRequest.Builder to create a
request.default CompletableFuture<DeleteChannelGroupResponse> 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 - default CompletableFuture<DeleteChannelGroupResponse> deleteChannelGroup(Consumer<DeleteChannelGroupRequest.Builder> 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.
This is a convenience which creates an instance of the DeleteChannelGroupRequest.Builder avoiding the
need to create one manually via DeleteChannelGroupRequest.builder()
deleteChannelGroupRequest - A Consumer that will call methods on
DeleteChannelGroupRequest.Builder to create a
request.default CompletableFuture<DeleteChannelPolicyResponse> deleteChannelPolicy(DeleteChannelPolicyRequest deleteChannelPolicyRequest)
Delete a channel policy.
deleteChannelPolicyRequest - default CompletableFuture<DeleteChannelPolicyResponse> deleteChannelPolicy(Consumer<DeleteChannelPolicyRequest.Builder> deleteChannelPolicyRequest)
Delete a channel policy.
This is a convenience which creates an instance of the DeleteChannelPolicyRequest.Builder avoiding the
need to create one manually via DeleteChannelPolicyRequest.builder()
deleteChannelPolicyRequest - A Consumer that will call methods on
DeleteChannelPolicyRequest.Builder to create
a request.default CompletableFuture<DeleteOriginEndpointResponse> 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 - default CompletableFuture<DeleteOriginEndpointResponse> deleteOriginEndpoint(Consumer<DeleteOriginEndpointRequest.Builder> 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.
This is a convenience which creates an instance of the DeleteOriginEndpointRequest.Builder avoiding the
need to create one manually via DeleteOriginEndpointRequest.builder()
deleteOriginEndpointRequest - A Consumer that will call methods on
DeleteOriginEndpointRequest.Builder to create
a request.default CompletableFuture<DeleteOriginEndpointPolicyResponse> deleteOriginEndpointPolicy(DeleteOriginEndpointPolicyRequest deleteOriginEndpointPolicyRequest)
Delete an origin endpoint policy.
deleteOriginEndpointPolicyRequest - default CompletableFuture<DeleteOriginEndpointPolicyResponse> deleteOriginEndpointPolicy(Consumer<DeleteOriginEndpointPolicyRequest.Builder> deleteOriginEndpointPolicyRequest)
Delete an origin endpoint policy.
This is a convenience which creates an instance of the DeleteOriginEndpointPolicyRequest.Builder avoiding
the need to create one manually via DeleteOriginEndpointPolicyRequest.builder()
deleteOriginEndpointPolicyRequest - A Consumer that will call methods on
DeleteOriginEndpointPolicyRequest.Builder to
create a request.default CompletableFuture<GetChannelResponse> getChannel(GetChannelRequest getChannelRequest)
Retrieves the specified channel that's configured in AWS Elemental MediaPackage, including the origin endpoints that are associated with it.
getChannelRequest - default CompletableFuture<GetChannelResponse> getChannel(Consumer<GetChannelRequest.Builder> getChannelRequest)
Retrieves the specified channel that's configured in AWS Elemental MediaPackage, including the origin endpoints that are associated with it.
This is a convenience which creates an instance of the GetChannelRequest.Builder avoiding the need to
create one manually via GetChannelRequest.builder()
getChannelRequest - A Consumer that will call methods on
GetChannelRequest.Builder to create a
request.default CompletableFuture<GetChannelGroupResponse> 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 - default CompletableFuture<GetChannelGroupResponse> getChannelGroup(Consumer<GetChannelGroupRequest.Builder> getChannelGroupRequest)
Retrieves the specified channel group that's configured in AWS Elemental MediaPackage, including the channels and origin endpoints that are associated with it.
This is a convenience which creates an instance of the GetChannelGroupRequest.Builder avoiding the need
to create one manually via GetChannelGroupRequest.builder()
getChannelGroupRequest - A Consumer that will call methods on
GetChannelGroupRequest.Builder to create a
request.default CompletableFuture<GetChannelPolicyResponse> 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 - default CompletableFuture<GetChannelPolicyResponse> getChannelPolicy(Consumer<GetChannelPolicyRequest.Builder> 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.
This is a convenience which creates an instance of the GetChannelPolicyRequest.Builder avoiding the need
to create one manually via GetChannelPolicyRequest.builder()
getChannelPolicyRequest - A Consumer that will call methods on
GetChannelPolicyRequest.Builder to create a
request.default CompletableFuture<GetOriginEndpointResponse> 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 - default CompletableFuture<GetOriginEndpointResponse> getOriginEndpoint(Consumer<GetOriginEndpointRequest.Builder> 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.
This is a convenience which creates an instance of the GetOriginEndpointRequest.Builder avoiding the need
to create one manually via GetOriginEndpointRequest.builder()
getOriginEndpointRequest - A Consumer that will call methods on
GetOriginEndpointRequest.Builder to create a
request.default CompletableFuture<GetOriginEndpointPolicyResponse> getOriginEndpointPolicy(GetOriginEndpointPolicyRequest getOriginEndpointPolicyRequest)
Retrieves the specified origin endpoint policy that's configured in AWS Elemental MediaPackage.
getOriginEndpointPolicyRequest - default CompletableFuture<GetOriginEndpointPolicyResponse> getOriginEndpointPolicy(Consumer<GetOriginEndpointPolicyRequest.Builder> getOriginEndpointPolicyRequest)
Retrieves the specified origin endpoint policy that's configured in AWS Elemental MediaPackage.
This is a convenience which creates an instance of the GetOriginEndpointPolicyRequest.Builder avoiding
the need to create one manually via GetOriginEndpointPolicyRequest.builder()
getOriginEndpointPolicyRequest - A Consumer that will call methods on
GetOriginEndpointPolicyRequest.Builder to
create a request.default CompletableFuture<ListChannelGroupsResponse> 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 - default CompletableFuture<ListChannelGroupsResponse> listChannelGroups(Consumer<ListChannelGroupsRequest.Builder> listChannelGroupsRequest)
Retrieves all channel groups that are configured in AWS Elemental MediaPackage, including the channels and origin endpoints that are associated with it.
This is a convenience which creates an instance of the ListChannelGroupsRequest.Builder avoiding the need
to create one manually via ListChannelGroupsRequest.builder()
listChannelGroupsRequest - A Consumer that will call methods on
ListChannelGroupsRequest.Builder to create a
request.default ListChannelGroupsPublisher listChannelGroupsPaginator(ListChannelGroupsRequest listChannelGroupsRequest)
Retrieves all channel groups that are configured in AWS Elemental MediaPackage, including the channels and origin endpoints that are associated with it.
This is a variant of
listChannelGroups(software.amazon.awssdk.services.mediapackagev2.model.ListChannelGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.mediapackagev2.paginators.ListChannelGroupsPublisher publisher = client.listChannelGroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.mediapackagev2.paginators.ListChannelGroupsPublisher publisher = client.listChannelGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mediapackagev2.model.ListChannelGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.mediapackagev2.model.ListChannelGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChannelGroups(software.amazon.awssdk.services.mediapackagev2.model.ListChannelGroupsRequest)
operation.
listChannelGroupsRequest - default ListChannelGroupsPublisher listChannelGroupsPaginator(Consumer<ListChannelGroupsRequest.Builder> listChannelGroupsRequest)
Retrieves all channel groups that are configured in AWS Elemental MediaPackage, including the channels and origin endpoints that are associated with it.
This is a variant of
listChannelGroups(software.amazon.awssdk.services.mediapackagev2.model.ListChannelGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.mediapackagev2.paginators.ListChannelGroupsPublisher publisher = client.listChannelGroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.mediapackagev2.paginators.ListChannelGroupsPublisher publisher = client.listChannelGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mediapackagev2.model.ListChannelGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.mediapackagev2.model.ListChannelGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChannelGroups(software.amazon.awssdk.services.mediapackagev2.model.ListChannelGroupsRequest)
operation.
This is a convenience which creates an instance of the ListChannelGroupsRequest.Builder avoiding the need
to create one manually via ListChannelGroupsRequest.builder()
listChannelGroupsRequest - A Consumer that will call methods on
ListChannelGroupsRequest.Builder to create a
request.default CompletableFuture<ListChannelsResponse> 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 - default CompletableFuture<ListChannelsResponse> listChannels(Consumer<ListChannelsRequest.Builder> 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.
This is a convenience which creates an instance of the ListChannelsRequest.Builder avoiding the need to
create one manually via ListChannelsRequest.builder()
listChannelsRequest - A Consumer that will call methods on
ListChannelsRequest.Builder to create a
request.default ListChannelsPublisher listChannelsPaginator(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.
This is a variant of
listChannels(software.amazon.awssdk.services.mediapackagev2.model.ListChannelsRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.mediapackagev2.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.mediapackagev2.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mediapackagev2.model.ListChannelsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.mediapackagev2.model.ListChannelsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChannels(software.amazon.awssdk.services.mediapackagev2.model.ListChannelsRequest) operation.
listChannelsRequest - default ListChannelsPublisher listChannelsPaginator(Consumer<ListChannelsRequest.Builder> 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.
This is a variant of
listChannels(software.amazon.awssdk.services.mediapackagev2.model.ListChannelsRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.mediapackagev2.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.mediapackagev2.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mediapackagev2.model.ListChannelsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.mediapackagev2.model.ListChannelsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChannels(software.amazon.awssdk.services.mediapackagev2.model.ListChannelsRequest) operation.
This is a convenience which creates an instance of the ListChannelsRequest.Builder avoiding the need to
create one manually via ListChannelsRequest.builder()
listChannelsRequest - A Consumer that will call methods on
ListChannelsRequest.Builder to create a
request.default CompletableFuture<ListOriginEndpointsResponse> listOriginEndpoints(ListOriginEndpointsRequest listOriginEndpointsRequest)
Retrieves all origin endpoints in a specific channel that are configured in AWS Elemental MediaPackage.
listOriginEndpointsRequest - default CompletableFuture<ListOriginEndpointsResponse> listOriginEndpoints(Consumer<ListOriginEndpointsRequest.Builder> listOriginEndpointsRequest)
Retrieves all origin endpoints in a specific channel that are configured in AWS Elemental MediaPackage.
This is a convenience which creates an instance of the ListOriginEndpointsRequest.Builder avoiding the
need to create one manually via ListOriginEndpointsRequest.builder()
listOriginEndpointsRequest - A Consumer that will call methods on
ListOriginEndpointsRequest.Builder to create
a request.default ListOriginEndpointsPublisher listOriginEndpointsPaginator(ListOriginEndpointsRequest listOriginEndpointsRequest)
Retrieves all origin endpoints in a specific channel that are configured in AWS Elemental MediaPackage.
This is a variant of
listOriginEndpoints(software.amazon.awssdk.services.mediapackagev2.model.ListOriginEndpointsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.mediapackagev2.paginators.ListOriginEndpointsPublisher publisher = client.listOriginEndpointsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.mediapackagev2.paginators.ListOriginEndpointsPublisher publisher = client.listOriginEndpointsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mediapackagev2.model.ListOriginEndpointsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.mediapackagev2.model.ListOriginEndpointsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listOriginEndpoints(software.amazon.awssdk.services.mediapackagev2.model.ListOriginEndpointsRequest)
operation.
listOriginEndpointsRequest - default ListOriginEndpointsPublisher listOriginEndpointsPaginator(Consumer<ListOriginEndpointsRequest.Builder> listOriginEndpointsRequest)
Retrieves all origin endpoints in a specific channel that are configured in AWS Elemental MediaPackage.
This is a variant of
listOriginEndpoints(software.amazon.awssdk.services.mediapackagev2.model.ListOriginEndpointsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.mediapackagev2.paginators.ListOriginEndpointsPublisher publisher = client.listOriginEndpointsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.mediapackagev2.paginators.ListOriginEndpointsPublisher publisher = client.listOriginEndpointsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mediapackagev2.model.ListOriginEndpointsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.mediapackagev2.model.ListOriginEndpointsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listOriginEndpoints(software.amazon.awssdk.services.mediapackagev2.model.ListOriginEndpointsRequest)
operation.
This is a convenience which creates an instance of the ListOriginEndpointsRequest.Builder avoiding the
need to create one manually via ListOriginEndpointsRequest.builder()
listOriginEndpointsRequest - A Consumer that will call methods on
ListOriginEndpointsRequest.Builder to create
a request.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags assigned to a resource.
listTagsForResourceRequest - default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists the tags assigned to a resource.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on
ListTagsForResourceRequest.Builder to create
a request.default CompletableFuture<PutChannelPolicyResponse> 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 - default CompletableFuture<PutChannelPolicyResponse> putChannelPolicy(Consumer<PutChannelPolicyRequest.Builder> 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.
This is a convenience which creates an instance of the PutChannelPolicyRequest.Builder avoiding the need
to create one manually via PutChannelPolicyRequest.builder()
putChannelPolicyRequest - A Consumer that will call methods on
PutChannelPolicyRequest.Builder to create a
request.default CompletableFuture<PutOriginEndpointPolicyResponse> putOriginEndpointPolicy(PutOriginEndpointPolicyRequest putOriginEndpointPolicyRequest)
Attaches an IAM policy to the specified origin endpoint. You can attach only one policy with each request.
putOriginEndpointPolicyRequest - default CompletableFuture<PutOriginEndpointPolicyResponse> putOriginEndpointPolicy(Consumer<PutOriginEndpointPolicyRequest.Builder> putOriginEndpointPolicyRequest)
Attaches an IAM policy to the specified origin endpoint. You can attach only one policy with each request.
This is a convenience which creates an instance of the PutOriginEndpointPolicyRequest.Builder avoiding
the need to create one manually via PutOriginEndpointPolicyRequest.builder()
putOriginEndpointPolicyRequest - A Consumer that will call methods on
PutOriginEndpointPolicyRequest.Builder to
create a request.default CompletableFuture<TagResourceResponse> 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 - default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> 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.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on
TagResourceRequest.Builder to create a
request.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes one or more tags from the specified resource.
untagResourceRequest - default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes one or more tags from the specified resource.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on
UntagResourceRequest.Builder to create a
request.default CompletableFuture<UpdateChannelResponse> 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 - default CompletableFuture<UpdateChannelResponse> updateChannel(Consumer<UpdateChannelRequest.Builder> 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.
This is a convenience which creates an instance of the UpdateChannelRequest.Builder avoiding the need to
create one manually via UpdateChannelRequest.builder()
updateChannelRequest - A Consumer that will call methods on
UpdateChannelRequest.Builder to create a
request.default CompletableFuture<UpdateChannelGroupResponse> 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 - default CompletableFuture<UpdateChannelGroupResponse> updateChannelGroup(Consumer<UpdateChannelGroupRequest.Builder> 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.
This is a convenience which creates an instance of the UpdateChannelGroupRequest.Builder avoiding the
need to create one manually via UpdateChannelGroupRequest.builder()
updateChannelGroupRequest - A Consumer that will call methods on
UpdateChannelGroupRequest.Builder to create a
request.default CompletableFuture<UpdateOriginEndpointResponse> 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 - default CompletableFuture<UpdateOriginEndpointResponse> updateOriginEndpoint(Consumer<UpdateOriginEndpointRequest.Builder> 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.
This is a convenience which creates an instance of the UpdateOriginEndpointRequest.Builder avoiding the
need to create one manually via UpdateOriginEndpointRequest.builder()
updateOriginEndpointRequest - A Consumer that will call methods on
UpdateOriginEndpointRequest.Builder to create
a request.default MediaPackageV2ServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientstatic MediaPackageV2AsyncClient create()
MediaPackageV2AsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static MediaPackageV2AsyncClientBuilder builder()
MediaPackageV2AsyncClient.Copyright © 2023. All rights reserved.