/*
* 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 translate-2017-07-01.normal.json service model.
*/
using System;
using System.Threading;
using System.Threading.Tasks;
using System.Collections.Generic;
using Amazon.Runtime;
using Amazon.Translate.Model;
namespace Amazon.Translate
{
///
/// Interface for accessing Translate
///
/// Provides translation of the input content from the source language to the target language.
///
public partial interface IAmazonTranslate : IAmazonService, IDisposable
{
#if AWS_ASYNC_ENUMERABLES_API
///
/// Paginators for the service
///
ITranslatePaginatorFactory Paginators { get; }
#endif
#region CreateParallelData
///
/// Creates a parallel data resource in Amazon Translate by importing an input file from
/// Amazon S3. Parallel data files contain examples that show how you want segments of
/// text to be translated. By adding parallel data, you can influence the style, tone,
/// and word choice in your translation output.
///
/// Container for the necessary parameters to execute the CreateParallelData service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateParallelData service method, as returned by Translate.
///
/// Another modification is being made. That modification must complete before you can
/// make your change.
///
///
/// There was a conflict processing the request. Try your request again.
///
///
/// An internal server error occurred. Retry your request.
///
///
/// The value of the parameter is not valid. Review the value of the parameter you are
/// using to correct it, and then retry your operation.
///
///
/// The request that you made is not valid. Check your request to determine why it's
/// not valid and then retry the request.
///
///
/// The specified limit has been exceeded. Review your request and retry it with a quantity
/// below the stated limit.
///
///
/// You have made too many requests within a short period of time. Wait for a short time
/// and then try your request again.
///
///
/// You have added too many tags to this resource. The maximum is 50 tags.
///
/// REST API Reference for CreateParallelData Operation
Task CreateParallelDataAsync(CreateParallelDataRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteParallelData
///
/// Deletes a parallel data resource in Amazon Translate.
///
/// Container for the necessary parameters to execute the DeleteParallelData service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteParallelData service method, as returned by Translate.
///
/// Another modification is being made. That modification must complete before you can
/// make your change.
///
///
/// An internal server error occurred. Retry your request.
///
///
/// The resource you are looking for has not been found. Review the resource you're looking
/// for and see if a different resource will accomplish your needs before retrying the
/// revised request.
///
///
/// You have made too many requests within a short period of time. Wait for a short time
/// and then try your request again.
///
/// REST API Reference for DeleteParallelData Operation
Task DeleteParallelDataAsync(DeleteParallelDataRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteTerminology
///
/// A synchronous action that deletes a custom terminology.
///
/// Container for the necessary parameters to execute the DeleteTerminology service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteTerminology service method, as returned by Translate.
///
/// An internal server error occurred. Retry your request.
///
///
/// The value of the parameter is not valid. Review the value of the parameter you are
/// using to correct it, and then retry your operation.
///
///
/// The resource you are looking for has not been found. Review the resource you're looking
/// for and see if a different resource will accomplish your needs before retrying the
/// revised request.
///
///
/// You have made too many requests within a short period of time. Wait for a short time
/// and then try your request again.
///
/// REST API Reference for DeleteTerminology Operation
Task DeleteTerminologyAsync(DeleteTerminologyRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeTextTranslationJob
///
/// Gets the properties associated with an asynchronous batch translation job including
/// name, ID, status, source and target languages, input/output S3 buckets, and so on.
///
/// Container for the necessary parameters to execute the DescribeTextTranslationJob service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeTextTranslationJob service method, as returned by Translate.
///
/// An internal server error occurred. Retry your request.
///
///
/// The resource you are looking for has not been found. Review the resource you're looking
/// for and see if a different resource will accomplish your needs before retrying the
/// revised request.
///
///
/// You have made too many requests within a short period of time. Wait for a short time
/// and then try your request again.
///
/// REST API Reference for DescribeTextTranslationJob Operation
Task DescribeTextTranslationJobAsync(DescribeTextTranslationJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetParallelData
///
/// Provides information about a parallel data resource.
///
/// Container for the necessary parameters to execute the GetParallelData service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetParallelData service method, as returned by Translate.
///
/// An internal server error occurred. Retry your request.
///
///
/// The value of the parameter is not valid. Review the value of the parameter you are
/// using to correct it, and then retry your operation.
///
///
/// The resource you are looking for has not been found. Review the resource you're looking
/// for and see if a different resource will accomplish your needs before retrying the
/// revised request.
///
///
/// You have made too many requests within a short period of time. Wait for a short time
/// and then try your request again.
///
/// REST API Reference for GetParallelData Operation
Task GetParallelDataAsync(GetParallelDataRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetTerminology
///
/// Retrieves a custom terminology.
///
/// Container for the necessary parameters to execute the GetTerminology service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetTerminology service method, as returned by Translate.
///
/// An internal server error occurred. Retry your request.
///
///
/// The value of the parameter is not valid. Review the value of the parameter you are
/// using to correct it, and then retry your operation.
///
///
/// The resource you are looking for has not been found. Review the resource you're looking
/// for and see if a different resource will accomplish your needs before retrying the
/// revised request.
///
///
/// You have made too many requests within a short period of time. Wait for a short time
/// and then try your request again.
///
/// REST API Reference for GetTerminology Operation
Task GetTerminologyAsync(GetTerminologyRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ImportTerminology
///
/// Creates or updates a custom terminology, depending on whether one already exists for
/// the given terminology name. Importing a terminology with the same name as an existing
/// one will merge the terminologies based on the chosen merge strategy. The only supported
/// merge strategy is OVERWRITE, where the imported terminology overwrites the existing
/// terminology of the same name.
///
///
///
/// If you import a terminology that overwrites an existing one, the new terminology takes
/// up to 10 minutes to fully propagate. After that, translations have access to the new
/// terminology.
///
///
/// Container for the necessary parameters to execute the ImportTerminology service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ImportTerminology service method, as returned by Translate.
///
/// Another modification is being made. That modification must complete before you can
/// make your change.
///
///
/// An internal server error occurred. Retry your request.
///
///
/// The value of the parameter is not valid. Review the value of the parameter you are
/// using to correct it, and then retry your operation.
///
///
/// The specified limit has been exceeded. Review your request and retry it with a quantity
/// below the stated limit.
///
///
/// You have made too many requests within a short period of time. Wait for a short time
/// and then try your request again.
///
///
/// You have added too many tags to this resource. The maximum is 50 tags.
///
/// REST API Reference for ImportTerminology Operation
Task ImportTerminologyAsync(ImportTerminologyRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListLanguages
///
/// Provides a list of languages (RFC-5646 codes and names) that Amazon Translate supports.
///
/// Container for the necessary parameters to execute the ListLanguages service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListLanguages service method, as returned by Translate.
///
/// An internal server error occurred. Retry your request.
///
///
/// The value of the parameter is not valid. Review the value of the parameter you are
/// using to correct it, and then retry your operation.
///
///
/// You have made too many requests within a short period of time. Wait for a short time
/// and then try your request again.
///
///
/// Requested display language code is not supported.
///
/// REST API Reference for ListLanguages Operation
Task ListLanguagesAsync(ListLanguagesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListParallelData
///
/// Provides a list of your parallel data resources in Amazon Translate.
///
/// Container for the necessary parameters to execute the ListParallelData service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListParallelData service method, as returned by Translate.
///
/// An internal server error occurred. Retry your request.
///
///
/// The value of the parameter is not valid. Review the value of the parameter you are
/// using to correct it, and then retry your operation.
///
///
/// You have made too many requests within a short period of time. Wait for a short time
/// and then try your request again.
///
/// REST API Reference for ListParallelData Operation
Task ListParallelDataAsync(ListParallelDataRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListTagsForResource
///
/// Lists all tags associated with a given Amazon Translate resource. For more information,
/// see Tagging
/// your resources.
///
/// Container for the necessary parameters to execute the ListTagsForResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListTagsForResource service method, as returned by Translate.
///
/// An internal server error occurred. Retry your request.
///
///
/// The value of the parameter is not valid. Review the value of the parameter you are
/// using to correct it, and then retry your operation.
///
///
/// The resource you are looking for has not been found. Review the resource you're looking
/// for and see if a different resource will accomplish your needs before retrying the
/// revised request.
///
/// REST API Reference for ListTagsForResource Operation
Task ListTagsForResourceAsync(ListTagsForResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListTerminologies
///
/// Provides a list of custom terminologies associated with your account.
///
/// Container for the necessary parameters to execute the ListTerminologies service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListTerminologies service method, as returned by Translate.
///
/// An internal server error occurred. Retry your request.
///
///
/// The value of the parameter is not valid. Review the value of the parameter you are
/// using to correct it, and then retry your operation.
///
///
/// You have made too many requests within a short period of time. Wait for a short time
/// and then try your request again.
///
/// REST API Reference for ListTerminologies Operation
Task ListTerminologiesAsync(ListTerminologiesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListTextTranslationJobs
///
/// Gets a list of the batch translation jobs that you have submitted.
///
/// Container for the necessary parameters to execute the ListTextTranslationJobs service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListTextTranslationJobs service method, as returned by Translate.
///
/// An internal server error occurred. Retry your request.
///
///
/// The filter specified for the operation is not valid. Specify a different filter.
///
///
/// The request that you made is not valid. Check your request to determine why it's
/// not valid and then retry the request.
///
///
/// You have made too many requests within a short period of time. Wait for a short time
/// and then try your request again.
///
/// REST API Reference for ListTextTranslationJobs Operation
Task ListTextTranslationJobsAsync(ListTextTranslationJobsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region StartTextTranslationJob
///
/// Starts an asynchronous batch translation job. Use batch translation jobs to translate
/// large volumes of text across multiple documents at once. For batch translation, you
/// can input documents with different source languages (specify auto as
/// the source language). You can specify one or more target languages. Batch translation
/// translates each input document into each of the target languages. For more information,
/// see Asynchronous
/// batch processing.
///
///
///
/// Batch translation jobs can be described with the DescribeTextTranslationJob
/// operation, listed with the ListTextTranslationJobs operation, and stopped with
/// the StopTextTranslationJob operation.
///
///
/// Container for the necessary parameters to execute the StartTextTranslationJob service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the StartTextTranslationJob service method, as returned by Translate.
///
/// An internal server error occurred. Retry your request.
///
///
/// The value of the parameter is not valid. Review the value of the parameter you are
/// using to correct it, and then retry your operation.
///
///
/// The request that you made is not valid. Check your request to determine why it's
/// not valid and then retry the request.
///
///
/// The resource you are looking for has not been found. Review the resource you're looking
/// for and see if a different resource will accomplish your needs before retrying the
/// revised request.
///
///
/// You have made too many requests within a short period of time. Wait for a short time
/// and then try your request again.
///
///
/// Amazon Translate does not support translation from the language of the source text
/// into the requested target language. For more information, see Supported
/// languages.
///
/// REST API Reference for StartTextTranslationJob Operation
Task StartTextTranslationJobAsync(StartTextTranslationJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region StopTextTranslationJob
///
/// Stops an asynchronous batch translation job that is in progress.
///
///
///
/// If the job's state is IN_PROGRESS, the job will be marked for termination
/// and put into the STOP_REQUESTED state. If the job completes before it
/// can be stopped, it is put into the COMPLETED state. Otherwise, the job
/// is put into the STOPPED state.
///
///
///
/// Asynchronous batch translation jobs are started with the StartTextTranslationJob
/// operation. You can use the DescribeTextTranslationJob or ListTextTranslationJobs
/// operations to get a batch translation job's JobId.
///
///
/// Container for the necessary parameters to execute the StopTextTranslationJob service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the StopTextTranslationJob service method, as returned by Translate.
///
/// An internal server error occurred. Retry your request.
///
///
/// The resource you are looking for has not been found. Review the resource you're looking
/// for and see if a different resource will accomplish your needs before retrying the
/// revised request.
///
///
/// You have made too many requests within a short period of time. Wait for a short time
/// and then try your request again.
///
/// REST API Reference for StopTextTranslationJob Operation
Task StopTextTranslationJobAsync(StopTextTranslationJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region TagResource
///
/// Associates a specific tag with a resource. A tag is a key-value pair that adds as
/// a metadata to a resource. For more information, see
/// Tagging your resources.
///
/// Container for the necessary parameters to execute the TagResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the TagResource service method, as returned by Translate.
///
/// Another modification is being made. That modification must complete before you can
/// make your change.
///
///
/// An internal server error occurred. Retry your request.
///
///
/// The value of the parameter is not valid. Review the value of the parameter you are
/// using to correct it, and then retry your operation.
///
///
/// The resource you are looking for has not been found. Review the resource you're looking
/// for and see if a different resource will accomplish your needs before retrying the
/// revised request.
///
///
/// You have added too many tags to this resource. The maximum is 50 tags.
///
/// REST API Reference for TagResource Operation
Task TagResourceAsync(TagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region TranslateDocument
///
/// Translates the input document from the source language to the target language. This
/// synchronous operation supports plain text or HTML for the input document. TranslateDocument
/// supports translations from English to any supported language, and from any supported
/// language to English. Therefore, specify either the source language code or the target
/// language code as “en” (English).
///
///
///
/// TranslateDocument does not support language auto-detection.
///
///
///
/// If you set the Formality parameter, the request will fail if the target
/// language does not support formality. For a list of target languages that support formality,
/// see Setting
/// formality.
///
///
/// Container for the necessary parameters to execute the TranslateDocument service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the TranslateDocument service method, as returned by Translate.
///
/// An internal server error occurred. Retry your request.
///
///
/// The request that you made is not valid. Check your request to determine why it's
/// not valid and then retry the request.
///
///
/// The specified limit has been exceeded. Review your request and retry it with a quantity
/// below the stated limit.
///
///
/// The resource you are looking for has not been found. Review the resource you're looking
/// for and see if a different resource will accomplish your needs before retrying the
/// revised request.
///
///
/// The Amazon Translate service is temporarily unavailable. Wait a bit and then retry
/// your request.
///
///
/// You have made too many requests within a short period of time. Wait for a short time
/// and then try your request again.
///
///
/// Amazon Translate does not support translation from the language of the source text
/// into the requested target language. For more information, see Supported
/// languages.
///
/// REST API Reference for TranslateDocument Operation
Task TranslateDocumentAsync(TranslateDocumentRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region TranslateText
///
/// Translates input text from the source language to the target language. For a list
/// of available languages and language codes, see Supported
/// languages.
///
/// Container for the necessary parameters to execute the TranslateText service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the TranslateText service method, as returned by Translate.
///
/// The confidence that Amazon Comprehend accurately detected the source language is low.
/// If a low confidence level is acceptable for your application, you can use the language
/// in the exception to call Amazon Translate again. For more information, see the DetectDominantLanguage
/// operation in the Amazon Comprehend Developer Guide.
///
///
/// An internal server error occurred. Retry your request.
///
///
/// The request that you made is not valid. Check your request to determine why it's
/// not valid and then retry the request.
///
///
/// The resource you are looking for has not been found. Review the resource you're looking
/// for and see if a different resource will accomplish your needs before retrying the
/// revised request.
///
///
/// The Amazon Translate service is temporarily unavailable. Wait a bit and then retry
/// your request.
///
///
/// The size of the text you submitted exceeds the size limit. Reduce the size of the
/// text or use a smaller document and then retry your request.
///
///
/// You have made too many requests within a short period of time. Wait for a short time
/// and then try your request again.
///
///
/// Amazon Translate does not support translation from the language of the source text
/// into the requested target language. For more information, see Supported
/// languages.
///
/// REST API Reference for TranslateText Operation
Task TranslateTextAsync(TranslateTextRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UntagResource
///
/// Removes a specific tag associated with an Amazon Translate resource. For more information,
/// see Tagging
/// your resources.
///
/// Container for the necessary parameters to execute the UntagResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UntagResource service method, as returned by Translate.
///
/// Another modification is being made. That modification must complete before you can
/// make your change.
///
///
/// An internal server error occurred. Retry your request.
///
///
/// The value of the parameter is not valid. Review the value of the parameter you are
/// using to correct it, and then retry your operation.
///
///
/// The resource you are looking for has not been found. Review the resource you're looking
/// for and see if a different resource will accomplish your needs before retrying the
/// revised request.
///
/// REST API Reference for UntagResource Operation
Task UntagResourceAsync(UntagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UpdateParallelData
///
/// Updates a previously created parallel data resource by importing a new input file
/// from Amazon S3.
///
/// Container for the necessary parameters to execute the UpdateParallelData service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdateParallelData service method, as returned by Translate.
///
/// Another modification is being made. That modification must complete before you can
/// make your change.
///
///
/// There was a conflict processing the request. Try your request again.
///
///
/// An internal server error occurred. Retry your request.
///
///
/// The value of the parameter is not valid. Review the value of the parameter you are
/// using to correct it, and then retry your operation.
///
///
/// The request that you made is not valid. Check your request to determine why it's
/// not valid and then retry the request.
///
///
/// The specified limit has been exceeded. Review your request and retry it with a quantity
/// below the stated limit.
///
///
/// The resource you are looking for has not been found. Review the resource you're looking
/// for and see if a different resource will accomplish your needs before retrying the
/// revised request.
///
///
/// You have made too many requests within a short period of time. Wait for a short time
/// and then try your request again.
///
/// REST API Reference for UpdateParallelData Operation
Task UpdateParallelDataAsync(UpdateParallelDataRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
}
}