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

#include <StartMedicalTranscriptionJobRequest.h>

+ Inheritance diagram for Aws::TranscribeService::Model::StartMedicalTranscriptionJobRequest:

Public Member Functions

 StartMedicalTranscriptionJobRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetMedicalTranscriptionJobName () const
 
bool MedicalTranscriptionJobNameHasBeenSet () const
 
void SetMedicalTranscriptionJobName (const Aws::String &value)
 
void SetMedicalTranscriptionJobName (Aws::String &&value)
 
void SetMedicalTranscriptionJobName (const char *value)
 
StartMedicalTranscriptionJobRequestWithMedicalTranscriptionJobName (const Aws::String &value)
 
StartMedicalTranscriptionJobRequestWithMedicalTranscriptionJobName (Aws::String &&value)
 
StartMedicalTranscriptionJobRequestWithMedicalTranscriptionJobName (const char *value)
 
const LanguageCodeGetLanguageCode () const
 
bool LanguageCodeHasBeenSet () const
 
void SetLanguageCode (const LanguageCode &value)
 
void SetLanguageCode (LanguageCode &&value)
 
StartMedicalTranscriptionJobRequestWithLanguageCode (const LanguageCode &value)
 
StartMedicalTranscriptionJobRequestWithLanguageCode (LanguageCode &&value)
 
int GetMediaSampleRateHertz () const
 
bool MediaSampleRateHertzHasBeenSet () const
 
void SetMediaSampleRateHertz (int value)
 
StartMedicalTranscriptionJobRequestWithMediaSampleRateHertz (int value)
 
const MediaFormatGetMediaFormat () const
 
bool MediaFormatHasBeenSet () const
 
void SetMediaFormat (const MediaFormat &value)
 
void SetMediaFormat (MediaFormat &&value)
 
StartMedicalTranscriptionJobRequestWithMediaFormat (const MediaFormat &value)
 
StartMedicalTranscriptionJobRequestWithMediaFormat (MediaFormat &&value)
 
const MediaGetMedia () const
 
bool MediaHasBeenSet () const
 
void SetMedia (const Media &value)
 
void SetMedia (Media &&value)
 
StartMedicalTranscriptionJobRequestWithMedia (const Media &value)
 
StartMedicalTranscriptionJobRequestWithMedia (Media &&value)
 
const Aws::StringGetOutputBucketName () const
 
bool OutputBucketNameHasBeenSet () const
 
void SetOutputBucketName (const Aws::String &value)
 
void SetOutputBucketName (Aws::String &&value)
 
void SetOutputBucketName (const char *value)
 
StartMedicalTranscriptionJobRequestWithOutputBucketName (const Aws::String &value)
 
StartMedicalTranscriptionJobRequestWithOutputBucketName (Aws::String &&value)
 
StartMedicalTranscriptionJobRequestWithOutputBucketName (const char *value)
 
const Aws::StringGetOutputEncryptionKMSKeyId () const
 
bool OutputEncryptionKMSKeyIdHasBeenSet () const
 
void SetOutputEncryptionKMSKeyId (const Aws::String &value)
 
void SetOutputEncryptionKMSKeyId (Aws::String &&value)
 
void SetOutputEncryptionKMSKeyId (const char *value)
 
StartMedicalTranscriptionJobRequestWithOutputEncryptionKMSKeyId (const Aws::String &value)
 
StartMedicalTranscriptionJobRequestWithOutputEncryptionKMSKeyId (Aws::String &&value)
 
StartMedicalTranscriptionJobRequestWithOutputEncryptionKMSKeyId (const char *value)
 
const MedicalTranscriptionSettingGetSettings () const
 
bool SettingsHasBeenSet () const
 
void SetSettings (const MedicalTranscriptionSetting &value)
 
void SetSettings (MedicalTranscriptionSetting &&value)
 
StartMedicalTranscriptionJobRequestWithSettings (const MedicalTranscriptionSetting &value)
 
StartMedicalTranscriptionJobRequestWithSettings (MedicalTranscriptionSetting &&value)
 
const SpecialtyGetSpecialty () const
 
bool SpecialtyHasBeenSet () const
 
void SetSpecialty (const Specialty &value)
 
void SetSpecialty (Specialty &&value)
 
StartMedicalTranscriptionJobRequestWithSpecialty (const Specialty &value)
 
StartMedicalTranscriptionJobRequestWithSpecialty (Specialty &&value)
 
const TypeGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const Type &value)
 
void SetType (Type &&value)
 
StartMedicalTranscriptionJobRequestWithType (const Type &value)
 
StartMedicalTranscriptionJobRequestWithType (Type &&value)
 
- Public Member Functions inherited from Aws::TranscribeService::TranscribeServiceRequest
virtual ~TranscribeServiceRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 27 of file StartMedicalTranscriptionJobRequest.h.

Constructor & Destructor Documentation

◆ StartMedicalTranscriptionJobRequest()

Aws::TranscribeService::Model::StartMedicalTranscriptionJobRequest::StartMedicalTranscriptionJobRequest ( )

Member Function Documentation

◆ GetLanguageCode()

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

The language code for the language spoken in the input media file. US English (en-US) is the valid value for medical transcription jobs. Any other value you enter for language code results in a BadRequestException error.

Definition at line 121 of file StartMedicalTranscriptionJobRequest.h.

◆ GetMedia()

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

Definition at line 232 of file StartMedicalTranscriptionJobRequest.h.

◆ GetMediaFormat()

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

The audio format of the input media file.

Definition at line 203 of file StartMedicalTranscriptionJobRequest.h.

◆ GetMediaSampleRateHertz()

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

The sample rate, in Hertz, of the audio track in the input media file.

If you do not specify the media sample rate, Amazon Transcribe Medical determines the sample rate. If you specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you should leave the MediaSampleRateHertz field blank and let Amazon Transcribe Medical determine the sample rate.

Definition at line 167 of file StartMedicalTranscriptionJobRequest.h.

◆ GetMedicalTranscriptionJobName()

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

The name of the medical transcription job. You can't use the strings "<code>.</code>" or "<code>..</code>" by themselves as the job name. The name must also be unique within an AWS account. If you try to create a medical transcription job with the same name as a previous medical transcription job, you get a ConflictException error.

Definition at line 50 of file StartMedicalTranscriptionJobRequest.h.

◆ GetOutputBucketName()

const Aws::String& Aws::TranscribeService::Model::StartMedicalTranscriptionJobRequest::GetOutputBucketName ( ) const
inline

The Amazon S3 location where the transcription is stored.

You must set OutputBucketName for Amazon Transcribe Medical to store the transcription results. Your transcript appears in the S3 location you specify. When you call the GetMedicalTranscriptionJob, the operation returns this location in the TranscriptFileUri field. The S3 bucket must have permissions that allow Amazon Transcribe Medical to put files in the bucket. For more information, see Permissions Required for IAM User Roles.

You can specify an AWS Key Management Service (KMS) key to encrypt the output of your transcription using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe Medical uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.

Definition at line 265 of file StartMedicalTranscriptionJobRequest.h.

◆ GetOutputEncryptionKMSKeyId()

const Aws::String& Aws::TranscribeService::Model::StartMedicalTranscriptionJobRequest::GetOutputEncryptionKMSKeyId ( ) const
inline

The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the StartMedicalTranscriptionJob operation must have permission to use the specified KMS key.

You use either of the following to identify a KMS key in the current account:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

  • KMS Key Alias: "alias/ExampleAlias"

You can use either of the following to identify a KMS key in the current account or another account:

  • Amazon Resource Name (ARN) of a KMS key in the current account or another account: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"

  • ARN of a KMS Key Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"

If you don't specify an encryption key, the output of the medical transcription job is encrypted with the default Amazon S3 key (SSE-S3).

If you specify a KMS key to encrypt your output, you must also specify an output location in the OutputBucketName parameter.

Definition at line 405 of file StartMedicalTranscriptionJobRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::TranscribeService::Model::StartMedicalTranscriptionJobRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::TranscribeService::Model::StartMedicalTranscriptionJobRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

◆ GetSettings()

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

Optional settings for the medical transcription job.

Definition at line 551 of file StartMedicalTranscriptionJobRequest.h.

◆ GetSpecialty()

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

The medical specialty of any clinician speaking in the input media.

Definition at line 582 of file StartMedicalTranscriptionJobRequest.h.

◆ GetType()

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

The type of speech in the input audio. CONVERSATION refers to conversations between two or more speakers, e.g., a conversations between doctors and patients. DICTATION refers to single-speaker dictated speech, e.g., for clinical notes.

Definition at line 616 of file StartMedicalTranscriptionJobRequest.h.

