Class: Aws::TranscribeService::Client

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

Overview

An API client for TranscribeService. To construct a client, you need to configure a :region and :credentials.

client = Aws::TranscribeService::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider)

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

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

    • Aws::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 searched for in the following locations:

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

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

  • :adaptive_retry_wait_to_fill (Boolean) — default: true

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

  • :client_side_monitoring (Boolean) — default: false

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

  • :client_side_monitoring_client_id (String) — default: ""

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

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

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

  • :client_side_monitoring_port (Integer) — default: 31000

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

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

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

  • :convert_params (Boolean) — default: true

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

  • :correct_clock_skew (Boolean) — default: true

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

  • :disable_host_prefix_injection (Boolean) — default: false

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

  • :endpoint (String)

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

  • :endpoint_cache_max_entries (Integer) — default: 1000

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

  • :endpoint_cache_max_threads (Integer) — default: 10

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

  • :endpoint_cache_poll_interval (Integer) — default: 60

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

  • :endpoint_discovery (Boolean) — default: false

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

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

    The log formatter.

  • :log_level (Symbol) — default: :info

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

  • :logger (Logger)

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

  • :max_attempts (Integer) — default: 3

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

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

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

  • :retry_backoff (Proc)

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

  • :retry_base_delay (Float) — default: 0.3

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

  • :retry_jitter (Symbol) — default: :none

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

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

  • :retry_limit (Integer) — default: 3

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

  • :retry_max_delay (Integer) — default: 0

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

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

    Specifies which retry algorithm to use. Values are:

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

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

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

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

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

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

  • :stub_responses (Boolean) — default: false

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

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

  • :validate_params (Boolean) — default: true

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

  • :http_proxy (URI::HTTP, String)

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

  • :http_open_timeout (Float) — default: 15

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

  • :http_read_timeout (Integer) — default: 60

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

  • :http_idle_timeout (Float) — default: 5

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

  • :http_continue_timeout (Float) — default: 1

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

  • :http_wire_trace (Boolean) — default: false

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

  • :ssl_verify_peer (Boolean) — default: true

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

  • :ssl_ca_bundle (String)

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

  • :ssl_ca_directory (String)

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



315
316
317
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 315

def initialize(*args)
  super
end

Instance Method Details

#create_medical_vocabulary(params = {}) ⇒ Types::CreateMedicalVocabularyResponse

Creates a new custom vocabulary that you can use to change how Amazon Transcribe Medical transcribes your audio file.

Examples:

Request syntax with placeholder values


resp = client.create_medical_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
  vocabulary_file_uri: "Uri", # 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

Parameters:

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

    ({})

Options Hash (params):

  • :vocabulary_name (required, String)

    The name of the custom vocabulary. This case-sensitive name must be unique within an AWS account. If you try to create a vocabulary with the same name as a previous vocabulary you will receive a ConflictException error.

  • :language_code (required, String)

    The language code used for the entries within your custom vocabulary. The language code of your custom vocabulary must match the language code of your transcription job. US English (en-US) is the only language code available for Amazon Transcribe Medical.

  • :vocabulary_file_uri (required, String)

    The Amazon S3 location of the text file you use to define your custom vocabulary. The URI must be in the same AWS region as the API endpoint you're calling. Enter information about your VocabularyFileUri in the following format:

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

    This is an example of a vocabulary file uri location in Amazon S3:

    https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/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 Medical Custom Vocabularies.

Returns:

See Also:



389
390
391
392
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 389

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

#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. If you try to create a vocabulary with the same name as a previous vocabulary you will receive a ConflictException error.

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

    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:



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

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.If you try to create a vocabulary filter with the same name as a previous vocabulary filter you will receive a ConflictException error.

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



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

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

#delete_medical_transcription_job(params = {}) ⇒ Struct

Deletes a transcription job generated by Amazon Transcribe Medical and any related information.

Examples:

Request syntax with placeholder values


