Class AmazonElasticTranscoderAsyncClient

  • All Implemented Interfaces:
    AmazonElasticTranscoder, AmazonElasticTranscoderAsync

    public class AmazonElasticTranscoderAsyncClient
    extends AmazonElasticTranscoderClient
    implements AmazonElasticTranscoderAsync
    Interface for accessing Amazon Elastic Transcoder asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

    AWS Elastic Transcoder Service

    The AWS Elastic Transcoder Service.

    • Constructor Detail

      • AmazonElasticTranscoderAsyncClient

        public AmazonElasticTranscoderAsyncClient()
        Constructs a new asynchronous client to invoke service methods on Amazon Elastic Transcoder. A credentials provider chain will be used that searches for credentials in this order:
        • Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
        • Java System Properties - aws.accessKeyId and aws.secretKey
        • Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
        • Instance profile credentials delivered through the Amazon EC2 metadata service

        Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).

        See Also:
        DefaultAWSCredentialsProviderChain, Executors.newFixedThreadPool(int)
      • AmazonElasticTranscoderAsyncClient

        public AmazonElasticTranscoderAsyncClient​(ClientConfiguration clientConfiguration)
        Constructs a new asynchronous client to invoke service methods on Amazon Elastic Transcoder. A credentials provider chain will be used that searches for credentials in this order:
        • Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
        • Java System Properties - aws.accessKeyId and aws.secretKey
        • Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
        • Instance profile credentials delivered through the Amazon EC2 metadata service

        Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().

        Parameters:
        clientConfiguration - The client configuration options controlling how this client connects to Amazon Elastic Transcoder (ex: proxy settings, retry counts, etc).
        See Also:
        DefaultAWSCredentialsProviderChain, Executors.newFixedThreadPool(int)
      • AmazonElasticTranscoderAsyncClient

        public AmazonElasticTranscoderAsyncClient​(AWSCredentials awsCredentials)
        Constructs a new asynchronous client to invoke service methods on Amazon Elastic Transcoder using the specified AWS account credentials.

        Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).

        Parameters:
        awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
        See Also:
        Executors.newFixedThreadPool(int)
      • AmazonElasticTranscoderAsyncClient

        public AmazonElasticTranscoderAsyncClient​(AWSCredentials awsCredentials,
                                                  ExecutorService executorService)
        Constructs a new asynchronous client to invoke service methods on Amazon Elastic Transcoder using the specified AWS account credentials and executor service. Default client settings will be used.
        Parameters:
        awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
        executorService - The executor service by which all asynchronous requests will be executed.
      • AmazonElasticTranscoderAsyncClient

        public AmazonElasticTranscoderAsyncClient​(AWSCredentials awsCredentials,
                                                  ClientConfiguration clientConfiguration,
                                                  ExecutorService executorService)
        Constructs a new asynchronous client to invoke service methods on Amazon Elastic Transcoder using the specified AWS account credentials, executor service, and client configuration options.
        Parameters:
        awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
        clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).
        executorService - The executor service by which all asynchronous requests will be executed.
      • AmazonElasticTranscoderAsyncClient

        public AmazonElasticTranscoderAsyncClient​(AWSCredentialsProvider awsCredentialsProvider)
        Constructs a new asynchronous client to invoke service methods on Amazon Elastic Transcoder using the specified AWS account credentials provider. Default client settings will be used.

        Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).

        Parameters:
        awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
        See Also:
        Executors.newFixedThreadPool(int)
      • AmazonElasticTranscoderAsyncClient

        public AmazonElasticTranscoderAsyncClient​(AWSCredentialsProvider awsCredentialsProvider,
                                                  ClientConfiguration clientConfiguration)
        Constructs a new asynchronous client to invoke service methods on Amazon Elastic Transcoder using the provided AWS account credentials provider and client configuration options.

        Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().

        Parameters:
        awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
        clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).
        See Also:
        DefaultAWSCredentialsProviderChain, Executors.newFixedThreadPool(int)
      • AmazonElasticTranscoderAsyncClient

        public AmazonElasticTranscoderAsyncClient​(AWSCredentialsProvider awsCredentialsProvider,
                                                  ExecutorService executorService)
        Constructs a new asynchronous client to invoke service methods on Amazon Elastic Transcoder using the specified AWS account credentials provider and executor service. Default client settings will be used.
        Parameters:
        awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
        executorService - The executor service by which all asynchronous requests will be executed.
      • AmazonElasticTranscoderAsyncClient

        public AmazonElasticTranscoderAsyncClient​(AWSCredentialsProvider awsCredentialsProvider,
                                                  ClientConfiguration clientConfiguration,
                                                  ExecutorService executorService)
        Constructs a new asynchronous client to invoke service methods on Amazon Elastic Transcoder using the specified AWS account credentials provider, executor service, and client configuration options.
        Parameters:
        awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
        clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).
        executorService - The executor service by which all asynchronous requests will be executed.
    • Method Detail

      • getExecutorService

        public ExecutorService getExecutorService()
        Returns the executor service used by this client to execute async requests.
        Returns:
        The executor service used by this client to execute async requests.
      • cancelJobAsync

        public Future<CancelJobResult> cancelJobAsync​(CancelJobRequest request)
        Description copied from interface: AmazonElasticTranscoderAsync

        The CancelJob operation cancels an unfinished job.

        You can only cancel a job that has a status of Submitted. To prevent a pipeline from starting to process a job while you're getting the job identifier, use UpdatePipelineStatus to temporarily pause the pipeline.
        Specified by:
        cancelJobAsync in interface AmazonElasticTranscoderAsync
        Parameters:
        request - The CancelJobRequest structure.
        Returns:
        A Java Future containing the result of the CancelJob operation returned by the service.
      • cancelJobAsync

        public Future<CancelJobResult> cancelJobAsync​(CancelJobRequest request,
                                                      AsyncHandler<CancelJobRequest,​CancelJobResult> asyncHandler)
        Description copied from interface: AmazonElasticTranscoderAsync

        The CancelJob operation cancels an unfinished job.

        You can only cancel a job that has a status of Submitted. To prevent a pipeline from starting to process a job while you're getting the job identifier, use UpdatePipelineStatus to temporarily pause the pipeline.
        Specified by:
        cancelJobAsync in interface AmazonElasticTranscoderAsync
        Parameters:
        request - The CancelJobRequest structure.
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the CancelJob operation returned by the service.
      • createJobAsync

        public Future<CreateJobResult> createJobAsync​(CreateJobRequest request)
        Description copied from interface: AmazonElasticTranscoderAsync

        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:
        createJobAsync in interface AmazonElasticTranscoderAsync
        Parameters:
        request - The CreateJobRequest structure.
        Returns:
        A Java Future containing the result of the CreateJob operation returned by the service.
      • createJobAsync

        public Future<CreateJobResult> createJobAsync​(CreateJobRequest request,
                                                      AsyncHandler<CreateJobRequest,​CreateJobResult> asyncHandler)
        Description copied from interface: AmazonElasticTranscoderAsync

        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:
        createJobAsync in interface AmazonElasticTranscoderAsync
        Parameters:
        request - The CreateJobRequest structure.
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the CreateJob operation returned by the service.
      • createPresetAsync

        public Future<CreatePresetResult> createPresetAsync​(CreatePresetRequest request)
        Description copied from interface: AmazonElasticTranscoderAsync

        The CreatePreset operation creates a preset with settings that you specify.

        Elastic Transcoder checks the CreatePreset settings to ensure that they meet Elastic Transcoder requirements and to determine whether they comply with H.264 standards. If your settings are not valid for Elastic Transcoder, Elastic Transcoder returns an HTTP 400 response ( ValidationException) and does not create the preset. If the settings are valid for Elastic Transcoder but aren't strictly compliant with the H.264 standard, Elastic Transcoder creates the preset and returns a warning message in the response. This helps you determine whether your settings comply with the H.264 standard while giving you greater flexibility with respect to the video that Elastic Transcoder produces.

        Elastic Transcoder uses the H.264 video-compression format. For more information, see the International Telecommunication Union publication Recommendation ITU-T H.264: Advanced video coding for generic audiovisual services.

        Specified by:
        createPresetAsync in interface AmazonElasticTranscoderAsync
        Parameters:
        request - The CreatePresetRequest structure.
        Returns:
        A Java Future containing the result of the CreatePreset operation returned by the service.
      • createPresetAsync

        public Future<CreatePresetResult> createPresetAsync​(CreatePresetRequest request,
                                                            AsyncHandler<CreatePresetRequest,​CreatePresetResult> asyncHandler)
        Description copied from interface: AmazonElasticTranscoderAsync

        The CreatePreset operation creates a preset with settings that you specify.

        Elastic Transcoder checks the CreatePreset settings to ensure that they meet Elastic Transcoder requirements and to determine whether they comply with H.264 standards. If your settings are not valid for Elastic Transcoder, Elastic Transcoder returns an HTTP 400 response ( ValidationException) and does not create the preset. If the settings are valid for Elastic Transcoder but aren't strictly compliant with the H.264 standard, Elastic Transcoder creates the preset and returns a warning message in the response. This helps you determine whether your settings comply with the H.264 standard while giving you greater flexibility with respect to the video that Elastic Transcoder produces.

        Elastic Transcoder uses the H.264 video-compression format. For more information, see the International Telecommunication Union publication Recommendation ITU-T H.264: Advanced video coding for generic audiovisual services.

        Specified by:
        createPresetAsync in interface AmazonElasticTranscoderAsync
        Parameters:
        request - The CreatePresetRequest structure.
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the CreatePreset operation returned by the service.
      • deletePipelineAsync

        public Future<DeletePipelineResult> deletePipelineAsync​(DeletePipelineRequest request)
        Description copied from interface: AmazonElasticTranscoderAsync

        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.

        Specified by:
        deletePipelineAsync in interface AmazonElasticTranscoderAsync
        Parameters:
        request - The DeletePipelineRequest structure.
        Returns:
        A Java Future containing the result of the DeletePipeline operation returned by the service.
      • deletePipelineAsync

        public Future<DeletePipelineResult> deletePipelineAsync​(DeletePipelineRequest request,
                                                                AsyncHandler<DeletePipelineRequest,​DeletePipelineResult> asyncHandler)
        Description copied from interface: AmazonElasticTranscoderAsync

        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.

        Specified by:
        deletePipelineAsync in interface AmazonElasticTranscoderAsync
        Parameters:
        request - The DeletePipelineRequest structure.
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the DeletePipeline operation returned by the service.
      • deletePresetAsync

        public Future<DeletePresetResult> deletePresetAsync​(DeletePresetRequest request,
                                                            AsyncHandler<DeletePresetRequest,​DeletePresetResult> asyncHandler)
        Description copied from interface: AmazonElasticTranscoderAsync

        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.

        Specified by:
        deletePresetAsync in interface AmazonElasticTranscoderAsync
        Parameters:
        request - The DeletePresetRequest structure.
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the DeletePreset operation returned by the service.
      • listJobsByPipelineAsync

        public Future<ListJobsByPipelineResult> listJobsByPipelineAsync​(ListJobsByPipelineRequest request)
        Description copied from interface: AmazonElasticTranscoderAsync

        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.

        Specified by:
        listJobsByPipelineAsync in interface AmazonElasticTranscoderAsync
        Parameters:
        request - The ListJobsByPipelineRequest structure.
        Returns:
        A Java Future containing the result of the ListJobsByPipeline operation returned by the service.
      • listJobsByPipelineAsync

        public Future<ListJobsByPipelineResult> listJobsByPipelineAsync​(ListJobsByPipelineRequest request,
                                                                        AsyncHandler<ListJobsByPipelineRequest,​ListJobsByPipelineResult> asyncHandler)
        Description copied from interface: AmazonElasticTranscoderAsync

        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.

        Specified by:
        listJobsByPipelineAsync in interface AmazonElasticTranscoderAsync
        Parameters:
        request - The ListJobsByPipelineRequest structure.
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the ListJobsByPipeline operation returned by the service.
      • listJobsByStatusAsync

        public Future<ListJobsByStatusResult> listJobsByStatusAsync​(ListJobsByStatusRequest request,
                                                                    AsyncHandler<ListJobsByStatusRequest,​ListJobsByStatusResult> asyncHandler)
        Description copied from interface: AmazonElasticTranscoderAsync

        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.

        Specified by:
        listJobsByStatusAsync in interface AmazonElasticTranscoderAsync
        Parameters:
        request - The ListJobsByStatusRequest structure.
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the ListJobsByStatus operation returned by the service.
      • listPresetsAsync

        public Future<ListPresetsResult> listPresetsAsync​(ListPresetsRequest request,
                                                          AsyncHandler<ListPresetsRequest,​ListPresetsResult> asyncHandler)
        Description copied from interface: AmazonElasticTranscoderAsync

        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.

        Specified by:
        listPresetsAsync in interface AmazonElasticTranscoderAsync
        Parameters:
        request - The ListPresetsRequest structure.
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the ListPresets operation returned by the service.
      • readJobAsync

        public Future<ReadJobResult> readJobAsync​(ReadJobRequest request,
                                                  AsyncHandler<ReadJobRequest,​ReadJobResult> asyncHandler)
        Description copied from interface: AmazonElasticTranscoderAsync

        The ReadJob operation returns detailed information about a job.

        Specified by:
        readJobAsync in interface AmazonElasticTranscoderAsync
        Parameters:
        request - The ReadJobRequest structure.
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the ReadJob operation returned by the service.
      • testRoleAsync

        public Future<TestRoleResult> testRoleAsync​(TestRoleRequest request)
        Description copied from interface: AmazonElasticTranscoderAsync

        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.

        Specified by:
        testRoleAsync in interface AmazonElasticTranscoderAsync
        Parameters:
        request - The TestRoleRequest structure.
        Returns:
        A Java Future containing the result of the TestRole operation returned by the service.
      • testRoleAsync

        public Future<TestRoleResult> testRoleAsync​(TestRoleRequest request,
                                                    AsyncHandler<TestRoleRequest,​TestRoleResult> asyncHandler)
        Description copied from interface: AmazonElasticTranscoderAsync

        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.

        Specified by:
        testRoleAsync in interface AmazonElasticTranscoderAsync
        Parameters:
        request - The TestRoleRequest structure.
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the TestRole operation returned by the service.
      • updatePipelineAsync

        public Future<UpdatePipelineResult> updatePipelineAsync​(UpdatePipelineRequest request)
        Description copied from interface: AmazonElasticTranscoderAsync

        Use the UpdatePipeline operation to update settings for a pipeline. When you change pipeline settings, your changes take effect immediately. Jobs that you have already submitted and that Elastic Transcoder has not started to process are affected in addition to jobs that you submit after you change settings.

        Specified by:
        updatePipelineAsync in interface AmazonElasticTranscoderAsync
        Parameters:
        request - The UpdatePipelineRequest structure.
        Returns:
        A Java Future containing the result of the UpdatePipeline operation returned by the service.
      • updatePipelineAsync

        public Future<UpdatePipelineResult> updatePipelineAsync​(UpdatePipelineRequest request,
                                                                AsyncHandler<UpdatePipelineRequest,​UpdatePipelineResult> asyncHandler)
        Description copied from interface: AmazonElasticTranscoderAsync

        Use the UpdatePipeline operation to update settings for a pipeline. When you change pipeline settings, your changes take effect immediately. Jobs that you have already submitted and that Elastic Transcoder has not started to process are affected in addition to jobs that you submit after you change settings.

        Specified by:
        updatePipelineAsync in interface AmazonElasticTranscoderAsync
        Parameters:
        request - The UpdatePipelineRequest structure.
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the UpdatePipeline operation returned by the service.
      • updatePipelineStatusAsync

        public Future<UpdatePipelineStatusResult> updatePipelineStatusAsync​(UpdatePipelineStatusRequest request)
        Description copied from interface: AmazonElasticTranscoderAsync

        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.

        Specified by:
        updatePipelineStatusAsync in interface AmazonElasticTranscoderAsync
        Parameters:
        request - The UpdatePipelineStatusRequest structure.
        Returns:
        A Java Future containing the result of the UpdatePipelineStatus operation returned by the service.
      • updatePipelineStatusAsync

        public Future<UpdatePipelineStatusResult> updatePipelineStatusAsync​(UpdatePipelineStatusRequest request,
                                                                            AsyncHandler<UpdatePipelineStatusRequest,​UpdatePipelineStatusResult> asyncHandler)
        Description copied from interface: AmazonElasticTranscoderAsync

        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.

        Specified by:
        updatePipelineStatusAsync in interface AmazonElasticTranscoderAsync
        Parameters:
        request - The UpdatePipelineStatusRequest structure.
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the UpdatePipelineStatus operation returned by the service.
      • shutdown

        public void shutdown()
        Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.
        Specified by:
        shutdown in interface AmazonElasticTranscoder
        Overrides:
        shutdown in class AmazonWebServiceClient