◆ LanguageCodeHasBeenSet()

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

The language code for the language spoken in the input media file. US English (en-US) is the valid value for medical transcription jobs. Any other value you enter for language code results in a BadRequestException error.

Definition at line 128 of file StartMedicalTranscriptionJobRequest.h.

◆ MediaFormatHasBeenSet()

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

The audio format of the input media file.

Definition at line 208 of file StartMedicalTranscriptionJobRequest.h.

◆ MediaHasBeenSet()

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

Definition at line 235 of file StartMedicalTranscriptionJobRequest.h.

◆ MediaSampleRateHertzHasBeenSet()

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

The sample rate, in Hertz, of the audio track in the input media file.

If you do not specify the media sample rate, Amazon Transcribe Medical determines the sample rate. If you specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you should leave the MediaSampleRateHertz field blank and let Amazon Transcribe Medical determine the sample rate.

Definition at line 177 of file StartMedicalTranscriptionJobRequest.h.

◆ MedicalTranscriptionJobNameHasBeenSet()

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

The name of the medical transcription job. You can't use the strings "<code>.</code>" or "<code>..</code>" by themselves as the job name. The name must also be unique within an AWS account. If you try to create a medical transcription job with the same name as a previous medical transcription job, you get a ConflictException error.

Definition at line 59 of file StartMedicalTranscriptionJobRequest.h.

◆ OutputBucketNameHasBeenSet()

bool Aws::TranscribeService::Model::StartMedicalTranscriptionJobRequest::OutputBucketNameHasBeenSet ( ) const
inline

The Amazon S3 location where the transcription is stored.

You must set OutputBucketName for Amazon Transcribe Medical to store the transcription results. Your transcript appears in the S3 location you specify. When you call the GetMedicalTranscriptionJob, the operation returns this location in the TranscriptFileUri field. The S3 bucket must have permissions that allow Amazon Transcribe Medical to put files in the bucket. For more information, see Permissions Required for IAM User Roles.

You can specify an AWS Key Management Service (KMS) key to encrypt the output of your transcription using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe Medical uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.

Definition at line 282 of file StartMedicalTranscriptionJobRequest.h.

◆ OutputEncryptionKMSKeyIdHasBeenSet()

bool Aws::TranscribeService::Model::StartMedicalTranscriptionJobRequest::OutputEncryptionKMSKeyIdHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the StartMedicalTranscriptionJob operation must have permission to use the specified KMS key.

You use either of the following to identify a KMS key in the current account:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

  • KMS Key Alias: "alias/ExampleAlias"

You can use either of the following to identify a KMS key in the current account or another account:

  • Amazon Resource Name (ARN) of a KMS key in the current account or another account: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"

  • ARN of a KMS Key Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"

If you don't specify an encryption key, the output of the medical transcription job is encrypted with the default Amazon S3 key (SSE-S3).

If you specify a KMS key to encrypt your output, you must also specify an output location in the OutputBucketName parameter.

Definition at line 425 of file StartMedicalTranscriptionJobRequest.h.

◆ SerializePayload()

Aws::String Aws::TranscribeService::Model::StartMedicalTranscriptionJobRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetLanguageCode() [1/2]

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

The language code for the language spoken in the input media file. US English (en-US) is the valid value for medical transcription jobs. Any other value you enter for language code results in a BadRequestException error.

Definition at line 135 of file StartMedicalTranscriptionJobRequest.h.

◆ SetLanguageCode() [2/2]

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

The language code for the language spoken in the input media file. US English (en-US) is the valid value for medical transcription jobs. Any other value you enter for language code results in a BadRequestException error.

Definition at line 142 of file StartMedicalTranscriptionJobRequest.h.

◆ SetMedia() [1/2]

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

Definition at line 238 of file StartMedicalTranscriptionJobRequest.h.

◆ SetMedia() [2/2]

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

Definition at line 241 of file StartMedicalTranscriptionJobRequest.h.

◆ SetMediaFormat() [1/2]

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

The audio format of the input media file.

Definition at line 213 of file StartMedicalTranscriptionJobRequest.h.

◆ SetMediaFormat() [2/2]

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

The audio format of the input media file.

Definition at line 218 of file StartMedicalTranscriptionJobRequest.h.

◆ SetMediaSampleRateHertz()

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

The sample rate, in Hertz, of the audio track in the input media file.

