com.amazonaws.services.mediapackage

Class AWSMediaPackageClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.mediapackage.AWSMediaPackageClient

All Implemented Interfaces:

AWSMediaPackage

Direct Known Subclasses:

AWSMediaPackageAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSMediaPackageClient
extends AmazonWebServiceClient
implements AWSMediaPackage

Client for accessing MediaPackage. All service calls made using this client are blocking, and will not return until the service call completes.

AWS Elemental MediaPackage

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.mediapackage.AWSMediaPackage

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSMediaPackageClientBuilder	builder()
ConfigureLogsResult	configureLogs(ConfigureLogsRequest request) Changes the Channel's properities to configure log subscription
CreateChannelResult	createChannel(CreateChannelRequest request) Creates a new Channel.
CreateHarvestJobResult	createHarvestJob(CreateHarvestJobRequest request) Creates a new HarvestJob record.
CreateOriginEndpointResult	createOriginEndpoint(CreateOriginEndpointRequest request) Creates a new OriginEndpoint record.
DeleteChannelResult	deleteChannel(DeleteChannelRequest request) Deletes an existing Channel.
DeleteOriginEndpointResult	deleteOriginEndpoint(DeleteOriginEndpointRequest request) Deletes an existing OriginEndpoint.
DescribeChannelResult	describeChannel(DescribeChannelRequest request) Gets details about a Channel.
DescribeHarvestJobResult	describeHarvestJob(DescribeHarvestJobRequest request) Gets details about an existing HarvestJob.
DescribeOriginEndpointResult	describeOriginEndpoint(DescribeOriginEndpointRequest request) Gets details about an existing OriginEndpoint.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
ListChannelsResult	listChannels(ListChannelsRequest request) Returns a collection of Channels.
ListHarvestJobsResult	listHarvestJobs(ListHarvestJobsRequest request) Returns a collection of HarvestJob records.
ListOriginEndpointsResult	listOriginEndpoints(ListOriginEndpointsRequest request) Returns a collection of OriginEndpoint records.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request)
RotateChannelCredentialsResult	rotateChannelCredentials(RotateChannelCredentialsRequest request) Deprecated.
RotateIngestEndpointCredentialsResult	rotateIngestEndpointCredentials(RotateIngestEndpointCredentialsRequest request) Rotate the IngestEndpoint's username and password, as specified by the IngestEndpoint's id.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest request)
UntagResourceResult	untagResource(UntagResourceRequest request)
UpdateChannelResult	updateChannel(UpdateChannelRequest request) Updates an existing Channel.
UpdateOriginEndpointResult	updateOriginEndpoint(UpdateOriginEndpointRequest request) Updates an existing OriginEndpoint.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AWSMediaPackageClientBuilder builder()

configureLogs

public ConfigureLogsResult configureLogs(ConfigureLogsRequest request)

Changes the Channel's properities to configure log subscription

Specified by:

configureLogs in interface AWSMediaPackage

Parameters:

configureLogsRequest - the option to configure log subscription.

Returns:

Result of the ConfigureLogs operation returned by the service.

Throws:

UnprocessableEntityException - The parameters sent in the request are not valid.

InternalServerErrorException - An unexpected error occurred.

ForbiddenException - The client is not authorized to access the requested resource.

NotFoundException - The requested resource does not exist.

ServiceUnavailableException - An unexpected error occurred.

TooManyRequestsException - The client has exceeded their resource or throttling limits.

See Also:

AWS API Documentation

createChannel

public CreateChannelResult createChannel(CreateChannelRequest request)

Creates a new Channel.

Specified by:

createChannel in interface AWSMediaPackage

Parameters:

createChannelRequest - A new Channel configuration.

Returns:

Result of the CreateChannel operation returned by the service.

Throws:

UnprocessableEntityException - The parameters sent in the request are not valid.

InternalServerErrorException - An unexpected error occurred.

ForbiddenException - The client is not authorized to access the requested resource.

NotFoundException - The requested resource does not exist.

ServiceUnavailableException - An unexpected error occurred.

TooManyRequestsException - The client has exceeded their resource or throttling limits.

See Also:

AWS API Documentation

createHarvestJob

public CreateHarvestJobResult createHarvestJob(CreateHarvestJobRequest request)

Creates a new HarvestJob record.

Specified by:

createHarvestJob in interface AWSMediaPackage

Parameters:

createHarvestJobRequest - Configuration parameters used to create a new HarvestJob.

Returns:

Result of the CreateHarvestJob operation returned by the service.

Throws:

UnprocessableEntityException - The parameters sent in the request are not valid.

InternalServerErrorException - An unexpected error occurred.

ForbiddenException - The client is not authorized to access the requested resource.

NotFoundException - The requested resource does not exist.

ServiceUnavailableException - An unexpected error occurred.

TooManyRequestsException - The client has exceeded their resource or throttling limits.

See Also:

AWS API Documentation

createOriginEndpoint

public CreateOriginEndpointResult createOriginEndpoint(CreateOriginEndpointRequest request)

