AWSTranslateStartTextTranslationJobRequest

Objective-C

@interface AWSTranslateStartTextTranslationJobRequest

Swift

class AWSTranslateStartTextTranslationJobRequest

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

    Declaration

    Objective-C

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

    Swift

    var clientToken: String? { get set }

  • 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 .

    Declaration

    Objective-C

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

    Swift

    var dataAccessRoleArn: String? { get set }

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

    Declaration

    Objective-C

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

    Swift

    var inputDataConfig: AWSTranslateInputDataConfig? { get set }

  • The name of the batch translation job to be performed.

    Declaration

    Objective-C

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

    Swift

    var jobName: String? { get set }

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

    Declaration

    Objective-C

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

    Swift

    var outputDataConfig: AWSTranslateOutputDataConfig? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSString *> *_Nullable parallelDataNames;

    Swift

    var parallelDataNames: [String]? { get set }

  • 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.

    Declaration

    Objective-C

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

    Swift

    var settings: AWSTranslateTranslationSettings? { get set }

  • 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.

    Declaration

    Objective-C

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

    Swift

    var sourceLanguageCode: String? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSString *> *_Nullable targetLanguageCodes;

    Swift

    var targetLanguageCodes: [String]? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSString *> *_Nullable terminologyNames;

    Swift

    var terminologyNames: [String]? { get set }