com.amazonaws.services.mediapackage

Interface AWSMediaPackage

All Known Subinterfaces:

AWSMediaPackageAsync

All Known Implementing Classes:

AbstractAWSMediaPackage, AbstractAWSMediaPackageAsync, AWSMediaPackageAsyncClient, AWSMediaPackageClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSMediaPackage

Interface for accessing MediaPackage.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSMediaPackage instead.

AWS Elemental MediaPackage

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
ConfigureLogsResult	configureLogs(ConfigureLogsRequest configureLogsRequest) Changes the Channel's properities to configure log subscription
CreateChannelResult	createChannel(CreateChannelRequest createChannelRequest) Creates a new Channel.
CreateHarvestJobResult	createHarvestJob(CreateHarvestJobRequest createHarvestJobRequest) Creates a new HarvestJob record.
CreateOriginEndpointResult	createOriginEndpoint(CreateOriginEndpointRequest createOriginEndpointRequest) Creates a new OriginEndpoint record.
DeleteChannelResult	deleteChannel(DeleteChannelRequest deleteChannelRequest) Deletes an existing Channel.
DeleteOriginEndpointResult	deleteOriginEndpoint(DeleteOriginEndpointRequest deleteOriginEndpointRequest) Deletes an existing OriginEndpoint.
DescribeChannelResult	describeChannel(DescribeChannelRequest describeChannelRequest) Gets details about a Channel.
DescribeHarvestJobResult	describeHarvestJob(DescribeHarvestJobRequest describeHarvestJobRequest) Gets details about an existing HarvestJob.
DescribeOriginEndpointResult	describeOriginEndpoint(DescribeOriginEndpointRequest describeOriginEndpointRequest) 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 listChannelsRequest) Returns a collection of Channels.
ListHarvestJobsResult	listHarvestJobs(ListHarvestJobsRequest listHarvestJobsRequest) Returns a collection of HarvestJob records.
ListOriginEndpointsResult	listOriginEndpoints(ListOriginEndpointsRequest listOriginEndpointsRequest) Returns a collection of OriginEndpoint records.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
RotateChannelCredentialsResult	rotateChannelCredentials(RotateChannelCredentialsRequest rotateChannelCredentialsRequest) Deprecated.
RotateIngestEndpointCredentialsResult	rotateIngestEndpointCredentials(RotateIngestEndpointCredentialsRequest rotateIngestEndpointCredentialsRequest) 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 tagResourceRequest)
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest)
UpdateChannelResult	updateChannel(UpdateChannelRequest updateChannelRequest) Updates an existing Channel.
UpdateOriginEndpointResult	updateOriginEndpoint(UpdateOriginEndpointRequest updateOriginEndpointRequest) Updates an existing OriginEndpoint.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

configureLogs

ConfigureLogsResult configureLogs(ConfigureLogsRequest configureLogsRequest)

Changes the Channel's properities to configure log subscription

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

CreateChannelResult createChannel(CreateChannelRequest createChannelRequest)

Creates a new Channel.

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

CreateHarvestJobResult createHarvestJob(CreateHarvestJobRequest createHarvestJobRequest)

Creates a new HarvestJob record.

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

CreateOriginEndpointResult createOriginEndpoint(CreateOriginEndpointRequest createOriginEndpointRequest)

Creates a new OriginEndpoint record.

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

DeleteChannelResult deleteChannel(DeleteChannelRequest deleteChannelRequest)

Deletes an existing Channel.

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

DeleteOriginEndpointResult deleteOriginEndpoint(DeleteOriginEndpointRequest deleteOriginEndpointRequest)

Deletes an existing OriginEndpoint.

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

DescribeChannelResult describeChannel(DescribeChannelRequest describeChannelRequest)

Gets details about a Channel.

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

DescribeHarvestJobResult describeHarvestJob(DescribeHarvestJobRequest describeHarvestJobRequest)

Gets details about an existing HarvestJob.

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

DescribeOriginEndpointResult describeOriginEndpoint(DescribeOriginEndpointRequest describeOriginEndpointRequest)

Gets details about an existing OriginEndpoint.

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

ListChannelsResult listChannels(ListChannelsRequest listChannelsRequest)

Returns a collection of Channels.

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

ListHarvestJobsResult listHarvestJobs(ListHarvestJobsRequest listHarvestJobsRequest)

Returns a collection of HarvestJob records.

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

ListOriginEndpointsResult listOriginEndpoints(ListOriginEndpointsRequest listOriginEndpointsRequest)

Returns a collection of OriginEndpoint records.

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

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

AWS API Documentation

rotateChannelCredentials

@Deprecated
RotateChannelCredentialsResult rotateChannelCredentials(RotateChannelCredentialsRequest rotateChannelCredentialsRequest)

Deprecated.

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

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

RotateIngestEndpointCredentialsResult rotateIngestEndpointCredentials(RotateIngestEndpointCredentialsRequest rotateIngestEndpointCredentialsRequest)

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

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

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

AWS API Documentation

updateChannel

UpdateChannelResult updateChannel(UpdateChannelRequest updateChannelRequest)

Updates an existing Channel.

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

UpdateOriginEndpointResult updateOriginEndpoint(UpdateOriginEndpointRequest updateOriginEndpointRequest)

Updates an existing OriginEndpoint.

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

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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