If you do not specify the media sample rate, Amazon Transcribe Medical determines the sample rate. If you specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you should leave the MediaSampleRateHertz field blank and let Amazon Transcribe Medical determine the sample rate.

Definition at line 187 of file StartMedicalTranscriptionJobRequest.h.

◆ SetMedicalTranscriptionJobName() [1/3]

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

The name of the medical transcription job. You can't use the strings "<code>.</code>" or "<code>..</code>" by themselves as the job name. The name must also be unique within an AWS account. If you try to create a medical transcription job with the same name as a previous medical transcription job, you get a ConflictException error.

Definition at line 68 of file StartMedicalTranscriptionJobRequest.h.

◆ SetMedicalTranscriptionJobName() [2/3]

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

The name of the medical transcription job. You can't use the strings "<code>.</code>" or "<code>..</code>" by themselves as the job name. The name must also be unique within an AWS account. If you try to create a medical transcription job with the same name as a previous medical transcription job, you get a ConflictException error.

Definition at line 77 of file StartMedicalTranscriptionJobRequest.h.

◆ SetMedicalTranscriptionJobName() [3/3]

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

The name of the medical transcription job. You can't use the strings "<code>.</code>" or "<code>..</code>" by themselves as the job name. The name must also be unique within an AWS account. If you try to create a medical transcription job with the same name as a previous medical transcription job, you get a ConflictException error.

Definition at line 86 of file StartMedicalTranscriptionJobRequest.h.

◆ SetOutputBucketName() [1/3]

void Aws::TranscribeService::Model::StartMedicalTranscriptionJobRequest::SetOutputBucketName ( const Aws::String value)
inline

The Amazon S3 location where the transcription is stored.

You must set OutputBucketName for Amazon Transcribe Medical to store the transcription results. Your transcript appears in the S3 location you specify. When you call the GetMedicalTranscriptionJob, the operation returns this location in the TranscriptFileUri field. The S3 bucket must have permissions that allow Amazon Transcribe Medical to put files in the bucket. For more information, see Permissions Required for IAM User Roles.

You can specify an AWS Key Management Service (KMS) key to encrypt the output of your transcription using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe Medical uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.

Definition at line 299 of file StartMedicalTranscriptionJobRequest.h.

◆ SetOutputBucketName() [2/3]

void Aws::TranscribeService::Model::StartMedicalTranscriptionJobRequest::SetOutputBucketName ( Aws::String &&  value)
inline

The Amazon S3 location where the transcription is stored.

You must set OutputBucketName for Amazon Transcribe Medical to store the transcription results. Your transcript appears in the S3 location you specify. When you call the GetMedicalTranscriptionJob, the operation returns this location in the TranscriptFileUri field. The S3 bucket must have permissions that allow Amazon Transcribe Medical to put files in the bucket. For more information, see Permissions Required for IAM User Roles.

You can specify an AWS Key Management Service (KMS) key to encrypt the output of your transcription using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe Medical uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.

Definition at line 316 of file StartMedicalTranscriptionJobRequest.h.

◆ SetOutputBucketName() [3/3]

void Aws::TranscribeService::Model::StartMedicalTranscriptionJobRequest::SetOutputBucketName ( const char *  value)
inline

The Amazon S3 location where the transcription is stored.

You must set OutputBucketName for Amazon Transcribe Medical to store the transcription results. Your transcript appears in the S3 location you specify. When you call the GetMedicalTranscriptionJob, the operation returns this location in the TranscriptFileUri field. The S3 bucket must have permissions that allow Amazon Transcribe Medical to put files in the bucket. For more information, see Permissions Required for IAM User Roles.

You can specify an AWS Key Management Service (KMS) key to encrypt the output of your transcription using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe Medical uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.

Definition at line 333 of file StartMedicalTranscriptionJobRequest.h.

◆ SetOutputEncryptionKMSKeyId() [1/3]

void Aws::TranscribeService::Model::StartMedicalTranscriptionJobRequest::SetOutputEncryptionKMSKeyId ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the StartMedicalTranscriptionJob operation must have permission to use the specified KMS key.

You use either of the following to identify a KMS key in the current account:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

  • KMS Key Alias: "alias/ExampleAlias"

You can use either of the following to identify a KMS key in the current account or another account:

  • Amazon Resource Name (ARN) of a KMS key in the current account or another account: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"

  • ARN of a KMS Key Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"

If you don't specify an encryption key, the output of the medical transcription job is encrypted with the default Amazon S3 key (SSE-S3).

