Overview  Package   Class  Index  Help 

Did this page help you?

   Yes   No   Tell us about it...
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.amazonaws.services.elastictranscoder
Class AmazonElasticTranscoderClient

java.lang.Object
  extended by com.amazonaws.AmazonWebServiceClient
      extended by com.amazonaws.services.elastictranscoder.AmazonElasticTranscoderClient
All Implemented Interfaces:
AmazonElasticTranscoder
Direct Known Subclasses:
AmazonElasticTranscoderAsyncClient
public class AmazonElasticTranscoderClient
extends AmazonWebServiceClient
implements AmazonElasticTranscoder

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

AWS Elastic Transcoder Service

The AWS Elastic Transcoder Service.

Constructor Summary
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.
 
Method Summary
 CancelJobResult cancelJob()
           To cancel a job, send a DELETE request to the /2012-09-25/jobs/[jobId] resource.
 CancelJobResult cancelJob(CancelJobRequest cancelJobRequest)
           To cancel a job, send a DELETE request to the /2012-09-25/jobs/[jobId] resource.
 CreateJobResult createJob()
           To create a job, send a POST request to the /2012-09-25/jobs resource.
 CreateJobResult createJob(CreateJobRequest createJobRequest)
           To create a job, send a POST request to the /2012-09-25/jobs resource.
 CreatePipelineResult createPipeline()
           To create a pipeline, send a POST request to the 2012-09-25/pipelines resource.
 CreatePipelineResult createPipeline(CreatePipelineRequest createPipelineRequest)
           To create a pipeline, send a POST request to the 2012-09-25/pipelines resource.
 CreatePresetResult createPreset()
           To create a preset, send a POST request to the /2012-09-25/presets resource.
 CreatePresetResult createPreset(CreatePresetRequest createPresetRequest)
           To create a preset, send a POST request to the /2012-09-25/presets resource.
 DeletePipelineResult deletePipeline()
           To delete a pipeline, send a DELETE request to the /2012-09-25/pipelines/[pipelineId] resource.
 DeletePipelineResult deletePipeline(DeletePipelineRequest deletePipelineRequest)
           To delete a pipeline, send a DELETE request to the /2012-09-25/pipelines/[pipelineId] resource.
 DeletePresetResult deletePreset()
           To delete a preset, send a DELETE request to the /2012-09-25/presets/[presetId] resource.
 DeletePresetResult deletePreset(DeletePresetRequest deletePresetRequest)
           To delete a preset, send a DELETE request to the /2012-09-25/presets/[presetId] resource.
 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()
           To get a list of the jobs currently in a pipeline, send a GET request to the /2012-09-25/jobsByPipeline/[pipelineId] resource.
 ListJobsByPipelineResult listJobsByPipeline(ListJobsByPipelineRequest listJobsByPipelineRequest)
           To get a list of the jobs currently in a pipeline, send a GET request to the /2012-09-25/jobsByPipeline/[pipelineId] resource.
 ListJobsByStatusResult listJobsByStatus()
           To get a list of the jobs that have a specified status, send a GET request to the /2012-09-25/jobsByStatus/[status] resource.
 ListJobsByStatusResult listJobsByStatus(ListJobsByStatusRequest listJobsByStatusRequest)
           To get a list of the jobs that have a specified status, send a GET request to the /2012-09-25/jobsByStatus/[status] resource.
 ListPipelinesResult listPipelines()
           To get a list of the pipelines associated with the current AWS account, send a GET request to the /2012-09-25/pipelines resource.
 ListPipelinesResult listPipelines(ListPipelinesRequest listPipelinesRequest)
           To get a list of the pipelines associated with the current AWS account, send a GET request to the /2012-09-25/pipelines resource.
 ListPresetsResult listPresets()
           To get a list of all presets associated with the current AWS account, send a GET request to the /2012-09-25/presets resource.
 ListPresetsResult listPresets(ListPresetsRequest listPresetsRequest)
           To get a list of all presets associated with the current AWS account, send a GET request to the /2012-09-25/presets resource.
 ReadJobResult readJob()
           To get detailed information about a job, send a GET request to the /2012-09-25/jobs/[jobId] resource.
 ReadJobResult readJob(ReadJobRequest readJobRequest)
           To get detailed information about a job, send a GET request to the /2012-09-25/jobs/[jobId] resource.
 ReadPipelineResult readPipeline()
           To get detailed information about a pipeline, send a GET request to the /2012-09-25/pipelines/[pipelineId] resource.
 ReadPipelineResult readPipeline(ReadPipelineRequest readPipelineRequest)
           To get detailed information about a pipeline, send a GET request to the /2012-09-25/pipelines/[pipelineId] resource.
 ReadPresetResult readPreset()
           To get detailed information about a preset, send a GET request to the /2012-09-25/presets/[presetId] resource.
 ReadPresetResult readPreset(ReadPresetRequest readPresetRequest)
           To get detailed information about a preset, send a GET request to the /2012-09-25/presets/[presetId] resource.
 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()
           To test the IAM role that's used by Elastic Transcoder to create the pipeline, send a POST request to the /2012-09-25/roleTests resource.
 TestRoleResult testRole(TestRoleRequest testRoleRequest)
           To test the IAM role that's used by Elastic Transcoder to create the pipeline, send a POST request to the /2012-09-25/roleTests resource.
 UpdatePipelineResult updatePipeline(UpdatePipelineRequest updatePipelineRequest)
           
 UpdatePipelineNotificationsResult updatePipelineNotifications()
           To update Amazon Simple Notification Service (Amazon SNS) notifications for a pipeline, send a POST request to the /2012-09-25/pipelines/[pipelineId]/notifications resource.
 UpdatePipelineNotificationsResult updatePipelineNotifications(UpdatePipelineNotificationsRequest updatePipelineNotificationsRequest)
           To update Amazon Simple Notification Service (Amazon SNS) notifications for a pipeline, send a POST request to the /2012-09-25/pipelines/[pipelineId]/notifications resource.
 UpdatePipelineStatusResult updatePipelineStatus()
           To pause or reactivate a pipeline, so the pipeline stops or restarts processing jobs, update the status for the pipeline.
 UpdatePipelineStatusResult updatePipelineStatus(UpdatePipelineStatusRequest updatePipelineStatusRequest)
           To pause or reactivate a pipeline, so the pipeline stops or restarts processing jobs, update the status for the pipeline.
 
Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, getTimeOffset, removeRequestHandler, setConfiguration, setEndpoint, setRegion, setTimeOffset, shutdown, withTimeOffset
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.amazonaws.services.elastictranscoder.AmazonElasticTranscoder
setEndpoint, setRegion, shutdown
 

