/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace TranscribeService { namespace Model { /** *

Provides detailed information about a specific medical transcription * job.

*/ class MedicalTranscriptionJobSummary { public: AWS_TRANSCRIBESERVICE_API MedicalTranscriptionJobSummary(); AWS_TRANSCRIBESERVICE_API MedicalTranscriptionJobSummary(Aws::Utils::Json::JsonView jsonValue); AWS_TRANSCRIBESERVICE_API MedicalTranscriptionJobSummary& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_TRANSCRIBESERVICE_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

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

*/ inline const Aws::String& GetMedicalTranscriptionJobName() const{ return m_medicalTranscriptionJobName; } /** *

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

*/ inline bool MedicalTranscriptionJobNameHasBeenSet() const { return m_medicalTranscriptionJobNameHasBeenSet; } /** *

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

*/ inline void SetMedicalTranscriptionJobName(const Aws::String& value) { m_medicalTranscriptionJobNameHasBeenSet = true; m_medicalTranscriptionJobName = value; } /** *

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

*/ inline void SetMedicalTranscriptionJobName(Aws::String&& value) { m_medicalTranscriptionJobNameHasBeenSet = true; m_medicalTranscriptionJobName = std::move(value); } /** *

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

*/ inline void SetMedicalTranscriptionJobName(const char* value) { m_medicalTranscriptionJobNameHasBeenSet = true; m_medicalTranscriptionJobName.assign(value); } /** *

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

*/ inline MedicalTranscriptionJobSummary& WithMedicalTranscriptionJobName(const Aws::String& value) { SetMedicalTranscriptionJobName(value); return *this;} /** *

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

*/ inline MedicalTranscriptionJobSummary& WithMedicalTranscriptionJobName(Aws::String&& value) { SetMedicalTranscriptionJobName(std::move(value)); return *this;} /** *

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

*/ inline MedicalTranscriptionJobSummary& WithMedicalTranscriptionJobName(const char* value) { SetMedicalTranscriptionJobName(value); return *this;} /** *

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.

*/ inline const Aws::Utils::DateTime& GetCreationTime() const{ return m_creationTime; } /** *

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

*/ inline bool CreationTimeHasBeenSet() const { return m_creationTimeHasBeenSet; } /** *

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

*/ inline void SetCreationTime(const Aws::Utils::DateTime& value) { m_creationTimeHasBeenSet = true; m_creationTime = value; } /** *

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

*/ inline void SetCreationTime(Aws::Utils::DateTime&& value) { m_creationTimeHasBeenSet = true; m_creationTime = std::move(value); } /** *

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

*/ inline MedicalTranscriptionJobSummary& WithCreationTime(const Aws::Utils::DateTime& value) { SetCreationTime(value); return *this;} /** *

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

*/ inline MedicalTranscriptionJobSummary& WithCreationTime(Aws::Utils::DateTime&& value) { SetCreationTime(std::move(value)); return *this;} /** *

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.

*/ inline const Aws::Utils::DateTime& GetStartTime() const{ return m_startTime; } /** *

The date and time your medical transcription job began processing.

*/ inline bool StartTimeHasBeenSet() const { return m_startTimeHasBeenSet; } /** *

The date and time your medical transcription job began processing.

*/ inline void SetStartTime(const Aws::Utils::DateTime& value) { m_startTimeHasBeenSet = true; m_startTime = value; } /** *

The date and time your medical transcription job began processing.

*/ inline void SetStartTime(Aws::Utils::DateTime&& value) { m_startTimeHasBeenSet = true; m_startTime = std::move(value); } /** *

The date and time your medical transcription job began processing.

*/ inline MedicalTranscriptionJobSummary& WithStartTime(const Aws::Utils::DateTime& value) { SetStartTime(value); return *this;} /** *

The date and time your medical transcription job began processing.

*/ inline MedicalTranscriptionJobSummary& WithStartTime(Aws::Utils::DateTime&& value) { SetStartTime(std::move(value)); return *this;} /** *

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.

*/ inline const Aws::Utils::DateTime& GetCompletionTime() const{ return m_completionTime; } /** *

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

*/ inline bool CompletionTimeHasBeenSet() const { return m_completionTimeHasBeenSet; } /** *

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

*/ inline void SetCompletionTime(const Aws::Utils::DateTime& value) { m_completionTimeHasBeenSet = true; m_completionTime = value; } /** *

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

*/ inline void SetCompletionTime(Aws::Utils::DateTime&& value) { m_completionTimeHasBeenSet = true; m_completionTime = std::move(value); } /** *

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

*/ inline MedicalTranscriptionJobSummary& WithCompletionTime(const Aws::Utils::DateTime& value) { SetCompletionTime(value); return *this;} /** *

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

*/ inline MedicalTranscriptionJobSummary& WithCompletionTime(Aws::Utils::DateTime&& value) { SetCompletionTime(std::move(value)); return *this;} /** *

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

*/ inline const LanguageCode& GetLanguageCode() const{ return m_languageCode; } /** *

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

*/ inline bool LanguageCodeHasBeenSet() const { return m_languageCodeHasBeenSet; } /** *

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

*/ inline void SetLanguageCode(const LanguageCode& value) { m_languageCodeHasBeenSet = true; m_languageCode = value; } /** *

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

*/ inline void SetLanguageCode(LanguageCode&& value) { m_languageCodeHasBeenSet = true; m_languageCode = std::move(value); } /** *

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

*/ inline MedicalTranscriptionJobSummary& WithLanguageCode(const LanguageCode& value) { SetLanguageCode(value); return *this;} /** *

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

*/ inline MedicalTranscriptionJobSummary& WithLanguageCode(LanguageCode&& value) { SetLanguageCode(std::move(value)); return *this;} /** *

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.

*/ inline const TranscriptionJobStatus& GetTranscriptionJobStatus() const{ return m_transcriptionJobStatus; } /** *

Provides the status of your medical transcription job.

*/ inline bool TranscriptionJobStatusHasBeenSet() const { return m_transcriptionJobStatusHasBeenSet; } /** *

Provides the status of your medical transcription job.

*/ inline void SetTranscriptionJobStatus(const TranscriptionJobStatus& value) { m_transcriptionJobStatusHasBeenSet = true; m_transcriptionJobStatus = value; } /** *

Provides the status of your medical transcription job.

*/ inline void SetTranscriptionJobStatus(TranscriptionJobStatus&& value) { m_transcriptionJobStatusHasBeenSet = true; m_transcriptionJobStatus = std::move(value); } /** *

Provides the status of your medical transcription job.

*/ inline MedicalTranscriptionJobSummary& WithTranscriptionJobStatus(const TranscriptionJobStatus& value) { SetTranscriptionJobStatus(value); return *this;} /** *

Provides the status of your medical transcription job.

*/ inline MedicalTranscriptionJobSummary& WithTranscriptionJobStatus(TranscriptionJobStatus&& value) { SetTranscriptionJobStatus(std::move(value)); return *this;} /** *

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

*/ inline const Aws::String& GetFailureReason() const{ return m_failureReason; } /** *

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

*/ inline bool FailureReasonHasBeenSet() const { return m_failureReasonHasBeenSet; } /** *

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

*/ inline void SetFailureReason(const Aws::String& value) { m_failureReasonHasBeenSet = true; m_failureReason = value; } /** *

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

*/ inline void SetFailureReason(Aws::String&& value) { m_failureReasonHasBeenSet = true; m_failureReason = std::move(value); } /** *

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

*/ inline void SetFailureReason(const char* value) { m_failureReasonHasBeenSet = true; m_failureReason.assign(value); } /** *

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

*/ inline MedicalTranscriptionJobSummary& WithFailureReason(const Aws::String& value) { SetFailureReason(value); return *this;} /** *

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

*/ inline MedicalTranscriptionJobSummary& WithFailureReason(Aws::String&& value) { SetFailureReason(std::move(value)); return *this;} /** *

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

*/ inline MedicalTranscriptionJobSummary& WithFailureReason(const char* value) { SetFailureReason(value); return *this;} /** *

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.

*/ inline const OutputLocationType& GetOutputLocationType() const{ return m_outputLocationType; } /** *

Indicates where the specified medical transcription output is stored.

*/ inline bool OutputLocationTypeHasBeenSet() const { return m_outputLocationTypeHasBeenSet; } /** *

Indicates where the specified medical transcription output is stored.

*/ inline void SetOutputLocationType(const OutputLocationType& value) { m_outputLocationTypeHasBeenSet = true; m_outputLocationType = value; } /** *

Indicates where the specified medical transcription output is stored.

*/ inline void SetOutputLocationType(OutputLocationType&& value) { m_outputLocationTypeHasBeenSet = true; m_outputLocationType = std::move(value); } /** *

Indicates where the specified medical transcription output is stored.

*/ inline MedicalTranscriptionJobSummary& WithOutputLocationType(const OutputLocationType& value) { SetOutputLocationType(value); return *this;} /** *

Indicates where the specified medical transcription output is stored.

*/ inline MedicalTranscriptionJobSummary& WithOutputLocationType(OutputLocationType&& value) { SetOutputLocationType(std::move(value)); return *this;} /** *

Provides the medical specialty represented in your media.

*/ inline const Specialty& GetSpecialty() const{ return m_specialty; } /** *

Provides the medical specialty represented in your media.

*/ inline bool SpecialtyHasBeenSet() const { return m_specialtyHasBeenSet; } /** *

Provides the medical specialty represented in your media.

*/ inline void SetSpecialty(const Specialty& value) { m_specialtyHasBeenSet = true; m_specialty = value; } /** *

Provides the medical specialty represented in your media.

*/ inline void SetSpecialty(Specialty&& value) { m_specialtyHasBeenSet = true; m_specialty = std::move(value); } /** *

Provides the medical specialty represented in your media.

*/ inline MedicalTranscriptionJobSummary& WithSpecialty(const Specialty& value) { SetSpecialty(value); return *this;} /** *

Provides the medical specialty represented in your media.

*/ inline MedicalTranscriptionJobSummary& WithSpecialty(Specialty&& value) { SetSpecialty(std::move(value)); return *this;} /** *

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

*/ inline const MedicalContentIdentificationType& GetContentIdentificationType() const{ return m_contentIdentificationType; } /** *

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

*/ inline bool ContentIdentificationTypeHasBeenSet() const { return m_contentIdentificationTypeHasBeenSet; } /** *

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

*/ inline void SetContentIdentificationType(const MedicalContentIdentificationType& value) { m_contentIdentificationTypeHasBeenSet = true; m_contentIdentificationType = value; } /** *

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

*/ inline void SetContentIdentificationType(MedicalContentIdentificationType&& value) { m_contentIdentificationTypeHasBeenSet = true; m_contentIdentificationType = std::move(value); } /** *

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

*/ inline MedicalTranscriptionJobSummary& WithContentIdentificationType(const MedicalContentIdentificationType& value) { SetContentIdentificationType(value); return *this;} /** *

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

*/ inline MedicalTranscriptionJobSummary& WithContentIdentificationType(MedicalContentIdentificationType&& value) { SetContentIdentificationType(std::move(value)); return *this;} /** *

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

*/ inline const Type& GetType() const{ return m_type; } /** *

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

*/ inline bool TypeHasBeenSet() const { return m_typeHasBeenSet; } /** *

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

*/ inline void SetType(const Type& value) { m_typeHasBeenSet = true; m_type = value; } /** *

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

*/ inline void SetType(Type&& value) { m_typeHasBeenSet = true; m_type = std::move(value); } /** *

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

*/ inline MedicalTranscriptionJobSummary& WithType(const Type& value) { SetType(value); return *this;} /** *

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

*/ inline MedicalTranscriptionJobSummary& WithType(Type&& value) { SetType(std::move(value)); return *this;} private: Aws::String m_medicalTranscriptionJobName; bool m_medicalTranscriptionJobNameHasBeenSet = false; Aws::Utils::DateTime m_creationTime; bool m_creationTimeHasBeenSet = false; Aws::Utils::DateTime m_startTime; bool m_startTimeHasBeenSet = false; Aws::Utils::DateTime m_completionTime; bool m_completionTimeHasBeenSet = false; LanguageCode m_languageCode; bool m_languageCodeHasBeenSet = false; TranscriptionJobStatus m_transcriptionJobStatus; bool m_transcriptionJobStatusHasBeenSet = false; Aws::String m_failureReason; bool m_failureReasonHasBeenSet = false; OutputLocationType m_outputLocationType; bool m_outputLocationTypeHasBeenSet = false; Specialty m_specialty; bool m_specialtyHasBeenSet = false; MedicalContentIdentificationType m_contentIdentificationType; bool m_contentIdentificationTypeHasBeenSet = false; Type m_type; bool m_typeHasBeenSet = false; }; } // namespace Model } // namespace TranscribeService } // namespace Aws

See Also: