Class: Aws::Translate::Client

Inherits:
Seahorse::Client::Base show all
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

#config, #handlers

API Operations collapse

Instance Method Summary collapse

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.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts.
  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String) —

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :secret_access_key (String)
  • :session_token (String)
  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

    When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects.

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15 —

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Integer) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



334
335
336
 
# File 'gems/aws-sdk-translate/lib/aws-sdk-translate/client.rb', line 334

def initialize(*args)
  super
end

Instance Method Details

#delete_terminology(params = {}) ⇒ Struct

A synchronous action that deletes a custom terminology.

Examples:

Request syntax with placeholder values


resp = client.delete_terminology({
  name: "ResourceName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the custom terminology being deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



357
358
359
360
 
# File 'gems/aws-sdk-translate/lib/aws-sdk-translate/client.rb', line 357

def delete_terminology(params = {}, options = {})
  req = build_request(:delete_terminology, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.describe_text_translation_job({
  job_id: "JobId", # required
})

Response structure


resp.text_translation_job_properties.job_id #=> String
resp.text_translation_job_properties.job_name #=> String
resp.text_translation_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "COMPLETED_WITH_ERROR", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.text_translation_job_properties.job_details.translated_documents_count #=> Integer
resp.text_translation_job_properties.job_details.documents_with_errors_count #=> Integer
resp.text_translation_job_properties.job_details.input_documents_count #=> Integer
resp.text_translation_job_properties.source_language_code #=> String
resp.text_translation_job_properties.target_language_codes #=> Array
resp.text_translation_job_properties.target_language_codes[0] #=> String
resp.text_translation_job_properties.terminology_names #=> Array
resp.text_translation_job_properties.terminology_names[0] #=> String
resp.text_translation_job_properties.message #=> String
resp.text_translation_job_properties.submitted_time #=> Time
resp.text_translation_job_properties.end_time #=> Time
resp.text_translation_job_properties.input_data_config.s3_uri #=> String
resp.text_translation_job_properties.input_data_config.content_type #=> String
resp.text_translation_job_properties.output_data_config.s3_uri #=> String
resp.text_translation_job_properties.data_access_role_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :job_id (required, String) —

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

Returns:

See Also:



406
407
408
409
 
# File 'gems/aws-sdk-translate/lib/aws-sdk-translate/client.rb', line 406

def describe_text_translation_job(params = {}, options = {})
  req = build_request(:describe_text_translation_job, params)
  req.send_request(options)
end

#get_terminology(params = {}) ⇒ Types::GetTerminologyResponse

Retrieves a custom terminology.

Examples:

Request syntax with placeholder values


resp = client.get_terminology({
  name: "ResourceName", # required
  terminology_data_format: "CSV", # required, accepts CSV, TMX
})

Response structure


resp.terminology_properties.name #=> String
resp.terminology_properties.description #=> String
resp.terminology_properties.arn #=> String
resp.terminology_properties.source_language_code #=> String
resp.terminology_properties.target_language_codes #=> Array
resp.terminology_properties.target_language_codes[0] #=> String
resp.terminology_properties.encryption_key.type #=> String, one of "KMS"
resp.terminology_properties.encryption_key.id #=> String
resp.terminology_properties.size_bytes #=> Integer
resp.terminology_properties.term_count #=> Integer
resp.terminology_properties.created_at #=> Time
resp.terminology_properties.last_updated_at #=> Time
resp.terminology_data_location.repository_type #=> String
resp.terminology_data_location.location #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the custom terminology being retrieved.

  • :terminology_data_format (required, String) —

    The data format of the custom terminology being retrieved, either CSV or TMX.

Returns:

See Also:



453
454
455
456
 
# File 'gems/aws-sdk-translate/lib/aws-sdk-translate/client.rb', line 453

def get_terminology(params = {}, options = {})
  req = build_request(:get_terminology, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.import_terminology({
  name: "ResourceName", # required
  merge_strategy: "OVERWRITE", # required, accepts OVERWRITE
  description: "Description",
  terminology_data: { # required
    file: "data", # required
    format: "CSV", # required, accepts CSV, TMX
  },
  encryption_key: {
    type: "KMS", # required, accepts KMS
    id: "EncryptionKeyID", # required
  },
})

Response structure


resp.terminology_properties.name #=> String
resp.terminology_properties.description #=> String
resp.terminology_properties.arn #=> String
resp.terminology_properties.source_language_code #=> String
resp.terminology_properties.target_language_codes #=> Array
resp.terminology_properties.target_language_codes[0] #=> String
resp.terminology_properties.encryption_key.type #=> String, one of "KMS"
resp.terminology_properties.encryption_key.id #=> String
resp.terminology_properties.size_bytes #=> Integer
resp.terminology_properties.term_count #=> Integer
resp.terminology_properties.created_at #=> Time
resp.terminology_properties.last_updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the custom terminology being imported.

  • :merge_strategy (required, String) —

    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.

  • :description (String) —

    The description of the custom terminology being imported.

  • :terminology_data (required, Types::TerminologyData) —

    The terminology data for the custom terminology being imported.

  • :encryption_key (Types::EncryptionKey) —

    The encryption key for the custom terminology being imported.

Returns:

See Also:



527
528
529
530
 
# File 'gems/aws-sdk-translate/lib/aws-sdk-translate/client.rb', line 527

def import_terminology(params = {}, options = {})
  req = build_request(:import_terminology, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_terminologies({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.terminology_properties_list #=> Array
resp.terminology_properties_list[0].name #=> String
resp.terminology_properties_list[0].description #=> String
resp.terminology_properties_list[0].arn #=> String
resp.terminology_properties_list[0].source_language_code #=> String
resp.terminology_properties_list[0].target_language_codes #=> Array
resp.terminology_properties_list[0].target_language_codes[0] #=> String
resp.terminology_properties_list[0].encryption_key.type #=> String, one of "KMS"
resp.terminology_properties_list[0].encryption_key.id #=> String
resp.terminology_properties_list[0].size_bytes #=> Integer
resp.terminology_properties_list[0].term_count #=> Integer
resp.terminology_properties_list[0].created_at #=> Time
resp.terminology_properties_list[0].last_updated_at #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

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

  • :max_results (Integer) —

    The maximum number of custom terminologies returned per list request.

Returns:

See Also:



576
577
578
579
 
# File 'gems/aws-sdk-translate/lib/aws-sdk-translate/client.rb', line 576

def list_terminologies(params = {}, options = {})
  req = build_request(:list_terminologies, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_text_translation_jobs({
  filter: {
    job_name: "JobName",
    job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, COMPLETED_WITH_ERROR, FAILED, STOP_REQUESTED, STOPPED
    submitted_before_time: Time.now,
    submitted_after_time: Time.now,
  },
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.text_translation_job_properties_list #=> Array
resp.text_translation_job_properties_list[0].job_id #=> String
resp.text_translation_job_properties_list[0].job_name #=> String
resp.text_translation_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "COMPLETED_WITH_ERROR", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.text_translation_job_properties_list[0].job_details.translated_documents_count #=> Integer
resp.text_translation_job_properties_list[0].job_details.documents_with_errors_count #=> Integer
resp.text_translation_job_properties_list[0].job_details.input_documents_count #=> Integer
resp.text_translation_job_properties_list[0].source_language_code #=> String
resp.text_translation_job_properties_list[0].target_language_codes #=> Array
resp.text_translation_job_properties_list[0].target_language_codes[0] #=> String
resp.text_translation_job_properties_list[0].terminology_names #=> Array
resp.text_translation_job_properties_list[0].terminology_names[0] #=> String
resp.text_translation_job_properties_list[0].message #=> String
resp.text_translation_job_properties_list[0].submitted_time #=> Time
resp.text_translation_job_properties_list[0].end_time #=> Time
resp.text_translation_job_properties_list[0].input_data_config.s3_uri #=> String
resp.text_translation_job_properties_list[0].input_data_config.content_type #=> String
resp.text_translation_job_properties_list[0].output_data_config.s3_uri #=> String
resp.text_translation_job_properties_list[0].data_access_role_arn #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filter (Types::TextTranslationJobFilter) —

    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.

  • :next_token (String) —

    The token to request the next page of results.

  • :max_results (Integer) —

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

Returns:

See Also:



642
643
644
645
 
# File 'gems/aws-sdk-translate/lib/aws-sdk-translate/client.rb', line 642

def list_text_translation_jobs(params = {}, options = {})
  req = build_request(:list_text_translation_jobs, params)
  req.send_request(options)
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.

Amazon Translate does not support batch translation of multiple source languages at once.

Examples:

Request syntax with placeholder values


resp = client.start_text_translation_job({
  job_name: "JobName",
  input_data_config: { # required
    s3_uri: "S3Uri", # required
    content_type: "ContentType", # required
  },
  output_data_config: { # required
    s3_uri: "S3Uri", # required
  },
  data_access_role_arn: "IamRoleArn", # required
  source_language_code: "LanguageCodeString", # required
  target_language_codes: ["LanguageCodeString"], # required
  terminology_names: ["ResourceName"],
  client_token: "ClientTokenString", # required
})

Response structure


resp.job_id #=> String
resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "COMPLETED_WITH_ERROR", "FAILED", "STOP_REQUESTED", "STOPPED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :job_name (String) —

    The name of the batch translation job to be performed.

  • :input_data_config (required, Types::InputDataConfig) —

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

  • :output_data_config (required, Types::OutputDataConfig) —

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

  • :data_access_role_arn (required, 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 nformation, see identity-and-access-management.

  • :source_language_code (required, 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.

  • :target_language_codes (required, Array<String>) —

    The language code of the output language.

  • :terminology_names (Array<String>) —

    The name of the terminology to use in the batch translation job. For a list of available terminologies, use the ListTerminologies operation.

  • :client_token (required, 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:

See Also:



729
730
731
732
 
# File 'gems/aws-sdk-translate/lib/aws-sdk-translate/client.rb', line 729

def start_text_translation_job(params = {}, options = {})
  req = build_request(:start_text_translation_job, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.stop_text_translation_job({
  job_id: "JobId", # required
})

Response structure


resp.job_id #=> String
resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "COMPLETED_WITH_ERROR", "FAILED", "STOP_REQUESTED", "STOPPED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :job_id (required, String) —

    The job ID of the job to be stopped.

Returns:

See Also:



769
770
771
772
 
# File 'gems/aws-sdk-translate/lib/aws-sdk-translate/client.rb', line 769

def stop_text_translation_job(params = {}, options = {})
  req = build_request(:stop_text_translation_job, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.translate_text({
  text: "BoundedLengthString", # required
  terminology_names: ["ResourceName"],
  source_language_code: "LanguageCodeString", # required
  target_language_code: "LanguageCodeString", # required
})

Response structure


resp.translated_text #=> String
resp.source_language_code #=> String
resp.target_language_code #=> String
resp.applied_terminologies #=> Array
resp.applied_terminologies[0].name #=> String
resp.applied_terminologies[0].terms #=> Array
resp.applied_terminologies[0].terms[0].source_text #=> String
resp.applied_terminologies[0].terms[0].target_text #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :text (required, String) —

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

  • :terminology_names (Array<String>) —

    The name of the terminology list file to be used in the TranslateText request. You can use 1 terminology list at most in a TranslateText request. Terminology lists can contain a maximum of 256 terms.

  • :source_language_code (required, String) —

    The language code for the language of the source text. The language must be a language supported by Amazon Translate. For a list of language codes, see what-is-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.

  • :target_language_code (required, String) —

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

Returns:

See Also:



837
838
839
840
 
# File 'gems/aws-sdk-translate/lib/aws-sdk-translate/client.rb', line 837

def translate_text(params = {}, options = {})
  req = build_request(:translate_text, params)
  req.send_request(options)
end