If you specify a KMS key to encrypt your output, you must also specify an output location in the OutputBucketName parameter.

Definition at line 445 of file StartMedicalTranscriptionJobRequest.h.

◆ SetOutputEncryptionKMSKeyId() [2/3]

void Aws::TranscribeService::Model::StartMedicalTranscriptionJobRequest::SetOutputEncryptionKMSKeyId ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the StartMedicalTranscriptionJob operation must have permission to use the specified KMS key.

You use either of the following to identify a KMS key in the current account:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

  • KMS Key Alias: "alias/ExampleAlias"

You can use either of the following to identify a KMS key in the current account or another account:

  • Amazon Resource Name (ARN) of a KMS key in the current account or another account: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"

  • ARN of a KMS Key Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"

If you don't specify an encryption key, the output of the medical transcription job is encrypted with the default Amazon S3 key (SSE-S3).

If you specify a KMS key to encrypt your output, you must also specify an output location in the OutputBucketName parameter.

Definition at line 465 of file StartMedicalTranscriptionJobRequest.h.

◆ SetOutputEncryptionKMSKeyId() [3/3]

void Aws::TranscribeService::Model::StartMedicalTranscriptionJobRequest::SetOutputEncryptionKMSKeyId ( const char *  value)
inline

The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the StartMedicalTranscriptionJob operation must have permission to use the specified KMS key.

You use either of the following to identify a KMS key in the current account:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

  • KMS Key Alias: "alias/ExampleAlias"

You can use either of the following to identify a KMS key in the current account or another account:

  • Amazon Resource Name (ARN) of a KMS key in the current account or another account: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"

  • ARN of a KMS Key Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"

If you don't specify an encryption key, the output of the medical transcription job is encrypted with the default Amazon S3 key (SSE-S3).

If you specify a KMS key to encrypt your output, you must also specify an output location in the OutputBucketName parameter.

Definition at line 485 of file StartMedicalTranscriptionJobRequest.h.

◆ SetSettings() [1/2]

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

Optional settings for the medical transcription job.

Definition at line 561 of file StartMedicalTranscriptionJobRequest.h.

◆ SetSettings() [2/2]

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

Optional settings for the medical transcription job.

Definition at line 566 of file StartMedicalTranscriptionJobRequest.h.

◆ SetSpecialty() [1/2]

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

The medical specialty of any clinician speaking in the input media.

Definition at line 592 of file StartMedicalTranscriptionJobRequest.h.

◆ SetSpecialty() [2/2]

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

The medical specialty of any clinician speaking in the input media.

Definition at line 597 of file StartMedicalTranscriptionJobRequest.h.

◆ SettingsHasBeenSet()

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

Optional settings for the medical transcription job.

Definition at line 556 of file StartMedicalTranscriptionJobRequest.h.

◆ SetType() [1/2]

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

The type of speech in the input audio. CONVERSATION refers to conversations between two or more speakers, e.g., a conversations between doctors and patients. DICTATION refers to single-speaker dictated speech, e.g., for clinical notes.

Definition at line 632 of file StartMedicalTranscriptionJobRequest.h.

◆ SetType() [2/2]

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

The type of speech in the input audio. CONVERSATION refers to conversations between two or more speakers, e.g., a conversations between doctors and patients. DICTATION refers to single-speaker dictated speech, e.g., for clinical notes.

Definition at line 640 of file StartMedicalTranscriptionJobRequest.h.

◆ SpecialtyHasBeenSet()

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

The medical specialty of any clinician speaking in the input media.

Definition at line 587 of file StartMedicalTranscriptionJobRequest.h.

◆ TypeHasBeenSet()

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

The type of speech in the input audio. CONVERSATION refers to conversations between two or more speakers, e.g., a conversations between doctors and patients. DICTATION refers to single-speaker dictated speech, e.g., for clinical notes.

Definition at line 624 of file StartMedicalTranscriptionJobRequest.h.

◆ WithLanguageCode() [1/2]

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

The language code for the language spoken in the input media file. US English (en-US) is the valid value for medical transcription jobs. Any other value you enter for language code results in a BadRequestException error.

Definition at line 149 of file StartMedicalTranscriptionJobRequest.h.

◆ WithLanguageCode() [2/2]

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

The language code for the language spoken in the input media file. US English (en-US) is the valid value for medical transcription jobs. Any other value you enter for language code results in a BadRequestException error.

