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

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

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

    Your AWS credentials used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or 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, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.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::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.

  • :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)
  • :account_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.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

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

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

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :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.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

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

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :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 the 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 - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disables response data type conversions. The request parameters hash must be formatted exactly as the API expects.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.

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

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

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

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

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

  • :endpoint_provider (Aws::Translate::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::Translate::EndpointParameters.

  • :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_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_open_timeout (Float) — default: 15 —

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

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

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

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. 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.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

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

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

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



480
481
482
 
# File 'gems/aws-sdk-translate/lib/aws-sdk-translate/client.rb', line 480

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 that show how you want segments of text to be translated. By adding parallel data, you can influence the style, tone, and word choice in your translation output.

Examples:

Request syntax with placeholder values


resp = client.create_parallel_data({
  name: "ResourceName", # required
  description: "Description",
  parallel_data_config: { # required
    s3_uri: "S3Uri",
    format: "TSV", # accepts TSV, CSV, TMX
  },
  encryption_key: {
    type: "KMS", # required, accepts KMS
    id: "EncryptionKeyID", # required
  },
  client_token: "ClientTokenString", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.name #=> String
resp.status #=> String, one of "CREATING", "UPDATING", "ACTIVE", "DELETING", "FAILED"

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    A custom name for the parallel data resource in Amazon Translate. You must assign a name that is unique in the account and region.

  • :description (String) —

    A custom description for the parallel data resource in Amazon Translate.

  • :parallel_data_config (required, Types::ParallelDataConfig) —

    Specifies the format and S3 location of the parallel data input file.

  • :encryption_key (Types::EncryptionKey) —

    The encryption key used to encrypt this object.

  • :client_token (required, String) —

    A unique identifier for the request. This token is automatically generated when you use Amazon Translate through an AWS SDK.

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

  • :tags (Array<Types::Tag>) —

    Tags to be associated with this resource. A tag is a key-value pair that adds metadata to a resource. Each tag key for the resource must be unique. For more information, see Tagging your resources.

Returns:

See Also:



558
559
560
561
 
# File 'gems/aws-sdk-translate/lib/aws-sdk-translate/client.rb', line 558

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

#delete_parallel_data(params = {}) ⇒ Types::DeleteParallelDataResponse

Deletes a parallel data resource in Amazon Translate.

Examples:

Request syntax with placeholder values


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

Response structure


resp.name #=> String
resp.status #=> String, one of "CREATING", "UPDATING", "ACTIVE", "DELETING", "FAILED"

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the parallel data resource that is being deleted.

Returns:

See Also:



588
589
590
591
 
# File 'gems/aws-sdk-translate/lib/aws-sdk-translate/client.rb', line 588

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

#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:



610
611
612
613
 
# File 'gems/aws-sdk-translate/lib/aws-sdk-translate/client.rb', line 610

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 asynchronous 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.parallel_data_names #=> Array
resp.text_translation_job_properties.parallel_data_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.output_data_config.encryption_key.type #=> String, one of "KMS"
resp.text_translation_job_properties.output_data_config.encryption_key.id #=> String
resp.text_translation_job_properties.data_access_role_arn #=> String
resp.text_translation_job_properties.settings.formality #=> String, one of "FORMAL", "INFORMAL"
resp.text_translation_job_properties.settings.profanity #=> String, one of "MASK"
resp.text_translation_job_properties.settings.brevity #=> String, one of "ON"

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:



666
667
668
669
 
# File 'gems/aws-sdk-translate/lib/aws-sdk-translate/client.rb', line 666

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

#get_parallel_data(params = {}) ⇒ Types::GetParallelDataResponse

Provides information about a parallel data resource.

Examples:

Request syntax with placeholder values


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

Response structure


resp.parallel_data_properties.name #=> String
resp.parallel_data_properties.arn #=> String
resp.parallel_data_properties.description #=> String
resp.parallel_data_properties.status #=> String, one of "CREATING", "UPDATING", "ACTIVE", "DELETING", "FAILED"
resp.parallel_data_properties.source_language_code #=> String
resp.parallel_data_properties.target_language_codes #=> Array
resp.parallel_data_properties.target_language_codes[0] #=> String
resp.parallel_data_properties.parallel_data_config.s3_uri #=> String
resp.parallel_data_properties.parallel_data_config.format #=> String, one of "TSV", "CSV", "TMX"
resp.parallel_data_properties.message #=> String
resp.parallel_data_properties.imported_data_size #=> Integer
resp.parallel_data_properties.imported_record_count #=> Integer
resp.parallel_data_properties.failed_record_count #=> Integer
resp.parallel_data_properties.skipped_record_count #=> Integer
resp.parallel_data_properties.encryption_key.type #=> String, one of "KMS"
resp.parallel_data_properties.encryption_key.id #=> String
resp.parallel_data_properties.created_at #=> Time
resp.parallel_data_properties.last_updated_at #=> Time
resp.parallel_data_properties.latest_update_attempt_status #=> String, one of "CREATING", "UPDATING", "ACTIVE", "DELETING", "FAILED"
resp.parallel_data_properties.latest_update_attempt_at #=> Time
resp.data_location.repository_type #=> String
resp.data_location.location #=> String
resp.auxiliary_data_location.repository_type #=> String
resp.auxiliary_data_location.location #=> String
resp.latest_update_attempt_auxiliary_data_location.repository_type #=> String
resp.latest_update_attempt_auxiliary_data_location.location #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the parallel data resource that is being retrieved.

Returns:

See Also:



722
723
724
725
 
# File 'gems/aws-sdk-translate/lib/aws-sdk-translate/client.rb', line 722

def get_parallel_data(params = {}, options = {})
  req = build_request(:get_parallel_data, 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", # accepts CSV, TMX, TSV
})

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_properties.directionality #=> String, one of "UNI", "MULTI"
resp.terminology_properties.message #=> String
resp.terminology_properties.skipped_term_count #=> Integer
resp.terminology_properties.format #=> String, one of "CSV", "TMX", "TSV"
resp.terminology_data_location.repository_type #=> String
resp.terminology_data_location.location #=> String
resp.auxiliary_data_location.repository_type #=> String
resp.auxiliary_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 (String) —

    The data format of the custom terminology being retrieved.

    If you don't specify this parameter, Amazon Translate returns a file with the same format as the file that was imported to create the terminology.

    If you specify this parameter when you retrieve a multi-directional terminology resource, you must specify the same format as the input file that was imported to create it. Otherwise, Amazon Translate throws an error.

Returns:

See Also:



784
785
786
787
 
# File 'gems/aws-sdk-translate/lib/aws-sdk-translate/client.rb', line 784

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 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. The only supported merge strategy is OVERWRITE, where the imported terminology overwrites the existing terminology of the same name.

If you import a terminology that overwrites an existing one, the new terminology takes up to 10 minutes to fully propagate. After that, translations have access to the new terminology.

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, TSV
    directionality: "UNI", # accepts UNI, MULTI
  },
  encryption_key: {
    type: "KMS", # required, accepts KMS
    id: "EncryptionKeyID", # required
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # 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
resp.terminology_properties.directionality #=> String, one of "UNI", "MULTI"
resp.terminology_properties.message #=> String
resp.terminology_properties.skipped_term_count #=> Integer
resp.terminology_properties.format #=> String, one of "CSV", "TMX", "TSV"
resp.auxiliary_data_location.repository_type #=> String
resp.auxiliary_data_location.location #=> String

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.

  • :tags (Array<Types::Tag>) —

    Tags to be associated with this resource. A tag is a key-value pair that adds metadata to a resource. Each tag key for the resource must be unique. For more information, see Tagging your resources.

Returns:

See Also:



880
881
882
883
 
# File 'gems/aws-sdk-translate/lib/aws-sdk-translate/client.rb', line 880

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

#list_languages(params = {}) ⇒ Types::ListLanguagesResponse

Provides a list of languages (RFC-5646 codes and names) that Amazon Translate supports.

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_languages({
  display_language_code: "de", # accepts de, en, es, fr, it, ja, ko, pt, zh, zh-TW
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.languages #=> Array
resp.languages[0].language_name #=> String
resp.languages[0].language_code #=> String
resp.display_language_code #=> String, one of "de", "en", "es", "fr", "it", "ja", "ko", "pt", "zh", "zh-TW"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :display_language_code (String) —

    The language code for the language to use to display the language names in the response. The language code is en by default.

  • :next_token (String) —

    Include the NextToken value to fetch the next group of supported languages.

  • :max_results (Integer) —

    The maximum number of results to return in each response.

Returns:

See Also:



927
928
929
930
 
# File 'gems/aws-sdk-translate/lib/aws-sdk-translate/client.rb', line 927

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.parallel_data_properties_list #=> Array
resp.parallel_data_properties_list[0].name #=> String
resp.parallel_data_properties_list[0].arn #=> String
resp.parallel_data_properties_list[0].description #=> String
resp.parallel_data_properties_list[0].status #=> String, one of "CREATING", "UPDATING", "ACTIVE", "DELETING", "FAILED"
resp.parallel_data_properties_list[0].source_language_code #=> String
resp.parallel_data_properties_list[0].target_language_codes #=> Array
resp.parallel_data_properties_list[0].target_language_codes[0] #=> String
resp.parallel_data_properties_list[0].parallel_data_config.s3_uri #=> String
resp.parallel_data_properties_list[0].parallel_data_config.format #=> String, one of "TSV", "CSV", "TMX"
resp.parallel_data_properties_list[0].message #=> String
resp.parallel_data_properties_list[0].imported_data_size #=> Integer
resp.parallel_data_properties_list[0].imported_record_count #=> Integer
resp.parallel_data_properties_list[0].failed_record_count #=> Integer
resp.parallel_data_properties_list[0].skipped_record_count #=> Integer
resp.parallel_data_properties_list[0].encryption_key.type #=> String, one of "KMS"
resp.parallel_data_properties_list[0].encryption_key.id #=> String
resp.parallel_data_properties_list[0].created_at #=> Time
resp.parallel_data_properties_list[0].last_updated_at #=> Time
resp.parallel_data_properties_list[0].latest_update_attempt_status #=> String, one of "CREATING", "UPDATING", "ACTIVE", "DELETING", "FAILED"
resp.parallel_data_properties_list[0].latest_update_attempt_at #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    A string that specifies the next page of results to return in a paginated response.

  • :max_results (Integer) —

    The maximum number of parallel data resources returned for each request.

Returns:

See Also:



985
986
987
988
 
# File 'gems/aws-sdk-translate/lib/aws-sdk-translate/client.rb', line 985

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

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Lists all tags associated with a given Amazon Translate resource. For more information, see Tagging your resources.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "ResourceArn", # required
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the given Amazon Translate resource you are querying.

Returns:

See Also:



1021
1022
1023
1024
 
# File 'gems/aws-sdk-translate/lib/aws-sdk-translate/client.rb', line 1021

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, 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.terminology_properties_list[0].directionality #=> String, one of "UNI", "MULTI"
resp.terminology_properties_list[0].message #=> String
resp.terminology_properties_list[0].skipped_term_count #=> Integer
resp.terminology_properties_list[0].format #=> String, one of "CSV", "TMX", "TSV"
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:



1074
1075
1076
1077
 
# File 'gems/aws-sdk-translate/lib/aws-sdk-translate/client.rb', line 1074

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].parallel_data_names #=> Array
resp.text_translation_job_properties_list[0].parallel_data_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].output_data_config.encryption_key.type #=> String, one of "KMS"
resp.text_translation_job_properties_list[0].output_data_config.encryption_key.id #=> String
resp.text_translation_job_properties_list[0].data_access_role_arn #=> String
resp.text_translation_job_properties_list[0].settings.formality #=> String, one of "FORMAL", "INFORMAL"
resp.text_translation_job_properties_list[0].settings.profanity #=> String, one of "MASK"
resp.text_translation_job_properties_list[0].settings.brevity #=> String, one of "ON"
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:



1147
1148
1149
1150
 
# File 'gems/aws-sdk-translate/lib/aws-sdk-translate/client.rb', line 1147

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. Use batch translation jobs to translate large volumes of text across multiple documents at once. For batch translation, you can input documents with different source languages (specify auto as the source language). You can specify one or more target languages. Batch translation translates each input document into each of the target languages. For more information, see Asynchronous batch processing.

Batch translation jobs can be described with the DescribeTextTranslationJob operation, listed with the ListTextTranslationJobs operation, and stopped with the StopTextTranslationJob operation.

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
    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
  settings: {
    formality: "FORMAL", # accepts FORMAL, INFORMAL
    profanity: "MASK", # accepts MASK
    brevity: "ON", # accepts ON
  },
})

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 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 information, see Identity and access management .

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

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

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

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

    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.

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

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

