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

Class: Aws::TranscribeService::Types::StartTranscriptionJobRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing StartTranscriptionJobRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  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,
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#language_codeString

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

Possible values:

  • 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

Returns:

  • (String)

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

#mediaTypes::Media

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

Returns:

  • (Types::Media)

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

#media_formatString

The format of the input media file.

Possible values:

  • mp3
  • mp4
  • wav
  • flac

Returns:

  • (String)

    The format of the input media file.

#media_sample_rate_hertzInteger

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.

Returns:

  • (Integer)

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

#output_bucket_nameString

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.

Returns:

  • (String)

    The location where the transcription is stored.

#output_encryption_kms_key_idString

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.

Returns:

  • (String)

    The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the output of the transcription job.

#settingsTypes::Settings

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

Returns:

  • (Types::Settings)

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

#transcription_job_nameString

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.

Returns:

  • (String)

    The name of the job.