/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.elastictranscoder; import javax.annotation.Generated; import com.amazonaws.services.elastictranscoder.model.*; /** * Interface for accessing Amazon Elastic Transcoder asynchronously. Each asynchronous method will return a Java Future * object representing the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to receive * notification when an asynchronous operation completes. *
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.elastictranscoder.AbstractAmazonElasticTranscoderAsync} instead. *
*
*
* The AWS Elastic Transcoder Service. *
*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AmazonElasticTranscoderAsync extends AmazonElasticTranscoder { /** ** 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.
*
CancelJobRequest
structure.
* @return A Java Future containing the result of the CancelJob operation returned by the service.
* @sample AmazonElasticTranscoderAsync.CancelJob
*/
java.util.concurrent.Future* 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.
*
CancelJobRequest
structure.
* @param 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.
* @return A Java Future containing the result of the CancelJob operation returned by the service.
* @sample AmazonElasticTranscoderAsyncHandler.CancelJob
*/
java.util.concurrent.Future* 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). *
* * @param createJobRequest * TheCreateJobRequest
structure.
* @return A Java Future containing the result of the CreateJob operation returned by the service.
* @sample AmazonElasticTranscoderAsync.CreateJob
*/
java.util.concurrent.Future* 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). *
* * @param createJobRequest * TheCreateJobRequest
structure.
* @param 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.
* @return A Java Future containing the result of the CreateJob operation returned by the service.
* @sample AmazonElasticTranscoderAsyncHandler.CreateJob
*/
java.util.concurrent.Future* The CreatePipeline operation creates a pipeline with settings that you specify. *
* * @param createPipelineRequest * TheCreatePipelineRequest
structure.
* @return A Java Future containing the result of the CreatePipeline operation returned by the service.
* @sample AmazonElasticTranscoderAsync.CreatePipeline
*/
java.util.concurrent.Future* The CreatePipeline operation creates a pipeline with settings that you specify. *
* * @param createPipelineRequest * TheCreatePipelineRequest
structure.
* @param 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.
* @return A Java Future containing the result of the CreatePipeline operation returned by the service.
* @sample AmazonElasticTranscoderAsyncHandler.CreatePipeline
*/
java.util.concurrent.Future* 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. *
* * @param createPresetRequest * TheCreatePresetRequest
structure.
* @return A Java Future containing the result of the CreatePreset operation returned by the service.
* @sample AmazonElasticTranscoderAsync.CreatePreset
*/
java.util.concurrent.Future* 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. *
* * @param createPresetRequest * TheCreatePresetRequest
structure.
* @param 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.
* @return A Java Future containing the result of the CreatePreset operation returned by the service.
* @sample AmazonElasticTranscoderAsyncHandler.CreatePreset
*/
java.util.concurrent.Future* 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.
*
DeletePipelineRequest
structure.
* @return A Java Future containing the result of the DeletePipeline operation returned by the service.
* @sample AmazonElasticTranscoderAsync.DeletePipeline
*/
java.util.concurrent.Future* 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.
*
DeletePipelineRequest
structure.
* @param 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.
* @return A Java Future containing the result of the DeletePipeline operation returned by the service.
* @sample AmazonElasticTranscoderAsyncHandler.DeletePipeline
*/
java.util.concurrent.Future* 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. *
*DeletePresetRequest
structure.
* @return A Java Future containing the result of the DeletePreset operation returned by the service.
* @sample AmazonElasticTranscoderAsync.DeletePreset
*/
java.util.concurrent.Future* 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. *
*DeletePresetRequest
structure.
* @param 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.
* @return A Java Future containing the result of the DeletePreset operation returned by the service.
* @sample AmazonElasticTranscoderAsyncHandler.DeletePreset
*/
java.util.concurrent.Future* 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. *
* * @param listJobsByPipelineRequest * TheListJobsByPipelineRequest
structure.
* @return A Java Future containing the result of the ListJobsByPipeline operation returned by the service.
* @sample AmazonElasticTranscoderAsync.ListJobsByPipeline
*/
java.util.concurrent.Future* 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. *
* * @param listJobsByPipelineRequest * TheListJobsByPipelineRequest
structure.
* @param 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.
* @return A Java Future containing the result of the ListJobsByPipeline operation returned by the service.
* @sample AmazonElasticTranscoderAsyncHandler.ListJobsByPipeline
*/
java.util.concurrent.Future* 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. *
* * @param listJobsByStatusRequest * TheListJobsByStatusRequest
structure.
* @return A Java Future containing the result of the ListJobsByStatus operation returned by the service.
* @sample AmazonElasticTranscoderAsync.ListJobsByStatus
*/
java.util.concurrent.Future* 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. *
* * @param listJobsByStatusRequest * TheListJobsByStatusRequest
structure.
* @param 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.
* @return A Java Future containing the result of the ListJobsByStatus operation returned by the service.
* @sample AmazonElasticTranscoderAsyncHandler.ListJobsByStatus
*/
java.util.concurrent.Future* The ListPipelines operation gets a list of the pipelines associated with the current AWS account. *
* * @param listPipelinesRequest * TheListPipelineRequest
structure.
* @return A Java Future containing the result of the ListPipelines operation returned by the service.
* @sample AmazonElasticTranscoderAsync.ListPipelines
*/
java.util.concurrent.Future* The ListPipelines operation gets a list of the pipelines associated with the current AWS account. *
* * @param listPipelinesRequest * TheListPipelineRequest
structure.
* @param 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.
* @return A Java Future containing the result of the ListPipelines operation returned by the service.
* @sample AmazonElasticTranscoderAsyncHandler.ListPipelines
*/
java.util.concurrent.Future* 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. *
* * @param listPresetsRequest * TheListPresetsRequest
structure.
* @return A Java Future containing the result of the ListPresets operation returned by the service.
* @sample AmazonElasticTranscoderAsync.ListPresets
*/
java.util.concurrent.Future* 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. *
* * @param listPresetsRequest * TheListPresetsRequest
structure.
* @param 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.
* @return A Java Future containing the result of the ListPresets operation returned by the service.
* @sample AmazonElasticTranscoderAsyncHandler.ListPresets
*/
java.util.concurrent.Future* The ReadJob operation returns detailed information about a job. *
* * @param readJobRequest * TheReadJobRequest
structure.
* @return A Java Future containing the result of the ReadJob operation returned by the service.
* @sample AmazonElasticTranscoderAsync.ReadJob
*/
java.util.concurrent.Future* The ReadJob operation returns detailed information about a job. *
* * @param readJobRequest * TheReadJobRequest
structure.
* @param 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.
* @return A Java Future containing the result of the ReadJob operation returned by the service.
* @sample AmazonElasticTranscoderAsyncHandler.ReadJob
*/
java.util.concurrent.Future* The ReadPipeline operation gets detailed information about a pipeline. *
* * @param readPipelineRequest * TheReadPipelineRequest
structure.
* @return A Java Future containing the result of the ReadPipeline operation returned by the service.
* @sample AmazonElasticTranscoderAsync.ReadPipeline
*/
java.util.concurrent.Future* The ReadPipeline operation gets detailed information about a pipeline. *
* * @param readPipelineRequest * TheReadPipelineRequest
structure.
* @param 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.
* @return A Java Future containing the result of the ReadPipeline operation returned by the service.
* @sample AmazonElasticTranscoderAsyncHandler.ReadPipeline
*/
java.util.concurrent.Future* The ReadPreset operation gets detailed information about a preset. *
* * @param readPresetRequest * TheReadPresetRequest
structure.
* @return A Java Future containing the result of the ReadPreset operation returned by the service.
* @sample AmazonElasticTranscoderAsync.ReadPreset
*/
java.util.concurrent.Future* The ReadPreset operation gets detailed information about a preset. *
* * @param readPresetRequest * TheReadPresetRequest
structure.
* @param 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.
* @return A Java Future containing the result of the ReadPreset operation returned by the service.
* @sample AmazonElasticTranscoderAsyncHandler.ReadPreset
*/
java.util.concurrent.Future* 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.
*
TestRoleRequest
structure.
* @return A Java Future containing the result of the TestRole operation returned by the service.
* @sample AmazonElasticTranscoderAsync.TestRole
*/
@Deprecated
java.util.concurrent.Future* 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.
*
TestRoleRequest
structure.
* @param 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.
* @return A Java Future containing the result of the TestRole operation returned by the service.
* @sample AmazonElasticTranscoderAsyncHandler.TestRole
*/
@Deprecated
java.util.concurrent.Future
* 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. *
*UpdatePipelineRequest
structure.
* @return A Java Future containing the result of the UpdatePipeline operation returned by the service.
* @sample AmazonElasticTranscoderAsync.UpdatePipeline
*/
java.util.concurrent.Future
* 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. *
*UpdatePipelineRequest
structure.
* @param 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.
* @return A Java Future containing the result of the UpdatePipeline operation returned by the service.
* @sample AmazonElasticTranscoderAsyncHandler.UpdatePipeline
*/
java.util.concurrent.Future* 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. *
* * @param updatePipelineNotificationsRequest * TheUpdatePipelineNotificationsRequest
structure.
* @return A Java Future containing the result of the UpdatePipelineNotifications operation returned by the service.
* @sample AmazonElasticTranscoderAsync.UpdatePipelineNotifications
*/
java.util.concurrent.Future* 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. *
* * @param updatePipelineNotificationsRequest * TheUpdatePipelineNotificationsRequest
structure.
* @param 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.
* @return A Java Future containing the result of the UpdatePipelineNotifications operation returned by the service.
* @sample AmazonElasticTranscoderAsyncHandler.UpdatePipelineNotifications
*/
java.util.concurrent.Future* 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. *
* * @param updatePipelineStatusRequest * TheUpdatePipelineStatusRequest
structure.
* @return A Java Future containing the result of the UpdatePipelineStatus operation returned by the service.
* @sample AmazonElasticTranscoderAsync.UpdatePipelineStatus
*/
java.util.concurrent.Future* 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. *
* * @param updatePipelineStatusRequest * TheUpdatePipelineStatusRequest
structure.
* @param 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.
* @return A Java Future containing the result of the UpdatePipelineStatus operation returned by the service.
* @sample AmazonElasticTranscoderAsyncHandler.UpdatePipelineStatus
*/
java.util.concurrent.Future