Creates a new OriginEndpoint record.

Specified by:

createOriginEndpoint in interface AWSMediaPackage

Parameters:

createOriginEndpointRequest - Configuration parameters used to create a new OriginEndpoint.

Returns:

Result of the CreateOriginEndpoint operation returned by the service.

Throws:

UnprocessableEntityException - The parameters sent in the request are not valid.

InternalServerErrorException - An unexpected error occurred.

ForbiddenException - The client is not authorized to access the requested resource.

NotFoundException - The requested resource does not exist.

ServiceUnavailableException - An unexpected error occurred.

TooManyRequestsException - The client has exceeded their resource or throttling limits.

See Also:

AWS API Documentation

deleteChannel

public DeleteChannelResult deleteChannel(DeleteChannelRequest request)

Deletes an existing Channel.

Specified by:

deleteChannel in interface AWSMediaPackage

Parameters:

deleteChannelRequest -

Returns:

Result of the DeleteChannel operation returned by the service.

Throws:

UnprocessableEntityException - The parameters sent in the request are not valid.

InternalServerErrorException - An unexpected error occurred.

ForbiddenException - The client is not authorized to access the requested resource.

NotFoundException - The requested resource does not exist.

ServiceUnavailableException - An unexpected error occurred.

TooManyRequestsException - The client has exceeded their resource or throttling limits.

See Also:

AWS API Documentation

deleteOriginEndpoint

public DeleteOriginEndpointResult deleteOriginEndpoint(DeleteOriginEndpointRequest request)

Deletes an existing OriginEndpoint.

Specified by:

deleteOriginEndpoint in interface AWSMediaPackage

Parameters:

deleteOriginEndpointRequest -

Returns:

Result of the DeleteOriginEndpoint operation returned by the service.

Throws:

UnprocessableEntityException - The parameters sent in the request are not valid.

InternalServerErrorException - An unexpected error occurred.

ForbiddenException - The client is not authorized to access the requested resource.

NotFoundException - The requested resource does not exist.

ServiceUnavailableException - An unexpected error occurred.

TooManyRequestsException - The client has exceeded their resource or throttling limits.

See Also:

AWS API Documentation

describeChannel

public DescribeChannelResult describeChannel(DescribeChannelRequest request)

Gets details about a Channel.

Specified by:

describeChannel in interface AWSMediaPackage

Parameters:

describeChannelRequest -

Returns:

Result of the DescribeChannel operation returned by the service.

Throws:

UnprocessableEntityException - The parameters sent in the request are not valid.

InternalServerErrorException - An unexpected error occurred.

ForbiddenException - The client is not authorized to access the requested resource.

NotFoundException - The requested resource does not exist.

ServiceUnavailableException - An unexpected error occurred.

TooManyRequestsException - The client has exceeded their resource or throttling limits.

See Also:

AWS API Documentation

describeHarvestJob

public DescribeHarvestJobResult describeHarvestJob(DescribeHarvestJobRequest request)

Gets details about an existing HarvestJob.

Specified by:

describeHarvestJob in interface AWSMediaPackage

Parameters:

describeHarvestJobRequest -

Returns:

Result of the DescribeHarvestJob operation returned by the service.

Throws:

UnprocessableEntityException - The parameters sent in the request are not valid.

InternalServerErrorException - An unexpected error occurred.

ForbiddenException - The client is not authorized to access the requested resource.

NotFoundException - The requested resource does not exist.

ServiceUnavailableException - An unexpected error occurred.

TooManyRequestsException - The client has exceeded their resource or throttling limits.

See Also:

AWS API Documentation

describeOriginEndpoint

public DescribeOriginEndpointResult describeOriginEndpoint(DescribeOriginEndpointRequest request)

Gets details about an existing OriginEndpoint.

Specified by:

describeOriginEndpoint in interface AWSMediaPackage

Parameters:

describeOriginEndpointRequest -

Returns:

Result of the DescribeOriginEndpoint operation returned by the service.

Throws:

UnprocessableEntityException - The parameters sent in the request are not valid.

InternalServerErrorException - An unexpected error occurred.

ForbiddenException - The client is not authorized to access the requested resource.

NotFoundException - The requested resource does not exist.

ServiceUnavailableException - An unexpected error occurred.

TooManyRequestsException - The client has exceeded their resource or throttling limits.

See Also:

AWS API Documentation

listChannels

public ListChannelsResult listChannels(ListChannelsRequest request)

Returns a collection of Channels.

Specified by:

listChannels in interface AWSMediaPackage

Parameters:

listChannelsRequest -

Returns:

Result of the ListChannels operation returned by the service.

Throws:

UnprocessableEntityException - The parameters sent in the request are not valid.

InternalServerErrorException - An unexpected error occurred.

ForbiddenException - The client is not authorized to access the requested resource.

NotFoundException - The requested resource does not exist.

ServiceUnavailableException - An unexpected error occurred.

TooManyRequestsException - The client has exceeded their resource or throttling limits.

See Also:

AWS API Documentation

listHarvestJobs

public ListHarvestJobsResult listHarvestJobs(ListHarvestJobsRequest request)

Returns a collection of HarvestJob records.

Specified by:

listHarvestJobs in interface AWSMediaPackage

Parameters:

listHarvestJobsRequest -

Returns:

Result of the ListHarvestJobs operation returned by the service.

Throws:

UnprocessableEntityException - The parameters sent in the request are not valid.

InternalServerErrorException - An unexpected error occurred.

ForbiddenException - The client is not authorized to access the requested resource.

NotFoundException - The requested resource does not exist.

ServiceUnavailableException - An unexpected error occurred.

TooManyRequestsException - The client has exceeded their resource or throttling limits.

See Also:

AWS API Documentation

listOriginEndpoints

public ListOriginEndpointsResult listOriginEndpoints(ListOriginEndpointsRequest request)

Returns a collection of OriginEndpoint records.

Specified by:

listOriginEndpoints in interface AWSMediaPackage

Parameters:

listOriginEndpointsRequest -

Returns:

Result of the ListOriginEndpoints operation returned by the service.

Throws:

UnprocessableEntityException - The parameters sent in the request are not valid.

InternalServerErrorException - An unexpected error occurred.

ForbiddenException - The client is not authorized to access the requested resource.

NotFoundException - The requested resource does not exist.

ServiceUnavailableException - An unexpected error occurred.

TooManyRequestsException - The client has exceeded their resource or throttling limits.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Specified by:

listTagsForResource in interface AWSMediaPackage

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

AWS API Documentation

rotateChannelCredentials

@Deprecated
public RotateChannelCredentialsResult rotateChannelCredentials(RotateChannelCredentialsRequest request)

Deprecated.

Changes the Channel's first IngestEndpoint's username and password. WARNING - This API is deprecated. Please use RotateIngestEndpointCredentials instead

Specified by:

rotateChannelCredentials in interface AWSMediaPackage

Parameters:

rotateChannelCredentialsRequest -

Returns:

Result of the RotateChannelCredentials operation returned by the service.

Throws:

UnprocessableEntityException - The parameters sent in the request are not valid.

InternalServerErrorException - An unexpected error occurred.

ForbiddenException - The client is not authorized to access the requested resource.

NotFoundException - The requested resource does not exist.

ServiceUnavailableException - An unexpected error occurred.

TooManyRequestsException - The client has exceeded their resource or throttling limits.

See Also:

AWS API Documentation

rotateIngestEndpointCredentials

public RotateIngestEndpointCredentialsResult rotateIngestEndpointCredentials(RotateIngestEndpointCredentialsRequest request)

Rotate the IngestEndpoint's username and password, as specified by the IngestEndpoint's id.

Specified by:

rotateIngestEndpointCredentials in interface AWSMediaPackage

Parameters:

rotateIngestEndpointCredentialsRequest -

Returns:

Result of the RotateIngestEndpointCredentials operation returned by the service.

Throws:

UnprocessableEntityException - The parameters sent in the request are not valid.

InternalServerErrorException - An unexpected error occurred.

ForbiddenException - The client is not authorized to access the requested resource.

NotFoundException - The requested resource does not exist.

ServiceUnavailableException - An unexpected error occurred.

TooManyRequestsException - The client has exceeded their resource or throttling limits.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Specified by:

tagResource in interface AWSMediaPackage

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Specified by:

untagResource in interface AWSMediaPackage

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

AWS API Documentation

updateChannel

public UpdateChannelResult updateChannel(UpdateChannelRequest request)

Updates an existing Channel.

Specified by:

updateChannel in interface AWSMediaPackage

Parameters:

updateChannelRequest - Configuration parameters used to update the Channel.

Returns:

Result of the UpdateChannel operation returned by the service.

Throws:

UnprocessableEntityException - The parameters sent in the request are not valid.

InternalServerErrorException - An unexpected error occurred.

ForbiddenException - The client is not authorized to access the requested resource.

NotFoundException - The requested resource does not exist.

ServiceUnavailableException - An unexpected error occurred.

TooManyRequestsException - The client has exceeded their resource or throttling limits.

See Also:

AWS API Documentation

updateOriginEndpoint

public UpdateOriginEndpointResult updateOriginEndpoint(UpdateOriginEndpointRequest request)

Updates an existing OriginEndpoint.

Specified by:

updateOriginEndpoint in interface AWSMediaPackage

Parameters:

updateOriginEndpointRequest - Configuration parameters used to update an existing OriginEndpoint.

Returns:

Result of the UpdateOriginEndpoint operation returned by the service.

Throws:

UnprocessableEntityException - The parameters sent in the request are not valid.

InternalServerErrorException - An unexpected error occurred.

ForbiddenException - The client is not authorized to access the requested resource.

NotFoundException - The requested resource does not exist.

ServiceUnavailableException - An unexpected error occurred.

TooManyRequestsException - The client has exceeded their resource or throttling limits.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AWSMediaPackage

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSMediaPackage

Overrides:

shutdown in class AmazonWebServiceClient