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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb

Overview

Note:

When making an API call, you may pass StartTranscriptionJobRequest data as a hash:

{
  transcription_job_name: "TranscriptionJobName", # required
  language_code: "af-ZA", # accepts af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN
  media_sample_rate_hertz: 1,
  media_format: "mp3", # accepts mp3, mp4, wav, flac, ogg, amr, webm
  media: { # required
    media_file_uri: "Uri",
  },
  output_bucket_name: "OutputBucketName",
  output_key: "OutputKey",
  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
  },
  model_settings: {
    language_model_name: "ModelName",
  },
  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
  },
  identify_language: false,
  language_options: ["af-ZA"], # accepts af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#content_redactionTypes::ContentRedaction

An object that contains the request parameters for content redaction.



2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 2250

class StartTranscriptionJobRequest < Struct.new(
  :transcription_job_name,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :output_bucket_name,
  :output_key,
  :output_encryption_kms_key_id,
  :settings,
  :model_settings,
  :job_execution_settings,
  :content_redaction,
  :identify_language,
  :language_options)
  SENSITIVE = []
  include Aws::Structure
end

#identify_languageBoolean

Set this field to true to enable automatic language identification. Automatic language identification is disabled by default. You receive a BadRequestException error if you enter a value for a LanguageCode.

Returns:

  • (Boolean)


2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 2250

class StartTranscriptionJobRequest < Struct.new(
  :transcription_job_name,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :output_bucket_name,
  :output_key,
  :output_encryption_kms_key_id,
  :settings,
  :model_settings,
  :job_execution_settings,
  :content_redaction,
  :identify_language,
  :language_options)
  SENSITIVE = []
  include Aws::Structure
end

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



2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 2250

class StartTranscriptionJobRequest < Struct.new(
  :transcription_job_name,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :output_bucket_name,
  :output_key,
  :output_encryption_kms_key_id,
  :settings,
  :model_settings,
  :job_execution_settings,
  :content_redaction,
  :identify_language,
  :language_options)
  SENSITIVE = []
  include Aws::Structure
end

#language_codeString

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

Returns:

  • (String)


2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 2250

class StartTranscriptionJobRequest < Struct.new(
  :transcription_job_name,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :output_bucket_name,
  :output_key,
  :output_encryption_kms_key_id,
  :settings,
  :model_settings,
  :job_execution_settings,
  :content_redaction,
  :identify_language,
  :language_options)
  SENSITIVE = []
  include Aws::Structure
end

#language_optionsArray<String>

An object containing a list of languages that might be present in your collection of audio files. Automatic language identification chooses a language that best matches the source audio from that list.

Returns:

  • (Array<String>)


2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 2250

class StartTranscriptionJobRequest < Struct.new(
  :transcription_job_name,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :output_bucket_name,
  :output_key,
  :output_encryption_kms_key_id,
  :settings,
  :model_settings,
  :job_execution_settings,
  :content_redaction,
  :identify_language,
  :language_options)
  SENSITIVE = []
  include Aws::Structure
end

#mediaTypes::Media

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

Returns:



2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 2250

class StartTranscriptionJobRequest < Struct.new(
  :transcription_job_name,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :output_bucket_name,
  :output_key,
  :output_encryption_kms_key_id,
  :settings,
  :model_settings,
  :job_execution_settings,
  :content_redaction,
  :identify_language,
  :language_options)
  SENSITIVE = []
  include Aws::Structure
end

#media_formatString

The format of the input media file.

Returns:

  • (String)


2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 2250

class StartTranscriptionJobRequest < Struct.new(
  :transcription_job_name,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :output_bucket_name,
  :output_key,
  :output_encryption_kms_key_id,
  :settings,
  :model_settings,
  :job_execution_settings,
  :content_redaction,
  :identify_language,
  :language_options)
  SENSITIVE = []
  include Aws::Structure
end

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


2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 2250

class StartTranscriptionJobRequest < Struct.new(
  :transcription_job_name,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :output_bucket_name,
  :output_key,
  :output_encryption_kms_key_id,
  :settings,
  :model_settings,
  :job_execution_settings,
  :content_redaction,
  :identify_language,
  :language_options)
  SENSITIVE = []
  include Aws::Structure
end

#model_settingsTypes::ModelSettings

Choose the custom language model you use for your transcription job in this parameter.



2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 2250

class StartTranscriptionJobRequest < Struct.new(
  :transcription_job_name,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :output_bucket_name,
  :output_key,
  :output_encryption_kms_key_id,
  :settings,
  :model_settings,
  :job_execution_settings,
  :content_redaction,
  :identify_language,
  :language_options)
  SENSITIVE = []
  include Aws::Structure
end

#output_bucket_nameString

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.

Returns:

  • (String)


2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 2250

class StartTranscriptionJobRequest < Struct.new(
  :transcription_job_name,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :output_bucket_name,
  :output_key,
  :output_encryption_kms_key_id,
  :settings,
  :model_settings,
  :job_execution_settings,
  :content_redaction,
  :identify_language,
  :language_options)
  SENSITIVE = []
  include Aws::Structure
end

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


2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 2250

class StartTranscriptionJobRequest < Struct.new(
  :transcription_job_name,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :output_bucket_name,
  :output_key,
  :output_encryption_kms_key_id,
  :settings,
  :model_settings,
  :job_execution_settings,
  :content_redaction,
  :identify_language,
  :language_options)
  SENSITIVE = []
  include Aws::Structure
end

#output_keyString

You can specify a location in an Amazon S3 bucket to store the output of your transcription job.

If you don't specify an output key, Amazon Transcribe stores the output of your transcription job in the Amazon S3 bucket you specified. By default, the object key is "your-transcription-job-name.json".

You can use output keys to specify the Amazon S3 prefix and file name of the transcription output. For example, specifying the Amazon S3 prefix, "folder1/folder2/", as an output key would lead to the output being stored as "folder1/folder2/your-transcription-job-name.json". If you specify "my-other-job-name.json" as the output key, the object key is changed to "my-other-job-name.json". You can use an output key to change both the prefix and the file name, for example "folder/my-other-job-name.json".

If you specify an output key, you must also specify an S3 bucket in the OutputBucketName parameter.

Returns:

  • (String)


2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 2250

class StartTranscriptionJobRequest < Struct.new(
  :transcription_job_name,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :output_bucket_name,
  :output_key,
  :output_encryption_kms_key_id,
  :settings,
  :model_settings,
  :job_execution_settings,
  :content_redaction,
  :identify_language,
  :language_options)
  SENSITIVE = []
  include Aws::Structure
end

#settingsTypes::Settings

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

Returns:



2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 2250

class StartTranscriptionJobRequest < Struct.new(
  :transcription_job_name,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :output_bucket_name,
  :output_key,
  :output_encryption_kms_key_id,
  :settings,
  :model_settings,
  :job_execution_settings,
  :content_redaction,
  :identify_language,
  :language_options)
  SENSITIVE = []
  include Aws::Structure
end

#transcription_job_nameString

The name of the 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 transcription job with the same name as a previous transcription job, you get a ConflictException error.

Returns:

  • (String)


2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 2250

class StartTranscriptionJobRequest < Struct.new(
  :transcription_job_name,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :output_bucket_name,
  :output_key,
  :output_encryption_kms_key_id,
  :settings,
  :model_settings,
  :job_execution_settings,
  :content_redaction,
  :identify_language,
  :language_options)
  SENSITIVE = []
  include Aws::Structure
end