public class AmazonElasticTranscoderClient extends AmazonWebServiceClient implements AmazonElasticTranscoder
AWS Elastic Transcoder Service
The AWS Elastic Transcoder Service.
| Constructor and Description | 
|---|
| AmazonElasticTranscoderClient()Constructs a new client to invoke service methods on
 AmazonElasticTranscoder. | 
| AmazonElasticTranscoderClient(AWSCredentials awsCredentials)Constructs a new client to invoke service methods on
 AmazonElasticTranscoder using the specified AWS account credentials. | 
| AmazonElasticTranscoderClient(AWSCredentials awsCredentials,
                             ClientConfiguration clientConfiguration)Constructs a new client to invoke service methods on
 AmazonElasticTranscoder using the specified AWS account credentials
 and client configuration options. | 
| AmazonElasticTranscoderClient(AWSCredentialsProvider awsCredentialsProvider)Constructs a new client to invoke service methods on
 AmazonElasticTranscoder using the specified AWS account credentials provider. | 
| AmazonElasticTranscoderClient(AWSCredentialsProvider awsCredentialsProvider,
                             ClientConfiguration clientConfiguration)Constructs a new client to invoke service methods on
 AmazonElasticTranscoder using the specified AWS account credentials
 provider and client configuration options. | 
| AmazonElasticTranscoderClient(ClientConfiguration clientConfiguration)Constructs a new client to invoke service methods on
 AmazonElasticTranscoder. | 
| 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()
 The ListPipelines operation gets a list of the pipelines associated
 with the current AWS account. | 
| ListPipelinesResult | listPipelines(ListPipelinesRequest listPipelinesRequest)
 The ListPipelines operation gets a list of the pipelines associated
 with the current AWS account. | 
| ListPresetsResult | listPresets()
 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. | 
| 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. | 
| void | setEndpoint(String endpoint,
           String serviceName,
           String regionId)Overrides the default endpoint for this client ("https://elastictranscoder.us-east-1.amazonaws.com/") and explicitly provides
 an AWS region ID and AWS service name to use when the client calculates a signature
 for requests. | 
| TestRoleResult | testRole(TestRoleRequest testRoleRequest)
 The TestRole operation tests the IAM role used to create the pipeline. | 
