class Aws::TranscribeService::Types::StartTranscriptionJobRequest

@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, zh-TW, th-TH, en-ZA, en-NZ
      media_sample_rate_hertz: 1,
      media_format: "mp3", # accepts mp3, mp4, wav, flac, ogg, amr, webm
      media: { # required
        media_file_uri: "Uri",
        redacted_media_file_uri: "Uri",
      },
      output_bucket_name: "OutputBucketName",
      output_key: "OutputKey",
      output_encryption_kms_key_id: "KMSKeyId",
      kms_encryption_context: {
        "NonEmptyString" => "NonEmptyString",
      },
      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, tag
      },
      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, zh-TW, th-TH, en-ZA, en-NZ
      tags: [
        {
          key: "TagKey", # required
          value: "TagValue", # required
        },
      ],
    }

@!attribute [rw] transcription_job_name

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 Amazon Web Services account. If you try to create a transcription
job with the same name as a previous transcription job, you get a
`ConflictException` error.
@return [String]

@!attribute [rw] language_code

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

To transcribe speech in Modern Standard Arabic (ar-SA), your audio
or video file must be encoded at a sample rate of 16,000 Hz or
higher.
@return [String]

@!attribute [rw] media_sample_rate_hertz

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.
@return [Integer]

@!attribute [rw] media_format

The format of the input media file.
@return [String]

@!attribute [rw] media

An object that describes the input media for a transcription job.
@return [Types::Media]

@!attribute [rw] output_bucket_name

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][1].

You can specify an Amazon Web Services 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.

[1]: https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user
@return [String]

@!attribute [rw] output_key

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.
@return [String]

@!attribute [rw] output_encryption_kms_key_id

The Amazon Resource Name (ARN) of the Amazon Web Services 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.
@return [String]

@!attribute [rw] kms_encryption_context

A map of plain text, non-secret key:value pairs, known as encryption
context pairs, that provide an added layer of security for your
data.
@return [Hash<String,String>]

@!attribute [rw] settings

A `Settings` object that provides optional settings for a
transcription job.
@return [Types::Settings]

@!attribute [rw] model_settings

Choose the custom language model you use for your transcription job
in this parameter.
@return [Types::ModelSettings]

@!attribute [rw] job_execution_settings

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.
@return [Types::JobExecutionSettings]

@!attribute [rw] content_redaction

An object that contains the request parameters for content
redaction.
@return [Types::ContentRedaction]

@!attribute [rw] identify_language

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`.
@return [Boolean]

@!attribute [rw] language_options

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.

To transcribe speech in Modern Standard Arabic (ar-SA), your audio
or video file must be encoded at a sample rate of 16,000 Hz or
higher.
@return [Array<String>]

@!attribute [rw] tags

Add tags to an Amazon Transcribe transcription job.
@return [Array<Types::Tag>]

@see docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/StartTranscriptionJobRequest AWS API Documentation

Constants

SENSITIVE