Creates a new custom vocabulary that you can use to change how Amazon Transcribe Medical transcribes your audio file.
" + "documentation":"Creates a new custom vocabulary that you can use to modify how Amazon Transcribe Medical transcribes your audio file.
" }, "CreateVocabulary":{ "name":"CreateVocabulary", @@ -414,6 +414,22 @@ ], "documentation":"Returns a list of vocabularies that match the specified criteria. If you don't enter a value in any of the request parameters, returns the entire list of vocabularies.
" }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"Lists all tags associated with a given transcription job, vocabulary, or resource.
" + }, "ListTranscriptionJobs":{ "name":"ListTranscriptionJobs", "http":{ @@ -507,6 +523,40 @@ ], "documentation":"Starts an asynchronous job to transcribe speech to text.
" }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ConflictException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"Tags a Amazon Transcribe resource with the given list of tags.
" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"BadRequestException"}, + {"shape":"ConflictException"}, + {"shape":"NotFoundException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"Removes specified tags from a specified Amazon Transcribe resource.
" + }, "UpdateCallAnalyticsCategory":{ "name":"UpdateCallAnalyticsCategory", "http":{ @@ -637,7 +687,7 @@ }, "LanguageCode":{ "shape":"LanguageCode", - "documentation":"If you know the language spoken between the customer and the agent, specify a language code for this field.
If you don't know the language, you can leave this field blank, and Amazon Transcribe will use machine learning to automatically identify the language. To improve the accuracy of language identification, you can provide an array containing the possible language codes for the language spoken in your audio.
The following list shows the supported languages and corresponding language codes for call analytics jobs:
Gulf Arabic (ar-AE)
Mandarin Chinese, Mainland (zh-CN)
Australian English (en-AU)
British English (en-GB)
Indian English (en-IN)
Irish English (en-IE)
Scottish English (en-AB)
US English (en-US)
Welsh English (en-WL)
Spanish (es-ES)
US Spanish (es-US)
French (fr-FR)
Canadian French (fr-CA)
German (de-DE)
Swiss German (de-CH)
Indian Hindi (hi-IN)
Italian (it-IT)
Japanese (ja-JP)
Korean (ko-KR)
Portuguese (pt-PT)
Brazilian Portuguese (pt-BR)
If you know the language spoken between the customer and the agent, specify a language code for this field.
If you don't know the language, you can leave this field blank, and Amazon Transcribe will use machine learning to automatically identify the language. To improve the accuracy of language identification, you can provide an array containing the possible language codes for the language spoken in your audio. Refer to Supported languages and language-specific features for additional information.
" }, "MediaSampleRateHertz":{ "shape":"MediaSampleRateHertz", @@ -663,7 +713,7 @@ }, "FailureReason":{ "shape":"FailureReason", - "documentation":"If the AnalyticsJobStatus 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 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.
If the AnalyticsJobStatus 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 the two values match.
Invalid sample rate for audio file: The sample rate specified in the MediaSampleRateHertz of the request isn't valid. The sample rate must be between 8,000 and 48,000 Hertz.
The sample rate provided does not match the detected sample rate: The sample rate in the audio file doesn't match the sample rate specified in the MediaSampleRateHertz field in the request. Check the sample rate of your media file and make sure that the two values match.
Invalid file size: file size too large: The size of your audio file is larger than what Amazon Transcribe Medical can process. For more information, see Guidelines and Quotas in the Amazon Transcribe Medical Guide.
Invalid number of channels: number of channels too large: Your audio contains more channels than Amazon Transcribe Medical is configured to process. To request additional channels, see Amazon Transcribe Medical Endpoints and Quotas in the Amazon Web Services General Reference.
When you run a call analytics job, you can specify the language spoken in the audio, or you can have Amazon Transcribe identify the language for you.
To specify a language, specify an array with one language code. If you don't know the language, you can leave this field blank and Amazon Transcribe will use machine learning to identify the language for you. To improve the ability of Amazon Transcribe to correctly identify the language, you can provide an array of the languages that can be present in the audio.
The following list shows the supported languages and corresponding language codes for call analytics jobs:
Gulf Arabic (ar-AE)
Mandarin Chinese, Mainland (zh-CN)
Australian English (en-AU)
British English (en-GB)
Indian English (en-IN)
Irish English (en-IE)
Scottish English (en-AB)
US English (en-US)
Welsh English (en-WL)
Spanish (es-ES)
US Spanish (es-US)
French (fr-FR)
Canadian French (fr-CA)
German (de-DE)
Swiss German (de-CH)
Indian Hindi (hi-IN)
Italian (it-IT)
Japanese (ja-JP)
Korean (ko-KR)
Portuguese (pt-PT)
Brazilian Portuguese (pt-BR)
When you run a call analytics job, you can specify the language spoken in the audio, or you can have Amazon Transcribe identify the language for you.
To specify a language, specify an array with one language code. If you don't know the language, you can leave this field blank and Amazon Transcribe will use machine learning to identify the language for you. To improve the ability of Amazon Transcribe to correctly identify the language, you can provide an array of the languages that can be present in the audio. Refer to Supported languages and language-specific features for additional information.
" } }, "documentation":"Provides optional settings for the CallAnalyticsJob operation.
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.
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,000 Hz 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,000 Hz, choose Narrowband.
Contains the data access role and the Amazon S3 prefixes to read the required input files to create a custom language model.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"Adds one or more tags, each in the form of a key:value pair, to a new language model at the time you create this new model.
" } } }, @@ -944,6 +998,10 @@ "VocabularyFileUri":{ "shape":"Uri", "documentation":"The location in Amazon S3 of the text file you use to define your custom vocabulary. The URI must be in the same Amazon Web Services 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.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"Adds one or more tags, each in the form of a key:value pair, to a new medical vocabulary at the time you create this new vocabulary.
" } } }, @@ -994,6 +1052,10 @@ "VocabularyFilterFileUri":{ "shape":"Uri", "documentation":"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.
Adds one or more tags, each in the form of a key:value pair, to a new Amazon Transcribe vocabulary filter at the time you create this new vocabulary filter.
" } } }, @@ -1027,7 +1089,7 @@ }, "LanguageCode":{ "shape":"LanguageCode", - "documentation":"The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see what-is-transcribe.
" + "documentation":"The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see transcribe-whatis.
" }, "Phrases":{ "shape":"Phrases", @@ -1035,7 +1097,11 @@ }, "VocabularyFileUri":{ "shape":"Uri", - "documentation":"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.
" + "documentation":"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.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"Adds one or more tags, each in the form of a key:value pair, to a new Amazon Transcribe vocabulary at the time you create this new vocabulary.
" } } }, @@ -1261,7 +1327,7 @@ }, "VocabularyState":{ "shape":"VocabularyState", - "documentation":"The processing state of the vocabulary. If the VocabularyState is READY then you can use it in the StartMedicalTranscriptionJob operation.
The processing state of the vocabulary. If the VocabularyState is READY then you can use it in the StartMedicalTranscriptionJob operation.
The maximum number of categories to return in the response. If there are fewer results in the list, the response contains only the actual results.
" + "documentation":"The maximum number of categories to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.
" } } }, @@ -1583,7 +1649,7 @@ }, "MaxResults":{ "shape":"MaxResults", - "documentation":"The maximum number of call analytics jobs to return in the response. If there are fewer results in the list, this response contains only the actual results.
" + "documentation":"The maximum number of call analytics jobs to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.
" } } }, @@ -1621,7 +1687,7 @@ }, "MaxResults":{ "shape":"MaxResults", - "documentation":"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.
" + "documentation":"The maximum number of language models to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.
" } } }, @@ -1655,7 +1721,7 @@ }, "MaxResults":{ "shape":"MaxResults", - "documentation":"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.
" + "documentation":"The maximum number of medical transcription jobs to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.
" } } }, @@ -1685,7 +1751,7 @@ }, "MaxResults":{ "shape":"MaxResults", - "documentation":"The maximum number of vocabularies to return in the response.
" + "documentation":"The maximum number of vocabularies to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.
" }, "StateEquals":{ "shape":"VocabularyState", @@ -1714,12 +1780,35 @@ } } }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"TranscribeArn", + "documentation":"Lists all tags associated with a given Amazon Resource Name (ARN).
" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "ResourceArn":{ + "shape":"TranscribeArn", + "documentation":"Lists all tags associated with the given Amazon Resource Name (ARN).
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"Lists all tags associated with the given transcription job, vocabulary, or resource.
" + } + } + }, "ListTranscriptionJobsRequest":{ "type":"structure", "members":{ "Status":{ "shape":"TranscriptionJobStatus", - "documentation":"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.
" + "documentation":"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.
" }, "JobNameContains":{ "shape":"TranscriptionJobName", @@ -1731,7 +1820,7 @@ }, "MaxResults":{ "shape":"MaxResults", - "documentation":"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.
" + "documentation":"The maximum number of jobs to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.
" } } }, @@ -1761,7 +1850,7 @@ }, "MaxResults":{ "shape":"MaxResults", - "documentation":"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.
" + "documentation":"The maximum number of vocabularies to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.
" }, "StateEquals":{ "shape":"VocabularyState", @@ -1799,7 +1888,7 @@ }, "MaxResults":{ "shape":"MaxResults", - "documentation":"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.
" + "documentation":"The maximum number of filters to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.
" }, "NameContains":{ "shape":"VocabularyFilterName", @@ -1922,7 +2011,7 @@ }, "FailureReason":{ "shape":"FailureReason", - "documentation":"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
If the TranscriptionJobStatus field is FAILED, this field contains information about why the job failed.
The FailureReason field contains one of the following values:
Unsupported media format- The media format specified in the MediaFormat field of the request isn't valid. See the description of the MediaFormat field for a list of valid values.
The media format provided does not match the detected media format- The media format of the audio file doesn't match the format specified in the MediaFormat field in the request. Check the media format of your media file and make sure the two values match.
Invalid sample rate for audio file- The sample rate specified in the MediaSampleRateHertz of the request isn't valid. The sample rate must be between 8,000 and 48,000 Hertz.
The sample rate provided does not match the detected sample rate- The sample rate in the audio file doesn't match the sample rate specified in the MediaSampleRateHertz field in the request. Check the sample rate of your media file and make sure that the two values match.
Invalid file size: file size too large- The size of your audio file is larger than what Amazon Transcribe Medical can process. For more information, see Guidelines and Quotas in the Amazon Transcribe Medical Guide
Invalid number of channels: number of channels too large- Your audio contains more channels than Amazon Transcribe Medical is configured to process. To request additional channels, see Amazon Transcribe Medical Endpoints and Quotas in the Amazon Web Services General Reference
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
The medical specialty of any clinicians providing a dictation or having a conversation. Refer to Transcribing a medical conversationfor a list of supported specialties.
" }, "Type":{ "shape":"Type", "documentation":"The type of speech in the transcription job. CONVERSATION is generally used for patient-physician dialogues. DICTATION is the setting for physicians speaking their notes after seeing a patient. For more information, see What is Amazon Transcribe Medical?.
A key:value pair assigned to a given medical transcription job.
" } }, "documentation":"The data structure that contains the information for a medical transcription job.
" @@ -1980,11 +2073,11 @@ }, "OutputLocationType":{ "shape":"OutputLocationType", - "documentation":"Indicates the location of the transcription job's output.
The CUSTOMER_BUCKET is the S3 location provided in the OutputBucketName field when the
Indicates the location of the transcription job's output. This field must be the path of an S3 bucket; if you don't already have an S3 bucket, one is created based on the path you add.
" }, "Specialty":{ "shape":"Specialty", - "documentation":"The medical specialty of the transcription job. Primary care is the only valid value.
The medical specialty of the transcription job. Refer to Transcribing a medical conversationfor a list of supported specialties.
" }, "ContentIdentificationType":{ "shape":"MedicalContentIdentificationType", @@ -2152,7 +2245,7 @@ "members":{ "StartPercentage":{ "shape":"Percentage", - "documentation":"A value that indicates the percentage of the beginning of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
StartPercentage - 10
EndPercentage - 50
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
" + "documentation":"A value that indicates the percentage of the beginning of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
StartPercentage - 10
EndPercentage - 50
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
" }, "EndPercentage":{ "shape":"Percentage", @@ -2291,16 +2384,16 @@ "members":{ "CallAnalyticsJobName":{ "shape":"CallAnalyticsJobName", - "documentation":"The name of the call analytics job. You can't use the string \".\" or \"..\" by themselves as the job name. The name must also be unique within an AWS account. If you try to create a call analytics job with the same name as a previous call analytics job, you get a ConflictException error.
The name of the call analytics job. You can't use the string \".\" or \"..\" by themselves as the job name. The name must also be unique within an Amazon Web Services account. If you try to create a call analytics job with the same name as a previous call analytics job, you get a ConflictException error.
The Amazon S3 location where the output of the call analytics job is stored. You can provide the following location types to store the output of call analytics job:
s3://DOC-EXAMPLE-BUCKET1
If you specify a bucket, Amazon Transcribe saves the output of the analytics job as a JSON file at the root level of the bucket.
s3://DOC-EXAMPLE-BUCKET1/folder/
f you specify a path, Amazon Transcribe saves the output of the analytics job as s3://DOC-EXAMPLE-BUCKET1/folder/your-transcription-job-name.json
If you specify a folder, you must provide a trailing slash.
s3://DOC-EXAMPLE-BUCKET1/folder/filename.json
If you provide a path that has the filename specified, Amazon Transcribe saves the output of the analytics job as s3://DOC-EXAMPLEBUCKET1/folder/filename.json
You can specify an AWS Key Management Service key to encrypt the output of our analytics job 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 the analytics job output that is placed in your S3 bucket.
The Amazon S3 location where the output of the call analytics job is stored. You can provide the following location types to store the output of call analytics job:
s3://DOC-EXAMPLE-BUCKET1
If you specify a bucket, Amazon Transcribe saves the output of the analytics job as a JSON file at the root level of the bucket.
s3://DOC-EXAMPLE-BUCKET1/folder/
f you specify a path, Amazon Transcribe saves the output of the analytics job as s3://DOC-EXAMPLE-BUCKET1/folder/your-transcription-job-name.json
If you specify a folder, you must provide a trailing slash.
s3://DOC-EXAMPLE-BUCKET1/folder/filename.json
If you provide a path that has the filename specified, Amazon Transcribe saves the output of the analytics job as s3://DOC-EXAMPLEBUCKET1/folder/filename.json
You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the output of our analytics job 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 the analytics job output that is placed in your S3 bucket.
The Amazon Resource Name (ARN) of the AWS Key Management Service key used to encrypt the output of the call analytics job. The user calling the operation must have permission to use the specified KMS key.
You use either of the following to identify an AWS 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-56ef1234567890ab\"
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 call analytics 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 OutputLocation parameter.
The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service key used to encrypt the output of the call analytics job. The user calling the operation must have permission to use the specified KMS key.
You use either of the following to identify an Amazon Web Services 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-56ef1234567890ab\"
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 call analytics 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 OutputLocation parameter.
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.
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, such as clinical notes.
Add tags to an Amazon Transcribe medical transcription job.
" } } }, @@ -2405,7 +2502,7 @@ }, "LanguageCode":{ "shape":"LanguageCode", - "documentation":"The language code for the language used in the input media file.
To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a sample rate of 16000 Hz or higher.
" + "documentation":"The language code for the language used in the input media file.
To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a sample rate of 16,000 Hz or higher.
" }, "MediaSampleRateHertz":{ "shape":"MediaSampleRateHertz", @@ -2429,7 +2526,7 @@ }, "OutputEncryptionKMSKeyId":{ "shape":"KMSKeyId", - "documentation":"The Amazon Resource Name (ARN) of the Amazon Web Services 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.
The Amazon Resource Name (ARN) of the Amazon Web Services 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.
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.
To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a sample rate of 16000 Hz or higher.
" + "documentation":"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.
To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a sample rate of 16,000 Hz or higher.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"Add tags to an Amazon Transcribe transcription job.
" } } }, @@ -2472,11 +2573,79 @@ "member":{"shape":"NonEmptyString"}, "min":1 }, + "Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the key is 'Department'.
" + }, + "Value":{ + "shape":"TagValue", + "documentation":"The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the value is 'Sales'.
" + } + }, + "documentation":"A key:value pair that adds metadata to a resource used by Amazon Transcribe. For example, a tag with the key:value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by your organization's sales department.
" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":200, + "min":1 + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":200, + "min":1 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "Tags" + ], + "members":{ + "ResourceArn":{ + "shape":"TranscribeArn", + "documentation":"The Amazon Resource Name (ARN) of the Amazon Transcribe resource you want to tag.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"The tags you are assigning to a given Amazon Transcribe resource.
" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, "TimestampMilliseconds":{ "type":"long", "max":14400000, "min":0 }, + "TranscribeArn":{ + "type":"string", + "max":1011, + "min":1, + "pattern":"arn:aws(-[^:]+)?:transcribe:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA-Z-]*/[0-9a-zA-Z._-]+" + }, "Transcript":{ "type":"structure", "members":{ @@ -2562,7 +2731,7 @@ }, "StartTime":{ "shape":"DateTime", - "documentation":"A timestamp that shows with the job was started processing.
" + "documentation":"A timestamp that shows when the job started processing.
" }, "CreationTime":{ "shape":"DateTime", @@ -2574,7 +2743,7 @@ }, "FailureReason":{ "shape":"FailureReason", - "documentation":"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.
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 8,000 and 48,000 Hertz.
The sample rate provided does not match the detected sample rate - The sample rate in the audio file doesn't match the sample rate specified in the MediaSampleRateHertz field in the request. Check the sample rate of your media file and make sure that the two values match.
Invalid file size: file size too large - The size of your audio file is larger than 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.
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.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"A key:value pair assigned to a given transcription job.
" } }, "documentation":"Describes an asynchronous transcription job that was created with the StartTranscriptionJob operation.
The Amazon Resource Name (ARN) of the Amazon Transcribe resource you want to remove tags from.
" + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"A list of tag keys you want to remove from a specified Amazon Transcribe resource.
" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, "UpdateCallAnalyticsCategoryRequest":{ "type":"structure", "required":[ @@ -2693,7 +2888,7 @@ "members":{ "CategoryName":{ "shape":"CategoryName", - "documentation":"The name of the analytics category to update. The name is case sensitive. If you try to update a call analytics category with the same name as a previous category you will receive a ConflictException error.
The name of the analytics category to update. The name is case sensitive. If you try to update a call analytics category with the same name as a previous category you will receive a ConflictException error.
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 Amazon Web Services 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.
" + "documentation":"The location in Amazon S3 of the text file that contains your custom vocabulary. The URI must be in the same Amazon Web Services 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.
" } } }, @@ -2800,7 +2995,7 @@ }, "LanguageCode":{ "shape":"LanguageCode", - "documentation":"The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see what-is-transcribe.
" + "documentation":"The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see transcribe-whatis.
" }, "Phrases":{ "shape":"Phrases",