Constructor Detail

AmazonElasticTranscoderClient

public AmazonElasticTranscoderClient()
Constructs a new client to invoke service methods on AmazonElasticTranscoder. A credentials provider chain will be used that searches for credentials in this order:

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:
DefaultAWSCredentialsProvider

AmazonElasticTranscoderClient

public AmazonElasticTranscoderClient(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AmazonElasticTranscoder. A credentials provider chain will be used that searches for credentials in this order:

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:
clientConfiguration - The client configuration options controlling how this client connects to AmazonElasticTranscoder (ex: proxy settings, retry counts, etc.).
See Also:
DefaultAWSCredentialsProvider

AmazonElasticTranscoderClient

public AmazonElasticTranscoderClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on AmazonElasticTranscoder using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AmazonElasticTranscoderClient

public 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.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:
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.).

AmazonElasticTranscoderClient

public AmazonElasticTranscoderClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on AmazonElasticTranscoder using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AmazonElasticTranscoderClient

public 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.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:
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.).
Method Detail

updatePipelineStatus

public UpdatePipelineStatusResult updatePipelineStatus(UpdatePipelineStatusRequest updatePipelineStatusRequest)
                                                throws AmazonServiceException,
                                                       AmazonClientException

To pause or reactivate a pipeline, so the pipeline stops or restarts processing jobs, update the status for the pipeline. Send a POST request to the /2012-09-25/pipelines/[pipelineId]/status resource.

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.

Specified by:
updatePipelineStatus in interface AmazonElasticTranscoder
Parameters:
updatePipelineStatusRequest - Container for the necessary parameters to execute the UpdatePipelineStatus service method on AmazonElasticTranscoder.
Returns:
The response from the UpdatePipelineStatus service method, as returned by AmazonElasticTranscoder.
Throws:
ResourceNotFoundException
AccessDeniedException
ResourceInUseException
InternalServiceException
ValidationException
IncompatibleVersionException
AmazonClientException - 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.