resp = client.delete_medical_transcription_job({
  medical_transcription_job_name: "TranscriptionJobName", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :medical_transcription_job_name (required, String)

    The name you provide to the DeleteMedicalTranscriptionJob object to delete a transcription job.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



550
551
552
553
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 550

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

#delete_medical_vocabulary(params = {}) ⇒ Struct

Deletes a vocabulary from Amazon Transcribe Medical.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :vocabulary_name (required, String)

    The name of the vocabulary you are choosing to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



572
573
574
575
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 572

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



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

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:



617
618
619
620
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 617

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:



639
640
641
642
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 639

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

#get_medical_transcription_job(params = {}) ⇒ Types::GetMedicalTranscriptionJobResponse

Returns information about a transcription job from Amazon Transcribe Medical. To see the status of the job, check the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished. You find the results of the completed job in the TranscriptFileUri field.

Examples:

Request syntax with placeholder values


resp = client.get_medical_transcription_job({
  medical_transcription_job_name: "TranscriptionJobName", # required
})

Response structure


resp.medical_transcription_job.medical_transcription_job_name #=> String
resp.medical_transcription_job.transcription_job_status #=> String, one of "QUEUED", "IN_PROGRESS", "FAILED", "COMPLETED"
resp.medical_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.medical_transcription_job.media_sample_rate_hertz #=> Integer
resp.medical_transcription_job.media_format #=> String, one of "mp3", "mp4", "wav", "flac"
resp.medical_transcription_job.media.media_file_uri #=> String
resp.medical_transcription_job.transcript.transcript_file_uri #=> String
resp.medical_transcription_job.start_time #=> Time
resp.medical_transcription_job.creation_time #=> Time
resp.medical_transcription_job.completion_time #=> Time
resp.medical_transcription_job.failure_reason #=> String
resp.medical_transcription_job.settings.show_speaker_labels #=> Boolean
resp.medical_transcription_job.settings.max_speaker_labels #=> Integer
resp.medical_transcription_job.settings.channel_identification #=> Boolean
resp.medical_transcription_job.settings.show_alternatives #=> Boolean
resp.medical_transcription_job.settings.max_alternatives #=> Integer
resp.medical_transcription_job.settings.vocabulary_name #=> String
resp.medical_transcription_job.specialty #=> String, one of "PRIMARYCARE"
resp.medical_transcription_job.type #=> String, one of "CONVERSATION", "DICTATION"

Parameters:

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

    ({})

Options Hash (params):

  • :medical_transcription_job_name (required, String)

    The name of the medical transcription job.

Returns:

See Also:



689
690
691
692
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 689

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

#get_medical_vocabulary(params = {}) ⇒ Types::GetMedicalVocabularyResponse

Retrieve information about a medical vocabulary.

Examples:

Request syntax with placeholder values


resp = client.get_medical_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 you are trying to get information about. The value you enter for this request is case-sensitive.

Returns:

See Also:



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

def get_medical_vocabulary(params = {}, options = {})
  req = build_request(:get_medical_vocabulary, 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 TranscriptFileUri field. If you enable content redaction, the redacted transcript appears in RedactedTranscriptFileUri.

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.transcript.redacted_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
resp.transcription_job.content_redaction.redaction_type #=> String, one of "PII"
resp.transcription_job.content_redaction.redaction_output #=> String, one of "redacted", "redacted_and_unredacted"

Parameters:

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

    ({})

Options Hash (params):

  • :transcription_job_name (required, String)

    The name of the job.

Returns:

See Also:



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

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:



823
824
825
826
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 823

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:



857
858
859
860
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 857

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

#list_medical_transcription_jobs(params = {}) ⇒ Types::ListMedicalTranscriptionJobsResponse

Lists medical transcription jobs with a specified status or substring that matches their names.

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_medical_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.medical_transcription_job_summaries #=> Array
resp.medical_transcription_job_summaries[0].medical_transcription_job_name #=> String
resp.medical_transcription_job_summaries[0].creation_time #=> Time
resp.medical_transcription_job_summaries[0].start_time #=> Time
resp.medical_transcription_job_summaries[0].completion_time #=> Time
resp.medical_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.medical_transcription_job_summaries[0].transcription_job_status #=> String, one of "QUEUED", "IN_PROGRESS", "FAILED", "COMPLETED"
resp.medical_transcription_job_summaries[0].failure_reason #=> String
resp.medical_transcription_job_summaries[0].output_location_type #=> String, one of "CUSTOMER_BUCKET", "SERVICE_BUCKET"
resp.medical_transcription_job_summaries[0].specialty #=> String, one of "PRIMARYCARE"
resp.medical_transcription_job_summaries[0].type #=> String, one of "CONVERSATION", "DICTATION"

Parameters:

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

    ({})

Options Hash (params):

  • :status (String)

    When specified, returns only medical 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 Medical 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 you a receive a truncated result in the previous request of ListMedicalTranscriptionJobs, include NextToken to fetch the next set of jobs.

  • :max_results (Integer)

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

Returns:

See Also:



922
923
924
925
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 922

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

#list_medical_vocabularies(params = {}) ⇒ Types::ListMedicalVocabulariesResponse

Returns a list of vocabularies that match the specified criteria. You get the entire list of vocabularies if you don't enter a value in any of the request parameters.

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_medical_vocabularies({
  next_token: "NextToken",
  max_results: 1,
  state_equals: "PENDING", # accepts PENDING, READY, FAILED
  name_contains: "VocabularyName",
})

Response structure


resp.status #=> String, one of "PENDING", "READY", "FAILED"
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 your previous request to ListMedicalVocabularies 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.

  • :state_equals (String)

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

  • :name_contains (String)

    Returns vocabularies in the list whose name contains the specified string. The search is case-insensitive, ListMedicalVocabularies returns both "vocabularyname" and "VocabularyName" in the response list.

Returns:

See Also:



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

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

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

Lists transcription jobs with the specified status.

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_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"
resp.transcription_job_summaries[0].content_redaction.redaction_type #=> String, one of "PII"
resp.transcription_job_summaries[0].content_redaction.redaction_output #=> String, one of "redacted", "redacted_and_unredacted"

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:



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

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.

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_vocabularies({
  next_token: "NextToken",
  max_results: 1,
  state_equals: "PENDING", # accepts PENDING, READY, FAILED
  name_contains: "VocabularyName",
})

Response structure


resp.status #=> String, one of "PENDING", "READY", "FAILED"
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 returns both "vocabularyname" and "VocabularyName" in the response list.

Returns:

See Also:



1100
1101
1102
1103
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1100

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.

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



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

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

#start_medical_transcription_job(params = {}) ⇒ Types::StartMedicalTranscriptionJobResponse

Start a batch job to transcribe medical speech to text.

Examples:

Request syntax with placeholder values


resp = client.start_medical_transcription_job({
  medical_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", # required
  output_encryption_kms_key_id: "KMSKeyId",
  settings: {
    show_speaker_labels: false,
    max_speaker_labels: 1,
    channel_identification: false,
    show_alternatives: false,
    max_alternatives: 1,
    vocabulary_name: "VocabularyName",
  },
  specialty: "PRIMARYCARE", # required, accepts PRIMARYCARE
  type: "CONVERSATION", # required, accepts CONVERSATION, DICTATION
})

Response structure


resp.medical_transcription_job.medical_transcription_job_name #=> String
resp.medical_transcription_job.transcription_job_status #=> String, one of "QUEUED", "IN_PROGRESS", "FAILED", "COMPLETED"
resp.medical_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.medical_transcription_job.media_sample_rate_hertz #=> Integer
resp.medical_transcription_job.media_format #=> String, one of "mp3", "mp4", "wav", "flac"
resp.medical_transcription_job.media.media_file_uri #=> String
resp.medical_transcription_job.transcript.transcript_file_uri #=> String
resp.medical_transcription_job.start_time #=> Time
resp.medical_transcription_job.creation_time #=> Time
resp.medical_transcription_job.completion_time #=> Time
resp.medical_transcription_job.failure_reason #=> String
resp.medical_transcription_job.settings.show_speaker_labels #=> Boolean
resp.medical_transcription_job.settings.max_speaker_labels #=> Integer
resp.medical_transcription_job.settings.channel_identification #=> Boolean
resp.medical_transcription_job.settings.show_alternatives #=> Boolean
resp.medical_transcription_job.settings.max_alternatives #=> Integer
resp.medical_transcription_job.settings.vocabulary_name #=> String
resp.medical_transcription_job.specialty #=> String, one of "PRIMARYCARE"
resp.medical_transcription_job.type #=> String, one of "CONVERSATION", "DICTATION"

Parameters:

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

    ({})

Options Hash (params):

  • :medical_transcription_job_name (required, String)

    The name of the medical transcription job. You can't use the strings "." or ".." by themselves as the job name. The name must also be unique within an AWS account. If you try to create a medical transcription job with the same name as a previous medical transcription job you will receive a ConflictException error.

  • :language_code (required, String)

    The language code for the language spoken in the input media file. US English (en-US) is the valid value for medical transcription jobs. Any other value you enter for language code results in a BadRequestException error.

  • :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 Medical determines the sample rate. If you specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you should leave the MediaSampleRateHertz field blank and let Amazon Transcribe Medical determine the sample rate.

  • :media_format (String)

    The audio format of the input media file.

  • :media (required, Types::Media)

    Describes the input media file in a transcription request.

  • :output_bucket_name (required, String)

    The Amazon S3 location where the transcription is stored.

    You must set OutputBucketName for Amazon Transcribe Medical to store the transcription results. Your transcript appears in the S3 location you specify. When you call the GetMedicalTranscriptionJob, the operation returns this location in the TranscriptFileUri field. The S3 bucket must have permissions that allow Amazon Transcribe Medical 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 Medical uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.

  • :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 StartMedicalTranscriptionJob operation must have permission to use the specified KMS key.

    You 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 in the current account or another account: "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 medical 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::MedicalTranscriptionSetting)

    Optional settings for the medical transcription job.

  • :specialty (required, String)

    The medical specialty of any clinician speaking in the input media.

  • :type (required, String)

    The type of speech in the input audio. CONVERSATION refers to conversations between two or more speakers, e.g., a conversations between doctors and patients. DICTATION refers to single-speaker dictated speech, e.g., for clinical notes.

Returns:

See Also:



1300
1301
1302
1303
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1300

def start_medical_transcription_job(params = {}, options = {})
  req = build_request(:start_medical_transcription_job, 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",
  },
  content_redaction: {
    redaction_type: "PII", # required, accepts PII
    redaction_output: "redacted", # required, accepts redacted, redacted_and_unredacted
  },
})

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.transcript.redacted_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
resp.transcription_job.content_redaction.redaction_type #=> String, one of "PII"
resp.transcription_job.content_redaction.redaction_output #=> String, one of "redacted", "redacted_and_unredacted"

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. If you try to create a transcription job with the same name as a previous transcription job you will receive a ConflictException error.

  • :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 transcript in the specified S3 bucket. When you call the GetTranscriptionJob operation, the operation returns this location in the TranscriptFileUri field. If you enable content redaction, the redacted transcript appears in RedactedTranscriptFileUri. If you enable content redaction and choose to output an unredacted transcript, that transcript's location still appears in the TranscriptFileUri. 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.

  • :content_redaction (Types::ContentRedaction)

    An object that contains the request parameters for content redaction.

Returns:

See Also:



1471
1472
1473
1474
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1471

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

#update_medical_vocabulary(params = {}) ⇒ Types::UpdateMedicalVocabularyResponse

Updates an existing vocabulary with new values in a different text file. The UpdateMedicalVocabulary 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_medical_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
  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. If you try to update a vocabulary with the same name as a previous vocabulary you will receive a ConflictException error.

  • :language_code (required, String)

    The language code of the entries in the updated vocabulary. US English (en-US) is the only valid language code in Amazon Transcribe Medical.

  • :vocabulary_file_uri (String)

    The Amazon S3 location of the text file containing the definition of the custom vocabulary. The URI must be in the same AWS region as the API endpoint you are calling. You can see the fields you need to enter for you Amazon S3 location in the example URI here:

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

    For example:

    https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt

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

    For more information about custom vocabularies in Amazon Transcribe Medical, see Medical Custom Vocabularies.

Returns:

See Also:



1540
1541
1542
1543
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1540

def update_medical_vocabulary(params = {}, options = {})
  req = build_request(:update_medical_vocabulary, 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. If you try to update a vocabulary with the same name as a previous vocabulary you will receive a ConflictException error.

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

    For example:

    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:



1605
1606
1607
1608
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1605

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. If you try to update a vocabulary filter with the same name as a previous vocabulary filter you will receive a ConflictException error.

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



1669
1670
1671
1672
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1669

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