com.amazonaws.services.mediaconvert

Class AWSMediaConvertClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.mediaconvert.AWSMediaConvertClient

All Implemented Interfaces:

AWSMediaConvert

Direct Known Subclasses:

AWSMediaConvertAsyncClient

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

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

AWS Elemental MediaConvert

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.mediaconvert.AWSMediaConvert

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSMediaConvertClientBuilder	builder()
CancelJobResult	cancelJob(CancelJobRequest request) Permanently remove a job from a queue.
CreateJobResult	createJob(CreateJobRequest request) Create a new transcoding job.
CreateJobTemplateResult	createJobTemplate(CreateJobTemplateRequest request) Create a new job template.
CreatePresetResult	createPreset(CreatePresetRequest request) Create a new preset.
CreateQueueResult	createQueue(CreateQueueRequest request) Create a new transcoding queue.
DeleteJobTemplateResult	deleteJobTemplate(DeleteJobTemplateRequest request) Permanently delete a job template you have created.
DeletePresetResult	deletePreset(DeletePresetRequest request) Permanently delete a preset you have created.
DeleteQueueResult	deleteQueue(DeleteQueueRequest request) Permanently delete a queue you have created.
DescribeEndpointsResult	describeEndpoints(DescribeEndpointsRequest request) Send an request with an empty body to the regional API endpoint to get your account API endpoint.
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.
GetJobResult	getJob(GetJobRequest request) Retrieve the JSON for a specific completed transcoding job.
GetJobTemplateResult	getJobTemplate(GetJobTemplateRequest request) Retrieve the JSON for a specific job template.
GetPresetResult	getPreset(GetPresetRequest request) Retrieve the JSON for a specific preset.
GetQueueResult	getQueue(GetQueueRequest request) Retrieve the JSON for a specific queue.
ListJobsResult	listJobs(ListJobsRequest request) Retrieve a JSON array of up to twenty of your most recently created jobs.
ListJobTemplatesResult	listJobTemplates(ListJobTemplatesRequest request) Retrieve a JSON array of up to twenty of your job templates.
ListPresetsResult	listPresets(ListPresetsRequest request) Retrieve a JSON array of up to twenty of your presets.
ListQueuesResult	listQueues(ListQueuesRequest request) Retrieve a JSON array of up to twenty of your queues.
UpdateJobTemplateResult	updateJobTemplate(UpdateJobTemplateRequest request) Modify one of your existing job templates.
UpdatePresetResult	updatePreset(UpdatePresetRequest request) Modify one of your existing presets.
UpdateQueueResult	updateQueue(UpdateQueueRequest request) Modify one of your existing queues.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.amazonaws.services.mediaconvert.AWSMediaConvert

shutdown

Method Detail

builder

public static AWSMediaConvertClientBuilder builder()

cancelJob

public CancelJobResult cancelJob(CancelJobRequest request)

Permanently remove a job from a queue. Once you have canceled a job, you can't start it again. You can't delete a running job.

Specified by:

cancelJob in interface AWSMediaConvert

Parameters:

cancelJobRequest -

Returns:

Result of the CancelJob operation returned by the service.

Throws:

BadRequestException - The service can't process your request because of a problem in the request. Please check your request form and syntax.

InternalServerErrorException - The service encountered an unexpected condition and cannot fulfill your request.

ForbiddenException - You don't have permissions for this action with the credentials you sent.

NotFoundException - The resource you requested does not exist.

TooManyRequestsException - Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests.

ConflictException - The service could not complete your request because there is a conflict with the current state of the resource.

See Also:

AWS API Documentation

createJob

public CreateJobResult createJob(CreateJobRequest request)

Create a new transcoding job. For information about jobs and job settings, see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html

Specified by:

createJob in interface AWSMediaConvert

Parameters:

createJobRequest -

Returns:

Result of the CreateJob operation returned by the service.

Throws:

BadRequestException - The service can't process your request because of a problem in the request. Please check your request form and syntax.

InternalServerErrorException - The service encountered an unexpected condition and cannot fulfill your request.

ForbiddenException - You don't have permissions for this action with the credentials you sent.

NotFoundException - The resource you requested does not exist.

TooManyRequestsException - Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests.

ConflictException - The service could not complete your request because there is a conflict with the current state of the resource.

See Also:

AWS API Documentation

createJobTemplate

public CreateJobTemplateResult createJobTemplate(CreateJobTemplateRequest request)

Create a new job template. For information about job templates see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html

Specified by:

createJobTemplate in interface AWSMediaConvert

Parameters:

createJobTemplateRequest -

Returns:

