{"openapi":"3.0.0","info":{"description":"Amazon Transcribe is an automatic speech recognition (ASR) service that makes it easy for developers to add speech-to-text capability to their applications","version":[{"name":"v1","value":"v1"}]},"servers":[{"description":"Amazon Transcribe is an automatic speech recognition (ASR) service that makes it easy for developers to add speech-to-text capability to their applications","url":"https://api.apirails.com/awstranscribe"}],"paths":{"/CreateCallAnalyticsCategory":{"post":{"tags":["Call Analytics"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/transcribe/latest/APIReference/API_CreateCallAnalyticsCategory.html","api_endpoint":"https://transcribe.{region}.amazonaws.com/"},"summary":"Create call analytics category","description":"Creates a new Call Analytics category. All categories are automatically applied to your Call Analytics transcriptions. Note that in order to apply categories to your transcriptions, you must create them before submitting your transcription request, as categories cannot be applied retroactively. When creating a new category, you can use the…","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"CategoryName":{"type":"string","description":"A unique name, chosen by you, for your Call Analytics category. It's helpful to use a detailed naming system that will make sense to you in the future. For example, it's better to use sentiment-positive-last30seconds for a category over a generic name like test-category . Category names are case…","required":true},"InputType":{"type":"enum","description":"Choose whether you want to create a real-time or a post-call category for your Call Analytics transcription. Specifying POST_CALL assigns your category to post-call transcriptions; categories with this input type cannot be applied to streaming (real-time) transcriptions. Specifying REAL_TIME…","enum":["REAL_TIME","POST_CALL"]},"Rules":{"type":"array","description":"Rules define a Call Analytics category. When creating a new category, you must create between 1 and 20 rules for that category. For each rule, you specify a filter you want applied to the attributes of a call. For example, you can choose a sentiment filter that detects if a customer's sentiment was…","required":true,"items":{"type":"object","properties":{"InterruptionFilter":{"type":"object","description":"Flag the presence or absence of interruptions in your Call Analytics transcription output. Refer to for more detail."},"NonTalkTimeFilter":{"type":"object","description":"Flag the presence or absence of periods of silence in your Call Analytics transcription output. Refer to for more detail."},"SentimentFilter":{"type":"object","description":"Flag the presence or absence of specific sentiments in your Call Analytics transcription output. Refer to for more detail."},"TranscriptFilter":{"type":"object","description":"Flag the presence or absence of specific words or phrases in your Call Analytics transcription output. Refer to for more detail."}}}},"Tags":{"type":"array","description":"Adds one or more custom tags, each in the form of a key:value pair, to a new call analytics category at the time you start this new job. To learn more about using tags with Amazon Transcribe, refer to Tagging resources .","items":{"type":"object","properties":{"Key":{"type":"string","description":"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'.","required":true},"Value":{"type":"string","description":"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'. Note…","required":true}}}}}},"example":{"CategoryName":"","InputType":"","Rules":[],"Tags":[]}}}}}},"/CreateLanguageModel":{"post":{"tags":["Language Models"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/transcribe/latest/APIReference/API_CreateLanguageModel.html","api_endpoint":"https://transcribe.{region}.amazonaws.com/"},"summary":"Create language model","description":"Creates a new custom language model. When creating a new custom language model, you must specify: If you want a Wideband (audio sample rates over 16,000 Hz) or Narrowband (audio sample rates under 16,000 Hz) base model The location of your training and tuning files (this must be an Amazon S3 URI) The language of your model A unique name for your…","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"BaseModelName":{"type":"enum","description":"The Amazon Transcribe standard language model, or base model, used to create your custom language model. Amazon Transcribe offers two options for base models: Wideband and Narrowband. If the audio you want to transcribe has a sample rate of 16,000 Hz or greater, choose WideBand . To transcribe…","required":true,"enum":["NarrowBand","WideBand"]},"InputDataConfig":{"type":"object","description":"Contains the Amazon S3 location of the training data you want to use to create a new custom language model, and permissions to access this location. When using InputDataConfig , you must include these sub-parameters: S3Uri , which is the Amazon S3 location of your training data, and…","required":true,"properties":{}},"LanguageCode":{"type":"enum","description":"The language code that represents the language of your model. Each custom language model must contain terms in only one language, and the language you select for your custom language model must match the language of your training and tuning data. For a list of supported languages and their…","required":true,"enum":["en-US","hi-IN","es-US","en-GB","en-AU","de-DE","ja-JP"]},"ModelName":{"type":"string","description":"A unique name, chosen by you, for your custom language model. 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 custom language model with the same name as an existing custom language model, you get a…","required":true},"Tags":{"type":"array","description":"Adds one or more custom tags, each in the form of a key:value pair, to a new custom language model at the time you create this new model. To learn more about using tags with Amazon Transcribe, refer to Tagging resources .","items":{"type":"object","properties":{"Key":{"type":"string","description":"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'.","required":true},"Value":{"type":"string","description":"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'. Note…","required":true}}}}}},"example":{"BaseModelName":"","InputDataConfig":{"DataAccessRoleArn":"string","S3Uri":"string","TuningDataS3Uri":"string"},"LanguageCode":"","ModelName":"","Tags":[]}}}}}},"/CreateMedicalVocabulary":{"post":{"tags":["Medical Vocabularies"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/transcribe/latest/APIReference/API_CreateMedicalVocabulary.html","api_endpoint":"https://transcribe.{region}.amazonaws.com/"},"summary":"Create medical vocabulary","description":"Creates a new custom medical vocabulary. Before creating a new custom medical vocabulary, you must first upload a text file that contains your vocabulary table into an Amazon S3 bucket. Note that this differs from , where you can include a list of terms within your request using the Phrases flag; CreateMedicalVocabulary does not support the…","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"LanguageCode":{"type":"enum","description":"The language code that represents the language of the entries in your custom vocabulary. US English ( en-US ) is the only language supported with Amazon Transcribe Medical.","required":true,"enum":["af-ZA","ar-AE","ar-SA","am-ET","cy-GB","da-DK","de-CH","de-DE","en-AB","en-AU","en-GB","en-IE","en-IN","en-US","en-WL","es-ES","es-MX","es-US","fa-AF","fa-IR","fr-CA","fr-FR","ga-IE","gd-GB","he-IL","hi-IN","ht-HT","id-ID","it-IT","ja-JP","jv-ID","km-KH","ko-KR","my-MM","ms-MY","nl-NL","pt-BR","pt-PT","ru-RU","ta-IN","te-IN","tr-TR","zh-CN","zh-TW","th-TH","en-ZA","en-NZ","vi-VN","sv-SE","ab-GE","ast-ES","az-AZ","ba-RU","be-BY","bg-BG","bn-IN","bs-BA","ca-ES","ckb-IQ","ckb-IR","cs-CZ","cy-WL","el-GR","et-EE","et-ET","eu-ES","fi-FI","gl-ES","gu-IN","ha-NG","hr-HR","hu-HU","hy-AM","is-IS","ka-GE","kab-DZ","kk-KZ","kn-IN","ky-KG","lg-IN","lt-LT","lv-LV","mhr-RU","mi-NZ","mk-MK","ml-IN","mn-MN","mr-IN","mt-MT","no-NO","ne-NP","or-IN","pa-IN","pl-PL","ps-AF","ro-RO","rw-RW","si-LK","sk-SK","sl-SI","so-SO","sq-AL","sr-RS","su-ID","sw-BI","sw-KE","sw-RW","sw-TZ","sw-UG","tl-PH","tt-RU","ug-CN","uk-UA","uz-UZ","wo-SN","zh-HK","zu-ZA"]},"Tags":{"type":"array","description":"Adds one or more custom tags, each in the form of a key:value pair, to a new custom medical vocabulary at the time you create this new custom vocabulary. To learn more about using tags with Amazon Transcribe, refer to Tagging resources .","items":{"type":"object","properties":{"Key":{"type":"string","description":"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'.","required":true},"Value":{"type":"string","description":"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'. Note…","required":true}}}},"VocabularyFileUri":{"type":"string","description":"The Amazon S3 location (URI) of the text file that contains your custom medical vocabulary. The URI must be in the same Amazon Web Services Region as the resource you're calling. Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt","required":true},"VocabularyName":{"type":"string","description":"A unique name, chosen by you, for your new custom medical vocabulary. 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 custom medical vocabulary with the same name as an existing custom medical vocabulary, you…","required":true}}},"example":{"LanguageCode":"","Tags":[],"VocabularyFileUri":"","VocabularyName":""}}}}}},"/CreateVocabulary":{"post":{"tags":["Vocabularies"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/transcribe/latest/APIReference/API_CreateVocabulary.html","api_endpoint":"https://transcribe.{region}.amazonaws.com/"},"summary":"Create vocabulary","description":"Creates a new custom vocabulary. When creating a new custom vocabulary, you can either upload a text file that contains your new entries, phrases, and terms into an Amazon S3 bucket and include the URI in your request. Or you can include a list of terms directly in your request using the Phrases flag. Each language has a character set that…","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"DataAccessRoleArn":{"type":"string","description":"The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files (in this case, your custom vocabulary). If the role that you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request…"},"LanguageCode":{"type":"enum","description":"The language code that represents the language of the entries in your custom vocabulary. Each custom vocabulary must contain terms in only one language. A custom vocabulary can only be used to transcribe files in the same language as the custom vocabulary. For example, if you create a custom…","required":true,"enum":["af-ZA","ar-AE","ar-SA","am-ET","cy-GB","da-DK","de-CH","de-DE","en-AB","en-AU","en-GB","en-IE","en-IN","en-US","en-WL","es-ES","es-MX","es-US","fa-AF","fa-IR","fr-CA","fr-FR","ga-IE","gd-GB","he-IL","hi-IN","ht-HT","id-ID","it-IT","ja-JP","jv-ID","km-KH","ko-KR","my-MM","ms-MY","nl-NL","pt-BR","pt-PT","ru-RU","ta-IN","te-IN","tr-TR","zh-CN","zh-TW","th-TH","en-ZA","en-NZ","vi-VN","sv-SE","ab-GE","ast-ES","az-AZ","ba-RU","be-BY","bg-BG","bn-IN","bs-BA","ca-ES","ckb-IQ","ckb-IR","cs-CZ","cy-WL","el-GR","et-EE","et-ET","eu-ES","fi-FI","gl-ES","gu-IN","ha-NG","hr-HR","hu-HU","hy-AM","is-IS","ka-GE","kab-DZ","kk-KZ","kn-IN","ky-KG","lg-IN","lt-LT","lv-LV","mhr-RU","mi-NZ","mk-MK","ml-IN","mn-MN","mr-IN","mt-MT","no-NO","ne-NP","or-IN","pa-IN","pl-PL","ps-AF","ro-RO","rw-RW","si-LK","sk-SK","sl-SI","so-SO","sq-AL","sr-RS","su-ID","sw-BI","sw-KE","sw-RW","sw-TZ","sw-UG","tl-PH","tt-RU","ug-CN","uk-UA","uz-UZ","wo-SN","zh-HK","zu-ZA"]},"Phrases":{"type":"array","description":"Use this parameter if you want to create your custom vocabulary by including all desired terms, as comma-separated values, within your request. The other option for creating your custom vocabulary is to save your entries in a text file and upload them to an Amazon S3 bucket, then specify the…","items":{"type":"string"}},"Tags":{"type":"array","description":"Adds one or more custom tags, each in the form of a key:value pair, to a new custom vocabulary at the time you create this new custom vocabulary. To learn more about using tags with Amazon Transcribe, refer to Tagging resources .","items":{"type":"object","properties":{"Key":{"type":"string","description":"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'.","required":true},"Value":{"type":"string","description":"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'. Note…","required":true}}}},"VocabularyFileUri":{"type":"string","description":"The Amazon S3 location of the text file that contains your custom vocabulary. The URI must be located in the same Amazon Web Services Region as the resource you're calling. Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt Note that if you include VocabularyFileUri in your…"},"VocabularyName":{"type":"string","description":"A unique name, chosen by you, for your new custom vocabulary. 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 custom vocabulary with the same name as an existing custom vocabulary, you get a ConflictException…","required":true}}},"example":{"DataAccessRoleArn":"","LanguageCode":"","Phrases":[],"Tags":[],"VocabularyFileUri":"","VocabularyName":""}}}}}},"/CreateVocabularyFilter":{"post":{"tags":["Vocabulary Filters"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/transcribe/latest/APIReference/API_CreateVocabularyFilter.html","api_endpoint":"https://transcribe.{region}.amazonaws.com/"},"summary":"Create vocabulary filter","description":"Creates a new custom vocabulary filter. You can use custom vocabulary filters to mask, delete, or flag specific words from your transcript. Custom vocabulary filters are commonly used to mask profanity in transcripts. Each language has a character set that contains all allowed characters for that specific language. If you use unsupported…","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"DataAccessRoleArn":{"type":"string","description":"The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files (in this case, your custom vocabulary filter). If the role that you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your…"},"LanguageCode":{"type":"enum","description":"The language code that represents the language of the entries in your vocabulary filter. Each custom vocabulary filter must contain terms in only one language. A custom vocabulary filter can only be used to transcribe files in the same language as the filter. For example, if you create a custom…","required":true,"enum":["af-ZA","ar-AE","ar-SA","am-ET","cy-GB","da-DK","de-CH","de-DE","en-AB","en-AU","en-GB","en-IE","en-IN","en-US","en-WL","es-ES","es-MX","es-US","fa-AF","fa-IR","fr-CA","fr-FR","ga-IE","gd-GB","he-IL","hi-IN","ht-HT","id-ID","it-IT","ja-JP","jv-ID","km-KH","ko-KR","my-MM","ms-MY","nl-NL","pt-BR","pt-PT","ru-RU","ta-IN","te-IN","tr-TR","zh-CN","zh-TW","th-TH","en-ZA","en-NZ","vi-VN","sv-SE","ab-GE","ast-ES","az-AZ","ba-RU","be-BY","bg-BG","bn-IN","bs-BA","ca-ES","ckb-IQ","ckb-IR","cs-CZ","cy-WL","el-GR","et-EE","et-ET","eu-ES","fi-FI","gl-ES","gu-IN","ha-NG","hr-HR","hu-HU","hy-AM","is-IS","ka-GE","kab-DZ","kk-KZ","kn-IN","ky-KG","lg-IN","lt-LT","lv-LV","mhr-RU","mi-NZ","mk-MK","ml-IN","mn-MN","mr-IN","mt-MT","no-NO","ne-NP","or-IN","pa-IN","pl-PL","ps-AF","ro-RO","rw-RW","si-LK","sk-SK","sl-SI","so-SO","sq-AL","sr-RS","su-ID","sw-BI","sw-KE","sw-RW","sw-TZ","sw-UG","tl-PH","tt-RU","ug-CN","uk-UA","uz-UZ","wo-SN","zh-HK","zu-ZA"]},"Tags":{"type":"array","description":"Adds one or more custom tags, each in the form of a key:value pair, to a new custom vocabulary filter at the time you create this new vocabulary filter. To learn more about using tags with Amazon Transcribe, refer to Tagging resources .","items":{"type":"object","properties":{"Key":{"type":"string","description":"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'.","required":true},"Value":{"type":"string","description":"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'. Note…","required":true}}}},"VocabularyFilterFileUri":{"type":"string","description":"The Amazon S3 location of the text file that contains your custom vocabulary filter terms. The URI must be located in the same Amazon Web Services Region as the resource you're calling. Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt Note that if you include…"},"VocabularyFilterName":{"type":"string","description":"A unique name, chosen by you, for your new custom vocabulary filter. 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 custom vocabulary filter with the same name as an existing custom vocabulary filter, you get…","required":true},"Words":{"type":"array","description":"Use this parameter if you want to create your custom vocabulary filter by including all desired terms, as comma-separated values, within your request. The other option for creating your vocabulary filter is to save your entries in a text file and upload them to an Amazon S3 bucket, then specify the…","items":{"type":"string"}}}},"example":{"DataAccessRoleArn":"","LanguageCode":"","Tags":[],"VocabularyFilterFileUri":"","VocabularyFilterName":"","Words":[]}}}}}},"/DeleteCallAnalyticsCategory":{"post":{"tags":["Call Analytics"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/transcribe/latest/APIReference/API_DeleteCallAnalyticsCategory.html","api_endpoint":"https://transcribe.{region}.amazonaws.com/"},"summary":"Delete call analytics category","description":"Deletes a Call Analytics category. To use this operation, specify the name of the category you want to delete using CategoryName . Category names are case sensitive.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"CategoryName":{"type":"string","description":"The name of the Call Analytics category you want to delete. Category names are case sensitive.","required":true}}},"example":{"CategoryName":""}}}}}},"/DeleteCallAnalyticsJob":{"post":{"tags":["Call Analytics"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/transcribe/latest/APIReference/API_DeleteCallAnalyticsJob.html","api_endpoint":"https://transcribe.{region}.amazonaws.com/"},"summary":"Delete call analytics job","description":"Deletes a Call Analytics job. To use this operation, specify the name of the job you want to delete using CallAnalyticsJobName . Job names are case sensitive.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"CallAnalyticsJobName":{"type":"string","description":"The name of the Call Analytics job you want to delete. Job names are case sensitive.","required":true}}},"example":{"CallAnalyticsJobName":""}}}}}},"/DeleteLanguageModel":{"post":{"tags":["Language Models"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/transcribe/latest/APIReference/API_DeleteLanguageModel.html","api_endpoint":"https://transcribe.{region}.amazonaws.com/"},"summary":"Delete language model","description":"Deletes a custom language model. To use this operation, specify the name of the language model you want to delete using ModelName . custom language model names are case sensitive.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ModelName":{"type":"string","description":"The name of the custom language model you want to delete. Model names are case sensitive.","required":true}}},"example":{"ModelName":""}}}}}},"/DeleteMedicalScribeJob":{"post":{"tags":["Medical Scribe"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/transcribe/latest/APIReference/API_DeleteMedicalScribeJob.html","api_endpoint":"https://transcribe.{region}.amazonaws.com/"},"summary":"Delete medical scribe job","description":"Deletes a Medical Scribe job. To use this operation, specify the name of the job you want to delete using MedicalScribeJobName . Job names are case sensitive.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"MedicalScribeJobName":{"type":"string","description":"The name of the Medical Scribe job you want to delete. Job names are case sensitive.","required":true}}},"example":{"MedicalScribeJobName":""}}}}}},"/DeleteMedicalTranscriptionJob":{"post":{"tags":["Medical Transcription"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/transcribe/latest/APIReference/API_DeleteMedicalTranscriptionJob.html","api_endpoint":"https://transcribe.{region}.amazonaws.com/"},"summary":"Delete medical transcription job","description":"Deletes a medical transcription job. To use this operation, specify the name of the job you want to delete using MedicalTranscriptionJobName . Job names are case sensitive.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"MedicalTranscriptionJobName":{"type":"string","description":"The name of the medical transcription job you want to delete. Job names are case sensitive.","required":true}}},"example":{"MedicalTranscriptionJobName":""}}}}}},"/DeleteMedicalVocabulary":{"post":{"tags":["Medical Vocabularies"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/transcribe/latest/APIReference/API_DeleteMedicalVocabulary.html","api_endpoint":"https://transcribe.{region}.amazonaws.com/"},"summary":"Delete medical vocabulary","description":"Deletes a custom medical vocabulary. To use this operation, specify the name of the custom vocabulary you want to delete using VocabularyName . Custom vocabulary names are case sensitive.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"VocabularyName":{"type":"string","description":"The name of the custom medical vocabulary you want to delete. Custom medical vocabulary names are case sensitive.","required":true}}},"example":{"VocabularyName":""}}}}}},"/DeleteTranscriptionJob":{"post":{"tags":["Transcription Jobs"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/transcribe/latest/APIReference/API_DeleteTranscriptionJob.html","api_endpoint":"https://transcribe.{region}.amazonaws.com/"},"summary":"Delete transcription job","description":"Deletes a transcription job. To use this operation, specify the name of the job you want to delete using TranscriptionJobName . Job names are case sensitive.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"TranscriptionJobName":{"type":"string","description":"The name of the transcription job you want to delete. Job names are case sensitive.","required":true}}},"example":{"TranscriptionJobName":""}}}}}},"/DeleteVocabulary":{"post":{"tags":["Vocabularies"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/transcribe/latest/APIReference/API_DeleteVocabulary.html","api_endpoint":"https://transcribe.{region}.amazonaws.com/"},"summary":"Delete vocabulary","description":"Deletes a custom vocabulary. To use this operation, specify the name of the custom vocabulary you want to delete using VocabularyName . Custom vocabulary names are case sensitive.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"VocabularyName":{"type":"string","description":"The name of the custom vocabulary you want to delete. Custom vocabulary names are case sensitive.","required":true}}},"example":{"VocabularyName":""}}}}}},"/DeleteVocabularyFilter":{"post":{"tags":["Vocabulary Filters"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/transcribe/latest/APIReference/API_DeleteVocabularyFilter.html","api_endpoint":"https://transcribe.{region}.amazonaws.com/"},"summary":"Delete vocabulary filter","description":"Deletes a custom vocabulary filter. To use this operation, specify the name of the custom vocabulary filter you want to delete using VocabularyFilterName . Custom vocabulary filter names are case sensitive.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"VocabularyFilterName":{"type":"string","description":"The name of the custom vocabulary filter you want to delete. Custom vocabulary filter names are case sensitive.","required":true}}},"example":{"VocabularyFilterName":""}}}}}},"/DescribeLanguageModel":{"post":{"tags":["Language Models"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/transcribe/latest/APIReference/API_DescribeLanguageModel.html","api_endpoint":"https://transcribe.{region}.amazonaws.com/"},"summary":"Describe language model","description":"Provides information about the specified custom language model. This operation also shows if the base language model that you used to create your custom language model has been updated. If Amazon Transcribe has updated the base model, you can create a new custom language model using the updated base model. If you tried to create a new custom…","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ModelName":{"type":"string","description":"The name of the custom language model you want information about. Model names are case sensitive.","required":true}}},"example":{"ModelName":""}}}}}},"/GetCallAnalyticsCategory":{"post":{"tags":["Call Analytics"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/transcribe/latest/APIReference/API_GetCallAnalyticsCategory.html","api_endpoint":"https://transcribe.{region}.amazonaws.com/"},"summary":"Get call analytics category","description":"Provides information about the specified Call Analytics category. To get a list of your Call Analytics categories, use the operation.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"CategoryName":{"type":"string","description":"The name of the Call Analytics category you want information about. Category names are case sensitive.","required":true}}},"example":{"CategoryName":""}}}}}},"/GetCallAnalyticsJob":{"post":{"tags":["Call Analytics"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/transcribe/latest/APIReference/API_GetCallAnalyticsJob.html","api_endpoint":"https://transcribe.{region}.amazonaws.com/"},"summary":"Get call analytics job","description":"Provides information about the specified Call Analytics job. To view the job's status, refer to CallAnalyticsJobStatus . If the status is COMPLETED , the job is finished. You can find your completed transcript at the URI specified in TranscriptFileUri . If the status is FAILED , FailureReason provides details on why your transcription job failed.…","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"CallAnalyticsJobName":{"type":"string","description":"The name of the Call Analytics job you want information about. Job names are case sensitive.","required":true}}},"example":{"CallAnalyticsJobName":""}}}}}},"/GetMedicalScribeJob":{"post":{"tags":["Medical Scribe"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/transcribe/latest/APIReference/API_GetMedicalScribeJob.html","api_endpoint":"https://transcribe.{region}.amazonaws.com/"},"summary":"Get medical scribe job","description":"Provides information about the specified Medical Scribe job. To view the status of the specified medical transcription job, check the MedicalScribeJobStatus field. If the status is COMPLETED , the job is finished. You can find the results at the location specified in MedicalScribeOutput . If the status is FAILED , FailureReason provides details on…","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"MedicalScribeJobName":{"type":"string","description":"The name of the Medical Scribe job you want information about. Job names are case sensitive.","required":true}}},"example":{"MedicalScribeJobName":""}}}}}},"/GetMedicalTranscriptionJob":{"post":{"tags":["Medical Transcription"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/transcribe/latest/APIReference/API_GetMedicalTranscriptionJob.html","api_endpoint":"https://transcribe.{region}.amazonaws.com/"},"summary":"Get medical transcription job","description":"Provides information about the specified medical transcription job. To view the status of the specified medical transcription job, check the TranscriptionJobStatus field. If the status is COMPLETED , the job is finished. You can find the results at the location specified in TranscriptFileUri . If the status is FAILED , FailureReason provides…","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"MedicalTranscriptionJobName":{"type":"string","description":"The name of the medical transcription job you want information about. Job names are case sensitive.","required":true}}},"example":{"MedicalTranscriptionJobName":""}}}}}},"/GetMedicalVocabulary":{"post":{"tags":["Medical Vocabularies"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/transcribe/latest/APIReference/API_GetMedicalVocabulary.html","api_endpoint":"https://transcribe.{region}.amazonaws.com/"},"summary":"Get medical vocabulary","description":"Provides information about the specified custom medical vocabulary. To view the status of the specified custom medical vocabulary, check the VocabularyState field. If the status is READY , your custom vocabulary is available to use. If the status is FAILED , FailureReason provides details on why your vocabulary failed. To get a list of your custom…","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"VocabularyName":{"type":"string","description":"The name of the custom medical vocabulary you want information about. Custom medical vocabulary names are case sensitive.","required":true}}},"example":{"VocabularyName":""}}}}}},"/GetTranscriptionJob":{"post":{"tags":["Transcription Jobs"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/transcribe/latest/APIReference/API_GetTranscriptionJob.html","api_endpoint":"https://transcribe.{region}.amazonaws.com/"},"summary":"Get transcription job","description":"Provides information about the specified transcription job. To view the status of the specified transcription job, check the TranscriptionJobStatus field. If the status is COMPLETED , the job is finished. You can find the results at the location specified in TranscriptFileUri . If the status is FAILED , FailureReason provides details on why your…","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"TranscriptionJobName":{"type":"string","description":"The name of the transcription job you want information about. Job names are case sensitive.","required":true}}},"example":{"TranscriptionJobName":""}}}}}},"/GetVocabulary":{"post":{"tags":["Vocabularies"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/transcribe/latest/APIReference/API_GetVocabulary.html","api_endpoint":"https://transcribe.{region}.amazonaws.com/"},"summary":"Get vocabulary","description":"Provides information about the specified custom vocabulary. To view the status of the specified custom vocabulary, check the VocabularyState field. If the status is READY , your custom vocabulary is available to use. If the status is FAILED , FailureReason provides details on why your custom vocabulary failed. To get a list of your custom…","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"VocabularyName":{"type":"string","description":"The name of the custom vocabulary you want information about. Custom vocabulary names are case sensitive.","required":true}}},"example":{"VocabularyName":""}}}}}},"/GetVocabularyFilter":{"post":{"tags":["Vocabulary Filters"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/transcribe/latest/APIReference/API_GetVocabularyFilter.html","api_endpoint":"https://transcribe.{region}.amazonaws.com/"},"summary":"Get vocabulary filter","description":"Provides information about the specified custom vocabulary filter. To get a list of your custom vocabulary filters, use the operation.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"VocabularyFilterName":{"type":"string","description":"The name of the custom vocabulary filter you want information about. Custom vocabulary filter names are case sensitive.","required":true}}},"example":{"VocabularyFilterName":""}}}}}},"/ListCallAnalyticsCategories":{"post":{"tags":["Call Analytics"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/transcribe/latest/APIReference/API_ListCallAnalyticsCategories.html","api_endpoint":"https://transcribe.{region}.amazonaws.com/"},"summary":"List call analytics categories","description":"Provides a list of Call Analytics categories, including all rules that make up each category. To get detailed information about a specific Call Analytics category, use the operation.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"MaxResults":{"type":"number","description":"The maximum number of Call Analytics categories to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you do not specify a value, a default of 5 is used."},"NextToken":{"type":"string","description":"If your ListCallAnalyticsCategories request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as…"}}},"example":{"MaxResults":"","NextToken":""}}}}}},"/ListCallAnalyticsJobs":{"post":{"tags":["Call Analytics"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/transcribe/latest/APIReference/API_ListCallAnalyticsJobs.html","api_endpoint":"https://transcribe.{region}.amazonaws.com/"},"summary":"List call analytics jobs","description":"Provides a list of Call Analytics jobs that match the specified criteria. If no criteria are specified, all Call Analytics jobs are returned. To get detailed information about a specific Call Analytics job, use the operation.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"JobNameContains":{"type":"string","description":"Returns only the Call Analytics jobs that contain the specified string. The search is not case sensitive."},"MaxResults":{"type":"number","description":"The maximum number of Call Analytics jobs to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you do not specify a value, a default of 5 is used."},"NextToken":{"type":"string","description":"If your ListCallAnalyticsJobs request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to…"},"Status":{"type":"enum","description":"Returns only Call Analytics jobs with the specified status. Jobs are ordered by creation date, with the newest job first. If you do not include Status , all Call Analytics jobs are returned.","enum":["QUEUED","IN_PROGRESS","FAILED","COMPLETED"]}}},"example":{"JobNameContains":"","MaxResults":"","NextToken":"","Status":""}}}}}},"/ListLanguageModels":{"post":{"tags":["Language Models"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/transcribe/latest/APIReference/API_ListLanguageModels.html","api_endpoint":"https://transcribe.{region}.amazonaws.com/"},"summary":"List language models","description":"Provides a list of custom language models that match the specified criteria. If no criteria are specified, all custom language models are returned. To get detailed information about a specific custom language model, use the operation.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"MaxResults":{"type":"number","description":"The maximum number of custom language models to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you do not specify a value, a default of 5 is used."},"NameContains":{"type":"string","description":"Returns only the custom language models that contain the specified string. The search is not case sensitive."},"NextToken":{"type":"string","description":"If your ListLanguageModels request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to…"},"StatusEquals":{"type":"enum","description":"Returns only custom language models with the specified status. Language models are ordered by creation date, with the newest model first. If you do not include StatusEquals , all custom language models are returned.","enum":["IN_PROGRESS","FAILED","COMPLETED"]}}},"example":{"MaxResults":"","NameContains":"","NextToken":"","StatusEquals":""}}}}}},"/ListMedicalScribeJobs":{"post":{"tags":["Medical Scribe"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/transcribe/latest/APIReference/API_ListMedicalScribeJobs.html","api_endpoint":"https://transcribe.{region}.amazonaws.com/"},"summary":"List medical scribe jobs","description":"Provides a list of Medical Scribe jobs that match the specified criteria. If no criteria are specified, all Medical Scribe jobs are returned. To get detailed information about a specific Medical Scribe job, use the operation.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"JobNameContains":{"type":"string","description":"Returns only the Medical Scribe jobs that contain the specified string. The search is not case sensitive."},"MaxResults":{"type":"number","description":"The maximum number of Medical Scribe jobs to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you do not specify a value, a default of 5 is used."},"NextToken":{"type":"string","description":"If your ListMedicalScribeJobs request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to…"},"Status":{"type":"enum","description":"Returns only Medical Scribe jobs with the specified status. Jobs are ordered by creation date, with the newest job first. If you do not include Status , all Medical Scribe jobs are returned.","enum":["QUEUED","IN_PROGRESS","FAILED","COMPLETED"]}}},"example":{"JobNameContains":"","MaxResults":"","NextToken":"","Status":""}}}}}},"/ListMedicalTranscriptionJobs":{"post":{"tags":["Medical Transcription"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/transcribe/latest/APIReference/API_ListMedicalTranscriptionJobs.html","api_endpoint":"https://transcribe.{region}.amazonaws.com/"},"summary":"List medical transcription jobs","description":"Provides a list of medical transcription jobs that match the specified criteria. If no criteria are specified, all medical transcription jobs are returned. To get detailed information about a specific medical transcription job, use the operation.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"JobNameContains":{"type":"string","description":"Returns only the medical transcription jobs that contain the specified string. The search is not case sensitive."},"MaxResults":{"type":"number","description":"The maximum number of medical transcription jobs to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you do not specify a value, a default of 5 is used."},"NextToken":{"type":"string","description":"If your ListMedicalTranscriptionJobs request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as…"},"Status":{"type":"enum","description":"Returns only medical transcription jobs with the specified status. Jobs are ordered by creation date, with the newest job first. If you do not include Status , all medical transcription jobs are returned.","enum":["QUEUED","IN_PROGRESS","FAILED","COMPLETED"]}}},"example":{"JobNameContains":"","MaxResults":"","NextToken":"","Status":""}}}}}},"/ListMedicalVocabularies":{"post":{"tags":["General"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/transcribe/latest/APIReference/API_ListMedicalVocabularies.html","api_endpoint":"https://transcribe.{region}.amazonaws.com/"},"summary":"List medical vocabularies","description":"Provides a list of custom medical vocabularies that match the specified criteria. If no criteria are specified, all custom medical vocabularies are returned. To get detailed information about a specific custom medical vocabulary, use the operation.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"MaxResults":{"type":"number","description":"The maximum number of custom medical vocabularies to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you do not specify a value, a default of 5 is used."},"NameContains":{"type":"string","description":"Returns only the custom medical vocabularies that contain the specified string. The search is not case sensitive."},"NextToken":{"type":"string","description":"If your ListMedicalVocabularies request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed…"},"StateEquals":{"type":"enum","description":"Returns only custom medical vocabularies with the specified state. Custom vocabularies are ordered by creation date, with the newest vocabulary first. If you do not include StateEquals , all custom medical vocabularies are returned.","enum":["PENDING","READY","FAILED"]}}},"example":{"MaxResults":"","NameContains":"","NextToken":"","StateEquals":""}}}}}},"/ListTagsForResource":{"post":{"tags":["Tags"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/transcribe/latest/APIReference/API_ListTagsForResource.html","api_endpoint":"https://transcribe.{region}.amazonaws.com/"},"summary":"List tags for resource","description":"Lists all tags associated with the specified transcription job, vocabulary, model, or resource. To learn more about using tags with Amazon Transcribe, refer to Tagging resources .","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ResourceArn":{"type":"string","description":"Returns a list of all tags associated with the specified Amazon Resource Name (ARN). ARNs have the format arn:partition:service:region:account-id:resource-type/resource-id . For example, arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name . Valid values for…","required":true}}},"example":{"ResourceArn":""}}}}}},"/ListTranscriptionJobs":{"post":{"tags":["Transcription Jobs"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/transcribe/latest/APIReference/API_ListTranscriptionJobs.html","api_endpoint":"https://transcribe.{region}.amazonaws.com/"},"summary":"List transcription jobs","description":"Provides a list of transcription jobs that match the specified criteria. If no criteria are specified, all transcription jobs are returned. To get detailed information about a specific transcription job, use the operation.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"JobNameContains":{"type":"string","description":"Returns only the transcription jobs that contain the specified string. The search is not case sensitive."},"MaxResults":{"type":"number","description":"The maximum number of transcription jobs to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you do not specify a value, a default of 5 is used."},"NextToken":{"type":"string","description":"If your ListTranscriptionJobs request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to…"},"Status":{"type":"enum","description":"Returns only transcription jobs with the specified status. Jobs are ordered by creation date, with the newest job first. If you do not include Status , all transcription jobs are returned.","enum":["QUEUED","IN_PROGRESS","FAILED","COMPLETED"]}}},"example":{"JobNameContains":"","MaxResults":"","NextToken":"","Status":""}}}}}},"/ListVocabularies":{"post":{"tags":["General"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/transcribe/latest/APIReference/API_ListVocabularies.html","api_endpoint":"https://transcribe.{region}.amazonaws.com/"},"summary":"List vocabularies","description":"Provides a list of custom vocabularies that match the specified criteria. If no criteria are specified, all custom vocabularies are returned. To get detailed information about a specific custom vocabulary, use the operation.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"MaxResults":{"type":"number","description":"The maximum number of custom vocabularies to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you do not specify a value, a default of 5 is used."},"NameContains":{"type":"string","description":"Returns only the custom vocabularies that contain the specified string. The search is not case sensitive."},"NextToken":{"type":"string","description":"If your ListVocabularies request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view…"},"StateEquals":{"type":"enum","description":"Returns only custom vocabularies with the specified state. Vocabularies are ordered by creation date, with the newest vocabulary first. If you do not include StateEquals , all custom medical vocabularies are returned.","enum":["PENDING","READY","FAILED"]}}},"example":{"MaxResults":"","NameContains":"","NextToken":"","StateEquals":""}}}}}},"/ListVocabularyFilters":{"post":{"tags":["Vocabulary Filters"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/transcribe/latest/APIReference/API_ListVocabularyFilters.html","api_endpoint":"https://transcribe.{region}.amazonaws.com/"},"summary":"List vocabulary filters","description":"Provides a list of custom vocabulary filters that match the specified criteria. If no criteria are specified, all custom vocabularies are returned. To get detailed information about a specific custom vocabulary filter, use the operation.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"MaxResults":{"type":"number","description":"The maximum number of custom vocabulary filters to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you do not specify a value, a default of 5 is used."},"NameContains":{"type":"string","description":"Returns only the custom vocabulary filters that contain the specified string. The search is not case sensitive."},"NextToken":{"type":"string","description":"If your ListVocabularyFilters request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to…"}}},"example":{"MaxResults":"","NameContains":"","NextToken":""}}}}}},"/StartCallAnalyticsJob":{"post":{"tags":["Call Analytics"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/transcribe/latest/APIReference/API_StartCallAnalyticsJob.html","api_endpoint":"https://transcribe.{region}.amazonaws.com/"},"summary":"Start call analytics job","description":"Transcribes the audio from a customer service call and applies any additional Request Parameters you choose to include in your request. In addition to many standard transcription features, Call Analytics provides you with call characteristics, call summarization, speaker sentiment, and optional redaction of your text transcript and your audio…","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"CallAnalyticsJobName":{"type":"string","description":"A unique name, chosen by you, for your Call Analytics job. 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.","required":true},"ChannelDefinitions":{"type":"array","description":"Makes it possible to specify which speaker is on which channel. For example, if your agent is the first participant to speak, you would set ChannelId to 0 (to indicate the first channel) and ParticipantRole to AGENT (to indicate that it's the agent speaking).","items":{"type":"object","properties":{"ChannelId":{"type":"number","description":"Specify the audio channel you want to define."},"ParticipantRole":{"type":"string","description":"Specify the speaker you want to define. Omitting this parameter is equivalent to specifying both participants.","enum":["AGENT","CUSTOMER"]}}}},"DataAccessRoleArn":{"type":"string","description":"The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files. If the role that you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails. IAM role ARNs have the format…"},"Media":{"type":"object","description":"Describes the Amazon S3 location of the media file you want to use in your Call Analytics request.","required":true,"properties":{}},"OutputEncryptionKMSKeyId":{"type":"string","description":"The Amazon Resource Name (ARN) of a KMS key that you want to use to encrypt your Call Analytics output. KMS key ARNs have the format arn:partition:kms:region:account:key/key-id . For example: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab . For more information, see KMS…"},"OutputLocation":{"type":"string","description":"The Amazon S3 location where you want your Call Analytics transcription output stored. You can use any of the following formats to specify the output location: s3://DOC-EXAMPLE-BUCKET s3://DOC-EXAMPLE-BUCKET/my-output-folder/ s3://DOC-EXAMPLE-BUCKET/my-output-folder/my-call-analytics-job.json…"},"Settings":{"type":"object","description":"Specify additional optional settings in your request, including content redaction; allows you to apply custom language models, vocabulary filters, and custom vocabularies to your Call Analytics job.","properties":{}},"Tags":{"type":"array","description":"Adds one or more custom tags, each in the form of a key:value pair, to a new call analytics job at the time you start this new job. To learn more about using tags with Amazon Transcribe, refer to Tagging resources .","items":{"type":"object","properties":{"Key":{"type":"string","description":"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'.","required":true},"Value":{"type":"string","description":"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'. Note…","required":true}}}}}},"example":{"CallAnalyticsJobName":"","ChannelDefinitions":[],"DataAccessRoleArn":"","Media":{"MediaFileUri":"string","RedactedMediaFileUri":"string"},"OutputEncryptionKMSKeyId":"","OutputLocation":"","Settings":{"LanguageModelName":"string","VocabularyFilterMethod":"remove","VocabularyFilterName":"string","VocabularyName":"string"},"Tags":[]}}}}}},"/StartMedicalScribeJob":{"post":{"tags":["Medical Scribe"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/transcribe/latest/APIReference/API_StartMedicalScribeJob.html","api_endpoint":"https://transcribe.{region}.amazonaws.com/"},"summary":"Start medical scribe job","description":"Transcribes patient-clinician conversations and generates clinical notes. Amazon Web Services HealthScribe automatically provides rich conversation transcripts, identifies speaker roles, classifies dialogues, extracts medical terms, and generates preliminary clinical notes. To learn more about these features, refer to Amazon Web Services…","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ChannelDefinitions":{"type":"array","description":"Makes it possible to specify which speaker is on which channel. For example, if the clinician is the first participant to speak, you would set ChannelId of the first ChannelDefinition in the list to 0 (to indicate the first channel) and ParticipantRole to CLINICIAN (to indicate that it's the…","items":{"type":"object","properties":{"ChannelId":{"type":"number","description":"Specify the audio channel you want to define.","required":true},"ParticipantRole":{"type":"string","description":"Specify the participant that you want to flag. The options are CLINICIAN and PATIENT","required":true,"enum":["PATIENT","CLINICIAN"]}}}},"DataAccessRoleArn":{"type":"string","description":"The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files, write to the output bucket, and use your KMS key if supplied. If the role that you specify doesn’t have the appropriate permissions your request fails. IAM role ARNs…","required":true},"KMSEncryptionContext":{"type":"object","description":"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 .","properties":{}},"Media":{"type":"object","description":"Media","required":true,"properties":{}},"MedicalScribeContext":{"type":"object","description":"The MedicalScribeContext object that contains contextual information which is used during clinical note generation to add relevant context to the note.","properties":{}},"MedicalScribeJobName":{"type":"string","description":"A unique name, chosen by you, for your Medical Scribe job. 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.","required":true},"OutputBucketName":{"type":"string","description":"The name of the Amazon S3 bucket where you want your Medical Scribe output stored. Do not include the S3:// prefix of the specified bucket. Note that the role specified in the DataAccessRoleArn request parameter must have permission to use the specified location. You can change Amazon S3…","required":true},"OutputEncryptionKMSKeyId":{"type":"string","description":"The Amazon Resource Name (ARN) of a KMS key that you want to use to encrypt your Medical Scribe output. KMS key ARNs have the format arn:partition:kms:region:account:key/key-id . For example: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab . For more information, see KMS…"},"Settings":{"type":"object","description":"Makes it possible to control how your Medical Scribe job is processed using a MedicalScribeSettings object. Specify ChannelIdentification if ChannelDefinitions are set. Enabled ShowSpeakerLabels if ChannelIdentification and ChannelDefinitions are not set. One and only one of ChannelIdentification…","required":true,"properties":{}},"Tags":{"type":"array","description":"Adds one or more custom tags, each in the form of a key:value pair, to the Medical Scribe job. To learn more about using tags with Amazon Transcribe, refer to Tagging resources .","items":{"type":"object","properties":{"Key":{"type":"string","description":"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'.","required":true},"Value":{"type":"string","description":"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'. Note…","required":true}}}}}},"example":{"ChannelDefinitions":[],"DataAccessRoleArn":"","KMSEncryptionContext":{},"Media":{"MediaFileUri":"string","RedactedMediaFileUri":"string"},"MedicalScribeContext":{},"MedicalScribeJobName":"","OutputBucketName":"","OutputEncryptionKMSKeyId":"","Settings":{"ChannelIdentification":true,"ShowSpeakerLabels":true,"VocabularyFilterName":"string","VocabularyName":"string"},"Tags":[]}}}}}},"/StartMedicalTranscriptionJob":{"post":{"tags":["Medical Transcription"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/transcribe/latest/APIReference/API_StartMedicalTranscriptionJob.html","api_endpoint":"https://transcribe.{region}.amazonaws.com/"},"summary":"Start medical transcription job","description":"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…","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ContentIdentificationType":{"type":"enum","description":"Labels all personal health information (PHI) identified in your transcript. For more information, see Identifying personal health information (PHI) in a transcription .","enum":["PHI"]},"KMSEncryptionContext":{"type":"object","description":"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 .","properties":{}},"LanguageCode":{"type":"enum","description":"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.","required":true,"enum":["af-ZA","ar-AE","ar-SA","am-ET","cy-GB","da-DK","de-CH","de-DE","en-AB","en-AU","en-GB","en-IE","en-IN","en-US","en-WL","es-ES","es-MX","es-US","fa-AF","fa-IR","fr-CA","fr-FR","ga-IE","gd-GB","he-IL","hi-IN","ht-HT","id-ID","it-IT","ja-JP","jv-ID","km-KH","ko-KR","my-MM","ms-MY","nl-NL","pt-BR","pt-PT","ru-RU","ta-IN","te-IN","tr-TR","zh-CN","zh-TW","th-TH","en-ZA","en-NZ","vi-VN","sv-SE","ab-GE","ast-ES","az-AZ","ba-RU","be-BY","bg-BG","bn-IN","bs-BA","ca-ES","ckb-IQ","ckb-IR","cs-CZ","cy-WL","el-GR","et-EE","et-ET","eu-ES","fi-FI","gl-ES","gu-IN","ha-NG","hr-HR","hu-HU","hy-AM","is-IS","ka-GE","kab-DZ","kk-KZ","kn-IN","ky-KG","lg-IN","lt-LT","lv-LV","mhr-RU","mi-NZ","mk-MK","ml-IN","mn-MN","mr-IN","mt-MT","no-NO","ne-NP","or-IN","pa-IN","pl-PL","ps-AF","ro-RO","rw-RW","si-LK","sk-SK","sl-SI","so-SO","sq-AL","sr-RS","su-ID","sw-BI","sw-KE","sw-RW","sw-TZ","sw-UG","tl-PH","tt-RU","ug-CN","uk-UA","uz-UZ","wo-SN","zh-HK","zu-ZA"]},"Media":{"type":"object","description":"Media","required":true,"properties":{}},"MediaFormat":{"type":"enum","description":"Specify the format of your input media file.","enum":["mp3","mp4","wav","flac","ogg","amr","webm","m4a"]},"MediaSampleRateHertz":{"type":"number","description":"The sample rate, in hertz, of the audio track in your input media file. If you do not 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…"},"MedicalTranscriptionJobName":{"type":"string","description":"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…","required":true},"OutputBucketName":{"type":"string","description":"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…","required":true},"OutputEncryptionKMSKeyId":{"type":"string","description":"The Amazon Resource Name (ARN) of a KMS key that you want to use to encrypt your medical transcription output. KMS key ARNs have the format arn:partition:kms:region:account:key/key-id . For example: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab . For more information…"},"OutputKey":{"type":"string","description":"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 ).…"},"Settings":{"type":"object","description":"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.","properties":{}},"Specialty":{"type":"enum","description":"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 .","required":true,"enum":["PRIMARYCARE"]},"Tags":{"type":"array","description":"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 .","items":{"type":"object","properties":{"Key":{"type":"string","description":"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'.","required":true},"Value":{"type":"string","description":"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'. Note…","required":true}}}},"Type":{"type":"enum","description":"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…","required":true,"enum":["CONVERSATION","DICTATION"]}}},"example":{"ContentIdentificationType":"","KMSEncryptionContext":{},"LanguageCode":"","Media":{"MediaFileUri":"string","RedactedMediaFileUri":"string"},"MediaFormat":"","MediaSampleRateHertz":"","MedicalTranscriptionJobName":"","OutputBucketName":"","OutputEncryptionKMSKeyId":"","OutputKey":"","Settings":{"ChannelIdentification":true,"ShowAlternatives":true,"ShowSpeakerLabels":true,"VocabularyName":"string"},"Specialty":"","Tags":[],"Type":""}}}}}},"/StartTranscriptionJob":{"post":{"tags":["Transcription Jobs"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/transcribe/latest/APIReference/API_StartTranscriptionJob.html","api_endpoint":"https://transcribe.{region}.amazonaws.com/"},"summary":"Start transcription job","description":"Transcribes the audio from a media file and applies any additional Request Parameters you choose to include in your request. To make a StartTranscriptionJob request, you must first upload your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location of the file using the Media parameter. You must include the following…","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ContentRedaction":{"type":"object","description":"Makes it possible to redact or flag specified personally identifiable information (PII) in your transcript. If you use ContentRedaction , you must also include the sub-parameters: RedactionOutput and RedactionType . You can optionally include PiiEntityTypes to choose which types of PII you want to…","properties":{}},"IdentifyLanguage":{"type":"boolean","description":"Enables automatic language identification in your transcription job request. Use this parameter if your media file contains only one language. If your media contains multiple languages, use IdentifyMultipleLanguages instead. If you include IdentifyLanguage , you can optionally include a list of…"},"IdentifyMultipleLanguages":{"type":"boolean","description":"Enables automatic multi-language identification in your transcription job request. Use this parameter if your media file contains more than one language. If your media contains only one language, use IdentifyLanguage instead. If you include IdentifyMultipleLanguages , you can optionally include a…"},"JobExecutionSettings":{"type":"object","description":"Makes it possible to control how your transcription job is processed. Currently, the only JobExecutionSettings modification you can choose is enabling job queueing using the AllowDeferredExecution sub-parameter. If you include JobExecutionSettings in your request, you must also include the…","properties":{}},"KMSEncryptionContext":{"type":"object","description":"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 .","properties":{}},"LanguageCode":{"type":"enum","description":"The language code that represents the language spoken in the input media file. If you're unsure of the language spoken in your media file, consider using IdentifyLanguage or IdentifyMultipleLanguages to enable automatic language identification. Note that you must include one of LanguageCode …","enum":["af-ZA","ar-AE","ar-SA","am-ET","cy-GB","da-DK","de-CH","de-DE","en-AB","en-AU","en-GB","en-IE","en-IN","en-US","en-WL","es-ES","es-MX","es-US","fa-AF","fa-IR","fr-CA","fr-FR","ga-IE","gd-GB","he-IL","hi-IN","ht-HT","id-ID","it-IT","ja-JP","jv-ID","km-KH","ko-KR","my-MM","ms-MY","nl-NL","pt-BR","pt-PT","ru-RU","ta-IN","te-IN","tr-TR","zh-CN","zh-TW","th-TH","en-ZA","en-NZ","vi-VN","sv-SE","ab-GE","ast-ES","az-AZ","ba-RU","be-BY","bg-BG","bn-IN","bs-BA","ca-ES","ckb-IQ","ckb-IR","cs-CZ","cy-WL","el-GR","et-EE","et-ET","eu-ES","fi-FI","gl-ES","gu-IN","ha-NG","hr-HR","hu-HU","hy-AM","is-IS","ka-GE","kab-DZ","kk-KZ","kn-IN","ky-KG","lg-IN","lt-LT","lv-LV","mhr-RU","mi-NZ","mk-MK","ml-IN","mn-MN","mr-IN","mt-MT","no-NO","ne-NP","or-IN","pa-IN","pl-PL","ps-AF","ro-RO","rw-RW","si-LK","sk-SK","sl-SI","so-SO","sq-AL","sr-RS","su-ID","sw-BI","sw-KE","sw-RW","sw-TZ","sw-UG","tl-PH","tt-RU","ug-CN","uk-UA","uz-UZ","wo-SN","zh-HK","zu-ZA"]},"LanguageIdSettings":{"type":"object","description":"If using automatic language identification in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter, include LanguageIdSettings with the relevant sub-parameters ( VocabularyName , LanguageModelName , and VocabularyFilterName ). Note that…","properties":{}},"LanguageOptions":{"type":"array","description":"You can specify two or more language codes that represent the languages you think may be present in your media. Including more than five is not recommended. If you're unsure what languages are present, do not include this parameter. If you include LanguageOptions in your request, you must also…","items":{"type":"string"}},"Media":{"type":"object","description":"Describes the Amazon S3 location of the media file you want to use in your request.","required":true,"properties":{}},"MediaFormat":{"type":"enum","description":"Specify the format of your input media file.","enum":["mp3","mp4","wav","flac","ogg","amr","webm","m4a"]},"MediaSampleRateHertz":{"type":"number","description":"The sample rate, in hertz, of the audio track in your input media file. If you do not specify the media sample rate, Amazon Transcribe determines it for you. If you specify the sample rate, it must match the rate detected by Amazon Transcribe. If there's a mismatch between the value that you…"},"ModelSettings":{"type":"object","description":"Specify the custom language model you want to include with your transcription job. If you include ModelSettings in your request, you must include the LanguageModelName sub-parameter. For more information, see Custom language models .","properties":{}},"OutputBucketName":{"type":"string","description":"The name of the Amazon S3 bucket where you want your 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…"},"OutputEncryptionKMSKeyId":{"type":"string","description":"The Amazon Resource Name (ARN) of a KMS key that you want to use to encrypt your transcription output. KMS key ARNs have the format arn:partition:kms:region:account:key/key-id . For example: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab . For more information, see KMS…"},"OutputKey":{"type":"string","description":"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 transcription job ( TranscriptionJobName ). Here are some…"},"Settings":{"type":"object","description":"Specify additional optional settings in your request, including channel identification, alternative transcriptions, speaker partitioning. You can use that to apply custom vocabularies and vocabulary filters. If you want to include a custom vocabulary or a custom vocabulary filter (or both) with…","properties":{}},"Subtitles":{"type":"object","description":"Produces subtitle files for your input media. You can specify WebVTT (*.vtt) and SubRip (*.srt) formats.","properties":{}},"Tags":{"type":"array","description":"Adds one or more custom tags, each in the form of a key:value pair, to a new transcription job at the time you start this new job. To learn more about using tags with Amazon Transcribe, refer to Tagging resources .","items":{"type":"object","properties":{"Key":{"type":"string","description":"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'.","required":true},"Value":{"type":"string","description":"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'. Note…","required":true}}}},"ToxicityDetection":{"type":"array","description":"Enables toxic speech detection in your transcript. If you include ToxicityDetection in your request, you must also include ToxicityCategories . For information on the types of toxic speech Amazon Transcribe can detect, see Detecting toxic speech .","items":{"type":"object","properties":{"ToxicityCategories":{"type":"array","description":"If you include ToxicityDetection in your transcription request, you must also include ToxicityCategories . The only accepted value for this parameter is ALL .","required":true}}}},"TranscriptionJobName":{"type":"string","description":"A unique name, chosen by you, for your 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…","required":true}}},"example":{"ContentRedaction":{"RedactionOutput":"redacted","RedactionType":"PII"},"IdentifyLanguage":"","IdentifyMultipleLanguages":"","JobExecutionSettings":{"AllowDeferredExecution":true,"DataAccessRoleArn":"string"},"KMSEncryptionContext":{},"LanguageCode":"","LanguageIdSettings":{},"LanguageOptions":[],"Media":{"MediaFileUri":"string","RedactedMediaFileUri":"string"},"MediaFormat":"","MediaSampleRateHertz":"","ModelSettings":{"LanguageModelName":"string"},"OutputBucketName":"","OutputEncryptionKMSKeyId":"","OutputKey":"","Settings":{"ChannelIdentification":true,"ShowAlternatives":true,"ShowSpeakerLabels":true,"VocabularyName":"string"},"Subtitles":{},"Tags":[],"ToxicityDetection":[],"TranscriptionJobName":""}}}}}},"/TagResource":{"post":{"tags":["Tags"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/transcribe/latest/APIReference/API_TagResource.html","api_endpoint":"https://transcribe.{region}.amazonaws.com/"},"summary":"Tag resource","description":"Adds one or more custom tags, each in the form of a key:value pair, to the specified resource. To learn more about using tags with Amazon Transcribe, refer to Tagging resources .","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ResourceArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the resource you want to tag. ARNs have the format arn:partition:service:region:account-id:resource-type/resource-id . For example, arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name . Valid values for resource-type are…","required":true},"Tags":{"type":"array","description":"Adds one or more custom tags, each in the form of a key:value pair, to the specified resource. To learn more about using tags with Amazon Transcribe, refer to Tagging resources .","required":true,"items":{"type":"object","properties":{"Key":{"type":"string","description":"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'.","required":true},"Value":{"type":"string","description":"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'. Note…","required":true}}}}}},"example":{"ResourceArn":"","Tags":[]}}}}}},"/UntagResource":{"post":{"tags":["Tags"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/transcribe/latest/APIReference/API_UntagResource.html","api_endpoint":"https://transcribe.{region}.amazonaws.com/"},"summary":"Untag resource","description":"Removes the specified tags from the specified Amazon Transcribe resource. If you include UntagResource in your request, you must also include ResourceArn and TagKeys .","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ResourceArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the Amazon Transcribe resource you want to remove tags from. ARNs have the format arn:partition:service:region:account-id:resource-type/resource-id . For example, arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name . Valid values for…","required":true},"TagKeys":{"type":"array","description":"Removes the specified tag keys from the specified Amazon Transcribe resource.","required":true,"items":{"type":"string"}}}},"example":{"ResourceArn":"","TagKeys":[]}}}}}},"/UpdateCallAnalyticsCategory":{"post":{"tags":["Call Analytics"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/transcribe/latest/APIReference/API_UpdateCallAnalyticsCategory.html","api_endpoint":"https://transcribe.{region}.amazonaws.com/"},"summary":"Update call analytics category","description":"Updates the specified Call Analytics category with new rules. Note that the UpdateCallAnalyticsCategory operation overwrites all existing rules contained in the specified category. You cannot append additional rules onto an existing category. To create a new category, see .","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"CategoryName":{"type":"string","description":"The name of the Call Analytics category you want to update. Category names are case sensitive.","required":true},"InputType":{"type":"enum","description":"Choose whether you want to update a real-time or a post-call category. The input type you specify must match the input type specified when the category was created. For example, if you created a category with the POST_CALL input type, you must use POST_CALL as the input type when updating this…","enum":["REAL_TIME","POST_CALL"]},"Rules":{"type":"array","description":"The rules used for the updated Call Analytics category. The rules you provide in this field replace the ones that are currently being used in the specified category.","required":true,"items":{"type":"object","properties":{"InterruptionFilter":{"type":"object","description":"Flag the presence or absence of interruptions in your Call Analytics transcription output. Refer to for more detail."},"NonTalkTimeFilter":{"type":"object","description":"Flag the presence or absence of periods of silence in your Call Analytics transcription output. Refer to for more detail."},"SentimentFilter":{"type":"object","description":"Flag the presence or absence of specific sentiments in your Call Analytics transcription output. Refer to for more detail."},"TranscriptFilter":{"type":"object","description":"Flag the presence or absence of specific words or phrases in your Call Analytics transcription output. Refer to for more detail."}}}}}},"example":{"CategoryName":"","InputType":"","Rules":[]}}}}}},"/UpdateMedicalVocabulary":{"post":{"tags":["Medical Vocabularies"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/transcribe/latest/APIReference/API_UpdateMedicalVocabulary.html","api_endpoint":"https://transcribe.{region}.amazonaws.com/"},"summary":"Update medical vocabulary","description":"Updates an existing custom medical vocabulary with new values. This operation overwrites all existing information with your new values; you cannot append new terms onto an existing custom vocabulary.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"LanguageCode":{"type":"enum","description":"The language code that represents the language of the entries in the custom vocabulary you want to update. US English ( en-US ) is the only language supported with Amazon Transcribe Medical.","required":true,"enum":["af-ZA","ar-AE","ar-SA","am-ET","cy-GB","da-DK","de-CH","de-DE","en-AB","en-AU","en-GB","en-IE","en-IN","en-US","en-WL","es-ES","es-MX","es-US","fa-AF","fa-IR","fr-CA","fr-FR","ga-IE","gd-GB","he-IL","hi-IN","ht-HT","id-ID","it-IT","ja-JP","jv-ID","km-KH","ko-KR","my-MM","ms-MY","nl-NL","pt-BR","pt-PT","ru-RU","ta-IN","te-IN","tr-TR","zh-CN","zh-TW","th-TH","en-ZA","en-NZ","vi-VN","sv-SE","ab-GE","ast-ES","az-AZ","ba-RU","be-BY","bg-BG","bn-IN","bs-BA","ca-ES","ckb-IQ","ckb-IR","cs-CZ","cy-WL","el-GR","et-EE","et-ET","eu-ES","fi-FI","gl-ES","gu-IN","ha-NG","hr-HR","hu-HU","hy-AM","is-IS","ka-GE","kab-DZ","kk-KZ","kn-IN","ky-KG","lg-IN","lt-LT","lv-LV","mhr-RU","mi-NZ","mk-MK","ml-IN","mn-MN","mr-IN","mt-MT","no-NO","ne-NP","or-IN","pa-IN","pl-PL","ps-AF","ro-RO","rw-RW","si-LK","sk-SK","sl-SI","so-SO","sq-AL","sr-RS","su-ID","sw-BI","sw-KE","sw-RW","sw-TZ","sw-UG","tl-PH","tt-RU","ug-CN","uk-UA","uz-UZ","wo-SN","zh-HK","zu-ZA"]},"VocabularyFileUri":{"type":"string","description":"The Amazon S3 location of the text file that contains your custom medical vocabulary. The URI must be located in the same Amazon Web Services Region as the resource you're calling. Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt","required":true},"VocabularyName":{"type":"string","description":"The name of the custom medical vocabulary you want to update. Custom medical vocabulary names are case sensitive.","required":true}}},"example":{"LanguageCode":"","VocabularyFileUri":"","VocabularyName":""}}}}}},"/UpdateVocabulary":{"post":{"tags":["Vocabularies"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/transcribe/latest/APIReference/API_UpdateVocabulary.html","api_endpoint":"https://transcribe.{region}.amazonaws.com/"},"summary":"Update vocabulary","description":"Updates an existing custom vocabulary with new values. This operation overwrites all existing information with your new values; you cannot append new terms onto an existing custom vocabulary.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"DataAccessRoleArn":{"type":"string","description":"The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files (in this case, your custom vocabulary). If the role that you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request…"},"LanguageCode":{"type":"enum","description":"The language code that represents the language of the entries in the custom vocabulary you want to update. Each custom vocabulary must contain terms in only one language. A custom vocabulary can only be used to transcribe files in the same language as the custom vocabulary. For example, if you…","required":true,"enum":["af-ZA","ar-AE","ar-SA","am-ET","cy-GB","da-DK","de-CH","de-DE","en-AB","en-AU","en-GB","en-IE","en-IN","en-US","en-WL","es-ES","es-MX","es-US","fa-AF","fa-IR","fr-CA","fr-FR","ga-IE","gd-GB","he-IL","hi-IN","ht-HT","id-ID","it-IT","ja-JP","jv-ID","km-KH","ko-KR","my-MM","ms-MY","nl-NL","pt-BR","pt-PT","ru-RU","ta-IN","te-IN","tr-TR","zh-CN","zh-TW","th-TH","en-ZA","en-NZ","vi-VN","sv-SE","ab-GE","ast-ES","az-AZ","ba-RU","be-BY","bg-BG","bn-IN","bs-BA","ca-ES","ckb-IQ","ckb-IR","cs-CZ","cy-WL","el-GR","et-EE","et-ET","eu-ES","fi-FI","gl-ES","gu-IN","ha-NG","hr-HR","hu-HU","hy-AM","is-IS","ka-GE","kab-DZ","kk-KZ","kn-IN","ky-KG","lg-IN","lt-LT","lv-LV","mhr-RU","mi-NZ","mk-MK","ml-IN","mn-MN","mr-IN","mt-MT","no-NO","ne-NP","or-IN","pa-IN","pl-PL","ps-AF","ro-RO","rw-RW","si-LK","sk-SK","sl-SI","so-SO","sq-AL","sr-RS","su-ID","sw-BI","sw-KE","sw-RW","sw-TZ","sw-UG","tl-PH","tt-RU","ug-CN","uk-UA","uz-UZ","wo-SN","zh-HK","zu-ZA"]},"Phrases":{"type":"array","description":"Use this parameter if you want to update your custom vocabulary by including all desired terms, as comma-separated values, within your request. The other option for updating your custom vocabulary is to save your entries in a text file and upload them to an Amazon S3 bucket, then specify the…","items":{"type":"string"}},"VocabularyFileUri":{"type":"string","description":"The Amazon S3 location of the text file that contains your custom vocabulary. The URI must be located in the same Amazon Web Services Region as the resource you're calling. Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt Note that if you include VocabularyFileUri in your…"},"VocabularyName":{"type":"string","description":"The name of the custom vocabulary you want to update. Custom vocabulary names are case sensitive.","required":true}}},"example":{"DataAccessRoleArn":"","LanguageCode":"","Phrases":[],"VocabularyFileUri":"","VocabularyName":""}}}}}},"/UpdateVocabularyFilter":{"post":{"tags":["Vocabulary Filters"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/transcribe/latest/APIReference/API_UpdateVocabularyFilter.html","api_endpoint":"https://transcribe.{region}.amazonaws.com/"},"summary":"Update vocabulary filter","description":"Updates an existing custom vocabulary filter with a new list of words. The new list you provide overwrites all previous entries; you cannot append new terms onto an existing custom vocabulary filter.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"DataAccessRoleArn":{"type":"string","description":"The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files (in this case, your custom vocabulary filter). If the role that you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your…"},"VocabularyFilterFileUri":{"type":"string","description":"The Amazon S3 location of the text file that contains your custom vocabulary filter terms. The URI must be located in the same Amazon Web Services Region as the resource you're calling. Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt Note that if you include…"},"VocabularyFilterName":{"type":"string","description":"The name of the custom vocabulary filter you want to update. Custom vocabulary filter names are case sensitive.","required":true},"Words":{"type":"array","description":"Use this parameter if you want to update your custom vocabulary filter by including all desired terms, as comma-separated values, within your request. The other option for updating your vocabulary filter is to save your entries in a text file and upload them to an Amazon S3 bucket, then specify the…","items":{"type":"string"}}}},"example":{"DataAccessRoleArn":"","VocabularyFilterFileUri":"","VocabularyFilterName":"","Words":[]}}}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"security":[{"bearerAuth":[]}]}