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

Class: Aws::TranscribeService::Types::TranscriptionJobSummary

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

Overview

Provides a summary of information about a transcription job.

Instance Attribute Summary collapse

Instance Attribute Details

#completion_timeTime

A timestamp that shows when the job was completed.

Returns:

  • (Time)


621
622
623
624
625
626
627
628
629
630
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 621

class TranscriptionJobSummary < Struct.new(
  :transcription_job_name,
  :creation_time,
  :completion_time,
  :language_code,
  :transcription_job_status,
  :failure_reason,
  :output_location_type)
  include Aws::Structure
end

#creation_timeTime

A timestamp that shows when the job was created.

Returns:

  • (Time)


621
622
623
624
625
626
627
628
629
630
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 621

class TranscriptionJobSummary < Struct.new(
  :transcription_job_name,
  :creation_time,
  :completion_time,
  :language_code,
  :transcription_job_status,
  :failure_reason,
  :output_location_type)
  include Aws::Structure
end

#failure_reasonString

If the TranscriptionJobStatus field is FAILED, a description of the error.

Returns:

  • (String)


621
622
623
624
625
626
627
628
629
630
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 621

class TranscriptionJobSummary < Struct.new(
  :transcription_job_name,
  :creation_time,
  :completion_time,
  :language_code,
  :transcription_job_status,
  :failure_reason,
  :output_location_type)
  include Aws::Structure
end

#language_codeString

The language code for the input speech.

Returns:

  • (String)


621
622
623
624
625
626
627
628
629
630
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 621

class TranscriptionJobSummary < Struct.new(
  :transcription_job_name,
  :creation_time,
  :completion_time,
  :language_code,
  :transcription_job_status,
  :failure_reason,
  :output_location_type)
  include Aws::Structure
end

#output_location_typeString

Indicates the location of the output of the transcription job.

If the value is CUSTOMER_BUCKET then the location is the S3 bucket specified in the outputBucketName field when the transcription job was started with the StartTranscriptionJob operation.

If the value is SERVICE_BUCKET then the output is stored by Amazon Transcribe and can be retrieved using the URI in the GetTranscriptionJob response's TranscriptFileUri field.

Returns:

  • (String)


621
622
623
624
625
626
627
628
629
630
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 621

class TranscriptionJobSummary < Struct.new(
  :transcription_job_name,
  :creation_time,
  :completion_time,
  :language_code,
  :transcription_job_status,
  :failure_reason,
  :output_location_type)
  include Aws::Structure
end

#transcription_job_nameString

The name of the transcription job.

Returns:

  • (String)


621
622
623
624
625
626
627
628
629
630
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 621

class TranscriptionJobSummary < Struct.new(
  :transcription_job_name,
  :creation_time,
  :completion_time,
  :language_code,
  :transcription_job_status,
  :failure_reason,
  :output_location_type)
  include Aws::Structure
end

#transcription_job_statusString

The status of the transcription job. When the status is COMPLETED, use the GetTranscriptionJob operation to get the results of the transcription.

Returns:

  • (String)


621
622
623
624
625
626
627
628
629
630
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 621

class TranscriptionJobSummary < Struct.new(
  :transcription_job_name,
  :creation_time,
  :completion_time,
  :language_code,
  :transcription_job_status,
  :failure_reason,
  :output_location_type)
  include Aws::Structure
end