Class: Aws::Translate::Types::StartTextTranslationJobRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-translate/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

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

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

  • (String) 


1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
 
# File 'lib/aws-sdk-translate/types.rb', line 1183

class StartTextTranslationJobRequest < Struct.new(
  :job_name,
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :source_language_code,
  :target_language_codes,
  :terminology_names,
  :parallel_data_names,
  :client_token,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end

#data_access_role_arn ⇒ String

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 ][1].

[1]: docs.aws.amazon.com/translate/latest/dg/identity-and-access-management.html

Returns:

  • (String) 


1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
 
# File 'lib/aws-sdk-translate/types.rb', line 1183

class StartTextTranslationJobRequest < Struct.new(
  :job_name,
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :source_language_code,
  :target_language_codes,
  :terminology_names,
  :parallel_data_names,
  :client_token,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end

#input_data_config ⇒ Types::InputDataConfig

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

Returns:



1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
 
# File 'lib/aws-sdk-translate/types.rb', line 1183

class StartTextTranslationJobRequest < Struct.new(
  :job_name,
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :source_language_code,
  :target_language_codes,
  :terminology_names,
  :parallel_data_names,
  :client_token,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end

#job_name ⇒ String

The name of the batch translation job to be performed.

Returns:

  • (String) 


1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
 
# File 'lib/aws-sdk-translate/types.rb', line 1183

class StartTextTranslationJobRequest < Struct.new(
  :job_name,
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :source_language_code,
  :target_language_codes,
  :terminology_names,
  :parallel_data_names,
  :client_token,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end

#output_data_config ⇒ Types::OutputDataConfig

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

Returns:



1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
 
# File 'lib/aws-sdk-translate/types.rb', line 1183

class StartTextTranslationJobRequest < Struct.new(
  :job_name,
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :source_language_code,
  :target_language_codes,
  :terminology_names,
  :parallel_data_names,
  :client_token,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end

#parallel_data_names ⇒ Array<String>

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.

<note markdown=“1”> 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].

</note>

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

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

[1]: aws.amazon.com/translate/pricing/ [2]: docs.aws.amazon.com/translate/latest/dg/customizing-translations-parallel-data.html

Returns:

  • (Array<String>) 


1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
 
# File 'lib/aws-sdk-translate/types.rb', line 1183

class StartTextTranslationJobRequest < Struct.new(
  :job_name,
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :source_language_code,
  :target_language_codes,
  :terminology_names,
  :parallel_data_names,
  :client_token,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end

#settings ⇒ Types::TranslationSettings

Settings to configure your translation output. You can configure the following options:

  • Brevity: not supported.

  • Formality: sets the formality level of the output text.

  • Profanity: masks profane words and phrases in your translation output.

Returns:



1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
 
# File 'lib/aws-sdk-translate/types.rb', line 1183

class StartTextTranslationJobRequest < Struct.new(
  :job_name,
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :source_language_code,
  :target_language_codes,
  :terminology_names,
  :parallel_data_names,
  :client_token,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end

#source_language_code ⇒ String

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

[1]: docs.aws.amazon.com/translate/latest/dg/what-is-languages.html

Returns:

  • (String) 


1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
 
# File 'lib/aws-sdk-translate/types.rb', line 1183

class StartTextTranslationJobRequest < Struct.new(
  :job_name,
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :source_language_code,
  :target_language_codes,
  :terminology_names,
  :parallel_data_names,
  :client_token,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end

#target_language_codes ⇒ Array<String>

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

[1]: docs.aws.amazon.com/translate/latest/dg/what-is-languages.html

Returns:

  • (Array<String>) 


1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
 
# File 'lib/aws-sdk-translate/types.rb', line 1183

class StartTextTranslationJobRequest < Struct.new(
  :job_name,
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :source_language_code,
  :target_language_codes,
  :terminology_names,
  :parallel_data_names,
  :client_token,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end

#terminology_names ⇒ Array<String>

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

[1]: docs.aws.amazon.com/translate/latest/dg/how-custom-terminology.html

Returns:

  • (Array<String>) 


1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
 
# File 'lib/aws-sdk-translate/types.rb', line 1183

class StartTextTranslationJobRequest < Struct.new(
  :job_name,
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :source_language_code,
  :target_language_codes,
  :terminology_names,
  :parallel_data_names,
  :client_token,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end