// // Copyright 2010-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. // #import #import #import NS_ASSUME_NONNULL_BEGIN FOUNDATION_EXPORT NSString *const AWSTranslateErrorDomain; typedef NS_ENUM(NSInteger, AWSTranslateErrorType) { AWSTranslateErrorUnknown, AWSTranslateErrorConcurrentModification, AWSTranslateErrorConflict, AWSTranslateErrorDetectedLanguageLowConfidence, AWSTranslateErrorInternalServer, AWSTranslateErrorInvalidFilter, AWSTranslateErrorInvalidParameterValue, AWSTranslateErrorInvalidRequest, AWSTranslateErrorLimitExceeded, AWSTranslateErrorResourceNotFound, AWSTranslateErrorServiceUnavailable, AWSTranslateErrorTextSizeLimitExceeded, AWSTranslateErrorTooManyRequests, AWSTranslateErrorTooManyTags, AWSTranslateErrorUnsupportedDisplayLanguageCode, AWSTranslateErrorUnsupportedLanguagePair, }; typedef NS_ENUM(NSInteger, AWSTranslateDirectionality) { AWSTranslateDirectionalityUnknown, AWSTranslateDirectionalityUni, AWSTranslateDirectionalityMulti, }; typedef NS_ENUM(NSInteger, AWSTranslateDisplayLanguageCode) { AWSTranslateDisplayLanguageCodeUnknown, AWSTranslateDisplayLanguageCodeDe, AWSTranslateDisplayLanguageCodeEn, AWSTranslateDisplayLanguageCodeEs, AWSTranslateDisplayLanguageCodeFr, AWSTranslateDisplayLanguageCodeIt, AWSTranslateDisplayLanguageCodeJa, AWSTranslateDisplayLanguageCodeKo, AWSTranslateDisplayLanguageCodePt, AWSTranslateDisplayLanguageCodeZh, AWSTranslateDisplayLanguageCodeZhTW, }; typedef NS_ENUM(NSInteger, AWSTranslateEncryptionKeyType) { AWSTranslateEncryptionKeyTypeUnknown, AWSTranslateEncryptionKeyTypeKms, }; typedef NS_ENUM(NSInteger, AWSTranslateFormality) { AWSTranslateFormalityUnknown, AWSTranslateFormalityFormal, AWSTranslateFormalityInformal, }; typedef NS_ENUM(NSInteger, AWSTranslateJobStatus) { AWSTranslateJobStatusUnknown, AWSTranslateJobStatusSubmitted, AWSTranslateJobStatusInProgress, AWSTranslateJobStatusCompleted, AWSTranslateJobStatusCompletedWithError, AWSTranslateJobStatusFailed, AWSTranslateJobStatusStopRequested, AWSTranslateJobStatusStopped, }; typedef NS_ENUM(NSInteger, AWSTranslateMergeStrategy) { AWSTranslateMergeStrategyUnknown, AWSTranslateMergeStrategyOverwrite, }; typedef NS_ENUM(NSInteger, AWSTranslateParallelDataFormat) { AWSTranslateParallelDataFormatUnknown, AWSTranslateParallelDataFormatTsv, AWSTranslateParallelDataFormatCsv, AWSTranslateParallelDataFormatTmx, }; typedef NS_ENUM(NSInteger, AWSTranslateParallelDataStatus) { AWSTranslateParallelDataStatusUnknown, AWSTranslateParallelDataStatusCreating, AWSTranslateParallelDataStatusUpdating, AWSTranslateParallelDataStatusActive, AWSTranslateParallelDataStatusDeleting, AWSTranslateParallelDataStatusFailed, }; typedef NS_ENUM(NSInteger, AWSTranslateProfanity) { AWSTranslateProfanityUnknown, AWSTranslateProfanityMask, }; typedef NS_ENUM(NSInteger, AWSTranslateTerminologyDataFormat) { AWSTranslateTerminologyDataFormatUnknown, AWSTranslateTerminologyDataFormatCsv, AWSTranslateTerminologyDataFormatTmx, AWSTranslateTerminologyDataFormatTsv, }; @class AWSTranslateAppliedTerminology; @class AWSTranslateCreateParallelDataRequest; @class AWSTranslateCreateParallelDataResponse; @class AWSTranslateDeleteParallelDataRequest; @class AWSTranslateDeleteParallelDataResponse; @class AWSTranslateDeleteTerminologyRequest; @class AWSTranslateDescribeTextTranslationJobRequest; @class AWSTranslateDescribeTextTranslationJobResponse; @class AWSTranslateDocument; @class AWSTranslateEncryptionKey; @class AWSTranslateGetParallelDataRequest; @class AWSTranslateGetParallelDataResponse; @class AWSTranslateGetTerminologyRequest; @class AWSTranslateGetTerminologyResponse; @class AWSTranslateImportTerminologyRequest; @class AWSTranslateImportTerminologyResponse; @class AWSTranslateInputDataConfig; @class AWSTranslateJobDetails; @class AWSTranslateLanguage; @class AWSTranslateListLanguagesRequest; @class AWSTranslateListLanguagesResponse; @class AWSTranslateListParallelDataRequest; @class AWSTranslateListParallelDataResponse; @class AWSTranslateListTagsForResourceRequest; @class AWSTranslateListTagsForResourceResponse; @class AWSTranslateListTerminologiesRequest; @class AWSTranslateListTerminologiesResponse; @class AWSTranslateListTextTranslationJobsRequest; @class AWSTranslateListTextTranslationJobsResponse; @class AWSTranslateOutputDataConfig; @class AWSTranslateParallelDataConfig; @class AWSTranslateParallelDataDataLocation; @class AWSTranslateParallelDataProperties; @class AWSTranslateStartTextTranslationJobRequest; @class AWSTranslateStartTextTranslationJobResponse; @class AWSTranslateStopTextTranslationJobRequest; @class AWSTranslateStopTextTranslationJobResponse; @class AWSTranslateTag; @class AWSTranslateTagResourceRequest; @class AWSTranslateTagResourceResponse; @class AWSTranslateTerm; @class AWSTranslateTerminologyData; @class AWSTranslateTerminologyDataLocation; @class AWSTranslateTerminologyProperties; @class AWSTranslateTextTranslationJobFilter; @class AWSTranslateTextTranslationJobProperties; @class AWSTranslateTranslateDocumentRequest; @class AWSTranslateTranslateDocumentResponse; @class AWSTranslateTranslateTextRequest; @class AWSTranslateTranslateTextResponse; @class AWSTranslateTranslatedDocument; @class AWSTranslateTranslationSettings; @class AWSTranslateUntagResourceRequest; @class AWSTranslateUntagResourceResponse; @class AWSTranslateUpdateParallelDataRequest; @class AWSTranslateUpdateParallelDataResponse; /**

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 TranslateText request.