updatePipelineNotifications

public UpdatePipelineNotificationsResult updatePipelineNotifications(UpdatePipelineNotificationsRequest updatePipelineNotificationsRequest)
                                                              throws AmazonServiceException,
                                                                     AmazonClientException

To update Amazon Simple Notification Service (Amazon SNS) notifications for a pipeline, send a POST request to the /2012-09-25/pipelines/[pipelineId]/notifications resource.

When you update notifications for a pipeline, Elastic Transcoder returns the values that you specified in the request.

Specified by:
updatePipelineNotifications in interface AmazonElasticTranscoder
Parameters:
updatePipelineNotificationsRequest - Container for the necessary parameters to execute the UpdatePipelineNotifications service method on AmazonElasticTranscoder.
Returns:
The response from the UpdatePipelineNotifications service method, as returned by AmazonElasticTranscoder.
Throws:
ResourceNotFoundException
AccessDeniedException
ResourceInUseException
InternalServiceException
ValidationException
IncompatibleVersionException
AmazonClientException - 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.

readJob

public ReadJobResult readJob(ReadJobRequest readJobRequest)
                      throws AmazonServiceException,
                             AmazonClientException

To get detailed information about a job, send a GET request to the /2012-09-25/jobs/[jobId] resource.

Specified by:
readJob in interface AmazonElasticTranscoder
Parameters:
readJobRequest - Container for the necessary parameters to execute the ReadJob service method on AmazonElasticTranscoder.
Returns:
The response from the ReadJob service method, as returned by AmazonElasticTranscoder.
Throws:
ResourceNotFoundException
AccessDeniedException
InternalServiceException
ValidationException
IncompatibleVersionException
AmazonClientException - 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.

listJobsByStatus

