Amazonka.Transcribe.Types.MedicalTranscriptionJobSummary

Documentation

data MedicalTranscriptionJobSummary

Provides detailed information about a specific medical transcription job.

See: newMedicalTranscriptionJobSummary smart constructor.

Constructors

MedicalTranscriptionJobSummary'

Fields

• completionTime :: Maybe POSIX

  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.

• contentIdentificationType :: Maybe MedicalContentIdentificationType

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

• creationTime :: Maybe POSIX

  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.

• failureReason :: Maybe Text

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

• languageCode :: Maybe LanguageCode

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

• medicalTranscriptionJobName :: Maybe Text

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

• outputLocationType :: Maybe OutputLocationType

  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.

• specialty :: Maybe Specialty

  Provides the medical specialty represented in your media.

• startTime :: Maybe POSIX

  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.

• transcriptionJobStatus :: Maybe TranscriptionJobStatus

  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.

• type' :: Maybe Type

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

Instances

FromJSON MedicalTranscriptionJobSummary

Defined in Amazonka.Transcribe.Types.MedicalTranscriptionJobSummary

Methods

parseJSON :: Value -> Parser MedicalTranscriptionJobSummary

parseJSONList :: Value -> Parser [MedicalTranscriptionJobSummary]

Generic MedicalTranscriptionJobSummary

Defined in Amazonka.Transcribe.Types.MedicalTranscriptionJobSummary

Associated Types

type Rep MedicalTranscriptionJobSummary :: Type -> Type

Methods

from :: MedicalTranscriptionJobSummary -> Rep MedicalTranscriptionJobSummary x

to :: Rep MedicalTranscriptionJobSummary x -> MedicalTranscriptionJobSummary

Read MedicalTranscriptionJobSummary

Defined in Amazonka.Transcribe.Types.MedicalTranscriptionJobSummary

Methods

readsPrec :: Int -> ReadS MedicalTranscriptionJobSummary

readList :: ReadS [MedicalTranscriptionJobSummary]

readPrec :: ReadPrec MedicalTranscriptionJobSummary

readListPrec :: ReadPrec [MedicalTranscriptionJobSummary]

Show MedicalTranscriptionJobSummary

Defined in Amazonka.Transcribe.Types.MedicalTranscriptionJobSummary

Methods

showsPrec :: Int -> MedicalTranscriptionJobSummary -> ShowS

show :: MedicalTranscriptionJobSummary -> String

showList :: [MedicalTranscriptionJobSummary] -> ShowS

NFData MedicalTranscriptionJobSummary

Defined in Amazonka.Transcribe.Types.MedicalTranscriptionJobSummary

Methods

rnf :: MedicalTranscriptionJobSummary -> ()

Eq MedicalTranscriptionJobSummary

Defined in Amazonka.Transcribe.Types.MedicalTranscriptionJobSummary

Methods

(==) :: MedicalTranscriptionJobSummary -> MedicalTranscriptionJobSummary -> Bool

(/=) :: MedicalTranscriptionJobSummary -> MedicalTranscriptionJobSummary -> Bool

Hashable MedicalTranscriptionJobSummary

Defined in Amazonka.Transcribe.Types.MedicalTranscriptionJobSummary

Methods

hashWithSalt :: Int -> MedicalTranscriptionJobSummary -> Int

hash :: MedicalTranscriptionJobSummary -> Int

type Rep MedicalTranscriptionJobSummary

Defined in Amazonka.Transcribe.Types.MedicalTranscriptionJobSummary

