AWS SDK for C++  1.9.153
AWS SDK for C++
Public Member Functions | List of all members
Aws::TranscribeService::Model::MedicalTranscriptionJob Class Reference

#include <MedicalTranscriptionJob.h>

Public Member Functions

 MedicalTranscriptionJob ()
 
 MedicalTranscriptionJob (Aws::Utils::Json::JsonView jsonValue)
 
MedicalTranscriptionJoboperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetMedicalTranscriptionJobName () const
 
bool MedicalTranscriptionJobNameHasBeenSet () const
 
void SetMedicalTranscriptionJobName (const Aws::String &value)
 
void SetMedicalTranscriptionJobName (Aws::String &&value)
 
void SetMedicalTranscriptionJobName (const char *value)
 
MedicalTranscriptionJobWithMedicalTranscriptionJobName (const Aws::String &value)
 
MedicalTranscriptionJobWithMedicalTranscriptionJobName (Aws::String &&value)
 
MedicalTranscriptionJobWithMedicalTranscriptionJobName (const char *value)
 
const TranscriptionJobStatusGetTranscriptionJobStatus () const
 
bool TranscriptionJobStatusHasBeenSet () const
 
void SetTranscriptionJobStatus (const TranscriptionJobStatus &value)
 
void SetTranscriptionJobStatus (TranscriptionJobStatus &&value)
 
MedicalTranscriptionJobWithTranscriptionJobStatus (const TranscriptionJobStatus &value)
 
MedicalTranscriptionJobWithTranscriptionJobStatus (TranscriptionJobStatus &&value)
 
const LanguageCodeGetLanguageCode () const
 
bool LanguageCodeHasBeenSet () const
 
void SetLanguageCode (const LanguageCode &value)
 
void SetLanguageCode (LanguageCode &&value)
 
MedicalTranscriptionJobWithLanguageCode (const LanguageCode &value)
 
MedicalTranscriptionJobWithLanguageCode (LanguageCode &&value)
 
int GetMediaSampleRateHertz () const
 
bool MediaSampleRateHertzHasBeenSet () const
 
void SetMediaSampleRateHertz (int value)
 
MedicalTranscriptionJobWithMediaSampleRateHertz (int value)
 
const MediaFormatGetMediaFormat () const
 
bool MediaFormatHasBeenSet () const
 
void SetMediaFormat (const MediaFormat &value)
 
void SetMediaFormat (MediaFormat &&value)
 
MedicalTranscriptionJobWithMediaFormat (const MediaFormat &value)
 
MedicalTranscriptionJobWithMediaFormat (MediaFormat &&value)
 
const MediaGetMedia () const
 
bool MediaHasBeenSet () const
 
void SetMedia (const Media &value)
 
void SetMedia (Media &&value)
 
MedicalTranscriptionJobWithMedia (const Media &value)
 
MedicalTranscriptionJobWithMedia (Media &&value)
 
const MedicalTranscriptGetTranscript () const
 
bool TranscriptHasBeenSet () const
 
void SetTranscript (const MedicalTranscript &value)
 
void SetTranscript (MedicalTranscript &&value)
 
MedicalTranscriptionJobWithTranscript (const MedicalTranscript &value)
 
MedicalTranscriptionJobWithTranscript (MedicalTranscript &&value)
 
const Aws::Utils::DateTimeGetStartTime () const
 
bool StartTimeHasBeenSet () const
 
void SetStartTime (const Aws::Utils::DateTime &value)
 
void SetStartTime (Aws::Utils::DateTime &&value)
 
MedicalTranscriptionJobWithStartTime (const Aws::Utils::DateTime &value)
 