public ListJobsByStatusResult listJobsByStatus(ListJobsByStatusRequest listJobsByStatusRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

To get a list of the jobs that have a specified status, send a GET request to the /2012-09-25/jobsByStatus/[status] resource.

Elastic Transcoder returns all of the jobs that have the specified status. The response body contains one element for each job that satisfies the search criteria.

Specified by:
listJobsByStatus in interface AmazonElasticTranscoder
Parameters:
listJobsByStatusRequest - Container for the necessary parameters to execute the ListJobsByStatus service method on AmazonElasticTranscoder.
Returns:
The response from the ListJobsByStatus service method, as returned by AmazonElasticTranscoder.
Throws:
ResourceNotFoundException
AccessDeniedException
InternalServiceException
ValidationException
IncompatibleVersionException
AmazonClientException - 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.

readPreset

public ReadPresetResult readPreset(ReadPresetRequest readPresetRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

To get detailed information about a preset, send a GET request to the /2012-09-25/presets/[presetId] resource.

Specified by:
readPreset in interface AmazonElasticTranscoder
Parameters:
readPresetRequest - Container for the necessary parameters to execute the ReadPreset service method on AmazonElasticTranscoder.
Returns:
The response from the ReadPreset service method, as returned by AmazonElasticTranscoder.
Throws:
ResourceNotFoundException
AccessDeniedException
InternalServiceException
ValidationException
IncompatibleVersionException
AmazonClientException - 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.

createPipeline

public CreatePipelineResult createPipeline(CreatePipelineRequest createPipelineRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

To create a pipeline, send a POST request to the 2012-09-25/pipelines resource.

Specified by:
createPipeline in interface AmazonElasticTranscoder
Parameters:
createPipelineRequest - Container for the necessary parameters to execute the CreatePipeline service method on AmazonElasticTranscoder.
Returns:
The response from the CreatePipeline service method, as returned by AmazonElasticTranscoder.
Throws:
AccessDeniedException
ResourceNotFoundException
InternalServiceException
LimitExceededException
ValidationException
IncompatibleVersionException
AmazonClientException - 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.

cancelJob

public CancelJobResult cancelJob(CancelJobRequest cancelJobRequest)
                          throws AmazonServiceException,
                                 AmazonClientException

To cancel a job, send a DELETE request to the /2012-09-25/jobs/[jobId] resource.

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.

Specified by:
cancelJob in interface AmazonElasticTranscoder
Parameters:
cancelJobRequest - Container for the necessary parameters to execute the CancelJob service method on AmazonElasticTranscoder.
Returns:
The response from the CancelJob service method, as returned by AmazonElasticTranscoder.
Throws:
ResourceNotFoundException
AccessDeniedException
ResourceInUseException
InternalServiceException
ValidationException
IncompatibleVersionException
AmazonClientException - 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.

updatePipeline

public UpdatePipelineResult updatePipeline(UpdatePipelineRequest updatePipelineRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException
Specified by:
updatePipeline in interface AmazonElasticTranscoder
Parameters:
updatePipelineRequest - Container for the necessary parameters to execute the UpdatePipeline service method on AmazonElasticTranscoder.
Returns:
The response from the UpdatePipeline service method, as returned by AmazonElasticTranscoder.
Throws:
AccessDeniedException
ResourceNotFoundException
ResourceInUseException
InternalServiceException
ValidationException
IncompatibleVersionException
AmazonClientException - 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.

listPresets

public ListPresetsResult listPresets(ListPresetsRequest listPresetsRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

To get a list of all presets associated with the current AWS account, send a GET request to the /2012-09-25/presets resource.

Specified by:
listPresets in interface AmazonElasticTranscoder
Parameters:
listPresetsRequest - Container for the necessary parameters to execute the ListPresets service method on AmazonElasticTranscoder.
Returns:
The response from the ListPresets service method, as returned by AmazonElasticTranscoder.
Throws:
AccessDeniedException
InternalServiceException
ValidationException
IncompatibleVersionException
AmazonClientException - 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.

deletePipeline

public DeletePipelineResult deletePipeline(DeletePipelineRequest deletePipelineRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

To delete a pipeline, send a DELETE request to the /2012-09-25/pipelines/[pipelineId] resource.

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.

Specified by:
deletePipeline in interface AmazonElasticTranscoder
Parameters:
deletePipelineRequest - Container for the necessary parameters to execute the DeletePipeline service method on AmazonElasticTranscoder.
Returns:
The response from the DeletePipeline service method, as returned by AmazonElasticTranscoder.
Throws:
ResourceNotFoundException
AccessDeniedException
ResourceInUseException
InternalServiceException
ValidationException
IncompatibleVersionException
AmazonClientException - 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.

testRole

public TestRoleResult testRole(TestRoleRequest testRoleRequest)
                        throws AmazonServiceException,
                               AmazonClientException

To test the IAM role that's used by Elastic Transcoder to create the pipeline, send a POST request to the /2012-09-25/roleTests resource.

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.

Specified by:
testRole in interface AmazonElasticTranscoder
Parameters:
testRoleRequest - Container for the necessary parameters to execute the TestRole service method on AmazonElasticTranscoder.
Returns:
The response from the TestRole service method, as returned by AmazonElasticTranscoder.
Throws:
ResourceNotFoundException
AccessDeniedException
InternalServiceException
ValidationException
IncompatibleVersionException
AmazonClientException - 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.

listPipelines

public ListPipelinesResult listPipelines(ListPipelinesRequest listPipelinesRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

To get a list of the pipelines associated with the current AWS account, send a GET request to the /2012-09-25/pipelines resource.

Specified by:
listPipelines in interface AmazonElasticTranscoder
Parameters:
listPipelinesRequest - Container for the necessary parameters to execute the ListPipelines service method on AmazonElasticTranscoder.
Returns:
The response from the ListPipelines service method, as returned by AmazonElasticTranscoder.
Throws:
AccessDeniedException
InternalServiceException
ValidationException
IncompatibleVersionException
AmazonClientException - 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.

readPipeline

public ReadPipelineResult readPipeline(ReadPipelineRequest readPipelineRequest)
                                throws AmazonServiceException,
                                       AmazonClientException

To get detailed information about a pipeline, send a GET request to the /2012-09-25/pipelines/[pipelineId] resource.

Specified by:
readPipeline in interface AmazonElasticTranscoder
Parameters:
readPipelineRequest - Container for the necessary parameters to execute the ReadPipeline service method on AmazonElasticTranscoder.
Returns:
The response from the ReadPipeline service method, as returned by AmazonElasticTranscoder.
Throws:
ResourceNotFoundException
AccessDeniedException
InternalServiceException
ValidationException
IncompatibleVersionException
AmazonClientException - 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.

createPreset

public CreatePresetResult createPreset(CreatePresetRequest createPresetRequest)
                                throws AmazonServiceException,
                                       AmazonClientException

To create a preset, send a POST request to the /2012-09-25/presets resource.

IMPORTANT:Elastic Transcoder checks the settings that you specify 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 .

Specified by:
createPreset in interface AmazonElasticTranscoder
Parameters:
createPresetRequest - Container for the necessary parameters to execute the CreatePreset service method on AmazonElasticTranscoder.
Returns:
The response from the CreatePreset service method, as returned by AmazonElasticTranscoder.
Throws:
AccessDeniedException
InternalServiceException
LimitExceededException
ValidationException
IncompatibleVersionException
AmazonClientException - 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.

deletePreset

public DeletePresetResult deletePreset(DeletePresetRequest deletePresetRequest)
                                throws AmazonServiceException,
                                       AmazonClientException

To delete a preset, send a DELETE request to the /2012-09-25/presets/[presetId] resource.

NOTE: If the preset has been used, you cannot delete it.

Specified by:
deletePreset in interface AmazonElasticTranscoder
Parameters:
deletePresetRequest - Container for the necessary parameters to execute the DeletePreset service method on AmazonElasticTranscoder.
Returns:
The response from the DeletePreset service method, as returned by AmazonElasticTranscoder.
Throws:
ResourceNotFoundException
AccessDeniedException
InternalServiceException
ValidationException
IncompatibleVersionException
AmazonClientException - 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.

createJob

public CreateJobResult createJob(CreateJobRequest createJobRequest)
                          throws AmazonServiceException,
                                 AmazonClientException

To create a job, send a POST request to the /2012-09-25/jobs resource.

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).

Specified by:
createJob in interface AmazonElasticTranscoder
Parameters:
createJobRequest - Container for the necessary parameters to execute the CreateJob service method on AmazonElasticTranscoder.
Returns:
The response from the CreateJob service method, as returned by AmazonElasticTranscoder.
Throws:
ResourceNotFoundException
AccessDeniedException
InternalServiceException
LimitExceededException
ValidationException
IncompatibleVersionException
AmazonClientException - 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.

listJobsByPipeline

public ListJobsByPipelineResult listJobsByPipeline(ListJobsByPipelineRequest listJobsByPipelineRequest)
                                            throws AmazonServiceException,
                                                   AmazonClientException

To get a list of the jobs currently in a pipeline, send a GET request to the /2012-09-25/jobsByPipeline/[pipelineId] resource.

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.

Specified by:
listJobsByPipeline in interface AmazonElasticTranscoder
Parameters:
listJobsByPipelineRequest - Container for the necessary parameters to execute the ListJobsByPipeline service method on AmazonElasticTranscoder.
Returns:
The response from the ListJobsByPipeline service method, as returned by AmazonElasticTranscoder.
Throws:
ResourceNotFoundException
AccessDeniedException
InternalServiceException
ValidationException
IncompatibleVersionException
AmazonClientException - 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.

updatePipelineStatus

public UpdatePipelineStatusResult updatePipelineStatus()
                                                throws AmazonServiceException,
                                                       AmazonClientException

To pause or reactivate a pipeline, so the pipeline stops or restarts processing jobs, update the status for the pipeline. Send a POST request to the /2012-09-25/pipelines/[pipelineId]/status resource.

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.

Specified by:
updatePipelineStatus in interface AmazonElasticTranscoder
Returns:
The response from the UpdatePipelineStatus service method, as returned by AmazonElasticTranscoder.
Throws:
ResourceNotFoundException
AccessDeniedException
ResourceInUseException
InternalServiceException
ValidationException
IncompatibleVersionException
AmazonClientException - 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.

updatePipelineNotifications

public UpdatePipelineNotificationsResult updatePipelineNotifications()
                                                              throws AmazonServiceException,
                                                                     AmazonClientException

To update Amazon Simple Notification Service (Amazon SNS) notifications for a pipeline, send a POST request to the /2012-09-25/pipelines/[pipelineId]/notifications resource.

When you update notifications for a pipeline, Elastic Transcoder returns the values that you specified in the request.

Specified by:
updatePipelineNotifications in interface AmazonElasticTranscoder
Returns:
The response from the UpdatePipelineNotifications service method, as returned by AmazonElasticTranscoder.
Throws:
ResourceNotFoundException
AccessDeniedException
ResourceInUseException
InternalServiceException
ValidationException
IncompatibleVersionException
AmazonClientException - 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.

readJob

public ReadJobResult readJob()
                      throws AmazonServiceException,
                             AmazonClientException

To get detailed information about a job, send a GET request to the /2012-09-25/jobs/[jobId] resource.

Specified by:
readJob in interface AmazonElasticTranscoder
Returns:
The response from the ReadJob service method, as returned by AmazonElasticTranscoder.
Throws:
ResourceNotFoundException
AccessDeniedException
InternalServiceException
ValidationException
IncompatibleVersionException
AmazonClientException - 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.

listJobsByStatus

public ListJobsByStatusResult listJobsByStatus()
                                        throws AmazonServiceException,
                                               AmazonClientException

To get a list of the jobs that have a specified status, send a GET request to the /2012-09-25/jobsByStatus/[status] resource.

Elastic Transcoder returns all of the jobs that have the specified status. The response body contains one element for each job that satisfies the search criteria.

Specified by:
listJobsByStatus in interface AmazonElasticTranscoder
Returns:
The response from the ListJobsByStatus service method, as returned by AmazonElasticTranscoder.
Throws:
ResourceNotFoundException
AccessDeniedException
InternalServiceException
ValidationException
IncompatibleVersionException
AmazonClientException - 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.

readPreset

public ReadPresetResult readPreset()
                            throws AmazonServiceException,
                                   AmazonClientException

To get detailed information about a preset, send a GET request to the /2012-09-25/presets/[presetId] resource.

Specified by:
readPreset in interface AmazonElasticTranscoder
Returns:
The response from the ReadPreset service method, as returned by AmazonElasticTranscoder.
Throws:
ResourceNotFoundException
AccessDeniedException
InternalServiceException
ValidationException
IncompatibleVersionException
AmazonClientException - 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.

createPipeline

public CreatePipelineResult createPipeline()
                                    throws AmazonServiceException,
                                           AmazonClientException

To create a pipeline, send a POST request to the 2012-09-25/pipelines resource.

Specified by:
createPipeline in interface AmazonElasticTranscoder
Returns:
The response from the CreatePipeline service method, as returned by AmazonElasticTranscoder.
Throws:
AccessDeniedException
ResourceNotFoundException
InternalServiceException
LimitExceededException
ValidationException
IncompatibleVersionException
AmazonClientException - 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.

cancelJob

public CancelJobResult cancelJob()
                          throws AmazonServiceException,
                                 AmazonClientException

To cancel a job, send a DELETE request to the /2012-09-25/jobs/[jobId] resource.

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.

Specified by:
cancelJob in interface AmazonElasticTranscoder
Returns:
The response from the CancelJob service method, as returned by AmazonElasticTranscoder.
Throws:
ResourceNotFoundException
AccessDeniedException
ResourceInUseException
InternalServiceException
ValidationException
IncompatibleVersionException
AmazonClientException - 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.

listPresets

public ListPresetsResult listPresets()
                              throws AmazonServiceException,
                                     AmazonClientException

To get a list of all presets associated with the current AWS account, send a GET request to the /2012-09-25/presets resource.

Specified by:
listPresets in interface AmazonElasticTranscoder
Returns:
The response from the ListPresets service method, as returned by AmazonElasticTranscoder.
Throws:
AccessDeniedException
InternalServiceException
ValidationException
IncompatibleVersionException
AmazonClientException - 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.

deletePipeline

public DeletePipelineResult deletePipeline()
                                    throws AmazonServiceException,
                                           AmazonClientException

To delete a pipeline, send a DELETE request to the /2012-09-25/pipelines/[pipelineId] resource.

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.

Specified by:
deletePipeline in interface AmazonElasticTranscoder
Returns:
The response from the DeletePipeline service method, as returned by AmazonElasticTranscoder.
Throws:
ResourceNotFoundException
AccessDeniedException
ResourceInUseException
InternalServiceException
ValidationException
IncompatibleVersionException
AmazonClientException - 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.

testRole

public TestRoleResult testRole()
                        throws AmazonServiceException,
                               AmazonClientException

To test the IAM role that's used by Elastic Transcoder to create the pipeline, send a POST request to the /2012-09-25/roleTests resource.

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.

Specified by:
testRole in interface AmazonElasticTranscoder
Returns:
The response from the TestRole service method, as returned by AmazonElasticTranscoder.
Throws:
ResourceNotFoundException
AccessDeniedException
InternalServiceException
ValidationException
IncompatibleVersionException
AmazonClientException - 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.

listPipelines

public ListPipelinesResult listPipelines()
                                  throws AmazonServiceException,
                                         AmazonClientException

To get a list of the pipelines associated with the current AWS account, send a GET request to the /2012-09-25/pipelines resource.

Specified by:
listPipelines in interface AmazonElasticTranscoder
Returns:
The response from the ListPipelines service method, as returned by AmazonElasticTranscoder.
Throws:
AccessDeniedException
InternalServiceException
ValidationException
IncompatibleVersionException
AmazonClientException - 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.

readPipeline

public ReadPipelineResult readPipeline()
                                throws AmazonServiceException,
                                       AmazonClientException

To get detailed information about a pipeline, send a GET request to the /2012-09-25/pipelines/[pipelineId] resource.

Specified by:
readPipeline in interface AmazonElasticTranscoder
Returns:
The response from the ReadPipeline service method, as returned by AmazonElasticTranscoder.
Throws:
ResourceNotFoundException
AccessDeniedException
InternalServiceException
ValidationException
IncompatibleVersionException
AmazonClientException - 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.

createPreset

public CreatePresetResult createPreset()
                                throws AmazonServiceException,
                                       AmazonClientException

To create a preset, send a POST request to the /2012-09-25/presets resource.

IMPORTANT:Elastic Transcoder checks the settings that you specify 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 .

Specified by:
createPreset in interface AmazonElasticTranscoder
Returns:
The response from the CreatePreset service method, as returned by AmazonElasticTranscoder.
Throws:
AccessDeniedException
InternalServiceException
LimitExceededException
ValidationException
IncompatibleVersionException
AmazonClientException - 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.

deletePreset

public DeletePresetResult deletePreset()
                                throws AmazonServiceException,
                                       AmazonClientException

To delete a preset, send a DELETE request to the /2012-09-25/presets/[presetId] resource.

NOTE: If the preset has been used, you cannot delete it.

Specified by:
deletePreset in interface AmazonElasticTranscoder
Returns:
The response from the DeletePreset service method, as returned by AmazonElasticTranscoder.
Throws:
ResourceNotFoundException
AccessDeniedException
InternalServiceException
ValidationException
IncompatibleVersionException
AmazonClientException - 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.

createJob

public CreateJobResult createJob()
                          throws AmazonServiceException,
                                 AmazonClientException

To create a job, send a POST request to the /2012-09-25/jobs resource.

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).

Specified by:
createJob in interface AmazonElasticTranscoder
Returns:
The response from the CreateJob service method, as returned by AmazonElasticTranscoder.
Throws:
ResourceNotFoundException
AccessDeniedException
InternalServiceException
LimitExceededException
ValidationException
IncompatibleVersionException
AmazonClientException - 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.

listJobsByPipeline

public ListJobsByPipelineResult listJobsByPipeline()
                                            throws AmazonServiceException,
                                                   AmazonClientException

To get a list of the jobs currently in a pipeline, send a GET request to the /2012-09-25/jobsByPipeline/[pipelineId] resource.

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.

Specified by:
listJobsByPipeline in interface AmazonElasticTranscoder
Returns:
The response from the ListJobsByPipeline service method, as returned by AmazonElasticTranscoder.
Throws:
ResourceNotFoundException
AccessDeniedException
InternalServiceException
ValidationException
IncompatibleVersionException
AmazonClientException - 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.

setEndpoint

public void setEndpoint(String endpoint,
                        String serviceName,
                        String regionId)
                 throws IllegalArgumentException
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. In almost all cases, this region ID and service name are automatically determined from the endpoint, and callers should use the simpler one-argument form of setEndpoint instead of this method.

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

Parameters:
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.
Throws:
IllegalArgumentException - If any problems are detected with the specified endpoint.
See Also:
AmazonDynamoDB#setRegion(Region)

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:
getCachedResponseMetadata in interface AmazonElasticTranscoder
Parameters:
request - The originally executed request
Returns:
The response metadata for the specified request, or null if none is available.
Overview  Package   Class  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.