Interface MediaPackageV2AsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in
some cases such as credentials retrieval and endpoint discovery as part of the async API call.
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.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Create a builder that can be used to configure and create aMediaPackageV2AsyncClient
.cancelHarvestJob
(Consumer<CancelHarvestJobRequest.Builder> cancelHarvestJobRequest) Cancels an in-progress harvest job.cancelHarvestJob
(CancelHarvestJobRequest cancelHarvestJobRequest) Cancels an in-progress harvest job.static MediaPackageV2AsyncClient
create()
Create aMediaPackageV2AsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.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.createChannelGroup
(Consumer<CreateChannelGroupRequest.Builder> createChannelGroupRequest) Create a channel group to group your channels and origin endpoints.createChannelGroup
(CreateChannelGroupRequest createChannelGroupRequest) Create a channel group to group your channels and origin endpoints.createHarvestJob
(Consumer<CreateHarvestJobRequest.Builder> createHarvestJobRequest) Creates a new harvest job to export content from a MediaPackage v2 channel to an S3 bucket.createHarvestJob
(CreateHarvestJobRequest createHarvestJobRequest) Creates a new harvest job to export content from a MediaPackage v2 channel to an S3 bucket.createOriginEndpoint
(Consumer<CreateOriginEndpointRequest.Builder> createOriginEndpointRequest) The endpoint is attached to a channel, and represents the output of the live content.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.deleteChannelGroup
(Consumer<DeleteChannelGroupRequest.Builder> deleteChannelGroupRequest) Delete a channel group.deleteChannelGroup
(DeleteChannelGroupRequest deleteChannelGroupRequest) Delete a channel group.deleteChannelPolicy
(Consumer<DeleteChannelPolicyRequest.Builder> deleteChannelPolicyRequest) Delete a channel policy.deleteChannelPolicy
(DeleteChannelPolicyRequest deleteChannelPolicyRequest) Delete a channel policy.deleteOriginEndpoint
(Consumer<DeleteOriginEndpointRequest.Builder> deleteOriginEndpointRequest) Origin endpoints can serve content until they're deleted.deleteOriginEndpoint
(DeleteOriginEndpointRequest deleteOriginEndpointRequest) Origin endpoints can serve content until they're deleted.deleteOriginEndpointPolicy
(Consumer<DeleteOriginEndpointPolicyRequest.Builder> deleteOriginEndpointPolicyRequest) Delete an origin endpoint policy.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.getChannelPolicy
(Consumer<GetChannelPolicyRequest.Builder> getChannelPolicyRequest) Retrieves the specified channel policy that's configured in AWS Elemental MediaPackage.getChannelPolicy
(GetChannelPolicyRequest getChannelPolicyRequest) Retrieves the specified channel policy that's configured in AWS Elemental MediaPackage.default CompletableFuture
<GetHarvestJobResponse> getHarvestJob
(Consumer<GetHarvestJobRequest.Builder> getHarvestJobRequest) Retrieves the details of a specific harvest job.default CompletableFuture
<GetHarvestJobResponse> getHarvestJob
(GetHarvestJobRequest getHarvestJobRequest) Retrieves the details of a specific harvest job.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.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.getOriginEndpointPolicy
(Consumer<GetOriginEndpointPolicyRequest.Builder> getOriginEndpointPolicyRequest) Retrieves the specified origin endpoint policy that's configured in AWS Elemental MediaPackage.getOriginEndpointPolicy
(GetOriginEndpointPolicyRequest getOriginEndpointPolicyRequest) Retrieves the specified origin endpoint policy that's configured in AWS Elemental MediaPackage.listChannelGroups
(Consumer<ListChannelGroupsRequest.Builder> listChannelGroupsRequest) Retrieves all channel groups that are configured in Elemental MediaPackage.listChannelGroups
(ListChannelGroupsRequest listChannelGroupsRequest) Retrieves all channel groups that are configured in Elemental MediaPackage.default ListChannelGroupsPublisher
listChannelGroupsPaginator
(Consumer<ListChannelGroupsRequest.Builder> listChannelGroupsRequest) This is a variant oflistChannelGroups(software.amazon.awssdk.services.mediapackagev2.model.ListChannelGroupsRequest)
operation.default ListChannelGroupsPublisher
listChannelGroupsPaginator
(ListChannelGroupsRequest listChannelGroupsRequest) This is a variant oflistChannelGroups(software.amazon.awssdk.services.mediapackagev2.model.ListChannelGroupsRequest)
operation.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) This is a variant oflistChannels(software.amazon.awssdk.services.mediapackagev2.model.ListChannelsRequest)
operation.default ListChannelsPublisher
listChannelsPaginator
(ListChannelsRequest listChannelsRequest) This is a variant oflistChannels(software.amazon.awssdk.services.mediapackagev2.model.ListChannelsRequest)
operation.default CompletableFuture
<ListHarvestJobsResponse> listHarvestJobs
(Consumer<ListHarvestJobsRequest.Builder> listHarvestJobsRequest) Retrieves a list of harvest jobs that match the specified criteria.default CompletableFuture
<ListHarvestJobsResponse> listHarvestJobs
(ListHarvestJobsRequest listHarvestJobsRequest) Retrieves a list of harvest jobs that match the specified criteria.default ListHarvestJobsPublisher
listHarvestJobsPaginator
(Consumer<ListHarvestJobsRequest.Builder> listHarvestJobsRequest) This is a variant oflistHarvestJobs(software.amazon.awssdk.services.mediapackagev2.model.ListHarvestJobsRequest)
operation.default ListHarvestJobsPublisher
listHarvestJobsPaginator
(ListHarvestJobsRequest listHarvestJobsRequest) This is a variant oflistHarvestJobs(software.amazon.awssdk.services.mediapackagev2.model.ListHarvestJobsRequest)
operation.listOriginEndpoints
(Consumer<ListOriginEndpointsRequest.Builder> listOriginEndpointsRequest) Retrieves all origin endpoints in a specific channel that are configured in AWS Elemental MediaPackage.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) This is a variant oflistOriginEndpoints(software.amazon.awssdk.services.mediapackagev2.model.ListOriginEndpointsRequest)
operation.default ListOriginEndpointsPublisher
listOriginEndpointsPaginator
(ListOriginEndpointsRequest listOriginEndpointsRequest) This is a variant oflistOriginEndpoints(software.amazon.awssdk.services.mediapackagev2.model.ListOriginEndpointsRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags assigned to a resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags assigned to a resource.putChannelPolicy
(Consumer<PutChannelPolicyRequest.Builder> putChannelPolicyRequest) Attaches an IAM policy to the specified channel.putChannelPolicy
(PutChannelPolicyRequest putChannelPolicyRequest) Attaches an IAM policy to the specified channel.putOriginEndpointPolicy
(Consumer<PutOriginEndpointPolicyRequest.Builder> putOriginEndpointPolicyRequest) Attaches an IAM policy to the specified origin endpoint.putOriginEndpointPolicy
(PutOriginEndpointPolicyRequest putOriginEndpointPolicyRequest) Attaches an IAM policy to the specified origin endpoint.resetChannelState
(Consumer<ResetChannelStateRequest.Builder> resetChannelStateRequest) Resetting the channel can help to clear errors from misconfigurations in the encoder.resetChannelState
(ResetChannelStateRequest resetChannelStateRequest) Resetting the channel can help to clear errors from misconfigurations in the encoder.resetOriginEndpointState
(Consumer<ResetOriginEndpointStateRequest.Builder> resetOriginEndpointStateRequest) Resetting the origin endpoint can help to resolve unexpected behavior and other content packaging issues.resetOriginEndpointState
(ResetOriginEndpointStateRequest resetOriginEndpointStateRequest) Resetting the origin endpoint can help to resolve unexpected behavior and other content packaging issues.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault 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.updateChannelGroup
(Consumer<UpdateChannelGroupRequest.Builder> updateChannelGroupRequest) Update the specified channel group.updateChannelGroup
(UpdateChannelGroupRequest updateChannelGroupRequest) Update the specified channel group.updateOriginEndpoint
(Consumer<UpdateOriginEndpointRequest.Builder> updateOriginEndpointRequest) Update the specified origin endpoint.updateOriginEndpoint
(UpdateOriginEndpointRequest updateOriginEndpointRequest) Update the specified origin endpoint.default MediaPackageV2AsyncWaiter
waiter()
Create an instance ofMediaPackageV2AsyncWaiter
using this client.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
cancelHarvestJob
default CompletableFuture<CancelHarvestJobResponse> cancelHarvestJob(CancelHarvestJobRequest cancelHarvestJobRequest) Cancels an in-progress harvest job.
- Parameters:
cancelHarvestJobRequest
-- Returns:
- A Java Future containing the result of the CancelHarvestJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
cancelHarvestJob
default CompletableFuture<CancelHarvestJobResponse> cancelHarvestJob(Consumer<CancelHarvestJobRequest.Builder> cancelHarvestJobRequest) Cancels an in-progress harvest job.
This is a convenience which creates an instance of the
CancelHarvestJobRequest.Builder
avoiding the need to create one manually viaCancelHarvestJobRequest.builder()
- Parameters:
cancelHarvestJobRequest
- AConsumer
that will call methods onCancelHarvestJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CancelHarvestJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createChannel
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.
- Parameters:
createChannelRequest
-- Returns:
- A Java Future containing the result of the CreateChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createChannel
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 viaCreateChannelRequest.builder()
- Parameters:
createChannelRequest
- AConsumer
that will call methods onCreateChannelRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createChannelGroup
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.
- Parameters:
createChannelGroupRequest
-- Returns:
- A Java Future containing the result of the CreateChannelGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createChannelGroup
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 viaCreateChannelGroupRequest.builder()
- Parameters:
createChannelGroupRequest
- AConsumer
that will call methods onCreateChannelGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateChannelGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createHarvestJob
default CompletableFuture<CreateHarvestJobResponse> createHarvestJob(CreateHarvestJobRequest createHarvestJobRequest) Creates a new harvest job to export content from a MediaPackage v2 channel to an S3 bucket.
- Parameters:
createHarvestJobRequest
- The request object for creating a new harvest job.- Returns:
- A Java Future containing the result of the CreateHarvestJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createHarvestJob
default CompletableFuture<CreateHarvestJobResponse> createHarvestJob(Consumer<CreateHarvestJobRequest.Builder> createHarvestJobRequest) Creates a new harvest job to export content from a MediaPackage v2 channel to an S3 bucket.
This is a convenience which creates an instance of the
CreateHarvestJobRequest.Builder
avoiding the need to create one manually viaCreateHarvestJobRequest.builder()
- Parameters:
createHarvestJobRequest
- AConsumer
that will call methods onCreateHarvestJobRequest.Builder
to create a request. The request object for creating a new harvest job.- Returns:
- A Java Future containing the result of the CreateHarvestJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createOriginEndpoint
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.
- Parameters:
createOriginEndpointRequest
-- Returns:
- A Java Future containing the result of the CreateOriginEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createOriginEndpoint
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 viaCreateOriginEndpointRequest.builder()
- Parameters:
createOriginEndpointRequest
- AConsumer
that will call methods onCreateOriginEndpointRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateOriginEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteChannel
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.
- Parameters:
deleteChannelRequest
-- Returns:
- A Java Future containing the result of the DeleteChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteChannel
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 viaDeleteChannelRequest.builder()
- Parameters:
deleteChannelRequest
- AConsumer
that will call methods onDeleteChannelRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteChannelGroup
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.
- Parameters:
deleteChannelGroupRequest
-- Returns:
- A Java Future containing the result of the DeleteChannelGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteChannelGroup
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 viaDeleteChannelGroupRequest.builder()
- Parameters:
deleteChannelGroupRequest
- AConsumer
that will call methods onDeleteChannelGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteChannelGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteChannelPolicy
default CompletableFuture<DeleteChannelPolicyResponse> deleteChannelPolicy(DeleteChannelPolicyRequest deleteChannelPolicyRequest) Delete a channel policy.
- Parameters:
deleteChannelPolicyRequest
-- Returns:
- A Java Future containing the result of the DeleteChannelPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteChannelPolicy
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 viaDeleteChannelPolicyRequest.builder()
- Parameters:
deleteChannelPolicyRequest
- AConsumer
that will call methods onDeleteChannelPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteChannelPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteOriginEndpoint
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.
- Parameters:
deleteOriginEndpointRequest
-- Returns:
- A Java Future containing the result of the DeleteOriginEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request throughput limit was exceeded.
- InternalServerException Indicates that an error from the service occurred while trying to process a request.
- AccessDeniedException Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteOriginEndpoint
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 viaDeleteOriginEndpointRequest.builder()
- Parameters:
deleteOriginEndpointRequest
- AConsumer
that will call methods onDeleteOriginEndpointRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteOriginEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request throughput limit was exceeded.
- InternalServerException Indicates that an error from the service occurred while trying to process a request.
- AccessDeniedException Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteOriginEndpointPolicy
default CompletableFuture<DeleteOriginEndpointPolicyResponse> deleteOriginEndpointPolicy(DeleteOriginEndpointPolicyRequest deleteOriginEndpointPolicyRequest) Delete an origin endpoint policy.
- Parameters:
deleteOriginEndpointPolicyRequest
-- Returns:
- A Java Future containing the result of the DeleteOriginEndpointPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteOriginEndpointPolicy
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 viaDeleteOriginEndpointPolicyRequest.builder()
- Parameters:
deleteOriginEndpointPolicyRequest
- AConsumer
that will call methods onDeleteOriginEndpointPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteOriginEndpointPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getChannel
Retrieves the specified channel that's configured in AWS Elemental MediaPackage, including the origin endpoints that are associated with it.
- Parameters:
getChannelRequest
-- Returns:
- A Java Future containing the result of the GetChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request throughput limit was exceeded.
- InternalServerException Indicates that an error from the service occurred while trying to process a request.
- AccessDeniedException Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getChannel
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 viaGetChannelRequest.builder()
- Parameters:
getChannelRequest
- AConsumer
that will call methods onGetChannelRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request throughput limit was exceeded.
- InternalServerException Indicates that an error from the service occurred while trying to process a request.
- AccessDeniedException Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getChannelGroup
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.
- Parameters:
getChannelGroupRequest
-- Returns:
- A Java Future containing the result of the GetChannelGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request throughput limit was exceeded.
- InternalServerException Indicates that an error from the service occurred while trying to process a request.
- AccessDeniedException Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getChannelGroup
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 viaGetChannelGroupRequest.builder()
- Parameters:
getChannelGroupRequest
- AConsumer
that will call methods onGetChannelGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetChannelGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request throughput limit was exceeded.
- InternalServerException Indicates that an error from the service occurred while trying to process a request.
- AccessDeniedException Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getChannelPolicy
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.
- Parameters:
getChannelPolicyRequest
-- Returns:
- A Java Future containing the result of the GetChannelPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request throughput limit was exceeded.
- InternalServerException Indicates that an error from the service occurred while trying to process a request.
- AccessDeniedException Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getChannelPolicy
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 viaGetChannelPolicyRequest.builder()
- Parameters:
getChannelPolicyRequest
- AConsumer
that will call methods onGetChannelPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetChannelPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request throughput limit was exceeded.
- InternalServerException Indicates that an error from the service occurred while trying to process a request.
- AccessDeniedException Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getHarvestJob
default CompletableFuture<GetHarvestJobResponse> getHarvestJob(GetHarvestJobRequest getHarvestJobRequest) Retrieves the details of a specific harvest job.
- Parameters:
getHarvestJobRequest
- The request object for retrieving a specific harvest job.- Returns:
- A Java Future containing the result of the GetHarvestJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request throughput limit was exceeded.
- InternalServerException Indicates that an error from the service occurred while trying to process a request.
- AccessDeniedException Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getHarvestJob
default CompletableFuture<GetHarvestJobResponse> getHarvestJob(Consumer<GetHarvestJobRequest.Builder> getHarvestJobRequest) Retrieves the details of a specific harvest job.
This is a convenience which creates an instance of the
GetHarvestJobRequest.Builder
avoiding the need to create one manually viaGetHarvestJobRequest.builder()
- Parameters:
getHarvestJobRequest
- AConsumer
that will call methods onGetHarvestJobRequest.Builder
to create a request. The request object for retrieving a specific harvest job.- Returns:
- A Java Future containing the result of the GetHarvestJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request throughput limit was exceeded.
- InternalServerException Indicates that an error from the service occurred while trying to process a request.
- AccessDeniedException Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getOriginEndpoint
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.
- Parameters:
getOriginEndpointRequest
-- Returns:
- A Java Future containing the result of the GetOriginEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request throughput limit was exceeded.
- InternalServerException Indicates that an error from the service occurred while trying to process a request.
- AccessDeniedException Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getOriginEndpoint
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 viaGetOriginEndpointRequest.builder()
- Parameters:
getOriginEndpointRequest
- AConsumer
that will call methods onGetOriginEndpointRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetOriginEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request throughput limit was exceeded.
- InternalServerException Indicates that an error from the service occurred while trying to process a request.
- AccessDeniedException Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getOriginEndpointPolicy
default CompletableFuture<GetOriginEndpointPolicyResponse> getOriginEndpointPolicy(GetOriginEndpointPolicyRequest getOriginEndpointPolicyRequest) Retrieves the specified origin endpoint policy that's configured in AWS Elemental MediaPackage.
- Parameters:
getOriginEndpointPolicyRequest
-- Returns:
- A Java Future containing the result of the GetOriginEndpointPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request throughput limit was exceeded.
- InternalServerException Indicates that an error from the service occurred while trying to process a request.
- AccessDeniedException Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getOriginEndpointPolicy
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 viaGetOriginEndpointPolicyRequest.builder()
- Parameters:
getOriginEndpointPolicyRequest
- AConsumer
that will call methods onGetOriginEndpointPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetOriginEndpointPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request throughput limit was exceeded.
- InternalServerException Indicates that an error from the service occurred while trying to process a request.
- AccessDeniedException Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannelGroups
default CompletableFuture<ListChannelGroupsResponse> listChannelGroups(ListChannelGroupsRequest listChannelGroupsRequest) Retrieves all channel groups that are configured in Elemental MediaPackage.
- Parameters:
listChannelGroupsRequest
-- Returns:
- A Java Future containing the result of the ListChannelGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request throughput limit was exceeded.
- InternalServerException Indicates that an error from the service occurred while trying to process a request.
- AccessDeniedException Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannelGroups
default CompletableFuture<ListChannelGroupsResponse> listChannelGroups(Consumer<ListChannelGroupsRequest.Builder> listChannelGroupsRequest) Retrieves all channel groups that are configured in Elemental MediaPackage.
This is a convenience which creates an instance of the
ListChannelGroupsRequest.Builder
avoiding the need to create one manually viaListChannelGroupsRequest.builder()
- Parameters:
listChannelGroupsRequest
- AConsumer
that will call methods onListChannelGroupsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListChannelGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request throughput limit was exceeded.
- InternalServerException Indicates that an error from the service occurred while trying to process a request.
- AccessDeniedException Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannelGroupsPaginator
default ListChannelGroupsPublisher listChannelGroupsPaginator(ListChannelGroupsRequest listChannelGroupsRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.mediapackagev2.paginators.ListChannelGroupsPublisher publisher = client.listChannelGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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.- Parameters:
listChannelGroupsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request throughput limit was exceeded.
- InternalServerException Indicates that an error from the service occurred while trying to process a request.
- AccessDeniedException Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannelGroupsPaginator
default ListChannelGroupsPublisher listChannelGroupsPaginator(Consumer<ListChannelGroupsRequest.Builder> listChannelGroupsRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.mediapackagev2.paginators.ListChannelGroupsPublisher publisher = client.listChannelGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListChannelGroupsRequest.builder()
- Parameters:
listChannelGroupsRequest
- AConsumer
that will call methods onListChannelGroupsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request throughput limit was exceeded.
- InternalServerException Indicates that an error from the service occurred while trying to process a request.
- AccessDeniedException Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannels
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.
- Parameters:
listChannelsRequest
-- Returns:
- A Java Future containing the result of the ListChannels operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request throughput limit was exceeded.
- InternalServerException Indicates that an error from the service occurred while trying to process a request.
- AccessDeniedException Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannels
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 viaListChannelsRequest.builder()
- Parameters:
listChannelsRequest
- AConsumer
that will call methods onListChannelsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListChannels operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request throughput limit was exceeded.
- InternalServerException Indicates that an error from the service occurred while trying to process a request.
- AccessDeniedException Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannelsPaginator
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 newSubscription
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 methodsoftware.amazon.awssdk.services.mediapackagev2.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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.- Parameters:
listChannelsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request throughput limit was exceeded.
- InternalServerException Indicates that an error from the service occurred while trying to process a request.
- AccessDeniedException Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannelsPaginator
default ListChannelsPublisher listChannelsPaginator(Consumer<ListChannelsRequest.Builder> listChannelsRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.mediapackagev2.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListChannelsRequest.builder()
- Parameters:
listChannelsRequest
- AConsumer
that will call methods onListChannelsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request throughput limit was exceeded.
- InternalServerException Indicates that an error from the service occurred while trying to process a request.
- AccessDeniedException Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listHarvestJobs
default CompletableFuture<ListHarvestJobsResponse> listHarvestJobs(ListHarvestJobsRequest listHarvestJobsRequest) Retrieves a list of harvest jobs that match the specified criteria.
- Parameters:
listHarvestJobsRequest
- The request object for listing harvest jobs.- Returns:
- A Java Future containing the result of the ListHarvestJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request throughput limit was exceeded.
- InternalServerException Indicates that an error from the service occurred while trying to process a request.
- AccessDeniedException Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listHarvestJobs
default CompletableFuture<ListHarvestJobsResponse> listHarvestJobs(Consumer<ListHarvestJobsRequest.Builder> listHarvestJobsRequest) Retrieves a list of harvest jobs that match the specified criteria.
This is a convenience which creates an instance of the
ListHarvestJobsRequest.Builder
avoiding the need to create one manually viaListHarvestJobsRequest.builder()
- Parameters:
listHarvestJobsRequest
- AConsumer
that will call methods onListHarvestJobsRequest.Builder
to create a request. The request object for listing harvest jobs.- Returns:
- A Java Future containing the result of the ListHarvestJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request throughput limit was exceeded.
- InternalServerException Indicates that an error from the service occurred while trying to process a request.
- AccessDeniedException Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listHarvestJobsPaginator
default ListHarvestJobsPublisher listHarvestJobsPaginator(ListHarvestJobsRequest listHarvestJobsRequest) This is a variant of
listHarvestJobs(software.amazon.awssdk.services.mediapackagev2.model.ListHarvestJobsRequest)
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 newSubscription
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 methodsoftware.amazon.awssdk.services.mediapackagev2.paginators.ListHarvestJobsPublisher publisher = client.listHarvestJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.mediapackagev2.paginators.ListHarvestJobsPublisher publisher = client.listHarvestJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mediapackagev2.model.ListHarvestJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.mediapackagev2.model.ListHarvestJobsResponse response) { //... }; });
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
listHarvestJobs(software.amazon.awssdk.services.mediapackagev2.model.ListHarvestJobsRequest)
operation.- Parameters:
listHarvestJobsRequest
- The request object for listing harvest jobs.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request throughput limit was exceeded.
- InternalServerException Indicates that an error from the service occurred while trying to process a request.
- AccessDeniedException Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listHarvestJobsPaginator
default ListHarvestJobsPublisher listHarvestJobsPaginator(Consumer<ListHarvestJobsRequest.Builder> listHarvestJobsRequest) This is a variant of
listHarvestJobs(software.amazon.awssdk.services.mediapackagev2.model.ListHarvestJobsRequest)
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 newSubscription
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 methodsoftware.amazon.awssdk.services.mediapackagev2.paginators.ListHarvestJobsPublisher publisher = client.listHarvestJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.mediapackagev2.paginators.ListHarvestJobsPublisher publisher = client.listHarvestJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mediapackagev2.model.ListHarvestJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.mediapackagev2.model.ListHarvestJobsResponse response) { //... }; });
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
listHarvestJobs(software.amazon.awssdk.services.mediapackagev2.model.ListHarvestJobsRequest)
operation.
This is a convenience which creates an instance of the
ListHarvestJobsRequest.Builder
avoiding the need to create one manually viaListHarvestJobsRequest.builder()
- Parameters:
listHarvestJobsRequest
- AConsumer
that will call methods onListHarvestJobsRequest.Builder
to create a request. The request object for listing harvest jobs.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request throughput limit was exceeded.
- InternalServerException Indicates that an error from the service occurred while trying to process a request.
- AccessDeniedException Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listOriginEndpoints
default CompletableFuture<ListOriginEndpointsResponse> listOriginEndpoints(ListOriginEndpointsRequest listOriginEndpointsRequest) Retrieves all origin endpoints in a specific channel that are configured in AWS Elemental MediaPackage.
- Parameters:
listOriginEndpointsRequest
-- Returns:
- A Java Future containing the result of the ListOriginEndpoints operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request throughput limit was exceeded.
- InternalServerException Indicates that an error from the service occurred while trying to process a request.
- AccessDeniedException Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listOriginEndpoints
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 viaListOriginEndpointsRequest.builder()
- Parameters:
listOriginEndpointsRequest
- AConsumer
that will call methods onListOriginEndpointsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListOriginEndpoints operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request throughput limit was exceeded.
- InternalServerException Indicates that an error from the service occurred while trying to process a request.
- AccessDeniedException Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listOriginEndpointsPaginator
default ListOriginEndpointsPublisher listOriginEndpointsPaginator(ListOriginEndpointsRequest listOriginEndpointsRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.mediapackagev2.paginators.ListOriginEndpointsPublisher publisher = client.listOriginEndpointsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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.- Parameters:
listOriginEndpointsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request throughput limit was exceeded.
- InternalServerException Indicates that an error from the service occurred while trying to process a request.
- AccessDeniedException Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listOriginEndpointsPaginator
default ListOriginEndpointsPublisher listOriginEndpointsPaginator(Consumer<ListOriginEndpointsRequest.Builder> listOriginEndpointsRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.mediapackagev2.paginators.ListOriginEndpointsPublisher publisher = client.listOriginEndpointsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListOriginEndpointsRequest.builder()
- Parameters:
listOriginEndpointsRequest
- AConsumer
that will call methods onListOriginEndpointsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request throughput limit was exceeded.
- InternalServerException Indicates that an error from the service occurred while trying to process a request.
- AccessDeniedException Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags assigned to a resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The input failed to meet the constraints specified by the AWS service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
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 viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The input failed to meet the constraints specified by the AWS service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putChannelPolicy
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.
- Parameters:
putChannelPolicyRequest
-- Returns:
- A Java Future containing the result of the PutChannelPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putChannelPolicy
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 viaPutChannelPolicyRequest.builder()
- Parameters:
putChannelPolicyRequest
- AConsumer
that will call methods onPutChannelPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutChannelPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putOriginEndpointPolicy
default CompletableFuture<PutOriginEndpointPolicyResponse> putOriginEndpointPolicy(PutOriginEndpointPolicyRequest putOriginEndpointPolicyRequest) Attaches an IAM policy to the specified origin endpoint. You can attach only one policy with each request.
- Parameters:
putOriginEndpointPolicyRequest
-- Returns:
- A Java Future containing the result of the PutOriginEndpointPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putOriginEndpointPolicy
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 viaPutOriginEndpointPolicyRequest.builder()
- Parameters:
putOriginEndpointPolicyRequest
- AConsumer
that will call methods onPutOriginEndpointPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutOriginEndpointPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
resetChannelState
default CompletableFuture<ResetChannelStateResponse> resetChannelState(ResetChannelStateRequest resetChannelStateRequest) 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.
- Parameters:
resetChannelStateRequest
-- Returns:
- A Java Future containing the result of the ResetChannelState operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
resetChannelState
default CompletableFuture<ResetChannelStateResponse> resetChannelState(Consumer<ResetChannelStateRequest.Builder> resetChannelStateRequest) 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.
This is a convenience which creates an instance of the
ResetChannelStateRequest.Builder
avoiding the need to create one manually viaResetChannelStateRequest.builder()
- Parameters:
resetChannelStateRequest
- AConsumer
that will call methods onResetChannelStateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ResetChannelState operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
resetOriginEndpointState
default CompletableFuture<ResetOriginEndpointStateResponse> resetOriginEndpointState(ResetOriginEndpointStateRequest resetOriginEndpointStateRequest) 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.
- Parameters:
resetOriginEndpointStateRequest
-- Returns:
- A Java Future containing the result of the ResetOriginEndpointState operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
resetOriginEndpointState
default CompletableFuture<ResetOriginEndpointStateResponse> resetOriginEndpointState(Consumer<ResetOriginEndpointStateRequest.Builder> resetOriginEndpointStateRequest) 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.
This is a convenience which creates an instance of the
ResetOriginEndpointStateRequest.Builder
avoiding the need to create one manually viaResetOriginEndpointStateRequest.builder()
- Parameters:
resetOriginEndpointStateRequest
- AConsumer
that will call methods onResetOriginEndpointStateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ResetOriginEndpointState operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
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.
- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The input failed to meet the constraints specified by the AWS service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
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 viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The input failed to meet the constraints specified by the AWS service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes one or more tags from the specified resource.
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The input failed to meet the constraints specified by the AWS service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
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 viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The input failed to meet the constraints specified by the AWS service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateChannel
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.
- Parameters:
updateChannelRequest
-- Returns:
- A Java Future containing the result of the UpdateChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateChannel
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 viaUpdateChannelRequest.builder()
- Parameters:
updateChannelRequest
- AConsumer
that will call methods onUpdateChannelRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateChannelGroup
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.
- Parameters:
updateChannelGroupRequest
-- Returns:
- A Java Future containing the result of the UpdateChannelGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateChannelGroup
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 viaUpdateChannelGroupRequest.builder()
- Parameters:
updateChannelGroupRequest
- AConsumer
that will call methods onUpdateChannelGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateChannelGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- ValidationException The input failed to meet the constraints specified by the AWS service.
- ResourceNotFoundException The specified resource doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateOriginEndpoint
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.
- Parameters:
updateOriginEndpointRequest
-- Returns:
- A Java Future containing the result of the UpdateOriginEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateOriginEndpoint
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 viaUpdateOriginEndpointRequest.builder()
- Parameters:
updateOriginEndpointRequest
- AConsumer
that will call methods onUpdateOriginEndpointRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateOriginEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MediaPackageV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
waiter
Create an instance ofMediaPackageV2AsyncWaiter
using this client.Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
- Returns:
- an instance of
MediaPackageV2AsyncWaiter
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aMediaPackageV2AsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aMediaPackageV2AsyncClient
.
-