Class: Aws::TranscribeService::Types::MedicalScribeJob

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

Overview

Provides detailed information about a Medical Scribe job.

To view the status of the specified Medical Scribe job, check the ‘MedicalScribeJobStatus` field. If the status is `COMPLETED`, the job is finished and you can find the results at the locations specified in `MedicalScribeOutput`. If the status is `FAILED`, `FailureReason` provides details on why your Medical Scribe job failed.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#channel_definitions ⇒ Array<Types::MedicalScribeChannelDefinition>

Makes it possible to specify which speaker is on which channel. For example, if the clinician is the first participant to speak, you would set ‘ChannelId` of the first `ChannelDefinition` in the list to `0` (to indicate the first channel) and `ParticipantRole` to `CLINICIAN` (to indicate that it’s the clinician speaking). Then you would set the ‘ChannelId` of the second `ChannelDefinition` in the list to `1` (to indicate the second channel) and `ParticipantRole` to `PATIENT` (to indicate that it’s the patient speaking).

Returns:



2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
 
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2898

class MedicalScribeJob < Struct.new(
  :medical_scribe_job_name,
  :medical_scribe_job_status,
  :language_code,
  :media,
  :medical_scribe_output,
  :start_time,
  :creation_time,
  :completion_time,
  :failure_reason,
  :settings,
  :data_access_role_arn,
  :channel_definitions,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#completion_time ⇒ Time

The date and time the specified Medical Scribe job finished processing.

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 Medical Scribe job that finished processing at 12:32 PM UTC-7 on May 4, 2022.

Returns:

  • (Time) 


2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
 
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2898

class MedicalScribeJob < Struct.new(
  :medical_scribe_job_name,
  :medical_scribe_job_status,
  :language_code,
  :media,
  :medical_scribe_output,
  :start_time,
  :creation_time,
  :completion_time,
  :failure_reason,
  :settings,
  :data_access_role_arn,
  :channel_definitions,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ Time

The date and time the specified Medical Scribe 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 Medical Scribe job that started processing at 12:32 PM UTC-7 on May 4, 2022.

Returns:

  • (Time) 


2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
 
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2898

class MedicalScribeJob < Struct.new(
  :medical_scribe_job_name,
  :medical_scribe_job_status,
  :language_code,
  :media,
  :medical_scribe_output,
  :start_time,
  :creation_time,
  :completion_time,
  :failure_reason,
  :settings,
  :data_access_role_arn,
  :channel_definitions,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#data_access_role_arn ⇒ String

The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files, write to the output bucket, and use your KMS key if supplied. If the role that you specify doesn’t have the appropriate permissions your request fails.

IAM role ARNs have the format ‘arn:partition:iam::account:role/role-name-with-path`. For example: `arn:aws:iam::111122223333:role/Admin`.

For more information, see [IAM ARNs].

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns

Returns:

  • (String) 


2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
 
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2898

class MedicalScribeJob < Struct.new(
  :medical_scribe_job_name,
  :medical_scribe_job_status,
  :language_code,
  :media,
  :medical_scribe_output,
  :start_time,
  :creation_time,
  :completion_time,
  :failure_reason,
  :settings,
  :data_access_role_arn,
  :channel_definitions,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#failure_reason ⇒ String

If ‘MedicalScribeJobStatus` 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) 


2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
 
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2898

class MedicalScribeJob < Struct.new(
  :medical_scribe_job_name,
  :medical_scribe_job_status,
  :language_code,
  :media,
  :medical_scribe_output,
  :start_time,
  :creation_time,
  :completion_time,
  :failure_reason,
  :settings,
  :data_access_role_arn,
  :channel_definitions,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#language_code ⇒ String

The language code used to create your Medical Scribe job. US English (‘en-US`) is the only supported language for Medical Scribe jobs.

Returns:

  • (String) 


2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
 
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2898