Definition at line 156 of file StartMedicalTranscriptionJobRequest.h.

◆ WithMedia() [1/2]

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

Definition at line 244 of file StartMedicalTranscriptionJobRequest.h.

◆ WithMedia() [2/2]

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

Definition at line 247 of file StartMedicalTranscriptionJobRequest.h.

◆ WithMediaFormat() [1/2]

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

The audio format of the input media file.

Definition at line 223 of file StartMedicalTranscriptionJobRequest.h.

◆ WithMediaFormat() [2/2]

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

The audio format of the input media file.

Definition at line 228 of file StartMedicalTranscriptionJobRequest.h.

◆ WithMediaSampleRateHertz()

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

The sample rate, in Hertz, of the audio track in the input media file.

If you do not specify the media sample rate, Amazon Transcribe Medical determines the sample rate. If you specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you should leave the MediaSampleRateHertz field blank and let Amazon Transcribe Medical determine the sample rate.

Definition at line 197 of file StartMedicalTranscriptionJobRequest.h.

◆ WithMedicalTranscriptionJobName() [1/3]

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

The name of the medical transcription job. You can't use the strings "<code>.</code>" or "<code>..</code>" by themselves as the job name. The name must also be unique within an AWS account. If you try to create a medical transcription job with the same name as a previous medical transcription job, you get a ConflictException error.

Definition at line 95 of file StartMedicalTranscriptionJobRequest.h.

◆ WithMedicalTranscriptionJobName() [2/3]

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

The name of the medical transcription job. You can't use the strings "<code>.</code>" or "<code>..</code>" by themselves as the job name. The name must also be unique within an AWS account. If you try to create a medical transcription job with the same name as a previous medical transcription job, you get a ConflictException error.

Definition at line 104 of file StartMedicalTranscriptionJobRequest.h.

◆ WithMedicalTranscriptionJobName() [3/3]

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

The name of the medical transcription job. You can't use the strings "<code>.</code>" or "<code>..</code>" by themselves as the job name. The name must also be unique within an AWS account. If you try to create a medical transcription job with the same name as a previous medical transcription job, you get a ConflictException error.

Definition at line 113 of file StartMedicalTranscriptionJobRequest.h.

◆ WithOutputBucketName() [1/3]

StartMedicalTranscriptionJobRequest& Aws::TranscribeService::Model::StartMedicalTranscriptionJobRequest::WithOutputBucketName ( const Aws::String value)
inline

The Amazon S3 location where the transcription is stored.

You must set OutputBucketName for Amazon Transcribe Medical to store the transcription results. Your transcript appears in the S3 location you specify. When you call the GetMedicalTranscriptionJob, the operation returns this location in the TranscriptFileUri field. The S3 bucket must have permissions that allow Amazon Transcribe Medical to put files in the bucket. For more information, see Permissions Required for IAM User Roles.

You can specify an AWS Key Management Service (KMS) key to encrypt the output of your transcription using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe Medical uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.

Definition at line 350 of file StartMedicalTranscriptionJobRequest.h.

◆ WithOutputBucketName() [2/3]

StartMedicalTranscriptionJobRequest& Aws::TranscribeService::Model::StartMedicalTranscriptionJobRequest::WithOutputBucketName ( Aws::String &&  value)
inline

The Amazon S3 location where the transcription is stored.

You must set OutputBucketName for Amazon Transcribe Medical to store the transcription results. Your transcript appears in the S3 location you specify. When you call the GetMedicalTranscriptionJob, the operation returns this location in the TranscriptFileUri field. The S3 bucket must have permissions that allow Amazon Transcribe Medical to put files in the bucket. For more information, see Permissions Required for IAM User Roles.

You can specify an AWS Key Management Service (KMS) key to encrypt the output of your transcription using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe Medical uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.

Definition at line 367 of file StartMedicalTranscriptionJobRequest.h.

◆ WithOutputBucketName() [3/3]

StartMedicalTranscriptionJobRequest& Aws::TranscribeService::Model::StartMedicalTranscriptionJobRequest::WithOutputBucketName ( const char *  value)
inline

The Amazon S3 location where the transcription is stored.

You must set OutputBucketName for Amazon Transcribe Medical to store the transcription results. Your transcript appears in the S3 location you specify. When you call the GetMedicalTranscriptionJob, the operation returns this location in the TranscriptFileUri field. The S3 bucket must have permissions that allow Amazon Transcribe Medical to put files in the bucket. For more information, see Permissions Required for IAM User Roles.