*/ @interface AWSTranslateAppliedTerminology : AWSModel /**

The name of the custom terminology applied to the input text by Amazon Translate for the translated text response.

*/ @property (nonatomic, strong) NSString * _Nullable name; /**

The specific terms of the custom terminology applied to the input text by Amazon Translate for the translated text response. A maximum of 250 terms will be returned, and the specific terms applied will be the first 250 terms in the source text.

*/ @property (nonatomic, strong) NSArray * _Nullable terms; @end /** */ @interface AWSTranslateCreateParallelDataRequest : AWSRequest /**

A unique identifier for the request. This token is automatically generated when you use Amazon Translate through an AWS SDK.

*/ @property (nonatomic, strong) NSString * _Nullable clientToken; /**

A custom description for the parallel data resource in Amazon Translate.

*/ @property (nonatomic, strong) NSString * _Nullable detail; /**

The encryption key used to encrypt this object.

*/ @property (nonatomic, strong) AWSTranslateEncryptionKey * _Nullable encryptionKey; /**

A custom name for the parallel data resource in Amazon Translate. You must assign a name that is unique in the account and region.

*/ @property (nonatomic, strong) NSString * _Nullable name; /**

Specifies the format and S3 location of the parallel data input file.

*/ @property (nonatomic, strong) AWSTranslateParallelDataConfig * _Nullable parallelDataConfig; /**

Tags to be associated with this resource. A tag is a key-value pair that adds metadata to a resource. Each tag key for the resource must be unique. For more information, see Tagging your resources.

*/ @property (nonatomic, strong) NSArray * _Nullable tags; @end /** */ @interface AWSTranslateCreateParallelDataResponse : AWSModel /**

The custom name that you assigned to the parallel data resource.

*/ @property (nonatomic, strong) NSString * _Nullable name; /**

The status of the parallel data resource. When the resource is ready for you to use, the status is ACTIVE.

*/ @property (nonatomic, assign) AWSTranslateParallelDataStatus status; @end /** */ @interface AWSTranslateDeleteParallelDataRequest : AWSRequest /**

The name of the parallel data resource that is being deleted.

*/ @property (nonatomic, strong) NSString * _Nullable name; @end /** */ @interface AWSTranslateDeleteParallelDataResponse : AWSModel /**

The name of the parallel data resource that is being deleted.

*/ @property (nonatomic, strong) NSString * _Nullable name; /**

The status of the parallel data deletion.

*/ @property (nonatomic, assign) AWSTranslateParallelDataStatus status; @end /** */ @interface AWSTranslateDeleteTerminologyRequest : AWSRequest /**

The name of the custom terminology being deleted.

*/ @property (nonatomic, strong) NSString * _Nullable name; @end /** */ @interface AWSTranslateDescribeTextTranslationJobRequest : AWSRequest /**

The identifier that Amazon Translate generated for the job. The StartTextTranslationJob operation returns this identifier in its response.

*/ @property (nonatomic, strong) NSString * _Nullable jobId; @end /** */ @interface AWSTranslateDescribeTextTranslationJobResponse : AWSModel /**

An object that contains the properties associated with an asynchronous batch translation job.

*/ @property (nonatomic, strong) AWSTranslateTextTranslationJobProperties * _Nullable textTranslationJobProperties; @end /**

The content and content type of a document.

Required parameters: [Content, ContentType] */ @interface AWSTranslateDocument : AWSModel /**

The Contentfield type is Binary large object (blob). This object contains the document content converted into base64-encoded binary data. If you use one of the AWS SDKs, the SDK performs the Base64-encoding on this field before sending the request.

*/ @property (nonatomic, strong) NSData * _Nullable content; /**

Describes the format of the document. You can specify one of the following:

  • text/html - The input data consists of HTML content. Amazon Translate translates only the text in the HTML element.

  • text/plain - The input data consists of unformatted text. Amazon Translate translates every character in the content.

  • application/vnd.openxmlformats-officedocument.wordprocessingml.document - The input data consists of a Word document (.docx).

*/ @property (nonatomic, strong) NSString * _Nullable contentType; @end /**

The encryption key used to encrypt this object.

Required parameters: [Type, Id] */ @interface AWSTranslateEncryptionKey : AWSModel /**

The Amazon Resource Name (ARN) of the encryption key being used to encrypt this object.

*/ @property (nonatomic, strong) NSString * _Nullable identifier; /**

The type of encryption key used by Amazon Translate to encrypt this object.

*/ @property (nonatomic, assign) AWSTranslateEncryptionKeyType types; @end /** */ @interface AWSTranslateGetParallelDataRequest : AWSRequest /**

The name of the parallel data resource that is being retrieved.

*/ @property (nonatomic, strong) NSString * _Nullable name; @end /** */ @interface AWSTranslateGetParallelDataResponse : AWSModel /**

The Amazon S3 location of a file that provides any errors or warnings that were produced by your input file. This file was created when Amazon Translate attempted to create a parallel data resource. The location is returned as a presigned URL to that has a 30-minute expiration.

*/ @property (nonatomic, strong) AWSTranslateParallelDataDataLocation * _Nullable auxiliaryDataLocation; /**

The Amazon S3 location of the most recent parallel data input file that was successfully imported into Amazon Translate. The location is returned as a presigned URL that has a 30-minute expiration.

Amazon Translate doesn't scan all input files for the risk of CSV injection attacks.

CSV injection occurs when a .csv or .tsv file is altered so that a record contains malicious code. The record begins with a special character, such as =, +, -, or @. When the file is opened in a spreadsheet program, the program might interpret the record as a formula and run the code within it.

Before you download an input file from Amazon S3, ensure that you recognize the file and trust its creator.

 */ @property (nonatomic, strong) AWSTranslateParallelDataDataLocation * _Nullable dataLocation; /**

The Amazon S3 location of a file that provides any errors or warnings that were produced by your input file. This file was created when Amazon Translate attempted to update a parallel data resource. The location is returned as a presigned URL to that has a 30-minute expiration.

*/ @property (nonatomic, strong) AWSTranslateParallelDataDataLocation * _Nullable latestUpdateAttemptAuxiliaryDataLocation; /**

The properties of the parallel data resource that is being retrieved.

*/ @property (nonatomic, strong) AWSTranslateParallelDataProperties * _Nullable parallelDataProperties; @end /** */ @interface AWSTranslateGetTerminologyRequest : AWSRequest /**

The name of the custom terminology being retrieved.

*/ @property (nonatomic, strong) NSString * _Nullable name; /**

The data format of the custom terminology being retrieved.

If you don't specify this parameter, Amazon Translate returns a file with the same format as the file that was imported to create the terminology.

If you specify this parameter when you retrieve a multi-directional terminology resource, you must specify the same format as the input file that was imported to create it. Otherwise, Amazon Translate throws an error.

*/ @property (nonatomic, assign) AWSTranslateTerminologyDataFormat terminologyDataFormat; @end /** */ @interface AWSTranslateGetTerminologyResponse : AWSModel /**

The Amazon S3 location of a file that provides any errors or warnings that were produced by your input file. This file was created when Amazon Translate attempted to create a terminology resource. The location is returned as a presigned URL to that has a 30-minute expiration.

*/ @property (nonatomic, strong) AWSTranslateTerminologyDataLocation * _Nullable auxiliaryDataLocation; /**

The Amazon S3 location of the most recent custom terminology input file that was successfully imported into Amazon Translate. The location is returned as a presigned URL that has a 30-minute expiration.

Amazon Translate doesn't scan all input files for the risk of CSV injection attacks.

CSV injection occurs when a .csv or .tsv file is altered so that a record contains malicious code. The record begins with a special character, such as =, +, -, or @. When the file is opened in a spreadsheet program, the program might interpret the record as a formula and run the code within it.

Before you download an input file from Amazon S3, ensure that you recognize the file and trust its creator.

 */ @property (nonatomic, strong) AWSTranslateTerminologyDataLocation * _Nullable terminologyDataLocation; /**

The properties of the custom terminology being retrieved.

*/ @property (nonatomic, strong) AWSTranslateTerminologyProperties * _Nullable terminologyProperties; @end /** */ @interface AWSTranslateImportTerminologyRequest : AWSRequest /**

The description of the custom terminology being imported.

*/ @property (nonatomic, strong) NSString * _Nullable detail; /**

The encryption key for the custom terminology being imported.

*/ @property (nonatomic, strong) AWSTranslateEncryptionKey * _Nullable encryptionKey; /**

The merge strategy of the custom terminology being imported. Currently, only the OVERWRITE merge strategy is supported. In this case, the imported terminology will overwrite an existing terminology of the same name.

*/ @property (nonatomic, assign) AWSTranslateMergeStrategy mergeStrategy; /**

The name of the custom terminology being imported.

*/ @property (nonatomic, strong) NSString * _Nullable name; /**

Tags to be associated with this resource. A tag is a key-value pair that adds metadata to a resource. Each tag key for the resource must be unique. For more information, see Tagging your resources.

*/ @property (nonatomic, strong) NSArray * _Nullable tags; /**

The terminology data for the custom terminology being imported.

*/ @property (nonatomic, strong) AWSTranslateTerminologyData * _Nullable terminologyData; @end /** */ @interface AWSTranslateImportTerminologyResponse : AWSModel /**

The Amazon S3 location of a file that provides any errors or warnings that were produced by your input file. This file was created when Amazon Translate attempted to create a terminology resource. The location is returned as a presigned URL to that has a 30 minute expiration.

*/ @property (nonatomic, strong) AWSTranslateTerminologyDataLocation * _Nullable auxiliaryDataLocation; /**

The properties of the custom terminology being imported.

*/ @property (nonatomic, strong) AWSTranslateTerminologyProperties * _Nullable terminologyProperties; @end /**

The input configuration properties for requesting a batch translation job.

Required parameters: [S3Uri, ContentType] */ @interface AWSTranslateInputDataConfig : AWSModel /**

Describes the format of the data that you submit to Amazon Translate as input. You can specify one of the following multipurpose internet mail extension (MIME) types:

  • text/html: The input data consists of one or more HTML files. Amazon Translate translates only the text that resides in the html element in each file.

  • text/plain: The input data consists of one or more unformatted text files. Amazon Translate translates every character in this type of input.

  • application/vnd.openxmlformats-officedocument.wordprocessingml.document: The input data consists of one or more Word documents (.docx).

  • application/vnd.openxmlformats-officedocument.presentationml.presentation: The input data consists of one or more PowerPoint Presentation files (.pptx).

  • application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: The input data consists of one or more Excel Workbook files (.xlsx).

  • application/x-xliff+xml: The input data consists of one or more XML Localization Interchange File Format (XLIFF) files (.xlf). Amazon Translate supports only XLIFF version 1.2.

If you structure your input data as HTML, ensure that you set this parameter to text/html. By doing so, you cut costs by limiting the translation to the contents of the html element in each file. Otherwise, if you set this parameter to text/plain, your costs will cover the translation of every character.

 */ @property (nonatomic, strong) NSString * _Nullable contentType; /**

The URI of the AWS S3 folder that contains the input files. Amazon Translate translates all the files in the folder and all its sub-folders. The folder must be in the same Region as the API endpoint you are calling.

*/ @property (nonatomic, strong) NSString * _Nullable s3Uri; @end /**

The number of documents successfully and unsuccessfully processed during a translation job.

*/ @interface AWSTranslateJobDetails : AWSModel /**

The number of documents that could not be processed during a translation job.

*/ @property (nonatomic, strong) NSNumber * _Nullable documentsWithErrorsCount; /**

The number of documents used as input in a translation job.

*/ @property (nonatomic, strong) NSNumber * _Nullable inputDocumentsCount; /**

The number of documents successfully processed during a translation job.

*/ @property (nonatomic, strong) NSNumber * _Nullable translatedDocumentsCount; @end /**

A supported language.

Required parameters: [LanguageName, LanguageCode] */ @interface AWSTranslateLanguage : AWSModel /**

Language code for the supported language.

*/ @property (nonatomic, strong) NSString * _Nullable languageCode; /**

Language name of the supported language.

*/ @property (nonatomic, strong) NSString * _Nullable languageName; @end /** */ @interface AWSTranslateListLanguagesRequest : AWSRequest /**

The language code for the language to use to display the language names in the response. The language code is en by default.

*/ @property (nonatomic, assign) AWSTranslateDisplayLanguageCode displayLanguageCode; /**

The maximum number of results to return in each response.

*/ @property (nonatomic, strong) NSNumber * _Nullable maxResults; /**

Include the NextToken value to fetch the next group of supported languages.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /** */ @interface AWSTranslateListLanguagesResponse : AWSModel /**

The language code passed in with the request.

*/ @property (nonatomic, assign) AWSTranslateDisplayLanguageCode displayLanguageCode; /**

The list of supported languages.

*/ @property (nonatomic, strong) NSArray * _Nullable languages; /**

If the response does not include all remaining results, use the NextToken in the next request to fetch the next group of supported languages.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /** */ @interface AWSTranslateListParallelDataRequest : AWSRequest /**

The maximum number of parallel data resources returned for each request.

*/ @property (nonatomic, strong) NSNumber * _Nullable maxResults; /**

A string that specifies the next page of results to return in a paginated response.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /** */ @interface AWSTranslateListParallelDataResponse : AWSModel /**

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; /**

The properties of the parallel data resources returned by this request.

*/ @property (nonatomic, strong) NSArray * _Nullable parallelDataPropertiesList; @end /** */ @interface AWSTranslateListTagsForResourceRequest : AWSRequest /**

The Amazon Resource Name (ARN) of the given Amazon Translate resource you are querying.

*/ @property (nonatomic, strong) NSString * _Nullable resourceArn; @end /** */ @interface AWSTranslateListTagsForResourceResponse : AWSModel /**

Tags associated with the Amazon Translate resource being queried. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Translate. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

*/ @property (nonatomic, strong) NSArray * _Nullable tags; @end /** */ @interface AWSTranslateListTerminologiesRequest : AWSRequest /**

The maximum number of custom terminologies returned per list request.

*/ @property (nonatomic, strong) NSNumber * _Nullable maxResults; /**

If the result of the request to ListTerminologies was truncated, include the NextToken to fetch the next group of custom terminologies.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /** */ @interface AWSTranslateListTerminologiesResponse : AWSModel /**

If the response to the ListTerminologies was truncated, the NextToken fetches the next group of custom terminologies.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; /**

The properties list of the custom terminologies returned on the list request.

*/ @property (nonatomic, strong) NSArray * _Nullable terminologyPropertiesList; @end /** */ @interface AWSTranslateListTextTranslationJobsRequest : AWSRequest /**

The parameters that specify which batch translation jobs to retrieve. Filters include job name, job status, and submission time. You can only set one filter at a time.

*/ @property (nonatomic, strong) AWSTranslateTextTranslationJobFilter * _Nullable filter; /**

The maximum number of results to return in each page. The default value is 100.

*/ @property (nonatomic, strong) NSNumber * _Nullable maxResults; /**

The token to request the next page of results.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /** */ @interface AWSTranslateListTextTranslationJobsResponse : AWSModel /**

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; /**

A list containing the properties of each job that is returned.

*/ @property (nonatomic, strong) NSArray * _Nullable textTranslationJobPropertiesList; @end /**

The output configuration properties for a batch translation job.

Required parameters: [S3Uri] */ @interface AWSTranslateOutputDataConfig : AWSModel /**

The encryption key used to encrypt this object.

*/ @property (nonatomic, strong) AWSTranslateEncryptionKey * _Nullable encryptionKey; /**

The URI of the S3 folder that contains a translation job's output file. The folder must be in the same Region as the API endpoint that you are calling.

*/ @property (nonatomic, strong) NSString * _Nullable s3Uri; @end /**

Specifies the format and S3 location of the parallel data input file.

Required parameters: [S3Uri, Format] */ @interface AWSTranslateParallelDataConfig : AWSModel /**

The format of the parallel data input file.

*/ @property (nonatomic, assign) AWSTranslateParallelDataFormat format; /**

The URI of the Amazon S3 folder that contains the parallel data input file. The folder must be in the same Region as the API endpoint you are calling.

*/ @property (nonatomic, strong) NSString * _Nullable s3Uri; @end /**

The location of the most recent parallel data input file that was successfully imported into Amazon Translate.

Required parameters: [RepositoryType, Location] */ @interface AWSTranslateParallelDataDataLocation : AWSModel /**

The Amazon S3 location of the parallel data input file. The location is returned as a presigned URL to that has a 30-minute expiration.

Amazon Translate doesn't scan all input files for the risk of CSV injection attacks.

CSV injection occurs when a .csv or .tsv file is altered so that a record contains malicious code. The record begins with a special character, such as =, +, -, or @. When the file is opened in a spreadsheet program, the program might interpret the record as a formula and run the code within it.

Before you download an input file from Amazon S3, ensure that you recognize the file and trust its creator.

 */ @property (nonatomic, strong) NSString * _Nullable location; /**

Describes the repository that contains the parallel data input file.

*/ @property (nonatomic, strong) NSString * _Nullable repositoryType; @end /**

The properties of a parallel data resource.

*/ @interface AWSTranslateParallelDataProperties : AWSModel /**

The Amazon Resource Name (ARN) of the parallel data resource.

*/ @property (nonatomic, strong) NSString * _Nullable arn; /**

The time at which the parallel data resource was created.

*/ @property (nonatomic, strong) NSDate * _Nullable createdAt; /**

The description assigned to the parallel data resource.

*/ @property (nonatomic, strong) NSString * _Nullable detail; /**

The encryption key used to encrypt this object.

*/ @property (nonatomic, strong) AWSTranslateEncryptionKey * _Nullable encryptionKey; /**

The number of records unsuccessfully imported from the parallel data input file.

*/ @property (nonatomic, strong) NSNumber * _Nullable failedRecordCount; /**

The number of UTF-8 characters that Amazon Translate imported from the parallel data input file. This number includes only the characters in your translation examples. It does not include characters that are used to format your file. For example, if you provided a Translation Memory Exchange (.tmx) file, this number does not include the tags.

*/ @property (nonatomic, strong) NSNumber * _Nullable importedDataSize; /**

The number of records successfully imported from the parallel data input file.

*/ @property (nonatomic, strong) NSNumber * _Nullable importedRecordCount; /**

The time at which the parallel data resource was last updated.

*/ @property (nonatomic, strong) NSDate * _Nullable lastUpdatedAt; /**

The time that the most recent update was attempted.

*/ @property (nonatomic, strong) NSDate * _Nullable latestUpdateAttemptAt; /**

The status of the most recent update attempt for the parallel data resource.

*/ @property (nonatomic, assign) AWSTranslateParallelDataStatus latestUpdateAttemptStatus; /**

Additional information from Amazon Translate about the parallel data resource.

*/ @property (nonatomic, strong) NSString * _Nullable message; /**

The custom name assigned to the parallel data resource.

*/ @property (nonatomic, strong) NSString * _Nullable name; /**

Specifies the format and S3 location of the parallel data input file.

*/ @property (nonatomic, strong) AWSTranslateParallelDataConfig * _Nullable parallelDataConfig; /**

The number of items in the input file that Amazon Translate skipped when you created or updated the parallel data resource. For example, Amazon Translate skips empty records, empty target texts, and empty lines.

*/ @property (nonatomic, strong) NSNumber * _Nullable skippedRecordCount; /**

The source language of the translations in the parallel data file.

*/ @property (nonatomic, strong) NSString * _Nullable sourceLanguageCode; /**

The status of the parallel data resource. When the parallel data is ready for you to use, the status is ACTIVE.

*/ @property (nonatomic, assign) AWSTranslateParallelDataStatus status; /**

The language codes for the target languages available in the parallel data file. All possible target languages are returned as an array.

*/ @property (nonatomic, strong) NSArray * _Nullable targetLanguageCodes; @end /** */ @interface AWSTranslateStartTextTranslationJobRequest : AWSRequest /**

A unique identifier for the request. This token is generated for you when using the Amazon Translate SDK.

*/ @property (nonatomic, strong) NSString * _Nullable clientToken; /**

The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that grants Amazon Translate read access to your input data. For more information, see Identity and access management .

*/ @property (nonatomic, strong) NSString * _Nullable dataAccessRoleArn; /**

Specifies the format and location of the input documents for the translation job.

*/ @property (nonatomic, strong) AWSTranslateInputDataConfig * _Nullable inputDataConfig; /**

The name of the batch translation job to be performed.

*/ @property (nonatomic, strong) NSString * _Nullable jobName; /**

Specifies the S3 folder to which your job output will be saved.

*/ @property (nonatomic, strong) AWSTranslateOutputDataConfig * _Nullable outputDataConfig; /**

The name of a parallel data resource to add to the translation job. This resource consists of examples that show how you want segments of text to be translated. If you specify multiple target languages for the job, the parallel data file must include translations for all the target languages.

When you add parallel data to a translation job, you create an Active Custom Translation job.

This parameter accepts only one parallel data resource.

Active Custom Translation jobs are priced at a higher rate than other jobs that don't use parallel data. For more information, see Amazon Translate pricing.

For a list of available parallel data resources, use the ListParallelData operation.

For more information, see Customizing your translations with parallel data.

*/ @property (nonatomic, strong) NSArray * _Nullable parallelDataNames; /**

Settings to configure your translation output, including the option to set the formality level of the output text and the option to mask profane words and phrases.

*/ @property (nonatomic, strong) AWSTranslateTranslationSettings * _Nullable settings; /**

The language code of the input language. Specify the language if all input documents share the same language. If you don't know the language of the source files, or your input documents contains different source languages, select auto. Amazon Translate auto detects the source language for each input document. For a list of supported language codes, see Supported languages.

*/ @property (nonatomic, strong) NSString * _Nullable sourceLanguageCode; /**

The target languages of the translation job. Enter up to 10 language codes. Each input file is translated into each target language.

Each language code is 2 or 5 characters long. For a list of language codes, see Supported languages.

*/ @property (nonatomic, strong) NSArray * _Nullable targetLanguageCodes; /**

The name of a custom terminology resource to add to the translation job. This resource lists examples source terms and the desired translation for each term.

This parameter accepts only one custom terminology resource.

If you specify multiple target languages for the job, translate uses the designated terminology for each requested target language that has an entry for the source term in the terminology file.

For a list of available custom terminology resources, use the ListTerminologies operation.

For more information, see Custom terminology.

*/ @property (nonatomic, strong) NSArray * _Nullable terminologyNames; @end /** */ @interface AWSTranslateStartTextTranslationJobResponse : AWSModel /**

The identifier generated for the job. To get the status of a job, use this ID with the DescribeTextTranslationJob operation.

*/ @property (nonatomic, strong) NSString * _Nullable jobId; /**

The status of the job. Possible values include:

  • SUBMITTED - The job has been received and is queued for processing.

  • IN_PROGRESS - Amazon Translate is processing the job.

  • COMPLETED - The job was successfully completed and the output is available.

  • COMPLETED_WITH_ERROR - The job was completed with errors. The errors can be analyzed in the job's output.

  • FAILED - The job did not complete. To get details, use the DescribeTextTranslationJob operation.

  • STOP_REQUESTED - The user who started the job has requested that it be stopped.

  • STOPPED - The job has been stopped.

*/ @property (nonatomic, assign) AWSTranslateJobStatus jobStatus; @end /** */ @interface AWSTranslateStopTextTranslationJobRequest : AWSRequest /**

The job ID of the job to be stopped.

*/ @property (nonatomic, strong) NSString * _Nullable jobId; @end /** */ @interface AWSTranslateStopTextTranslationJobResponse : AWSModel /**

The job ID of the stopped batch translation job.

*/ @property (nonatomic, strong) NSString * _Nullable jobId; /**

The status of the designated job. Upon successful completion, the job's status will be STOPPED.

*/ @property (nonatomic, assign) AWSTranslateJobStatus jobStatus; @end /**

A key-value pair that adds as a metadata to a resource used by Amazon Translate.

Required parameters: [Key, Value] */ @interface AWSTranslateTag : AWSModel /**

The initial part of a key-value pair that forms a tag associated with a given resource.

*/ @property (nonatomic, strong) NSString * _Nullable key; /**

The second part of a key-value pair that forms a tag associated with a given resource.

*/ @property (nonatomic, strong) NSString * _Nullable value; @end /** */ @interface AWSTranslateTagResourceRequest : AWSRequest /**

The Amazon Resource Name (ARN) of the given Amazon Translate resource to which you want to associate the tags.

*/ @property (nonatomic, strong) NSString * _Nullable resourceArn; /**

Tags being associated with a specific Amazon Translate resource. There can be a maximum of 50 tags (both existing and pending) associated with a specific resource.

*/ @property (nonatomic, strong) NSArray * _Nullable tags; @end /** */ @interface AWSTranslateTagResourceResponse : AWSModel @end /**

The term being translated by the custom terminology.

*/ @interface AWSTranslateTerm : AWSModel /**

The source text of the term being translated by the custom terminology.

*/ @property (nonatomic, strong) NSString * _Nullable sourceText; /**

The target text of the term being translated by the custom terminology.

*/ @property (nonatomic, strong) NSString * _Nullable targetText; @end /**

The data associated with the custom terminology. For information about the custom terminology file, see Creating a Custom Terminology.

Required parameters: [File, Format] */ @interface AWSTranslateTerminologyData : AWSModel /**

The directionality of your terminology resource indicates whether it has one source language (uni-directional) or multiple (multi-directional).

UNI

The terminology resource has one source language (for example, the first column in a CSV file), and all of its other languages are target languages.

MULTI

Any language in the terminology resource can be the source language or a target language. A single multi-directional terminology resource can be used for jobs that translate different language pairs. For example, if the terminology contains English and Spanish terms, it can be used for jobs that translate English to Spanish and Spanish to English.

When you create a custom terminology resource without specifying the directionality, it behaves as uni-directional terminology, although this parameter will have a null value.

*/ @property (nonatomic, assign) AWSTranslateDirectionality directionality; /**

The file containing the custom terminology data. Your version of the AWS SDK performs a Base64-encoding on this field before sending a request to the AWS service. Users of the SDK should not perform Base64-encoding themselves.

*/ @property (nonatomic, strong) NSData * _Nullable file; /**

The data format of the custom terminology.

*/ @property (nonatomic, assign) AWSTranslateTerminologyDataFormat format; @end /**

The location of the custom terminology data.

Required parameters: [RepositoryType, Location] */ @interface AWSTranslateTerminologyDataLocation : AWSModel /**

The Amazon S3 location of the most recent custom terminology input file that was successfully imported into Amazon Translate. The location is returned as a presigned URL that has a 30-minute expiration .

Amazon Translate doesn't scan all input files for the risk of CSV injection attacks.

CSV injection occurs when a .csv or .tsv file is altered so that a record contains malicious code. The record begins with a special character, such as =, +, -, or @. When the file is opened in a spreadsheet program, the program might interpret the record as a formula and run the code within it.

Before you download an input file from Amazon S3, ensure that you recognize the file and trust its creator.

 */ @property (nonatomic, strong) NSString * _Nullable location; /**

The repository type for the custom terminology data.

*/ @property (nonatomic, strong) NSString * _Nullable repositoryType; @end /**

The properties of the custom terminology.

*/ @interface AWSTranslateTerminologyProperties : AWSModel /**

The Amazon Resource Name (ARN) of the custom terminology.

*/ @property (nonatomic, strong) NSString * _Nullable arn; /**

The time at which the custom terminology was created, based on the timestamp.

*/ @property (nonatomic, strong) NSDate * _Nullable createdAt; /**

The description of the custom terminology properties.

*/ @property (nonatomic, strong) NSString * _Nullable detail; /**

The directionality of your terminology resource indicates whether it has one source language (uni-directional) or multiple (multi-directional).

UNI

The terminology resource has one source language (the first column in a CSV file), and all of its other languages are target languages.

MULTI

Any language in the terminology resource can be the source language.

*/ @property (nonatomic, assign) AWSTranslateDirectionality directionality; /**

The encryption key for the custom terminology.

*/ @property (nonatomic, strong) AWSTranslateEncryptionKey * _Nullable encryptionKey; /**

The format of the custom terminology input file.

*/ @property (nonatomic, assign) AWSTranslateTerminologyDataFormat format; /**

The time at which the custom terminology was last update, based on the timestamp.

*/ @property (nonatomic, strong) NSDate * _Nullable lastUpdatedAt; /**

Additional information from Amazon Translate about the terminology resource.

*/ @property (nonatomic, strong) NSString * _Nullable message; /**

The name of the custom terminology.

*/ @property (nonatomic, strong) NSString * _Nullable name; /**

The size of the file used when importing a custom terminology.

*/ @property (nonatomic, strong) NSNumber * _Nullable sizeBytes; /**

The number of terms in the input file that Amazon Translate skipped when you created or updated the terminology resource.

*/ @property (nonatomic, strong) NSNumber * _Nullable skippedTermCount; /**

The language code for the source text of the translation request for which the custom terminology is being used.

*/ @property (nonatomic, strong) NSString * _Nullable sourceLanguageCode; /**

The language codes for the target languages available with the custom terminology resource. All possible target languages are returned in array.

*/ @property (nonatomic, strong) NSArray * _Nullable targetLanguageCodes; /**

The number of terms included in the custom terminology.

*/ @property (nonatomic, strong) NSNumber * _Nullable termCount; @end /**

Provides information for filtering a list of translation jobs. For more information, see ListTextTranslationJobs.

*/ @interface AWSTranslateTextTranslationJobFilter : AWSModel /**

Filters the list of jobs by name.

*/ @property (nonatomic, strong) NSString * _Nullable jobName; /**

Filters the list of jobs based by job status.

*/ @property (nonatomic, assign) AWSTranslateJobStatus jobStatus; /**

Filters the list of jobs based on the time that the job was submitted for processing and returns only the jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.

*/ @property (nonatomic, strong) NSDate * _Nullable submittedAfterTime; /**

Filters the list of jobs based on the time that the job was submitted for processing and returns only the jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.

*/ @property (nonatomic, strong) NSDate * _Nullable submittedBeforeTime; @end /**

Provides information about a translation job.

*/ @interface AWSTranslateTextTranslationJobProperties : AWSModel /**

The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that granted Amazon Translate read access to the job's input data.

*/ @property (nonatomic, strong) NSString * _Nullable dataAccessRoleArn; /**

The time at which the translation job ended.

*/ @property (nonatomic, strong) NSDate * _Nullable endTime; /**

The input configuration properties that were specified when the job was requested.

*/ @property (nonatomic, strong) AWSTranslateInputDataConfig * _Nullable inputDataConfig; /**

The number of documents successfully and unsuccessfully processed during the translation job.

*/ @property (nonatomic, strong) AWSTranslateJobDetails * _Nullable jobDetails; /**

The ID of the translation job.

*/ @property (nonatomic, strong) NSString * _Nullable jobId; /**

The user-defined name of the translation job.

*/ @property (nonatomic, strong) NSString * _Nullable jobName; /**

The status of the translation job.

*/ @property (nonatomic, assign) AWSTranslateJobStatus jobStatus; /**

An explanation of any errors that may have occurred during the translation job.

*/ @property (nonatomic, strong) NSString * _Nullable message; /**

The output configuration properties that were specified when the job was requested.

*/ @property (nonatomic, strong) AWSTranslateOutputDataConfig * _Nullable outputDataConfig; /**

A list containing the names of the parallel data resources applied to the translation job.

*/ @property (nonatomic, strong) NSArray * _Nullable parallelDataNames; /**

Settings that modify the translation output.

*/ @property (nonatomic, strong) AWSTranslateTranslationSettings * _Nullable settings; /**

The language code of the language of the source text. The language must be a language supported by Amazon Translate.

*/ @property (nonatomic, strong) NSString * _Nullable sourceLanguageCode; /**

The time at which the translation job was submitted.

*/ @property (nonatomic, strong) NSDate * _Nullable submittedTime; /**

The language code of the language of the target text. The language must be a language supported by Amazon Translate.

*/ @property (nonatomic, strong) NSArray * _Nullable targetLanguageCodes; /**

A list containing the names of the terminologies applied to a translation job. Only one terminology can be applied per StartTextTranslationJob request at this time.

*/ @property (nonatomic, strong) NSArray * _Nullable terminologyNames; @end /** */ @interface AWSTranslateTranslateDocumentRequest : AWSRequest /**

The content and content type for the document to be translated. The document size must not exceed 100 KB.

*/ @property (nonatomic, strong) AWSTranslateDocument * _Nullable document; /**

Settings to configure your translation output, including the option to set the formality level of the output text and the option to mask profane words and phrases.

*/ @property (nonatomic, strong) AWSTranslateTranslationSettings * _Nullable settings; /**

The language code for the language of the source text. Do not use auto, because TranslateDocument does not support language auto-detection. For a list of supported language codes, see Supported languages.

*/ @property (nonatomic, strong) NSString * _Nullable sourceLanguageCode; /**

The language code requested for the translated document. For a list of supported language codes, see Supported languages.

*/ @property (nonatomic, strong) NSString * _Nullable targetLanguageCode; /**

The name of a terminology list file to add to the translation job. This file provides source terms and the desired translation for each term. A terminology list can contain a maximum of 256 terms. You can use one custom terminology resource in your translation request.

Use the ListTerminologies operation to get the available terminology lists.

For more information about custom terminology lists, see Custom terminology.

*/ @property (nonatomic, strong) NSArray * _Nullable terminologyNames; @end /** */ @interface AWSTranslateTranslateDocumentResponse : AWSModel /**

Settings to configure your translation output, including the option to set the formality level of the output text and the option to mask profane words and phrases.

*/ @property (nonatomic, strong) AWSTranslateTranslationSettings * _Nullable appliedSettings; /**

The names of the custom terminologies applied to the input text by Amazon Translate to produce the translated text document.

*/ @property (nonatomic, strong) NSArray * _Nullable appliedTerminologies; /**

The language code of the source document.

*/ @property (nonatomic, strong) NSString * _Nullable sourceLanguageCode; /**

The language code of the translated document.

*/ @property (nonatomic, strong) NSString * _Nullable targetLanguageCode; /**

The document containing the translated content. The document format matches the source document format.

*/ @property (nonatomic, strong) AWSTranslateTranslatedDocument * _Nullable translatedDocument; @end /** */ @interface AWSTranslateTranslateTextRequest : AWSRequest /**

Settings to configure your translation output, including the option to set the formality level of the output text and the option to mask profane words and phrases.

*/ @property (nonatomic, strong) AWSTranslateTranslationSettings * _Nullable settings; /**

The language code for the language of the source text. For a list of language codes, see Supported languages.

To have Amazon Translate determine the source language of your text, you can specify auto in the SourceLanguageCode field. If you specify auto, Amazon Translate will call Amazon Comprehend to determine the source language.

If you specify auto, you must send the TranslateText request in a region that supports Amazon Comprehend. Otherwise, the request returns an error indicating that autodetect is not supported.

*/ @property (nonatomic, strong) NSString * _Nullable sourceLanguageCode; /**

The language code requested for the language of the target text. For a list of language codes, see Supported languages.

*/ @property (nonatomic, strong) NSString * _Nullable targetLanguageCode; /**

The name of a terminology list file to add to the translation job. This file provides source terms and the desired translation for each term. A terminology list can contain a maximum of 256 terms. You can use one custom terminology resource in your translation request.

Use the ListTerminologies operation to get the available terminology lists.

For more information about custom terminology lists, see Custom terminology.

*/ @property (nonatomic, strong) NSArray * _Nullable terminologyNames; /**

The text to translate. The text string can be a maximum of 10,000 bytes long. Depending on your character set, this may be fewer than 10,000 characters.

*/ @property (nonatomic, strong) NSString * _Nullable text; @end /** */ @interface AWSTranslateTranslateTextResponse : AWSModel /**

Optional settings that modify the translation output.

*/ @property (nonatomic, strong) AWSTranslateTranslationSettings * _Nullable appliedSettings; /**

The names of the custom terminologies applied to the input text by Amazon Translate for the translated text response.

*/ @property (nonatomic, strong) NSArray * _Nullable appliedTerminologies; /**

The language code for the language of the source text.

*/ @property (nonatomic, strong) NSString * _Nullable sourceLanguageCode; /**

The language code for the language of the target text.

*/ @property (nonatomic, strong) NSString * _Nullable targetLanguageCode; /**

The translated text.

*/ @property (nonatomic, strong) NSString * _Nullable translatedText; @end /**

The translated content.

Required parameters: [Content] */ @interface AWSTranslateTranslatedDocument : AWSModel /**

The document containing the translated content.

*/ @property (nonatomic, strong) NSData * _Nullable content; @end /**

Settings to configure your translation output, including the option to set the formality level of the output text and the option to mask profane words and phrases.

*/ @interface AWSTranslateTranslationSettings : AWSModel /**

You can optionally specify the desired level of formality for translations to supported target languages. The formality setting controls the level of formal language usage (also known as register) in the translation output. You can set the value to informal or formal. If you don't specify a value for formality, or if the target language doesn't support formality, the translation will ignore the formality setting.

If you specify multiple target languages for the job, translate ignores the formality setting for any unsupported target language.

For a list of target languages that support formality, see Supported languages in the Amazon Translate Developer Guide.

*/ @property (nonatomic, assign) AWSTranslateFormality formality; /**

Enable the profanity setting if you want Amazon Translate to mask profane words and phrases in your translation output.

To mask profane words and phrases, Amazon Translate replaces them with the grawlix string “?$#@$“. This 5-character sequence is used for each profane word or phrase, regardless of the length or number of words.

Amazon Translate doesn't detect profanity in all of its supported languages. For languages that don't support profanity detection, see Unsupported languages in the Amazon Translate Developer Guide.

If you specify multiple target languages for the job, all the target languages must support profanity masking. If any of the target languages don't support profanity masking, the translation job won't mask profanity for any target language.

*/ @property (nonatomic, assign) AWSTranslateProfanity profanity; @end /** */ @interface AWSTranslateUntagResourceRequest : AWSRequest /**

The Amazon Resource Name (ARN) of the given Amazon Translate resource from which you want to remove the tags.

*/ @property (nonatomic, strong) NSString * _Nullable resourceArn; /**

The initial part of a key-value pair that forms a tag being removed from a given resource. Keys must be unique and cannot be duplicated for a particular resource.

*/ @property (nonatomic, strong) NSArray * _Nullable tagKeys; @end /** */ @interface AWSTranslateUntagResourceResponse : AWSModel @end /** */ @interface AWSTranslateUpdateParallelDataRequest : AWSRequest /**

A unique identifier for the request. This token is automatically generated when you use Amazon Translate through an AWS SDK.

*/ @property (nonatomic, strong) NSString * _Nullable clientToken; /**

A custom description for the parallel data resource in Amazon Translate.

*/ @property (nonatomic, strong) NSString * _Nullable detail; /**

The name of the parallel data resource being updated.

*/ @property (nonatomic, strong) NSString * _Nullable name; /**

Specifies the format and S3 location of the parallel data input file.

*/ @property (nonatomic, strong) AWSTranslateParallelDataConfig * _Nullable parallelDataConfig; @end /** */ @interface AWSTranslateUpdateParallelDataResponse : AWSModel /**

The time that the most recent update was attempted.

*/ @property (nonatomic, strong) NSDate * _Nullable latestUpdateAttemptAt; /**

The status of the parallel data update attempt. When the updated parallel data resource is ready for you to use, the status is ACTIVE.

*/ @property (nonatomic, assign) AWSTranslateParallelDataStatus latestUpdateAttemptStatus; /**

The name of the parallel data resource being updated.

*/ @property (nonatomic, strong) NSString * _Nullable name; /**

The status of the parallel data resource that you are attempting to update. Your update request is accepted only if this status is either ACTIVE or FAILED.

*/ @property (nonatomic, assign) AWSTranslateParallelDataStatus status; @end NS_ASSUME_NONNULL_END