Class: Aws::TranscribeService::Types::MedicalTranscriptionJobSummary

Inherits:

Struct

• Object
• Struct
• Aws::TranscribeService::Types::MedicalTranscriptionJobSummary

Defined in:

gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb

Overview

Provides detailed information about a specific medical transcription job.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #completion_time ⇒ Time

  The date and time the specified medical transcription job finished processing.

• #content_identification_type ⇒ String

  Labels all personal health information (PHI) identified in your transcript.

• #creation_time ⇒ Time

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

• #failure_reason ⇒ String

  If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job failed.

• #language_code ⇒ String

  The language code used to create your medical transcription.

• #medical_transcription_job_name ⇒ String

  The name of the medical transcription job.

• #output_location_type ⇒ String

  Indicates where the specified medical transcription output is stored.

• #specialty ⇒ String

  Provides the medical specialty represented in your media.

• #start_time ⇒ Time

  The date and time your medical transcription job began processing.

• #transcription_job_status ⇒ String

  Provides the status of your medical transcription job.

• #type ⇒ String

  Indicates whether the input media is a dictation or a conversation, as specified in the StartMedicalTranscriptionJob request.

Instance Attribute Details

#completion_time ⇒ Time

The date and time the specified medical 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 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 3597

class MedicalTranscriptionJobSummary < Struct.new(
  :medical_transcription_job_name,
  :creation_time,
  :start_time,
  :completion_time,
  :language_code,
  :transcription_job_status,
  :failure_reason,
  :output_location_type,
  :specialty,
  :content_identification_type,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#content_identification_type ⇒ String

Labels all personal health information (PHI) identified in your transcript. For more information, see Identifying personal health information (PHI) in a transcription.

Returns:

• (String)

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

class MedicalTranscriptionJobSummary < Struct.new(
  :medical_transcription_job_name,
  :creation_time,
  :start_time,
  :completion_time,
  :language_code,
  :transcription_job_status,
  :failure_reason,
  :output_location_type,
  :specialty,
  :content_identification_type,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ Time

The date and time the specified medical 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 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 3597

class MedicalTranscriptionJobSummary < Struct.new(
  :medical_transcription_job_name,
  :creation_time,
  :start_time,
  :completion_time,
  :language_code,
  :transcription_job_status,
  :failure_reason,
  :output_location_type,
  :specialty,
  :content_identification_type,
  :type)
  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.

Returns:

• (String)

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

class MedicalTranscriptionJobSummary < Struct.new(
  :medical_transcription_job_name,
  :creation_time,
  :start_time,
  :completion_time,
  :language_code,
  :transcription_job_status,
  :failure_reason,
  :output_location_type,
  :specialty,
  :content_identification_type,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#language_code ⇒ String

The language code used to create your medical transcription. US English (en-US) is the only supported language for medical transcriptions.

Returns:

• (String)

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

class MedicalTranscriptionJobSummary < Struct.new(
  :medical_transcription_job_name,
  :creation_time,
  :start_time,
  :completion_time,
  :language_code,
  :transcription_job_status,
  :failure_reason,
  :output_location_type,
  :specialty,
  :content_identification_type,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#medical_transcription_job_name ⇒ String

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

Returns:

• (String)

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

class MedicalTranscriptionJobSummary < Struct.new(
  :medical_transcription_job_name,
  :creation_time,
  :start_time,
  :completion_time,
  :language_code,
  :transcription_job_status,
  :failure_reason,
  :output_location_type,
  :specialty,
  :content_identification_type,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#output_location_type ⇒ String

Indicates where the specified medical 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 field.

Returns:

• (String)

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

class MedicalTranscriptionJobSummary < Struct.new(
  :medical_transcription_job_name,
  :creation_time,
  :start_time,
  :completion_time,
  :language_code,
  :transcription_job_status,
  :failure_reason,
  :output_location_type,
  :specialty,
  :content_identification_type,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#specialty ⇒ String

Provides the medical specialty represented in your media.

Returns:

• (String)

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

class MedicalTranscriptionJobSummary < Struct.new(
  :medical_transcription_job_name,
  :creation_time,
  :start_time,
  :completion_time,
  :language_code,
  :transcription_job_status,
  :failure_reason,
  :output_location_type,
  :specialty,
  :content_identification_type,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

The date and time your medical 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 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 3597

class MedicalTranscriptionJobSummary < Struct.new(
  :medical_transcription_job_name,
  :creation_time,
  :start_time,
  :completion_time,
  :language_code,
  :transcription_job_status,
  :failure_reason,
  :output_location_type,
  :specialty,
  :content_identification_type,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#transcription_job_status ⇒ String

Provides the status of your medical transcription job.

If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed.

Returns:

• (String)

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

class MedicalTranscriptionJobSummary < Struct.new(
  :medical_transcription_job_name,
  :creation_time,
  :start_time,
  :completion_time,
  :language_code,
  :transcription_job_status,
  :failure_reason,
  :output_location_type,
  :specialty,
  :content_identification_type,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

Indicates whether the input media is a dictation or a conversation, as specified in the StartMedicalTranscriptionJob request.

Returns:

• (String)

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

class MedicalTranscriptionJobSummary < Struct.new(
  :medical_transcription_job_name,
  :creation_time,
  :start_time,
  :completion_time,
  :language_code,
  :transcription_job_status,
  :failure_reason,
  :output_location_type,
  :specialty,
  :content_identification_type,
  :type)
  SENSITIVE = []
  include Aws::Structure
end