You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::TranscribeService::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb

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::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

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

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

    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 IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails 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 search 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.

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

  • :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 endpoints. This should be avalid 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. Defaults to false.

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

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

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

  • :retry_base_delay (Float) — default: 0.3

    The base delay in seconds used by the default backoff function.

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

    @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 and auth errors from expired credentials.

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

  • :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 rasing 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 yeidled by #session_for.

  • :http_idle_timeout (Float) — default: 5

    The number of seconds a connection is allowed to sit idble 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 yeidled by #session_for.

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



261
262
263
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 261

def initialize(*args)
  super
end

Instance Method Details

#create_vocabulary(params = {}) ⇒ Types::CreateVocabularyResponse

Creates a new custom vocabulary that you can use to change the way Amazon Transcribe handles transcription of an audio file.

Examples:

Request syntax with placeholder values


resp = client.create_vocabulary({
  vocabulary_name: "VocabularyName", # required
  language_code: "en-US", # required, accepts en-US, es-US, en-AU, fr-CA, en-GB, de-DE, pt-BR, fr-FR, it-IT, ko-KR, es-ES, en-IN, hi-IN, ar-SA, ru-RU, zh-CN, nl-NL, id-ID, ta-IN, fa-IR, en-IE, en-AB, en-WL, pt-PT, te-IN, tr-TR, de-CH, he-IL, ms-MY, ja-JP, ar-AE
  phrases: ["Phrase"],
  vocabulary_file_uri: "Uri",
})

Response structure


resp.vocabulary_name #=> String
resp.language_code #=> String, one of "en-US", "es-US", "en-AU", "fr-CA", "en-GB", "de-DE", "pt-BR", "fr-FR", "it-IT", "ko-KR", "es-ES", "en-IN", "hi-IN", "ar-SA", "ru-RU", "zh-CN", "nl-NL", "id-ID", "ta-IN", "fa-IR", "en-IE", "en-AB", "en-WL", "pt-PT", "te-IN", "tr-TR", "de-CH", "he-IL", "ms-MY", "ja-JP", "ar-AE"
resp.vocabulary_state #=> String, one of "PENDING", "READY", "FAILED"
resp.last_modified_time #=> Time
resp.failure_reason #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :vocabulary_name (required, String)

    The name of the vocabulary. The name must be unique within an AWS account. The name is case-sensitive.

  • :language_code (required, String)

    The language code of the vocabulary entries.

  • :phrases (Array<String>)

    An array of strings that contains the vocabulary entries.

  • :vocabulary_file_uri (String)

    The S3 location of the text file that contains the definition of the custom vocabulary. The URI must be in the same region as the API endpoint that you are calling. The general form is

    https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>

    For example:

    https://s3.us-east-1.amazonaws.com/examplebucket/vocab.txt

    For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.

    For more information about custom vocabularies, see Custom Vocabularies.

Returns:

See Also:



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

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

#create_vocabulary_filter(params = {}) ⇒ Types::CreateVocabularyFilterResponse

Creates a new vocabulary filter that you can use to filter words, such as profane words, from the output of a transcription job.

Examples:

Request syntax with placeholder values


resp = client.create_vocabulary_filter({
  vocabulary_filter_name: "VocabularyFilterName", # required
  language_code: "en-US", # required, accepts en-US, es-US, en-AU, fr-CA, en-GB, de-DE, pt-BR, fr-FR, it-IT, ko-KR, es-ES, en-IN, hi-IN, ar-SA, ru-RU, zh-CN, nl-NL, id-ID, ta-IN, fa-IR, en-IE, en-AB, en-WL, pt-PT, te-IN, tr-TR, de-CH, he-IL, ms-MY, ja-JP, ar-AE
  words: ["Word"],
  vocabulary_filter_file_uri: "Uri",
})

Response structure