| UpdatePipelineResult | updatePipeline(UpdatePipelineRequest updatePipelineRequest)
 Use the  UpdatePipelineoperation 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, getRequestMetricsCollector, getTimeOffset, removeRequestHandler, setConfiguration, setEndpoint, setRegion, setTimeOffset, shutdown, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion, shutdownpublic AmazonElasticTranscoderClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChainpublic 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 AmazonElasticTranscoder
                       (ex: proxy settings, retry counts, etc.).DefaultAWSCredentialsProviderChainpublic 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 AmazonElasticTranscoder
                       (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 AmazonElasticTranscoder
                       (ex: proxy settings, retry counts, etc.).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 AmazonElasticTranscoderupdatePipelineStatusRequest - Container for the necessary
           parameters to execute the UpdatePipelineStatus service method on
           AmazonElasticTranscoder.ResourceNotFoundExceptionAccessDeniedExceptionResourceInUseExceptionInternalServiceExceptionValidationExceptionIncompatibleVersionExceptionAmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElasticTranscoder indicating
             either a problem with the data in the request, or a server side issue.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 AmazonElasticTranscoderupdatePipelineNotificationsRequest - Container for the necessary
           parameters to execute the UpdatePipelineNotifications service method
           on AmazonElasticTranscoder.ResourceNotFoundExceptionAccessDeniedExceptionResourceInUseExceptionInternalServiceExceptionValidationExceptionIncompatibleVersionExceptionAmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElasticTranscoder indicating
             either a problem with the data in the request, or a server side issue.public ReadJobResult readJob(ReadJobRequest readJobRequest)
The ReadJob operation returns detailed information about a job.
readJob in interface AmazonElasticTranscoderreadJobRequest - Container for the necessary parameters to
           execute the ReadJob service method on AmazonElasticTranscoder.ResourceNotFoundExceptionAccessDeniedExceptionInternalServiceExceptionValidationExceptionIncompatibleVersionExceptionAmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElasticTranscoder indicating
             either a problem with the data in the request, or a server side issue.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 AmazonElasticTranscoderlistJobsByStatusRequest - Container for the necessary parameters
           to execute the ListJobsByStatus service method on
           AmazonElasticTranscoder.ResourceNotFoundExceptionAccessDeniedExceptionInternalServiceExceptionValidationExceptionIncompatibleVersionExceptionAmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElasticTranscoder indicating
             either a problem with the data in the request, or a server side issue.public ReadPresetResult readPreset(ReadPresetRequest readPresetRequest)
The ReadPreset operation gets detailed information about a preset.
readPreset in interface AmazonElasticTranscoderreadPresetRequest - Container for the necessary parameters to
           execute the ReadPreset service method on AmazonElasticTranscoder.ResourceNotFoundExceptionAccessDeniedExceptionInternalServiceExceptionValidationExceptionIncompatibleVersionExceptionAmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElasticTranscoder indicating
             either a problem with the data in the request, or a server side issue.public CreatePipelineResult createPipeline(CreatePipelineRequest createPipelineRequest)
The CreatePipeline operation creates a pipeline with settings that you specify.
createPipeline in interface AmazonElasticTranscodercreatePipelineRequest - Container for the necessary parameters to
           execute the CreatePipeline service method on AmazonElasticTranscoder.AccessDeniedExceptionResourceNotFoundExceptionInternalServiceExceptionLimitExceededExceptionValidationExceptionIncompatibleVersionExceptionAmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElasticTranscoder indicating
             either a problem with the data in the request, or a server side issue.public CancelJobResult cancelJob(CancelJobRequest cancelJobRequest)
The CancelJob operation cancels an unfinished job.
NOTE: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 - Container for the necessary parameters to
           execute the CancelJob service method on AmazonElasticTranscoder.ResourceNotFoundExceptionAccessDeniedExceptionResourceInUseExceptionInternalServiceExceptionValidationExceptionIncompatibleVersionExceptionAmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElasticTranscoder indicating
             either a problem with the data in the request, or a server side issue.public UpdatePipelineResult updatePipeline(UpdatePipelineRequest updatePipelineRequest)
 Use the UpdatePipeline operation to update settings for
 a pipeline. 
IMPORTANT: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 - Container for the necessary parameters to
           execute the UpdatePipeline service method on AmazonElasticTranscoder.AccessDeniedExceptionResourceNotFoundExceptionResourceInUseExceptionInternalServiceExceptionValidationExceptionIncompatibleVersionExceptionAmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElasticTranscoder indicating
             either a problem with the data in the request, or a server side issue.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 AmazonElasticTranscoderlistPresetsRequest - Container for the necessary parameters to
           execute the ListPresets service method on AmazonElasticTranscoder.AccessDeniedExceptionInternalServiceExceptionValidationExceptionIncompatibleVersionExceptionAmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElasticTranscoder indicating
             either a problem with the data in the request, or a server side issue.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 AmazonElasticTranscoderdeletePipelineRequest - Container for the necessary parameters to
           execute the DeletePipeline service method on AmazonElasticTranscoder.ResourceNotFoundExceptionAccessDeniedExceptionResourceInUseExceptionInternalServiceExceptionValidationExceptionIncompatibleVersionExceptionAmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElasticTranscoder indicating
             either a problem with the data in the request, or a server side issue.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 AmazonElasticTranscodertestRoleRequest - Container for the necessary parameters to
           execute the TestRole service method on AmazonElasticTranscoder.ResourceNotFoundExceptionAccessDeniedExceptionInternalServiceExceptionValidationExceptionIncompatibleVersionExceptionAmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElasticTranscoder indicating
             either a problem with the data in the request, or a server side issue.public ListPipelinesResult listPipelines(ListPipelinesRequest listPipelinesRequest)
The ListPipelines operation gets a list of the pipelines associated with the current AWS account.
listPipelines in interface AmazonElasticTranscoderlistPipelinesRequest - Container for the necessary parameters to
           execute the ListPipelines service method on AmazonElasticTranscoder.AccessDeniedExceptionInternalServiceExceptionValidationExceptionIncompatibleVersionExceptionAmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElasticTranscoder indicating
             either a problem with the data in the request, or a server side issue.public ReadPipelineResult readPipeline(ReadPipelineRequest readPipelineRequest)
The ReadPipeline operation gets detailed information about a pipeline.
readPipeline in interface AmazonElasticTranscoderreadPipelineRequest - Container for the necessary parameters to
           execute the ReadPipeline service method on AmazonElasticTranscoder.ResourceNotFoundExceptionAccessDeniedExceptionInternalServiceExceptionValidationExceptionIncompatibleVersionExceptionAmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElasticTranscoder indicating
             either a problem with the data in the request, or a server side issue.public CreatePresetResult createPreset(CreatePresetRequest createPresetRequest)
The CreatePreset operation creates a preset with settings that you specify.
IMPORTANT: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 - Container for the necessary parameters to
           execute the CreatePreset service method on AmazonElasticTranscoder.AccessDeniedExceptionInternalServiceExceptionLimitExceededExceptionValidationExceptionIncompatibleVersionExceptionAmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElasticTranscoder indicating
             either a problem with the data in the request, or a server side issue.public DeletePresetResult deletePreset(DeletePresetRequest deletePresetRequest)
The DeletePreset operation removes a preset that you've added in an AWS region.
NOTE: You can't delete the default presets that are included with Elastic Transcoder.
deletePreset in interface AmazonElasticTranscoderdeletePresetRequest - Container for the necessary parameters to
           execute the DeletePreset service method on AmazonElasticTranscoder.ResourceNotFoundExceptionAccessDeniedExceptionInternalServiceExceptionValidationExceptionIncompatibleVersionExceptionAmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElasticTranscoder indicating
             either a problem with the data in the request, or a server side issue.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 AmazonElasticTranscodercreateJobRequest - Container for the necessary parameters to
           execute the CreateJob service method on AmazonElasticTranscoder.ResourceNotFoundExceptionAccessDeniedExceptionInternalServiceExceptionLimitExceededExceptionValidationExceptionIncompatibleVersionExceptionAmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElasticTranscoder indicating
             either a problem with the data in the request, or a server side issue.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 AmazonElasticTranscoderlistJobsByPipelineRequest - Container for the necessary
           parameters to execute the ListJobsByPipeline service method on
           AmazonElasticTranscoder.ResourceNotFoundExceptionAccessDeniedExceptionInternalServiceExceptionValidationExceptionIncompatibleVersionExceptionAmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElasticTranscoder indicating
             either a problem with the data in the request, or a server side issue.public ListPresetsResult listPresets() throws AmazonServiceException, AmazonClientException
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 AmazonElasticTranscoderAccessDeniedExceptionInternalServiceExceptionValidationExceptionIncompatibleVersionExceptionAmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElasticTranscoder indicating
             either a problem with the data in the request, or a server side issue.public ListPipelinesResult listPipelines() throws AmazonServiceException, AmazonClientException
The ListPipelines operation gets a list of the pipelines associated with the current AWS account.
listPipelines in interface AmazonElasticTranscoderAccessDeniedExceptionInternalServiceExceptionValidationExceptionIncompatibleVersionExceptionAmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElasticTranscoder indicating
             either a problem with the data in the request, or a server side issue.public void setEndpoint(String endpoint, String serviceName, String regionId) throws IllegalArgumentException
This method is not threadsafe. Endpoints should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit.
 Callers can pass in just the endpoint (ex: "elastictranscoder.us-east-1.amazonaws.com/") or a full
 URL, including the protocol (ex: "https://elastictranscoder.us-east-1.amazonaws.com/"). If the
 protocol is not specified here, the default protocol from this client's
 ClientConfiguration will be used, which by default is HTTPS.
 
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
endpoint - The endpoint (ex: "elastictranscoder.us-east-1.amazonaws.com/") or a full URL,
            including the protocol (ex: "https://elastictranscoder.us-east-1.amazonaws.com/") of
            the region specific AWS endpoint this client will communicate
            with.serviceName - The name of the AWS service to use when signing requests.regionId - The ID of the region in which this service resides.IllegalArgumentException - If any problems are detected with the specified endpoint.AmazonDynamoDB#setRegion(Region)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 requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.