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

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: "en-US", # required, accepts en-US, es-US
  media_sample_rate_hertz: 1,
  media_format: "mp3", # required, accepts mp3, mp4, wav, flac
  media: { # required
    media_file_uri: "Uri",
  },
  output_bucket_name: "OutputBucketName",
  settings: {
    vocabulary_name: "VocabularyName",
    show_speaker_labels: false,
    max_speaker_labels: 1,
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#language_codeString

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

Returns:

  • (String)


468
469
470
471
472
473
474
475
476
477
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 468

class StartTranscriptionJobRequest < Struct.new(
  :transcription_job_name,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :output_bucket_name,
  :settings)
  include Aws::Structure
end

#mediaTypes::Media

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

Returns:



468
469
470
471
472
473
474
475
476
477
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 468

class StartTranscriptionJobRequest < Struct.new(
  :transcription_job_name,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :output_bucket_name,
  :settings)
  include Aws::Structure
end

#media_formatString

The format of the input media file.

Returns:

  • (String)


468
469
470
471
472
473
474
475
476
477
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 468

class StartTranscriptionJobRequest < Struct.new(
  :transcription_job_name,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :output_bucket_name,
  :settings)
  include Aws::Structure
end

#media_sample_rate_hertzInteger

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

Returns:

  • (Integer)


468
469
470
471
472
473
474
475
476
477
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 468

class StartTranscriptionJobRequest < Struct.new(
  :transcription_job_name,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :output_bucket_name,
  :settings)
  include Aws::Structure
end

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

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)


468
469
470
471
472
473
474
475
476
477
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 468

class StartTranscriptionJobRequest < Struct.new(
  :transcription_job_name,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :output_bucket_name,
  :settings)
  include Aws::Structure
end

#settingsTypes::Settings

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

Returns:



468
469
470
471
472
473
474
475
476
477
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 468

class StartTranscriptionJobRequest < Struct.new(
  :transcription_job_name,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :output_bucket_name,
  :settings)
  include Aws::Structure
end

#transcription_job_nameString

The name of the job. You can't use the strings "." or ".." in the job name. The name must be unique within an AWS account.

Returns:

  • (String)


468
469
470
471
472
473
474
475
476
477
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 468

class StartTranscriptionJobRequest < Struct.new(
  :transcription_job_name,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :output_bucket_name,
  :settings)
  include Aws::Structure
end