resp.vocabulary_filter_name #=> String
resp.language_code #=> String, one of "en-US", "es-US", "en-AU", "fr-CA", "en-GB", "de-DE", "pt-BR", "fr-FR", "it-IT", "ko-KR", "es-ES", "en-IN", "hi-IN", "ar-SA", "ru-RU", "zh-CN", "nl-NL", "id-ID", "ta-IN", "fa-IR", "en-IE", "en-AB", "en-WL", "pt-PT", "te-IN", "tr-TR", "de-CH", "he-IL", "ms-MY", "ja-JP", "ar-AE"
resp.last_modified_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :vocabulary_filter_name (required, String)

    The vocabulary filter name. The name must be unique within the account that contains it.

  • :language_code (required, String)

    The language code of the words in the vocabulary filter. All words in the filter must be in the same language. The vocabulary filter can only be used with transcription jobs in the specified language.

  • :words (Array<String>)

    The words to use in the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies.

    If you provide a list of words in the Words parameter, you can't use the VocabularyFilterFileUri parameter.

  • :vocabulary_filter_file_uri (String)

    The Amazon S3 location of a text file used as input to create the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies.

    The specified file must be less than 50 KB of UTF-8 characters.

    If you provide the location of a list of words in the VocabularyFilterFileUri parameter, you can't use the Words parameter.

Returns:

See Also:



403
404
405
406
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 403

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

#delete_transcription_job(params = {}) ⇒ Struct

Deletes a previously submitted transcription job along with any other generated results such as the transcription, models, and so on.

Examples:

Request syntax with placeholder values