Result of the CreateJobTemplate operation returned by the service.

Throws:

BadRequestException - The service can't process your request because of a problem in the request. Please check your request form and syntax.

InternalServerErrorException - The service encountered an unexpected condition and cannot fulfill your request.

ForbiddenException - You don't have permissions for this action with the credentials you sent.

NotFoundException - The resource you requested does not exist.

TooManyRequestsException - Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests.

ConflictException - The service could not complete your request because there is a conflict with the current state of the resource.

See Also:

AWS API Documentation

createPreset

public CreatePresetResult createPreset(CreatePresetRequest request)

Create a new preset. For information about job templates see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html

Specified by:

createPreset in interface AWSMediaConvert

Parameters:

createPresetRequest -

Returns:

Result of the CreatePreset operation returned by the service.

Throws:

BadRequestException - The service can't process your request because of a problem in the request. Please check your request form and syntax.

InternalServerErrorException - The service encountered an unexpected condition and cannot fulfill your request.

ForbiddenException - You don't have permissions for this action with the credentials you sent.

NotFoundException - The resource you requested does not exist.

TooManyRequestsException - Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests.

ConflictException - The service could not complete your request because there is a conflict with the current state of the resource.

See Also:

AWS API Documentation

createQueue

public CreateQueueResult createQueue(CreateQueueRequest request)

Create a new transcoding queue. For information about job templates see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html

Specified by:

createQueue in interface AWSMediaConvert

Parameters:

createQueueRequest -

Returns:

Result of the CreateQueue operation returned by the service.

Throws:

BadRequestException - The service can't process your request because of a problem in the request. Please check your request form and syntax.

InternalServerErrorException - The service encountered an unexpected condition and cannot fulfill your request.

ForbiddenException - You don't have permissions for this action with the credentials you sent.

NotFoundException - The resource you requested does not exist.

TooManyRequestsException - Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests.

ConflictException - The service could not complete your request because there is a conflict with the current state of the resource.

See Also:

AWS API Documentation

deleteJobTemplate

public DeleteJobTemplateResult deleteJobTemplate(DeleteJobTemplateRequest request)

Permanently delete a job template you have created.

Specified by:

deleteJobTemplate in interface AWSMediaConvert

Parameters:

deleteJobTemplateRequest -

Returns:

Result of the DeleteJobTemplate operation returned by the service.

Throws:

BadRequestException - The service can't process your request because of a problem in the request. Please check your request form and syntax.

InternalServerErrorException - The service encountered an unexpected condition and cannot fulfill your request.

ForbiddenException - You don't have permissions for this action with the credentials you sent.

NotFoundException - The resource you requested does not exist.

TooManyRequestsException - Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests.

ConflictException - The service could not complete your request because there is a conflict with the current state of the resource.

See Also:

AWS API Documentation

deletePreset

public DeletePresetResult deletePreset(DeletePresetRequest request)

Permanently delete a preset you have created.

Specified by:

deletePreset in interface AWSMediaConvert

Parameters:

deletePresetRequest -

Returns:

Result of the DeletePreset operation returned by the service.

Throws:

BadRequestException - The service can't process your request because of a problem in the request. Please check your request form and syntax.

InternalServerErrorException - The service encountered an unexpected condition and cannot fulfill your request.

ForbiddenException - You don't have permissions for this action with the credentials you sent.

NotFoundException - The resource you requested does not exist.

TooManyRequestsException - Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests.

ConflictException - The service could not complete your request because there is a conflict with the current state of the resource.

See Also:

AWS API Documentation

deleteQueue

public DeleteQueueResult deleteQueue(DeleteQueueRequest request)

Permanently delete a queue you have created.

Specified by:

deleteQueue in interface AWSMediaConvert

Parameters:

deleteQueueRequest -

Returns:

Result of the DeleteQueue operation returned by the service.

Throws:

BadRequestException - The service can't process your request because of a problem in the request. Please check your request form and syntax.

InternalServerErrorException - The service encountered an unexpected condition and cannot fulfill your request.

ForbiddenException - You don't have permissions for this action with the credentials you sent.

NotFoundException - The resource you requested does not exist.

TooManyRequestsException - Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests.

ConflictException - The service could not complete your request because there is a conflict with the current state of the resource.

See Also:

AWS API Documentation

describeEndpoints

public DescribeEndpointsResult describeEndpoints(DescribeEndpointsRequest request)

Send an request with an empty body to the regional API endpoint to get your account API endpoint.

Specified by:

describeEndpoints in interface AWSMediaConvert

Parameters:

describeEndpointsRequest - DescribeEndpointsRequest