type Rep MedicalTranscriptionJobSummary = D1 ('MetaData "MedicalTranscriptionJobSummary" "Amazonka.Transcribe.Types.MedicalTranscriptionJobSummary" "amazonka-transcribe-2.0-4BjJqzwmm0K94bsEMe1tnF" 'False) (C1 ('MetaCons "MedicalTranscriptionJobSummary'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "completionTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "contentIdentificationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MedicalContentIdentificationType))) :*: (S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LanguageCode))))) :*: ((S1 ('MetaSel ('Just "medicalTranscriptionJobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "outputLocationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OutputLocationType)) :*: S1 ('MetaSel ('Just "specialty") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Specialty)))) :*: (S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "transcriptionJobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TranscriptionJobStatus)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Type)))))))

newMedicalTranscriptionJobSummary :: MedicalTranscriptionJobSummary

Create a value of MedicalTranscriptionJobSummary with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:completionTime:MedicalTranscriptionJobSummary', medicalTranscriptionJobSummary_completionTime - 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.

$sel:contentIdentificationType:MedicalTranscriptionJobSummary', medicalTranscriptionJobSummary_contentIdentificationType - Labels all personal health information (PHI) identified in your transcript. For more information, see Identifying personal health information (PHI) in a transcription.

$sel:creationTime:MedicalTranscriptionJobSummary', medicalTranscriptionJobSummary_creationTime - 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.

$sel:failureReason:MedicalTranscriptionJobSummary', medicalTranscriptionJobSummary_failureReason - If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job failed. See also: Common Errors.

$sel:languageCode:MedicalTranscriptionJobSummary', medicalTranscriptionJobSummary_languageCode - The language code used to create your medical transcription. US English (en-US) is the only supported language for medical transcriptions.

$sel:medicalTranscriptionJobName:MedicalTranscriptionJobSummary', medicalTranscriptionJobSummary_medicalTranscriptionJobName - The name of the medical transcription job. Job names are case sensitive and must be unique within an Amazon Web Services account.

$sel:outputLocationType:MedicalTranscriptionJobSummary', medicalTranscriptionJobSummary_outputLocationType - 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.

$sel:specialty:MedicalTranscriptionJobSummary', medicalTranscriptionJobSummary_specialty - Provides the medical specialty represented in your media.

$sel:startTime:MedicalTranscriptionJobSummary', medicalTranscriptionJobSummary_startTime - 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.

$sel:transcriptionJobStatus:MedicalTranscriptionJobSummary', medicalTranscriptionJobSummary_transcriptionJobStatus - 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.

$sel:type':MedicalTranscriptionJobSummary', medicalTranscriptionJobSummary_type - Indicates whether the input media is a dictation or a conversation, as specified in the StartMedicalTranscriptionJob request.

medicalTranscriptionJobSummary_completionTime :: Lens' MedicalTranscriptionJobSummary (Maybe UTCTime)

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.

medicalTranscriptionJobSummary_contentIdentificationType :: Lens' MedicalTranscriptionJobSummary (Maybe MedicalContentIdentificationType)

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

medicalTranscriptionJobSummary_creationTime :: Lens' MedicalTranscriptionJobSummary (Maybe UTCTime)

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.

medicalTranscriptionJobSummary_failureReason :: Lens' MedicalTranscriptionJobSummary (Maybe Text)

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

medicalTranscriptionJobSummary_languageCode :: Lens' MedicalTranscriptionJobSummary (Maybe LanguageCode)

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

medicalTranscriptionJobSummary_medicalTranscriptionJobName :: Lens' MedicalTranscriptionJobSummary (Maybe Text)

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

medicalTranscriptionJobSummary_outputLocationType :: Lens' MedicalTranscriptionJobSummary (Maybe OutputLocationType)

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.

medicalTranscriptionJobSummary_specialty :: Lens' MedicalTranscriptionJobSummary (Maybe Specialty)

Provides the medical specialty represented in your media.

medicalTranscriptionJobSummary_startTime :: Lens' MedicalTranscriptionJobSummary (Maybe UTCTime)

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.

medicalTranscriptionJobSummary_transcriptionJobStatus :: Lens' MedicalTranscriptionJobSummary (Maybe TranscriptionJobStatus)

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.

medicalTranscriptionJobSummary_type :: Lens' MedicalTranscriptionJobSummary (Maybe Type)

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