Class: Aws::Translate::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Translate::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-translate/lib/aws-sdk-translate/client.rb
Overview
An API client for Translate. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::Translate::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_parallel_data(params = {}) ⇒ Types::CreateParallelDataResponse
Creates a parallel data resource in Amazon Translate by importing an input file from Amazon S3.
-
#delete_parallel_data(params = {}) ⇒ Types::DeleteParallelDataResponse
Deletes a parallel data resource in Amazon Translate.
-
#delete_terminology(params = {}) ⇒ Struct
A synchronous action that deletes a custom terminology.
-
#describe_text_translation_job(params = {}) ⇒ Types::DescribeTextTranslationJobResponse
Gets the properties associated with an asycnhronous batch translation job including name, ID, status, source and target languages, input/output S3 buckets, and so on.
-
#get_parallel_data(params = {}) ⇒ Types::GetParallelDataResponse
Provides information about a parallel data resource.
-
#get_terminology(params = {}) ⇒ Types::GetTerminologyResponse
Retrieves a custom terminology.
-
#import_terminology(params = {}) ⇒ Types::ImportTerminologyResponse
Creates or updates a custom terminology, depending on whether or not one already exists for the given terminology name.
-
#list_parallel_data(params = {}) ⇒ Types::ListParallelDataResponse
Provides a list of your parallel data resources in Amazon Translate.
-
#list_terminologies(params = {}) ⇒ Types::ListTerminologiesResponse
Provides a list of custom terminologies associated with your account.
-
#list_text_translation_jobs(params = {}) ⇒ Types::ListTextTranslationJobsResponse
Gets a list of the batch translation jobs that you have submitted.
-
#start_text_translation_job(params = {}) ⇒ Types::StartTextTranslationJobResponse
Starts an asynchronous batch translation job.
-
#stop_text_translation_job(params = {}) ⇒ Types::StopTextTranslationJobResponse
Stops an asynchronous batch translation job that is in progress.
-
#translate_text(params = {}) ⇒ Types::TranslateTextResponse
Translates input text from the source language to the target language.
-
#update_parallel_data(params = {}) ⇒ Types::UpdateParallelDataResponse
Updates a previously created parallel data resource by importing a new input file from Amazon S3.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
334 335 336 |
# File 'gems/aws-sdk-translate/lib/aws-sdk-translate/client.rb', line 334 def initialize(*args) super end |
Instance Method Details
#create_parallel_data(params = {}) ⇒ Types::CreateParallelDataResponse
Creates a parallel data resource in Amazon Translate by importing an input file from Amazon S3. Parallel data files contain examples of source phrases and their translations from your translation memory. By adding parallel data, you can influence the style, tone, and word choice in your translation output.
397 398 399 400 |
# File 'gems/aws-sdk-translate/lib/aws-sdk-translate/client.rb', line 397 def create_parallel_data(params = {}, = {}) req = build_request(:create_parallel_data, params) req.send_request() end |
#delete_parallel_data(params = {}) ⇒ Types::DeleteParallelDataResponse
Deletes a parallel data resource in Amazon Translate.
427 428 429 430 |
# File 'gems/aws-sdk-translate/lib/aws-sdk-translate/client.rb', line 427 def delete_parallel_data(params = {}, = {}) req = build_request(:delete_parallel_data, params) req.send_request() end |
#delete_terminology(params = {}) ⇒ Struct
A synchronous action that deletes a custom terminology.
449 450 451 452 |
# File 'gems/aws-sdk-translate/lib/aws-sdk-translate/client.rb', line 449 def delete_terminology(params = {}, = {}) req = build_request(:delete_terminology, params) req.send_request() end |
#describe_text_translation_job(params = {}) ⇒ Types::DescribeTextTranslationJobResponse
Gets the properties associated with an asycnhronous batch translation job including name, ID, status, source and target languages, input/output S3 buckets, and so on.
500 501 502 503 |
# File 'gems/aws-sdk-translate/lib/aws-sdk-translate/client.rb', line 500 def describe_text_translation_job(params = {}, = {}) req = build_request(:describe_text_translation_job, params) req.send_request() end |
#get_parallel_data(params = {}) ⇒ Types::GetParallelDataResponse
Provides information about a parallel data resource.
556 557 558 559 |
# File 'gems/aws-sdk-translate/lib/aws-sdk-translate/client.rb', line 556 def get_parallel_data(params = {}, = {}) req = build_request(:get_parallel_data, params) req.send_request() end |
#get_terminology(params = {}) ⇒ Types::GetTerminologyResponse
Retrieves a custom terminology.
603 604 605 606 |
# File 'gems/aws-sdk-translate/lib/aws-sdk-translate/client.rb', line 603 def get_terminology(params = {}, = {}) req = build_request(:get_terminology, params) req.send_request() end |
#import_terminology(params = {}) ⇒ Types::ImportTerminologyResponse
Creates or updates a custom terminology, depending on whether or not one already exists for the given terminology name. Importing a terminology with the same name as an existing one will merge the terminologies based on the chosen merge strategy. Currently, the only supported merge strategy is OVERWRITE, and so the imported terminology will overwrite an existing terminology of the same name.
If you import a terminology that overwrites an existing one, the new terminology take up to 10 minutes to fully propagate and be available for use in a translation due to cache policies with the DataPlane service that performs the translations.
677 678 679 680 |
# File 'gems/aws-sdk-translate/lib/aws-sdk-translate/client.rb', line 677 def import_terminology(params = {}, = {}) req = build_request(:import_terminology, params) req.send_request() end |
#list_parallel_data(params = {}) ⇒ Types::ListParallelDataResponse
Provides a list of your parallel data resources in Amazon Translate.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
735 736 737 738 |
# File 'gems/aws-sdk-translate/lib/aws-sdk-translate/client.rb', line 735 def list_parallel_data(params = {}, = {}) req = build_request(:list_parallel_data, params) req.send_request() end |
#list_terminologies(params = {}) ⇒ Types::ListTerminologiesResponse
Provides a list of custom terminologies associated with your account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
784 785 786 787 |
# File 'gems/aws-sdk-translate/lib/aws-sdk-translate/client.rb', line 784 def list_terminologies(params = {}, = {}) req = build_request(:list_terminologies, params) req.send_request() end |
#list_text_translation_jobs(params = {}) ⇒ Types::ListTextTranslationJobsResponse
Gets a list of the batch translation jobs that you have submitted.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
852 853 854 855 |
# File 'gems/aws-sdk-translate/lib/aws-sdk-translate/client.rb', line 852 def list_text_translation_jobs(params = {}, = {}) req = build_request(:list_text_translation_jobs, params) req.send_request() end |
#start_text_translation_job(params = {}) ⇒ Types::StartTextTranslationJobResponse
Starts an asynchronous batch translation job. Batch translation jobs can be used to translate large volumes of text across multiple documents at once. For more information, see async.
Batch translation jobs can be described with the DescribeTextTranslationJob operation, listed with the ListTextTranslationJobs operation, and stopped with the StopTextTranslationJob operation.
945 946 947 948 |
# File 'gems/aws-sdk-translate/lib/aws-sdk-translate/client.rb', line 945 def start_text_translation_job(params = {}, = {}) req = build_request(:start_text_translation_job, params) req.send_request() end |
#stop_text_translation_job(params = {}) ⇒ Types::StopTextTranslationJobResponse
Stops an asynchronous batch translation job that is in progress.
If the job's state is IN_PROGRESS
, the job will be marked for
termination and put into the STOP_REQUESTED
state. If the job
completes before it can be stopped, it is put into the COMPLETED
state. Otherwise, the job is put into the STOPPED
state.
Asynchronous batch translation jobs are started with the
StartTextTranslationJob operation. You can use the
DescribeTextTranslationJob or ListTextTranslationJobs operations to
get a batch translation job's JobId
.
985 986 987 988 |
# File 'gems/aws-sdk-translate/lib/aws-sdk-translate/client.rb', line 985 def stop_text_translation_job(params = {}, = {}) req = build_request(:stop_text_translation_job, params) req.send_request() end |
#translate_text(params = {}) ⇒ Types::TranslateTextResponse
Translates input text from the source language to the target language. For a list of available languages and language codes, see what-is-languages.
1053 1054 1055 1056 |
# File 'gems/aws-sdk-translate/lib/aws-sdk-translate/client.rb', line 1053 def translate_text(params = {}, = {}) req = build_request(:translate_text, params) req.send_request() end |
#update_parallel_data(params = {}) ⇒ Types::UpdateParallelDataResponse
Updates a previously created parallel data resource by importing a new input file from Amazon S3.
1108 1109 1110 1111 |
# File 'gems/aws-sdk-translate/lib/aws-sdk-translate/client.rb', line 1108 def update_parallel_data(params = {}, = {}) req = build_request(:update_parallel_data, params) req.send_request() end |