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

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

Overview

Note:

When making an API call, you may pass StartTextTranslationJobRequest data as a hash:

{
  job_name: "JobName",
  input_data_config: { # required
    s3_uri: "S3Uri", # required
    content_type: "ContentType", # required
  },
  output_data_config: { # required
    s3_uri: "S3Uri", # required
    encryption_key: {
      type: "KMS", # required, accepts KMS
      id: "EncryptionKeyID", # required
    },
  },
  data_access_role_arn: "IamRoleArn", # required
  source_language_code: "LanguageCodeString", # required
  target_language_codes: ["LanguageCodeString"], # required
  terminology_names: ["ResourceName"],
  parallel_data_names: ["ResourceName"],
  client_token: "ClientTokenString", # required
}

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 auto-generated when using the Amazon Translate SDK.

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

Returns:

  • (String) 


1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
 
# File 'lib/aws-sdk-translate/types.rb', line 1136

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

Returns:

  • (String) 


1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
 
# File 'lib/aws-sdk-translate/types.rb', line 1136

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)
  SENSITIVE = []
  include Aws::Structure
end

#input_data_config ⇒ Types::InputDataConfig

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

Returns:



1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
 
# File 'lib/aws-sdk-translate/types.rb', line 1136

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)
  SENSITIVE = []
  include Aws::Structure
end

#job_name ⇒ String

The name of the batch translation job to be performed.

Returns:

  • (String) 


1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
 
# File 'lib/aws-sdk-translate/types.rb', line 1136

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)
  SENSITIVE = []
  include Aws::Structure
end

#output_data_config ⇒ Types::OutputDataConfig

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

Returns:



1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
 
# File 'lib/aws-sdk-translate/types.rb', line 1136

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)
  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. 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-translations-parallel-data.

[1]: aws.amazon.com/translate/pricing/

Returns:

  • (Array<String>) 


1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
 
# File 'lib/aws-sdk-translate/types.rb', line 1136

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)
  SENSITIVE = []
  include Aws::Structure
end

#source_language_code ⇒ String

The language code of the input language. For a list of language codes, see what-is-languages.

Amazon Translate does not automatically detect a source language during batch translation jobs.

Returns:

  • (String) 


1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
 
# File 'lib/aws-sdk-translate/types.rb', line 1136

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)
  SENSITIVE = []
  include Aws::Structure
end

#target_language_codes ⇒ Array<String>

The language code of the output language.

Returns:

  • (Array<String>) 


1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
 
# File 'lib/aws-sdk-translate/types.rb', line 1136

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

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

For more information, see how-custom-terminology.

Returns:

  • (Array<String>) 


1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
 
# File 'lib/aws-sdk-translate/types.rb', line 1136

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)
  SENSITIVE = []
  include Aws::Structure
end