/*
* Copyright 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.
*/
/*
* Do not modify this file. This file is generated from the elastictranscoder-2012-09-25.normal.json service model.
*/
using System;
using System.Threading;
using System.Threading.Tasks;
using System.Collections.Generic;
using Amazon.Runtime;
using Amazon.ElasticTranscoder.Model;
namespace Amazon.ElasticTranscoder
{
///
/// Interface for accessing ElasticTranscoder
///
/// AWS Elastic Transcoder Service
///
/// The AWS Elastic Transcoder Service.
///
///
public partial interface IAmazonElasticTranscoder : IAmazonService, IDisposable
{
#if AWS_ASYNC_ENUMERABLES_API
///
/// Paginators for the service
///
IElasticTranscoderPaginatorFactory Paginators { get; }
#endif
#region CancelJob
///
/// 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.
///
///
///
/// Container for the necessary parameters to execute the CancelJob service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CancelJob service method, as returned by ElasticTranscoder.
///
/// General authentication failure. The request was not signed correctly.
///
///
///
///
///
/// Elastic Transcoder encountered an unexpected exception while trying to fulfill the
/// request.
///
///
/// The resource you are attempting to change is in use. For example, you are attempting
/// to delete a pipeline that is currently in use.
///
///
/// The requested resource does not exist or is not available. For example, the pipeline
/// to which you're trying to add a job doesn't exist or is still being created.
///
///
/// One or more required parameter values were not provided in the request.
///
/// REST API Reference for CancelJob Operation
Task CancelJobAsync(CancelJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreateJob
///
/// 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).
///
///
/// Container for the necessary parameters to execute the CreateJob service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateJob service method, as returned by ElasticTranscoder.
///
/// General authentication failure. The request was not signed correctly.
///
///
///
///
///
/// Elastic Transcoder encountered an unexpected exception while trying to fulfill the
/// request.
///
///
/// Too many operations for a given AWS account. For example, the number of pipelines
/// exceeds the maximum allowed.
///
///
/// The requested resource does not exist or is not available. For example, the pipeline
/// to which you're trying to add a job doesn't exist or is still being created.
///
///
/// One or more required parameter values were not provided in the request.
///
/// REST API Reference for CreateJob Operation
Task CreateJobAsync(CreateJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreatePipeline
///
/// The CreatePipeline operation creates a pipeline with settings that you specify.
///
/// Container for the necessary parameters to execute the CreatePipeline service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreatePipeline service method, as returned by ElasticTranscoder.
///
/// General authentication failure. The request was not signed correctly.
///
///
///
///
///
/// Elastic Transcoder encountered an unexpected exception while trying to fulfill the
/// request.
///
///
/// Too many operations for a given AWS account. For example, the number of pipelines
/// exceeds the maximum allowed.
///
///
/// The requested resource does not exist or is not available. For example, the pipeline
/// to which you're trying to add a job doesn't exist or is still being created.
///
///
/// One or more required parameter values were not provided in the request.
///
/// REST API Reference for CreatePipeline Operation
Task CreatePipelineAsync(CreatePipelineRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreatePreset
///
/// 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.
///
///
/// Container for the necessary parameters to execute the CreatePreset service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreatePreset service method, as returned by ElasticTranscoder.
///
/// General authentication failure. The request was not signed correctly.
///
///
///
///
///
/// Elastic Transcoder encountered an unexpected exception while trying to fulfill the
/// request.
///
///
/// Too many operations for a given AWS account. For example, the number of pipelines
/// exceeds the maximum allowed.
///
///
/// One or more required parameter values were not provided in the request.
///
/// REST API Reference for CreatePreset Operation
Task CreatePresetAsync(CreatePresetRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeletePipeline
///
/// 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.
///
///
/// Container for the necessary parameters to execute the DeletePipeline service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeletePipeline service method, as returned by ElasticTranscoder.
///
/// General authentication failure. The request was not signed correctly.
///
///
///
///
///
/// Elastic Transcoder encountered an unexpected exception while trying to fulfill the
/// request.
///
///
/// The resource you are attempting to change is in use. For example, you are attempting
/// to delete a pipeline that is currently in use.
///
///
/// The requested resource does not exist or is not available. For example, the pipeline
/// to which you're trying to add a job doesn't exist or is still being created.
///
///
/// One or more required parameter values were not provided in the request.
///
/// REST API Reference for DeletePipeline Operation
Task DeletePipelineAsync(DeletePipelineRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeletePreset
///
/// 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.
///
///
///
/// Container for the necessary parameters to execute the DeletePreset service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeletePreset service method, as returned by ElasticTranscoder.
///
/// General authentication failure. The request was not signed correctly.
///
///
///
///
///
/// Elastic Transcoder encountered an unexpected exception while trying to fulfill the
/// request.
///
///
/// The requested resource does not exist or is not available. For example, the pipeline
/// to which you're trying to add a job doesn't exist or is still being created.
///
///
/// One or more required parameter values were not provided in the request.
///
/// REST API Reference for DeletePreset Operation
Task DeletePresetAsync(DeletePresetRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListJobsByPipeline
///
/// 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.
///
///
/// Container for the necessary parameters to execute the ListJobsByPipeline service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListJobsByPipeline service method, as returned by ElasticTranscoder.
///
/// General authentication failure. The request was not signed correctly.
///
///
///
///
///
/// Elastic Transcoder encountered an unexpected exception while trying to fulfill the
/// request.
///
///
/// The requested resource does not exist or is not available. For example, the pipeline
/// to which you're trying to add a job doesn't exist or is still being created.
///
///
/// One or more required parameter values were not provided in the request.
///
/// REST API Reference for ListJobsByPipeline Operation
Task ListJobsByPipelineAsync(ListJobsByPipelineRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListJobsByStatus
///
/// 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.
///
/// Container for the necessary parameters to execute the ListJobsByStatus service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListJobsByStatus service method, as returned by ElasticTranscoder.
///
/// General authentication failure. The request was not signed correctly.
///
///
///
///
///
/// Elastic Transcoder encountered an unexpected exception while trying to fulfill the
/// request.
///
///
/// The requested resource does not exist or is not available. For example, the pipeline
/// to which you're trying to add a job doesn't exist or is still being created.
///
///
/// One or more required parameter values were not provided in the request.
///
/// REST API Reference for ListJobsByStatus Operation
Task ListJobsByStatusAsync(ListJobsByStatusRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListPipelines
///
/// The ListPipelines operation gets a list of the pipelines associated with the current
/// AWS account.
///
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListPipelines service method, as returned by ElasticTranscoder.
///
/// General authentication failure. The request was not signed correctly.
///
///
///
///
///
/// Elastic Transcoder encountered an unexpected exception while trying to fulfill the
/// request.
///
///
/// One or more required parameter values were not provided in the request.
///
/// REST API Reference for ListPipelines Operation
Task ListPipelinesAsync(System.Threading.CancellationToken cancellationToken = default(CancellationToken));
///
/// The ListPipelines operation gets a list of the pipelines associated with the current
/// AWS account.
///
/// Container for the necessary parameters to execute the ListPipelines service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListPipelines service method, as returned by ElasticTranscoder.
///
/// General authentication failure. The request was not signed correctly.
///
///
///
///
///
/// Elastic Transcoder encountered an unexpected exception while trying to fulfill the
/// request.
///
///
/// One or more required parameter values were not provided in the request.
///
/// REST API Reference for ListPipelines Operation
Task ListPipelinesAsync(ListPipelinesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListPresets
///
/// The ListPresets operation gets a list of the default presets included with Elastic
/// Transcoder and the presets that you've added in an AWS region.
///
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListPresets service method, as returned by ElasticTranscoder.
///
/// General authentication failure. The request was not signed correctly.
///
///
///
///
///
/// Elastic Transcoder encountered an unexpected exception while trying to fulfill the
/// request.
///
///
/// One or more required parameter values were not provided in the request.
///
/// REST API Reference for ListPresets Operation
Task ListPresetsAsync(System.Threading.CancellationToken cancellationToken = default(CancellationToken));
///
/// 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.
///
/// Container for the necessary parameters to execute the ListPresets service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListPresets service method, as returned by ElasticTranscoder.
///
/// General authentication failure. The request was not signed correctly.
///
///
///
///
///
/// Elastic Transcoder encountered an unexpected exception while trying to fulfill the
/// request.
///
///
/// One or more required parameter values were not provided in the request.
///
/// REST API Reference for ListPresets Operation
Task ListPresetsAsync(ListPresetsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ReadJob
///
/// The ReadJob operation returns detailed information about a job.
///
/// Container for the necessary parameters to execute the ReadJob service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ReadJob service method, as returned by ElasticTranscoder.
///
/// General authentication failure. The request was not signed correctly.
///
///
///
///
///
/// Elastic Transcoder encountered an unexpected exception while trying to fulfill the
/// request.
///
///
/// The requested resource does not exist or is not available. For example, the pipeline
/// to which you're trying to add a job doesn't exist or is still being created.
///
///
/// One or more required parameter values were not provided in the request.
///
/// REST API Reference for ReadJob Operation
Task ReadJobAsync(ReadJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ReadPipeline
///
/// The ReadPipeline operation gets detailed information about a pipeline.
///
/// Container for the necessary parameters to execute the ReadPipeline service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ReadPipeline service method, as returned by ElasticTranscoder.
///
/// General authentication failure. The request was not signed correctly.
///
///
///
///
///
/// Elastic Transcoder encountered an unexpected exception while trying to fulfill the
/// request.
///
///
/// The requested resource does not exist or is not available. For example, the pipeline
/// to which you're trying to add a job doesn't exist or is still being created.
///
///
/// One or more required parameter values were not provided in the request.
///
/// REST API Reference for ReadPipeline Operation
Task ReadPipelineAsync(ReadPipelineRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ReadPreset
///
/// The ReadPreset operation gets detailed information about a preset.
///
/// Container for the necessary parameters to execute the ReadPreset service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ReadPreset service method, as returned by ElasticTranscoder.
///
/// General authentication failure. The request was not signed correctly.
///
///
///
///
///
/// Elastic Transcoder encountered an unexpected exception while trying to fulfill the
/// request.
///
///
/// The requested resource does not exist or is not available. For example, the pipeline
/// to which you're trying to add a job doesn't exist or is still being created.
///
///
/// One or more required parameter values were not provided in the request.
///
/// REST API Reference for ReadPreset Operation
Task ReadPresetAsync(ReadPresetRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region TestRole
///
/// 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.
///
///
/// Container for the necessary parameters to execute the TestRole service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the TestRole service method, as returned by ElasticTranscoder.
///
/// General authentication failure. The request was not signed correctly.
///
///
///
///
///
/// Elastic Transcoder encountered an unexpected exception while trying to fulfill the
/// request.
///
///
/// The requested resource does not exist or is not available. For example, the pipeline
/// to which you're trying to add a job doesn't exist or is still being created.
///
///
/// One or more required parameter values were not provided in the request.
///
/// REST API Reference for TestRole Operation
[Obsolete("This API is deprecated and will be removed in a future release.")]
Task TestRoleAsync(TestRoleRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UpdatePipeline
///
/// 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.
///
///
///
/// Container for the necessary parameters to execute the UpdatePipeline service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdatePipeline service method, as returned by ElasticTranscoder.
///
/// General authentication failure. The request was not signed correctly.
///
///
///
///
///
/// Elastic Transcoder encountered an unexpected exception while trying to fulfill the
/// request.
///
///
/// The resource you are attempting to change is in use. For example, you are attempting
/// to delete a pipeline that is currently in use.
///
///
/// The requested resource does not exist or is not available. For example, the pipeline
/// to which you're trying to add a job doesn't exist or is still being created.
///
///
/// One or more required parameter values were not provided in the request.
///
/// REST API Reference for UpdatePipeline Operation
Task UpdatePipelineAsync(UpdatePipelineRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UpdatePipelineNotifications
///
/// 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.
///
///
/// Container for the necessary parameters to execute the UpdatePipelineNotifications service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdatePipelineNotifications service method, as returned by ElasticTranscoder.
///
/// General authentication failure. The request was not signed correctly.
///
///
///
///
///
/// Elastic Transcoder encountered an unexpected exception while trying to fulfill the
/// request.
///
///
/// The resource you are attempting to change is in use. For example, you are attempting
/// to delete a pipeline that is currently in use.
///
///
/// The requested resource does not exist or is not available. For example, the pipeline
/// to which you're trying to add a job doesn't exist or is still being created.
///
///
/// One or more required parameter values were not provided in the request.
///
/// REST API Reference for UpdatePipelineNotifications Operation
Task UpdatePipelineNotificationsAsync(UpdatePipelineNotificationsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UpdatePipelineStatus
///
/// 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.
///
///
/// Container for the necessary parameters to execute the UpdatePipelineStatus service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdatePipelineStatus service method, as returned by ElasticTranscoder.
///
/// General authentication failure. The request was not signed correctly.
///
///
///
///
///
/// Elastic Transcoder encountered an unexpected exception while trying to fulfill the
/// request.
///
///
/// The resource you are attempting to change is in use. For example, you are attempting
/// to delete a pipeline that is currently in use.
///
///
/// The requested resource does not exist or is not available. For example, the pipeline
/// to which you're trying to add a job doesn't exist or is still being created.
///
///
/// One or more required parameter values were not provided in the request.
///
/// REST API Reference for UpdatePipelineStatus Operation
Task UpdatePipelineStatusAsync(UpdatePipelineStatusRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
}
}