You can specify an AWS Key Management Service (KMS) key to encrypt the output of your transcription using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe Medical uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.

Definition at line 384 of file StartMedicalTranscriptionJobRequest.h.

◆ WithOutputEncryptionKMSKeyId() [1/3]

StartMedicalTranscriptionJobRequest& Aws::TranscribeService::Model::StartMedicalTranscriptionJobRequest::WithOutputEncryptionKMSKeyId ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the StartMedicalTranscriptionJob operation must have permission to use the specified KMS key.

You use either of the following to identify a KMS key in the current account:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

  • KMS Key Alias: "alias/ExampleAlias"

You can use either of the following to identify a KMS key in the current account or another account:

  • Amazon Resource Name (ARN) of a KMS key in the current account or another account: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"

  • ARN of a KMS Key Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"

If you don't specify an encryption key, the output of the medical transcription job is encrypted with the default Amazon S3 key (SSE-S3).

If you specify a KMS key to encrypt your output, you must also specify an output location in the OutputBucketName parameter.

Definition at line 505 of file StartMedicalTranscriptionJobRequest.h.

◆ WithOutputEncryptionKMSKeyId() [2/3]

StartMedicalTranscriptionJobRequest& Aws::TranscribeService::Model::StartMedicalTranscriptionJobRequest::WithOutputEncryptionKMSKeyId ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the StartMedicalTranscriptionJob operation must have permission to use the specified KMS key.

You use either of the following to identify a KMS key in the current account:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

  • KMS Key Alias: "alias/ExampleAlias"

You can use either of the following to identify a KMS key in the current account or another account:

  • Amazon Resource Name (ARN) of a KMS key in the current account or another account: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"

  • ARN of a KMS Key Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"

If you don't specify an encryption key, the output of the medical transcription job is encrypted with the default Amazon S3 key (SSE-S3).

If you specify a KMS key to encrypt your output, you must also specify an output location in the OutputBucketName parameter.

Definition at line 525 of file StartMedicalTranscriptionJobRequest.h.

◆ WithOutputEncryptionKMSKeyId() [3/3]

StartMedicalTranscriptionJobRequest& Aws::TranscribeService::Model::StartMedicalTranscriptionJobRequest::WithOutputEncryptionKMSKeyId ( const char *  value)
inline

The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the StartMedicalTranscriptionJob operation must have permission to use the specified KMS key.

You use either of the following to identify a KMS key in the current account:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

  • KMS Key Alias: "alias/ExampleAlias"

You can use either of the following to identify a KMS key in the current account or another account:

  • Amazon Resource Name (ARN) of a KMS key in the current account or another account: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"

  • ARN of a KMS Key Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"

If you don't specify an encryption key, the output of the medical transcription job is encrypted with the default Amazon S3 key (SSE-S3).

If you specify a KMS key to encrypt your output, you must also specify an output location in the OutputBucketName parameter.

Definition at line 545 of file StartMedicalTranscriptionJobRequest.h.

◆ WithSettings() [1/2]

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

Optional settings for the medical transcription job.

Definition at line 571 of file StartMedicalTranscriptionJobRequest.h.

◆ WithSettings() [2/2]

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

Optional settings for the medical transcription job.

Definition at line 576 of file StartMedicalTranscriptionJobRequest.h.

◆ WithSpecialty() [1/2]

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

The medical specialty of any clinician speaking in the input media.

Definition at line 602 of file StartMedicalTranscriptionJobRequest.h.

◆ WithSpecialty() [2/2]

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

The medical specialty of any clinician speaking in the input media.

Definition at line 607 of file StartMedicalTranscriptionJobRequest.h.

◆ WithType() [1/2]

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

The type of speech in the input audio. CONVERSATION refers to conversations between two or more speakers, e.g., a conversations between doctors and patients. DICTATION refers to single-speaker dictated speech, e.g., for clinical notes.

Definition at line 648 of file StartMedicalTranscriptionJobRequest.h.

◆ WithType() [2/2]

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

The type of speech in the input audio. CONVERSATION refers to conversations between two or more speakers, e.g., a conversations between doctors and patients. DICTATION refers to single-speaker dictated speech, e.g., for clinical notes.

Definition at line 656 of file StartMedicalTranscriptionJobRequest.h.


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