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

Inherits:

Struct

Object
Struct
Aws::TranscribeService::Types::TranscriptionJobSummary

show all

Includes:: Structure

Defined in:: lib/aws-sdk-transcribeservice/types.rb

Overview

Provides detailed information about a specific transcription job.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#completion_time ⇒ Time

The date and time the specified transcription job finished processing.
#content_redaction ⇒ Types::ContentRedaction

The content redaction settings of the transcription job.
#creation_time ⇒ Time

The date and time the specified transcription job request was made.
#failure_reason ⇒ String

If ‘TranscriptionJobStatus` is `FAILED`, `FailureReason` contains information about why the transcription job failed.
#identified_language_score ⇒ Float

The confidence score associated with the language identified in your media file.
#identify_language ⇒ Boolean

Indicates whether automatic language identification was enabled (‘TRUE`) for the specified transcription job.
#identify_multiple_languages ⇒ Boolean

Indicates whether automatic multi-language identification was enabled (‘TRUE`) for the specified transcription job.
#language_code ⇒ String

The language code used to create your transcription.
#language_codes ⇒ Array<Types::LanguageCodeItem>

The language codes used to create your transcription job.
#model_settings ⇒ Types::ModelSettings

Provides the name of the custom language model that was included in the specified transcription job.
#output_location_type ⇒ String

Indicates where the specified transcription output is stored.
#start_time ⇒ Time

The date and time your transcription job began processing.
#toxicity_detection ⇒ Array<Types::ToxicityDetectionSettings>

Indicates whether toxicity detection was enabled for the specified transcription job.
#transcription_job_name ⇒ String

The name of the transcription job.
#transcription_job_status ⇒ String

Provides the status of your transcription job.

Instance Attribute Details

#completion_time ⇒ `Time`

The date and time the specified transcription job finished processing.

Timestamps are in the format ‘YYYY-MM-DD’T’HH:MM:SS.SSSSSS-UTC`. For example, ‘2022-05-04T12:33:13.922000-07:00` represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022.

Returns:

(Time)

# File 'lib/aws-sdk-transcribeservice/types.rb', line 5541

class TranscriptionJobSummary < Struct.new(
  :transcription_job_name,
  :creation_time,
  :start_time,
  :completion_time,
  :language_code,
  :transcription_job_status,
  :failure_reason,
  :output_location_type,
  :content_redaction,
  :model_settings,
  :identify_language,
  :identify_multiple_languages,
  :identified_language_score,
  :language_codes,
  :toxicity_detection)
  SENSITIVE = []
  include Aws::Structure
end

#content_redaction ⇒ `Types::ContentRedaction`

The content redaction settings of the transcription job.

Returns:

(Types::ContentRedaction)

# File 'lib/aws-sdk-transcribeservice/types.rb', line 5541

class TranscriptionJobSummary < Struct.new(
  :transcription_job_name,
  :creation_time,
  :start_time,
  :completion_time,
  :language_code,
  :transcription_job_status,
  :failure_reason,
  :output_location_type,
  :content_redaction,
  :model_settings,
  :identify_language,
  :identify_multiple_languages,
  :identified_language_score,
  :language_codes,
  :toxicity_detection)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ `Time`

The date and time the specified transcription job request was made.

Timestamps are in the format ‘YYYY-MM-DD’T’HH:MM:SS.SSSSSS-UTC`. For example, ‘2022-05-04T12:32:58.761000-07:00` represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

Returns:

(Time)

# File 'lib/aws-sdk-transcribeservice/types.rb', line 5541

class TranscriptionJobSummary < Struct.new(
  :transcription_job_name,
  :creation_time,
  :start_time,
  :completion_time,
  :language_code,
  :transcription_job_status,
  :failure_reason,
  :output_location_type,
  :content_redaction,
  :model_settings,
  :identify_language,
  :identify_multiple_languages,
  :identified_language_score,
  :language_codes,
  :toxicity_detection)
  SENSITIVE = []
  include Aws::Structure
end

#failure_reason ⇒ `String`

If ‘TranscriptionJobStatus` is `FAILED`, `FailureReason` contains information about why the transcription job failed. See also: [Common Errors].

[1]: docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html

Returns:

(String)

# File 'lib/aws-sdk-transcribeservice/types.rb', line 5541

class TranscriptionJobSummary < Struct.new(
  :transcription_job_name,
  :creation_time,
  :start_time,
  :completion_time,
  :language_code,
  :transcription_job_status,
  :failure_reason,
  :output_location_type,
  :content_redaction,
  :model_settings,
  :identify_language,
  :identify_multiple_languages,
  :identified_language_score,
  :language_codes,
  :toxicity_detection)
  SENSITIVE = []
  include Aws::Structure
end

#identified_language_score ⇒ `Float`

The confidence score associated with the language identified in your media file.

Confidence scores are values between 0 and 1; a larger value indicates a higher probability that the identified language correctly matches the language spoken in your media.

Returns:

(Float)

# File 'lib/aws-sdk-transcribeservice/types.rb', line 5541

class TranscriptionJobSummary < Struct.new(
  :transcription_job_name,
  :creation_time,
  :start_time,
  :completion_time,
  :language_code,
  :transcription_job_status,
  :failure_reason,
  :output_location_type,
  :content_redaction,
  :model_settings,
  :identify_language,
  :identify_multiple_languages,
  :identified_language_score,
  :language_codes,
  :toxicity_detection)
  SENSITIVE = []
  include Aws::Structure
end

#identify_language ⇒ `Boolean`

Indicates whether automatic language identification was enabled (‘TRUE`) for the specified transcription job.

Returns:

(Boolean)

# File 'lib/aws-sdk-transcribeservice/types.rb', line 5541

class TranscriptionJobSummary < Struct.new(
  :transcription_job_name,
  :creation_time,
  :start_time,
  :completion_time,
  :language_code,
  :transcription_job_status,
  :failure_reason,
  :output_location_type,
  :content_redaction,
  :model_settings,
  :identify_language,
  :identify_multiple_languages,
  :identified_language_score,
  :language_codes,
  :toxicity_detection)
  SENSITIVE = []
  include Aws::Structure
end

#identify_multiple_languages ⇒ `Boolean`

Indicates whether automatic multi-language identification was enabled (‘TRUE`) for the specified transcription job.

Returns:

(Boolean)

# File 'lib/aws-sdk-transcribeservice/types.rb', line 5541

class TranscriptionJobSummary < Struct.new(
  :transcription_job_name,
  :creation_time,
  :start_time,
  :completion_time,
  :language_code,
  :transcription_job_status,
  :failure_reason,
  :output_location_type,
  :content_redaction,
  :model_settings,
  :identify_language,
  :identify_multiple_languages,
  :identified_language_score,
  :language_codes,
  :toxicity_detection)
  SENSITIVE = []
  include Aws::Structure
end

#language_code ⇒ `String`

The language code used to create your transcription.

Returns:

(String)

# File 'lib/aws-sdk-transcribeservice/types.rb', line 5541

class TranscriptionJobSummary < Struct.new(
  :transcription_job_name,
  :creation_time,
  :start_time,
  :completion_time,
  :language_code,
  :transcription_job_status,
  :failure_reason,
  :output_location_type,
  :content_redaction,
  :model_settings,
  :identify_language,
  :identify_multiple_languages,
  :identified_language_score,
  :language_codes,
  :toxicity_detection)
  SENSITIVE = []
  include Aws::Structure
end

#language_codes ⇒ `Array<Types::LanguageCodeItem>`

The language codes used to create your transcription job. This parameter is used with multi-language identification. For single-language identification, the singular version of this parameter, ‘LanguageCode`, is present.

Returns:

(Array<Types::LanguageCodeItem>)

# File 'lib/aws-sdk-transcribeservice/types.rb', line 5541

class TranscriptionJobSummary < Struct.new(
  :transcription_job_name,
  :creation_time,
  :start_time,
  :completion_time,
  :language_code,
  :transcription_job_status,
  :failure_reason,
  :output_location_type,
  :content_redaction,
  :model_settings,
  :identify_language,
  :identify_multiple_languages,
  :identified_language_score,
  :language_codes,
  :toxicity_detection)
  SENSITIVE = []
  include Aws::Structure
end

#model_settings ⇒ `Types::ModelSettings`

Provides the name of the custom language model that was included in the specified transcription job.

Only use ‘ModelSettings` with the `LanguageModelName` sub-parameter if you’re not using automatic language identification (‘). If using LanguageIdSettings in your request, this parameter contains a LanguageModelName sub-parameter.</p> `

Returns:

(Types::ModelSettings)

# File 'lib/aws-sdk-transcribeservice/types.rb', line 5541

class TranscriptionJobSummary < Struct.new(
  :transcription_job_name,
  :creation_time,
  :start_time,
  :completion_time,
  :language_code,
  :transcription_job_status,
  :failure_reason,
  :output_location_type,
  :content_redaction,
  :model_settings,
  :identify_language,
  :identify_multiple_languages,
  :identified_language_score,
  :language_codes,
  :toxicity_detection)
  SENSITIVE = []
  include Aws::Structure
end

#output_location_type ⇒ `String`

Indicates where the specified transcription output is stored.

If the value is ‘CUSTOMER_BUCKET`, the location is the Amazon S3 bucket you specified using the `OutputBucketName` parameter in your request. If you also included `OutputKey` in your request, your output is located in the path you specified in your request.

If the value is ‘SERVICE_BUCKET`, the location is a service-managed Amazon S3 bucket. To access a transcript stored in a service-managed bucket, use the URI shown in the `TranscriptFileUri` or `RedactedTranscriptFileUri` field.

Returns:

(String)

# File 'lib/aws-sdk-transcribeservice/types.rb', line 5541

class TranscriptionJobSummary < Struct.new(
  :transcription_job_name,
  :creation_time,
  :start_time,
  :completion_time,
  :language_code,
  :transcription_job_status,
  :failure_reason,
  :output_location_type,
  :content_redaction,
  :model_settings,
  :identify_language,
  :identify_multiple_languages,
  :identified_language_score,
  :language_codes,
  :toxicity_detection)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ `Time`

The date and time your transcription job began processing.

Timestamps are in the format ‘YYYY-MM-DD’T’HH:MM:SS.SSSSSS-UTC`. For example, ‘2022-05-04T12:32:58.789000-07:00` represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

Returns:

(Time)

# File 'lib/aws-sdk-transcribeservice/types.rb', line 5541

class TranscriptionJobSummary < Struct.new(
  :transcription_job_name,
  :creation_time,
  :start_time,
  :completion_time,
  :language_code,
  :transcription_job_status,
  :failure_reason,
  :output_location_type,
  :content_redaction,
  :model_settings,
  :identify_language,
  :identify_multiple_languages,
  :identified_language_score,
  :language_codes,
  :toxicity_detection)
  SENSITIVE = []
  include Aws::Structure
end

#toxicity_detection ⇒ `Array<Types::ToxicityDetectionSettings>`

Indicates whether toxicity detection was enabled for the specified transcription job.

Returns:

(Array<Types::ToxicityDetectionSettings>)

# File 'lib/aws-sdk-transcribeservice/types.rb', line 5541

class TranscriptionJobSummary < Struct.new(
  :transcription_job_name,
  :creation_time,
  :start_time,
  :completion_time,
  :language_code,
  :transcription_job_status,
  :failure_reason,
  :output_location_type,
  :content_redaction,
  :model_settings,
  :identify_language,
  :identify_multiple_languages,
  :identified_language_score,
  :language_codes,
  :toxicity_detection)
  SENSITIVE = []
  include Aws::Structure
end

#transcription_job_name ⇒ `String`

The name of the transcription job. Job names are case sensitive and must be unique within an Amazon Web Services account.

Returns:

(String)

# File 'lib/aws-sdk-transcribeservice/types.rb', line 5541

class TranscriptionJobSummary < Struct.new(
  :transcription_job_name,
  :creation_time,
  :start_time,
  :completion_time,
  :language_code,
  :transcription_job_status,
  :failure_reason,
  :output_location_type,
  :content_redaction,
  :model_settings,
  :identify_language,
  :identify_multiple_languages,
  :identified_language_score,
  :language_codes,
  :toxicity_detection)
  SENSITIVE = []
  include Aws::Structure
end

#transcription_job_status ⇒ `String`

Provides the status of your transcription job.

If the status is ‘COMPLETED`, the job is finished and you can find the results at the location specified in `TranscriptFileUri` (or `RedactedTranscriptFileUri`, if you requested transcript redaction). If the status is `FAILED`, `FailureReason` provides details on why your transcription job failed.

Returns:

(String)

# File 'lib/aws-sdk-transcribeservice/types.rb', line 5541

class TranscriptionJobSummary < Struct.new(
  :transcription_job_name,
  :creation_time,
  :start_time,
  :completion_time,
  :language_code,
  :transcription_job_status,
  :failure_reason,
  :output_location_type,
  :content_redaction,
  :model_settings,
  :identify_language,
  :identify_multiple_languages,
  :identified_language_score,
  :language_codes,
  :toxicity_detection)
  SENSITIVE = []
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#completion_time ⇒ Time

#content_redaction ⇒ Types::ContentRedaction

#creation_time ⇒ Time

#failure_reason ⇒ String

#identified_language_score ⇒ Float

#identify_language ⇒ Boolean

#identify_multiple_languages ⇒ Boolean

#language_code ⇒ String

#language_codes ⇒ Array<Types::LanguageCodeItem>

#model_settings ⇒ Types::ModelSettings

#output_location_type ⇒ String

#start_time ⇒ Time

#toxicity_detection ⇒ Array<Types::ToxicityDetectionSettings>

#transcription_job_name ⇒ String

#transcription_job_status ⇒ String

#completion_time ⇒ `Time`

#content_redaction ⇒ `Types::ContentRedaction`

#creation_time ⇒ `Time`

#failure_reason ⇒ `String`

#identified_language_score ⇒ `Float`

#identify_language ⇒ `Boolean`

#identify_multiple_languages ⇒ `Boolean`

#language_code ⇒ `String`

#language_codes ⇒ `Array<Types::LanguageCodeItem>`

#model_settings ⇒ `Types::ModelSettings`

#output_location_type ⇒ `String`

#start_time ⇒ `Time`

#toxicity_detection ⇒ `Array<Types::ToxicityDetectionSettings>`

#transcription_job_name ⇒ `String`

#transcription_job_status ⇒ `String`