See Also:



1321
1322
1323
1324
 
# File 'gems/aws-sdk-translate/lib/aws-sdk-translate/client.rb', line 1321

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:



1361
1362
1363
1364
 
# File 'gems/aws-sdk-translate/lib/aws-sdk-translate/client.rb', line 1361

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

#tag_resource(params = {}) ⇒ Struct

Associates a specific tag with a resource. A tag is a key-value pair that adds as a metadata to a resource. For more information, see Tagging your resources.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "ResourceArn", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the given Amazon Translate resource to which you want to associate the tags.

  • :tags (required, Array<Types::Tag>) —

    Tags being associated with a specific Amazon Translate resource. There can be a maximum of 50 tags (both existing and pending) associated with a specific resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1401
1402
1403
1404
 
# File 'gems/aws-sdk-translate/lib/aws-sdk-translate/client.rb', line 1401

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

#translate_document(params = {}) ⇒ Types::TranslateDocumentResponse

Translates the input document from the source language to the target language. This synchronous operation supports text, HTML, or Word documents as the input document. TranslateDocument supports translations from English to any supported language, and from any supported language to English. Therefore, specify either the source language code or the target language code as “en” (English).

If you set the Formality parameter, the request will fail if the target language does not support formality. For a list of target languages that support formality, see Setting formality.

