String redactionType
Request parameter that defines the entities to be redacted. The only accepted value is PII.
String redactionOutput
The output transcript file stored in either the default S3 bucket or in a bucket you specify.
When you choose redacted Amazon Transcribe outputs only the redacted transcript.
When you choose redacted_and_unredacted Amazon Transcribe outputs both the redacted and unredacted
transcripts.
String languageCode
The language of the input text you're using to train your custom language model.
String baseModelName
The Amazon Transcribe standard language model, or base model used to create your custom language model.
If you want to use your custom language model to transcribe audio with a sample rate of 16 kHz or greater, choose
Wideband.
If you want to use your custom language model to transcribe audio with a sample rate that is less than 16 kHz,
choose Narrowband.
String modelName
The name you choose for your custom language model when you create it.
InputDataConfig inputDataConfig
Contains the data access role and the Amazon S3 prefixes to read the required input files to create a custom language model.
String languageCode
The language code of the text you've used to create a custom language model.
String baseModelName
The Amazon Transcribe standard language model, or base model you've used to create a custom language model.
String modelName
The name you've chosen for your custom language model.
InputDataConfig inputDataConfig
The data access role and Amazon S3 prefixes you've chosen to create your custom language model.
String modelStatus
The status of the custom language model. When the status is COMPLETED the model is ready to use.
String vocabularyName
The name of the custom vocabulary. This case-sensitive name must be unique within an AWS account. If you try to
create a vocabulary with the same name as a previous vocabulary, you get a ConflictException error.
String languageCode
The language code for the language used for the entries in your custom vocabulary. The language code of your custom vocabulary must match the language code of your transcription job. US English (en-US) is the only language code available for Amazon Transcribe Medical.
String vocabularyFileUri
The location in Amazon S3 of the text file you use to define your custom vocabulary. The URI must be in the same
AWS Region as the resource that you're calling. Enter information about your VocabularyFileUri in
the following format:
https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>
The following is an example URI for a vocabulary file that is stored in Amazon S3:
https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt
For more information about Amazon S3 object names, see Object Keys in the Amazon S3 Developer Guide.
For more information about custom vocabularies, see Medical Custom Vocabularies.
String vocabularyName
The name of the vocabulary. The name must be unique within an AWS account and is case sensitive.
String languageCode
The language code for the entries in your custom vocabulary. US English (en-US) is the only valid language code for Amazon Transcribe Medical.
String vocabularyState
The processing state of your custom vocabulary in Amazon Transcribe Medical. If the state is READY,
you can use the vocabulary in a StartMedicalTranscriptionJob request.
Date lastModifiedTime
The date and time that you created the vocabulary.
String failureReason
If the VocabularyState field is FAILED, this field contains information about why the
job failed.
String vocabularyFilterName
The vocabulary filter name. The name must be unique within the account that contains it. If you try to create a
vocabulary filter with the same name as another vocabulary filter, you get a ConflictException
error.
String languageCode
The language code of the words in the vocabulary filter. All words in the filter must be in the same language. The vocabulary filter can only be used with transcription jobs in the specified language.
List<E> words
The words to use in the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies.
If you provide a list of words in the Words parameter, you can't use the
VocabularyFilterFileUri parameter.
String vocabularyFilterFileUri
The Amazon S3 location of a text file used as input to create the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies.
The specified file must be less than 50 KB of UTF-8 characters.
If you provide the location of a list of words in the VocabularyFilterFileUri parameter, you can't
use the Words parameter.
String vocabularyName
The name of the vocabulary. The name must be unique within an AWS account. The name is case sensitive. If you try
to create a vocabulary with the same name as a previous vocabulary you will receive a
ConflictException error.
String languageCode
The language code of the vocabulary entries.
List<E> phrases
An array of strings that contains the vocabulary entries.
String vocabularyFileUri
The S3 location of the text file that contains the definition of the custom vocabulary. The URI must be in the same region as the API endpoint that you are calling. The general form is
For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.
For more information about custom vocabularies, see Custom Vocabularies.
String vocabularyName
The name of the vocabulary.
String languageCode
The language code of the vocabulary entries.
String vocabularyState
The processing state of the vocabulary. When the VocabularyState field contains READY
the vocabulary is ready to be used in a StartTranscriptionJob request.
Date lastModifiedTime
The date and time that the vocabulary was created.
String failureReason
If the VocabularyState field is FAILED, this field contains information about why the
job failed.
String modelName
The name of the model you're choosing to delete.
String medicalTranscriptionJobName
The name you provide to the DeleteMedicalTranscriptionJob object to delete a transcription job.
String vocabularyName
The name of the vocabulary that you want to delete.
String transcriptionJobName
The name of the transcription job to be deleted.
String vocabularyFilterName
The name of the vocabulary filter to remove.
String vocabularyName
The name of the vocabulary to delete.
String modelName
The name of the custom language model you submit to get more information.
LanguageModel languageModel
The name of the custom language model you requested more information about.
String medicalTranscriptionJobName
The name of the medical transcription job.
MedicalTranscriptionJob medicalTranscriptionJob
An object that contains the results of the medical transcription job.
String vocabularyName
The name of the vocabulary that you want information about. The value is case sensitive.
String vocabularyName
The name of the vocabulary returned by Amazon Transcribe Medical.
String languageCode
The valid language code for your vocabulary entries.
String vocabularyState
The processing state of the vocabulary. If the VocabularyState is READY then you can
use it in the StartMedicalTranscriptionJob operation.
Date lastModifiedTime
The date and time that the vocabulary was last modified with a text file different from the one that was previously used.
String failureReason
If the VocabularyState is FAILED, this field contains information about why the job
failed.
String downloadUri
The location in Amazon S3 where the vocabulary is stored. Use this URI to get the contents of the vocabulary. You can download your vocabulary from the URI for a limited time.
String transcriptionJobName
The name of the job.
TranscriptionJob transcriptionJob
An object that contains the results of the transcription job.
String vocabularyFilterName
The name of the vocabulary filter for which to return information.
String vocabularyFilterName
The name of the vocabulary filter.
String languageCode
The language code of the words in the vocabulary filter.
Date lastModifiedTime
The date and time that the contents of the vocabulary filter were updated.
String downloadUri
The URI of the list of words in the vocabulary filter. You can use this URI to get the list of words.
String vocabularyName
The name of the vocabulary to return information about. The name is case sensitive.
String vocabularyName
The name of the vocabulary to return.
String languageCode
The language code of the vocabulary entries.
String vocabularyState
The processing state of the vocabulary.
Date lastModifiedTime
The date and time that the vocabulary was last modified.
String failureReason
If the VocabularyState field is FAILED, this field contains information about why the
job failed.
String downloadUri
The S3 location where the vocabulary is stored. Use this URI to get the contents of the vocabulary. The URI is available for a limited time.
String s3Uri
The Amazon S3 prefix you specify to access the plain text files that you use to train your custom language model.
String tuningDataS3Uri
The Amazon S3 prefix you specify to access the plain text files that you use to tune your custom language model.
String dataAccessRoleArn
The Amazon Resource Name (ARN) that uniquely identifies the permissions you've given Amazon Transcribe to access your Amazon S3 buckets containing your media files or text data.
Boolean allowDeferredExecution
Indicates whether a job should be queued by Amazon Transcribe when the concurrent execution limit is exceeded.
When the AllowDeferredExecution field is true, jobs are queued and executed when the number of
executing jobs falls below the concurrent execution limit. If the field is false, Amazon Transcribe returns a
LimitExceededException exception.
If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn
field.
String dataAccessRoleArn
The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that contains the input files. Amazon Transcribe assumes this role to read queued media files. If you have specified an output S3 bucket for the transcription results, this role should have access to the output bucket as well.
If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn
field.
String modelName
The name of the custom language model.
Date createTime
The time the custom language model was created.
Date lastModifiedTime
The most recent time the custom language model was modified.
String languageCode
The language code you used to create your custom language model.
String baseModelName
The Amazon Transcribe standard language model, or base model used to create the custom language model.
String modelStatus
The creation status of a custom language model. When the status is COMPLETED the model is ready for
use.
Boolean upgradeAvailability
Whether the base model used for the custom language model is up to date. If this field is true then
you are running the most up-to-date version of the base model in your custom language model.
String failureReason
The reason why the custom language model couldn't be created.
InputDataConfig inputDataConfig
The data access role and Amazon S3 prefixes for the input files used to train the custom language model.
String statusEquals
When specified, returns only custom language models with the specified status. Language models are ordered by creation date, with the newest models first. If you don't specify a status, Amazon Transcribe returns all custom language models ordered by date.
String nameContains
When specified, the custom language model names returned contain the substring you've specified.
String nextToken
When included, fetches the next set of jobs if the result of the previous request was truncated.
Integer maxResults
The maximum number of language models to return in the response. If there are fewer results in the list, the response contains only the actual results.
String nextToken
The operation returns a page of jobs at a time. The maximum size of the list is set by the MaxResults parameter.
If there are more language models in the list than the page size, Amazon Transcribe returns the
NextPage token. Include the token in the next request to the operation to return the next page of
language models.
List<E> models
A list of objects containing information about custom language models.
String status
When specified, returns only medical transcription jobs with the specified status. Jobs are ordered by creation date, with the newest jobs returned first. If you don't specify a status, Amazon Transcribe Medical returns all transcription jobs ordered by creation date.
String jobNameContains
When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.
String nextToken
If you a receive a truncated result in the previous request of ListMedicalTranscriptionJobs, include
NextToken to fetch the next set of jobs.
Integer maxResults
The maximum number of medical transcription jobs to return in the response. IF there are fewer results in the list, this response contains only the actual results.
String status
The requested status of the medical transcription jobs returned.
String nextToken
The ListMedicalTranscriptionJobs operation returns a page of jobs at a time. The maximum size of the
page is set by the MaxResults parameter. If the number of jobs exceeds what can fit on a page,
Amazon Transcribe Medical returns the NextPage token. Include the token in the next request to the
ListMedicalTranscriptionJobs operation to return in the next page of jobs.
List<E> medicalTranscriptionJobSummaries
A list of objects containing summary information for a transcription job.
String nextToken
If the result of your previous request to ListMedicalVocabularies was truncated, include the
NextToken to fetch the next set of vocabularies.
Integer maxResults
The maximum number of vocabularies to return in the response.
String stateEquals
When specified, returns only vocabularies with the VocabularyState equal to the specified vocabulary
state. Use this field to see which vocabularies are ready for your medical transcription jobs.
String nameContains
Returns vocabularies whose names contain the specified string. The search is not case sensitive.
ListMedicalVocabularies returns both "vocabularyname" and "VocabularyName
".
String status
The requested vocabulary state.
String nextToken
The ListMedicalVocabularies operation returns a page of vocabularies at a time. You set the maximum
number of vocabularies to return on a page with the MaxResults parameter. If there are more jobs in
the list will fit on a page, Amazon Transcribe Medical returns the NextPage token. To return the
next page of vocabularies, include the token in the next request to the ListMedicalVocabularies
operation .
List<E> vocabularies
A list of objects that describe the vocabularies that match your search criteria.
String status
When specified, returns only transcription jobs with the specified status. Jobs are ordered by creation date, with the newest jobs returned first. If you don’t specify a status, Amazon Transcribe returns all transcription jobs ordered by creation date.
String jobNameContains
When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.
String nextToken
If the result of the previous request to ListTranscriptionJobs was truncated, include the
NextToken to fetch the next set of jobs.
Integer maxResults
The maximum number of jobs to return in the response. If there are fewer results in the list, this response contains only the actual results.
String status
The requested status of the jobs returned.
String nextToken
The ListTranscriptionJobs operation returns a page of jobs at a time. The maximum size of the page
is set by the MaxResults parameter. If there are more jobs in the list than the page size, Amazon
Transcribe returns the NextPage token. Include the token in the next request to the
ListTranscriptionJobs operation to return in the next page of jobs.
List<E> transcriptionJobSummaries
A list of objects containing summary information for a transcription job.
String nextToken
If the result of the previous request to ListVocabularies was truncated, include the
NextToken to fetch the next set of jobs.
Integer maxResults
The maximum number of vocabularies to return in the response. If there are fewer results in the list, this response contains only the actual results.
String stateEquals
When specified, only returns vocabularies with the VocabularyState field equal to the specified
state.
String nameContains
When specified, the vocabularies returned in the list are limited to vocabularies whose name contains the
specified string. The search is not case sensitive, ListVocabularies returns both "vocabularyname"
and "VocabularyName" in the response list.
String status
The requested vocabulary state.
String nextToken
The ListVocabularies operation returns a page of vocabularies at a time. The maximum size of the
page is set in the MaxResults parameter. If there are more jobs in the list than will fit on the
page, Amazon Transcribe returns the NextPage token. To return in the next page of jobs, include the
token in the next request to the ListVocabularies operation.
List<E> vocabularies
A list of objects that describe the vocabularies that match the search criteria in the request.
String nextToken
If the result of the previous request to ListVocabularyFilters was truncated, include the
NextToken to fetch the next set of collections.
Integer maxResults
The maximum number of filters to return in the response. If there are fewer results in the list, this response contains only the actual results.
String nameContains
Filters the response so that it only contains vocabulary filters whose name contains the specified string.
String nextToken
The ListVocabularyFilters operation returns a page of collections at a time. The maximum size of the
page is set by the MaxResults parameter. If there are more jobs in the list than the page size,
Amazon Transcribe returns the NextPage token. Include the token in the next request to the
ListVocabularyFilters operation to return in the next page of jobs.
List<E> vocabularyFilters
The list of vocabulary filters. It contains at most MaxResults number of filters. If there are more
filters, call the ListVocabularyFilters operation again with the NextToken parameter in
the request set to the value of the NextToken field in the response.
String mediaFileUri
The S3 object location of the input media file. The URI must be in the same region as the API endpoint that you are calling. The general form is:
For example:
For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.
String transcriptFileUri
The S3 object location of the medical transcript.
Use this URI to access the medical transcript. This URI points to the S3 bucket you created to store the medical transcript.
String medicalTranscriptionJobName
The name for a given medical transcription job.
String transcriptionJobStatus
The completion status of a medical transcription job.
String languageCode
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.
Integer mediaSampleRateHertz
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 MediaSampleHertz blank and let Amazon Transcribe Medical determine the sample rate.
String mediaFormat
The format of the input media file.
Media media
MedicalTranscript transcript
An object that contains the MedicalTranscript. The MedicalTranscript contains the
TranscriptFileUri.
Date startTime
A timestamp that shows when the job started processing.
Date creationTime
A timestamp that shows when the job was created.
Date completionTime
A timestamp that shows when the job was completed.
String failureReason
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 8000 and 48000
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
MedicalTranscriptionSetting settings
Object that contains object.
String specialty
The medical specialty of any clinicians providing a dictation or having a conversation. PRIMARYCARE
is the only available setting for this object. This specialty enables you to generate transcriptions for the
following medical fields:
Family Medicine
String type
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 how-it-works-med
String medicalTranscriptionJobName
The name of a medical transcription job.
Date creationTime
A timestamp that shows when the medical transcription job was created.
Date startTime
A timestamp that shows when the job began processing.
Date completionTime
A timestamp that shows when the job was completed.
String languageCode
The language of the transcript in the source audio file.
String transcriptionJobStatus
The status of the medical transcription job.
String failureReason
If the TranscriptionJobStatus field is FAILED, a description of the error.
String outputLocationType
Indicates the location of the transcription job's output.
The CUSTOMER_BUCKET is the S3 location provided in the OutputBucketName field when the
String specialty
The medical specialty of the transcription job. Primary care is the only valid value.
String type
The speech of the clinician in the input audio.
Boolean showSpeakerLabels
Determines whether the transcription job uses speaker recognition to identify different speakers in the input
audio. Speaker recognition labels individual speakers in the audio file. If you set the
ShowSpeakerLabels field to true, you must also set the maximum number of speaker labels in the
MaxSpeakerLabels field.
You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If
you set both, your request returns a BadRequestException.
Integer maxSpeakerLabels
The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this
number, multiple speakers are identified as a single speaker. If you specify the MaxSpeakerLabels
field, you must set the ShowSpeakerLabels field to true.
Boolean channelIdentification
Instructs Amazon Transcribe Medical to process each audio channel separately and then merge the transcription output of each channel into a single transcription.
Amazon Transcribe Medical also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of item. The alternative transcriptions also come with confidence scores provided by Amazon Transcribe Medical.
You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If
you set both, your request returns a BadRequestException
Boolean showAlternatives
Determines whether alternative transcripts are generated along with the transcript that has the highest
confidence. If you set ShowAlternatives field to true, you must also set the maximum number of
alternatives to return in the MaxAlternatives field.
Integer maxAlternatives
The maximum number of alternatives that you tell the service to return. If you specify the
MaxAlternatives field, you must set the ShowAlternatives field to true.
String vocabularyName
The name of the vocabulary to use when processing a medical transcription job.
String languageModelName
The name of your custom language model.
String vocabularyName
The name of a vocabulary to use when processing the transcription job.
Boolean showSpeakerLabels
Determines whether the transcription job uses speaker recognition to identify different speakers in the input
audio. Speaker recognition labels individual speakers in the audio file. If you set the
ShowSpeakerLabels field to true, you must also set the maximum number of speaker labels
MaxSpeakerLabels field.
You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If
you set both, your request returns a BadRequestException.
Integer maxSpeakerLabels
The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this
number, multiple speakers are identified as a single speaker. If you specify the MaxSpeakerLabels
field, you must set the ShowSpeakerLabels field to true.
Boolean channelIdentification
Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription.
Amazon Transcribe also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of the item including the confidence that Amazon Transcribe has in the transcription.
You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If
you set both, your request returns a BadRequestException.
Boolean showAlternatives
Determines whether the transcription contains alternative transcriptions. If you set the
ShowAlternatives field to true, you must also set the maximum number of alternatives to return in
the MaxAlternatives field.
Integer maxAlternatives
The number of alternative transcriptions that the service should return. If you specify the
MaxAlternatives field, you must set the ShowAlternatives field to true.
String vocabularyFilterName
The name of the vocabulary filter to use when transcribing the audio. The filter that you specify must have the same language code as the transcription job.
String vocabularyFilterMethod
Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***")
as placeholder text. Set to remove to remove filtered text from the transcript without using
placeholder text.
String medicalTranscriptionJobName
The name of the medical transcription job. You can't use the strings "." or ".." 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.
String languageCode
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.
Integer mediaSampleRateHertz
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.
String mediaFormat
The audio format of the input media file.
Media media
String outputBucketName
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.
String outputKey
You can specify a location in an Amazon S3 bucket to store the output of your medical transcription job.
If you don't specify an output key, Amazon Transcribe Medical stores the output of your transcription job in the Amazon S3 bucket you specified. By default, the object key is "your-transcription-job-name.json".
You can use output keys to specify the Amazon S3 prefix and file name of the transcription output. For example, specifying the Amazon S3 prefix, "folder1/folder2/", as an output key would lead to the output being stored as "folder1/folder2/your-transcription-job-name.json". If you specify "my-other-job-name.json" as the output key, the object key is changed to "my-other-job-name.json". You can use an output key to change both the prefix and the file name, for example "folder/my-other-job-name.json".
If you specify an output key, you must also specify an S3 bucket in the OutputBucketName parameter.
String outputEncryptionKMSKeyId
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.
MedicalTranscriptionSetting settings
Optional settings for the medical transcription job.
String specialty
The medical specialty of any clinician speaking in the input media.
String type
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.
MedicalTranscriptionJob medicalTranscriptionJob
A batch job submitted to transcribe medical speech to text.
String transcriptionJobName
The name of the job. You can't use the strings "." or ".." by themselves as the job
name. The name must also be unique within an AWS account. If you try to create a transcription job with the same
name as a previous transcription job, you get a ConflictException error.
String languageCode
The language code for the language used in the input media file.
Integer mediaSampleRateHertz
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 determines the sample rate. If you specify the
sample rate, it must match the sample rate detected by Amazon Transcribe. In most cases, you should leave the
MediaSampleRateHertz field blank and let Amazon Transcribe determine the sample rate.
String mediaFormat
The format of the input media file.
Media media
An object that describes the input media for a transcription job.
String outputBucketName
The location where the transcription is stored.
If you set the OutputBucketName, Amazon Transcribe puts the transcript in the specified S3 bucket.
When you call the GetTranscriptionJob operation, the operation returns this location in the
TranscriptFileUri field. If you enable content redaction, the redacted transcript appears in
RedactedTranscriptFileUri. If you enable content redaction and choose to output an unredacted
transcript, that transcript's location still appears in the TranscriptFileUri. The S3 bucket must
have permissions that allow Amazon Transcribe 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 uses the
default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.
If you don't set the OutputBucketName, Amazon Transcribe generates a pre-signed URL, a shareable URL
that provides secure access to your transcription, and returns it in the TranscriptFileUri field.
Use this URL to download the transcription.
String outputKey
You can specify a location in an Amazon S3 bucket to store the output of your transcription job.
If you don't specify an output key, Amazon Transcribe stores the output of your transcription job in the Amazon S3 bucket you specified. By default, the object key is "your-transcription-job-name.json".
You can use output keys to specify the Amazon S3 prefix and file name of the transcription output. For example, specifying the Amazon S3 prefix, "folder1/folder2/", as an output key would lead to the output being stored as "folder1/folder2/your-transcription-job-name.json". If you specify "my-other-job-name.json" as the output key, the object key is changed to "my-other-job-name.json". You can use an output key to change both the prefix and the file name, for example "folder/my-other-job-name.json".
If you specify an output key, you must also specify an S3 bucket in the OutputBucketName parameter.
String outputEncryptionKMSKeyId
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 StartTranscriptionJob operation must have permission to use
the specified KMS key.
You can 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: "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 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.
Settings settings
A Settings object that provides optional settings for a transcription job.
ModelSettings modelSettings
Choose the custom language model you use for your transcription job in this parameter.
JobExecutionSettings jobExecutionSettings
Provides information about how a transcription job is executed. Use this field to indicate that the job can be queued for deferred execution if the concurrency limit is reached and there are no slots available to immediately run the job.
ContentRedaction contentRedaction
An object that contains the request parameters for content redaction.
Boolean identifyLanguage
Set this field to true to enable automatic language identification. Automatic language
identification is disabled by default. You receive a BadRequestException error if you enter a value
for a LanguageCode.
List<E> languageOptions
An object containing a list of languages that might be present in your collection of audio files. Automatic language identification chooses a language that best matches the source audio from that list.
TranscriptionJob transcriptionJob
An object containing details of the asynchronous transcription job.
String transcriptFileUri
The S3 object location of the transcript.
Use this URI to access the transcript. If you specified an S3 bucket in the OutputBucketName field
when you created the job, this is the URI of that bucket. If you chose to store the transcript in Amazon
Transcribe, this is a shareable URL that provides secure access to that location.
String redactedTranscriptFileUri
The S3 object location of the redacted transcript.
Use this URI to access the redacted transcript. If you specified an S3 bucket in the
OutputBucketName field when you created the job, this is the URI of that bucket. If you chose to
store the transcript in Amazon Transcribe, this is a shareable URL that provides secure access to that location.
String transcriptionJobName
The name of the transcription job.
String transcriptionJobStatus
The status of the transcription job.
String languageCode
The language code for the input speech.
Integer mediaSampleRateHertz
The sample rate, in Hertz, of the audio track in the input media file.
String mediaFormat
The format of the input media file.
Media media
An object that describes the input media for the transcription job.
Transcript transcript
An object that describes the output of the transcription job.
Date startTime
A timestamp that shows with the job was started processing.
Date creationTime
A timestamp that shows when the job was created.
Date completionTime
A timestamp that shows when the job was completed.
String failureReason
If the TranscriptionJobStatus field is FAILED, this field contains information about
why the job failed.
The FailureReason field can contain 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 that 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 8000 and 48000
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 Amazon
Transcribe can process. For more information, see Limits in the Amazon
Transcribe Developer Guide.
Invalid number of channels: number of channels too large - Your audio contains more channels than
Amazon Transcribe is configured to process. To request additional channels, see Amazon
Transcribe Limits in the Amazon Web Services General Reference.
Settings settings
Optional settings for the transcription job. Use these settings to turn on speaker recognition, to set the maximum number of speakers that should be identified and to specify a custom vocabulary to use when processing the transcription job.
ModelSettings modelSettings
An object containing the details of your custom language model.
JobExecutionSettings jobExecutionSettings
Provides information about how a transcription job is executed.
ContentRedaction contentRedaction
An object that describes content redaction settings for the transcription job.
Boolean identifyLanguage
A value that shows if automatic language identification was enabled for a transcription job.
List<E> languageOptions
An object that shows the optional array of languages inputted for transcription jobs with automatic language identification enabled.
Float identifiedLanguageScore
A value between zero and one that Amazon Transcribe assigned to the language that it identified in the source audio. Larger values indicate that Amazon Transcribe has higher confidence in the language it identified.
String transcriptionJobName
The name of the transcription job.
Date creationTime
A timestamp that shows when the job was created.
Date startTime
A timestamp that shows when the job started processing.
Date completionTime
A timestamp that shows when the job was completed.
String languageCode
The language code for the input speech.
String transcriptionJobStatus
The status of the transcription job. When the status is COMPLETED, use the
GetTranscriptionJob operation to get the results of the transcription.
String failureReason
If the TranscriptionJobStatus field is FAILED, a description of the error.
String outputLocationType
Indicates the location of the output of the transcription job.
If the value is CUSTOMER_BUCKET then the location is the S3 bucket specified in the
outputBucketName field when the transcription job was started with the
StartTranscriptionJob operation.
If the value is SERVICE_BUCKET then the output is stored by Amazon Transcribe and can be retrieved
using the URI in the GetTranscriptionJob response's TranscriptFileUri field.
ContentRedaction contentRedaction
The content redaction settings of the transcription job.
ModelSettings modelSettings
Boolean identifyLanguage
Whether automatic language identification was enabled for a transcription job.
Float identifiedLanguageScore
A value between zero and one that Amazon Transcribe assigned to the language it identified in the source audio. A higher score indicates that Amazon Transcribe is more confident in the language it identified.
String vocabularyName
The name of the vocabulary to update. The name is case sensitive. If you try to update a vocabulary with the same
name as a vocabulary you've already made, you get a ConflictException error.
String languageCode
The language code of the language used for the entries in the updated vocabulary. US English (en-US) is the only valid language code in Amazon Transcribe Medical.
String vocabularyFileUri
The location in Amazon S3 of the text file that contains the you use for your custom vocabulary. The URI must be in the same AWS Region as the resource that you are calling. The following is the format for a URI:
https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>
For example:
https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt
For more information about Amazon S3 object names, see Object Keys in the Amazon S3 Developer Guide.
For more information about custom vocabularies in Amazon Transcribe Medical, see Medical Custom Vocabularies.
String vocabularyName
The name of the updated vocabulary.
String languageCode
The language code for the language of the text file used to update the custom vocabulary. US English (en-US) is the only language supported in Amazon Transcribe Medical.
Date lastModifiedTime
The date and time that the vocabulary was updated.
String vocabularyState
The processing state of the update to the vocabulary. When the VocabularyState field is
READY, the vocabulary is ready to be used in a StartMedicalTranscriptionJob request.
String vocabularyFilterName
The name of the vocabulary filter to update. If you try to update a vocabulary filter with the same name as
another vocabulary filter, you get a ConflictException error.
List<E> words
The words to use in the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies.
If you provide a list of words in the Words parameter, you can't use the
VocabularyFilterFileUri parameter.
String vocabularyFilterFileUri
The Amazon S3 location of a text file used as input to create the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies.
The specified file must be less than 50 KB of UTF-8 characters.
If you provide the location of a list of words in the VocabularyFilterFileUri parameter, you can't
use the Words parameter.
String vocabularyName
The name of the vocabulary to update. The name is case sensitive. If you try to update a vocabulary with the same
name as a previous vocabulary you will receive a ConflictException error.
String languageCode
The language code of the vocabulary entries.
List<E> phrases
An array of strings containing the vocabulary entries.
String vocabularyFileUri
The S3 location of the text file that contains the definition of the custom vocabulary. The URI must be in the same region as the API endpoint that you are calling. The general form is
For example:
For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.
For more information about custom vocabularies, see Custom Vocabularies.
String vocabularyName
The name of the vocabulary that was updated.
String languageCode
The language code of the vocabulary entries.
Date lastModifiedTime
The date and time that the vocabulary was updated.
String vocabularyState
The processing state of the vocabulary. When the VocabularyState field contains READY
the vocabulary is ready to be used in a StartTranscriptionJob request.
String vocabularyFilterName
The name of the vocabulary filter. The name must be unique in the account that holds the filter.
String languageCode
The language code of the words in the vocabulary filter.
Date lastModifiedTime
The date and time that the vocabulary was last updated.
String vocabularyName
The name of the vocabulary.
String languageCode
The language code of the vocabulary entries.
Date lastModifiedTime
The date and time that the vocabulary was last modified.
String vocabularyState
The processing state of the vocabulary. If the state is READY you can use the vocabulary in a
StartTranscriptionJob request.
Copyright © 2021. All rights reserved.