resp = client.delete_transcription_job({
  transcription_job_name: "TranscriptionJobName", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :transcription_job_name (required, String)

    The name of the transcription job to be deleted.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



426
427
428
429
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 426

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

#delete_vocabulary(params = {}) ⇒ Struct

Deletes a vocabulary from Amazon Transcribe.

Examples:

Request syntax with placeholder values


resp = client.delete_vocabulary({
  vocabulary_name: "VocabularyName", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :vocabulary_name (required, String)

    The name of the vocabulary to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



448
449
450
451
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 448

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

#delete_vocabulary_filter(params = {}) ⇒ Struct

Removes a vocabulary filter.

Examples:

Request syntax with placeholder values


resp = client.delete_vocabulary_filter({
  vocabulary_filter_name: "VocabularyFilterName", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :vocabulary_filter_name (required, String)

    The name of the vocabulary filter to remove.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



470
471
472
473
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 470

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

#get_transcription_job(params = {}) ⇒ Types::GetTranscriptionJobResponse

Returns information about a transcription job. To see the status of the job, check the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished and you can find the results at the location specified in the TranscriptionFileUri field.

Examples:

Request syntax with placeholder values


resp = client.get_transcription_job({
  transcription_job_name: "TranscriptionJobName", # required
})

Response structure


resp.transcription_job.transcription_job_name #=> String
resp.transcription_job.transcription_job_status #=> String, one of "QUEUED", "IN_PROGRESS", "FAILED", "COMPLETED"
resp.transcription_job.language_code #=> String, one of "en-US", "es-US", "en-AU", "fr-CA", "en-GB", "de-DE", "pt-BR", "fr-FR", "it-IT", "ko-KR", "es-ES", "en-IN", "hi-IN", "ar-SA", "ru-RU", "zh-CN", "nl-NL", "id-ID", "ta-IN", "fa-IR", "en-IE", "en-AB", "en-WL", "pt-PT", "te-IN", "tr-TR", "de-CH", "he-IL", "ms-MY", "ja-JP", "ar-AE"
resp.transcription_job.media_sample_rate_hertz #=> Integer
resp.transcription_job.media_format #=> String, one of "mp3", "mp4", "wav", "flac"
resp.transcription_job.media.media_file_uri #=> String
resp.transcription_job.transcript.transcript_file_uri #=> String
resp.transcription_job.start_time #=> Time
resp.transcription_job.creation_time #=> Time
resp.transcription_job.completion_time #=> Time
resp.transcription_job.failure_reason #=> String
resp.transcription_job.settings.vocabulary_name #=> String
resp.transcription_job.settings.show_speaker_labels #=> Boolean
resp.transcription_job.settings.max_speaker_labels #=> Integer
resp.transcription_job.settings.channel_identification #=> Boolean
resp.transcription_job.settings.show_alternatives #=> Boolean
resp.transcription_job.settings.max_alternatives #=> Integer
resp.transcription_job.settings.vocabulary_filter_name #=> String
resp.transcription_job.settings.vocabulary_filter_method #=> String, one of "remove", "mask"
resp.transcription_job.job_execution_settings.allow_deferred_execution #=> Boolean
resp.transcription_job.job_execution_settings.data_access_role_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :transcription_job_name (required, String)

    The name of the job.

Returns:

See Also:



521
522
523
524
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 521

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

#get_vocabulary(params = {}) ⇒ Types::GetVocabularyResponse

Gets information about a vocabulary.

Examples:

Request syntax with placeholder values


resp = client.get_vocabulary({
  vocabulary_name: "VocabularyName", # required
})

Response structure


resp.vocabulary_name #=> String
resp.language_code #=> String, one of "en-US", "es-US", "en-AU", "fr-CA", "en-GB", "de-DE", "pt-BR", "fr-FR", "it-IT", "ko-KR", "es-ES", "en-IN", "hi-IN", "ar-SA", "ru-RU", "zh-CN", "nl-NL", "id-ID", "ta-IN", "fa-IR", "en-IE", "en-AB", "en-WL", "pt-PT", "te-IN", "tr-TR", "de-CH", "he-IL", "ms-MY", "ja-JP", "ar-AE"
resp.vocabulary_state #=> String, one of "PENDING", "READY", "FAILED"
resp.last_modified_time #=> Time
resp.failure_reason #=> String
resp.download_uri #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :vocabulary_name (required, String)

    The name of the vocabulary to return information about. The name is case-sensitive.

Returns:

See Also:



560
561
562
563
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 560

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

#get_vocabulary_filter(params = {}) ⇒ Types::GetVocabularyFilterResponse

Returns information about a vocabulary filter.

Examples:

Request syntax with placeholder values


resp = client.get_vocabulary_filter({
  vocabulary_filter_name: "VocabularyFilterName", # required
})

Response structure


resp.vocabulary_filter_name #=> String
resp.language_code #=> String, one of "en-US", "es-US", "en-AU", "fr-CA", "en-GB", "de-DE", "pt-BR", "fr-FR", "it-IT", "ko-KR", "es-ES", "en-IN", "hi-IN", "ar-SA", "ru-RU", "zh-CN", "nl-NL", "id-ID", "ta-IN", "fa-IR", "en-IE", "en-AB", "en-WL", "pt-PT", "te-IN", "tr-TR", "de-CH", "he-IL", "ms-MY", "ja-JP", "ar-AE"
resp.last_modified_time #=> Time
resp.download_uri #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :vocabulary_filter_name (required, String)

    The name of the vocabulary filter for which to return information.

Returns:

See Also:



594
595
596
597
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 594

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

#list_transcription_jobs(params = {}) ⇒ Types::ListTranscriptionJobsResponse

Lists transcription jobs with the specified status.

Examples:

Request syntax with placeholder values


resp = client.list_transcription_jobs({
  status: "QUEUED", # accepts QUEUED, IN_PROGRESS, FAILED, COMPLETED
  job_name_contains: "TranscriptionJobName",
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.status #=> String, one of "QUEUED", "IN_PROGRESS", "FAILED", "COMPLETED"
resp.next_token #=> String
resp.transcription_job_summaries #=> Array
resp.transcription_job_summaries[0].transcription_job_name #=> String
resp.transcription_job_summaries[0].creation_time #=> Time
resp.transcription_job_summaries[0].start_time #=> Time
resp.transcription_job_summaries[0].completion_time #=> Time
resp.transcription_job_summaries[0].language_code #=> String, one of "en-US", "es-US", "en-AU", "fr-CA", "en-GB", "de-DE", "pt-BR", "fr-FR", "it-IT", "ko-KR", "es-ES", "en-IN", "hi-IN", "ar-SA", "ru-RU", "zh-CN", "nl-NL", "id-ID", "ta-IN", "fa-IR", "en-IE", "en-AB", "en-WL", "pt-PT", "te-IN", "tr-TR", "de-CH", "he-IL", "ms-MY", "ja-JP", "ar-AE"
resp.transcription_job_summaries[0].transcription_job_status #=> String, one of "QUEUED", "IN_PROGRESS", "FAILED", "COMPLETED"
resp.transcription_job_summaries[0].failure_reason #=> String
resp.transcription_job_summaries[0].output_location_type #=> String, one of "CUSTOMER_BUCKET", "SERVICE_BUCKET"

Parameters:

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

    ({})

Options Hash (params):

  • :status (String)

    When specified, returns only transcription jobs with the specified status. Jobs are ordered by creation date, with the newest jobs returned first. If you don’t specify a status, Amazon Transcribe returns all transcription jobs ordered by creation date.

  • :job_name_contains (String)

    When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.

  • :next_token (String)

    If the result of the previous request to ListTranscriptionJobs was truncated, include the NextToken to fetch the next set of jobs.

  • :max_results (Integer)

    The maximum number of jobs to return in the response. If there are fewer results in the list, this response contains only the actual results.

Returns:

See Also:



653
654
655
656
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 653

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

#list_vocabularies(params = {}) ⇒ Types::ListVocabulariesResponse

Returns a list of vocabularies that match the specified criteria. If no criteria are specified, returns the entire list of vocabularies.

Examples:

Request syntax with placeholder values


resp = client.list_vocabularies({
  next_token: "NextToken",
  max_results: 1,
  state_equals: "PENDING", # accepts PENDING, READY, FAILED
  name_contains: "VocabularyName",
})

Response structure


resp.status #=> String, one of "QUEUED", "IN_PROGRESS", "FAILED", "COMPLETED"
resp.next_token #=> String
resp.vocabularies #=> Array
resp.vocabularies[0].vocabulary_name #=> String
resp.vocabularies[0].language_code #=> String, one of "en-US", "es-US", "en-AU", "fr-CA", "en-GB", "de-DE", "pt-BR", "fr-FR", "it-IT", "ko-KR", "es-ES", "en-IN", "hi-IN", "ar-SA", "ru-RU", "zh-CN", "nl-NL", "id-ID", "ta-IN", "fa-IR", "en-IE", "en-AB", "en-WL", "pt-PT", "te-IN", "tr-TR", "de-CH", "he-IL", "ms-MY", "ja-JP", "ar-AE"
resp.vocabularies[0].last_modified_time #=> Time
resp.vocabularies[0].vocabulary_state #=> String, one of "PENDING", "READY", "FAILED"

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String)

    If the result of the previous request to ListVocabularies was truncated, include the NextToken to fetch the next set of jobs.

  • :max_results (Integer)

    The maximum number of vocabularies to return in the response. If there are fewer results in the list, this response contains only the actual results.

  • :state_equals (String)

    When specified, only returns vocabularies with the VocabularyState field equal to the specified state.

  • :name_contains (String)

    When specified, the vocabularies returned in the list are limited to vocabularies whose name contains the specified string. The search is case-insensitive, ListVocabularies will return both "vocabularyname" and "VocabularyName" in the response list.

Returns:

See Also:



709
710
711
712
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 709

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

#list_vocabulary_filters(params = {}) ⇒ Types::ListVocabularyFiltersResponse

Gets information about vocabulary filters.

Examples:

Request syntax with placeholder values


resp = client.list_vocabulary_filters({
  next_token: "NextToken",
  max_results: 1,
  name_contains: "VocabularyFilterName",
})

Response structure


resp.next_token #=> String
resp.vocabulary_filters #=> Array
resp.vocabulary_filters[0].vocabulary_filter_name #=> String
resp.vocabulary_filters[0].language_code #=> String, one of "en-US", "es-US", "en-AU", "fr-CA", "en-GB", "de-DE", "pt-BR", "fr-FR", "it-IT", "ko-KR", "es-ES", "en-IN", "hi-IN", "ar-SA", "ru-RU", "zh-CN", "nl-NL", "id-ID", "ta-IN", "fa-IR", "en-IE", "en-AB", "en-WL", "pt-PT", "te-IN", "tr-TR", "de-CH", "he-IL", "ms-MY", "ja-JP", "ar-AE"
resp.vocabulary_filters[0].last_modified_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String)

    If the result of the previous request to ListVocabularyFilters was truncated, include the NextToken to fetch the next set of collections.

  • :max_results (Integer)

    The maximum number of filters to return in the response. If there are fewer results in the list, this response contains only the actual results.

  • :name_contains (String)

    Filters the response so that it only contains vocabulary filters whose name contains the specified string.

Returns:

See Also:



755
756
757
758
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 755

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

#start_transcription_job(params = {}) ⇒ Types::StartTranscriptionJobResponse

Starts an asynchronous job to transcribe speech to text.

Examples:

Request syntax with placeholder values


resp = client.start_transcription_job({
  transcription_job_name: "TranscriptionJobName", # required
  language_code: "en-US", # required, accepts en-US, es-US, en-AU, fr-CA, en-GB, de-DE, pt-BR, fr-FR, it-IT, ko-KR, es-ES, en-IN, hi-IN, ar-SA, ru-RU, zh-CN, nl-NL, id-ID, ta-IN, fa-IR, en-IE, en-AB, en-WL, pt-PT, te-IN, tr-TR, de-CH, he-IL, ms-MY, ja-JP, ar-AE
  media_sample_rate_hertz: 1,
  media_format: "mp3", # accepts mp3, mp4, wav, flac
  media: { # required
    media_file_uri: "Uri",
  },
  output_bucket_name: "OutputBucketName",
  output_encryption_kms_key_id: "KMSKeyId",
  settings: {
    vocabulary_name: "VocabularyName",
    show_speaker_labels: false,
    max_speaker_labels: 1,
    channel_identification: false,
    show_alternatives: false,
    max_alternatives: 1,
    vocabulary_filter_name: "VocabularyFilterName",
    vocabulary_filter_method: "remove", # accepts remove, mask
  },
  job_execution_settings: {
    allow_deferred_execution: false,
    data_access_role_arn: "DataAccessRoleArn",
  },
})

Response structure


resp.transcription_job.transcription_job_name #=> String
resp.transcription_job.transcription_job_status #=> String, one of "QUEUED", "IN_PROGRESS", "FAILED", "COMPLETED"
resp.transcription_job.language_code #=> String, one of "en-US", "es-US", "en-AU", "fr-CA", "en-GB", "de-DE", "pt-BR", "fr-FR", "it-IT", "ko-KR", "es-ES", "en-IN", "hi-IN", "ar-SA", "ru-RU", "zh-CN", "nl-NL", "id-ID", "ta-IN", "fa-IR", "en-IE", "en-AB", "en-WL", "pt-PT", "te-IN", "tr-TR", "de-CH", "he-IL", "ms-MY", "ja-JP", "ar-AE"
resp.transcription_job.media_sample_rate_hertz #=> Integer
resp.transcription_job.media_format #=> String, one of "mp3", "mp4", "wav", "flac"
resp.transcription_job.media.media_file_uri #=> String
resp.transcription_job.transcript.transcript_file_uri #=> String
resp.transcription_job.start_time #=> Time
resp.transcription_job.creation_time #=> Time
resp.transcription_job.completion_time #=> Time
resp.transcription_job.failure_reason #=> String
resp.transcription_job.settings.vocabulary_name #=> String
resp.transcription_job.settings.show_speaker_labels #=> Boolean
resp.transcription_job.settings.max_speaker_labels #=> Integer
resp.transcription_job.settings.channel_identification #=> Boolean
resp.transcription_job.settings.show_alternatives #=> Boolean
resp.transcription_job.settings.max_alternatives #=> Integer
resp.transcription_job.settings.vocabulary_filter_name #=> String
resp.transcription_job.settings.vocabulary_filter_method #=> String, one of "remove", "mask"
resp.transcription_job.job_execution_settings.allow_deferred_execution #=> Boolean
resp.transcription_job.job_execution_settings.data_access_role_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :transcription_job_name (required, String)

    The name of the job. Note that you can't use the strings "." or ".." by themselves as the job name. The name must also be unique within an AWS account.

  • :language_code (required, String)

    The language code for the language used in the input media file.

  • :media_sample_rate_hertz (Integer)

    The sample rate, in Hertz, of the audio track in the input media file.

    If you do not specify the media sample rate, Amazon Transcribe determines the sample rate. If you specify the sample rate, it must match the sample rate detected by Amazon Transcribe. In most cases, you should leave the MediaSampleRateHertz field blank and let Amazon Transcribe determine the sample rate.

  • :media_format (String)

    The format of the input media file.

  • :media (required, Types::Media)

    An object that describes the input media for a transcription job.

  • :output_bucket_name (String)

    The location where the transcription is stored.

    If you set the OutputBucketName, Amazon Transcribe puts the transcription in the specified S3 bucket. When you call the GetTranscriptionJob operation, the operation returns this location in the TranscriptFileUri field. The S3 bucket must have permissions that allow Amazon Transcribe to put files in the bucket. For more information, see Permissions Required for IAM User Roles.

    You can specify an AWS Key Management Service (KMS) key to encrypt the output of your transcription using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.

    If you don't set the OutputBucketName, Amazon Transcribe generates a pre-signed URL, a shareable URL that provides secure access to your transcription, and returns it in the TranscriptFileUri field. Use this URL to download the transcription.

  • :output_encryption_kms_key_id (String)

    The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the StartTranscriptionJob operation must have permission to use the specified KMS key.

    You can use either of the following to identify a KMS key in the current account:

    • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

    • KMS Key Alias: "alias/ExampleAlias"

    You can use either of the following to identify a KMS key in the current account or another account:

    • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"

    • ARN of a KMS Key Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"

    If you don't specify an encryption key, the output of the transcription job is encrypted with the default Amazon S3 key (SSE-S3).

    If you specify a KMS key to encrypt your output, you must also specify an output location in the OutputBucketName parameter.

  • :settings (Types::Settings)

    A Settings object that provides optional settings for a transcription job.

  • :job_execution_settings (Types::JobExecutionSettings)

    Provides information about how a transcription job is executed. Use this field to indicate that the job can be queued for deferred execution if the concurrency limit is reached and there are no slots available to immediately run the job.

Returns:

See Also:



910
911
912
913
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 910

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

#update_vocabulary(params = {}) ⇒ Types::UpdateVocabularyResponse

Updates an existing vocabulary with new values. The UpdateVocabulary operation overwrites all of the existing information with the values that you provide in the request.

Examples:

Request syntax with placeholder values


resp = client.update_vocabulary({
  vocabulary_name: "VocabularyName", # required
  language_code: "en-US", # required, accepts en-US, es-US, en-AU, fr-CA, en-GB, de-DE, pt-BR, fr-FR, it-IT, ko-KR, es-ES, en-IN, hi-IN, ar-SA, ru-RU, zh-CN, nl-NL, id-ID, ta-IN, fa-IR, en-IE, en-AB, en-WL, pt-PT, te-IN, tr-TR, de-CH, he-IL, ms-MY, ja-JP, ar-AE
  phrases: ["Phrase"],
  vocabulary_file_uri: "Uri",
})

Response structure


resp.vocabulary_name #=> String
resp.language_code #=> String, one of "en-US", "es-US", "en-AU", "fr-CA", "en-GB", "de-DE", "pt-BR", "fr-FR", "it-IT", "ko-KR", "es-ES", "en-IN", "hi-IN", "ar-SA", "ru-RU", "zh-CN", "nl-NL", "id-ID", "ta-IN", "fa-IR", "en-IE", "en-AB", "en-WL", "pt-PT", "te-IN", "tr-TR", "de-CH", "he-IL", "ms-MY", "ja-JP", "ar-AE"
resp.last_modified_time #=> Time
resp.vocabulary_state #=> String, one of "PENDING", "READY", "FAILED"

Parameters:

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

    ({})

Options Hash (params):

  • :vocabulary_name (required, String)

    The name of the vocabulary to update. The name is case-sensitive.

  • :language_code (required, String)

    The language code of the vocabulary entries.

  • :phrases (Array<String>)

    An array of strings containing the vocabulary entries.

  • :vocabulary_file_uri (String)

    The S3 location of the text file that contains the definition of the custom vocabulary. The URI must be in the same region as the API endpoint that you are calling. The general form is

    https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>

    For example:

    https://s3.us-east-1.amazonaws.com/examplebucket/vocab.txt

    For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.

    For more information about custom vocabularies, see Custom Vocabularies.

Returns:

See Also:



979
980
981
982
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 979

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

#update_vocabulary_filter(params = {}) ⇒ Types::UpdateVocabularyFilterResponse

Updates a vocabulary filter with a new list of filtered words.

Examples:

Request syntax with placeholder values


resp = client.update_vocabulary_filter({
  vocabulary_filter_name: "VocabularyFilterName", # required
  words: ["Word"],
  vocabulary_filter_file_uri: "Uri",
})

Response structure


resp.vocabulary_filter_name #=> String
resp.language_code #=> String, one of "en-US", "es-US", "en-AU", "fr-CA", "en-GB", "de-DE", "pt-BR", "fr-FR", "it-IT", "ko-KR", "es-ES", "en-IN", "hi-IN", "ar-SA", "ru-RU", "zh-CN", "nl-NL", "id-ID", "ta-IN", "fa-IR", "en-IE", "en-AB", "en-WL", "pt-PT", "te-IN", "tr-TR", "de-CH", "he-IL", "ms-MY", "ja-JP", "ar-AE"
resp.last_modified_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :vocabulary_filter_name (required, String)

    The name of the vocabulary filter to update.

  • :words (Array<String>)

    The words to use in the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies.

    If you provide a list of words in the Words parameter, you can't use the VocabularyFilterFileUri parameter.

  • :vocabulary_filter_file_uri (String)

    The Amazon S3 location of a text file used as input to create the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies.

    The specified file must be less than 50 KB of UTF-8 characters.

    If you provide the location of a list of words in the VocabularyFilterFileUri parameter, you can't use the Words parameter.

Returns:

See Also:



1041
1042
1043
1044
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1041

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