Examples:

Request syntax with placeholder values


resp = client.translate_document({
  document: { # required
    content: "data", # required
    content_type: "ContentType", # required
  },
  terminology_names: ["ResourceName"],
  source_language_code: "LanguageCodeString", # required
  target_language_code: "LanguageCodeString", # required
  settings: {
    formality: "FORMAL", # accepts FORMAL, INFORMAL
    profanity: "MASK", # accepts MASK
    brevity: "ON", # accepts ON
  },
})

Response structure


resp.translated_document.content #=> 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
resp.applied_settings.formality #=> String, one of "FORMAL", "INFORMAL"
resp.applied_settings.profanity #=> String, one of "MASK"
resp.applied_settings.brevity #=> String, one of "ON"

Parameters:

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

    ({})

Options Hash (params):

  • :document (required, Types::Document) —

    The content and content type for the document to be translated. The document size must not exceed 100 KB.

  • :terminology_names (Array<String>) —

    The name of a terminology list file to add to the translation job. This file provides source terms and the desired translation for each term. A terminology list can contain a maximum of 256 terms. You can use one custom terminology resource in your translation request.

    Use the ListTerminologies operation to get the available terminology lists.

    For more information about custom terminology lists, see Custom terminology.

  • :source_language_code (required, String) —

    The language code for the language of the source text. For a list of supported language codes, see Supported 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.

    If you specify auto, you must send the TranslateDocument request in a region that supports Amazon Comprehend. Otherwise, the request returns an error indicating that autodetect is not supported.

  • :target_language_code (required, String) —

    The language code requested for the translated document. For a list of supported language codes, see Supported languages.

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