class MedicalScribeJob < Struct.new(
  :medical_scribe_job_name,
  :medical_scribe_job_status,
  :language_code,
  :media,
  :medical_scribe_output,
  :start_time,
  :creation_time,
  :completion_time,
  :failure_reason,
  :settings,
  :data_access_role_arn,
  :channel_definitions,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#media ⇒ Types::Media

Describes the Amazon S3 location of the media file you want to use in your request.

For information on supported media formats, refer to the ‘MediaFormat` parameter or the [Media formats] section in the Amazon S3 Developer Guide.

[1]: docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio

Returns:



2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
 
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2898

class MedicalScribeJob < Struct.new(
  :medical_scribe_job_name,
  :medical_scribe_job_status,
  :language_code,
  :media,
  :medical_scribe_output,
  :start_time,
  :creation_time,
  :completion_time,
  :failure_reason,
  :settings,
  :data_access_role_arn,
  :channel_definitions,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#medical_scribe_job_name ⇒ String

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

Returns:

  • (String) 


2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
 
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2898

class MedicalScribeJob < Struct.new(
  :medical_scribe_job_name,
  :medical_scribe_job_status,
  :language_code,
  :media,
  :medical_scribe_output,
  :start_time,
  :creation_time,
  :completion_time,
  :failure_reason,
  :settings,
  :data_access_role_arn,
  :channel_definitions,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#medical_scribe_job_status ⇒ String

Provides the status of the specified Medical Scribe job.

If the status is ‘COMPLETED`, the job is finished and you can find the results at the location specified in `MedicalScribeOutput` If the status is `FAILED`, `FailureReason` provides details on why your Medical Scribe job failed.

Returns:

  • (String) 


2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
 
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2898

class MedicalScribeJob < Struct.new(
  :medical_scribe_job_name,
  :medical_scribe_job_status,
  :language_code,
  :media,
  :medical_scribe_output,
  :start_time,
  :creation_time,
  :completion_time,
  :failure_reason,
  :settings,
  :data_access_role_arn,
  :channel_definitions,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#medical_scribe_output ⇒ Types::MedicalScribeOutput

The location of the output of your Medical Scribe job. ‘ClinicalDocumentUri` holds the Amazon S3 URI for the Clinical Document and `TranscriptFileUri` holds the Amazon S3 URI for the Transcript.

Returns:



2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
 
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2898

class MedicalScribeJob < Struct.new(
  :medical_scribe_job_name,
  :medical_scribe_job_status,
  :language_code,
  :media,
  :medical_scribe_output,
  :start_time,
  :creation_time,
  :completion_time,
  :failure_reason,
  :settings,
  :data_access_role_arn,
  :channel_definitions,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#settings ⇒ Types::MedicalScribeSettings

Makes it possible to control how your Medical Scribe job is processed using a ‘MedicalScribeSettings` object. Specify `ChannelIdentification` if `ChannelDefinitions` are set. Enabled `ShowSpeakerLabels` if `ChannelIdentification` and `ChannelDefinitions` are not set. One and only one of `ChannelIdentification` and `ShowSpeakerLabels` must be set. If `ShowSpeakerLabels` is set, `MaxSpeakerLabels` must also be set. Use `Settings` to specify a vocabulary or vocabulary filter or both using `VocabularyName`, `VocabularyFilterName`. `VocabularyFilterMethod` must be specified if `VocabularyFilterName` is set.

Returns:



2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
 
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2898

class MedicalScribeJob < Struct.new(
  :medical_scribe_job_name,
  :medical_scribe_job_status,
  :language_code,
  :media,
  :medical_scribe_output,
  :start_time,
  :creation_time,
  :completion_time,
  :failure_reason,
  :settings,
  :data_access_role_arn,
  :channel_definitions,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

The date and time your Medical Scribe 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 Medical Scribe job that started processing at 12:32 PM UTC-7 on May 4, 2022.

Returns:

  • (Time) 


2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
 
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2898

class MedicalScribeJob < Struct.new(
  :medical_scribe_job_name,
  :medical_scribe_job_status,
  :language_code,
  :media,
  :medical_scribe_output,
  :start_time,
  :creation_time,
  :completion_time,
  :failure_reason,
  :settings,
  :data_access_role_arn,
  :channel_definitions,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

Adds one or more custom tags, each in the form of a key:value pair, to the Medica Scribe job.

To learn more about using tags with Amazon Transcribe, refer to [Tagging resources].

[1]: docs.aws.amazon.com/transcribe/latest/dg/tagging.html

Returns:



2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
 
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2898

class MedicalScribeJob < Struct.new(
  :medical_scribe_job_name,
  :medical_scribe_job_status,
  :language_code,
  :media,
  :medical_scribe_output,
  :start_time,
  :creation_time,
  :completion_time,
  :failure_reason,
  :settings,
  :data_access_role_arn,
  :channel_definitions,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end