@ThreadSafe public class AmazonElasticTranscoderClient extends AmazonWebServiceClient implements AmazonElasticTranscoder
The AWS Elastic Transcoder Service.
LOGGING_AWS_REQUEST_METRIC
Constructor and Description |
---|
AmazonElasticTranscoderClient()
Constructs a new client to invoke service methods on Amazon Elastic
Transcoder.
|
AmazonElasticTranscoderClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on Amazon Elastic
Transcoder using the specified AWS account credentials.
|
AmazonElasticTranscoderClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon Elastic
Transcoder using the specified AWS account credentials and client
configuration options.
|
AmazonElasticTranscoderClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on Amazon Elastic
Transcoder using the specified AWS account credentials provider.
|
AmazonElasticTranscoderClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon Elastic
Transcoder using the specified AWS account credentials provider and
client configuration options.
|
AmazonElasticTranscoderClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
Constructs a new client to invoke service methods on Amazon Elastic
Transcoder using the specified AWS account credentials provider, client
configuration options, and request metric collector.
|
AmazonElasticTranscoderClient(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon Elastic
Transcoder.
|
Modifier and Type | Method and Description |
---|---|
CancelJobResult |
cancelJob(CancelJobRequest cancelJobRequest)
The CancelJob operation cancels an unfinished job.
|
CreateJobResult |
createJob(CreateJobRequest createJobRequest)
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 createPipelineRequest)
The CreatePipeline operation creates a pipeline with settings that you
specify.
|
CreatePresetResult |
createPreset(CreatePresetRequest createPresetRequest)
The CreatePreset operation creates a preset with settings that you
specify.
|
DeletePipelineResult |
deletePipeline(DeletePipelineRequest deletePipelineRequest)
The DeletePipeline operation removes a pipeline.
|
DeletePresetResult |
deletePreset(DeletePresetRequest deletePresetRequest)
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 listJobsByPipelineRequest)
The ListJobsByPipeline operation gets a list of the jobs currently in a
pipeline.
|
ListJobsByStatusResult |
listJobsByStatus(ListJobsByStatusRequest listJobsByStatusRequest)
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 listPipelinesRequest)
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 listPresetsRequest)
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 readJobRequest)
The ReadJob operation returns detailed information about a job.
|
ReadPipelineResult |
readPipeline(ReadPipelineRequest readPipelineRequest)
The ReadPipeline operation gets detailed information about a pipeline.
|
ReadPresetResult |
readPreset(ReadPresetRequest readPresetRequest)
The ReadPreset operation gets detailed information about a preset.
|
TestRoleResult |
testRole(TestRoleRequest testRoleRequest)
The TestRole operation tests the IAM role used to create the pipeline.
|
UpdatePipelineResult |
updatePipeline(UpdatePipelineRequest updatePipelineRequest)
Use the
UpdatePipeline operation to update settings for a
pipeline. |
UpdatePipelineNotificationsResult |
updatePipelineNotifications(UpdatePipelineNotificationsRequest updatePipelineNotificationsRequest)
With the UpdatePipelineNotifications operation, you can update Amazon
Simple Notification Service (Amazon SNS) notifications for a pipeline.
|
UpdatePipelineStatusResult |
updatePipelineStatus(UpdatePipelineStatusRequest updatePipelineStatusRequest)
The UpdatePipelineStatus operation pauses or reactivates a pipeline, so
that the pipeline stops or restarts the processing of jobs.
|
addRequestHandler, addRequestHandler, configureRegion, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerRegionOverride, getTimeOffset, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion, shutdown
public AmazonElasticTranscoderClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
public AmazonElasticTranscoderClient(ClientConfiguration 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
public AmazonElasticTranscoderClient(AWSCredentials awsCredentials)
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.public AmazonElasticTranscoderClient(AWSCredentials awsCredentials, ClientConfiguration 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.).public AmazonElasticTranscoderClient(AWSCredentialsProvider 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.public AmazonElasticTranscoderClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration 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.).public AmazonElasticTranscoderClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector 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 CancelJobResult cancelJob(CancelJobRequest cancelJobRequest)
The CancelJob operation cancels an unfinished job.
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 AmazonElasticTranscoder
cancelJobRequest
- The CancelJobRequest
structure.ValidationException
- One or more required parameter values were not provided in the
request.IncompatibleVersionException
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.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 createJobRequest)
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 AmazonElasticTranscoder
createJobRequest
- The CreateJobRequest
structure.ValidationException
- One or more required parameter values were not provided in the
request.IncompatibleVersionException
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.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 createPipelineRequest)
The CreatePipeline operation creates a pipeline with settings that you specify.
createPipeline
in interface AmazonElasticTranscoder
createPipelineRequest
- The CreatePipelineRequest
structure.ValidationException
- One or more required parameter values were not provided in the
request.IncompatibleVersionException
AccessDeniedException
- 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 createPresetRequest)
The CreatePreset operation creates a preset with settings that you specify.
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 AmazonElasticTranscoder
createPresetRequest
- The CreatePresetRequest
structure.ValidationException
- One or more required parameter values were not provided in the
request.IncompatibleVersionException
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 DeletePipelineResult deletePipeline(DeletePipelineRequest deletePipelineRequest)
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 AmazonElasticTranscoder
deletePipelineRequest
- The DeletePipelineRequest
structure.ValidationException
- One or more required parameter values were not provided in the
request.IncompatibleVersionException
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.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 deletePresetRequest)
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 AmazonElasticTranscoder
deletePresetRequest
- The DeletePresetRequest
structure.ValidationException
- One or more required parameter values were not provided in the
request.IncompatibleVersionException
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.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 listJobsByPipelineRequest)
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 AmazonElasticTranscoder
listJobsByPipelineRequest
- The ListJobsByPipelineRequest
structure.ValidationException
- One or more required parameter values were not provided in the
request.IncompatibleVersionException
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.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 listJobsByStatusRequest)
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 AmazonElasticTranscoder
listJobsByStatusRequest
- The ListJobsByStatusRequest
structure.ValidationException
- One or more required parameter values were not provided in the
request.IncompatibleVersionException
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.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 listPipelinesRequest)
The ListPipelines operation gets a list of the pipelines associated with the current AWS account.
listPipelines
in interface AmazonElasticTranscoder
listPipelinesRequest
- The ListPipelineRequest
structure.ValidationException
- One or more required parameter values were not provided in the
request.IncompatibleVersionException
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()
AmazonElasticTranscoder
listPipelines
in interface AmazonElasticTranscoder
AmazonElasticTranscoder.listPipelines(ListPipelinesRequest)
public ListPresetsResult listPresets(ListPresetsRequest listPresetsRequest)
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 AmazonElasticTranscoder
listPresetsRequest
- The ListPresetsRequest
structure.ValidationException
- One or more required parameter values were not provided in the
request.IncompatibleVersionException
AccessDeniedException
- 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()
AmazonElasticTranscoder
listPresets
in interface AmazonElasticTranscoder
AmazonElasticTranscoder.listPresets(ListPresetsRequest)
public ReadJobResult readJob(ReadJobRequest readJobRequest)
The ReadJob operation returns detailed information about a job.
readJob
in interface AmazonElasticTranscoder
readJobRequest
- The ReadJobRequest
structure.ValidationException
- One or more required parameter values were not provided in the
request.IncompatibleVersionException
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.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 readPipelineRequest)
The ReadPipeline operation gets detailed information about a pipeline.
readPipeline
in interface AmazonElasticTranscoder
readPipelineRequest
- The ReadPipelineRequest
structure.ValidationException
- One or more required parameter values were not provided in the
request.IncompatibleVersionException
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.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 readPresetRequest)
The ReadPreset operation gets detailed information about a preset.
readPreset
in interface AmazonElasticTranscoder
readPresetRequest
- The ReadPresetRequest
structure.ValidationException
- One or more required parameter values were not provided in the
request.IncompatibleVersionException
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.AccessDeniedException
- General authentication failure. The request was not signed
correctly.InternalServiceException
- Elastic Transcoder encountered an unexpected exception while
trying to fulfill the request.public TestRoleResult testRole(TestRoleRequest testRoleRequest)
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 AmazonElasticTranscoder
testRoleRequest
- The TestRoleRequest
structure.ValidationException
- One or more required parameter values were not provided in the
request.IncompatibleVersionException
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.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 updatePipelineRequest)
Use the UpdatePipeline
operation to update settings for a
pipeline.
updatePipeline
in interface AmazonElasticTranscoder
updatePipelineRequest
- The UpdatePipelineRequest
structure.ValidationException
- One or more required parameter values were not provided in the
request.IncompatibleVersionException
AccessDeniedException
- 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 updatePipelineNotificationsRequest)
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 AmazonElasticTranscoder
updatePipelineNotificationsRequest
- The UpdatePipelineNotificationsRequest
structure.ValidationException
- One or more required parameter values were not provided in the
request.IncompatibleVersionException
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.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 updatePipelineStatusRequest)
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 AmazonElasticTranscoder
updatePipelineStatusRequest
- The UpdatePipelineStatusRequest
structure.ValidationException
- One or more required parameter values were not provided in the
request.IncompatibleVersionException
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.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 AmazonElasticTranscoder
request
- The originally executed requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.