See Also:



1523
1524
1525
1526
 
# File 'gems/aws-sdk-translate/lib/aws-sdk-translate/client.rb', line 1523

def translate_document(params = {}, options = {})
  req = build_request(:translate_document, 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 Supported 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
  settings: {
    formality: "FORMAL", # accepts FORMAL, INFORMAL
    profanity: "MASK", # accepts MASK
    brevity: "ON", # accepts ON
  },
})

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
resp.applied_settings.formality #=> String, one of "FORMAL", "INFORMAL"
resp.applied_settings.profanity #=> String, one of "MASK"
resp.applied_settings.brevity #=> String, one of "ON"

Parameters:

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

    ({})

Options Hash (params):

  • :text (required, String) —

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

  • :terminology_names (Array<String>) —

    The name of a terminology list file to add to the translation job. This file provides source terms and the desired translation for each term. A terminology list can contain a maximum of 256 terms. You can use one custom terminology resource in your translation request.

    Use the ListTerminologies operation to get the available terminology lists.

    For more information about custom terminology lists, see Custom terminology.

  • :source_language_code (required, String) —

    The language code for the language of the source text. For a list of language codes, see Supported 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.

    If you specify auto, you must send the TranslateText request in a region that supports Amazon Comprehend. Otherwise, the request returns an error indicating that autodetect is not supported.

  • :target_language_code (required, String) —

    The language code requested for the language of the target text. For a list of language codes, see Supported languages.

  • :settings (Types::TranslationSettings) —

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

    • Brevity: reduces the length of the translated output for most translations.

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

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