Returns:

Result of the DescribeEndpoints operation returned by the service.

Throws:

BadRequestException - BadRequestException

InternalServerErrorException - InternalServiceException

ForbiddenException - AccessDeniedException

NotFoundException - ResourceNotFoundException

TooManyRequestsException - LimitExceededException

ConflictException - ResourceInUseException

See Also:

AWS API Documentation

getJob

public GetJobResult getJob(GetJobRequest request)

Retrieve the JSON for a specific completed transcoding job.

Specified by:

getJob in interface AWSMediaConvert

Parameters:

getJobRequest -

Returns:

Result of the GetJob operation returned by the service.

Throws:

BadRequestException - The service can't process your request because of a problem in the request. Please check your request form and syntax.

InternalServerErrorException - The service encountered an unexpected condition and cannot fulfill your request.

ForbiddenException - You don't have permissions for this action with the credentials you sent.

NotFoundException - The resource you requested does not exist.

TooManyRequestsException - Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests.

ConflictException - The service could not complete your request because there is a conflict with the current state of the resource.

See Also:

AWS API Documentation

getJobTemplate

public GetJobTemplateResult getJobTemplate(GetJobTemplateRequest request)

Retrieve the JSON for a specific job template.

Specified by:

getJobTemplate in interface AWSMediaConvert

Parameters:

getJobTemplateRequest -

Returns:

Result of the GetJobTemplate operation returned by the service.

Throws:

BadRequestException - The service can't process your request because of a problem in the request. Please check your request form and syntax.

InternalServerErrorException - The service encountered an unexpected condition and cannot fulfill your request.

ForbiddenException - You don't have permissions for this action with the credentials you sent.

NotFoundException - The resource you requested does not exist.

TooManyRequestsException - Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests.

ConflictException - The service could not complete your request because there is a conflict with the current state of the resource.

See Also:

AWS API Documentation

getPreset

public GetPresetResult getPreset(GetPresetRequest request)

Retrieve the JSON for a specific preset.

Specified by:

getPreset in interface AWSMediaConvert

Parameters:

getPresetRequest -

Returns:

Result of the GetPreset operation returned by the service.

Throws:

BadRequestException - The service can't process your request because of a problem in the request. Please check your request form and syntax.

InternalServerErrorException - The service encountered an unexpected condition and cannot fulfill your request.

ForbiddenException - You don't have permissions for this action with the credentials you sent.

NotFoundException - The resource you requested does not exist.

TooManyRequestsException - Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests.

ConflictException - The service could not complete your request because there is a conflict with the current state of the resource.

See Also:

AWS API Documentation

getQueue

public GetQueueResult getQueue(GetQueueRequest request)

Retrieve the JSON for a specific queue.

Specified by:

getQueue in interface AWSMediaConvert

Parameters:

getQueueRequest -

Returns:

Result of the GetQueue operation returned by the service.

Throws:

BadRequestException - The service can't process your request because of a problem in the request. Please check your request form and syntax.

InternalServerErrorException - The service encountered an unexpected condition and cannot fulfill your request.

ForbiddenException - You don't have permissions for this action with the credentials you sent.

NotFoundException - The resource you requested does not exist.

TooManyRequestsException - Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests.

ConflictException - The service could not complete your request because there is a conflict with the current state of the resource.

See Also:

AWS API Documentation

listJobTemplates

public ListJobTemplatesResult listJobTemplates(ListJobTemplatesRequest request)

Retrieve a JSON array of up to twenty of your job templates. This will return the templates themselves, not just a list of them. To retrieve the next twenty templates, use the nextToken string returned with the array

Specified by:

listJobTemplates in interface AWSMediaConvert

Parameters:

listJobTemplatesRequest -

Returns:

Result of the ListJobTemplates operation returned by the service.

Throws:

BadRequestException - The service can't process your request because of a problem in the request. Please check your request form and syntax.

InternalServerErrorException - The service encountered an unexpected condition and cannot fulfill your request.

ForbiddenException - You don't have permissions for this action with the credentials you sent.

NotFoundException - The resource you requested does not exist.

TooManyRequestsException - Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests.

ConflictException - The service could not complete your request because there is a conflict with the current state of the resource.

See Also:

AWS API Documentation

listJobs

public ListJobsResult listJobs(ListJobsRequest request)

Retrieve a JSON array of up to twenty of your most recently created jobs. This array includes in-process, completed, and errored jobs. This will return the jobs themselves, not just a list of the jobs. To retrieve the twenty next most recent jobs, use the nextToken string returned with the array.

Specified by:

listJobs in interface AWSMediaConvert

