@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonElasticTranscoderClient extends AmazonWebServiceClient implements AmazonElasticTranscoder
The AWS Elastic Transcoder Service.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Constructor and Description |
|---|
AmazonElasticTranscoderClient()
Deprecated.
|
AmazonElasticTranscoderClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AmazonElasticTranscoderClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AmazonElasticTranscoderClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AmazonElasticTranscoderClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AmazonElasticTranscoderClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AmazonElasticTranscoderClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AmazonElasticTranscoderClient(ClientConfiguration clientConfiguration)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static AmazonElasticTranscoderClientBuilder |
builder() |
CancelJobResult |
cancelJob(CancelJobRequest request)
The CancelJob operation cancels an unfinished job.
|
CreateJobResult |
createJob(CreateJobRequest request)
When you create a job, Elastic Transcoder returns JSON data that includes the values that you specified plus
information about the job that is created.
|
CreatePipelineResult |
createPipeline(CreatePipelineRequest request)
The CreatePipeline operation creates a pipeline with settings that you specify.
|
CreatePresetResult |
createPreset(CreatePresetRequest request)
The CreatePreset operation creates a preset with settings that you specify.
|
DeletePipelineResult |
deletePipeline(DeletePipelineRequest request)
The DeletePipeline operation removes a pipeline.
|
DeletePresetResult |
deletePreset(DeletePresetRequest request)
The DeletePreset operation removes a preset that you've added in an AWS region.
|
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.
|
ListJobsByPipelineResult |
listJobsByPipeline(ListJobsByPipelineRequest request)
The ListJobsByPipeline operation gets a list of the jobs currently in a pipeline.
|
ListJobsByStatusResult |
listJobsByStatus(ListJobsByStatusRequest request)
The ListJobsByStatus operation gets a list of jobs that have a specified status.
|
ListPipelinesResult |
listPipelines()
Simplified method form for invoking the ListPipelines operation.
|
ListPipelinesResult |
listPipelines(ListPipelinesRequest request)
The ListPipelines operation gets a list of the pipelines associated with the current AWS account.
|
ListPresetsResult |
listPresets()
Simplified method form for invoking the ListPresets operation.
|
ListPresetsResult |
listPresets(ListPresetsRequest request)
The ListPresets operation gets a list of the default presets included with Elastic Transcoder and the presets
that you've added in an AWS region.
|
ReadJobResult |
readJob(ReadJobRequest request)
The ReadJob operation returns detailed information about a job.
|
ReadPipelineResult |
readPipeline(ReadPipelineRequest request)
The ReadPipeline operation gets detailed information about a pipeline.
|
ReadPresetResult |
readPreset(ReadPresetRequest request)
The ReadPreset operation gets detailed information about a preset.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
TestRoleResult |
testRole(TestRoleRequest request)
Deprecated.
|
UpdatePipelineResult |
updatePipeline(UpdatePipelineRequest request)
Use the
UpdatePipeline operation to update settings for a pipeline. |
UpdatePipelineNotificationsResult |
updatePipelineNotifications(UpdatePipelineNotificationsRequest request)
With the UpdatePipelineNotifications operation, you can update Amazon Simple Notification Service (Amazon SNS)
notifications for a pipeline.
|
UpdatePipelineStatusResult |
updatePipelineStatus(UpdatePipelineStatusRequest request)
The UpdatePipelineStatus operation pauses or reactivates a pipeline, so that the pipeline stops or restarts the
processing of jobs.
|
AmazonElasticTranscoderWaiters |
waiters() |
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion@Deprecated public AmazonElasticTranscoderClient()
AmazonElasticTranscoderClientBuilder.defaultClient()All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain@Deprecated public AmazonElasticTranscoderClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration - The client configuration options controlling how this client connects to Amazon Elastic Transcoder (ex:
proxy settings, retry counts, etc.).DefaultAWSCredentialsProviderChain@Deprecated public AmazonElasticTranscoderClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AmazonElasticTranscoderClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.@Deprecated public AmazonElasticTranscoderClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration - The client configuration options controlling how this client connects to Amazon Elastic Transcoder (ex:
proxy settings, retry counts, etc.).@Deprecated public AmazonElasticTranscoderClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.@Deprecated public AmazonElasticTranscoderClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client connects to Amazon Elastic Transcoder (ex:
proxy settings, retry counts, etc.).@Deprecated public AmazonElasticTranscoderClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsClientBuilder.withMetricsCollector(RequestMetricCollector)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client connects to Amazon Elastic Transcoder (ex:
proxy settings, retry counts, etc.).requestMetricCollector - optional request metric collectorpublic static AmazonElasticTranscoderClientBuilder builder()
public CancelJobResult cancelJob(CancelJobRequest request)
The CancelJob operation cancels an unfinished job.
You can only cancel a job that has a status of Submitted. To prevent a pipeline from starting to
process a job while you're getting the job identifier, use UpdatePipelineStatus to temporarily pause the
pipeline.
cancelJob in interface AmazonElasticTranscodercancelJobRequest - The CancelJobRequest structure.ValidationException - One or more required parameter values were not provided in the request.IncompatibleVersionExceptionResourceNotFoundException - The requested resource does not exist or is not available. For example, the pipeline to which you're
trying to add a job doesn't exist or is still being created.ResourceInUseException - The resource you are attempting to change is in use. For example, you are attempting to delete a pipeline
that is currently in use.AccessDeniedException - General authentication failure. The request was not signed correctly.InternalServiceException - Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.public CreateJobResult createJob(CreateJobRequest request)
When you create a job, Elastic Transcoder returns JSON data that includes the values that you specified plus information about the job that is created.
If you have specified more than one output for your jobs (for example, one output for the Kindle Fire and another output for the Apple iPhone 4s), you currently must use the Elastic Transcoder API to list the jobs (as opposed to the AWS Console).
createJob in interface AmazonElasticTranscodercreateJobRequest - The CreateJobRequest structure.ValidationException - One or more required parameter values were not provided in the request.IncompatibleVersionExceptionResourceNotFoundException - The requested resource does not exist or is not available. For example, the pipeline to which you're
trying to add a job doesn't exist or is still being created.AccessDeniedException - General authentication failure. The request was not signed correctly.LimitExceededException - Too many operations for a given AWS account. For example, the number of pipelines exceeds the maximum
allowed.InternalServiceException - Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.public CreatePipelineResult createPipeline(CreatePipelineRequest request)
The CreatePipeline operation creates a pipeline with settings that you specify.
createPipeline in interface AmazonElasticTranscodercreatePipelineRequest - The CreatePipelineRequest structure.ValidationException - One or more required parameter values were not provided in the request.IncompatibleVersionExceptionAccessDeniedException - General authentication failure. The request was not signed correctly.ResourceNotFoundException - The requested resource does not exist or is not available. For example, the pipeline to which you're
trying to add a job doesn't exist or is still being created.LimitExceededException - Too many operations for a given AWS account. For example, the number of pipelines exceeds the maximum
allowed.InternalServiceException - Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.public CreatePresetResult createPreset(CreatePresetRequest request)
The CreatePreset operation creates a preset with settings that you specify.
Elastic Transcoder checks the CreatePreset settings to ensure that they meet Elastic Transcoder requirements and
to determine whether they comply with H.264 standards. If your settings are not valid for Elastic Transcoder,
Elastic Transcoder returns an HTTP 400 response (ValidationException) and does not create the
preset. If the settings are valid for Elastic Transcoder but aren't strictly compliant with the H.264 standard,
Elastic Transcoder creates the preset and returns a warning message in the response. This helps you determine
whether your settings comply with the H.264 standard while giving you greater flexibility with respect to the
video that Elastic Transcoder produces.
Elastic Transcoder uses the H.264 video-compression format. For more information, see the International Telecommunication Union publication Recommendation ITU-T H.264: Advanced video coding for generic audiovisual services.
createPreset in interface AmazonElasticTranscodercreatePresetRequest - The CreatePresetRequest structure.ValidationException - One or more required parameter values were not provided in the request.IncompatibleVersionExceptionAccessDeniedException - General authentication failure. The request was not signed correctly.LimitExceededException - Too many operations for a given AWS account. For example, the number of pipelines exceeds the maximum
allowed.InternalServiceException - Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.public DeletePipelineResult deletePipeline(DeletePipelineRequest request)
The DeletePipeline operation removes a pipeline.
You can only delete a pipeline that has never been used or that is not currently in use (doesn't contain any
active jobs). If the pipeline is currently in use, DeletePipeline returns an error.
deletePipeline in interface AmazonElasticTranscoderdeletePipelineRequest - The DeletePipelineRequest structure.ValidationException - One or more required parameter values were not provided in the request.IncompatibleVersionExceptionResourceNotFoundException - The requested resource does not exist or is not available. For example, the pipeline to which you're
trying to add a job doesn't exist or is still being created.ResourceInUseException - The resource you are attempting to change is in use. For example, you are attempting to delete a pipeline
that is currently in use.AccessDeniedException - General authentication failure. The request was not signed correctly.InternalServiceException - Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.public DeletePresetResult deletePreset(DeletePresetRequest request)
The DeletePreset operation removes a preset that you've added in an AWS region.
You can't delete the default presets that are included with Elastic Transcoder.
deletePreset in interface AmazonElasticTranscoderdeletePresetRequest - The DeletePresetRequest structure.ValidationException - One or more required parameter values were not provided in the request.IncompatibleVersionExceptionResourceNotFoundException - The requested resource does not exist or is not available. For example, the pipeline to which you're
trying to add a job doesn't exist or is still being created.AccessDeniedException - General authentication failure. The request was not signed correctly.InternalServiceException - Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.public ListJobsByPipelineResult listJobsByPipeline(ListJobsByPipelineRequest request)
The ListJobsByPipeline operation gets a list of the jobs currently in a pipeline.
Elastic Transcoder returns all of the jobs currently in the specified pipeline. The response body contains one element for each job that satisfies the search criteria.
listJobsByPipeline in interface AmazonElasticTranscoderlistJobsByPipelineRequest - The ListJobsByPipelineRequest structure.ValidationException - One or more required parameter values were not provided in the request.IncompatibleVersionExceptionResourceNotFoundException - The requested resource does not exist or is not available. For example, the pipeline to which you're
trying to add a job doesn't exist or is still being created.AccessDeniedException - General authentication failure. The request was not signed correctly.InternalServiceException - Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.public ListJobsByStatusResult listJobsByStatus(ListJobsByStatusRequest request)
The ListJobsByStatus operation gets a list of jobs that have a specified status. The response body contains one element for each job that satisfies the search criteria.
listJobsByStatus in interface AmazonElasticTranscoderlistJobsByStatusRequest - The ListJobsByStatusRequest structure.ValidationException - One or more required parameter values were not provided in the request.IncompatibleVersionExceptionResourceNotFoundException - The requested resource does not exist or is not available. For example, the pipeline to which you're
trying to add a job doesn't exist or is still being created.AccessDeniedException - General authentication failure. The request was not signed correctly.InternalServiceException - Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.public ListPipelinesResult listPipelines(ListPipelinesRequest request)
The ListPipelines operation gets a list of the pipelines associated with the current AWS account.
listPipelines in interface AmazonElasticTranscoderlistPipelinesRequest - The ListPipelineRequest structure.ValidationException - One or more required parameter values were not provided in the request.IncompatibleVersionExceptionAccessDeniedException - General authentication failure. The request was not signed correctly.InternalServiceException - Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.public ListPipelinesResult listPipelines()
AmazonElasticTranscoderlistPipelines in interface AmazonElasticTranscoderAmazonElasticTranscoder.listPipelines(ListPipelinesRequest)public ListPresetsResult listPresets(ListPresetsRequest request)
The ListPresets operation gets a list of the default presets included with Elastic Transcoder and the presets that you've added in an AWS region.
listPresets in interface AmazonElasticTranscoderlistPresetsRequest - The ListPresetsRequest structure.ValidationException - One or more required parameter values were not provided in the request.IncompatibleVersionExceptionAccessDeniedException - General authentication failure. The request was not signed correctly.InternalServiceException - Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.public ListPresetsResult listPresets()
AmazonElasticTranscoderlistPresets in interface AmazonElasticTranscoderAmazonElasticTranscoder.listPresets(ListPresetsRequest)public ReadJobResult readJob(ReadJobRequest request)
The ReadJob operation returns detailed information about a job.
readJob in interface AmazonElasticTranscoderreadJobRequest - The ReadJobRequest structure.ValidationException - One or more required parameter values were not provided in the request.IncompatibleVersionExceptionResourceNotFoundException - The requested resource does not exist or is not available. For example, the pipeline to which you're
trying to add a job doesn't exist or is still being created.AccessDeniedException - General authentication failure. The request was not signed correctly.InternalServiceException - Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.public ReadPipelineResult readPipeline(ReadPipelineRequest request)
The ReadPipeline operation gets detailed information about a pipeline.
readPipeline in interface AmazonElasticTranscoderreadPipelineRequest - The ReadPipelineRequest structure.ValidationException - One or more required parameter values were not provided in the request.IncompatibleVersionExceptionResourceNotFoundException - The requested resource does not exist or is not available. For example, the pipeline to which you're
trying to add a job doesn't exist or is still being created.AccessDeniedException - General authentication failure. The request was not signed correctly.InternalServiceException - Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.public ReadPresetResult readPreset(ReadPresetRequest request)
The ReadPreset operation gets detailed information about a preset.
readPreset in interface AmazonElasticTranscoderreadPresetRequest - The ReadPresetRequest structure.ValidationException - One or more required parameter values were not provided in the request.IncompatibleVersionExceptionResourceNotFoundException - The requested resource does not exist or is not available. For example, the pipeline to which you're
trying to add a job doesn't exist or is still being created.AccessDeniedException - General authentication failure. The request was not signed correctly.InternalServiceException - Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.@Deprecated public TestRoleResult testRole(TestRoleRequest request)
The TestRole operation tests the IAM role used to create the pipeline.
The TestRole action lets you determine whether the IAM role you are using has sufficient permissions
to let Elastic Transcoder perform tasks associated with the transcoding process. The action attempts to assume
the specified IAM role, checks read access to the input and output buckets, and tries to send a test notification
to Amazon SNS topics that you specify.
testRole in interface AmazonElasticTranscodertestRoleRequest - The TestRoleRequest structure.ValidationException - One or more required parameter values were not provided in the request.IncompatibleVersionExceptionResourceNotFoundException - The requested resource does not exist or is not available. For example, the pipeline to which you're
trying to add a job doesn't exist or is still being created.AccessDeniedException - General authentication failure. The request was not signed correctly.InternalServiceException - Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.public UpdatePipelineResult updatePipeline(UpdatePipelineRequest request)
Use the UpdatePipeline operation to update settings for a pipeline.
When you change pipeline settings, your changes take effect immediately. Jobs that you have already submitted and that Elastic Transcoder has not started to process are affected in addition to jobs that you submit after you change settings.
updatePipeline in interface AmazonElasticTranscoderupdatePipelineRequest - The UpdatePipelineRequest structure.ValidationException - One or more required parameter values were not provided in the request.IncompatibleVersionExceptionAccessDeniedException - General authentication failure. The request was not signed correctly.ResourceInUseException - The resource you are attempting to change is in use. For example, you are attempting to delete a pipeline
that is currently in use.ResourceNotFoundException - The requested resource does not exist or is not available. For example, the pipeline to which you're
trying to add a job doesn't exist or is still being created.InternalServiceException - Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.public UpdatePipelineNotificationsResult updatePipelineNotifications(UpdatePipelineNotificationsRequest request)
With the UpdatePipelineNotifications operation, you can update Amazon Simple Notification Service (Amazon SNS) notifications for a pipeline.
When you update notifications for a pipeline, Elastic Transcoder returns the values that you specified in the request.
updatePipelineNotifications in interface AmazonElasticTranscoderupdatePipelineNotificationsRequest - The UpdatePipelineNotificationsRequest structure.ValidationException - One or more required parameter values were not provided in the request.IncompatibleVersionExceptionResourceNotFoundException - The requested resource does not exist or is not available. For example, the pipeline to which you're
trying to add a job doesn't exist or is still being created.ResourceInUseException - The resource you are attempting to change is in use. For example, you are attempting to delete a pipeline
that is currently in use.AccessDeniedException - General authentication failure. The request was not signed correctly.InternalServiceException - Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.public UpdatePipelineStatusResult updatePipelineStatus(UpdatePipelineStatusRequest request)
The UpdatePipelineStatus operation pauses or reactivates a pipeline, so that the pipeline stops or restarts the processing of jobs.
Changing the pipeline status is useful if you want to cancel one or more jobs. You can't cancel jobs after Elastic Transcoder has started processing them; if you pause the pipeline to which you submitted the jobs, you have more time to get the job IDs for the jobs that you want to cancel, and to send a CancelJob request.
updatePipelineStatus in interface AmazonElasticTranscoderupdatePipelineStatusRequest - The UpdatePipelineStatusRequest structure.ValidationException - One or more required parameter values were not provided in the request.IncompatibleVersionExceptionResourceNotFoundException - The requested resource does not exist or is not available. For example, the pipeline to which you're
trying to add a job doesn't exist or is still being created.ResourceInUseException - The resource you are attempting to change is in use. For example, you are attempting to delete a pipeline
that is currently in use.AccessDeniedException - General authentication failure. The request was not signed correctly.InternalServiceException - Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
getCachedResponseMetadata in interface AmazonElasticTranscoderrequest - The originally executed requestpublic AmazonElasticTranscoderWaiters waiters()
waiters in interface AmazonElasticTranscoderpublic void shutdown()
AmazonWebServiceClientshutdown in interface AmazonElasticTranscodershutdown in class AmazonWebServiceClient