Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Transcribes the audio from a medical dictation or conversation and applies any additional Request Parameters you choose to include in your request.
In addition to many standard transcription features, Amazon Transcribe Medical provides you with a robust medical vocabulary and, optionally, content identification, which adds flags to personal health information (PHI). To learn more about these features, refer to How Amazon Transcribe Medical works.
To make a StartMedicalTranscriptionJob
request, you must first upload
your media file into an Amazon S3 bucket; you can then specify the S3
location of the file using the Media
parameter.
You must include the following parameters in your
StartMedicalTranscriptionJob
request:
region
: The Amazon Web Services Region where you are making your request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas.MedicalTranscriptionJobName
: A custom name you create for your transcription job that is unique within your Amazon Web Services account.Media
(MediaFileUri
): The Amazon S3 location of your media file.LanguageCode
: This must been-US
.OutputBucketName
: The Amazon S3 bucket where you want your transcript stored. If you want your output stored in a sub-folder of this bucket, you must also includeOutputKey
.Specialty
: This must bePRIMARYCARE
.Type
: Choose whether your audio is a conversation or a dictation.
Synopsis
- data StartMedicalTranscriptionJob = StartMedicalTranscriptionJob' {
- contentIdentificationType :: Maybe MedicalContentIdentificationType
- kmsEncryptionContext :: Maybe (HashMap Text Text)
- mediaFormat :: Maybe MediaFormat
- mediaSampleRateHertz :: Maybe Natural
- outputEncryptionKMSKeyId :: Maybe Text
- outputKey :: Maybe Text
- settings :: Maybe MedicalTranscriptionSetting
- tags :: Maybe (NonEmpty Tag)
- medicalTranscriptionJobName :: Text
- languageCode :: LanguageCode
- media :: Media
- outputBucketName :: Text
- specialty :: Specialty
- type' :: Type
- newStartMedicalTranscriptionJob :: Text -> LanguageCode -> Media -> Text -> Specialty -> Type -> StartMedicalTranscriptionJob
- startMedicalTranscriptionJob_contentIdentificationType :: Lens' StartMedicalTranscriptionJob (Maybe MedicalContentIdentificationType)
- startMedicalTranscriptionJob_kmsEncryptionContext :: Lens' StartMedicalTranscriptionJob (Maybe (HashMap Text Text))
- startMedicalTranscriptionJob_mediaFormat :: Lens' StartMedicalTranscriptionJob (Maybe MediaFormat)
- startMedicalTranscriptionJob_mediaSampleRateHertz :: Lens' StartMedicalTranscriptionJob (Maybe Natural)
- startMedicalTranscriptionJob_outputEncryptionKMSKeyId :: Lens' StartMedicalTranscriptionJob (Maybe Text)
- startMedicalTranscriptionJob_outputKey :: Lens' StartMedicalTranscriptionJob (Maybe Text)
- startMedicalTranscriptionJob_settings :: Lens' StartMedicalTranscriptionJob (Maybe MedicalTranscriptionSetting)
- startMedicalTranscriptionJob_tags :: Lens' StartMedicalTranscriptionJob (Maybe (NonEmpty Tag))
- startMedicalTranscriptionJob_medicalTranscriptionJobName :: Lens' StartMedicalTranscriptionJob Text
- startMedicalTranscriptionJob_languageCode :: Lens' StartMedicalTranscriptionJob LanguageCode
- startMedicalTranscriptionJob_media :: Lens' StartMedicalTranscriptionJob Media
- startMedicalTranscriptionJob_outputBucketName :: Lens' StartMedicalTranscriptionJob Text
- startMedicalTranscriptionJob_specialty :: Lens' StartMedicalTranscriptionJob Specialty
- startMedicalTranscriptionJob_type :: Lens' StartMedicalTranscriptionJob Type
- data StartMedicalTranscriptionJobResponse = StartMedicalTranscriptionJobResponse' {}
- newStartMedicalTranscriptionJobResponse :: Int -> StartMedicalTranscriptionJobResponse
- startMedicalTranscriptionJobResponse_medicalTranscriptionJob :: Lens' StartMedicalTranscriptionJobResponse (Maybe MedicalTranscriptionJob)
- startMedicalTranscriptionJobResponse_httpStatus :: Lens' StartMedicalTranscriptionJobResponse Int
Creating a Request
data StartMedicalTranscriptionJob Source #
See: newStartMedicalTranscriptionJob
smart constructor.
StartMedicalTranscriptionJob' | |
|
Instances
newStartMedicalTranscriptionJob Source #
:: Text | |
-> LanguageCode | |
-> Media | |
-> Text | |
-> Specialty | |
-> Type | |
-> StartMedicalTranscriptionJob |
Create a value of StartMedicalTranscriptionJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StartMedicalTranscriptionJob
, startMedicalTranscriptionJob_contentIdentificationType
- Labels all personal health information (PHI) identified in your
transcript. For more information, see
Identifying personal health information (PHI) in a transcription.
$sel:kmsEncryptionContext:StartMedicalTranscriptionJob'
, startMedicalTranscriptionJob_kmsEncryptionContext
- A map of plain text, non-secret key:value pairs, known as encryption
context pairs, that provide an added layer of security for your data.
For more information, see
KMS encryption context
and
Asymmetric keys in KMS.
StartMedicalTranscriptionJob
, startMedicalTranscriptionJob_mediaFormat
- Specify the format of your input media file.
StartMedicalTranscriptionJob
, startMedicalTranscriptionJob_mediaSampleRateHertz
- The sample rate, in hertz, of the audio track in your input media file.
If you don't specify the media sample rate, Amazon Transcribe Medical
determines it for you. If you specify the sample rate, it must match the
rate detected by Amazon Transcribe Medical; if there's a mismatch
between the value that you specify and the value detected, your job
fails. Therefore, in most cases, it's advised to omit
MediaSampleRateHertz
and let Amazon Transcribe Medical determine the
sample rate.
$sel:outputEncryptionKMSKeyId:StartMedicalTranscriptionJob'
, startMedicalTranscriptionJob_outputEncryptionKMSKeyId
- The KMS key you want to use to encrypt your medical transcription
output.
If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways:
- Use the KMS key ID itself. For example,
1234abcd-12ab-34cd-56ef-1234567890ab
. - Use an alias for the KMS key ID. For example,
alias/ExampleAlias
. - Use the Amazon Resource Name (ARN) for the KMS key ID. For example,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab
. - Use the ARN for the KMS key alias. For example,
arn:aws:kms:region:account-ID:alias/ExampleAlias
.
If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways:
- Use the ARN for the KMS key ID. For example,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab
. - Use the ARN for the KMS key alias. For example,
arn:aws:kms:region:account-ID:alias/ExampleAlias
.
If you don't specify an encryption key, your output 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 using the OutputLocation
parameter.
Note that the user making the request must have permission to use the specified KMS key.
$sel:outputKey:StartMedicalTranscriptionJob'
, startMedicalTranscriptionJob_outputKey
- Use in combination with OutputBucketName
to specify the output
location of your transcript and, optionally, a unique name for your
output file. The default name for your transcription output is the same
as the name you specified for your medical transcription job
(MedicalTranscriptionJobName
).
Here are some examples of how you can use OutputKey
:
- If you specify 'DOC-EXAMPLE-BUCKET' as the
OutputBucketName
and 'my-transcript.json' as theOutputKey
, your transcription output path iss3://DOC-EXAMPLE-BUCKET/my-transcript.json
. - If you specify 'my-first-transcription' as the
MedicalTranscriptionJobName
, 'DOC-EXAMPLE-BUCKET' as theOutputBucketName
, and 'my-transcript' as theOutputKey
, your transcription output path iss3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json
. - If you specify 'DOC-EXAMPLE-BUCKET' as the
OutputBucketName
and 'test-files/my-transcript.json' as theOutputKey
, your transcription output path iss3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json
. - If you specify 'my-first-transcription' as the
MedicalTranscriptionJobName
, 'DOC-EXAMPLE-BUCKET' as theOutputBucketName
, and 'test-files/my-transcript' as theOutputKey
, your transcription output path iss3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json
.
If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist, one is created for you.
StartMedicalTranscriptionJob
, startMedicalTranscriptionJob_settings
- Specify additional optional settings in your request, including channel
identification, alternative transcriptions, and speaker partitioning.
You can use that to apply custom vocabularies to your transcription job.
StartMedicalTranscriptionJob
, startMedicalTranscriptionJob_tags
- Adds one or more custom tags, each in the form of a key:value pair, to a
new medical transcription job at the time you start this new job.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
StartMedicalTranscriptionJob
, startMedicalTranscriptionJob_medicalTranscriptionJobName
- A unique name, chosen by you, for your medical transcription job. The
name that you specify is also used as the default name of your
transcription output file. If you want to specify a different name for
your transcription output, use the OutputKey
parameter.
This name is case sensitive, cannot contain spaces, and must be unique
within an Amazon Web Services account. If you try to create a new job
with the same name as an existing job, you get a ConflictException
error.
StartMedicalTranscriptionJob
, startMedicalTranscriptionJob_languageCode
- The language code that represents the language spoken in the input media
file. US English (en-US
) is the only valid value for medical
transcription jobs. Any other value you enter for language code results
in a BadRequestException
error.
StartMedicalTranscriptionJob
, startMedicalTranscriptionJob_media
- Undocumented member.
$sel:outputBucketName:StartMedicalTranscriptionJob'
, startMedicalTranscriptionJob_outputBucketName
- The name of the Amazon S3 bucket where you want your medical
transcription output stored. Do not include the S3://
prefix of the
specified bucket.
If you want your output to go to a sub-folder of this bucket, specify it
using the OutputKey
parameter; OutputBucketName
only accepts the
name of a bucket.
For example, if you want your output stored in
S3://DOC-EXAMPLE-BUCKET
, set OutputBucketName
to
DOC-EXAMPLE-BUCKET
. However, if you want your output stored in
S3://DOC-EXAMPLE-BUCKET/test-files/
, set OutputBucketName
to
DOC-EXAMPLE-BUCKET
and OutputKey
to test-files/
.
Note that Amazon Transcribe must have permission to use the specified location. You can change Amazon S3 permissions using the Amazon Web Services Management Console. See also Permissions Required for IAM User Roles.
StartMedicalTranscriptionJob
, startMedicalTranscriptionJob_specialty
- Specify the predominant medical specialty represented in your media. For
batch transcriptions, PRIMARYCARE
is the only valid value. If you
require additional specialties, refer to .
StartMedicalTranscriptionJob
, startMedicalTranscriptionJob_type
- Specify whether your input media contains only one person (DICTATION
)
or contains a conversation between two people (CONVERSATION
).
For example, DICTATION
could be used for a medical professional
wanting to transcribe voice memos; CONVERSATION
could be used for
transcribing the doctor-patient dialogue during the patient's office
visit.
Request Lenses
startMedicalTranscriptionJob_contentIdentificationType :: Lens' StartMedicalTranscriptionJob (Maybe MedicalContentIdentificationType) Source #
Labels all personal health information (PHI) identified in your transcript. For more information, see Identifying personal health information (PHI) in a transcription.
startMedicalTranscriptionJob_kmsEncryptionContext :: Lens' StartMedicalTranscriptionJob (Maybe (HashMap Text Text)) Source #
A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data. For more information, see KMS encryption context and Asymmetric keys in KMS.
startMedicalTranscriptionJob_mediaFormat :: Lens' StartMedicalTranscriptionJob (Maybe MediaFormat) Source #
Specify the format of your input media file.
startMedicalTranscriptionJob_mediaSampleRateHertz :: Lens' StartMedicalTranscriptionJob (Maybe Natural) Source #
The sample rate, in hertz, of the audio track in your input media file.
If you don't specify the media sample rate, Amazon Transcribe Medical
determines it for you. If you specify the sample rate, it must match the
rate detected by Amazon Transcribe Medical; if there's a mismatch
between the value that you specify and the value detected, your job
fails. Therefore, in most cases, it's advised to omit
MediaSampleRateHertz
and let Amazon Transcribe Medical determine the
sample rate.
startMedicalTranscriptionJob_outputEncryptionKMSKeyId :: Lens' StartMedicalTranscriptionJob (Maybe Text) Source #
The KMS key you want to use to encrypt your medical transcription output.
If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways:
- Use the KMS key ID itself. For example,
1234abcd-12ab-34cd-56ef-1234567890ab
. - Use an alias for the KMS key ID. For example,
alias/ExampleAlias
. - Use the Amazon Resource Name (ARN) for the KMS key ID. For example,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab
. - Use the ARN for the KMS key alias. For example,
arn:aws:kms:region:account-ID:alias/ExampleAlias
.
If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways:
- Use the ARN for the KMS key ID. For example,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab
. - Use the ARN for the KMS key alias. For example,
arn:aws:kms:region:account-ID:alias/ExampleAlias
.
If you don't specify an encryption key, your output 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 using the OutputLocation
parameter.
Note that the user making the request must have permission to use the specified KMS key.
startMedicalTranscriptionJob_outputKey :: Lens' StartMedicalTranscriptionJob (Maybe Text) Source #
Use in combination with OutputBucketName
to specify the output
location of your transcript and, optionally, a unique name for your
output file. The default name for your transcription output is the same
as the name you specified for your medical transcription job
(MedicalTranscriptionJobName
).
Here are some examples of how you can use OutputKey
:
- If you specify 'DOC-EXAMPLE-BUCKET' as the
OutputBucketName
and 'my-transcript.json' as theOutputKey
, your transcription output path iss3://DOC-EXAMPLE-BUCKET/my-transcript.json
. - If you specify 'my-first-transcription' as the
MedicalTranscriptionJobName
, 'DOC-EXAMPLE-BUCKET' as theOutputBucketName
, and 'my-transcript' as theOutputKey
, your transcription output path iss3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json
. - If you specify 'DOC-EXAMPLE-BUCKET' as the
OutputBucketName
and 'test-files/my-transcript.json' as theOutputKey
, your transcription output path iss3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json
. - If you specify 'my-first-transcription' as the
MedicalTranscriptionJobName
, 'DOC-EXAMPLE-BUCKET' as theOutputBucketName
, and 'test-files/my-transcript' as theOutputKey
, your transcription output path iss3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json
.
If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist, one is created for you.
startMedicalTranscriptionJob_settings :: Lens' StartMedicalTranscriptionJob (Maybe MedicalTranscriptionSetting) Source #
Specify additional optional settings in your request, including channel identification, alternative transcriptions, and speaker partitioning. You can use that to apply custom vocabularies to your transcription job.
startMedicalTranscriptionJob_tags :: Lens' StartMedicalTranscriptionJob (Maybe (NonEmpty Tag)) Source #
Adds one or more custom tags, each in the form of a key:value pair, to a new medical transcription job at the time you start this new job.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
startMedicalTranscriptionJob_medicalTranscriptionJobName :: Lens' StartMedicalTranscriptionJob Text Source #
A unique name, chosen by you, for your medical transcription job. The
name that you specify is also used as the default name of your
transcription output file. If you want to specify a different name for
your transcription output, use the OutputKey
parameter.
This name is case sensitive, cannot contain spaces, and must be unique
within an Amazon Web Services account. If you try to create a new job
with the same name as an existing job, you get a ConflictException
error.
startMedicalTranscriptionJob_languageCode :: Lens' StartMedicalTranscriptionJob LanguageCode Source #
The language code that represents the language spoken in the input media
file. US English (en-US
) is the only valid value for medical
transcription jobs. Any other value you enter for language code results
in a BadRequestException
error.
startMedicalTranscriptionJob_media :: Lens' StartMedicalTranscriptionJob Media Source #
Undocumented member.
startMedicalTranscriptionJob_outputBucketName :: Lens' StartMedicalTranscriptionJob Text Source #
The name of the Amazon S3 bucket where you want your medical
transcription output stored. Do not include the S3://
prefix of the
specified bucket.
If you want your output to go to a sub-folder of this bucket, specify it
using the OutputKey
parameter; OutputBucketName
only accepts the
name of a bucket.
For example, if you want your output stored in
S3://DOC-EXAMPLE-BUCKET
, set OutputBucketName
to
DOC-EXAMPLE-BUCKET
. However, if you want your output stored in
S3://DOC-EXAMPLE-BUCKET/test-files/
, set OutputBucketName
to
DOC-EXAMPLE-BUCKET
and OutputKey
to test-files/
.
Note that Amazon Transcribe must have permission to use the specified location. You can change Amazon S3 permissions using the Amazon Web Services Management Console. See also Permissions Required for IAM User Roles.
startMedicalTranscriptionJob_specialty :: Lens' StartMedicalTranscriptionJob Specialty Source #
Specify the predominant medical specialty represented in your media. For
batch transcriptions, PRIMARYCARE
is the only valid value. If you
require additional specialties, refer to .
startMedicalTranscriptionJob_type :: Lens' StartMedicalTranscriptionJob Type Source #
Specify whether your input media contains only one person (DICTATION
)
or contains a conversation between two people (CONVERSATION
).
For example, DICTATION
could be used for a medical professional
wanting to transcribe voice memos; CONVERSATION
could be used for
transcribing the doctor-patient dialogue during the patient's office
visit.
Destructuring the Response
data StartMedicalTranscriptionJobResponse Source #
See: newStartMedicalTranscriptionJobResponse
smart constructor.
StartMedicalTranscriptionJobResponse' | |
|
Instances
newStartMedicalTranscriptionJobResponse Source #
Create a value of StartMedicalTranscriptionJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:medicalTranscriptionJob:StartMedicalTranscriptionJobResponse'
, startMedicalTranscriptionJobResponse_medicalTranscriptionJob
- Provides detailed information about the current medical transcription
job, including job status and, if applicable, failure reason.
$sel:httpStatus:StartMedicalTranscriptionJobResponse'
, startMedicalTranscriptionJobResponse_httpStatus
- The response's http status code.
Response Lenses
startMedicalTranscriptionJobResponse_medicalTranscriptionJob :: Lens' StartMedicalTranscriptionJobResponse (Maybe MedicalTranscriptionJob) Source #
Provides detailed information about the current medical transcription job, including job status and, if applicable, failure reason.
startMedicalTranscriptionJobResponse_httpStatus :: Lens' StartMedicalTranscriptionJobResponse Int Source #
The response's http status code.