Parameters:

listJobsRequest -

Returns:

Result of the ListJobs operation returned by the service.

Throws:

BadRequestException - The service can't process your request because of a problem in the request. Please check your request form and syntax.

InternalServerErrorException - The service encountered an unexpected condition and cannot fulfill your request.

ForbiddenException - You don't have permissions for this action with the credentials you sent.

NotFoundException - The resource you requested does not exist.

TooManyRequestsException - Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests.

ConflictException - The service could not complete your request because there is a conflict with the current state of the resource.

See Also:

AWS API Documentation

listPresets

public ListPresetsResult listPresets(ListPresetsRequest request)

Retrieve a JSON array of up to twenty of your presets. This will return the presets themselves, not just a list of them. To retrieve the next twenty presets, use the nextToken string returned with the array.

Specified by:

listPresets in interface AWSMediaConvert

Parameters:

listPresetsRequest -

Returns:

Result of the ListPresets operation returned by the service.

Throws:

BadRequestException - The service can't process your request because of a problem in the request. Please check your request form and syntax.

InternalServerErrorException - The service encountered an unexpected condition and cannot fulfill your request.

ForbiddenException - You don't have permissions for this action with the credentials you sent.

NotFoundException - The resource you requested does not exist.

TooManyRequestsException - Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests.

ConflictException - The service could not complete your request because there is a conflict with the current state of the resource.

See Also:

AWS API Documentation

listQueues

public ListQueuesResult listQueues(ListQueuesRequest request)

Retrieve a JSON array of up to twenty of your queues. This will return the queues themselves, not just a list of them. To retrieve the next twenty queues, use the nextToken string returned with the array.

Specified by:

listQueues in interface AWSMediaConvert

Parameters:

listQueuesRequest -

Returns:

Result of the ListQueues operation returned by the service.

Throws:

BadRequestException - The service can't process your request because of a problem in the request. Please check your request form and syntax.

InternalServerErrorException - The service encountered an unexpected condition and cannot fulfill your request.

ForbiddenException - You don't have permissions for this action with the credentials you sent.

NotFoundException - The resource you requested does not exist.

TooManyRequestsException - Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests.

ConflictException - The service could not complete your request because there is a conflict with the current state of the resource.

See Also:

AWS API Documentation

updateJobTemplate

public UpdateJobTemplateResult updateJobTemplate(UpdateJobTemplateRequest request)

Modify one of your existing job templates.

Specified by:

updateJobTemplate in interface AWSMediaConvert

Parameters:

updateJobTemplateRequest -

Returns:

Result of the UpdateJobTemplate operation returned by the service.

Throws:

BadRequestException - The service can't process your request because of a problem in the request. Please check your request form and syntax.

InternalServerErrorException - The service encountered an unexpected condition and cannot fulfill your request.

ForbiddenException - You don't have permissions for this action with the credentials you sent.

NotFoundException - The resource you requested does not exist.

TooManyRequestsException - Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests.

ConflictException - The service could not complete your request because there is a conflict with the current state of the resource.

See Also:

AWS API Documentation

updatePreset

public UpdatePresetResult updatePreset(UpdatePresetRequest request)

Modify one of your existing presets.

Specified by:

updatePreset in interface AWSMediaConvert

Parameters:

updatePresetRequest -

Returns:

Result of the UpdatePreset operation returned by the service.

Throws:

BadRequestException - The service can't process your request because of a problem in the request. Please check your request form and syntax.

InternalServerErrorException - The service encountered an unexpected condition and cannot fulfill your request.

ForbiddenException - You don't have permissions for this action with the credentials you sent.

NotFoundException - The resource you requested does not exist.

TooManyRequestsException - Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests.

ConflictException - The service could not complete your request because there is a conflict with the current state of the resource.

See Also:

AWS API Documentation

updateQueue

public UpdateQueueResult updateQueue(UpdateQueueRequest request)

Modify one of your existing queues.

Specified by:

updateQueue in interface AWSMediaConvert

Parameters:

updateQueueRequest -

Returns:

Result of the UpdateQueue operation returned by the service.

Throws:

BadRequestException - The service can't process your request because of a problem in the request. Please check your request form and syntax.

InternalServerErrorException - The service encountered an unexpected condition and cannot fulfill your request.

ForbiddenException - You don't have permissions for this action with the credentials you sent.

NotFoundException - The resource you requested does not exist.

TooManyRequestsException - Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests.

ConflictException - The service could not complete your request because there is a conflict with the current state of the resource.

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 AWSMediaConvert

Parameters:

request - The originally executed request

Returns:

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