Returns:

See Also:



1637
1638
1639
1640
 
# File 'gems/aws-sdk-translate/lib/aws-sdk-translate/client.rb', line 1637

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

#untag_resource(params = {}) ⇒ Struct

Removes a specific tag associated with an Amazon Translate resource. For more information, see Tagging your resources.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "ResourceArn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the given Amazon Translate resource from which you want to remove the tags.

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

    The initial part of a key-value pair that forms a tag being removed from a given resource. Keys must be unique and cannot be duplicated for a particular resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1671
1672
1673
1674
 
# File 'gems/aws-sdk-translate/lib/aws-sdk-translate/client.rb', line 1671

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

#update_parallel_data(params = {}) ⇒ Types::UpdateParallelDataResponse

Updates a previously created parallel data resource by importing a new input file from Amazon S3.

Examples:

Request syntax with placeholder values


resp = client.update_parallel_data({
  name: "ResourceName", # required
  description: "Description",
  parallel_data_config: { # required
    s3_uri: "S3Uri",
    format: "TSV", # accepts TSV, CSV, TMX
  },
  client_token: "ClientTokenString", # required
})

Response structure


resp.name #=> String
resp.status #=> String, one of "CREATING", "UPDATING", "ACTIVE", "DELETING", "FAILED"
resp.latest_update_attempt_status #=> String, one of "CREATING", "UPDATING", "ACTIVE", "DELETING", "FAILED"
resp.latest_update_attempt_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the parallel data resource being updated.

  • :description (String) —

    A custom description for the parallel data resource in Amazon Translate.

  • :parallel_data_config (required, Types::ParallelDataConfig) —

    Specifies the format and S3 location of the parallel data input file.

  • :client_token (required, String) —

    A unique identifier for the request. This token is automatically generated when you use Amazon Translate through an AWS SDK.

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

Returns:

See Also:



1726
1727
1728
1729
 
# File 'gems/aws-sdk-translate/lib/aws-sdk-translate/client.rb', line 1726

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