@aws-sdk/client-translate 3.295.0 → 3.297.0

package/dist-types/models/models_0.d.ts

@@ -1,6 +1,7 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
 import { TranslateServiceException as __BaseException } from "./TranslateServiceException";
 /**
+ * @public
  * <p>The term being translated by the custom terminology.</p>
  */
 export interface Term {
@@ -14,6 +15,7 @@ export interface Term {
     TargetText?: string;
 }
 /**
+ * @public
  * <p>The custom terminology applied to the input text by Amazon Translate for the translated text
  *       response. This is optional in the response and will only be present if you specified
  *       terminology input in the request. Currently, only one terminology can be applied per
@@ -33,6 +35,7 @@ export interface AppliedTerminology {
     Terms?: Term[];
 }
 /**
+ * @public
  * <p>Another modification is being made. That modification must complete before you can make
  *       your change.</p>
  */
@@ -46,6 +49,7 @@ export declare class ConcurrentModificationException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ConcurrentModificationException, __BaseException>);
 }
 /**
+ * @public
  * <p>There was a conflict processing the request. Try your request again.</p>
  */
 export declare class ConflictException extends __BaseException {
@@ -57,10 +61,14 @@ export declare class ConflictException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
 }
+/**
+ * @public
+ */
 export declare enum EncryptionKeyType {
     KMS = "KMS"
 }
 /**
+ * @public
  * <p>The encryption key used to encrypt this object.</p>
  */
 export interface EncryptionKey {
@@ -73,12 +81,16 @@ export interface EncryptionKey {
      */
     Id: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum ParallelDataFormat {
     CSV = "CSV",
     TMX = "TMX",
     TSV = "TSV"
 }
 /**
+ * @public
  * <p>Specifies the format and S3 location of the parallel data input file.</p>
  */
 export interface ParallelDataConfig {
@@ -93,6 +105,7 @@ export interface ParallelDataConfig {
     Format: ParallelDataFormat | string | undefined;
 }
 /**
+ * @public
  * <p>A key-value pair that adds as a metadata to a resource used by Amazon Translate. </p>
  */
 export interface Tag {
@@ -106,6 +119,9 @@ export interface Tag {
      */
     Value: string | undefined;
 }
+/**
+ * @public
+ */
 export interface CreateParallelDataRequest {
     /**
      * <p>A custom name for the parallel data resource in Amazon Translate. You must assign a name
@@ -137,6 +153,9 @@ export interface CreateParallelDataRequest {
      */
     Tags?: Tag[];
 }
+/**
+ * @public
+ */
 export declare enum ParallelDataStatus {
     ACTIVE = "ACTIVE",
     CREATING = "CREATING",
@@ -144,6 +163,9 @@ export declare enum ParallelDataStatus {
     FAILED = "FAILED",
     UPDATING = "UPDATING"
 }
+/**
+ * @public
+ */
 export interface CreateParallelDataResponse {
     /**
      * <p>The custom name that you assigned to the parallel data resource.</p>
@@ -156,6 +178,7 @@ export interface CreateParallelDataResponse {
     Status?: ParallelDataStatus | string;
 }
 /**
+ * @public
  * <p>An internal server error occurred. Retry your request.</p>
  */
 export declare class InternalServerException extends __BaseException {
@@ -168,6 +191,7 @@ export declare class InternalServerException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
 }
 /**
+ * @public
  * <p>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.</p>
  */
@@ -181,6 +205,7 @@ export declare class InvalidParameterValueException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InvalidParameterValueException, __BaseException>);
 }
 /**
+ * @public
  * <p> The request that you made is not valid. Check your request to determine why it's not
  *       valid and then retry the request. </p>
  */
@@ -194,6 +219,7 @@ export declare class InvalidRequestException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>);
 }
 /**
+ * @public
  * <p>The specified limit has been exceeded. Review your request and retry it with a quantity
  *       below the stated limit.</p>
  */
@@ -207,6 +233,7 @@ export declare class LimitExceededException extends __BaseException {
     constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
 }
 /**
+ * @public
  * <p> You have made too many requests within a short period of time. Wait for a short time and
  *       then try your request again.</p>
  */
@@ -220,6 +247,7 @@ export declare class TooManyRequestsException extends __BaseException {
     constructor(opts: __ExceptionOptionType<TooManyRequestsException, __BaseException>);
 }
 /**
+ * @public
  * <p>You have added too many tags to this resource. The maximum is 50 tags.</p>
  */
 export declare class TooManyTagsException extends __BaseException {
@@ -231,12 +259,18 @@ export declare class TooManyTagsException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<TooManyTagsException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface DeleteParallelDataRequest {
     /**
      * <p>The name of the parallel data resource that is being deleted.</p>
      */
     Name: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteParallelDataResponse {
     /**
      * <p>The name of the parallel data resource that is being deleted.</p>
@@ -248,6 +282,7 @@ export interface DeleteParallelDataResponse {
     Status?: ParallelDataStatus | string;
 }
 /**
+ * @public
  * <p>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.</p>
@@ -261,12 +296,18 @@ export declare class ResourceNotFoundException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface DeleteTerminologyRequest {
     /**
      * <p>The name of the custom terminology being deleted. </p>
      */
     Name: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeTextTranslationJobRequest {
     /**
      * <p>The identifier that Amazon Translate generated for the job. The <a>StartTextTranslationJob</a> operation returns this identifier in its
@@ -275,6 +316,7 @@ export interface DescribeTextTranslationJobRequest {
     JobId: string | undefined;
 }
 /**
+ * @public
  * <p>The input configuration properties for requesting a batch translation job.</p>
  */
 export interface InputDataConfig {
@@ -331,6 +373,7 @@ export interface InputDataConfig {
     ContentType: string | undefined;
 }
 /**
+ * @public
  * <p>The number of documents successfully and unsuccessfully processed during a translation
  *       job.</p>
  */
@@ -348,6 +391,9 @@ export interface JobDetails {
      */
     InputDocumentsCount?: number;
 }
+/**
+ * @public
+ */
 export declare enum JobStatus {
     COMPLETED = "COMPLETED",
     COMPLETED_WITH_ERROR = "COMPLETED_WITH_ERROR",
@@ -358,6 +404,7 @@ export declare enum JobStatus {
     SUBMITTED = "SUBMITTED"
 }
 /**
+ * @public
  * <p>The output configuration properties for a batch translation job.</p>
  */
 export interface OutputDataConfig {
@@ -371,14 +418,21 @@ export interface OutputDataConfig {
      */
     EncryptionKey?: EncryptionKey;
 }
+/**
+ * @public
+ */
 export declare enum Formality {
     FORMAL = "FORMAL",
     INFORMAL = "INFORMAL"
 }
+/**
+ * @public
+ */
 export declare enum Profanity {
     MASK = "MASK"
 }
 /**
+ * @public
  * <p>Optional settings that configure the translation output. Use these settings for
  *       real time translations and asynchronous translation jobs.</p>
  */
@@ -413,6 +467,7 @@ export interface TranslationSettings {
     Profanity?: Profanity | string;
 }
 /**
+ * @public
  * <p>Provides information about a translation job.</p>
  */
 export interface TextTranslationJobProperties {
@@ -484,6 +539,9 @@ export interface TextTranslationJobProperties {
      */
     Settings?: TranslationSettings;
 }
+/**
+ * @public
+ */
 export interface DescribeTextTranslationJobResponse {
     /**
      * <p>An object that contains the properties associated with an asynchronous batch translation
@@ -491,6 +549,9 @@ export interface DescribeTextTranslationJobResponse {
      */
     TextTranslationJobProperties?: TextTranslationJobProperties;
 }
+/**
+ * @public
+ */
 export interface GetParallelDataRequest {
     /**
      * <p>The name of the parallel data resource that is being retrieved.</p>
@@ -498,6 +559,7 @@ export interface GetParallelDataRequest {
     Name: string | undefined;
 }
 /**
+ * @public
  * <p>The location of the most recent parallel data input file that was successfully imported
  *       into Amazon Translate.</p>
  */
@@ -523,6 +585,7 @@ export interface ParallelDataDataLocation {
     Location: string | undefined;
 }
 /**
+ * @public
  * <p>The properties of a parallel data resource.</p>
  */
 export interface ParallelDataProperties {
@@ -602,6 +665,9 @@ export interface ParallelDataProperties {
      */
     LatestUpdateAttemptAt?: Date;
 }
+/**
+ * @public
+ */
 export interface GetParallelDataResponse {
     /**
      * <p>The properties of the parallel data resource that is being retrieved.</p>
@@ -638,11 +704,17 @@ export interface GetParallelDataResponse {
      */
     LatestUpdateAttemptAuxiliaryDataLocation?: ParallelDataDataLocation;
 }
+/**
+ * @public
+ */
 export declare enum TerminologyDataFormat {
     CSV = "CSV",
     TMX = "TMX",
     TSV = "TSV"
 }
+/**
+ * @public
+ */
 export interface GetTerminologyRequest {
     /**
      * <p>The name of the custom terminology being retrieved.</p>
@@ -659,6 +731,7 @@ export interface GetTerminologyRequest {
     TerminologyDataFormat?: TerminologyDataFormat | string;
 }
 /**
+ * @public
  * <p>The location of the custom terminology data.</p>
  */
 export interface TerminologyDataLocation {
@@ -683,11 +756,15 @@ export interface TerminologyDataLocation {
      */
     Location: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum Directionality {
     MULTI = "MULTI",
     UNI = "UNI"
 }
 /**
+ * @public
  * <p>The properties of the custom terminology.</p>
  */
 export interface TerminologyProperties {
@@ -763,6 +840,9 @@ export interface TerminologyProperties {
      */
     Format?: TerminologyDataFormat | string;
 }
+/**
+ * @public
+ */
 export interface GetTerminologyResponse {
     /**
      * <p>The properties of the custom terminology being retrieved.</p>
@@ -792,10 +872,14 @@ export interface GetTerminologyResponse {
      */
     AuxiliaryDataLocation?: TerminologyDataLocation;
 }
+/**
+ * @public
+ */
 export declare enum MergeStrategy {
     OVERWRITE = "OVERWRITE"
 }
 /**
+ * @public
  * <p>The data associated with the custom terminology. For information about the custom terminology file, see
  *       <a href="https://docs.aws.amazon.com/translate/latest/dg/creating-custom-terminology.html">
  *       Creating a Custom Terminology</a>.</p>
@@ -834,6 +918,9 @@ export interface TerminologyData {
      */
     Directionality?: Directionality | string;
 }
+/**
+ * @public
+ */
 export interface ImportTerminologyRequest {
     /**
      * <p>The name of the custom terminology being imported.</p>
@@ -865,6 +952,9 @@ export interface ImportTerminologyRequest {
      */
     Tags?: Tag[];
 }
+/**
+ * @public
+ */
 export interface ImportTerminologyResponse {
     /**
      * <p>The properties of the custom terminology being imported.</p>
@@ -878,6 +968,9 @@ export interface ImportTerminologyResponse {
      */
     AuxiliaryDataLocation?: TerminologyDataLocation;
 }
+/**
+ * @public
+ */
 export declare enum DisplayLanguageCode {
     DE = "de",
     EN = "en",
@@ -890,6 +983,9 @@ export declare enum DisplayLanguageCode {
     ZH = "zh",
     ZH_TW = "zh-TW"
 }
+/**
+ * @public
+ */
 export interface ListLanguagesRequest {
     /**
      * <p>The language code for the language to use to display the language names in the response.
@@ -906,6 +1002,7 @@ export interface ListLanguagesRequest {
     MaxResults?: number;
 }
 /**
+ * @public
  * <p>A supported language.</p>
  */
 export interface Language {
@@ -918,6 +1015,9 @@ export interface Language {
      */
     LanguageCode: string | undefined;
 }
+/**
+ * @public
+ */
 export interface ListLanguagesResponse {
     /**
      * <p>The list of supported languages.</p>
@@ -934,6 +1034,7 @@ export interface ListLanguagesResponse {
     NextToken?: string;
 }
 /**
+ * @public
  * <p>Requested display language code is not supported.</p>
  */
 export declare class UnsupportedDisplayLanguageCodeException extends __BaseException {
@@ -949,6 +1050,9 @@ export declare class UnsupportedDisplayLanguageCodeException extends __BaseExcep
      */
     constructor(opts: __ExceptionOptionType<UnsupportedDisplayLanguageCodeException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface ListParallelDataRequest {
     /**
      * <p>A string that specifies the next page of results to return in a paginated response.</p>
@@ -959,6 +1063,9 @@ export interface ListParallelDataRequest {
      */
     MaxResults?: number;
 }
+/**
+ * @public
+ */
 export interface ListParallelDataResponse {
     /**
      * <p>The properties of the parallel data resources returned by this request.</p>
@@ -970,6 +1077,9 @@ export interface ListParallelDataResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListTagsForResourceRequest {
     /**
      * <p>The Amazon Resource Name (ARN) of the given Amazon Translate resource you are querying.
@@ -977,6 +1087,9 @@ export interface ListTagsForResourceRequest {
      */
     ResourceArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface ListTagsForResourceResponse {
     /**
      * <p>Tags associated with the Amazon Translate resource being queried. A tag is a key-value
@@ -986,6 +1099,9 @@ export interface ListTagsForResourceResponse {
      */
     Tags?: Tag[];
 }
+/**
+ * @public
+ */
 export interface ListTerminologiesRequest {
     /**
      * <p>If the result of the request to ListTerminologies was truncated, include the NextToken to
@@ -997,6 +1113,9 @@ export interface ListTerminologiesRequest {
      */
     MaxResults?: number;
 }
+/**
+ * @public
+ */
 export interface ListTerminologiesResponse {
     /**
      * <p>The properties list of the custom terminologies returned on the list request.</p>
@@ -1009,6 +1128,7 @@ export interface ListTerminologiesResponse {
     NextToken?: string;
 }
 /**
+ * @public
  * <p>The filter specified for the operation is not valid. Specify a different filter.</p>
  */
 export declare class InvalidFilterException extends __BaseException {
@@ -1021,6 +1141,7 @@ export declare class InvalidFilterException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InvalidFilterException, __BaseException>);
 }
 /**
+ * @public
  * <p>Provides information for filtering a list of translation jobs. For more information, see
  *         <a>ListTextTranslationJobs</a>.</p>
  */
@@ -1046,6 +1167,9 @@ export interface TextTranslationJobFilter {
      */
     SubmittedAfterTime?: Date;
 }
+/**
+ * @public
+ */
 export interface ListTextTranslationJobsRequest {
     /**
      * <p>The parameters that specify which batch translation jobs to retrieve. Filters include job
@@ -1061,6 +1185,9 @@ export interface ListTextTranslationJobsRequest {
      */
     MaxResults?: number;
 }
+/**
+ * @public
+ */
 export interface ListTextTranslationJobsResponse {
     /**
      * <p>A list containing the properties of each job that is returned.</p>
@@ -1072,6 +1199,9 @@ export interface ListTextTranslationJobsResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface StartTextTranslationJobRequest {
     /**
      * <p>The name of the batch translation job to be performed.</p>
@@ -1147,6 +1277,9 @@ export interface StartTextTranslationJobRequest {
      */
     Settings?: TranslationSettings;
 }
+/**
+ * @public
+ */
 export interface StartTextTranslationJobResponse {
     /**
      * <p>The identifier generated for the job. To get the status of a job, use this ID with the
@@ -1193,6 +1326,7 @@ export interface StartTextTranslationJobResponse {
     JobStatus?: JobStatus | string;
 }
 /**
+ * @public
  * <p>Amazon Translate does not support translation from the language of the source text into the requested
  *       target language. For more information, see <a href="https://docs.aws.amazon.com/translate/latest/dg/how-to-error-msg.html">Error messages</a>. </p>
  */
@@ -1213,12 +1347,18 @@ export declare class UnsupportedLanguagePairException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<UnsupportedLanguagePairException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface StopTextTranslationJobRequest {
     /**
      * <p>The job ID of the job to be stopped.</p>
      */
     JobId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface StopTextTranslationJobResponse {
     /**
      * <p>The job ID of the stopped batch translation job.</p>
@@ -1230,6 +1370,9 @@ export interface StopTextTranslationJobResponse {
      */
     JobStatus?: JobStatus | string;
 }
+/**
+ * @public
+ */
 export interface TagResourceRequest {
     /**
      * <p>The Amazon Resource Name (ARN) of the given Amazon Translate resource to which you want
@@ -1242,9 +1385,13 @@ export interface TagResourceRequest {
      */
     Tags: Tag[] | undefined;
 }
+/**
+ * @public
+ */
 export interface TagResourceResponse {
 }
 /**
+ * @public
  * <p>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 <a href="https://docs.aws.amazon.com/comprehend/latest/dg/API_DetectDominantLanguage.html">DetectDominantLanguage</a> operation in the <i>Amazon Comprehend Developer
@@ -1264,6 +1411,7 @@ export declare class DetectedLanguageLowConfidenceException extends __BaseExcept
     constructor(opts: __ExceptionOptionType<DetectedLanguageLowConfidenceException, __BaseException>);
 }
 /**
+ * @public
  * <p>The Amazon Translate service is temporarily unavailable. Wait a bit and then retry your
  *       request.</p>
  */
@@ -1277,6 +1425,7 @@ export declare class ServiceUnavailableException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
 }
 /**
+ * @public
  * <p> 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. </p>
  */
@@ -1289,6 +1438,9 @@ export declare class TextSizeLimitExceededException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<TextSizeLimitExceededException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface TranslateTextRequest {
     /**
      * <p>The text to translate. The text string can be a maximum of 10,000 bytes long. Depending on
@@ -1325,6 +1477,9 @@ export interface TranslateTextRequest {
      */
     Settings?: TranslationSettings;
 }
+/**
+ * @public
+ */
 export interface TranslateTextResponse {
     /**
      * <p>The translated text.</p>
@@ -1348,6 +1503,9 @@ export interface TranslateTextResponse {
      */
     AppliedSettings?: TranslationSettings;
 }
+/**
+ * @public
+ */
 export interface UntagResourceRequest {
     /**
      * <p> The Amazon Resource Name (ARN) of the given Amazon Translate resource from which you
@@ -1361,8 +1519,14 @@ export interface UntagResourceRequest {
      */
     TagKeys: string[] | undefined;
 }
+/**
+ * @public
+ */
 export interface UntagResourceResponse {
 }
+/**
+ * @public
+ */
 export interface UpdateParallelDataRequest {
     /**
      * <p>The name of the parallel data resource being updated.</p>
@@ -1382,6 +1546,9 @@ export interface UpdateParallelDataRequest {
      */
     ClientToken?: string;
 }
+/**
+ * @public
+ */
 export interface UpdateParallelDataResponse {
     /**
      * <p>The name of the parallel data resource being updated.</p>

package/dist-types/pagination/Interfaces.d.ts

@@ -1,5 +1,8 @@
 import { PaginationConfiguration } from "@aws-sdk/types";
 import { TranslateClient } from "../TranslateClient";
+/**
+ * @public
+ */
 export interface TranslatePaginationConfiguration extends PaginationConfiguration {
     client: TranslateClient;
 }

package/dist-types/pagination/ListLanguagesPaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListLanguagesCommandInput, ListLanguagesCommandOutput } from "../commands/ListLanguagesCommand";
 import { TranslatePaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListLanguages(config: TranslatePaginationConfiguration, input: ListLanguagesCommandInput, ...additionalArguments: any): Paginator<ListLanguagesCommandOutput>;

package/dist-types/pagination/ListParallelDataPaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListParallelDataCommandInput, ListParallelDataCommandOutput } from "../commands/ListParallelDataCommand";
 import { TranslatePaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListParallelData(config: TranslatePaginationConfiguration, input: ListParallelDataCommandInput, ...additionalArguments: any): Paginator<ListParallelDataCommandOutput>;

package/dist-types/pagination/ListTerminologiesPaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListTerminologiesCommandInput, ListTerminologiesCommandOutput } from "../commands/ListTerminologiesCommand";
 import { TranslatePaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListTerminologies(config: TranslatePaginationConfiguration, input: ListTerminologiesCommandInput, ...additionalArguments: any): Paginator<ListTerminologiesCommandOutput>;

package/dist-types/pagination/ListTextTranslationJobsPaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListTextTranslationJobsCommandInput, ListTextTranslationJobsCommandOutput } from "../commands/ListTextTranslationJobsCommand";
 import { TranslatePaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListTextTranslationJobs(config: TranslatePaginationConfiguration, input: ListTextTranslationJobsCommandInput, ...additionalArguments: any): Paginator<ListTextTranslationJobsCommandOutput>;