com.amazonaws.services.mediaconvert.AWSMediaConvert Maven / Gradle / Ivy
/*
* Copyright 2013-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.mediaconvert;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.mediaconvert.model.*;
/**
* Interface for accessing MediaConvert.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.mediaconvert.AbstractAWSMediaConvert} instead.
*
*
* AWS Elemental MediaConvert
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSMediaConvert {
/**
* 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 RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "mediaconvert";
/**
* 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.
*
* @param cancelJobRequest
* @return 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.
* @throws InternalServerErrorException
* The service encountered an unexpected condition and cannot fulfill your request.
* @throws ForbiddenException
* You don't have permissions for this action with the credentials you sent.
* @throws NotFoundException
* The resource you requested does not exist.
* @throws TooManyRequestsException
* Too many requests have been sent in too short of a time. The service limits the rate at which it will
* accept requests.
* @throws ConflictException
* The service could not complete your request because there is a conflict with the current state of the
* resource.
* @sample AWSMediaConvert.CancelJob
* @see AWS API
* Documentation
*/
CancelJobResult cancelJob(CancelJobRequest cancelJobRequest);
/**
* 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
*
* @param createJobRequest
* @return 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.
* @throws InternalServerErrorException
* The service encountered an unexpected condition and cannot fulfill your request.
* @throws ForbiddenException
* You don't have permissions for this action with the credentials you sent.
* @throws NotFoundException
* The resource you requested does not exist.
* @throws TooManyRequestsException
* Too many requests have been sent in too short of a time. The service limits the rate at which it will
* accept requests.
* @throws ConflictException
* The service could not complete your request because there is a conflict with the current state of the
* resource.
* @sample AWSMediaConvert.CreateJob
* @see AWS API
* Documentation
*/
CreateJobResult createJob(CreateJobRequest createJobRequest);
/**
* 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
*
* @param createJobTemplateRequest
* @return 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.
* @throws InternalServerErrorException
* The service encountered an unexpected condition and cannot fulfill your request.
* @throws ForbiddenException
* You don't have permissions for this action with the credentials you sent.
* @throws NotFoundException
* The resource you requested does not exist.
* @throws TooManyRequestsException
* Too many requests have been sent in too short of a time. The service limits the rate at which it will
* accept requests.
* @throws ConflictException
* The service could not complete your request because there is a conflict with the current state of the
* resource.
* @sample AWSMediaConvert.CreateJobTemplate
* @see AWS
* API Documentation
*/
CreateJobTemplateResult createJobTemplate(CreateJobTemplateRequest createJobTemplateRequest);
/**
* 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
*
* @param createPresetRequest
* @return 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.
* @throws InternalServerErrorException
* The service encountered an unexpected condition and cannot fulfill your request.
* @throws ForbiddenException
* You don't have permissions for this action with the credentials you sent.
* @throws NotFoundException
* The resource you requested does not exist.
* @throws TooManyRequestsException
* Too many requests have been sent in too short of a time. The service limits the rate at which it will
* accept requests.
* @throws ConflictException
* The service could not complete your request because there is a conflict with the current state of the
* resource.
* @sample AWSMediaConvert.CreatePreset
* @see AWS API
* Documentation
*/
CreatePresetResult createPreset(CreatePresetRequest createPresetRequest);
/**
* 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
*
* @param createQueueRequest
* @return 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.
* @throws InternalServerErrorException
* The service encountered an unexpected condition and cannot fulfill your request.
* @throws ForbiddenException
* You don't have permissions for this action with the credentials you sent.
* @throws NotFoundException
* The resource you requested does not exist.
* @throws TooManyRequestsException
* Too many requests have been sent in too short of a time. The service limits the rate at which it will
* accept requests.
* @throws ConflictException
* The service could not complete your request because there is a conflict with the current state of the
* resource.
* @sample AWSMediaConvert.CreateQueue
* @see AWS API
* Documentation
*/
CreateQueueResult createQueue(CreateQueueRequest createQueueRequest);
/**
* Permanently delete a job template you have created.
*
* @param deleteJobTemplateRequest
* @return 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.
* @throws InternalServerErrorException
* The service encountered an unexpected condition and cannot fulfill your request.
* @throws ForbiddenException
* You don't have permissions for this action with the credentials you sent.
* @throws NotFoundException
* The resource you requested does not exist.
* @throws TooManyRequestsException
* Too many requests have been sent in too short of a time. The service limits the rate at which it will
* accept requests.
* @throws ConflictException
* The service could not complete your request because there is a conflict with the current state of the
* resource.
* @sample AWSMediaConvert.DeleteJobTemplate
* @see AWS
* API Documentation
*/
DeleteJobTemplateResult deleteJobTemplate(DeleteJobTemplateRequest deleteJobTemplateRequest);
/**
* Permanently delete a preset you have created.
*
* @param deletePresetRequest
* @return 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.
* @throws InternalServerErrorException
* The service encountered an unexpected condition and cannot fulfill your request.
* @throws ForbiddenException
* You don't have permissions for this action with the credentials you sent.
* @throws NotFoundException
* The resource you requested does not exist.
* @throws TooManyRequestsException
* Too many requests have been sent in too short of a time. The service limits the rate at which it will
* accept requests.
* @throws ConflictException
* The service could not complete your request because there is a conflict with the current state of the
* resource.
* @sample AWSMediaConvert.DeletePreset
* @see AWS API
* Documentation
*/
DeletePresetResult deletePreset(DeletePresetRequest deletePresetRequest);
/**
* Permanently delete a queue you have created.
*
* @param deleteQueueRequest
* @return 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.
* @throws InternalServerErrorException
* The service encountered an unexpected condition and cannot fulfill your request.
* @throws ForbiddenException
* You don't have permissions for this action with the credentials you sent.
* @throws NotFoundException
* The resource you requested does not exist.
* @throws TooManyRequestsException
* Too many requests have been sent in too short of a time. The service limits the rate at which it will
* accept requests.
* @throws ConflictException
* The service could not complete your request because there is a conflict with the current state of the
* resource.
* @sample AWSMediaConvert.DeleteQueue
* @see AWS API
* Documentation
*/
DeleteQueueResult deleteQueue(DeleteQueueRequest deleteQueueRequest);
/**
* Send an request with an empty body to the regional API endpoint to get your account API endpoint.
*
* @param describeEndpointsRequest
* DescribeEndpointsRequest
* @return Result of the DescribeEndpoints operation returned by the service.
* @throws BadRequestException
* BadRequestException
* @throws InternalServerErrorException
* InternalServiceException
* @throws ForbiddenException
* AccessDeniedException
* @throws NotFoundException
* ResourceNotFoundException
* @throws TooManyRequestsException
* LimitExceededException
* @throws ConflictException
* ResourceInUseException
* @sample AWSMediaConvert.DescribeEndpoints
* @see AWS
* API Documentation
*/
DescribeEndpointsResult describeEndpoints(DescribeEndpointsRequest describeEndpointsRequest);
/**
* Retrieve the JSON for a specific completed transcoding job.
*
* @param getJobRequest
* @return 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.
* @throws InternalServerErrorException
* The service encountered an unexpected condition and cannot fulfill your request.
* @throws ForbiddenException
* You don't have permissions for this action with the credentials you sent.
* @throws NotFoundException
* The resource you requested does not exist.
* @throws TooManyRequestsException
* Too many requests have been sent in too short of a time. The service limits the rate at which it will
* accept requests.
* @throws ConflictException
* The service could not complete your request because there is a conflict with the current state of the
* resource.
* @sample AWSMediaConvert.GetJob
* @see AWS API
* Documentation
*/
GetJobResult getJob(GetJobRequest getJobRequest);
/**
* Retrieve the JSON for a specific job template.
*
* @param getJobTemplateRequest
* @return 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.
* @throws InternalServerErrorException
* The service encountered an unexpected condition and cannot fulfill your request.
* @throws ForbiddenException
* You don't have permissions for this action with the credentials you sent.
* @throws NotFoundException
* The resource you requested does not exist.
* @throws TooManyRequestsException
* Too many requests have been sent in too short of a time. The service limits the rate at which it will
* accept requests.
* @throws ConflictException
* The service could not complete your request because there is a conflict with the current state of the
* resource.
* @sample AWSMediaConvert.GetJobTemplate
* @see AWS
* API Documentation
*/
GetJobTemplateResult getJobTemplate(GetJobTemplateRequest getJobTemplateRequest);
/**
* Retrieve the JSON for a specific preset.
*
* @param getPresetRequest
* @return 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.
* @throws InternalServerErrorException
* The service encountered an unexpected condition and cannot fulfill your request.
* @throws ForbiddenException
* You don't have permissions for this action with the credentials you sent.
* @throws NotFoundException
* The resource you requested does not exist.
* @throws TooManyRequestsException
* Too many requests have been sent in too short of a time. The service limits the rate at which it will
* accept requests.
* @throws ConflictException
* The service could not complete your request because there is a conflict with the current state of the
* resource.
* @sample AWSMediaConvert.GetPreset
* @see AWS API
* Documentation
*/
GetPresetResult getPreset(GetPresetRequest getPresetRequest);
/**
* Retrieve the JSON for a specific queue.
*
* @param getQueueRequest
* @return 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.
* @throws InternalServerErrorException
* The service encountered an unexpected condition and cannot fulfill your request.
* @throws ForbiddenException
* You don't have permissions for this action with the credentials you sent.
* @throws NotFoundException
* The resource you requested does not exist.
* @throws TooManyRequestsException
* Too many requests have been sent in too short of a time. The service limits the rate at which it will
* accept requests.
* @throws ConflictException
* The service could not complete your request because there is a conflict with the current state of the
* resource.
* @sample AWSMediaConvert.GetQueue
* @see AWS API
* Documentation
*/
GetQueueResult getQueue(GetQueueRequest getQueueRequest);
/**
* 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
*
* @param listJobTemplatesRequest
* @return 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.
* @throws InternalServerErrorException
* The service encountered an unexpected condition and cannot fulfill your request.
* @throws ForbiddenException
* You don't have permissions for this action with the credentials you sent.
* @throws NotFoundException
* The resource you requested does not exist.
* @throws TooManyRequestsException
* Too many requests have been sent in too short of a time. The service limits the rate at which it will
* accept requests.
* @throws ConflictException
* The service could not complete your request because there is a conflict with the current state of the
* resource.
* @sample AWSMediaConvert.ListJobTemplates
* @see AWS
* API Documentation
*/
ListJobTemplatesResult listJobTemplates(ListJobTemplatesRequest listJobTemplatesRequest);
/**
* 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.
*
* @param listJobsRequest
* @return 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.
* @throws InternalServerErrorException
* The service encountered an unexpected condition and cannot fulfill your request.
* @throws ForbiddenException
* You don't have permissions for this action with the credentials you sent.
* @throws NotFoundException
* The resource you requested does not exist.
* @throws TooManyRequestsException
* Too many requests have been sent in too short of a time. The service limits the rate at which it will
* accept requests.
* @throws ConflictException
* The service could not complete your request because there is a conflict with the current state of the
* resource.
* @sample AWSMediaConvert.ListJobs
* @see AWS API
* Documentation
*/
ListJobsResult listJobs(ListJobsRequest listJobsRequest);
/**
* 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.
*
* @param listPresetsRequest
* @return 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.
* @throws InternalServerErrorException
* The service encountered an unexpected condition and cannot fulfill your request.
* @throws ForbiddenException
* You don't have permissions for this action with the credentials you sent.
* @throws NotFoundException
* The resource you requested does not exist.
* @throws TooManyRequestsException
* Too many requests have been sent in too short of a time. The service limits the rate at which it will
* accept requests.
* @throws ConflictException
* The service could not complete your request because there is a conflict with the current state of the
* resource.
* @sample AWSMediaConvert.ListPresets
* @see AWS API
* Documentation
*/
ListPresetsResult listPresets(ListPresetsRequest listPresetsRequest);
/**
* 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.
*
* @param listQueuesRequest
* @return 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.
* @throws InternalServerErrorException
* The service encountered an unexpected condition and cannot fulfill your request.
* @throws ForbiddenException
* You don't have permissions for this action with the credentials you sent.
* @throws NotFoundException
* The resource you requested does not exist.
* @throws TooManyRequestsException
* Too many requests have been sent in too short of a time. The service limits the rate at which it will
* accept requests.
* @throws ConflictException
* The service could not complete your request because there is a conflict with the current state of the
* resource.
* @sample AWSMediaConvert.ListQueues
* @see AWS API
* Documentation
*/
ListQueuesResult listQueues(ListQueuesRequest listQueuesRequest);
/**
* Modify one of your existing job templates.
*
* @param updateJobTemplateRequest
* @return 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.
* @throws InternalServerErrorException
* The service encountered an unexpected condition and cannot fulfill your request.
* @throws ForbiddenException
* You don't have permissions for this action with the credentials you sent.
* @throws NotFoundException
* The resource you requested does not exist.
* @throws TooManyRequestsException
* Too many requests have been sent in too short of a time. The service limits the rate at which it will
* accept requests.
* @throws ConflictException
* The service could not complete your request because there is a conflict with the current state of the
* resource.
* @sample AWSMediaConvert.UpdateJobTemplate
* @see AWS
* API Documentation
*/
UpdateJobTemplateResult updateJobTemplate(UpdateJobTemplateRequest updateJobTemplateRequest);
/**
* Modify one of your existing presets.
*
* @param updatePresetRequest
* @return 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.
* @throws InternalServerErrorException
* The service encountered an unexpected condition and cannot fulfill your request.
* @throws ForbiddenException
* You don't have permissions for this action with the credentials you sent.
* @throws NotFoundException
* The resource you requested does not exist.
* @throws TooManyRequestsException
* Too many requests have been sent in too short of a time. The service limits the rate at which it will
* accept requests.
* @throws ConflictException
* The service could not complete your request because there is a conflict with the current state of the
* resource.
* @sample AWSMediaConvert.UpdatePreset
* @see AWS API
* Documentation
*/
UpdatePresetResult updatePreset(UpdatePresetRequest updatePresetRequest);
/**
* Modify one of your existing queues.
*
* @param updateQueueRequest
* @return 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.
* @throws InternalServerErrorException
* The service encountered an unexpected condition and cannot fulfill your request.
* @throws ForbiddenException
* You don't have permissions for this action with the credentials you sent.
* @throws NotFoundException
* The resource you requested does not exist.
* @throws TooManyRequestsException
* Too many requests have been sent in too short of a time. The service limits the rate at which it will
* accept requests.
* @throws ConflictException
* The service could not complete your request because there is a conflict with the current state of the
* resource.
* @sample AWSMediaConvert.UpdateQueue
* @see AWS API
* Documentation
*/
UpdateQueueResult updateQueue(UpdateQueueRequest updateQueueRequest);
/**
* 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.
*/
void shutdown();
/**
* 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}