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

Class: Aws::TranscribeService::Types::TranscriptionJob

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

Overview

Describes an asynchronous transcription job that was created with the StartTranscriptionJob operation.

Instance Attribute Summary collapse

Instance Attribute Details

#completion_timeTime

A timestamp that shows when the job was completed.

Returns:

  • (Time)


563
564
565
566
567
568
569
570
571
572
573
574
575
576
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 563

class TranscriptionJob < Struct.new(
  :transcription_job_name,
  :transcription_job_status,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :transcript,
  :creation_time,
  :completion_time,
  :failure_reason,
  :settings)
  include Aws::Structure
end

#creation_timeTime

A timestamp that shows when the job was created.

Returns:

  • (Time)


563
564
565
566
567
568
569
570
571
572
573
574
575
576
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 563

class TranscriptionJob < Struct.new(
  :transcription_job_name,
  :transcription_job_status,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :transcript,
  :creation_time,
  :completion_time,
  :failure_reason,
  :settings)
  include Aws::Structure
end

#failure_reasonString

If the TranscriptionJobStatus field is FAILED, this field contains information about why the job failed.

Returns:

  • (String)


563
564
565
566
567
568
569
570
571
572
573
574
575
576
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 563

class TranscriptionJob < Struct.new(
  :transcription_job_name,
  :transcription_job_status,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :transcript,
  :creation_time,
  :completion_time,
  :failure_reason,
  :settings)
  include Aws::Structure
end

#language_codeString

The language code for the input speech.

Returns:

  • (String)


563
564
565
566
567
568
569
570
571
572
573
574
575
576
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 563

class TranscriptionJob < Struct.new(
  :transcription_job_name,
  :transcription_job_status,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :transcript,
  :creation_time,
  :completion_time,
  :failure_reason,
  :settings)
  include Aws::Structure
end

#mediaTypes::Media

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

Returns:



563
564
565
566
567
568
569
570
571
572
573
574
575
576
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 563

class TranscriptionJob < Struct.new(
  :transcription_job_name,
  :transcription_job_status,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :transcript,
  :creation_time,
  :completion_time,
  :failure_reason,
  :settings)
  include Aws::Structure
end

#media_formatString

The format of the input media file.

Returns:

  • (String)


563
564
565
566
567
568
569
570
571
572
573
574
575
576
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 563

class TranscriptionJob < Struct.new(
  :transcription_job_name,
  :transcription_job_status,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :transcript,
  :creation_time,
  :completion_time,
  :failure_reason,
  :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)


563
564
565
566
567
568
569
570
571
572
573
574
575
576
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 563

class TranscriptionJob < Struct.new(
  :transcription_job_name,
  :transcription_job_status,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :transcript,
  :creation_time,
  :completion_time,
  :failure_reason,
  :settings)
  include Aws::Structure
end

#settingsTypes::Settings

Optional settings for the transcription job. Use these settings to turn on speaker recognition, to set the maximum number of speakers that should be identified and to specify a custom vocabulary to use when processing the transcription job.

Returns:



563
564
565
566
567
568
569
570
571
572
573
574
575
576
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 563

class TranscriptionJob < Struct.new(
  :transcription_job_name,
  :transcription_job_status,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :transcript,
  :creation_time,
  :completion_time,
  :failure_reason,
  :settings)
  include Aws::Structure
end

#transcriptTypes::Transcript

An object that describes the output of the transcription job.

Returns:



563
564
565
566
567
568
569
570
571
572
573
574
575
576
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 563

class TranscriptionJob < Struct.new(
  :transcription_job_name,
  :transcription_job_status,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :transcript,
  :creation_time,
  :completion_time,
  :failure_reason,
  :settings)
  include Aws::Structure
end

#transcription_job_nameString

The name of the transcription job.

Returns:

  • (String)


563
564
565
566
567
568
569
570
571
572
573
574
575
576
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 563

class TranscriptionJob < Struct.new(
  :transcription_job_name,
  :transcription_job_status,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :transcript,
  :creation_time,
  :completion_time,
  :failure_reason,
  :settings)
  include Aws::Structure
end

#transcription_job_statusString

The status of the transcription job.

Returns:

  • (String)


563
564
565
566
567
568
569
570
571
572
573
574
575
576
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 563

class TranscriptionJob < Struct.new(
  :transcription_job_name,
  :transcription_job_status,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :transcript,
  :creation_time,
  :completion_time,
  :failure_reason,
  :settings)
  include Aws::Structure
end