MedicalTranscriptionJobWithStartTime (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetCreationTime () const
 
bool CreationTimeHasBeenSet () const
 
void SetCreationTime (const Aws::Utils::DateTime &value)
 
void SetCreationTime (Aws::Utils::DateTime &&value)
 
MedicalTranscriptionJobWithCreationTime (const Aws::Utils::DateTime &value)
 
MedicalTranscriptionJobWithCreationTime (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetCompletionTime () const
 
bool CompletionTimeHasBeenSet () const
 
void SetCompletionTime (const Aws::Utils::DateTime &value)
 
void SetCompletionTime (Aws::Utils::DateTime &&value)
 
MedicalTranscriptionJobWithCompletionTime (const Aws::Utils::DateTime &value)
 
MedicalTranscriptionJobWithCompletionTime (Aws::Utils::DateTime &&value)
 
const Aws::StringGetFailureReason () const
 
bool FailureReasonHasBeenSet () const
 
void SetFailureReason (const Aws::String &value)
 
void SetFailureReason (Aws::String &&value)
 
void SetFailureReason (const char *value)
 
MedicalTranscriptionJobWithFailureReason (const Aws::String &value)
 
MedicalTranscriptionJobWithFailureReason (Aws::String &&value)
 
MedicalTranscriptionJobWithFailureReason (const char *value)
 
const MedicalTranscriptionSettingGetSettings () const
 
bool SettingsHasBeenSet () const
 
void SetSettings (const MedicalTranscriptionSetting &value)
 
void SetSettings (MedicalTranscriptionSetting &&value)
 
MedicalTranscriptionJobWithSettings (const MedicalTranscriptionSetting &value)
 
MedicalTranscriptionJobWithSettings (MedicalTranscriptionSetting &&value)
 
const MedicalContentIdentificationTypeGetContentIdentificationType () const
 
bool ContentIdentificationTypeHasBeenSet () const
 
void SetContentIdentificationType (const MedicalContentIdentificationType &value)
 
void SetContentIdentificationType (MedicalContentIdentificationType &&value)
 
MedicalTranscriptionJobWithContentIdentificationType (const MedicalContentIdentificationType &value)
 
MedicalTranscriptionJobWithContentIdentificationType (MedicalContentIdentificationType &&value)
 
const SpecialtyGetSpecialty () const
 
bool SpecialtyHasBeenSet () const
 
void SetSpecialty (const Specialty &value)
 
void SetSpecialty (Specialty &&value)
 
MedicalTranscriptionJobWithSpecialty (const Specialty &value)
 
MedicalTranscriptionJobWithSpecialty (Specialty &&value)
 
const TypeGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const Type &value)
 
void SetType (Type &&value)
 
MedicalTranscriptionJobWithType (const Type &value)
 
MedicalTranscriptionJobWithType (Type &&value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
MedicalTranscriptionJobWithTags (const Aws::Vector< Tag > &value)
 
MedicalTranscriptionJobWithTags (Aws::Vector< Tag > &&value)
 
MedicalTranscriptionJobAddTags (const Tag &value)
 
MedicalTranscriptionJobAddTags (Tag &&value)
 

Detailed Description

The data structure that contains the information for a medical transcription job.

See Also:

AWS API Reference

Definition at line 44 of file MedicalTranscriptionJob.h.

Constructor & Destructor Documentation

◆ MedicalTranscriptionJob() [1/2]

Aws::TranscribeService::Model::MedicalTranscriptionJob::MedicalTranscriptionJob ( )

◆ MedicalTranscriptionJob() [2/2]

Aws::TranscribeService::Model::MedicalTranscriptionJob::MedicalTranscriptionJob ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddTags() [1/2]

MedicalTranscriptionJob& Aws::TranscribeService::Model::MedicalTranscriptionJob::AddTags ( const Tag value)
inline

A key:value pair assigned to a given medical transcription job.

Definition at line 875 of file MedicalTranscriptionJob.h.

◆ AddTags() [2/2]

MedicalTranscriptionJob& Aws::TranscribeService::Model::MedicalTranscriptionJob::AddTags ( Tag &&  value)
inline

A key:value pair assigned to a given medical transcription job.

Definition at line 880 of file MedicalTranscriptionJob.h.

◆ CompletionTimeHasBeenSet()

bool Aws::TranscribeService::Model::MedicalTranscriptionJob::CompletionTimeHasBeenSet ( ) const
inline

A timestamp that shows when the job was completed.

Definition at line 372 of file MedicalTranscriptionJob.h.

◆ ContentIdentificationTypeHasBeenSet()

bool Aws::TranscribeService::Model::MedicalTranscriptionJob::ContentIdentificationTypeHasBeenSet ( ) const
inline

Shows the type of content that you've configured Amazon Transcribe Medical to identify in a transcription job. If the value is PHI, you've configured the job to identify personal health information (PHI) in the transcription output.

Definition at line 697 of file MedicalTranscriptionJob.h.

◆ CreationTimeHasBeenSet()

bool Aws::TranscribeService::Model::MedicalTranscriptionJob::CreationTimeHasBeenSet ( ) const
inline

A timestamp that shows when the job was created.

Definition at line 341 of file MedicalTranscriptionJob.h.

◆ FailureReasonHasBeenSet()

bool Aws::TranscribeService::Model::MedicalTranscriptionJob::FailureReasonHasBeenSet ( ) const
inline

If the TranscriptionJobStatus field is FAILED, this field contains information about why the job failed.

The FailureReason field contains one of the following values:

  • Unsupported media format- The media format specified in the MediaFormat field of the request isn't valid. See the description of the MediaFormat field for a list of valid values.

  • The media format provided does not match the detected media format- The media format of the audio file doesn't match the format specified in the MediaFormat field in the request. Check the media format of your media file and make sure the two values match.

  • Invalid sample rate for audio file- The sample rate specified in the MediaSampleRateHertz of the request isn't valid. The sample rate must be between 8,000 and 48,000 Hertz.

  • The sample rate provided does not match the detected sample rate- The sample rate in the audio file doesn't match the sample rate specified in the MediaSampleRateHertz field in the request. Check the sample rate of your media file and make sure that the two values match.

  • Invalid file size: file size too large- The size of your audio file is larger than what Amazon Transcribe Medical can process. For more information, see Guidelines and Quotas in the Amazon Transcribe Medical Guide

  • Invalid number of channels: number of channels too large- Your audio contains more channels than Amazon Transcribe Medical is configured to process. To request additional channels, see Amazon Transcribe Medical Endpoints and Quotas in the Amazon Web Services General Reference

Definition at line 457 of file MedicalTranscriptionJob.h.

◆ GetCompletionTime()

const Aws::Utils::DateTime& Aws::TranscribeService::Model::MedicalTranscriptionJob::GetCompletionTime ( ) const
inline

A timestamp that shows when the job was completed.

Definition at line 367 of file MedicalTranscriptionJob.h.

◆ GetContentIdentificationType()

const MedicalContentIdentificationType& Aws::TranscribeService::Model::MedicalTranscriptionJob::GetContentIdentificationType ( ) const
inline

Shows the type of content that you've configured Amazon Transcribe Medical to identify in a transcription job. If the value is PHI, you've configured the job to identify personal health information (PHI) in the transcription output.

Definition at line 689 of file MedicalTranscriptionJob.h.

◆ GetCreationTime()

const Aws::Utils::DateTime& Aws::TranscribeService::Model::MedicalTranscriptionJob::GetCreationTime ( ) const
inline

A timestamp that shows when the job was created.

Definition at line 336 of file MedicalTranscriptionJob.h.

◆ GetFailureReason()

const Aws::String& Aws::TranscribeService::Model::MedicalTranscriptionJob::GetFailureReason ( ) const
inline

If the TranscriptionJobStatus field is FAILED, this field contains information about why the job failed.

The FailureReason field contains one of the following values:

  • Unsupported media format- The media format specified in the MediaFormat field of the request isn't valid. See the description of the MediaFormat field for a list of valid values.

  • The media format provided does not match the detected media format- The media format of the audio file doesn't match the format specified in the MediaFormat field in the request. Check the media format of your media file and make sure the two values match.

  • Invalid sample rate for audio file- The sample rate specified in the MediaSampleRateHertz of the request isn't valid. The sample rate must be between 8,000 and 48,000 Hertz.

  • The sample rate provided does not match the detected sample rate- The sample rate in the audio file doesn't match the sample rate specified in the MediaSampleRateHertz field in the request. Check the sample rate of your media file and make sure that the two values match.

  • Invalid file size: file size too large- The size of your audio file is larger than what Amazon Transcribe Medical can process. For more information, see Guidelines and Quotas in the Amazon Transcribe Medical Guide

  • Invalid number of channels: number of channels too large- Your audio contains more channels than Amazon Transcribe Medical is configured to process. To request additional channels, see Amazon Transcribe Medical Endpoints and Quotas in the Amazon Web Services General Reference

Definition at line 425 of file MedicalTranscriptionJob.h.

◆ GetLanguageCode()

const LanguageCode& Aws::TranscribeService::Model::MedicalTranscriptionJob::GetLanguageCode ( ) const
inline

The language code for the language spoken in the source audio file. US English (en-US) is the only supported language for medical transcriptions. Any other value you enter for language code results in a BadRequestException error.

Definition at line 131 of file MedicalTranscriptionJob.h.

◆ GetMedia()

const Media& Aws::TranscribeService::Model::MedicalTranscriptionJob::GetMedia ( ) const
inline

Definition at line 247 of file MedicalTranscriptionJob.h.

◆ GetMediaFormat()

const MediaFormat& Aws::TranscribeService::Model::MedicalTranscriptionJob::GetMediaFormat ( ) const
inline

The format of the input media file.

Definition at line 218 of file MedicalTranscriptionJob.h.

◆ GetMediaSampleRateHertz()

int Aws::TranscribeService::Model::MedicalTranscriptionJob::GetMediaSampleRateHertz ( ) const
inline

The sample rate, in Hertz, of the source audio containing medical information.

If you don't specify the sample rate, Amazon Transcribe Medical determines it for you. If you choose to specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you should leave the MedicalMediaSampleHertz blank and let Amazon Transcribe Medical determine the sample rate.

Definition at line 182 of file MedicalTranscriptionJob.h.

◆ GetMedicalTranscriptionJobName()

const Aws::String& Aws::TranscribeService::Model::MedicalTranscriptionJob::GetMedicalTranscriptionJobName ( ) const
inline

The name for a given medical transcription job.

Definition at line 56 of file MedicalTranscriptionJob.h.

◆ GetSettings()

const MedicalTranscriptionSetting& Aws::TranscribeService::Model::MedicalTranscriptionJob::GetSettings ( ) const
inline

Object that contains object.

Definition at line 655 of file MedicalTranscriptionJob.h.

◆ GetSpecialty()

const Specialty& Aws::TranscribeService::Model::MedicalTranscriptionJob::GetSpecialty ( ) const
inline

The medical specialty of any clinicians providing a dictation or having a conversation. Refer to Transcribing a medical conversationfor a list of supported specialties.

Definition at line 738 of file MedicalTranscriptionJob.h.

◆ GetStartTime()

const Aws::Utils::DateTime& Aws::TranscribeService::Model::MedicalTranscriptionJob::GetStartTime ( ) const
inline

A timestamp that shows when the job started processing.

Definition at line 305 of file MedicalTranscriptionJob.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::TranscribeService::Model::MedicalTranscriptionJob::GetTags ( ) const
inline

A key:value pair assigned to a given medical transcription job.

Definition at line 845 of file MedicalTranscriptionJob.h.

◆ GetTranscript()

const MedicalTranscript& Aws::TranscribeService::Model::MedicalTranscriptionJob::GetTranscript ( ) const
inline

An object that contains the MedicalTranscript. The MedicalTranscript contains the TranscriptFileUri.

Definition at line 269 of file MedicalTranscriptionJob.h.

◆ GetTranscriptionJobStatus()

const TranscriptionJobStatus& Aws::TranscribeService::Model::MedicalTranscriptionJob::GetTranscriptionJobStatus ( ) const
inline

The completion status of a medical transcription job.

Definition at line 97 of file MedicalTranscriptionJob.h.

◆ GetType()

const Type& Aws::TranscribeService::Model::MedicalTranscriptionJob::GetType ( ) const
inline

The type of speech in the transcription job. CONVERSATION is generally used for patient-physician dialogues. DICTATION is the setting for physicians speaking their notes after seeing a patient. For more information, see What is Amazon Transcribe Medical?.

Definition at line 789 of file MedicalTranscriptionJob.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::TranscribeService::Model::MedicalTranscriptionJob::Jsonize ( ) const

◆ LanguageCodeHasBeenSet()

bool Aws::TranscribeService::Model::MedicalTranscriptionJob::LanguageCodeHasBeenSet ( ) const
inline

The language code for the language spoken in the source audio file. US English (en-US) is the only supported language for medical transcriptions. Any other value you enter for language code results in a BadRequestException error.

Definition at line 139 of file MedicalTranscriptionJob.h.

◆ MediaFormatHasBeenSet()

bool Aws::TranscribeService::Model::MedicalTranscriptionJob::MediaFormatHasBeenSet ( ) const
inline

The format of the input media file.

Definition at line 223 of file MedicalTranscriptionJob.h.

◆ MediaHasBeenSet()

bool Aws::TranscribeService::Model::MedicalTranscriptionJob::MediaHasBeenSet ( ) const
inline

Definition at line 250 of file MedicalTranscriptionJob.h.

◆ MediaSampleRateHertzHasBeenSet()

bool Aws::TranscribeService::Model::MedicalTranscriptionJob::MediaSampleRateHertzHasBeenSet ( ) const
inline

The sample rate, in Hertz, of the source audio containing medical information.

If you don't specify the sample rate, Amazon Transcribe Medical determines it for you. If you choose to specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you should leave the MedicalMediaSampleHertz blank and let Amazon Transcribe Medical determine the sample rate.

Definition at line 192 of file MedicalTranscriptionJob.h.

◆ MedicalTranscriptionJobNameHasBeenSet()

bool Aws::TranscribeService::Model::MedicalTranscriptionJob::MedicalTranscriptionJobNameHasBeenSet ( ) const
inline

The name for a given medical transcription job.

Definition at line 61 of file MedicalTranscriptionJob.h.

◆ operator=()

MedicalTranscriptionJob& Aws::TranscribeService::Model::MedicalTranscriptionJob::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetCompletionTime() [1/2]

void Aws::TranscribeService::Model::MedicalTranscriptionJob::SetCompletionTime ( Aws::Utils::DateTime &&  value)
inline

A timestamp that shows when the job was completed.

Definition at line 382 of file MedicalTranscriptionJob.h.

◆ SetCompletionTime() [2/2]

void Aws::TranscribeService::Model::MedicalTranscriptionJob::SetCompletionTime ( const Aws::Utils::DateTime value)
inline

A timestamp that shows when the job was completed.

Definition at line 377 of file MedicalTranscriptionJob.h.

◆ SetContentIdentificationType() [1/2]

void Aws::TranscribeService::Model::MedicalTranscriptionJob::SetContentIdentificationType ( const MedicalContentIdentificationType value)
inline

Shows the type of content that you've configured Amazon Transcribe Medical to identify in a transcription job. If the value is PHI, you've configured the job to identify personal health information (PHI) in the transcription output.

Definition at line 705 of file MedicalTranscriptionJob.h.

◆ SetContentIdentificationType() [2/2]

void Aws::TranscribeService::Model::MedicalTranscriptionJob::SetContentIdentificationType ( MedicalContentIdentificationType &&  value)
inline

Shows the type of content that you've configured Amazon Transcribe Medical to identify in a transcription job. If the value is PHI, you've configured the job to identify personal health information (PHI) in the transcription output.

Definition at line 713 of file MedicalTranscriptionJob.h.

◆ SetCreationTime() [1/2]

void Aws::TranscribeService::Model::MedicalTranscriptionJob::SetCreationTime ( Aws::Utils::DateTime &&  value)
inline

A timestamp that shows when the job was created.

Definition at line 351 of file MedicalTranscriptionJob.h.

◆ SetCreationTime() [2/2]

void Aws::TranscribeService::Model::MedicalTranscriptionJob::SetCreationTime ( const Aws::Utils::DateTime value)
inline

A timestamp that shows when the job was created.

Definition at line 346 of file MedicalTranscriptionJob.h.

◆ SetFailureReason() [1/3]

void Aws::TranscribeService::Model::MedicalTranscriptionJob::SetFailureReason ( Aws::String &&  value)
inline

If the TranscriptionJobStatus field is FAILED, this field contains information about why the job failed.

The FailureReason field contains one of the following values:

  • Unsupported media format- The media format specified in the MediaFormat field of the request isn't valid. See the description of the MediaFormat field for a list of valid values.

  • The media format provided does not match the detected media format- The media format of the audio file doesn't match the format specified in the MediaFormat field in the request. Check the media format of your media file and make sure the two values match.

  • Invalid sample rate for audio file- The sample rate specified in the MediaSampleRateHertz of the request isn't valid. The sample rate must be between 8,000 and 48,000 Hertz.

  • The sample rate provided does not match the detected sample rate- The sample rate in the audio file doesn't match the sample rate specified in the MediaSampleRateHertz field in the request. Check the sample rate of your media file and make sure that the two values match.

  • Invalid file size: file size too large- The size of your audio file is larger than what Amazon Transcribe Medical can process. For more information, see Guidelines and Quotas in the Amazon Transcribe Medical Guide

  • Invalid number of channels: number of channels too large- Your audio contains more channels than Amazon Transcribe Medical is configured to process. To request additional channels, see Amazon Transcribe Medical Endpoints and Quotas in the Amazon Web Services General Reference

Definition at line 521 of file MedicalTranscriptionJob.h.

◆ SetFailureReason() [2/3]

void Aws::TranscribeService::Model::MedicalTranscriptionJob::SetFailureReason ( const Aws::String value)
inline

If the TranscriptionJobStatus field is FAILED, this field contains information about why the job failed.

The FailureReason field contains one of the following values:

  • Unsupported media format- The media format specified in the MediaFormat field of the request isn't valid. See the description of the MediaFormat field for a list of valid values.

  • The media format provided does not match the detected media format- The media format of the audio file doesn't match the format specified in the MediaFormat field in the request. Check the media format of your media file and make sure the two values match.

  • Invalid sample rate for audio file- The sample rate specified in the MediaSampleRateHertz of the request isn't valid. The sample rate must be between 8,000 and 48,000 Hertz.

  • The sample rate provided does not match the detected sample rate- The sample rate in the audio file doesn't match the sample rate specified in the MediaSampleRateHertz field in the request. Check the sample rate of your media file and make sure that the two values match.

  • Invalid file size: file size too large- The size of your audio file is larger than what Amazon Transcribe Medical can process. For more information, see Guidelines and Quotas in the Amazon Transcribe Medical Guide

  • Invalid number of channels: number of channels too large- Your audio contains more channels than Amazon Transcribe Medical is configured to process. To request additional channels, see Amazon Transcribe Medical Endpoints and Quotas in the Amazon Web Services General Reference

Definition at line 489 of file MedicalTranscriptionJob.h.

◆ SetFailureReason() [3/3]

void Aws::TranscribeService::Model::MedicalTranscriptionJob::SetFailureReason ( const char *  value)
inline

If the TranscriptionJobStatus field is FAILED, this field contains information about why the job failed.

The FailureReason field contains one of the following values:

  • Unsupported media format- The media format specified in the MediaFormat field of the request isn't valid. See the description of the MediaFormat field for a list of valid values.

  • The media format provided does not match the detected media format- The media format of the audio file doesn't match the format specified in the MediaFormat field in the request. Check the media format of your media file and make sure the two values match.

  • Invalid sample rate for audio file- The sample rate specified in the MediaSampleRateHertz of the request isn't valid. The sample rate must be between 8,000 and 48,000 Hertz.

  • The sample rate provided does not match the detected sample rate- The sample rate in the audio file doesn't match the sample rate specified in the MediaSampleRateHertz field in the request. Check the sample rate of your media file and make sure that the two values match.

  • Invalid file size: file size too large- The size of your audio file is larger than what Amazon Transcribe Medical can process. For more information, see Guidelines and Quotas in the Amazon Transcribe Medical Guide

  • Invalid number of channels: number of channels too large- Your audio contains more channels than Amazon Transcribe Medical is configured to process. To request additional channels, see Amazon Transcribe Medical Endpoints and Quotas in the Amazon Web Services General Reference

Definition at line 553 of file MedicalTranscriptionJob.h.

◆ SetLanguageCode() [1/2]

void Aws::TranscribeService::Model::MedicalTranscriptionJob::SetLanguageCode ( const LanguageCode value)
inline

The language code for the language spoken in the source audio file. US English (en-US) is the only supported language for medical transcriptions. Any other value you enter for language code results in a BadRequestException error.

Definition at line 147 of file MedicalTranscriptionJob.h.

◆ SetLanguageCode() [2/2]

void Aws::TranscribeService::Model::MedicalTranscriptionJob::SetLanguageCode ( LanguageCode &&  value)
inline

The language code for the language spoken in the source audio file. US English (en-US) is the only supported language for medical transcriptions. Any other value you enter for language code results in a BadRequestException error.

Definition at line 155 of file MedicalTranscriptionJob.h.

◆ SetMedia() [1/2]

void Aws::TranscribeService::Model::MedicalTranscriptionJob::SetMedia ( const Media value)
inline

Definition at line 253 of file MedicalTranscriptionJob.h.

◆ SetMedia() [2/2]

void Aws::TranscribeService::Model::MedicalTranscriptionJob::SetMedia ( Media &&  value)
inline

Definition at line 256 of file MedicalTranscriptionJob.h.

◆ SetMediaFormat() [1/2]

void Aws::TranscribeService::Model::MedicalTranscriptionJob::SetMediaFormat ( const MediaFormat value)
inline

The format of the input media file.

Definition at line 228 of file MedicalTranscriptionJob.h.

◆ SetMediaFormat() [2/2]

void Aws::TranscribeService::Model::MedicalTranscriptionJob::SetMediaFormat ( MediaFormat &&  value)
inline

The format of the input media file.

Definition at line 233 of file MedicalTranscriptionJob.h.

◆ SetMediaSampleRateHertz()

void Aws::TranscribeService::Model::MedicalTranscriptionJob::SetMediaSampleRateHertz ( int  value)
inline

The sample rate, in Hertz, of the source audio containing medical information.

If you don't specify the sample rate, Amazon Transcribe Medical determines it for you. If you choose to specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you should leave the MedicalMediaSampleHertz blank and let Amazon Transcribe Medical determine the sample rate.

Definition at line 202 of file MedicalTranscriptionJob.h.

◆ SetMedicalTranscriptionJobName() [1/3]

void Aws::TranscribeService::Model::MedicalTranscriptionJob::SetMedicalTranscriptionJobName ( Aws::String &&  value)
inline

The name for a given medical transcription job.

Definition at line 71 of file MedicalTranscriptionJob.h.

◆ SetMedicalTranscriptionJobName() [2/3]

void Aws::TranscribeService::Model::MedicalTranscriptionJob::SetMedicalTranscriptionJobName ( const Aws::String value)
inline

The name for a given medical transcription job.

Definition at line 66 of file MedicalTranscriptionJob.h.

◆ SetMedicalTranscriptionJobName() [3/3]

void Aws::TranscribeService::Model::MedicalTranscriptionJob::SetMedicalTranscriptionJobName ( const char *  value)
inline

The name for a given medical transcription job.

Definition at line 76 of file MedicalTranscriptionJob.h.

◆ SetSettings() [1/2]

void Aws::TranscribeService::Model::MedicalTranscriptionJob::SetSettings ( const MedicalTranscriptionSetting value)
inline

Object that contains object.

Definition at line 665 of file MedicalTranscriptionJob.h.

◆ SetSettings() [2/2]

void Aws::TranscribeService::Model::MedicalTranscriptionJob::SetSettings ( MedicalTranscriptionSetting &&  value)
inline

Object that contains object.

Definition at line 670 of file MedicalTranscriptionJob.h.

◆ SetSpecialty() [1/2]

void Aws::TranscribeService::Model::MedicalTranscriptionJob::SetSpecialty ( const Specialty value)
inline

The medical specialty of any clinicians providing a dictation or having a conversation. Refer to Transcribing a medical conversationfor a list of supported specialties.

Definition at line 754 of file MedicalTranscriptionJob.h.

◆ SetSpecialty() [2/2]

void Aws::TranscribeService::Model::MedicalTranscriptionJob::SetSpecialty ( Specialty &&  value)
inline

The medical specialty of any clinicians providing a dictation or having a conversation. Refer to Transcribing a medical conversationfor a list of supported specialties.

Definition at line 762 of file MedicalTranscriptionJob.h.

◆ SetStartTime() [1/2]

void Aws::TranscribeService::Model::MedicalTranscriptionJob::SetStartTime ( Aws::Utils::DateTime &&  value)
inline

A timestamp that shows when the job started processing.

Definition at line 320 of file MedicalTranscriptionJob.h.

◆ SetStartTime() [2/2]

void Aws::TranscribeService::Model::MedicalTranscriptionJob::SetStartTime ( const Aws::Utils::DateTime value)
inline

A timestamp that shows when the job started processing.

Definition at line 315 of file MedicalTranscriptionJob.h.

◆ SetTags() [1/2]

void Aws::TranscribeService::Model::MedicalTranscriptionJob::SetTags ( Aws::Vector< Tag > &&  value)
inline

A key:value pair assigned to a given medical transcription job.

Definition at line 860 of file MedicalTranscriptionJob.h.

◆ SetTags() [2/2]

void Aws::TranscribeService::Model::MedicalTranscriptionJob::SetTags ( const Aws::Vector< Tag > &  value)
inline

A key:value pair assigned to a given medical transcription job.

Definition at line 855 of file MedicalTranscriptionJob.h.

◆ SettingsHasBeenSet()

bool Aws::TranscribeService::Model::MedicalTranscriptionJob::SettingsHasBeenSet ( ) const
inline

Object that contains object.

Definition at line 660 of file MedicalTranscriptionJob.h.

◆ SetTranscript() [1/2]

void Aws::TranscribeService::Model::MedicalTranscriptionJob::SetTranscript ( const MedicalTranscript value)
inline

An object that contains the MedicalTranscript. The MedicalTranscript contains the TranscriptFileUri.

Definition at line 281 of file MedicalTranscriptionJob.h.

◆ SetTranscript() [2/2]

void Aws::TranscribeService::Model::MedicalTranscriptionJob::SetTranscript ( MedicalTranscript &&  value)
inline

An object that contains the MedicalTranscript. The MedicalTranscript contains the TranscriptFileUri.

Definition at line 287 of file MedicalTranscriptionJob.h.

◆ SetTranscriptionJobStatus() [1/2]

void Aws::TranscribeService::Model::MedicalTranscriptionJob::SetTranscriptionJobStatus ( const TranscriptionJobStatus value)
inline

The completion status of a medical transcription job.

Definition at line 107 of file MedicalTranscriptionJob.h.

◆ SetTranscriptionJobStatus() [2/2]

void Aws::TranscribeService::Model::MedicalTranscriptionJob::SetTranscriptionJobStatus ( TranscriptionJobStatus &&  value)
inline

The completion status of a medical transcription job.

Definition at line 112 of file MedicalTranscriptionJob.h.

◆ SetType() [1/2]

void Aws::TranscribeService::Model::MedicalTranscriptionJob::SetType ( const Type value)
inline

The type of speech in the transcription job. CONVERSATION is generally used for patient-physician dialogues. DICTATION is the setting for physicians speaking their notes after seeing a patient. For more information, see What is Amazon Transcribe Medical?.

Definition at line 809 of file MedicalTranscriptionJob.h.

◆ SetType() [2/2]

void Aws::TranscribeService::Model::MedicalTranscriptionJob::SetType ( Type &&  value)
inline

The type of speech in the transcription job. CONVERSATION is generally used for patient-physician dialogues. DICTATION is the setting for physicians speaking their notes after seeing a patient. For more information, see What is Amazon Transcribe Medical?.

Definition at line 819 of file MedicalTranscriptionJob.h.

◆ SpecialtyHasBeenSet()

bool Aws::TranscribeService::Model::MedicalTranscriptionJob::SpecialtyHasBeenSet ( ) const
inline

The medical specialty of any clinicians providing a dictation or having a conversation. Refer to Transcribing a medical conversationfor a list of supported specialties.

Definition at line 746 of file MedicalTranscriptionJob.h.

◆ StartTimeHasBeenSet()

bool Aws::TranscribeService::Model::MedicalTranscriptionJob::StartTimeHasBeenSet ( ) const
inline

A timestamp that shows when the job started processing.

Definition at line 310 of file MedicalTranscriptionJob.h.

◆ TagsHasBeenSet()

bool Aws::TranscribeService::Model::MedicalTranscriptionJob::TagsHasBeenSet ( ) const
inline

A key:value pair assigned to a given medical transcription job.

Definition at line 850 of file MedicalTranscriptionJob.h.

◆ TranscriptHasBeenSet()

bool Aws::TranscribeService::Model::MedicalTranscriptionJob::TranscriptHasBeenSet ( ) const
inline

An object that contains the MedicalTranscript. The MedicalTranscript contains the TranscriptFileUri.

Definition at line 275 of file MedicalTranscriptionJob.h.

◆ TranscriptionJobStatusHasBeenSet()

bool Aws::TranscribeService::Model::MedicalTranscriptionJob::TranscriptionJobStatusHasBeenSet ( ) const
inline

The completion status of a medical transcription job.

Definition at line 102 of file MedicalTranscriptionJob.h.

◆ TypeHasBeenSet()

bool Aws::TranscribeService::Model::MedicalTranscriptionJob::TypeHasBeenSet ( ) const
inline

The type of speech in the transcription job. CONVERSATION is generally used for patient-physician dialogues. DICTATION is the setting for physicians speaking their notes after seeing a patient. For more information, see What is Amazon Transcribe Medical?.

Definition at line 799 of file MedicalTranscriptionJob.h.

◆ WithCompletionTime() [1/2]

MedicalTranscriptionJob& Aws::TranscribeService::Model::MedicalTranscriptionJob::WithCompletionTime ( Aws::Utils::DateTime &&  value)
inline

A timestamp that shows when the job was completed.

Definition at line 392 of file MedicalTranscriptionJob.h.

◆ WithCompletionTime() [2/2]

MedicalTranscriptionJob& Aws::TranscribeService::Model::MedicalTranscriptionJob::WithCompletionTime ( const Aws::Utils::DateTime value)
inline

A timestamp that shows when the job was completed.

Definition at line 387 of file MedicalTranscriptionJob.h.

◆ WithContentIdentificationType() [1/2]

MedicalTranscriptionJob& Aws::TranscribeService::Model::MedicalTranscriptionJob::WithContentIdentificationType ( const MedicalContentIdentificationType value)
inline

Shows the type of content that you've configured Amazon Transcribe Medical to identify in a transcription job. If the value is PHI, you've configured the job to identify personal health information (PHI) in the transcription output.

Definition at line 721 of file MedicalTranscriptionJob.h.

◆ WithContentIdentificationType() [2/2]

MedicalTranscriptionJob& Aws::TranscribeService::Model::MedicalTranscriptionJob::WithContentIdentificationType ( MedicalContentIdentificationType &&  value)
inline

Shows the type of content that you've configured Amazon Transcribe Medical to identify in a transcription job. If the value is PHI, you've configured the job to identify personal health information (PHI) in the transcription output.

Definition at line 729 of file MedicalTranscriptionJob.h.

◆ WithCreationTime() [1/2]

MedicalTranscriptionJob& Aws::TranscribeService::Model::MedicalTranscriptionJob::WithCreationTime ( Aws::Utils::DateTime &&  value)
inline

A timestamp that shows when the job was created.

Definition at line 361 of file MedicalTranscriptionJob.h.

◆ WithCreationTime() [2/2]

MedicalTranscriptionJob& Aws::TranscribeService::Model::MedicalTranscriptionJob::WithCreationTime ( const Aws::Utils::DateTime value)
inline

A timestamp that shows when the job was created.

Definition at line 356 of file MedicalTranscriptionJob.h.

◆ WithFailureReason() [1/3]

MedicalTranscriptionJob& Aws::TranscribeService::Model::MedicalTranscriptionJob::WithFailureReason ( Aws::String &&  value)
inline

If the TranscriptionJobStatus field is FAILED, this field contains information about why the job failed.

The FailureReason field contains one of the following values:

  • Unsupported media format- The media format specified in the MediaFormat field of the request isn't valid. See the description of the MediaFormat field for a list of valid values.

  • The media format provided does not match the detected media format- The media format of the audio file doesn't match the format specified in the MediaFormat field in the request. Check the media format of your media file and make sure the two values match.

  • Invalid sample rate for audio file- The sample rate specified in the MediaSampleRateHertz of the request isn't valid. The sample rate must be between 8,000 and 48,000 Hertz.

  • The sample rate provided does not match the detected sample rate- The sample rate in the audio file doesn't match the sample rate specified in the MediaSampleRateHertz field in the request. Check the sample rate of your media file and make sure that the two values match.

  • Invalid file size: file size too large- The size of your audio file is larger than what Amazon Transcribe Medical can process. For more information, see Guidelines and Quotas in the Amazon Transcribe Medical Guide

  • Invalid number of channels: number of channels too large- Your audio contains more channels than Amazon Transcribe Medical is configured to process. To request additional channels, see Amazon Transcribe Medical Endpoints and Quotas in the Amazon Web Services General Reference

Definition at line 617 of file MedicalTranscriptionJob.h.

◆ WithFailureReason() [2/3]

MedicalTranscriptionJob& Aws::TranscribeService::Model::MedicalTranscriptionJob::WithFailureReason ( const Aws::String value)
inline

If the TranscriptionJobStatus field is FAILED, this field contains information about why the job failed.

The FailureReason field contains one of the following values:

  • Unsupported media format- The media format specified in the MediaFormat field of the request isn't valid. See the description of the MediaFormat field for a list of valid values.

  • The media format provided does not match the detected media format- The media format of the audio file doesn't match the format specified in the MediaFormat field in the request. Check the media format of your media file and make sure the two values match.

  • Invalid sample rate for audio file- The sample rate specified in the MediaSampleRateHertz of the request isn't valid. The sample rate must be between 8,000 and 48,000 Hertz.

  • The sample rate provided does not match the detected sample rate- The sample rate in the audio file doesn't match the sample rate specified in the MediaSampleRateHertz field in the request. Check the sample rate of your media file and make sure that the two values match.

  • Invalid file size: file size too large- The size of your audio file is larger than what Amazon Transcribe Medical can process. For more information, see Guidelines and Quotas in the Amazon Transcribe Medical Guide

  • Invalid number of channels: number of channels too large- Your audio contains more channels than Amazon Transcribe Medical is configured to process. To request additional channels, see Amazon Transcribe Medical Endpoints and Quotas in the Amazon Web Services General Reference

Definition at line 585 of file MedicalTranscriptionJob.h.

◆ WithFailureReason() [3/3]

MedicalTranscriptionJob& Aws::TranscribeService::Model::MedicalTranscriptionJob::WithFailureReason ( const char *  value)
inline

If the TranscriptionJobStatus field is FAILED, this field contains information about why the job failed.

The FailureReason field contains one of the following values:

  • Unsupported media format- The media format specified in the MediaFormat field of the request isn't valid. See the description of the MediaFormat field for a list of valid values.

  • The media format provided does not match the detected media format- The media format of the audio file doesn't match the format specified in the MediaFormat field in the request. Check the media format of your media file and make sure the two values match.

  • Invalid sample rate for audio file- The sample rate specified in the MediaSampleRateHertz of the request isn't valid. The sample rate must be between 8,000 and 48,000 Hertz.

  • The sample rate provided does not match the detected sample rate- The sample rate in the audio file doesn't match the sample rate specified in the MediaSampleRateHertz field in the request. Check the sample rate of your media file and make sure that the two values match.

  • Invalid file size: file size too large- The size of your audio file is larger than what Amazon Transcribe Medical can process. For more information, see Guidelines and Quotas in the Amazon Transcribe Medical Guide

  • Invalid number of channels: number of channels too large- Your audio contains more channels than Amazon Transcribe Medical is configured to process. To request additional channels, see Amazon Transcribe Medical Endpoints and Quotas in the Amazon Web Services General Reference

Definition at line 649 of file MedicalTranscriptionJob.h.

◆ WithLanguageCode() [1/2]

MedicalTranscriptionJob& Aws::TranscribeService::Model::MedicalTranscriptionJob::WithLanguageCode ( const LanguageCode value)
inline

The language code for the language spoken in the source audio file. US English (en-US) is the only supported language for medical transcriptions. Any other value you enter for language code results in a BadRequestException error.

Definition at line 163 of file MedicalTranscriptionJob.h.

◆ WithLanguageCode() [2/2]

MedicalTranscriptionJob& Aws::TranscribeService::Model::MedicalTranscriptionJob::WithLanguageCode ( LanguageCode &&  value)
inline

The language code for the language spoken in the source audio file. US English (en-US) is the only supported language for medical transcriptions. Any other value you enter for language code results in a BadRequestException error.

Definition at line 171 of file MedicalTranscriptionJob.h.

◆ WithMedia() [1/2]

MedicalTranscriptionJob& Aws::TranscribeService::Model::MedicalTranscriptionJob::WithMedia ( const Media value)
inline

Definition at line 259 of file MedicalTranscriptionJob.h.

◆ WithMedia() [2/2]

MedicalTranscriptionJob& Aws::TranscribeService::Model::MedicalTranscriptionJob::WithMedia ( Media &&  value)
inline

Definition at line 262 of file MedicalTranscriptionJob.h.

◆ WithMediaFormat() [1/2]

MedicalTranscriptionJob& Aws::TranscribeService::Model::MedicalTranscriptionJob::WithMediaFormat ( const MediaFormat value)
inline

The format of the input media file.

Definition at line 238 of file MedicalTranscriptionJob.h.

◆ WithMediaFormat() [2/2]

MedicalTranscriptionJob& Aws::TranscribeService::Model::MedicalTranscriptionJob::WithMediaFormat ( MediaFormat &&  value)
inline

The format of the input media file.

Definition at line 243 of file MedicalTranscriptionJob.h.

◆ WithMediaSampleRateHertz()

MedicalTranscriptionJob& Aws::TranscribeService::Model::MedicalTranscriptionJob::WithMediaSampleRateHertz ( int  value)
inline

The sample rate, in Hertz, of the source audio containing medical information.

If you don't specify the sample rate, Amazon Transcribe Medical determines it for you. If you choose to specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you should leave the MedicalMediaSampleHertz blank and let Amazon Transcribe Medical determine the sample rate.

Definition at line 212 of file MedicalTranscriptionJob.h.

◆ WithMedicalTranscriptionJobName() [1/3]

MedicalTranscriptionJob& Aws::TranscribeService::Model::MedicalTranscriptionJob::WithMedicalTranscriptionJobName ( Aws::String &&  value)
inline

The name for a given medical transcription job.

Definition at line 86 of file MedicalTranscriptionJob.h.

◆ WithMedicalTranscriptionJobName() [2/3]

MedicalTranscriptionJob& Aws::TranscribeService::Model::MedicalTranscriptionJob::WithMedicalTranscriptionJobName ( const Aws::String value)
inline

The name for a given medical transcription job.

Definition at line 81 of file MedicalTranscriptionJob.h.

◆ WithMedicalTranscriptionJobName() [3/3]

MedicalTranscriptionJob& Aws::TranscribeService::Model::MedicalTranscriptionJob::WithMedicalTranscriptionJobName ( const char *  value)
inline

The name for a given medical transcription job.

Definition at line 91 of file MedicalTranscriptionJob.h.

◆ WithSettings() [1/2]

MedicalTranscriptionJob& Aws::TranscribeService::Model::MedicalTranscriptionJob::WithSettings ( const MedicalTranscriptionSetting value)
inline

Object that contains object.

Definition at line 675 of file MedicalTranscriptionJob.h.

◆ WithSettings() [2/2]

MedicalTranscriptionJob& Aws::TranscribeService::Model::MedicalTranscriptionJob::WithSettings ( MedicalTranscriptionSetting &&  value)
inline

Object that contains object.

Definition at line 680 of file MedicalTranscriptionJob.h.

◆ WithSpecialty() [1/2]

MedicalTranscriptionJob& Aws::TranscribeService::Model::MedicalTranscriptionJob::WithSpecialty ( const Specialty value)
inline

The medical specialty of any clinicians providing a dictation or having a conversation. Refer to Transcribing a medical conversationfor a list of supported specialties.

Definition at line 770 of file MedicalTranscriptionJob.h.

◆ WithSpecialty() [2/2]

MedicalTranscriptionJob& Aws::TranscribeService::Model::MedicalTranscriptionJob::WithSpecialty ( Specialty &&  value)
inline

The medical specialty of any clinicians providing a dictation or having a conversation. Refer to Transcribing a medical conversationfor a list of supported specialties.

Definition at line 778 of file MedicalTranscriptionJob.h.

◆ WithStartTime() [1/2]

MedicalTranscriptionJob& Aws::TranscribeService::Model::MedicalTranscriptionJob::WithStartTime ( Aws::Utils::DateTime &&  value)
inline

A timestamp that shows when the job started processing.

Definition at line 330 of file MedicalTranscriptionJob.h.

◆ WithStartTime() [2/2]

MedicalTranscriptionJob& Aws::TranscribeService::Model::MedicalTranscriptionJob::WithStartTime ( const Aws::Utils::DateTime value)
inline

A timestamp that shows when the job started processing.

Definition at line 325 of file MedicalTranscriptionJob.h.

◆ WithTags() [1/2]

MedicalTranscriptionJob& Aws::TranscribeService::Model::MedicalTranscriptionJob::WithTags ( Aws::Vector< Tag > &&  value)
inline

A key:value pair assigned to a given medical transcription job.

Definition at line 870 of file MedicalTranscriptionJob.h.

◆ WithTags() [2/2]

MedicalTranscriptionJob& Aws::TranscribeService::Model::MedicalTranscriptionJob::WithTags ( const Aws::Vector< Tag > &  value)
inline

A key:value pair assigned to a given medical transcription job.

Definition at line 865 of file MedicalTranscriptionJob.h.

◆ WithTranscript() [1/2]

MedicalTranscriptionJob& Aws::TranscribeService::Model::MedicalTranscriptionJob::WithTranscript ( const MedicalTranscript value)
inline

An object that contains the MedicalTranscript. The MedicalTranscript contains the TranscriptFileUri.

Definition at line 293 of file MedicalTranscriptionJob.h.

◆ WithTranscript() [2/2]

MedicalTranscriptionJob& Aws::TranscribeService::Model::MedicalTranscriptionJob::WithTranscript ( MedicalTranscript &&  value)
inline

An object that contains the MedicalTranscript. The MedicalTranscript contains the TranscriptFileUri.

Definition at line 299 of file MedicalTranscriptionJob.h.

◆ WithTranscriptionJobStatus() [1/2]

MedicalTranscriptionJob& Aws::TranscribeService::Model::MedicalTranscriptionJob::WithTranscriptionJobStatus ( const TranscriptionJobStatus value)
inline

The completion status of a medical transcription job.

Definition at line 117 of file MedicalTranscriptionJob.h.

◆ WithTranscriptionJobStatus() [2/2]

MedicalTranscriptionJob& Aws::TranscribeService::Model::MedicalTranscriptionJob::WithTranscriptionJobStatus ( TranscriptionJobStatus &&  value)
inline

The completion status of a medical transcription job.

Definition at line 122 of file MedicalTranscriptionJob.h.

◆ WithType() [1/2]

MedicalTranscriptionJob& Aws::TranscribeService::Model::MedicalTranscriptionJob::WithType ( const Type value)
inline

The type of speech in the transcription job. CONVERSATION is generally used for patient-physician dialogues. DICTATION is the setting for physicians speaking their notes after seeing a patient. For more information, see What is Amazon Transcribe Medical?.

Definition at line 829 of file MedicalTranscriptionJob.h.

◆ WithType() [2/2]

MedicalTranscriptionJob& Aws::TranscribeService::Model::MedicalTranscriptionJob::WithType ( Type &&  value)
inline

The type of speech in the transcription job. CONVERSATION is generally used for patient-physician dialogues. DICTATION is the setting for physicians speaking their notes after seeing a patient. For more information, see What is Amazon Transcribe Medical?.

Definition at line 839 of file MedicalTranscriptionJob.h.


The documentation for this class was generated from the following file: