Split (1)

train · 107k rows

id stringlengths 8 78	source stringclasses 743 values	chunk_id int64 1 5.05k	text stringlengths 593 49.7k
transcribe-api-029	transcribe-api.pdf	29	Version 2017-10-26 121 Amazon Transcribe BadRequestException API Reference Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message ﬁeld for more information. HTTP Status Code: 400 InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again. HTTP Status Code: 500 LimitExceededException You've either sent too many requests or your input ﬁle is too long. Wait before retrying your request, or use a smaller ﬁle and try your request again. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 ListMedicalVocabularies API Version 2017-10-26 122 Amazon Transcribe API Reference ListTagsForResource Service: Amazon Transcribe Service Lists all tags associated with the speciﬁed transcription job, vocabulary, model, or resource. To learn more about using tags with Amazon Transcribe, refer to Tagging resources. Request Syntax { "ResourceArn": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ResourceArn Returns a list of all tags associated with the speciﬁed 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 resource-type are: transcription-job, medical-transcription-job, vocabulary, medical-vocabulary, vocabulary-filter, and language-model. Type: String Length Constraints: Minimum length of 1. Maximum length of 1011. Pattern: arn:aws(-[^:]+)?:transcribe:[a-zA-Z0-9-]:[0-9]{12}:[a-zA-Z-]/ [0-9a-zA-Z._-]+ Required: Yes ListTagsForResource API Version 2017-10-26 123 API Reference Amazon Transcribe Response Syntax { "ResourceArn": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ResourceArn The Amazon Resource Name (ARN) speciﬁed in your request. Type: String Length Constraints: Minimum length of 1. Maximum length of 1011. Pattern: arn:aws(-[^:]+)?:transcribe:[a-zA-Z0-9-]:[0-9]{12}:[a-zA-Z-]/ [0-9a-zA-Z._-]+ Tags Lists all tags associated with the given transcription job, vocabulary, model, or resource. Type: Array of Tag objects Array Members: Minimum number of 1 item. Maximum number of 200 items. Errors For information about the errors that are common to all actions, see Common Errors. ListTagsForResource API Version 2017-10-26 124 Amazon Transcribe BadRequestException API Reference Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message ﬁeld for more information. HTTP Status Code: 400 InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again. HTTP Status Code: 500 LimitExceededException You've either sent too many requests or your input ﬁle is too long. Wait before retrying your request, or use a smaller ﬁle and try your request again. HTTP Status Code: 400 NotFoundException We can't ﬁnd the requested resource. Check that the speciﬁed name is correct and try your request again. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin ListTagsForResource API Version 2017-10-26 125 Amazon Transcribe • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference ListTagsForResource API Version 2017-10-26 126 Amazon Transcribe API Reference ListTranscriptionJobs Service: Amazon Transcribe Service Provides a list of transcription jobs that match the speciﬁed criteria. If no criteria are speciﬁed, all transcription jobs are returned. To get detailed information about a speciﬁc transcription job, use the GetTranscriptionJob operation. Request Syntax { "JobNameContains": "string", "MaxResults": number, "NextToken": "string", "Status": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. JobNameContains Returns only the transcription jobs that contain the speciﬁed string. The search is not case sensitive. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: No MaxResults 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
transcribe-api-030	transcribe-api.pdf	30	"string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. JobNameContains Returns only the transcription jobs that contain the speciﬁed string. The search is not case sensitive. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: No MaxResults 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. ListTranscriptionJobs API Version 2017-10-26 127 Amazon Transcribe Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. API Reference Required: No NextToken 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 view all your results. Type: String Length Constraints: Maximum length of 8192. Pattern: .+ Required: No Status Returns only transcription jobs with the speciﬁed status. Jobs are ordered by creation date, with the newest job ﬁrst. If you do not include Status, all transcription jobs are returned. Type: String Valid Values: QUEUED \| IN_PROGRESS \| FAILED \| COMPLETED Required: No Response Syntax { "NextToken": "string", "Status": "string", "TranscriptionJobSummaries": [ { "CompletionTime": number, "ContentRedaction": { "PiiEntityTypes": [ "string" ], "RedactionOutput": "string", "RedactionType": "string" ListTranscriptionJobs API Version 2017-10-26 128 Amazon Transcribe API Reference }, "CreationTime": number, "FailureReason": "string", "IdentifiedLanguageScore": number, "IdentifyLanguage": boolean, "IdentifyMultipleLanguages": boolean, "LanguageCode": "string", "LanguageCodes": [ { "DurationInSeconds": number, "LanguageCode": "string" } ], "ModelSettings": { "LanguageModelName": "string" }, "OutputLocationType": "string", "StartTime": number, "ToxicityDetection": [ { "ToxicityCategories": [ "string" ] } ], "TranscriptionJobName": "string", "TranscriptionJobStatus": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results. Type: String ListTranscriptionJobs API Version 2017-10-26 129 Amazon Transcribe API Reference Length Constraints: Maximum length of 8192. Pattern: .+ Status Lists all transcription jobs that have the status speciﬁed in your request. Jobs are ordered by creation date, with the newest job ﬁrst. Type: String Valid Values: QUEUED \| IN_PROGRESS \| FAILED \| COMPLETED TranscriptionJobSummaries Provides a summary of information about each result. Type: Array of TranscriptionJobSummary objects Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message ﬁeld for more information. HTTP Status Code: 400 InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again. HTTP Status Code: 500 LimitExceededException You've either sent too many requests or your input ﬁle is too long. Wait before retrying your request, or use a smaller ﬁle and try your request again. HTTP Status Code: 400 ListTranscriptionJobs API Version 2017-10-26 130 Amazon Transcribe See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 ListTranscriptionJobs API Version 2017-10-26 131 Amazon Transcribe API Reference ListVocabularies Service: Amazon Transcribe Service Provides a list of custom vocabularies that match the speciﬁed criteria. If no criteria are speciﬁed, all custom vocabularies are returned. To get detailed information about a speciﬁc custom vocabulary, use the GetVocabulary operation. Request Syntax { "MaxResults": number, "NameContains": "string", "NextToken": "string", "StateEquals": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MaxResults 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. Type: Integer Valid Range: Minimum value of 1.
transcribe-api-031	transcribe-api.pdf	31	detailed information about a speciﬁc custom vocabulary, use the GetVocabulary operation. Request Syntax { "MaxResults": number, "NameContains": "string", "NextToken": "string", "StateEquals": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MaxResults 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. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No NameContains Returns only the custom vocabularies that contain the speciﬁed string. The search is not case sensitive. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. ListVocabularies API Version 2017-10-26 132 Amazon Transcribe API Reference Pattern: ^[0-9a-zA-Z._-]+ Required: No NextToken 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 all your results. Type: String Length Constraints: Maximum length of 8192. Pattern: .+ Required: No StateEquals Returns only custom vocabularies with the speciﬁed state. Vocabularies are ordered by creation date, with the newest vocabulary ﬁrst. If you do not include StateEquals, all custom medical vocabularies are returned. Type: String Valid Values: PENDING \| READY \| FAILED Required: No Response Syntax { "NextToken": "string", "Status": "string", "Vocabularies": [ { "LanguageCode": "string", "LastModifiedTime": number, "VocabularyName": "string", "VocabularyState": "string" ListVocabularies API Version 2017-10-26 133 Amazon Transcribe } ] } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results. Type: String Length Constraints: Maximum length of 8192. Pattern: .+ Status Lists all custom vocabularies that have the status speciﬁed in your request. Vocabularies are ordered by creation date, with the newest vocabulary ﬁrst. Type: String Valid Values: PENDING \| READY \| FAILED Vocabularies Provides information about the custom vocabularies that match the criteria speciﬁed in your request. Type: Array of VocabularyInfo objects Errors For information about the errors that are common to all actions, see Common Errors. ListVocabularies API Version 2017-10-26 134 Amazon Transcribe BadRequestException API Reference Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message ﬁeld for more information. HTTP Status Code: 400 InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again. HTTP Status Code: 500 LimitExceededException You've either sent too many requests or your input ﬁle is too long. Wait before retrying your request, or use a smaller ﬁle and try your request again. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 ListVocabularies API Version 2017-10-26 135 Amazon Transcribe API Reference ListVocabularyFilters Service: Amazon Transcribe Service Provides a list of custom vocabulary ﬁlters that match the speciﬁed criteria. If no criteria are speciﬁed, all custom vocabularies are returned. To get detailed information about a speciﬁc custom vocabulary ﬁlter, use the GetVocabularyFilter operation. Request Syntax { "MaxResults": number, "NameContains": "string", "NextToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MaxResults The maximum number of custom vocabulary ﬁlters 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. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No NameContains Returns only the custom vocabulary ﬁlters that contain the speciﬁed string. The search is not case sensitive. Type: String Length Constraints: Minimum length of 1.
transcribe-api-032	transcribe-api.pdf	32	to all actions, see Common Parameters. The request accepts the following data in JSON format. MaxResults The maximum number of custom vocabulary ﬁlters 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. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No NameContains Returns only the custom vocabulary ﬁlters that contain the speciﬁed string. The search is not case sensitive. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. ListVocabularyFilters API Version 2017-10-26 136 Amazon Transcribe API Reference Pattern: ^[0-9a-zA-Z._-]+ Required: No NextToken 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 view all your results. Type: String Length Constraints: Maximum length of 8192. Pattern: .+ Required: No Response Syntax { "NextToken": "string", "VocabularyFilters": [ { "LanguageCode": "string", "LastModifiedTime": number, "VocabularyFilterName": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results ListVocabularyFilters API Version 2017-10-26 137 Amazon Transcribe API Reference output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results. Type: String Length Constraints: Maximum length of 8192. Pattern: .+ VocabularyFilters Provides information about the custom vocabulary ﬁlters that match the criteria speciﬁed in your request. Type: Array of VocabularyFilterInfo objects Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message ﬁeld for more information. HTTP Status Code: 400 InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again. HTTP Status Code: 500 LimitExceededException You've either sent too many requests or your input ﬁle is too long. Wait before retrying your request, or use a smaller ﬁle and try your request again. HTTP Status Code: 400 ListVocabularyFilters API Version 2017-10-26 138 Amazon Transcribe See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 ListVocabularyFilters API Version 2017-10-26 139 Amazon Transcribe API Reference StartCallAnalyticsJob Service: Amazon Transcribe Service 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 ﬁle. You can also apply custom categories to ﬂag speciﬁed conditions. To learn more about these features and insights, refer to Analyzing call center audio with Call Analytics. If you want to apply categories to your Call Analytics job, you must create them before submitting your job request. Categories cannot be retroactively applied to a job. To create a new category, use the CreateCallAnalyticsCategory operation. To learn more about Call Analytics categories, see Creating categories for post-call transcriptions and Creating categories for real-time transcriptions. To make a StartCallAnalyticsJob request, you must ﬁrst upload your media ﬁle into an Amazon S3 bucket; you can then specify the Amazon S3 location of the ﬁle using the Media parameter. Job queuing is available for Call Analytics jobs. If you pass a DataAccessRoleArn in your request and you exceed your Concurrent Job Limit, your job will automatically be added to a queue to be processed once your concurrent job count is below the limit. You must include the following parameters in your StartCallAnalyticsJob request: • region: The AWS Region where you are making your request. For a list of AWS Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas. • CallAnalyticsJobName: A custom name that you create for your transcription job that's unique within your AWS account. •
transcribe-api-033	transcribe-api.pdf	33	queuing is available for Call Analytics jobs. If you pass a DataAccessRoleArn in your request and you exceed your Concurrent Job Limit, your job will automatically be added to a queue to be processed once your concurrent job count is below the limit. You must include the following parameters in your StartCallAnalyticsJob request: • region: The AWS Region where you are making your request. For a list of AWS Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas. • CallAnalyticsJobName: A custom name that you create for your transcription job that's unique within your AWS account. • Media (MediaFileUri or RedactedMediaFileUri): The Amazon S3 location of your media ﬁle. Note With Call Analytics, you can redact the audio contained in your media ﬁle by including RedactedMediaFileUri, instead of MediaFileUri, to specify the location of your input StartCallAnalyticsJob API Version 2017-10-26 140 Amazon Transcribe API Reference audio. If you choose to redact your audio, you can ﬁnd your redacted media at the location speciﬁed in the RedactedMediaFileUri ﬁeld of your response. Request Syntax { "CallAnalyticsJobName": "string", "ChannelDefinitions": [ { "ChannelId": number, "ParticipantRole": "string" } ], "DataAccessRoleArn": "string", "Media": { "MediaFileUri": "string", "RedactedMediaFileUri": "string" }, "OutputEncryptionKMSKeyId": "string", "OutputLocation": "string", "Settings": { "ContentRedaction": { "PiiEntityTypes": [ "string" ], "RedactionOutput": "string", "RedactionType": "string" }, "LanguageIdSettings": { "string" : { "LanguageModelName": "string", "VocabularyFilterName": "string", "VocabularyName": "string" } }, "LanguageModelName": "string", "LanguageOptions": [ "string" ], "Summarization": { "GenerateAbstractiveSummary": boolean }, "VocabularyFilterMethod": "string", "VocabularyFilterName": "string", "VocabularyName": "string" }, StartCallAnalyticsJob API Version 2017-10-26 141 Amazon Transcribe "Tags": [ { "Key": "string", "Value": "string" } ] } Request Parameters API Reference For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. CallAnalyticsJobName 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 AWS account. If you try to create a new job with the same name as an existing job, you get a ConflictException error. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: Yes ChannelDeﬁnitions Makes it possible to specify which speaker is on which channel. For example, if your agent is the ﬁrst participant to speak, you would set ChannelId to 0 (to indicate the ﬁrst channel) and ParticipantRole to AGENT (to indicate that it's the agent speaking). Type: Array of ChannelDeﬁnition objects Array Members: Fixed number of 2 items. Required: No StartCallAnalyticsJob API Version 2017-10-26 142 Amazon Transcribe DataAccessRoleArn API Reference The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input ﬁles. If the role that you specify doesn’t have the appropriate permissions to access the speciﬁed Amazon S3 location, your request fails. IAM role ARNs have the format arn:partition:iam::account:role/role-name-with- path. For example: arn:aws:iam::111122223333:role/Admin. For more information, see IAM ARNs. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso-{0,1}[a-z]{0,1}):iam::[0-9] {0,63}:role/[A-Za-z0-9:_/+=,@.-]{0,1024}$ Required: No Media Describes the Amazon S3 location of the media ﬁle you want to use in your Call Analytics request. Type: Media object Required: Yes OutputEncryptionKMSKeyId The KMS key you want to use to encrypt your Call Analytics output. If using a key located in the current AWS account, you can specify your KMS key in one of four ways: 1. Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. 2. Use an alias for the KMS key ID. For example, alias/ExampleAlias. 3. Use the Amazon Resource Name (ARN) for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. 4. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account- ID:alias/ExampleAlias. StartCallAnalyticsJob API Version 2017-10-26 143 Amazon Transcribe API Reference If using a key located in a diﬀerent AWS account than the current AWS account, you can specify your KMS key in one of two ways: 1. Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account- ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. 2. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account- ID:alias/ExampleAlias. If you do not specify an encryption key, your output is encrypted with the default Amazon S3 key (SSE-S3). If you specify a KMS key to encrypt your output, you must also specify an output location using the OutputLocation parameter. Note that the role making the StartCallAnalyticsJob request must have permission to use the speciﬁed KMS key. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$ Required: No OutputLocation 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: 1. s3://DOC-EXAMPLE-BUCKET 2. s3://DOC-EXAMPLE-BUCKET/my-output-folder/ 3. s3://DOC-EXAMPLE-BUCKET/my-output-folder/my-call-analytics-job.json Unless you specify a ﬁle name (option 3), the name of your output ﬁle has a default value that matches the name you speciﬁed
transcribe-api-034	transcribe-api.pdf	34	must also specify an output location using the OutputLocation parameter. Note that the role making the StartCallAnalyticsJob request must have permission to use the speciﬁed KMS key. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$ Required: No OutputLocation 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: 1. s3://DOC-EXAMPLE-BUCKET 2. s3://DOC-EXAMPLE-BUCKET/my-output-folder/ 3. s3://DOC-EXAMPLE-BUCKET/my-output-folder/my-call-analytics-job.json Unless you specify a ﬁle name (option 3), the name of your output ﬁle has a default value that matches the name you speciﬁed for your transcription job using the CallAnalyticsJobName parameter. You can specify a KMS key to encrypt your output using the OutputEncryptionKMSKeyId parameter. If you do not specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption. StartCallAnalyticsJob API Version 2017-10-26 144 Amazon Transcribe API Reference If you do not specify OutputLocation, your transcript is placed in a service-managed Amazon S3 bucket and you are provided with a URI to access your transcript. Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. Pattern: (s3://\|http(s*)://).+ Required: No Settings Specify additional optional settings in your StartCallAnalyticsJob request, including content redaction; allows you to apply custom language models, vocabulary ﬁlters, and custom vocabularies to your Call Analytics job. Type: CallAnalyticsJobSettings object Required: No Tags 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. Type: Array of Tag objects Array Members: Minimum number of 1 item. Maximum number of 200 items. Required: No Response Syntax { "CallAnalyticsJob": { "CallAnalyticsJobDetails": { "Skipped": [ { "Feature": "string", "Message": "string", "ReasonCode": "string" } StartCallAnalyticsJob API Version 2017-10-26 145 API Reference Amazon Transcribe ] }, "CallAnalyticsJobName": "string", "CallAnalyticsJobStatus": "string", "ChannelDefinitions": [ { "ChannelId": number, "ParticipantRole": "string" } ], "CompletionTime": number, "CreationTime": number, "DataAccessRoleArn": "string", "FailureReason": "string", "IdentifiedLanguageScore": number, "LanguageCode": "string", "Media": { "MediaFileUri": "string", "RedactedMediaFileUri": "string" }, "MediaFormat": "string", "MediaSampleRateHertz": number, "Settings": { "ContentRedaction": { "PiiEntityTypes": [ "string" ], "RedactionOutput": "string", "RedactionType": "string" }, "LanguageIdSettings": { "string" : { "LanguageModelName": "string", "VocabularyFilterName": "string", "VocabularyName": "string" } }, "LanguageModelName": "string", "LanguageOptions": [ "string" ], "Summarization": { "GenerateAbstractiveSummary": boolean }, "VocabularyFilterMethod": "string", "VocabularyFilterName": "string", "VocabularyName": "string" }, StartCallAnalyticsJob API Version 2017-10-26 146 Amazon Transcribe API Reference "StartTime": number, "Tags": [ { "Key": "string", "Value": "string" } ], "Transcript": { "RedactedTranscriptFileUri": "string", "TranscriptFileUri": "string" } } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. CallAnalyticsJob Provides detailed information about the current Call Analytics job, including job status and, if applicable, failure reason. Type: CallAnalyticsJob object Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message ﬁeld for more information. HTTP Status Code: 400 ConﬂictException A resource already exists with this name. Resource names must be unique within an AWS account. StartCallAnalyticsJob API Version 2017-10-26 147 Amazon Transcribe HTTP Status Code: 400 InternalFailureException API Reference There was an internal error. Check the error message, correct the issue, and try your request again. HTTP Status Code: 500 LimitExceededException You've either sent too many requests or your input ﬁle is too long. Wait before retrying your request, or use a smaller ﬁle and try your request again. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 StartCallAnalyticsJob API Version 2017-10-26 148 Amazon Transcribe API Reference StartMedicalScribeJob Service: Amazon Transcribe Service Transcribes patient-clinician conversations and generates clinical notes. AWS HealthScribe automatically provides rich conversation transcripts, identiﬁes speaker roles, classiﬁes dialogues, extracts medical terms, and generates preliminary clinical notes. To learn more about these features, refer to AWS HealthScribe. To make a StartMedicalScribeJob request, you must ﬁrst upload your media ﬁle into an Amazon S3 bucket; you can then specify the Amazon S3 location of the ﬁle using the Media parameter. You must include the following parameters in your StartMedicalTranscriptionJob request: • DataAccessRoleArn: The ARN of an IAM role with the these minimum permissions: read permission on
transcribe-api-035	transcribe-api.pdf	35	StartMedicalScribeJob Service: Amazon Transcribe Service Transcribes patient-clinician conversations and generates clinical notes. AWS HealthScribe automatically provides rich conversation transcripts, identiﬁes speaker roles, classiﬁes dialogues, extracts medical terms, and generates preliminary clinical notes. To learn more about these features, refer to AWS HealthScribe. To make a StartMedicalScribeJob request, you must ﬁrst upload your media ﬁle into an Amazon S3 bucket; you can then specify the Amazon S3 location of the ﬁle using the Media parameter. You must include the following parameters in your StartMedicalTranscriptionJob request: • DataAccessRoleArn: The ARN of an IAM role with the these minimum permissions: read permission on input ﬁle Amazon S3 bucket speciﬁed in Media, write permission on the Amazon S3 bucket speciﬁed in OutputBucketName, and full permissions on the AWS KMS key speciﬁed in OutputEncryptionKMSKeyId (if set). The role should also allow transcribe.amazonaws.com to assume it. • Media (MediaFileUri): The Amazon S3 location of your media ﬁle. • MedicalScribeJobName: A custom name you create for your MedicalScribe job that is unique within your AWS account. • OutputBucketName: The Amazon S3 bucket where you want your output ﬁles stored. • Settings: A MedicalScribeSettings obect that must set exactly one of ShowSpeakerLabels or ChannelIdentification to true. If ShowSpeakerLabels is true, MaxSpeakerLabels must also be set. • ChannelDefinitions: A MedicalScribeChannelDefinitions array should be set if and only if the ChannelIdentification value of Settings is set to true. Request Syntax { "ChannelDefinitions": [ { "ChannelId": number, "ParticipantRole": "string" StartMedicalScribeJob API Version 2017-10-26 149 API Reference Amazon Transcribe } ], "DataAccessRoleArn": "string", "KMSEncryptionContext": { "string" : "string" }, "Media": { "MediaFileUri": "string", "RedactedMediaFileUri": "string" }, "MedicalScribeJobName": "string", "OutputBucketName": "string", "OutputEncryptionKMSKeyId": "string", "Settings": { "ChannelIdentification": boolean, "ClinicalNoteGenerationSettings": { "NoteTemplate": "string" }, "MaxSpeakerLabels": number, "ShowSpeakerLabels": boolean, "VocabularyFilterMethod": "string", "VocabularyFilterName": "string", "VocabularyName": "string" }, "Tags": [ { "Key": "string", "Value": "string" } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ChannelDeﬁnitions Makes it possible to specify which speaker is on which channel. For example, if the clinician is the ﬁrst participant to speak, you would set ChannelId of the ﬁrst ChannelDefinition in the list to 0 (to indicate the ﬁrst channel) and ParticipantRole to CLINICIAN (to StartMedicalScribeJob API Version 2017-10-26 150 Amazon Transcribe API Reference indicate that it's the clinician speaking). Then you would set the ChannelId of the second ChannelDefinition in the list to 1 (to indicate the second channel) and ParticipantRole to PATIENT (to indicate that it's the patient speaking). Type: Array of MedicalScribeChannelDeﬁnition objects Array Members: Fixed number of 2 items. Required: No DataAccessRoleArn The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input ﬁles, write to the output bucket, and use your AWS KMS key if supplied. If the role that you specify doesn’t have the appropriate permissions your request fails. IAM role ARNs have the format arn:partition:iam::account:role/role-name-with- path. For example: arn:aws:iam::111122223333:role/Admin. For more information, see IAM ARNs. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso-{0,1}[a-z]{0,1}):iam::[0-9] {0,63}:role/[A-Za-z0-9:_/+=,@.-]{0,1024}$ Required: Yes KMSEncryptionContext A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data. For more information, see AWS KMS encryption context and Asymmetric keys in AWS KMS. Type: String to string map Map Entries: Maximum number of 10 items. Key Length Constraints: Minimum length of 1. Maximum length of 2000. StartMedicalScribeJob API Version 2017-10-26 151 Amazon Transcribe Key Pattern: .\S. API Reference Value Length Constraints: Minimum length of 1. Maximum length of 2000. Value Pattern: .\S. Required: No Media Describes the Amazon S3 location of the media ﬁle you want to use in your request. For information on supported media formats, refer to the MediaFormat parameter or the Media formats section in the Amazon S3 Developer Guide. Type: Media object Required: Yes MedicalScribeJobName 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 AWS account. If you try to create a new job with the same name as an existing job, you get a ConflictException error. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: Yes OutputBucketName The name of the Amazon S3 bucket where you want your Medical Scribe output stored. Do not include the S3:// preﬁx of the speciﬁed bucket. Note that the role speciﬁed in the DataAccessRoleArn request parameter must have permission to use the speciﬁed location. You can change Amazon S3 permissions using the AWS Management Console. See also Permissions Required for IAM User Roles. Type: String StartMedicalScribeJob API Version 2017-10-26 152 Amazon Transcribe API Reference Length Constraints: Maximum length of 64. Pattern: [a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9] Required: Yes OutputEncryptionKMSKeyId The
transcribe-api-036	transcribe-api.pdf	36	Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: Yes OutputBucketName The name of the Amazon S3 bucket where you want your Medical Scribe output stored. Do not include the S3:// preﬁx of the speciﬁed bucket. Note that the role speciﬁed in the DataAccessRoleArn request parameter must have permission to use the speciﬁed location. You can change Amazon S3 permissions using the AWS Management Console. See also Permissions Required for IAM User Roles. Type: String StartMedicalScribeJob API Version 2017-10-26 152 Amazon Transcribe API Reference Length Constraints: Maximum length of 64. Pattern: [a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9] Required: Yes OutputEncryptionKMSKeyId The KMS key you want to use to encrypt your Medical Scribe output. If using a key located in the current AWS account, you can specify your KMS key in one of four ways: 1. Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. 2. Use an alias for the KMS key ID. For example, alias/ExampleAlias. 3. Use the Amazon Resource Name (ARN) for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. 4. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account- ID:alias/ExampleAlias. If using a key located in a diﬀerent AWS account than the current AWS account, you can specify your KMS key in one of two ways: 1. Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account- ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. 2. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account- ID:alias/ExampleAlias. If you do not specify an encryption key, your output is encrypted with the default Amazon S3 key (SSE-S3). Note that the role speciﬁed in the DataAccessRoleArn request parameter must have permission to use the speciﬁed KMS key. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$ Required: No StartMedicalScribeJob API Version 2017-10-26 153 Amazon Transcribe Settings API Reference 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 and ShowSpeakerLabels must be set. If ShowSpeakerLabels is set, MaxSpeakerLabels must also be set. Use Settings to specify a vocabulary or vocabulary ﬁlter or both using VocabularyName, VocabularyFilterName. VocabularyFilterMethod must be speciﬁed if VocabularyFilterName is set. Type: MedicalScribeSettings object Required: Yes Tags Adds one or more custom tags, each in the form of a key:value pair, to the Medica Scribe job. To learn more about using tags with Amazon Transcribe, refer to Tagging resources. Type: Array of Tag objects Array Members: Minimum number of 1 item. Maximum number of 200 items. Required: No Response Syntax { "MedicalScribeJob": { "ChannelDefinitions": [ { "ChannelId": number, "ParticipantRole": "string" } ], "CompletionTime": number, "CreationTime": number, "DataAccessRoleArn": "string", "FailureReason": "string", "LanguageCode": "string", StartMedicalScribeJob API Version 2017-10-26 154 Amazon Transcribe API Reference "Media": { "MediaFileUri": "string", "RedactedMediaFileUri": "string" }, "MedicalScribeJobName": "string", "MedicalScribeJobStatus": "string", "MedicalScribeOutput": { "ClinicalDocumentUri": "string", "TranscriptFileUri": "string" }, "Settings": { "ChannelIdentification": boolean, "ClinicalNoteGenerationSettings": { "NoteTemplate": "string" }, "MaxSpeakerLabels": number, "ShowSpeakerLabels": boolean, "VocabularyFilterMethod": "string", "VocabularyFilterName": "string", "VocabularyName": "string" }, "StartTime": number, "Tags": [ { "Key": "string", "Value": "string" } ] } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. MedicalScribeJob Provides detailed information about the current Medical Scribe job, including job status and, if applicable, failure reason. Type: MedicalScribeJob object StartMedicalScribeJob API Version 2017-10-26 155 Amazon Transcribe Errors API Reference For information about the errors that are common to all actions, see Common Errors. BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message ﬁeld for more information. HTTP Status Code: 400 ConﬂictException A resource already exists with this name. Resource names must be unique within an AWS account. HTTP Status Code: 400 InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again. HTTP Status Code: 500 LimitExceededException You've either sent too many requests or your input ﬁle is too long. Wait before retrying your request, or use a smaller ﬁle and try your request again. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 StartMedicalScribeJob API Version 2017-10-26 156 Amazon Transcribe • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference StartMedicalScribeJob API Version 2017-10-26 157 Amazon Transcribe API Reference StartMedicalTranscriptionJob Service: Amazon
transcribe-api-037	transcribe-api.pdf	37	again. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 StartMedicalScribeJob API Version 2017-10-26 156 Amazon Transcribe • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference StartMedicalScribeJob API Version 2017-10-26 157 Amazon Transcribe API Reference StartMedicalTranscriptionJob Service: Amazon Transcribe Service 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 identiﬁcation, which adds ﬂags to personal health information (PHI). To learn more about these features, refer to How Amazon Transcribe Medical works. To make a StartMedicalTranscriptionJob request, you must ﬁrst upload your media ﬁle into an Amazon S3 bucket; you can then specify the Amazon S3 location of the ﬁle using the Media parameter. You must include the following parameters in your StartMedicalTranscriptionJob request: • region: The AWS Region where you are making your request. For a list of AWS Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas. • MedicalTranscriptionJobName: A custom name you create for your transcription job that is unique within your AWS account. • Media (MediaFileUri): The Amazon S3 location of your media ﬁle. • LanguageCode: This must be en-US. • OutputBucketName: The Amazon S3 bucket where you want your transcript stored. If you want your output stored in a sub-folder of this bucket, you must also include OutputKey. • Specialty: This must be PRIMARYCARE. • Type: Choose whether your audio is a conversation or a dictation. Request Syntax { "ContentIdentificationType": "string", "KMSEncryptionContext": { "string" : "string" }, "LanguageCode": "string", "Media": { StartMedicalTranscriptionJob API Version 2017-10-26 158 Amazon Transcribe API Reference "MediaFileUri": "string", "RedactedMediaFileUri": "string" }, "MediaFormat": "string", "MediaSampleRateHertz": number, "MedicalTranscriptionJobName": "string", "OutputBucketName": "string", "OutputEncryptionKMSKeyId": "string", "OutputKey": "string", "Settings": { "ChannelIdentification": boolean, "MaxAlternatives": number, "MaxSpeakerLabels": number, "ShowAlternatives": boolean, "ShowSpeakerLabels": boolean, "VocabularyName": "string" }, "Specialty": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "Type": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ContentIdentiﬁcationType Labels all personal health information (PHI) identiﬁed in your transcript. For more information, see Identifying personal health information (PHI) in a transcription. Type: String Valid Values: PHI Required: No StartMedicalTranscriptionJob API Version 2017-10-26 159 Amazon Transcribe KMSEncryptionContext API Reference 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 AWS KMS encryption context and Asymmetric keys in AWS KMS. Type: String to string map Map Entries: Maximum number of 10 items. Key Length Constraints: Minimum length of 1. Maximum length of 2000. Key Pattern: .\S. Value Length Constraints: Minimum length of 1. Maximum length of 2000. Value Pattern: .\S. Required: No LanguageCode The language code that represents the language spoken in the input media ﬁle. 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. Type: String Valid Values: af-ZA \| ar-AE \| ar-SA \| da-DK \| de-CH \| de-DE \| en-AB \| en-AU \| en-GB \| en-IE \| en-IN \| en-US \| en-WL \| es-ES \| es-US \| fa-IR \| fr-CA \| fr-FR \| he-IL \| hi-IN \| id-ID \| it-IT \| ja-JP \| ko-KR \| 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-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 \| or-IN \| pa-IN \| pl-PL \| ps-AF \| ro-RO \| rw-RW \| si-LK \| sk-SK \| sl-SI \| so-SO \| 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 \| zu-ZA StartMedicalTranscriptionJob API Version 2017-10-26 160 Amazon Transcribe Required: Yes Media API Reference Describes the Amazon S3 location of
transcribe-api-038	transcribe-api.pdf	38	\| 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 \| or-IN \| pa-IN \| pl-PL \| ps-AF \| ro-RO \| rw-RW \| si-LK \| sk-SK \| sl-SI \| so-SO \| 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 \| zu-ZA StartMedicalTranscriptionJob API Version 2017-10-26 160 Amazon Transcribe Required: Yes Media API Reference Describes the Amazon S3 location of the media ﬁle you want to use in your request. For information on supported media formats, refer to the MediaFormat parameter or the Media formats section in the Amazon S3 Developer Guide. Type: Media object Required: Yes MediaFormat Specify the format of your input media ﬁle. Type: String Valid Values: mp3 \| mp4 \| wav \| flac \| ogg \| amr \| webm \| m4a Required: No MediaSampleRateHertz The sample rate, in hertz, of the audio track in your input media ﬁle. 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 that you specify and the value detected, your job fails. Therefore, in most cases, it's advised to omit MediaSampleRateHertz and let Amazon Transcribe Medical determine the sample rate. Type: Integer Valid Range: Minimum value of 16000. Maximum value of 48000. Required: No MedicalTranscriptionJobName A unique name, chosen by you, for your medical transcription job. The name that you specify is also used as the default name of your transcription output ﬁle. If you want to specify a diﬀerent name for your transcription output, use the OutputKey parameter. StartMedicalTranscriptionJob API Version 2017-10-26 161 Amazon Transcribe API Reference This name is case sensitive, cannot contain spaces, and must be unique within an AWS account. If you try to create a new job with the same name as an existing job, you get a ConflictException error. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: Yes OutputBucketName The name of the Amazon S3 bucket where you want your medical transcription output stored. Do not include the S3:// preﬁx of the speciﬁed bucket. If you want your output to go to a sub-folder of this bucket, specify it using the OutputKey parameter; OutputBucketName only accepts the name of a bucket. For example, if you want your output stored in S3://DOC-EXAMPLE-BUCKET, set OutputBucketName to DOC-EXAMPLE-BUCKET. However, if you want your output stored in S3://DOC-EXAMPLE-BUCKET/test-files/, set OutputBucketName to DOC-EXAMPLE- BUCKET and OutputKey to test-files/. Note that Amazon Transcribe must have permission to use the speciﬁed location. You can change Amazon S3 permissions using the AWS Management Console. See also Permissions Required for IAM User Roles. Type: String Length Constraints: Maximum length of 64. Pattern: [a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9] Required: Yes OutputEncryptionKMSKeyId The KMS key you want to use to encrypt your medical transcription output. If using a key located in the current AWS account, you can specify your KMS key in one of four ways: StartMedicalTranscriptionJob API Version 2017-10-26 162 Amazon Transcribe API Reference 1. Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. 2. Use an alias for the KMS key ID. For example, alias/ExampleAlias. 3. Use the Amazon Resource Name (ARN) for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. 4. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account- ID:alias/ExampleAlias. If using a key located in a diﬀerent AWS account than the current AWS account, you can specify your KMS key in one of two ways: 1. Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account- ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. 2. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account- ID:alias/ExampleAlias. If you do not specify an encryption key, your output is encrypted with the default Amazon S3 key (SSE-S3). If you specify a KMS key to encrypt your output, you must also specify an output location using the OutputLocation parameter. Note that the role making the StartCallAnalyticsJob request must have permission to use the speciﬁed KMS key. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$ Required: No OutputKey Use in combination with OutputBucketName to specify the output location of your transcript and, optionally, a unique name for your output ﬁle. The default name for your transcription output is the same as the name you speciﬁed for your medical transcription job (MedicalTranscriptionJobName). Here are some examples of how you can use OutputKey: StartMedicalTranscriptionJob API Version 2017-10-26 163 Amazon Transcribe API Reference • If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'my-transcript.json' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my- transcript.json.
transcribe-api-039	transcribe-api.pdf	39	key. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$ Required: No OutputKey Use in combination with OutputBucketName to specify the output location of your transcript and, optionally, a unique name for your output ﬁle. The default name for your transcription output is the same as the name you speciﬁed for your medical transcription job (MedicalTranscriptionJobName). Here are some examples of how you can use OutputKey: StartMedicalTranscriptionJob API Version 2017-10-26 163 Amazon Transcribe API Reference • If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'my-transcript.json' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my- transcript.json. • If you specify 'my-ﬁrst-transcription' as the MedicalTranscriptionJobName, 'DOC- EXAMPLE-BUCKET' as the OutputBucketName, and 'my-transcript' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first- transcription.json. • If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'test-ﬁles/my- transcript.json' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE- BUCKET/test-files/my-transcript.json. • If you specify 'my-ﬁrst-transcription' as the MedicalTranscriptionJobName, 'DOC- EXAMPLE-BUCKET' as the OutputBucketName, and 'test-ﬁles/my-transcript' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/test-files/ my-transcript/my-first-transcription.json. If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist, one is created for you. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: [a-zA-Z0-9-_.!*'()/]{1,1024}$ Required: No Settings Specify additional optional settings in your StartMedicalTranscriptionJob request, including channel identiﬁcation, alternative transcriptions, and speaker partitioning. You can use that to apply custom vocabularies to your transcription job. Type: MedicalTranscriptionSetting object Required: No Specialty Specify the predominant medical specialty represented in your media. For batch transcriptions, PRIMARYCARE is the only valid value. If you require additional specialties, refer to StartMedicalStreamTranscription. StartMedicalTranscriptionJob API Version 2017-10-26 164 Amazon Transcribe Type: String Valid Values: PRIMARYCARE Required: Yes Tags API Reference 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. Type: Array of Tag objects Array Members: Minimum number of 1 item. Maximum number of 200 items. Required: No Type Specify whether your input media contains only one person (DICTATION) or contains a conversation between two people (CONVERSATION). For example, DICTATION could be used for a medical professional wanting to transcribe voice memos; CONVERSATION could be used for transcribing the doctor-patient dialogue during the patient's oﬃce visit. Type: String Valid Values: CONVERSATION \| DICTATION Required: Yes Response Syntax { "MedicalTranscriptionJob": { "CompletionTime": number, "ContentIdentificationType": "string", "CreationTime": number, "FailureReason": "string", "LanguageCode": "string", StartMedicalTranscriptionJob API Version 2017-10-26 165 Amazon Transcribe API Reference "Media": { "MediaFileUri": "string", "RedactedMediaFileUri": "string" }, "MediaFormat": "string", "MediaSampleRateHertz": number, "MedicalTranscriptionJobName": "string", "Settings": { "ChannelIdentification": boolean, "MaxAlternatives": number, "MaxSpeakerLabels": number, "ShowAlternatives": boolean, "ShowSpeakerLabels": boolean, "VocabularyName": "string" }, "Specialty": "string", "StartTime": number, "Tags": [ { "Key": "string", "Value": "string" } ], "Transcript": { "TranscriptFileUri": "string" }, "TranscriptionJobStatus": "string", "Type": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. MedicalTranscriptionJob Provides detailed information about the current medical transcription job, including job status and, if applicable, failure reason. Type: MedicalTranscriptionJob object StartMedicalTranscriptionJob API Version 2017-10-26 166 Amazon Transcribe Errors API Reference For information about the errors that are common to all actions, see Common Errors. BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message ﬁeld for more information. HTTP Status Code: 400 ConﬂictException A resource already exists with this name. Resource names must be unique within an AWS account. HTTP Status Code: 400 InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again. HTTP Status Code: 500 LimitExceededException You've either sent too many requests or your input ﬁle is too long. Wait before retrying your request, or use a smaller ﬁle and try your request again. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 StartMedicalTranscriptionJob API Version 2017-10-26 167 Amazon Transcribe • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference StartMedicalTranscriptionJob API Version 2017-10-26 168 Amazon Transcribe API Reference StartTranscriptionJob Service: Amazon Transcribe Service Transcribes the audio from a media ﬁle and applies any additional Request Parameters you choose to include in your request. To make a StartTranscriptionJob request, you must ﬁrst upload your media ﬁle into an
transcribe-api-040	transcribe-api.pdf	40	SDK for C++ • AWS SDK for Go v2 StartMedicalTranscriptionJob API Version 2017-10-26 167 Amazon Transcribe • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference StartMedicalTranscriptionJob API Version 2017-10-26 168 Amazon Transcribe API Reference StartTranscriptionJob Service: Amazon Transcribe Service Transcribes the audio from a media ﬁle and applies any additional Request Parameters you choose to include in your request. To make a StartTranscriptionJob request, you must ﬁrst upload your media ﬁle into an Amazon S3 bucket; you can then specify the Amazon S3 location of the ﬁle using the Media parameter. You must include the following parameters in your StartTranscriptionJob request: • region: The AWS Region where you are making your request. For a list of AWS Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas. • TranscriptionJobName: A custom name you create for your transcription job that is unique within your AWS account. • Media (MediaFileUri): The Amazon S3 location of your media ﬁle. • One of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages: If you know the language of your media ﬁle, specify it using the LanguageCode parameter; you can ﬁnd all valid language codes in the Supported languages table. If you do not know the languages spoken in your media, use either IdentifyLanguage or IdentifyMultipleLanguages and let Amazon Transcribe identify the languages for you. Request Syntax { "ContentRedaction": { "PiiEntityTypes": [ "string" ], "RedactionOutput": "string", "RedactionType": "string" }, "IdentifyLanguage": boolean, "IdentifyMultipleLanguages": boolean, "JobExecutionSettings": { "AllowDeferredExecution": boolean, "DataAccessRoleArn": "string" }, "KMSEncryptionContext": { "string" : "string" StartTranscriptionJob API Version 2017-10-26 169 API Reference Amazon Transcribe }, "LanguageCode": "string", "LanguageIdSettings": { "string" : { "LanguageModelName": "string", "VocabularyFilterName": "string", "VocabularyName": "string" } }, "LanguageOptions": [ "string" ], "Media": { "MediaFileUri": "string", "RedactedMediaFileUri": "string" }, "MediaFormat": "string", "MediaSampleRateHertz": number, "ModelSettings": { "LanguageModelName": "string" }, "OutputBucketName": "string", "OutputEncryptionKMSKeyId": "string", "OutputKey": "string", "Settings": { "ChannelIdentification": boolean, "MaxAlternatives": number, "MaxSpeakerLabels": number, "ShowAlternatives": boolean, "ShowSpeakerLabels": boolean, "VocabularyFilterMethod": "string", "VocabularyFilterName": "string", "VocabularyName": "string" }, "Subtitles": { "Formats": [ "string" ], "OutputStartIndex": number }, "Tags": [ { "Key": "string", "Value": "string" } ], "ToxicityDetection": [ { StartTranscriptionJob API Version 2017-10-26 170 Amazon Transcribe API Reference "ToxicityCategories": [ "string" ] } ], "TranscriptionJobName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ContentRedaction Makes it possible to redact or ﬂag speciﬁed personally identiﬁable 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 redact. If you do not include PiiEntityTypes in your request, all PII is redacted. Type: ContentRedaction object Required: No IdentifyLanguage Enables automatic language identiﬁcation in your transcription job request. Use this parameter if your media ﬁle contains only one language. If your media contains multiple languages, use IdentifyMultipleLanguages instead. If you include IdentifyLanguage, you can optionally include a list of language codes, using LanguageOptions, that you think may be present in your media ﬁle. Including LanguageOptions restricts IdentifyLanguage to only the language options that you specify, which can improve transcription accuracy. If you want to apply a custom language model, a custom vocabulary, or a custom vocabulary ﬁlter to your automatic language identiﬁcation request, include LanguageIdSettings with the relevant sub-parameters (VocabularyName, LanguageModelName, and VocabularyFilterName). If you include LanguageIdSettings, also include LanguageOptions. StartTranscriptionJob API Version 2017-10-26 171 Amazon Transcribe API Reference Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails. Type: Boolean Required: No IdentifyMultipleLanguages Enables automatic multi-language identiﬁcation in your transcription job request. Use this parameter if your media ﬁle contains more than one language. If your media contains only one language, use IdentifyLanguage instead. If you include IdentifyMultipleLanguages, you can optionally include a list of language codes, using LanguageOptions, that you think may be present in your media ﬁle. Including LanguageOptions restricts IdentifyLanguage to only the language options that you specify, which can improve transcription accuracy. If you want to apply a custom vocabulary or a custom vocabulary ﬁlter to your automatic language identiﬁcation request, include LanguageIdSettings with the relevant sub-parameters (VocabularyName and VocabularyFilterName). If you include LanguageIdSettings, also include LanguageOptions. Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails. Type: Boolean Required: No JobExecutionSettings Makes it possible to control how your transcription job is processed. Currently, the only JobExecutionSettings modiﬁcation you can choose is enabling job queueing using the AllowDeferredExecution sub-parameter. If you include JobExecutionSettings in your request, you must also
transcribe-api-041	transcribe-api.pdf	41	apply a custom vocabulary or a custom vocabulary ﬁlter to your automatic language identiﬁcation request, include LanguageIdSettings with the relevant sub-parameters (VocabularyName and VocabularyFilterName). If you include LanguageIdSettings, also include LanguageOptions. Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails. Type: Boolean Required: No JobExecutionSettings Makes it possible to control how your transcription job is processed. Currently, the only JobExecutionSettings modiﬁcation you can choose is enabling job queueing using the AllowDeferredExecution sub-parameter. If you include JobExecutionSettings in your request, you must also include the sub- parameters: AllowDeferredExecution and DataAccessRoleArn. Type: JobExecutionSettings object StartTranscriptionJob API Version 2017-10-26 172 Amazon Transcribe Required: No KMSEncryptionContext API Reference 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 AWS KMS encryption context and Asymmetric keys in AWS KMS. Type: String to string map Map Entries: Maximum number of 10 items. Key Length Constraints: Minimum length of 1. Maximum length of 2000. Key Pattern: .\S. Value Length Constraints: Minimum length of 1. Maximum length of 2000. Value Pattern: .\S. Required: No LanguageCode The language code that represents the language spoken in the input media ﬁle. If you're unsure of the language spoken in your media ﬁle, consider using IdentifyLanguage or IdentifyMultipleLanguages to enable automatic language identiﬁcation. Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails. For a list of supported languages and their associated language codes, refer to the Supported languages table. Note To transcribe speech in Modern Standard Arabic (ar-SA) in AWS GovCloud (US) (US- West, us-gov-west-1), AWS GovCloud (US) (US-East, us-gov-east-1), Canada (Calgary, ca-west-1) and Africa (Cape Town, af-south-1), your media ﬁle must be encoded at a sample rate of 16,000 Hz or higher. StartTranscriptionJob API Version 2017-10-26 173 Amazon Transcribe Type: String API Reference Valid Values: af-ZA \| ar-AE \| ar-SA \| da-DK \| de-CH \| de-DE \| en-AB \| en-AU \| en-GB \| en-IE \| en-IN \| en-US \| en-WL \| es-ES \| es-US \| fa-IR \| fr-CA \| fr-FR \| he-IL \| hi-IN \| id-ID \| it-IT \| ja-JP \| ko-KR \| 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-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 \| or-IN \| pa-IN \| pl-PL \| ps-AF \| ro-RO \| rw-RW \| si-LK \| sk-SK \| sl-SI \| so-SO \| 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 \| zu-ZA Required: No LanguageIdSettings If using automatic language identiﬁcation in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary ﬁlter, include LanguageIdSettings with the relevant sub-parameters (VocabularyName, LanguageModelName, and VocabularyFilterName). Note that multi-language identiﬁcation (IdentifyMultipleLanguages) doesn't support custom language models. LanguageIdSettings supports two to ﬁve language codes. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary ﬁlter. The language codes that you specify must match the languages of the associated custom language models, custom vocabularies, and custom vocabulary ﬁlters. It's recommended that you include LanguageOptions when using LanguageIdSettings to ensure that the correct language dialect is identiﬁed. For example, if you specify a custom vocabulary that is in en-US but Amazon Transcribe determines that the language spoken in your media is en-AU, your custom vocabulary is not applied to your transcription. If you include LanguageOptions and include en-US as the only English language dialect, your custom vocabulary is applied to your transcription. If you want to include a custom language model with your request but do not want to use automatic language identiﬁcation, use instead the ModelSettings parameter with the LanguageModelName sub-parameter. If you want to include a custom vocabulary or StartTranscriptionJob API Version 2017-10-26 174 Amazon Transcribe API Reference a custom vocabulary ﬁlter (or both) with your request but do not want to use automatic language identiﬁcation, use instead the Settings parameter with the VocabularyName or VocabularyFilterName (or both) sub-parameter. Type: String to LanguageIdSettings object map Map Entries: Maximum number
transcribe-api-042	transcribe-api.pdf	42	English language dialect, your custom vocabulary is applied to your transcription. If you want to include a custom language model with your request but do not want to use automatic language identiﬁcation, use instead the ModelSettings parameter with the LanguageModelName sub-parameter. If you want to include a custom vocabulary or StartTranscriptionJob API Version 2017-10-26 174 Amazon Transcribe API Reference a custom vocabulary ﬁlter (or both) with your request but do not want to use automatic language identiﬁcation, use instead the Settings parameter with the VocabularyName or VocabularyFilterName (or both) sub-parameter. Type: String to LanguageIdSettings object map Map Entries: Maximum number of 5 items. Valid Keys: af-ZA \| ar-AE \| ar-SA \| da-DK \| de-CH \| de-DE \| en-AB \| en-AU \| en-GB \| en-IE \| en-IN \| en-US \| en-WL \| es-ES \| es-US \| fa-IR \| fr-CA \| fr-FR \| he-IL \| hi-IN \| id-ID \| it-IT \| ja-JP \| ko-KR \| 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-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 \| or-IN \| pa-IN \| pl-PL \| ps-AF \| ro-RO \| rw-RW \| si-LK \| sk-SK \| sl-SI \| so-SO \| 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 \| zu-ZA Required: No LanguageOptions You can specify two or more language codes that represent the languages you think may be present in your media. Including more than ﬁve 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 include IdentifyLanguage. For more information, refer to Supported languages. To transcribe speech in Modern Standard Arabic (ar-SA)in AWS GovCloud (US) (US-West, us- gov-west-1), AWS GovCloud (US) (US-East, us-gov-east-1), in Canada (Calgary) ca-west-1 and Africa (Cape Town) af-south-1, your media ﬁle must be encoded at a sample rate of 16,000 Hz or higher. Type: Array of strings Array Members: Minimum number of 1 item. StartTranscriptionJob API Version 2017-10-26 175 Amazon Transcribe API Reference Valid Values: af-ZA \| ar-AE \| ar-SA \| da-DK \| de-CH \| de-DE \| en-AB \| en-AU \| en-GB \| en-IE \| en-IN \| en-US \| en-WL \| es-ES \| es-US \| fa-IR \| fr-CA \| fr-FR \| he-IL \| hi-IN \| id-ID \| it-IT \| ja-JP \| ko-KR \| 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-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 \| or-IN \| pa-IN \| pl-PL \| ps-AF \| ro-RO \| rw-RW \| si-LK \| sk-SK \| sl-SI \| so-SO \| 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 \| zu-ZA Required: No Media Describes the Amazon S3 location of the media ﬁle you want to use in your request. Type: Media object Required: Yes MediaFormat Specify the format of your input media ﬁle. Type: String Valid Values: mp3 \| mp4 \| wav \| flac \| ogg \| amr \| webm \| m4a Required: No MediaSampleRateHertz The sample rate, in hertz, of the audio track in your input media ﬁle. 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 specify and the value detected, your job fails. In most cases, you can omit MediaSampleRateHertz and let Amazon Transcribe determine the sample rate. Type: Integer StartTranscriptionJob API Version 2017-10-26 176 Amazon Transcribe API Reference Valid Range: Minimum value of 8000. Maximum value of 48000. Required: No ModelSettings Specify the custom
transcribe-api-043	transcribe-api.pdf	43	in hertz, of the audio track in your input media ﬁle. 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 specify and the value detected, your job fails. In most cases, you can omit MediaSampleRateHertz and let Amazon Transcribe determine the sample rate. Type: Integer StartTranscriptionJob API Version 2017-10-26 176 Amazon Transcribe API Reference Valid Range: Minimum value of 8000. Maximum value of 48000. Required: No ModelSettings 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. Type: ModelSettings object Required: No OutputBucketName The name of the Amazon S3 bucket where you want your transcription output stored. Do not include the S3:// preﬁx of the speciﬁed bucket. If you want your output to go to a sub-folder of this bucket, specify it using the OutputKey parameter; OutputBucketName only accepts the name of a bucket. For example, if you want your output stored in S3://DOC-EXAMPLE-BUCKET, set OutputBucketName to DOC-EXAMPLE-BUCKET. However, if you want your output stored in S3://DOC-EXAMPLE-BUCKET/test-files/, set OutputBucketName to DOC-EXAMPLE- BUCKET and OutputKey to test-files/. Note that Amazon Transcribe must have permission to use the speciﬁed location. You can change Amazon S3 permissions using the AWS Management Console. See also Permissions Required for IAM User Roles. If you do not specify OutputBucketName, your transcript is placed in a service-managed Amazon S3 bucket and you are provided with a URI to access your transcript. Type: String Length Constraints: Maximum length of 64. Pattern: [a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9] Required: No StartTranscriptionJob API Version 2017-10-26 177 Amazon Transcribe OutputEncryptionKMSKeyId API Reference The KMS key you want to use to encrypt your transcription output. If using a key located in the current AWS account, you can specify your KMS key in one of four ways: 1. Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. 2. Use an alias for the KMS key ID. For example, alias/ExampleAlias. 3. Use the Amazon Resource Name (ARN) for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. 4. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account- ID:alias/ExampleAlias. If using a key located in a diﬀerent AWS account than the current AWS account, you can specify your KMS key in one of two ways: 1. Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account- ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. 2. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account- ID:alias/ExampleAlias. If you do not specify an encryption key, your output is encrypted with the default Amazon S3 key (SSE-S3). If you specify a KMS key to encrypt your output, you must also specify an output location using the OutputLocation parameter. Note that the role making the StartCallAnalyticsJob request must have permission to use the speciﬁed KMS key. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$ Required: No OutputKey Use in combination with OutputBucketName to specify the output location of your transcript and, optionally, a unique name for your output ﬁle. The default name for your StartTranscriptionJob API Version 2017-10-26 178 Amazon Transcribe API Reference transcription output is the same as the name you speciﬁed for your transcription job (TranscriptionJobName). Here are some examples of how you can use OutputKey: • If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'my-transcript.json' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my- transcript.json. • If you specify 'my-ﬁrst-transcription' as the TranscriptionJobName, 'DOC-EXAMPLE- BUCKET' as the OutputBucketName, and 'my-transcript' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first- transcription.json. • If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'test-ﬁles/my- transcript.json' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE- BUCKET/test-files/my-transcript.json. • If you specify 'my-ﬁrst-transcription' as the TranscriptionJobName, 'DOC-EXAMPLE- BUCKET' as the OutputBucketName, and 'test-ﬁles/my-transcript' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/ my-first-transcription.json. If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist, one is created for you. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: [a-zA-Z0-9-_.!*'()/]{1,1024}$ Required: No Settings Specify additional optional settings in your StartTranscriptionJob request, including channel identiﬁcation, alternative transcriptions, speaker partitioning. You can use that to apply custom vocabularies and vocabulary ﬁlters. If you want to include a custom vocabulary or a custom vocabulary ﬁlter (or both) with your request but do not want to use automatic language identiﬁcation, use Settings with the VocabularyName or VocabularyFilterName (or both) sub-parameter. StartTranscriptionJob API Version 2017-10-26 179 Amazon Transcribe API Reference If you're using automatic language identiﬁcation with your request and want to include a custom language model, a custom vocabulary, or a custom vocabulary ﬁlter, use instead the LanguageIdSettings parameter with
transcribe-api-044	transcribe-api.pdf	44	settings in your StartTranscriptionJob request, including channel identiﬁcation, alternative transcriptions, speaker partitioning. You can use that to apply custom vocabularies and vocabulary ﬁlters. If you want to include a custom vocabulary or a custom vocabulary ﬁlter (or both) with your request but do not want to use automatic language identiﬁcation, use Settings with the VocabularyName or VocabularyFilterName (or both) sub-parameter. StartTranscriptionJob API Version 2017-10-26 179 Amazon Transcribe API Reference If you're using automatic language identiﬁcation with your request and want to include a custom language model, a custom vocabulary, or a custom vocabulary ﬁlter, use instead the LanguageIdSettings parameter with the LanguageModelName, VocabularyName or VocabularyFilterName sub-parameters. Type: Settings object Required: No Subtitles Produces subtitle ﬁles for your input media. You can specify WebVTT (.vtt) and SubRip (.srt) formats. Type: Subtitles object Required: No Tags 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. Type: Array of Tag objects Array Members: Minimum number of 1 item. Maximum number of 200 items. Required: No ToxicityDetection 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. Type: Array of ToxicityDetectionSettings objects Array Members: Fixed number of 1 item. Required: No StartTranscriptionJob API Version 2017-10-26 180 Amazon Transcribe TranscriptionJobName API Reference 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 ﬁle. If you want to specify a diﬀerent name for your transcription output, use the OutputKey parameter. This name is case sensitive, cannot contain spaces, and must be unique within an AWS account. If you try to create a new job with the same name as an existing job, you get a ConflictException error. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: Yes Response Syntax { "TranscriptionJob": { "CompletionTime": number, "ContentRedaction": { "PiiEntityTypes": [ "string" ], "RedactionOutput": "string", "RedactionType": "string" }, "CreationTime": number, "FailureReason": "string", "IdentifiedLanguageScore": number, "IdentifyLanguage": boolean, "IdentifyMultipleLanguages": boolean, "JobExecutionSettings": { "AllowDeferredExecution": boolean, "DataAccessRoleArn": "string" }, "LanguageCode": "string", "LanguageCodes": [ { "DurationInSeconds": number, "LanguageCode": "string" } StartTranscriptionJob API Version 2017-10-26 181 API Reference Amazon Transcribe ], "LanguageIdSettings": { "string" : { "LanguageModelName": "string", "VocabularyFilterName": "string", "VocabularyName": "string" } }, "LanguageOptions": [ "string" ], "Media": { "MediaFileUri": "string", "RedactedMediaFileUri": "string" }, "MediaFormat": "string", "MediaSampleRateHertz": number, "ModelSettings": { "LanguageModelName": "string" }, "Settings": { "ChannelIdentification": boolean, "MaxAlternatives": number, "MaxSpeakerLabels": number, "ShowAlternatives": boolean, "ShowSpeakerLabels": boolean, "VocabularyFilterMethod": "string", "VocabularyFilterName": "string", "VocabularyName": "string" }, "StartTime": number, "Subtitles": { "Formats": [ "string" ], "OutputStartIndex": number, "SubtitleFileUris": [ "string" ] }, "Tags": [ { "Key": "string", "Value": "string" } ], "ToxicityDetection": [ { "ToxicityCategories": [ "string" ] } StartTranscriptionJob API Version 2017-10-26 182 API Reference Amazon Transcribe ], "Transcript": { "RedactedTranscriptFileUri": "string", "TranscriptFileUri": "string" }, "TranscriptionJobName": "string", "TranscriptionJobStatus": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. TranscriptionJob Provides detailed information about the current transcription job, including job status and, if applicable, failure reason. Type: TranscriptionJob object Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message ﬁeld for more information. HTTP Status Code: 400 ConﬂictException A resource already exists with this name. Resource names must be unique within an AWS account. HTTP Status Code: 400 StartTranscriptionJob API Version 2017-10-26 183 Amazon Transcribe InternalFailureException API Reference There was an internal error. Check the error message, correct the issue, and try your request again. HTTP Status Code: 500 LimitExceededException You've either sent too many requests or your input ﬁle is too long. Wait before retrying your request, or use a smaller ﬁle and try your request again. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 StartTranscriptionJob API Version 2017-10-26 184 Amazon Transcribe API Reference TagResource Service: Amazon Transcribe Service Adds one or more custom tags, each in the form
transcribe-api-045	transcribe-api.pdf	45	Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 StartTranscriptionJob API Version 2017-10-26 184 Amazon Transcribe API Reference TagResource Service: Amazon Transcribe Service Adds one or more custom tags, each in the form of a key:value pair, to the speciﬁed resource. To learn more about using tags with Amazon Transcribe, refer to Tagging resources. Request Syntax { "ResourceArn": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ResourceArn 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: transcription-job, medical-transcription-job, vocabulary, medical-vocabulary, vocabulary-filter, and language-model. Type: String Length Constraints: Minimum length of 1. Maximum length of 1011. Pattern: arn:aws(-[^:]+)?:transcribe:[a-zA-Z0-9-]:[0-9]{12}:[a-zA-Z-]/ [0-9a-zA-Z._-]+ TagResource API Version 2017-10-26 185 Amazon Transcribe Required: Yes Tags API Reference Adds one or more custom tags, each in the form of a key:value pair, to the speciﬁed resource. To learn more about using tags with Amazon Transcribe, refer to Tagging resources. Type: Array of Tag objects Array Members: Minimum number of 1 item. Maximum number of 200 items. Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message ﬁeld for more information. HTTP Status Code: 400 ConﬂictException A resource already exists with this name. Resource names must be unique within an AWS account. HTTP Status Code: 400 InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again. HTTP Status Code: 500 TagResource API Version 2017-10-26 186 Amazon Transcribe LimitExceededException API Reference You've either sent too many requests or your input ﬁle is too long. Wait before retrying your request, or use a smaller ﬁle and try your request again. HTTP Status Code: 400 NotFoundException We can't ﬁnd the requested resource. Check that the speciﬁed name is correct and try your request again. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 TagResource API Version 2017-10-26 187 Amazon Transcribe API Reference UntagResource Service: Amazon Transcribe Service Removes the speciﬁed tags from the speciﬁed Amazon Transcribe resource. If you include UntagResource in your request, you must also include ResourceArn and TagKeys. Request Syntax { "ResourceArn": "string", "TagKeys": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ResourceArn 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 resource-type are: transcription-job, medical-transcription-job, vocabulary, medical-vocabulary, vocabulary-filter, and language-model. Type: String Length Constraints: Minimum length of 1. Maximum length of 1011. Pattern: arn:aws(-[^:]+)?:transcribe:[a-zA-Z0-9-]:[0-9]{12}:[a-zA-Z-]/ [0-9a-zA-Z._-]+ Required: Yes UntagResource API Version 2017-10-26 188 Amazon Transcribe TagKeys API Reference Removes the speciﬁed tag keys from the speciﬁed Amazon Transcribe resource. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 200 items. Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message ﬁeld for more information. HTTP Status Code: 400 ConﬂictException A resource already exists with this name.
transcribe-api-046	transcribe-api.pdf	46	Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message ﬁeld for more information. HTTP Status Code: 400 ConﬂictException A resource already exists with this name. Resource names must be unique within an AWS account. HTTP Status Code: 400 InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again. HTTP Status Code: 500 UntagResource API Version 2017-10-26 189 Amazon Transcribe LimitExceededException API Reference You've either sent too many requests or your input ﬁle is too long. Wait before retrying your request, or use a smaller ﬁle and try your request again. HTTP Status Code: 400 NotFoundException We can't ﬁnd the requested resource. Check that the speciﬁed name is correct and try your request again. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 UntagResource API Version 2017-10-26 190 Amazon Transcribe API Reference UpdateCallAnalyticsCategory Service: Amazon Transcribe Service Updates the speciﬁed Call Analytics category with new rules. Note that the UpdateCallAnalyticsCategory operation overwrites all existing rules contained in the speciﬁed category. You cannot append additional rules onto an existing category. To create a new category, see CreateCallAnalyticsCategory. Request Syntax { "CategoryName": "string", "InputType": "string", "Rules": [ { ... } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. CategoryName The name of the Call Analytics category you want to update. Category names are case sensitive. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: Yes InputType Choose whether you want to update a real-time or a post-call category. The input type you specify must match the input type speciﬁed 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 category. UpdateCallAnalyticsCategory API Version 2017-10-26 191 Amazon Transcribe Type: String Valid Values: REAL_TIME \| POST_CALL Required: No Rules API Reference The rules used for the updated Call Analytics category. The rules you provide in this ﬁeld replace the ones that are currently being used in the speciﬁed category. Type: Array of Rule objects Array Members: Minimum number of 1 item. Maximum number of 20 items. Required: Yes Response Syntax { "CategoryProperties": { "CategoryName": "string", "CreateTime": number, "InputType": "string", "LastUpdateTime": number, "Rules": [ { ... } ], "Tags": [ { "Key": "string", "Value": "string" } ] } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. UpdateCallAnalyticsCategory API Version 2017-10-26 192 Amazon Transcribe CategoryProperties API Reference Provides you with the properties of the Call Analytics category you speciﬁed in your UpdateCallAnalyticsCategory request. Type: CategoryProperties object Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message ﬁeld for more information. HTTP Status Code: 400 ConﬂictException A resource already exists with this name. Resource names must be unique within an AWS account. HTTP Status Code: 400 InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again. HTTP Status Code: 500 LimitExceededException You've either sent too many requests or your input ﬁle is too long. Wait before retrying your request, or use a smaller ﬁle and try your request again. HTTP Status Code: 400 NotFoundException We can't ﬁnd the requested resource. Check that the speciﬁed name is correct and try your request again. UpdateCallAnalyticsCategory API Version 2017-10-26 193 Amazon Transcribe HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET
transcribe-api-047	transcribe-api.pdf	47	request again. HTTP Status Code: 500 LimitExceededException You've either sent too many requests or your input ﬁle is too long. Wait before retrying your request, or use a smaller ﬁle and try your request again. HTTP Status Code: 400 NotFoundException We can't ﬁnd the requested resource. Check that the speciﬁed name is correct and try your request again. UpdateCallAnalyticsCategory API Version 2017-10-26 193 Amazon Transcribe HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 UpdateCallAnalyticsCategory API Version 2017-10-26 194 Amazon Transcribe API Reference UpdateMedicalVocabulary Service: Amazon Transcribe Service 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. Request Syntax { "LanguageCode": "string", "VocabularyFileUri": "string", "VocabularyName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. LanguageCode 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. Type: String Valid Values: af-ZA \| ar-AE \| ar-SA \| da-DK \| de-CH \| de-DE \| en-AB \| en-AU \| en-GB \| en-IE \| en-IN \| en-US \| en-WL \| es-ES \| es-US \| fa-IR \| fr-CA \| fr-FR \| he-IL \| hi-IN \| id-ID \| it-IT \| ja-JP \| ko-KR \| 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-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 \| or-IN \| pa-IN \| pl-PL \| ps-AF \| ro-RO \| rw-RW \| si-LK \| sk-SK \| sl-SI \| UpdateMedicalVocabulary API Version 2017-10-26 195 Amazon Transcribe API Reference so-SO \| 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 \| zu-ZA Required: Yes VocabularyFileUri The Amazon S3 location of the text ﬁle that contains your custom medical vocabulary. The URI must be located in the same AWS Region as the resource you're calling. Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. Pattern: (s3://\|http(s*)://).+ Required: Yes VocabularyName The name of the custom medical vocabulary you want to update. Custom medical vocabulary names are case sensitive. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: Yes Response Syntax { "LanguageCode": "string", "LastModifiedTime": number, "VocabularyName": "string", "VocabularyState": "string" } UpdateMedicalVocabulary API Version 2017-10-26 196 Amazon Transcribe Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. LanguageCode The language code you selected for your custom medical vocabulary. US English (en-US) is the only language supported with Amazon Transcribe Medical. Type: String Valid Values: af-ZA \| ar-AE \| ar-SA \| da-DK \| de-CH \| de-DE \| en-AB \| en-AU \| en-GB \| en-IE \| en-IN \| en-US \| en-WL \| es-ES \| es-US \| fa-IR \| fr-CA \| fr-FR \| he-IL \| hi-IN \| id-ID \| it-IT \| ja-JP \| ko-KR \| 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-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 \| or-IN \| pa-IN \| pl-PL
transcribe-api-048	transcribe-api.pdf	48	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-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 \| or-IN \| pa-IN \| pl-PL \| ps-AF \| ro-RO \| rw-RW \| si-LK \| sk-SK \| sl-SI \| so-SO \| 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 \| zu-ZA LastModiﬁedTime The date and time the speciﬁed custom medical vocabulary was last updated. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022. Type: Timestamp VocabularyName The name of the updated custom medical vocabulary. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. UpdateMedicalVocabulary API Version 2017-10-26 197 Amazon Transcribe Pattern: ^[0-9a-zA-Z._-]+ VocabularyState API Reference The processing state of your custom medical vocabulary. If the state is READY, you can use the custom vocabulary in a StartMedicalTranscriptionJob request. Type: String Valid Values: PENDING \| READY \| FAILED Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message ﬁeld for more information. HTTP Status Code: 400 ConﬂictException A resource already exists with this name. Resource names must be unique within an AWS account. HTTP Status Code: 400 InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again. HTTP Status Code: 500 LimitExceededException You've either sent too many requests or your input ﬁle is too long. Wait before retrying your request, or use a smaller ﬁle and try your request again. HTTP Status Code: 400 UpdateMedicalVocabulary API Version 2017-10-26 198 Amazon Transcribe NotFoundException API Reference We can't ﬁnd the requested resource. Check that the speciﬁed name is correct and try your request again. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 UpdateMedicalVocabulary API Version 2017-10-26 199 Amazon Transcribe API Reference UpdateVocabulary Service: Amazon Transcribe Service 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. Request Syntax { "DataAccessRoleArn": "string", "LanguageCode": "string", "Phrases": [ "string" ], "VocabularyFileUri": "string", "VocabularyName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. DataAccessRoleArn The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input ﬁles (in this case, your custom vocabulary). If the role that you specify doesn’t have the appropriate permissions to access the speciﬁed Amazon S3 location, your request fails. IAM role ARNs have the format arn:partition:iam::account:role/role-name-with- path. For example: arn:aws:iam::111122223333:role/Admin. For more information, see IAM ARNs. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso-{0,1}[a-z]{0,1}):iam::[0-9] {0,63}:role/[A-Za-z0-9:_/+=,@.-]{0,1024}$ UpdateVocabulary API Version 2017-10-26 200 Amazon Transcribe Required: No LanguageCode API Reference 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 ﬁles in the same language as the custom vocabulary. For example, if you create a custom vocabulary using US English (en-US), you can only apply this custom vocabulary to ﬁles that contain English audio. For a list of supported languages and their associated language codes, refer to the Supported languages table. Type: String Valid Values: af-ZA \| ar-AE \| ar-SA \| da-DK \| de-CH \| de-DE \| en-AB \| en-AU \| en-GB \| en-IE \| en-IN \| en-US \| en-WL \| es-ES \| es-US \| fa-IR \| fr-CA \| fr-FR \| he-IL \| hi-IN \| id-ID \| it-IT \| ja-JP \| ko-KR \| ms-MY
transcribe-api-049	transcribe-api.pdf	49	language as the custom vocabulary. For example, if you create a custom vocabulary using US English (en-US), you can only apply this custom vocabulary to ﬁles that contain English audio. For a list of supported languages and their associated language codes, refer to the Supported languages table. Type: String Valid Values: af-ZA \| ar-AE \| ar-SA \| da-DK \| de-CH \| de-DE \| en-AB \| en-AU \| en-GB \| en-IE \| en-IN \| en-US \| en-WL \| es-ES \| es-US \| fa-IR \| fr-CA \| fr-FR \| he-IL \| hi-IN \| id-ID \| it-IT \| ja-JP \| ko-KR \| 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-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 \| or-IN \| pa-IN \| pl-PL \| ps-AF \| ro-RO \| rw-RW \| si-LK \| sk-SK \| sl-SI \| so-SO \| 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 \| zu-ZA Required: Yes Phrases 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 ﬁle and upload them to an Amazon S3 bucket, then specify the location of your ﬁle using the VocabularyFileUri parameter. Note that if you include Phrases in your request, you cannot use VocabularyFileUri; you must choose one or the other. UpdateVocabulary API Version 2017-10-26 201 Amazon Transcribe API Reference Each language has a character set that contains all allowed characters for that speciﬁc language. If you use unsupported characters, your custom vocabulary ﬁlter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language. Type: Array of strings Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: .+ Required: No VocabularyFileUri The Amazon S3 location of the text ﬁle that contains your custom vocabulary. The URI must be located in the same AWS 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 request, you cannot use the Phrases ﬂag; you must choose one or the other. Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. Pattern: (s3://\|http(s*)://).+ Required: No VocabularyName The name of the custom vocabulary you want to update. Custom vocabulary names are case sensitive. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: Yes UpdateVocabulary API Version 2017-10-26 202 API Reference Amazon Transcribe Response Syntax { "LanguageCode": "string", "LastModifiedTime": number, "VocabularyName": "string", "VocabularyState": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. LanguageCode The language code you selected for your custom vocabulary. Type: String Valid Values: af-ZA \| ar-AE \| ar-SA \| da-DK \| de-CH \| de-DE \| en-AB \| en-AU \| en-GB \| en-IE \| en-IN \| en-US \| en-WL \| es-ES \| es-US \| fa-IR \| fr-CA \| fr-FR \| he-IL \| hi-IN \| id-ID \| it-IT \| ja-JP \| ko-KR \| 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-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 \| or-IN \| pa-IN \| pl-PL \| ps-AF \| ro-RO \| rw-RW \| si-LK \| sk-SK \| sl-SI \| so-SO \| 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 \| zu-ZA LastModiﬁedTime The date and time the speciﬁed custom vocabulary was last updated. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00
transcribe-api-050	transcribe-api.pdf	50	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 \| or-IN \| pa-IN \| pl-PL \| ps-AF \| ro-RO \| rw-RW \| si-LK \| sk-SK \| sl-SI \| so-SO \| 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 \| zu-ZA LastModiﬁedTime The date and time the speciﬁed custom vocabulary was last updated. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022. UpdateVocabulary API Version 2017-10-26 203 API Reference Amazon Transcribe Type: Timestamp VocabularyName The name of the updated custom vocabulary. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ VocabularyState The processing state of your custom vocabulary. If the state is READY, you can use the custom vocabulary in a StartTranscriptionJob request. Type: String Valid Values: PENDING \| READY \| FAILED Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message ﬁeld for more information. HTTP Status Code: 400 ConﬂictException A resource already exists with this name. Resource names must be unique within an AWS account. HTTP Status Code: 400 InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again. UpdateVocabulary API Version 2017-10-26 204 Amazon Transcribe HTTP Status Code: 500 LimitExceededException API Reference You've either sent too many requests or your input ﬁle is too long. Wait before retrying your request, or use a smaller ﬁle and try your request again. HTTP Status Code: 400 NotFoundException We can't ﬁnd the requested resource. Check that the speciﬁed name is correct and try your request again. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 UpdateVocabulary API Version 2017-10-26 205 Amazon Transcribe API Reference UpdateVocabularyFilter Service: Amazon Transcribe Service Updates an existing custom vocabulary ﬁlter 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 ﬁlter. Request Syntax { "DataAccessRoleArn": "string", "VocabularyFilterFileUri": "string", "VocabularyFilterName": "string", "Words": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. DataAccessRoleArn The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input ﬁles (in this case, your custom vocabulary ﬁlter). If the role that you specify doesn’t have the appropriate permissions to access the speciﬁed Amazon S3 location, your request fails. IAM role ARNs have the format arn:partition:iam::account:role/role-name-with- path. For example: arn:aws:iam::111122223333:role/Admin. For more information, see IAM ARNs. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso-{0,1}[a-z]{0,1}):iam::[0-9] {0,63}:role/[A-Za-z0-9:_/+=,@.-]{0,1024}$ Required: No UpdateVocabularyFilter API Version 2017-10-26 206 Amazon Transcribe VocabularyFilterFileUri API Reference The Amazon S3 location of the text ﬁle that contains your custom vocabulary ﬁlter terms. The URI must be located in the same AWS 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 VocabularyFilterFileUri in your request, you cannot use Words; you must choose one or the other. Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. Pattern: (s3://\|http(s*)://).+ Required: No VocabularyFilterName The name of the custom vocabulary ﬁlter you want to update. Custom vocabulary ﬁlter names are case sensitive. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: Yes Words Use this parameter if you want to update your custom vocabulary ﬁlter by including all desired terms, as comma-separated values, within your request. The other option for updating your vocabulary ﬁlter is to save your entries in a text ﬁle and upload them to an Amazon S3 bucket, then specify the location of your ﬁle using the VocabularyFilterFileUri parameter. Note that if you include Words in your request, you cannot use VocabularyFilterFileUri; you must choose one or the other. Each language has a character set that contains all allowed characters for that speciﬁc language. If you
transcribe-api-051	transcribe-api.pdf	51	^[0-9a-zA-Z._-]+ Required: Yes Words Use this parameter if you want to update your custom vocabulary ﬁlter by including all desired terms, as comma-separated values, within your request. The other option for updating your vocabulary ﬁlter is to save your entries in a text ﬁle and upload them to an Amazon S3 bucket, then specify the location of your ﬁle using the VocabularyFilterFileUri parameter. Note that if you include Words in your request, you cannot use VocabularyFilterFileUri; you must choose one or the other. Each language has a character set that contains all allowed characters for that speciﬁc language. If you use unsupported characters, your custom vocabulary ﬁlter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language. UpdateVocabularyFilter API Version 2017-10-26 207 Amazon Transcribe Type: Array of strings API Reference Array Members: Minimum number of 1 item. Length Constraints: Minimum length of 1. Maximum length of 256. Required: No Response Syntax { "LanguageCode": "string", "LastModifiedTime": number, "VocabularyFilterName": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. LanguageCode The language code you selected for your custom vocabulary ﬁlter. Type: String Valid Values: af-ZA \| ar-AE \| ar-SA \| da-DK \| de-CH \| de-DE \| en-AB \| en-AU \| en-GB \| en-IE \| en-IN \| en-US \| en-WL \| es-ES \| es-US \| fa-IR \| fr-CA \| fr-FR \| he-IL \| hi-IN \| id-ID \| it-IT \| ja-JP \| ko-KR \| 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-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 \| or-IN \| pa-IN \| pl-PL \| ps-AF \| ro-RO \| rw-RW \| si-LK \| sk-SK \| sl-SI \| so-SO \| 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 \| zu-ZA UpdateVocabularyFilter API Version 2017-10-26 208 Amazon Transcribe LastModiﬁedTime API Reference The date and time the speciﬁed custom vocabulary ﬁlter was last updated. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022. Type: Timestamp VocabularyFilterName The name of the updated custom vocabulary ﬁlter. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message ﬁeld for more information. HTTP Status Code: 400 InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again. HTTP Status Code: 500 LimitExceededException You've either sent too many requests or your input ﬁle is too long. Wait before retrying your request, or use a smaller ﬁle and try your request again. HTTP Status Code: 400 UpdateVocabularyFilter API Version 2017-10-26 209 Amazon Transcribe NotFoundException API Reference We can't ﬁnd the requested resource. Check that the speciﬁed name is correct and try your request again. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Amazon Transcribe Streaming Service The following actions are supported by Amazon Transcribe Streaming Service: • GetMedicalScribeStream • StartCallAnalyticsStreamTranscription • StartMedicalScribeStream • StartMedicalStreamTranscription • StartStreamTranscription Amazon Transcribe Streaming Service API Version 2017-10-26 210 Amazon Transcribe API Reference GetMedicalScribeStream Service: Amazon Transcribe Streaming Service Provides details about the speciﬁed AWS HealthScribe streaming session. To view the status of the streaming session, check the StreamStatus ﬁeld in the response. To get the details of post- stream analytics, including its status, check the PostStreamAnalyticsResult ﬁeld in the response. Request Syntax GET /medical-scribe-stream/SessionId HTTP/1.1 URI Request Parameters The request uses the following URI parameters. SessionId The identiﬁer
transcribe-api-052	transcribe-api.pdf	52	Streaming Service The following actions are supported by Amazon Transcribe Streaming Service: • GetMedicalScribeStream • StartCallAnalyticsStreamTranscription • StartMedicalScribeStream • StartMedicalStreamTranscription • StartStreamTranscription Amazon Transcribe Streaming Service API Version 2017-10-26 210 Amazon Transcribe API Reference GetMedicalScribeStream Service: Amazon Transcribe Streaming Service Provides details about the speciﬁed AWS HealthScribe streaming session. To view the status of the streaming session, check the StreamStatus ﬁeld in the response. To get the details of post- stream analytics, including its status, check the PostStreamAnalyticsResult ﬁeld in the response. Request Syntax GET /medical-scribe-stream/SessionId HTTP/1.1 URI Request Parameters The request uses the following URI parameters. SessionId The identiﬁer of the HealthScribe streaming session you want information about. Length Constraints: Fixed length of 36. Pattern: [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA- F0-9]{12} Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "MedicalScribeStreamDetails": { "ChannelDefinitions": [ GetMedicalScribeStream API Version 2017-10-26 211 Amazon Transcribe API Reference { "ChannelId": number, "ParticipantRole": "string" } ], "EncryptionSettings": { "KmsEncryptionContext": { "string" : "string" }, "KmsKeyId": "string" }, "LanguageCode": "string", "MediaEncoding": "string", "MediaSampleRateHertz": number, "PostStreamAnalyticsResult": { "ClinicalNoteGenerationResult": { "ClinicalNoteOutputLocation": "string", "FailureReason": "string", "Status": "string", "TranscriptOutputLocation": "string" } }, "PostStreamAnalyticsSettings": { "ClinicalNoteGenerationSettings": { "NoteTemplate": "string", "OutputBucketName": "string" } }, "ResourceAccessRoleArn": "string", "SessionId": "string", "StreamCreatedAt": number, "StreamEndedAt": number, "StreamStatus": "string", "VocabularyFilterMethod": "string", "VocabularyFilterName": "string", "VocabularyName": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. GetMedicalScribeStream API Version 2017-10-26 212 Amazon Transcribe MedicalScribeStreamDetails Provides details about a HealthScribe streaming session. Type: MedicalScribeStreamDetails object Errors API Reference For information about the errors that are common to all actions, see Common Errors. BadRequestException One or more arguments to the StartStreamTranscription, StartMedicalStreamTranscription, or StartCallAnalyticsStreamTranscription operation was not valid. For example, MediaEncoding or LanguageCode used unsupported values. Check the speciﬁed parameters and try your request again. HTTP Status Code: 400 InternalFailureException A problem occurred while processing the audio. Amazon Transcribe terminated processing. HTTP Status Code: 500 LimitExceededException Your client has exceeded one of the Amazon Transcribe limits. This is typically the audio length limit. Break your audio stream into smaller chunks and try your request again. HTTP Status Code: 429 ResourceNotFoundException The request references a resource which doesn't exist. HTTP Status Code: 404 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: GetMedicalScribeStream API Version 2017-10-26 213 API Reference Amazon Transcribe • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 GetMedicalScribeStream API Version 2017-10-26 214 Amazon Transcribe API Reference StartCallAnalyticsStreamTranscription Service: Amazon Transcribe Streaming Service Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to Amazon Transcribe and the transcription results are streamed to your application. Use this operation for Call Analytics transcriptions. The following parameters are required: • language-code • media-encoding • sample-rate For more information on streaming with Amazon Transcribe, see Transcribing streaming audio. Request Syntax POST /call-analytics-stream-transcription HTTP/1.1 x-amzn-transcribe-language-code: LanguageCode x-amzn-transcribe-sample-rate: MediaSampleRateHertz x-amzn-transcribe-media-encoding: MediaEncoding x-amzn-transcribe-vocabulary-name: VocabularyName x-amzn-transcribe-session-id: SessionId x-amzn-transcribe-vocabulary-filter-name: VocabularyFilterName x-amzn-transcribe-vocabulary-filter-method: VocabularyFilterMethod x-amzn-transcribe-language-model-name: LanguageModelName x-amzn-transcribe-enable-partial-results- stabilization: EnablePartialResultsStabilization x-amzn-transcribe-partial-results-stability: PartialResultsStability x-amzn-transcribe-content-identification-type: ContentIdentificationType x-amzn-transcribe-content-redaction-type: ContentRedactionType x-amzn-transcribe-pii-entity-types: PiiEntityTypes Content-type: application/json { "AudioEvent": { "AudioChunk": blob }, "ConfigurationEvent": { "ChannelDefinitions": [ { StartCallAnalyticsStreamTranscription API Version 2017-10-26 215 Amazon Transcribe API Reference "ChannelId": number, "ParticipantRole": "string" } ], "PostCallAnalyticsSettings": { "ContentRedactionOutput": "string", "DataAccessRoleArn": "string", "OutputEncryptionKMSKeyId": "string", "OutputLocation": "string" } } } URI Request Parameters The request uses the following URI parameters. ContentIdentiﬁcationType Labels all personally identiﬁable information (PII) identiﬁed in your transcript. Content identiﬁcation is performed at the segment level; PII speciﬁed in PiiEntityTypes is ﬂagged upon complete transcription of an audio segment. If you don't include PiiEntityTypes in your request, all PII is identiﬁed. You can’t set ContentIdentificationType and ContentRedactionType in the same request. If you set both, your request returns a BadRequestException. For more information, see Redacting or identifying personally identiﬁable information. Valid Values: PII ContentRedactionType Redacts all personally identiﬁable information (PII) identiﬁed in your transcript. Content redaction is performed at the segment level; PII speciﬁed in PiiEntityTypes is redacted upon complete transcription of an audio segment. If you don't include PiiEntityTypes in your request, all PII is redacted. You can’t set ContentRedactionType and ContentIdentificationType in the same request. If you set both, your request returns a BadRequestException. For more information, see Redacting or identifying personally identiﬁable information. StartCallAnalyticsStreamTranscription API Version 2017-10-26 216 Amazon Transcribe Valid Values: PII EnablePartialResultsStabilization API Reference Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy. For more information, see Partial-result stabilization. LanguageCode Specify
transcribe-api-053	transcribe-api.pdf	53	performed at the segment level; PII speciﬁed in PiiEntityTypes is redacted upon complete transcription of an audio segment. If you don't include PiiEntityTypes in your request, all PII is redacted. You can’t set ContentRedactionType and ContentIdentificationType in the same request. If you set both, your request returns a BadRequestException. For more information, see Redacting or identifying personally identiﬁable information. StartCallAnalyticsStreamTranscription API Version 2017-10-26 216 Amazon Transcribe Valid Values: PII EnablePartialResultsStabilization API Reference Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy. For more information, see Partial-result stabilization. LanguageCode Specify the language code that represents the language spoken in your audio. For a list of languages supported with real-time Call Analytics, refer to the Supported languages table. Valid Values: en-US \| en-GB \| es-US \| fr-CA \| fr-FR \| en-AU \| it-IT \| de-DE \| pt-BR Required: Yes LanguageModelName Specify the name of the custom language model that you want to use when processing your transcription. Note that language model names are case sensitive. The language of the speciﬁed language model must match the language code you specify in your transcription request. If the languages don't match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch. For more information, see Custom language models. Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ MediaEncoding Specify the encoding of your input audio. Supported formats are: • FLAC • OPUS-encoded audio in an Ogg container • PCM (only signed 16-bit little-endian audio formats, which does not include WAV) For more information, see Media formats. StartCallAnalyticsStreamTranscription API Version 2017-10-26 217 Amazon Transcribe API Reference Valid Values: pcm \| ogg-opus \| flac Required: Yes MediaSampleRateHertz The sample rate of the input audio (in hertz). Low-quality audio, such as telephone audio, is typically around 8,000 Hz. High-quality audio typically ranges from 16,000 Hz to 48,000 Hz. Note that the sample rate you specify must match that of your audio. Valid Range: Minimum value of 8000. Maximum value of 48000. Required: Yes PartialResultsStability Specify the level of stability to use when you enable partial results stabilization (EnablePartialResultsStabilization). Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy. For more information, see Partial-result stabilization. Valid Values: high \| medium \| low PiiEntityTypes Specify which types of personally identiﬁable information (PII) you want to redact in your transcript. You can include as many types as you'd like, or you can select ALL. Values must be comma-separated and can include: ADDRESS, BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, CREDIT_DEBIT_NUMBER, EMAIL, NAME, PHONE, PIN, SSN, or ALL. Note that if you include PiiEntityTypes in your request, you must also include ContentIdentificationType or ContentRedactionType. If you include ContentRedactionType or ContentIdentificationType in your request, but do not include PiiEntityTypes, all PII is redacted or identiﬁed. Length Constraints: Minimum length of 1. Maximum length of 300. Pattern: ^[A-Z_, ]+ StartCallAnalyticsStreamTranscription API Version 2017-10-26 218 Amazon Transcribe SessionId API Reference Specify a name for your Call Analytics transcription session. If you don't include this parameter in your request, Amazon Transcribe generates an ID and returns it in the response. Length Constraints: Fixed length of 36. Pattern: [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA- F0-9]{12} VocabularyFilterMethod Specify how you want your vocabulary ﬁlter applied to your transcript. To replace words with ***, choose mask. To delete words, choose remove. To ﬂag words without changing them, choose tag. Valid Values: remove \| mask \| tag VocabularyFilterName Specify the name of the custom vocabulary ﬁlter that you want to use when processing your transcription. Note that vocabulary ﬁlter names are case sensitive. If the language of the speciﬁed custom vocabulary ﬁlter doesn't match the language identiﬁed in your media, the vocabulary ﬁlter is not applied to your transcription. For more information, see Using vocabulary ﬁltering with unwanted words. Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ VocabularyName Specify the name of the custom vocabulary that you want to use when processing your transcription. Note that vocabulary names are case sensitive. If the language of the speciﬁed custom vocabulary doesn't match the language identiﬁed in your media, the custom vocabulary is not applied to your transcription. For more information, see Custom vocabularies. Length Constraints: Minimum length of 1. Maximum length of 200. StartCallAnalyticsStreamTranscription API Version 2017-10-26 219 Amazon Transcribe API Reference Pattern: ^[0-9a-zA-Z._-]+ Request Body The request accepts the following data in JSON format. AudioEvent A blob of audio from your application. Your audio stream consists of one or more audio events. For more information, see Event stream encoding. Type: AudioEvent object Required: No ConﬁgurationEvent Contains audio channel deﬁnitions and post-call analytics settings. Type: ConﬁgurationEvent object Required: No Response Syntax HTTP/1.1 200 x-amzn-request-id: RequestId x-amzn-transcribe-language-code: LanguageCode x-amzn-transcribe-sample-rate: MediaSampleRateHertz x-amzn-transcribe-media-encoding: MediaEncoding x-amzn-transcribe-vocabulary-name: VocabularyName x-amzn-transcribe-session-id: SessionId x-amzn-transcribe-vocabulary-filter-name: VocabularyFilterName x-amzn-transcribe-vocabulary-filter-method: VocabularyFilterMethod
transcribe-api-054	transcribe-api.pdf	54	information, see Custom vocabularies. Length Constraints: Minimum length of 1. Maximum length of 200. StartCallAnalyticsStreamTranscription API Version 2017-10-26 219 Amazon Transcribe API Reference Pattern: ^[0-9a-zA-Z._-]+ Request Body The request accepts the following data in JSON format. AudioEvent A blob of audio from your application. Your audio stream consists of one or more audio events. For more information, see Event stream encoding. Type: AudioEvent object Required: No ConﬁgurationEvent Contains audio channel deﬁnitions and post-call analytics settings. Type: ConﬁgurationEvent object Required: No Response Syntax HTTP/1.1 200 x-amzn-request-id: RequestId x-amzn-transcribe-language-code: LanguageCode x-amzn-transcribe-sample-rate: MediaSampleRateHertz x-amzn-transcribe-media-encoding: MediaEncoding x-amzn-transcribe-vocabulary-name: VocabularyName x-amzn-transcribe-session-id: SessionId x-amzn-transcribe-vocabulary-filter-name: VocabularyFilterName x-amzn-transcribe-vocabulary-filter-method: VocabularyFilterMethod x-amzn-transcribe-language-model-name: LanguageModelName x-amzn-transcribe-enable-partial-results- stabilization: EnablePartialResultsStabilization x-amzn-transcribe-partial-results-stability: PartialResultsStability x-amzn-transcribe-content-identification-type: ContentIdentificationType x-amzn-transcribe-content-redaction-type: ContentRedactionType x-amzn-transcribe-pii-entity-types: PiiEntityTypes Content-type: application/json StartCallAnalyticsStreamTranscription API Version 2017-10-26 220 Amazon Transcribe API Reference { "BadRequestException": { }, "CategoryEvent": { "MatchedCategories": [ "string" ], "MatchedDetails": { "string" : { "TimestampRanges": [ { "BeginOffsetMillis": number, "EndOffsetMillis": number } ] } } }, "ConflictException": { }, "InternalFailureException": { }, "LimitExceededException": { }, "ServiceUnavailableException": { }, "UtteranceEvent": { "BeginOffsetMillis": number, "EndOffsetMillis": number, "Entities": [ { "BeginOffsetMillis": number, "Category": "string", "Confidence": number, "Content": "string", "EndOffsetMillis": number, "Type": "string" } ], "IsPartial": boolean, "IssuesDetected": [ { "CharacterOffsets": { "Begin": number, "End": number StartCallAnalyticsStreamTranscription API Version 2017-10-26 221 API Reference Amazon Transcribe } } ], "Items": [ { "BeginOffsetMillis": number, "Confidence": number, "Content": "string", "EndOffsetMillis": number, "Stable": boolean, "Type": "string", "VocabularyFilterMatch": boolean } ], "ParticipantRole": "string", "Sentiment": "string", "Transcript": "string", "UtteranceId": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The response returns the following HTTP headers. ContentIdentiﬁcationType Shows whether content identiﬁcation was enabled for your Call Analytics transcription. Valid Values: PII ContentRedactionType Shows whether content redaction was enabled for your Call Analytics transcription. Valid Values: PII EnablePartialResultsStabilization Shows whether partial results stabilization was enabled for your Call Analytics transcription. LanguageCode Provides the language code that you speciﬁed in your Call Analytics request. StartCallAnalyticsStreamTranscription API Version 2017-10-26 222 Amazon Transcribe API Reference Valid Values: en-US \| en-GB \| es-US \| fr-CA \| fr-FR \| en-AU \| it-IT \| de-DE \| pt-BR LanguageModelName Provides the name of the custom language model that you speciﬁed in your Call Analytics request. Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ MediaEncoding Provides the media encoding you speciﬁed in your Call Analytics request. Valid Values: pcm \| ogg-opus \| flac MediaSampleRateHertz Provides the sample rate that you speciﬁed in your Call Analytics request. Valid Range: Minimum value of 8000. Maximum value of 48000. PartialResultsStability Provides the stabilization level used for your transcription. Valid Values: high \| medium \| low PiiEntityTypes Lists the PII entity types you speciﬁed in your Call Analytics request. Length Constraints: Minimum length of 1. Maximum length of 300. Pattern: ^[A-Z_, ]+ RequestId Provides the identiﬁer for your real-time Call Analytics request. SessionId Provides the identiﬁer for your Call Analytics transcription session. StartCallAnalyticsStreamTranscription API Version 2017-10-26 223 Amazon Transcribe API Reference Length Constraints: Fixed length of 36. Pattern: [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA- F0-9]{12} VocabularyFilterMethod Provides the vocabulary ﬁltering method used in your Call Analytics transcription. Valid Values: remove \| mask \| tag VocabularyFilterName Provides the name of the custom vocabulary ﬁlter that you speciﬁed in your Call Analytics request. Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ VocabularyName Provides the name of the custom vocabulary that you speciﬁed in your Call Analytics request. Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ The following data is returned in JSON format by the service. BadRequestException One or more arguments to the StartStreamTranscription, StartMedicalStreamTranscription, or StartCallAnalyticsStreamTranscription operation was not valid. For example, MediaEncoding or LanguageCode used unsupported values. Check the speciﬁed parameters and try your request again. Type: Exception HTTP Status Code: 400 CategoryEvent Provides information on matched categories that were used to generate real-time supervisor alerts. StartCallAnalyticsStreamTranscription API Version 2017-10-26 224 Amazon Transcribe Type: CategoryEvent object ConﬂictException API Reference A new stream started with the same session ID. The current stream has been terminated. Type: Exception HTTP Status Code: 409 InternalFailureException A problem occurred while processing the audio. Amazon Transcribe terminated processing. Type: Exception HTTP Status Code: 500 LimitExceededException Your client has exceeded one of the Amazon Transcribe limits. This is typically the audio length limit. Break your audio stream into smaller chunks and try your request again. Type: Exception HTTP Status Code: 429 ServiceUnavailableException The service is currently unavailable. Try your request later. Type: Exception HTTP Status Code: 503 UtteranceEvent Contains set of transcription results from one or more audio segments, along with additional information per your request parameters. This can include information relating to channel deﬁnitions, partial result stabilization, sentiment, issue detection, and other transcription- related data. Type: UtteranceEvent object Errors For information about the errors that are common to all actions, see Common Errors. StartCallAnalyticsStreamTranscription API Version 2017-10-26 225
transcribe-api-055	transcribe-api.pdf	55	the audio length limit. Break your audio stream into smaller chunks and try your request again. Type: Exception HTTP Status Code: 429 ServiceUnavailableException The service is currently unavailable. Try your request later. Type: Exception HTTP Status Code: 503 UtteranceEvent Contains set of transcription results from one or more audio segments, along with additional information per your request parameters. This can include information relating to channel deﬁnitions, partial result stabilization, sentiment, issue detection, and other transcription- related data. Type: UtteranceEvent object Errors For information about the errors that are common to all actions, see Common Errors. StartCallAnalyticsStreamTranscription API Version 2017-10-26 225 Amazon Transcribe BadRequestException API Reference One or more arguments to the StartStreamTranscription, StartMedicalStreamTranscription, or StartCallAnalyticsStreamTranscription operation was not valid. For example, MediaEncoding or LanguageCode used unsupported values. Check the speciﬁed parameters and try your request again. HTTP Status Code: 400 ConﬂictException A new stream started with the same session ID. The current stream has been terminated. HTTP Status Code: 409 InternalFailureException A problem occurred while processing the audio. Amazon Transcribe terminated processing. HTTP Status Code: 500 LimitExceededException Your client has exceeded one of the Amazon Transcribe limits. This is typically the audio length limit. Break your audio stream into smaller chunks and try your request again. HTTP Status Code: 429 ServiceUnavailableException The service is currently unavailable. Try your request later. HTTP Status Code: 503 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 StartCallAnalyticsStreamTranscription API Version 2017-10-26 226 Amazon Transcribe • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference StartCallAnalyticsStreamTranscription API Version 2017-10-26 227 Amazon Transcribe API Reference StartMedicalScribeStream Service: Amazon Transcribe Streaming Service Starts a bidirectional HTTP/2 stream, where audio is streamed to AWS HealthScribe and the transcription results are streamed to your application. When you start a stream, you ﬁrst specify the stream conﬁguration in a MedicalScribeConfigurationEvent. This event includes channel deﬁnitions, encryption settings, and post-stream analytics settings, such as the output conﬁguration for aggregated transcript and clinical note generation. These are additional streaming session conﬁgurations beyond those provided in your initial start request headers. Whether you are starting a new session or resuming an existing session, your ﬁrst event must be a MedicalScribeConfigurationEvent. After you send a MedicalScribeConfigurationEvent, you start AudioEvents and AWS HealthScribe responds with real-time transcription results. When you are ﬁnished, to start processing the results with the post-stream analytics, send a MedicalScribeSessionControlEvent with a Type of END_OF_SESSION and AWS HealthScribe starts the analytics. You can pause or resume streaming. To pause streaming, complete the input stream without sending the MedicalScribeSessionControlEvent. To resume streaming, call the StartMedicalScribeStream and specify the same SessionId you used to start the stream. The following parameters are required: • language-code • media-encoding • media-sample-rate-hertz For more information on streaming with AWS HealthScribe, see AWS HealthScribe. Request Syntax POST /medical-scribe-stream HTTP/1.1 x-amzn-transcribe-session-id: SessionId x-amzn-transcribe-language-code: LanguageCode x-amzn-transcribe-sample-rate: MediaSampleRateHertz x-amzn-transcribe-media-encoding: MediaEncoding StartMedicalScribeStream API Version 2017-10-26 228 Amazon Transcribe API Reference Content-type: application/json { "AudioEvent": { "AudioChunk": blob }, "ConfigurationEvent": { "ChannelDefinitions": [ { "ChannelId": number, "ParticipantRole": "string" } ], "EncryptionSettings": { "KmsEncryptionContext": { "string" : "string" }, "KmsKeyId": "string" }, "PostStreamAnalyticsSettings": { "ClinicalNoteGenerationSettings": { "NoteTemplate": "string", "OutputBucketName": "string" } }, "ResourceAccessRoleArn": "string", "VocabularyFilterMethod": "string", "VocabularyFilterName": "string", "VocabularyName": "string" }, "SessionControlEvent": { "Type": "string" } } URI Request Parameters The request uses the following URI parameters. LanguageCode Specify the language code for your HealthScribe streaming session. Valid Values: en-US StartMedicalScribeStream API Version 2017-10-26 229 Amazon Transcribe Required: Yes MediaEncoding Specify the encoding used for the input audio. Supported formats are: • FLAC • OPUS-encoded audio in an Ogg container API Reference • PCM (only signed 16-bit little-endian audio formats, which does not include WAV) For more information, see Media formats. Valid Values: pcm \| ogg-opus \| flac Required: Yes MediaSampleRateHertz Specify the sample rate of the input audio (in hertz). AWS HealthScribe supports a range from 16,000 Hz to 48,000 Hz. The sample rate you specify must match that of your audio. Valid Range: Minimum value of 16000. Maximum value of 48000. Required: Yes SessionId Specify an identiﬁer for your streaming session (in UUID format). If you don't include a SessionId in your request, AWS HealthScribe generates an ID and returns it in the response. Length Constraints: Fixed length of 36. Pattern: [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA- F0-9]{12} Request Body The request accepts the following data in JSON format. AudioEvent A wrapper for your audio chunks StartMedicalScribeStream API Version 2017-10-26 230 Amazon Transcribe API Reference For more information, see Event stream encoding. Type: MedicalScribeAudioEvent object Required: No ConﬁgurationEvent Specify additional
transcribe-api-056	transcribe-api.pdf	56	must match that of your audio. Valid Range: Minimum value of 16000. Maximum value of 48000. Required: Yes SessionId Specify an identiﬁer for your streaming session (in UUID format). If you don't include a SessionId in your request, AWS HealthScribe generates an ID and returns it in the response. Length Constraints: Fixed length of 36. Pattern: [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA- F0-9]{12} Request Body The request accepts the following data in JSON format. AudioEvent A wrapper for your audio chunks StartMedicalScribeStream API Version 2017-10-26 230 Amazon Transcribe API Reference For more information, see Event stream encoding. Type: MedicalScribeAudioEvent object Required: No ConﬁgurationEvent Specify additional streaming session conﬁgurations beyond those provided in your initial start request headers. For example, specify channel deﬁnitions, encryption settings, and post-stream analytics settings. Whether you are starting a new session or resuming an existing session, your ﬁrst event must be a MedicalScribeConfigurationEvent. Type: MedicalScribeConﬁgurationEvent object Required: No SessionControlEvent Specify the lifecycle of your streaming session, such as ending the session. Type: MedicalScribeSessionControlEvent object Required: No Response Syntax HTTP/1.1 200 x-amzn-transcribe-session-id: SessionId x-amzn-request-id: RequestId x-amzn-transcribe-language-code: LanguageCode x-amzn-transcribe-sample-rate: MediaSampleRateHertz x-amzn-transcribe-media-encoding: MediaEncoding Content-type: application/json { "BadRequestException": { }, "ConflictException": { }, "InternalFailureException": { StartMedicalScribeStream API Version 2017-10-26 231 API Reference Amazon Transcribe }, "LimitExceededException": { }, "ServiceUnavailableException": { }, "TranscriptEvent": { "TranscriptSegment": { "BeginAudioTime": number, "ChannelId": "string", "Content": "string", "EndAudioTime": number, "IsPartial": boolean, "Items": [ { "BeginAudioTime": number, "Confidence": number, "Content": "string", "EndAudioTime": number, "Type": "string", "VocabularyFilterMatch": boolean } ], "SegmentId": "string" } } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The response returns the following HTTP headers. LanguageCode The Language Code that you speciﬁed in your request. Same as provided in the StartMedicalScribeStreamRequest. Valid Values: en-US MediaEncoding The Media Encoding you speciﬁed in your request. Same as provided in the StartMedicalScribeStreamRequest StartMedicalScribeStream API Version 2017-10-26 232 Amazon Transcribe API Reference Valid Values: pcm \| ogg-opus \| flac MediaSampleRateHertz The sample rate (in hertz) that you speciﬁed in your request. Same as provided in the StartMedicalScribeStreamRequest Valid Range: Minimum value of 16000. Maximum value of 48000. RequestId The unique identiﬁer for your streaming request. SessionId The identiﬁer (in UUID format) for your streaming session. If you already started streaming, this is same ID as the one you speciﬁed in your initial StartMedicalScribeStreamRequest. Length Constraints: Fixed length of 36. Pattern: [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA- F0-9]{12} The following data is returned in JSON format by the service. BadRequestException One or more arguments to the StartStreamTranscription, StartMedicalStreamTranscription, or StartCallAnalyticsStreamTranscription operation was not valid. For example, MediaEncoding or LanguageCode used unsupported values. Check the speciﬁed parameters and try your request again. Type: Exception HTTP Status Code: 400 ConﬂictException A new stream started with the same session ID. The current stream has been terminated. Type: Exception HTTP Status Code: 409 StartMedicalScribeStream API Version 2017-10-26 233 Amazon Transcribe InternalFailureException API Reference A problem occurred while processing the audio. Amazon Transcribe terminated processing. Type: Exception HTTP Status Code: 500 LimitExceededException Your client has exceeded one of the Amazon Transcribe limits. This is typically the audio length limit. Break your audio stream into smaller chunks and try your request again. Type: Exception HTTP Status Code: 429 ServiceUnavailableException The service is currently unavailable. Try your request later. Type: Exception HTTP Status Code: 503 TranscriptEvent The transcript event that contains real-time transcription results. Type: MedicalScribeTranscriptEvent object Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException One or more arguments to the StartStreamTranscription, StartMedicalStreamTranscription, or StartCallAnalyticsStreamTranscription operation was not valid. For example, MediaEncoding or LanguageCode used unsupported values. Check the speciﬁed parameters and try your request again. HTTP Status Code: 400 ConﬂictException A new stream started with the same session ID. The current stream has been terminated. StartMedicalScribeStream API Version 2017-10-26 234 Amazon Transcribe HTTP Status Code: 409 InternalFailureException API Reference A problem occurred while processing the audio. Amazon Transcribe terminated processing. HTTP Status Code: 500 LimitExceededException Your client has exceeded one of the Amazon Transcribe limits. This is typically the audio length limit. Break your audio stream into smaller chunks and try your request again. HTTP Status Code: 429 ServiceUnavailableException The service is currently unavailable. Try your request later. HTTP Status Code: 503 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 StartMedicalScribeStream API Version 2017-10-26 235 Amazon Transcribe API Reference StartMedicalStreamTranscription Service: Amazon Transcribe Streaming Service Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to Amazon Transcribe Medical and the transcription
transcribe-api-057	transcribe-api.pdf	57	this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 StartMedicalScribeStream API Version 2017-10-26 235 Amazon Transcribe API Reference StartMedicalStreamTranscription Service: Amazon Transcribe Streaming Service Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to Amazon Transcribe Medical and the transcription results are streamed to your application. The following parameters are required: • language-code • media-encoding • sample-rate For more information on streaming with Amazon Transcribe Medical, see Transcribing streaming audio. Request Syntax POST /medical-stream-transcription HTTP/1.1 x-amzn-transcribe-language-code: LanguageCode x-amzn-transcribe-sample-rate: MediaSampleRateHertz x-amzn-transcribe-media-encoding: MediaEncoding x-amzn-transcribe-vocabulary-name: VocabularyName x-amzn-transcribe-specialty: Specialty x-amzn-transcribe-type: Type x-amzn-transcribe-show-speaker-label: ShowSpeakerLabel x-amzn-transcribe-session-id: SessionId x-amzn-transcribe-enable-channel-identification: EnableChannelIdentification x-amzn-transcribe-number-of-channels: NumberOfChannels x-amzn-transcribe-content-identification-type: ContentIdentificationType Content-type: application/json { "AudioEvent": { "AudioChunk": blob }, "ConfigurationEvent": { "ChannelDefinitions": [ { "ChannelId": number, "ParticipantRole": "string" } StartMedicalStreamTranscription API Version 2017-10-26 236 API Reference Amazon Transcribe ], "PostCallAnalyticsSettings": { "ContentRedactionOutput": "string", "DataAccessRoleArn": "string", "OutputEncryptionKMSKeyId": "string", "OutputLocation": "string" } } } URI Request Parameters The request uses the following URI parameters. ContentIdentiﬁcationType Labels all personal health information (PHI) identiﬁed in your transcript. Content identiﬁcation is performed at the segment level; PHI is ﬂagged upon complete transcription of an audio segment. For more information, see Identifying personal health information (PHI) in a transcription. Valid Values: PHI EnableChannelIdentiﬁcation Enables channel identiﬁcation in multi-channel audio. Channel identiﬁcation transcribes the audio on each channel independently, then appends the output for each channel into one transcript. If you have multi-channel audio and do not enable channel identiﬁcation, your audio is transcribed in a continuous manner and your transcript is not separated by channel. If you include EnableChannelIdentification in your request, you must also include NumberOfChannels. For more information, see Transcribing multi-channel audio. LanguageCode Specify the language code that represents the language spoken in your audio. StartMedicalStreamTranscription API Version 2017-10-26 237 Amazon Transcribe API Reference Important Amazon Transcribe Medical only supports US English (en-US). Valid Values: en-US \| en-GB \| es-US \| fr-CA \| fr-FR \| en-AU \| it-IT \| de-DE \| pt-BR \| ja-JP \| ko-KR \| zh-CN \| th-TH \| es-ES \| ar-SA \| pt-PT \| ca-ES \| ar-AE \| hi-IN \| zh-HK \| nl-NL \| no-NO \| sv-SE \| pl-PL \| fi-FI \| zh-TW \| en-IN \| en-IE \| en-NZ \| en-AB \| en-ZA \| en-WL \| de-CH \| af-ZA \| eu-ES \| hr-HR \| cs-CZ \| da-DK \| fa-IR \| gl-ES \| el-GR \| he-IL \| id-ID \| lv-LV \| ms-MY \| ro-RO \| ru-RU \| sr-RS \| sk-SK \| so-SO \| tl-PH \| uk-UA \| vi-VN \| zu-ZA Required: Yes MediaEncoding Specify the encoding used for the input audio. Supported formats are: • FLAC • OPUS-encoded audio in an Ogg container • PCM (only signed 16-bit little-endian audio formats, which does not include WAV) For more information, see Media formats. Valid Values: pcm \| ogg-opus \| flac Required: Yes MediaSampleRateHertz The sample rate of the input audio (in hertz). Amazon Transcribe Medical supports a range from 16,000 Hz to 48,000 Hz. Note that the sample rate you specify must match that of your audio. Valid Range: Minimum value of 8000. Maximum value of 48000. Required: Yes NumberOfChannels Specify the number of channels in your audio stream. This value must be 2, as only two channels are supported. If your audio doesn't contain multiple channels, do not include this parameter in your request. StartMedicalStreamTranscription API Version 2017-10-26 238 Amazon Transcribe API Reference If you include NumberOfChannels in your request, you must also include EnableChannelIdentification. Valid Range: Minimum value of 2. SessionId Specify a name for your transcription session. If you don't include this parameter in your request, Amazon Transcribe Medical generates an ID and returns it in the response. Length Constraints: Fixed length of 36. Pattern: [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA- F0-9]{12} ShowSpeakerLabel Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media ﬁle. For more information, see Partitioning speakers (diarization). Specialty Specify the medical specialty contained in your audio. Valid Values: PRIMARYCARE \| CARDIOLOGY \| NEUROLOGY \| ONCOLOGY \| RADIOLOGY \| UROLOGY Required: Yes Type Specify the type of input audio. For example, choose DICTATION for a provider dictating patient notes and CONVERSATION for a dialogue between a patient and a medical professional. Valid Values: CONVERSATION \| DICTATION Required: Yes VocabularyName Specify the name of the custom vocabulary that you want to use when processing your transcription. Note that vocabulary names are case sensitive. Length Constraints: Minimum length of 1. Maximum length of 200. StartMedicalStreamTranscription API Version 2017-10-26 239 Amazon Transcribe API Reference Pattern: ^[0-9a-zA-Z._-]+ Request Body The request
transcribe-api-058	transcribe-api.pdf	58	Valid Values: PRIMARYCARE \| CARDIOLOGY \| NEUROLOGY \| ONCOLOGY \| RADIOLOGY \| UROLOGY Required: Yes Type Specify the type of input audio. For example, choose DICTATION for a provider dictating patient notes and CONVERSATION for a dialogue between a patient and a medical professional. Valid Values: CONVERSATION \| DICTATION Required: Yes VocabularyName Specify the name of the custom vocabulary that you want to use when processing your transcription. Note that vocabulary names are case sensitive. Length Constraints: Minimum length of 1. Maximum length of 200. StartMedicalStreamTranscription API Version 2017-10-26 239 Amazon Transcribe API Reference Pattern: ^[0-9a-zA-Z._-]+ Request Body The request accepts the following data in JSON format. AudioEvent A blob of audio from your application. Your audio stream consists of one or more audio events. For more information, see Event stream encoding. Type: AudioEvent object Required: No ConﬁgurationEvent Contains audio channel deﬁnitions and post-call analytics settings. Type: ConﬁgurationEvent object Required: No Response Syntax HTTP/1.1 200 x-amzn-request-id: RequestId x-amzn-transcribe-language-code: LanguageCode x-amzn-transcribe-sample-rate: MediaSampleRateHertz x-amzn-transcribe-media-encoding: MediaEncoding x-amzn-transcribe-vocabulary-name: VocabularyName x-amzn-transcribe-specialty: Specialty x-amzn-transcribe-type: Type x-amzn-transcribe-show-speaker-label: ShowSpeakerLabel x-amzn-transcribe-session-id: SessionId x-amzn-transcribe-enable-channel-identification: EnableChannelIdentification x-amzn-transcribe-number-of-channels: NumberOfChannels x-amzn-transcribe-content-identification-type: ContentIdentificationType Content-type: application/json { "BadRequestException": { StartMedicalStreamTranscription API Version 2017-10-26 240 API Reference Amazon Transcribe }, "ConflictException": { }, "InternalFailureException": { }, "LimitExceededException": { }, "ServiceUnavailableException": { }, "TranscriptEvent": { "Transcript": { "Results": [ { "Alternatives": [ { "Entities": [ { "Category": "string", "Confidence": number, "Content": "string", "EndTime": number, "StartTime": number } ], "Items": [ { "Confidence": number, "Content": "string", "EndTime": number, "Speaker": "string", "StartTime": number, "Type": "string" } ], "Transcript": "string" } ], "ChannelId": "string", "EndTime": number, "IsPartial": boolean, "ResultId": "string", "StartTime": number } ] StartMedicalStreamTranscription API Version 2017-10-26 241 Amazon Transcribe } } } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The response returns the following HTTP headers. ContentIdentiﬁcationType Shows whether content identiﬁcation was enabled for your transcription. Valid Values: PHI EnableChannelIdentiﬁcation Shows whether channel identiﬁcation was enabled for your transcription. LanguageCode Provides the language code that you speciﬁed in your request. This must be en-US. Valid Values: en-US \| en-GB \| es-US \| fr-CA \| fr-FR \| en-AU \| it-IT \| de-DE \| pt-BR \| ja-JP \| ko-KR \| zh-CN \| th-TH \| es-ES \| ar-SA \| pt-PT \| ca-ES \| ar-AE \| hi-IN \| zh-HK \| nl-NL \| no-NO \| sv-SE \| pl-PL \| fi-FI \| zh-TW \| en-IN \| en-IE \| en-NZ \| en-AB \| en-ZA \| en-WL \| de-CH \| af-ZA \| eu-ES \| hr-HR \| cs-CZ \| da-DK \| fa-IR \| gl-ES \| el-GR \| he-IL \| id-ID \| lv-LV \| ms-MY \| ro-RO \| ru-RU \| sr-RS \| sk-SK \| so-SO \| tl-PH \| uk-UA \| vi-VN \| zu-ZA MediaEncoding Provides the media encoding you speciﬁed in your request. Valid Values: pcm \| ogg-opus \| flac MediaSampleRateHertz Provides the sample rate that you speciﬁed in your request. Valid Range: Minimum value of 8000. Maximum value of 48000. NumberOfChannels Provides the number of channels that you speciﬁed in your request. StartMedicalStreamTranscription API Version 2017-10-26 242 Amazon Transcribe API Reference Valid Range: Minimum value of 2. RequestId Provides the identiﬁer for your streaming request. SessionId Provides the identiﬁer for your transcription session. Length Constraints: Fixed length of 36. Pattern: [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA- F0-9]{12} ShowSpeakerLabel Shows whether speaker partitioning was enabled for your transcription. Specialty Provides the medical specialty that you speciﬁed in your request. Valid Values: PRIMARYCARE \| CARDIOLOGY \| NEUROLOGY \| ONCOLOGY \| RADIOLOGY \| UROLOGY Type Provides the type of audio you speciﬁed in your request. Valid Values: CONVERSATION \| DICTATION VocabularyName Provides the name of the custom vocabulary that you speciﬁed in your request. Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ The following data is returned in JSON format by the service. BadRequestException One or more arguments to the StartStreamTranscription, StartMedicalStreamTranscription, or StartCallAnalyticsStreamTranscription StartMedicalStreamTranscription API Version 2017-10-26 243 Amazon Transcribe API Reference operation was not valid. For example, MediaEncoding or LanguageCode used unsupported values. Check the speciﬁed parameters and try your request again. Type: Exception HTTP Status Code: 400 ConﬂictException A new stream started with the same session ID. The current stream has been terminated. Type: Exception HTTP Status Code: 409 InternalFailureException A problem occurred while processing the audio. Amazon Transcribe terminated processing. Type: Exception HTTP Status Code: 500 LimitExceededException Your client has exceeded one of the Amazon Transcribe limits. This is typically the audio length limit. Break your audio stream into smaller chunks and try your request again. Type: Exception HTTP Status Code: 429 ServiceUnavailableException The service is currently unavailable. Try your request later. Type: Exception HTTP Status Code: 503 TranscriptEvent The MedicalTranscriptEvent associated with a MedicalTranscriptResultStream. Contains a set of transcription results from one or more audio segments, along with additional information per your request parameters. This can include information relating to alternative transcriptions, channel identiﬁcation, partial result
transcribe-api-059	transcribe-api.pdf	59	Transcribe terminated processing. Type: Exception HTTP Status Code: 500 LimitExceededException Your client has exceeded one of the Amazon Transcribe limits. This is typically the audio length limit. Break your audio stream into smaller chunks and try your request again. Type: Exception HTTP Status Code: 429 ServiceUnavailableException The service is currently unavailable. Try your request later. Type: Exception HTTP Status Code: 503 TranscriptEvent The MedicalTranscriptEvent associated with a MedicalTranscriptResultStream. Contains a set of transcription results from one or more audio segments, along with additional information per your request parameters. This can include information relating to alternative transcriptions, channel identiﬁcation, partial result stabilization, language identiﬁcation, and other transcription-related data. Type: MedicalTranscriptEvent object StartMedicalStreamTranscription API Version 2017-10-26 244 Amazon Transcribe Errors API Reference For information about the errors that are common to all actions, see Common Errors. BadRequestException One or more arguments to the StartStreamTranscription, StartMedicalStreamTranscription, or StartCallAnalyticsStreamTranscription operation was not valid. For example, MediaEncoding or LanguageCode used unsupported values. Check the speciﬁed parameters and try your request again. HTTP Status Code: 400 ConﬂictException A new stream started with the same session ID. The current stream has been terminated. HTTP Status Code: 409 InternalFailureException A problem occurred while processing the audio. Amazon Transcribe terminated processing. HTTP Status Code: 500 LimitExceededException Your client has exceeded one of the Amazon Transcribe limits. This is typically the audio length limit. Break your audio stream into smaller chunks and try your request again. HTTP Status Code: 429 ServiceUnavailableException The service is currently unavailable. Try your request later. HTTP Status Code: 503 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface StartMedicalStreamTranscription API Version 2017-10-26 245 API Reference Amazon Transcribe • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 StartMedicalStreamTranscription API Version 2017-10-26 246 Amazon Transcribe API Reference StartStreamTranscription Service: Amazon Transcribe Streaming Service Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to Amazon Transcribe and the transcription results are streamed to your application. The following parameters are required: • language-code or identify-language or identify-multiple-language • media-encoding • sample-rate For more information on streaming with Amazon Transcribe, see Transcribing streaming audio. Request Syntax POST /stream-transcription HTTP/1.1 x-amzn-transcribe-language-code: LanguageCode x-amzn-transcribe-sample-rate: MediaSampleRateHertz x-amzn-transcribe-media-encoding: MediaEncoding x-amzn-transcribe-vocabulary-name: VocabularyName x-amzn-transcribe-session-id: SessionId x-amzn-transcribe-vocabulary-filter-name: VocabularyFilterName x-amzn-transcribe-vocabulary-filter-method: VocabularyFilterMethod x-amzn-transcribe-show-speaker-label: ShowSpeakerLabel x-amzn-transcribe-enable-channel-identification: EnableChannelIdentification x-amzn-transcribe-number-of-channels: NumberOfChannels x-amzn-transcribe-enable-partial-results- stabilization: EnablePartialResultsStabilization x-amzn-transcribe-partial-results-stability: PartialResultsStability x-amzn-transcribe-content-identification-type: ContentIdentificationType x-amzn-transcribe-content-redaction-type: ContentRedactionType x-amzn-transcribe-pii-entity-types: PiiEntityTypes x-amzn-transcribe-language-model-name: LanguageModelName x-amzn-transcribe-identify-language: IdentifyLanguage x-amzn-transcribe-language-options: LanguageOptions x-amzn-transcribe-preferred-language: PreferredLanguage x-amzn-transcribe-identify-multiple-languages: IdentifyMultipleLanguages x-amzn-transcribe-vocabulary-names: VocabularyNames x-amzn-transcribe-vocabulary-filter-names: VocabularyFilterNames Content-type: application/json StartStreamTranscription API Version 2017-10-26 247 Amazon Transcribe API Reference { "AudioEvent": { "AudioChunk": blob }, "ConfigurationEvent": { "ChannelDefinitions": [ { "ChannelId": number, "ParticipantRole": "string" } ], "PostCallAnalyticsSettings": { "ContentRedactionOutput": "string", "DataAccessRoleArn": "string", "OutputEncryptionKMSKeyId": "string", "OutputLocation": "string" } } } URI Request Parameters The request uses the following URI parameters. ContentIdentiﬁcationType Labels all personally identiﬁable information (PII) identiﬁed in your transcript. Content identiﬁcation is performed at the segment level; PII speciﬁed in PiiEntityTypes is ﬂagged upon complete transcription of an audio segment. If you don't include PiiEntityTypes in your request, all PII is identiﬁed. You can’t set ContentIdentificationType and ContentRedactionType in the same request. If you set both, your request returns a BadRequestException. For more information, see Redacting or identifying personally identiﬁable information. Valid Values: PII ContentRedactionType Redacts all personally identiﬁable information (PII) identiﬁed in your transcript. StartStreamTranscription API Version 2017-10-26 248 Amazon Transcribe API Reference Content redaction is performed at the segment level; PII speciﬁed in PiiEntityTypes is redacted upon complete transcription of an audio segment. If you don't include PiiEntityTypes in your request, all PII is redacted. You can’t set ContentRedactionType and ContentIdentificationType in the same request. If you set both, your request returns a BadRequestException. For more information, see Redacting or identifying personally identiﬁable information. Valid Values: PII EnableChannelIdentiﬁcation Enables channel identiﬁcation in multi-channel audio. Channel identiﬁcation transcribes the audio on each channel independently, then appends the output for each channel into one transcript. If you have multi-channel audio and do not enable channel identiﬁcation, your audio is transcribed in a continuous manner and your transcript is not separated by channel. If you include EnableChannelIdentification in your request, you must also include NumberOfChannels. For more information, see Transcribing multi-channel audio. EnablePartialResultsStabilization Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy. For more information, see Partial-result stabilization. IdentifyLanguage Enables automatic language identiﬁcation for your transcription. If you include IdentifyLanguage, you must include a list of language codes, using LanguageOptions, that you think may be present in your audio stream. You can also include a
transcribe-api-060	transcribe-api.pdf	60	identiﬁcation, your audio is transcribed in a continuous manner and your transcript is not separated by channel. If you include EnableChannelIdentification in your request, you must also include NumberOfChannels. For more information, see Transcribing multi-channel audio. EnablePartialResultsStabilization Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy. For more information, see Partial-result stabilization. IdentifyLanguage Enables automatic language identiﬁcation for your transcription. If you include IdentifyLanguage, you must include a list of language codes, using LanguageOptions, that you think may be present in your audio stream. You can also include a preferred language using PreferredLanguage. Adding a preferred language can help Amazon Transcribe identify the language faster than if you omit this parameter. StartStreamTranscription API Version 2017-10-26 249 Amazon Transcribe API Reference If you have multi-channel audio that contains diﬀerent languages on each channel, and you've enabled channel identiﬁcation, automatic language identiﬁcation identiﬁes the dominant language on each audio channel. Note that you must include either LanguageCode or IdentifyLanguage or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails. Streaming language identiﬁcation can't be combined with custom language models or redaction. IdentifyMultipleLanguages Enables automatic multi-language identiﬁcation in your transcription job request. Use this parameter if your stream contains more than one language. If your stream contains only one language, use IdentifyLanguage instead. If you include IdentifyMultipleLanguages, you must include a list of language codes, using LanguageOptions, that you think may be present in your stream. If you want to apply a custom vocabulary or a custom vocabulary ﬁlter to your automatic multiple language identiﬁcation request, include VocabularyNames or VocabularyFilterNames. Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails. LanguageCode Specify the language code that represents the language spoken in your audio. If you're unsure of the language spoken in your audio, consider using IdentifyLanguage to enable automatic language identiﬁcation. For a list of languages supported with Amazon Transcribe streaming, refer to the Supported languages table. Valid Values: en-US \| en-GB \| es-US \| fr-CA \| fr-FR \| en-AU \| it-IT \| de-DE \| pt-BR \| ja-JP \| ko-KR \| zh-CN \| th-TH \| es-ES \| ar-SA \| pt-PT \| ca-ES \| ar-AE \| hi-IN \| zh-HK \| nl-NL \| no-NO \| sv-SE \| pl-PL \| fi-FI \| zh-TW StartStreamTranscription API Version 2017-10-26 250 Amazon Transcribe API Reference \| en-IN \| en-IE \| en-NZ \| en-AB \| en-ZA \| en-WL \| de-CH \| af-ZA \| eu-ES \| hr-HR \| cs-CZ \| da-DK \| fa-IR \| gl-ES \| el-GR \| he-IL \| id-ID \| lv-LV \| ms-MY \| ro-RO \| ru-RU \| sr-RS \| sk-SK \| so-SO \| tl-PH \| uk-UA \| vi-VN \| zu-ZA LanguageModelName Specify the name of the custom language model that you want to use when processing your transcription. Note that language model names are case sensitive. The language of the speciﬁed language model must match the language code you specify in your transcription request. If the languages don't match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch. For more information, see Custom language models. Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ LanguageOptions Specify two or more language codes that represent the languages you think may be present in your media; including more than ﬁve is not recommended. Including language options can improve the accuracy of language identiﬁcation. If you include LanguageOptions in your request, you must also include IdentifyLanguage or IdentifyMultipleLanguages. For a list of languages supported with Amazon Transcribe streaming, refer to the Supported languages table. Important You can only include one language dialect per language per stream. For example, you cannot include en-US and en-AU in the same request. Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[a-zA-Z-,]+ StartStreamTranscription API Version 2017-10-26 251 Amazon Transcribe MediaEncoding API Reference Specify the encoding of your input audio. Supported formats are: • FLAC • OPUS-encoded audio in an Ogg container • PCM (only signed 16-bit little-endian audio formats, which does not include WAV) For more information, see Media formats. Valid Values: pcm \| ogg-opus \| flac Required: Yes MediaSampleRateHertz The sample rate of the input audio (in hertz). Low-quality audio, such as telephone audio, is typically around 8,000 Hz. High-quality audio typically ranges from 16,000 Hz to 48,000 Hz. Note that the sample rate you specify must match that of your audio. Valid Range: Minimum value of 8000. Maximum value of 48000. Required: Yes NumberOfChannels Specify the number of channels in your audio stream. This value must be 2, as only two channels are supported. If your audio doesn't contain multiple channels, do not include this
transcribe-api-061	transcribe-api.pdf	61	see Media formats. Valid Values: pcm \| ogg-opus \| flac Required: Yes MediaSampleRateHertz The sample rate of the input audio (in hertz). Low-quality audio, such as telephone audio, is typically around 8,000 Hz. High-quality audio typically ranges from 16,000 Hz to 48,000 Hz. Note that the sample rate you specify must match that of your audio. Valid Range: Minimum value of 8000. Maximum value of 48000. Required: Yes NumberOfChannels Specify the number of channels in your audio stream. This value must be 2, as only two channels are supported. If your audio doesn't contain multiple channels, do not include this parameter in your request. If you include NumberOfChannels in your request, you must also include EnableChannelIdentification. Valid Range: Minimum value of 2. PartialResultsStability Specify the level of stability to use when you enable partial results stabilization (EnablePartialResultsStabilization). Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy. For more information, see Partial-result stabilization. StartStreamTranscription API Version 2017-10-26 252 Amazon Transcribe API Reference Valid Values: high \| medium \| low PiiEntityTypes Specify which types of personally identiﬁable information (PII) you want to redact in your transcript. You can include as many types as you'd like, or you can select ALL. Values must be comma-separated and can include: ADDRESS, BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, CREDIT_DEBIT_NUMBER, EMAIL, NAME, PHONE, PIN, SSN, or ALL. Note that if you include PiiEntityTypes in your request, you must also include ContentIdentificationType or ContentRedactionType. If you include ContentRedactionType or ContentIdentificationType in your request, but do not include PiiEntityTypes, all PII is redacted or identiﬁed. Length Constraints: Minimum length of 1. Maximum length of 300. Pattern: ^[A-Z_, ]+ PreferredLanguage Specify a preferred language from the subset of languages codes you speciﬁed in LanguageOptions. You can only use this parameter if you've included IdentifyLanguage and LanguageOptions in your request. Valid Values: en-US \| en-GB \| es-US \| fr-CA \| fr-FR \| en-AU \| it-IT \| de-DE \| pt-BR \| ja-JP \| ko-KR \| zh-CN \| th-TH \| es-ES \| ar-SA \| pt-PT \| ca-ES \| ar-AE \| hi-IN \| zh-HK \| nl-NL \| no-NO \| sv-SE \| pl-PL \| fi-FI \| zh-TW \| en-IN \| en-IE \| en-NZ \| en-AB \| en-ZA \| en-WL \| de-CH \| af-ZA \| eu-ES \| hr-HR \| cs-CZ \| da-DK \| fa-IR \| gl-ES \| el-GR \| he-IL \| id-ID \| lv-LV \| ms-MY \| ro-RO \| ru-RU \| sr-RS \| sk-SK \| so-SO \| tl-PH \| uk-UA \| vi-VN \| zu-ZA SessionId Specify a name for your transcription session. If you don't include this parameter in your request, Amazon Transcribe generates an ID and returns it in the response. Length Constraints: Fixed length of 36. StartStreamTranscription API Version 2017-10-26 253 Amazon Transcribe API Reference Pattern: [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA- F0-9]{12} ShowSpeakerLabel Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media ﬁle. For more information, see Partitioning speakers (diarization). VocabularyFilterMethod Specify how you want your vocabulary ﬁlter applied to your transcript. To replace words with ***, choose mask. To delete words, choose remove. To ﬂag words without changing them, choose tag. Valid Values: remove \| mask \| tag VocabularyFilterName Specify the name of the custom vocabulary ﬁlter that you want to use when processing your transcription. Note that vocabulary ﬁlter names are case sensitive. If the language of the speciﬁed custom vocabulary ﬁlter doesn't match the language identiﬁed in your media, the vocabulary ﬁlter is not applied to your transcription. Important This parameter is not intended for use with the IdentifyLanguage parameter. If you're including IdentifyLanguage in your request and want to use one or more vocabulary ﬁlters with your transcription, use the VocabularyFilterNames parameter instead. For more information, see Using vocabulary ﬁltering with unwanted words. Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ StartStreamTranscription API Version 2017-10-26 254 Amazon Transcribe VocabularyFilterNames API Reference Specify the names of the custom vocabulary ﬁlters that you want to use when processing your transcription. Note that vocabulary ﬁlter names are case sensitive. If none of the languages of the speciﬁed custom vocabulary ﬁlters match the language identiﬁed in your media, your job fails. Important This parameter is only intended for use with the IdentifyLanguage parameter. If you're not including IdentifyLanguage in your request and want to use a custom vocabulary ﬁlter with your transcription, use the VocabularyFilterName parameter instead. For more information, see Using vocabulary ﬁltering with unwanted words. Length Constraints: Minimum length of 1. Maximum length of 3000. Pattern: ^[a-zA-Z0-9,-._]+ VocabularyName Specify the name of the custom vocabulary that you want to use when processing your transcription. Note that vocabulary names are case sensitive. If the language of the speciﬁed custom vocabulary doesn't match the language identiﬁed in your media, the custom vocabulary is not applied to your transcription. Important This
transcribe-api-062	transcribe-api.pdf	62	the IdentifyLanguage parameter. If you're not including IdentifyLanguage in your request and want to use a custom vocabulary ﬁlter with your transcription, use the VocabularyFilterName parameter instead. For more information, see Using vocabulary ﬁltering with unwanted words. Length Constraints: Minimum length of 1. Maximum length of 3000. Pattern: ^[a-zA-Z0-9,-._]+ VocabularyName Specify the name of the custom vocabulary that you want to use when processing your transcription. Note that vocabulary names are case sensitive. If the language of the speciﬁed custom vocabulary doesn't match the language identiﬁed in your media, the custom vocabulary is not applied to your transcription. Important This parameter is not intended for use with the IdentifyLanguage parameter. If you're including IdentifyLanguage in your request and want to use one or more custom vocabularies with your transcription, use the VocabularyNames parameter instead. For more information, see Custom vocabularies. Length Constraints: Minimum length of 1. Maximum length of 200. StartStreamTranscription API Version 2017-10-26 255 Amazon Transcribe Pattern: ^[0-9a-zA-Z._-]+ VocabularyNames API Reference Specify the names of the custom vocabularies that you want to use when processing your transcription. Note that vocabulary names are case sensitive. If none of the languages of the speciﬁed custom vocabularies match the language identiﬁed in your media, your job fails. Important This parameter is only intended for use with the IdentifyLanguage parameter. If you're not including IdentifyLanguage in your request and want to use a custom vocabulary with your transcription, use the VocabularyName parameter instead. For more information, see Custom vocabularies. Length Constraints: Minimum length of 1. Maximum length of 3000. Pattern: ^[a-zA-Z0-9,-._]+ Request Body The request accepts the following data in JSON format. AudioEvent A blob of audio from your application. Your audio stream consists of one or more audio events. For more information, see Event stream encoding. Type: AudioEvent object Required: No ConﬁgurationEvent Contains audio channel deﬁnitions and post-call analytics settings. Type: ConﬁgurationEvent object Required: No StartStreamTranscription API Version 2017-10-26 256 Amazon Transcribe Response Syntax API Reference HTTP/1.1 200 x-amzn-request-id: RequestId x-amzn-transcribe-language-code: LanguageCode x-amzn-transcribe-sample-rate: MediaSampleRateHertz x-amzn-transcribe-media-encoding: MediaEncoding x-amzn-transcribe-vocabulary-name: VocabularyName x-amzn-transcribe-session-id: SessionId x-amzn-transcribe-vocabulary-filter-name: VocabularyFilterName x-amzn-transcribe-vocabulary-filter-method: VocabularyFilterMethod x-amzn-transcribe-show-speaker-label: ShowSpeakerLabel x-amzn-transcribe-enable-channel-identification: EnableChannelIdentification x-amzn-transcribe-number-of-channels: NumberOfChannels x-amzn-transcribe-enable-partial-results- stabilization: EnablePartialResultsStabilization x-amzn-transcribe-partial-results-stability: PartialResultsStability x-amzn-transcribe-content-identification-type: ContentIdentificationType x-amzn-transcribe-content-redaction-type: ContentRedactionType x-amzn-transcribe-pii-entity-types: PiiEntityTypes x-amzn-transcribe-language-model-name: LanguageModelName x-amzn-transcribe-identify-language: IdentifyLanguage x-amzn-transcribe-language-options: LanguageOptions x-amzn-transcribe-preferred-language: PreferredLanguage x-amzn-transcribe-identify-multiple-languages: IdentifyMultipleLanguages x-amzn-transcribe-vocabulary-names: VocabularyNames x-amzn-transcribe-vocabulary-filter-names: VocabularyFilterNames Content-type: application/json { "BadRequestException": { }, "ConflictException": { }, "InternalFailureException": { }, "LimitExceededException": { }, "ServiceUnavailableException": { }, "TranscriptEvent": { "Transcript": { "Results": [ StartStreamTranscription API Version 2017-10-26 257 API Reference Amazon Transcribe { "Alternatives": [ { "Entities": [ { "Category": "string", "Confidence": number, "Content": "string", "EndTime": number, "StartTime": number, "Type": "string" } ], "Items": [ { "Confidence": number, "Content": "string", "EndTime": number, "Speaker": "string", "Stable": boolean, "StartTime": number, "Type": "string", "VocabularyFilterMatch": boolean } ], "Transcript": "string" } ], "ChannelId": "string", "EndTime": number, "IsPartial": boolean, "LanguageCode": "string", "LanguageIdentification": [ { "LanguageCode": "string", "Score": number } ], "ResultId": "string", "StartTime": number } ] } } StartStreamTranscription API Version 2017-10-26 258 Amazon Transcribe } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The response returns the following HTTP headers. ContentIdentiﬁcationType Shows whether content identiﬁcation was enabled for your transcription. Valid Values: PII ContentRedactionType Shows whether content redaction was enabled for your transcription. Valid Values: PII EnableChannelIdentiﬁcation Shows whether channel identiﬁcation was enabled for your transcription. EnablePartialResultsStabilization Shows whether partial results stabilization was enabled for your transcription. IdentifyLanguage Shows whether automatic language identiﬁcation was enabled for your transcription. IdentifyMultipleLanguages Shows whether automatic multi-language identiﬁcation was enabled for your transcription. LanguageCode Provides the language code that you speciﬁed in your request. Valid Values: en-US \| en-GB \| es-US \| fr-CA \| fr-FR \| en-AU \| it-IT \| de-DE \| pt-BR \| ja-JP \| ko-KR \| zh-CN \| th-TH \| es-ES \| ar-SA \| pt-PT \| ca-ES \| ar-AE \| hi-IN \| zh-HK \| nl-NL \| no-NO \| sv-SE \| pl-PL \| fi-FI \| zh-TW \| en-IN \| en-IE \| en-NZ \| en-AB \| en-ZA \| en-WL \| de-CH \| af-ZA \| eu-ES \| hr-HR \| cs-CZ \| da-DK \| fa-IR \| gl-ES \| el-GR \| he-IL \| id-ID \| lv-LV StartStreamTranscription API Version 2017-10-26 259 Amazon Transcribe API Reference \| ms-MY \| ro-RO \| ru-RU \| sr-RS \| sk-SK \| so-SO \| tl-PH \| uk-UA \| vi-VN \| zu-ZA LanguageModelName Provides the name of the custom language model that you speciﬁed in your request. Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ LanguageOptions Provides the language codes that you speciﬁed in your request. Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[a-zA-Z-,]+ MediaEncoding Provides the media encoding you speciﬁed in your request. Valid Values: pcm \| ogg-opus \| flac MediaSampleRateHertz Provides the sample rate that you speciﬁed in your request. Valid Range: Minimum value of 8000. Maximum value of 48000. NumberOfChannels Provides the number of
transcribe-api-063	transcribe-api.pdf	63	tl-PH \| uk-UA \| vi-VN \| zu-ZA LanguageModelName Provides the name of the custom language model that you speciﬁed in your request. Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ LanguageOptions Provides the language codes that you speciﬁed in your request. Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[a-zA-Z-,]+ MediaEncoding Provides the media encoding you speciﬁed in your request. Valid Values: pcm \| ogg-opus \| flac MediaSampleRateHertz Provides the sample rate that you speciﬁed in your request. Valid Range: Minimum value of 8000. Maximum value of 48000. NumberOfChannels Provides the number of channels that you speciﬁed in your request. Valid Range: Minimum value of 2. PartialResultsStability Provides the stabilization level used for your transcription. Valid Values: high \| medium \| low PiiEntityTypes Lists the PII entity types you speciﬁed in your request. StartStreamTranscription API Version 2017-10-26 260 Amazon Transcribe API Reference Length Constraints: Minimum length of 1. Maximum length of 300. Pattern: ^[A-Z_, ]+ PreferredLanguage Provides the preferred language that you speciﬁed in your request. Valid Values: en-US \| en-GB \| es-US \| fr-CA \| fr-FR \| en-AU \| it-IT \| de-DE \| pt-BR \| ja-JP \| ko-KR \| zh-CN \| th-TH \| es-ES \| ar-SA \| pt-PT \| ca-ES \| ar-AE \| hi-IN \| zh-HK \| nl-NL \| no-NO \| sv-SE \| pl-PL \| fi-FI \| zh-TW \| en-IN \| en-IE \| en-NZ \| en-AB \| en-ZA \| en-WL \| de-CH \| af-ZA \| eu-ES \| hr-HR \| cs-CZ \| da-DK \| fa-IR \| gl-ES \| el-GR \| he-IL \| id-ID \| lv-LV \| ms-MY \| ro-RO \| ru-RU \| sr-RS \| sk-SK \| so-SO \| tl-PH \| uk-UA \| vi-VN \| zu-ZA RequestId Provides the identiﬁer for your streaming request. SessionId Provides the identiﬁer for your transcription session. Length Constraints: Fixed length of 36. Pattern: [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA- F0-9]{12} ShowSpeakerLabel Shows whether speaker partitioning was enabled for your transcription. VocabularyFilterMethod Provides the vocabulary ﬁltering method used in your transcription. Valid Values: remove \| mask \| tag VocabularyFilterName Provides the name of the custom vocabulary ﬁlter that you speciﬁed in your request. Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ StartStreamTranscription API Version 2017-10-26 261 Amazon Transcribe VocabularyFilterNames API Reference Provides the names of the custom vocabulary ﬁlters that you speciﬁed in your request. Length Constraints: Minimum length of 1. Maximum length of 3000. Pattern: ^[a-zA-Z0-9,-._]+ VocabularyName Provides the name of the custom vocabulary that you speciﬁed in your request. Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ VocabularyNames Provides the names of the custom vocabularies that you speciﬁed in your request. Length Constraints: Minimum length of 1. Maximum length of 3000. Pattern: ^[a-zA-Z0-9,-._]+ The following data is returned in JSON format by the service. BadRequestException A client error occurred when the stream was created. Check the parameters of the request and try your request again. Type: Exception HTTP Status Code: 400 ConﬂictException A new stream started with the same session ID. The current stream has been terminated. Type: Exception HTTP Status Code: 409 InternalFailureException A problem occurred while processing the audio. Amazon Transcribe terminated processing. StartStreamTranscription API Version 2017-10-26 262 Amazon Transcribe Type: Exception HTTP Status Code: 500 LimitExceededException API Reference Your client has exceeded one of the Amazon Transcribe limits. This is typically the audio length limit. Break your audio stream into smaller chunks and try your request again. Type: Exception HTTP Status Code: 429 ServiceUnavailableException The service is currently unavailable. Try your request later. Type: Exception HTTP Status Code: 503 TranscriptEvent Contains Transcript, which contains Results. The Result object contains a set of transcription results from one or more audio segments, along with additional information per your request parameters. Type: TranscriptEvent object Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException One or more arguments to the StartStreamTranscription, StartMedicalStreamTranscription, or StartCallAnalyticsStreamTranscription operation was not valid. For example, MediaEncoding or LanguageCode used unsupported values. Check the speciﬁed parameters and try your request again. HTTP Status Code: 400 ConﬂictException A new stream started with the same session ID. The current stream has been terminated. HTTP Status Code: 409 StartStreamTranscription API Version 2017-10-26 263 Amazon Transcribe InternalFailureException API Reference A problem occurred while processing the audio. Amazon Transcribe terminated processing. HTTP Status Code: 500 LimitExceededException Your client has exceeded one of the Amazon Transcribe limits. This is typically the audio length limit. Break your audio stream into smaller chunks and try your request again. HTTP Status Code: 429 ServiceUnavailableException The service is currently unavailable. Try your request later. HTTP Status Code: 503 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS
transcribe-api-064	transcribe-api.pdf	64	Reference A problem occurred while processing the audio. Amazon Transcribe terminated processing. HTTP Status Code: 500 LimitExceededException Your client has exceeded one of the Amazon Transcribe limits. This is typically the audio length limit. Break your audio stream into smaller chunks and try your request again. HTTP Status Code: 429 ServiceUnavailableException The service is currently unavailable. Try your request later. HTTP Status Code: 503 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 StartStreamTranscription API Version 2017-10-26 264 Amazon Transcribe Data Types The following data types are supported by Amazon Transcribe Service: API Reference • AbsoluteTimeRange • CallAnalyticsJob • CallAnalyticsJobDetails • CallAnalyticsJobSettings • CallAnalyticsJobSummary • CallAnalyticsSkippedFeature • CategoryProperties • ChannelDeﬁnition • ClinicalNoteGenerationSettings • ContentRedaction • InputDataConﬁg • InterruptionFilter • JobExecutionSettings • LanguageCodeItem • LanguageIdSettings • LanguageModel • Media • MedicalScribeChannelDeﬁnition • MedicalScribeJob • MedicalScribeJobSummary • MedicalScribeOutput • MedicalScribeSettings • MedicalTranscript • MedicalTranscriptionJob • MedicalTranscriptionJobSummary • MedicalTranscriptionSetting • ModelSettings API Version 2017-10-26 265 API Reference Amazon Transcribe • NonTalkTimeFilter • RelativeTimeRange • Rule • SentimentFilter • Settings • Subtitles • SubtitlesOutput • Summarization • Tag • ToxicityDetectionSettings • Transcript • TranscriptFilter • TranscriptionJob • TranscriptionJobSummary • VocabularyFilterInfo • VocabularyInfo The following data types are supported by Amazon Transcribe Streaming Service: • Alternative • AudioEvent • AudioStream • CallAnalyticsEntity • CallAnalyticsItem • CallAnalyticsTranscriptResultStream • CategoryEvent • ChannelDeﬁnition • CharacterOﬀsets • ClinicalNoteGenerationResult • ClinicalNoteGenerationSettings • ConﬁgurationEvent API Version 2017-10-26 266 Amazon Transcribe • Entity • IssueDetected • Item • LanguageWithScore • MedicalAlternative • MedicalEntity • MedicalItem • MedicalResult • MedicalScribeAudioEvent • MedicalScribeChannelDeﬁnition • MedicalScribeConﬁgurationEvent • MedicalScribeEncryptionSettings • MedicalScribeInputStream • MedicalScribePostStreamAnalyticsResult • MedicalScribePostStreamAnalyticsSettings • MedicalScribeResultStream • MedicalScribeSessionControlEvent • MedicalScribeStreamDetails • MedicalScribeTranscriptEvent • MedicalScribeTranscriptItem • MedicalScribeTranscriptSegment • MedicalTranscript • MedicalTranscriptEvent • MedicalTranscriptResultStream • PointsOfInterest • PostCallAnalyticsSettings • Result • TimestampRange • Transcript • TranscriptEvent API Reference API Version 2017-10-26 267 Amazon Transcribe • TranscriptResultStream • UtteranceEvent API Reference Amazon Transcribe Service The following data types are supported by Amazon Transcribe Service: • AbsoluteTimeRange • CallAnalyticsJob • CallAnalyticsJobDetails • CallAnalyticsJobSettings • CallAnalyticsJobSummary • CallAnalyticsSkippedFeature • CategoryProperties • ChannelDeﬁnition • ClinicalNoteGenerationSettings • ContentRedaction • InputDataConﬁg • InterruptionFilter • JobExecutionSettings • LanguageCodeItem • LanguageIdSettings • LanguageModel • Media • MedicalScribeChannelDeﬁnition • MedicalScribeJob • MedicalScribeJobSummary • MedicalScribeOutput • MedicalScribeSettings • MedicalTranscript • MedicalTranscriptionJob Amazon Transcribe Service API Version 2017-10-26 268 Amazon Transcribe API Reference • MedicalTranscriptionJobSummary • MedicalTranscriptionSetting • ModelSettings • NonTalkTimeFilter • RelativeTimeRange • Rule • SentimentFilter • Settings • Subtitles • SubtitlesOutput • Summarization • Tag • ToxicityDetectionSettings • Transcript • TranscriptFilter • TranscriptionJob • TranscriptionJobSummary • VocabularyFilterInfo • VocabularyInfo Amazon Transcribe Service API Version 2017-10-26 269 Amazon Transcribe API Reference AbsoluteTimeRange Service: Amazon Transcribe Service A time range, in milliseconds, between two points in your media ﬁle. You can use StartTime and EndTime to search a custom segment. For example, setting StartTime to 10000 and EndTime to 50000 only searches for your speciﬁed criteria in the audio contained between the 10,000 millisecond mark and the 50,000 millisecond mark of your media ﬁle. You must use StartTime and EndTime as a set; that is, if you include one, you must include both. You can use also First to search from the start of the audio until the time that you specify, or Last to search from the time that you specify until the end of the audio. For example, setting First to 50000 only searches for your speciﬁed criteria in the audio contained between the start of the media ﬁle to the 50,000 millisecond mark. You can use First and Last independently of each other. If you prefer to use percentage instead of milliseconds, see RelativeTimeRange. Contents EndTime The time, in milliseconds, when Amazon Transcribe stops searching for the speciﬁed criteria in your audio. If you include EndTime in your request, you must also include StartTime. Type: Long Valid Range: Minimum value of 0. Maximum value of 14400000. Required: No First The time, in milliseconds, from the start of your media ﬁle until the speciﬁed value. Amazon Transcribe searches for your speciﬁed criteria in this time segment. Type: Long Valid Range: Minimum value of 0. Maximum value of 14400000. Required: No AbsoluteTimeRange API Version 2017-10-26 270 Amazon Transcribe Last API Reference The time, in milliseconds, from the speciﬁed value until the end of your media ﬁle. Amazon Transcribe searches for your speciﬁed criteria in this time segment. Type: Long Valid Range: Minimum value of 0. Maximum value of 14400000. Required: No StartTime The time, in milliseconds, when Amazon Transcribe starts searching for
transcribe-api-065	transcribe-api.pdf	65	time, in milliseconds, from the start of your media ﬁle until the speciﬁed value. Amazon Transcribe searches for your speciﬁed criteria in this time segment. Type: Long Valid Range: Minimum value of 0. Maximum value of 14400000. Required: No AbsoluteTimeRange API Version 2017-10-26 270 Amazon Transcribe Last API Reference The time, in milliseconds, from the speciﬁed value until the end of your media ﬁle. Amazon Transcribe searches for your speciﬁed criteria in this time segment. Type: Long Valid Range: Minimum value of 0. Maximum value of 14400000. Required: No StartTime The time, in milliseconds, when Amazon Transcribe starts searching for the speciﬁed criteria in your audio. If you include StartTime in your request, you must also include EndTime. Type: Long Valid Range: Minimum value of 0. Maximum value of 14400000. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 AbsoluteTimeRange API Version 2017-10-26 271 Amazon Transcribe API Reference CallAnalyticsJob Service: Amazon Transcribe Service Provides detailed information about a Call Analytics job. To view the job's status, refer to CallAnalyticsJobStatus. If the status is COMPLETED, the job is ﬁnished. You can ﬁnd your completed transcript at the URI speciﬁed in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed. If you enabled personally identiﬁable information (PII) redaction, the redacted transcript appears at the location speciﬁed in RedactedTranscriptFileUri. If you chose to redact the audio in your media ﬁle, you can ﬁnd your redacted media ﬁle at the location speciﬁed in the RedactedMediaFileUri ﬁeld of your response. Contents CallAnalyticsJobDetails Provides detailed information about a call analytics job, including information about skipped analytics features. Type: CallAnalyticsJobDetails object Required: No CallAnalyticsJobName The name of the Call Analytics job. Job names are case sensitive and must be unique within an AWS account. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: No CallAnalyticsJobStatus Provides the status of the speciﬁed Call Analytics job. CallAnalyticsJob API Version 2017-10-26 272 Amazon Transcribe API Reference If the status is COMPLETED, the job is ﬁnished and you can ﬁnd the results at the location speciﬁed in TranscriptFileUri (or RedactedTranscriptFileUri, if you requested transcript redaction). If the status is FAILED, FailureReason provides details on why your transcription job failed. Type: String Valid Values: QUEUED \| IN_PROGRESS \| FAILED \| COMPLETED Required: No ChannelDeﬁnitions Indicates which speaker is on which channel. Type: Array of ChannelDeﬁnition objects Array Members: Fixed number of 2 items. Required: No CompletionTime The date and time the speciﬁed Call Analytics job ﬁnished processing. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022. Type: Timestamp Required: No CreationTime The date and time the speciﬁed Call Analytics job request was made. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022. Type: Timestamp Required: No CallAnalyticsJob API Version 2017-10-26 273 Amazon Transcribe DataAccessRoleArn API Reference The Amazon Resource Name (ARN) you included in your request. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso-{0,1}[a-z]{0,1}):iam::[0-9] {0,63}:role/[A-Za-z0-9:_/+=,@.-]{0,1024}$ Required: No FailureReason If CallAnalyticsJobStatus is FAILED, FailureReason contains information about why the Call Analytics job request failed. The FailureReason ﬁeld contains one of the following values: • Unsupported media format. The media format speciﬁed in MediaFormat isn't valid. Refer to refer to the MediaFormat parameter for a list of supported formats. • The media format provided does not match the detected media format. The media format speciﬁed in MediaFormat doesn't match the format of the input ﬁle. Check the media format of your media ﬁle and correct the speciﬁed value. • Invalid sample rate for audio file. The sample rate speciﬁed in MediaSampleRateHertz isn't valid. The sample rate must be between 8,000 and 48,000 hertz. • The sample rate provided does not match the detected sample rate. The sample rate speciﬁed in MediaSampleRateHertz doesn't match the sample rate detected in your input media ﬁle. Check the sample rate of your media ﬁle and correct the speciﬁed value. • Invalid file size: file size too large. The size of your media ﬁle is larger than what Amazon Transcribe can process. For more information, refer to Service quotas. CallAnalyticsJob API Version 2017-10-26 274 Amazon Transcribe API Reference • Invalid number of channels: number of channels too large. Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Service quotas. Type: String Required: No IdentiﬁedLanguageScore The conﬁdence score associated with the language identiﬁed in your media ﬁle. Conﬁdence scores are values between 0 and 1;
transcribe-api-066	transcribe-api.pdf	66	your media ﬁle and correct the speciﬁed value. • Invalid file size: file size too large. The size of your media ﬁle is larger than what Amazon Transcribe can process. For more information, refer to Service quotas. CallAnalyticsJob API Version 2017-10-26 274 Amazon Transcribe API Reference • Invalid number of channels: number of channels too large. Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Service quotas. Type: String Required: No IdentiﬁedLanguageScore The conﬁdence score associated with the language identiﬁed in your media ﬁle. Conﬁdence scores are values between 0 and 1; a larger value indicates a higher probability that the identiﬁed language correctly matches the language spoken in your media. Type: Float Required: No LanguageCode The language code used to create your Call Analytics job. For a list of supported languages and their associated language codes, refer to the Supported languages table. If you do not know the language spoken in your media ﬁle, you can omit this ﬁeld and let Amazon Transcribe automatically identify the language of your media. To improve the accuracy of language identiﬁcation, you can include several language codes and Amazon Transcribe chooses the closest match for your transcription. Type: String Valid Values: af-ZA \| ar-AE \| ar-SA \| da-DK \| de-CH \| de-DE \| en-AB \| en-AU \| en-GB \| en-IE \| en-IN \| en-US \| en-WL \| es-ES \| es-US \| fa-IR \| fr-CA \| fr-FR \| he-IL \| hi-IN \| id-ID \| it-IT \| ja-JP \| ko-KR \| 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-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 \| or-IN \| pa-IN \| pl-PL \| ps-AF \| ro-RO \| rw-RW \| si-LK \| sk-SK \| sl-SI \| CallAnalyticsJob API Version 2017-10-26 275 Amazon Transcribe API Reference so-SO \| 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 \| zu-ZA Required: No Media Provides the Amazon S3 location of the media ﬁle you used in your Call Analytics request. Type: Media object Required: No MediaFormat The format of the input media ﬁle. Type: String Valid Values: mp3 \| mp4 \| wav \| flac \| ogg \| amr \| webm \| m4a Required: No MediaSampleRateHertz The sample rate, in hertz, of the audio track in your input media ﬁle. Type: Integer Valid Range: Minimum value of 8000. Maximum value of 48000. Required: No Settings Provides information on any additional settings that were included in your request. Additional settings include content redaction and language identiﬁcation settings. Type: CallAnalyticsJobSettings object Required: No StartTime The date and time the speciﬁed Call Analytics job began processing. CallAnalyticsJob API Version 2017-10-26 276 Amazon Transcribe API Reference Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022. Type: Timestamp Required: No Tags The tags, each in the form of a key:value pair, assigned to the speciﬁed call analytics job. Type: Array of Tag objects Array Members: Minimum number of 1 item. Maximum number of 200 items. Required: No Transcript Provides you with the Amazon S3 URI you can use to access your transcript. Type: Transcript object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 CallAnalyticsJob API Version 2017-10-26 277 Amazon Transcribe API Reference CallAnalyticsJobDetails Service: Amazon Transcribe Service Contains details about a call analytics job, including information about skipped analytics features. Contents Skipped Contains information about any skipped analytics features during the analysis of a call analytics job. This array lists all the analytics features that were skipped, along with their corresponding reason code and message. Type: Array of CallAnalyticsSkippedFeature objects Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 CallAnalyticsJobDetails API Version 2017-10-26 278 Amazon Transcribe API Reference CallAnalyticsJobSettings Service: Amazon Transcribe Service Provides additional optional settings for your StartCallAnalyticsJob request, including
transcribe-api-067	transcribe-api.pdf	67	Skipped Contains information about any skipped analytics features during the analysis of a call analytics job. This array lists all the analytics features that were skipped, along with their corresponding reason code and message. Type: Array of CallAnalyticsSkippedFeature objects Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 CallAnalyticsJobDetails API Version 2017-10-26 278 Amazon Transcribe API Reference CallAnalyticsJobSettings Service: Amazon Transcribe Service Provides additional optional settings for your StartCallAnalyticsJob request, including content redaction, automatic language identiﬁcation; allows you to apply custom language models, custom vocabulary ﬁlters, and custom vocabularies. Contents ContentRedaction Makes it possible to redact or ﬂag speciﬁed personally identiﬁable 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 redact. Type: ContentRedaction object Required: No LanguageIdSettings If using automatic language identiﬁcation in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary ﬁlter, include LanguageIdSettings with the relevant sub-parameters (VocabularyName, LanguageModelName, and VocabularyFilterName). LanguageIdSettings supports two to ﬁve language codes. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary ﬁlter. The language codes that you specify must match the languages of the associated custom language models, custom vocabularies, and custom vocabulary ﬁlters. It's recommended that you include LanguageOptions when using LanguageIdSettings to ensure that the correct language dialect is identiﬁed. For example, if you specify a custom vocabulary that is in en-US but Amazon Transcribe determines that the language spoken in your media is en-AU, your custom vocabulary is not applied to your transcription. If you include LanguageOptions and include en-US as the only English language dialect, your custom vocabulary is applied to your transcription. If you want to include a custom language model, custom vocabulary, or custom vocabulary ﬁlter with your request but do not want to use automatic language identiﬁcation, use CallAnalyticsJobSettings API Version 2017-10-26 279 Amazon Transcribe API Reference instead the CallAnalyticsJobSettings parameter with the LanguageModelName, VocabularyName, or VocabularyFilterName sub-parameters. For a list of languages supported with Call Analytics, refer to Supported languages and language-speciﬁc features. Type: String to LanguageIdSettings object map Map Entries: Maximum number of 5 items. Valid Keys: af-ZA \| ar-AE \| ar-SA \| da-DK \| de-CH \| de-DE \| en-AB \| en-AU \| en-GB \| en-IE \| en-IN \| en-US \| en-WL \| es-ES \| es-US \| fa-IR \| fr-CA \| fr-FR \| he-IL \| hi-IN \| id-ID \| it-IT \| ja-JP \| ko-KR \| 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-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 \| or-IN \| pa-IN \| pl-PL \| ps-AF \| ro-RO \| rw-RW \| si-LK \| sk-SK \| sl-SI \| so-SO \| 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 \| zu-ZA Required: No LanguageModelName The name of the custom language model you want to use when processing your Call Analytics job. Note that custom language model names are case sensitive. The language of the speciﬁed custom language model must match the language code that you specify in your transcription request. If the languages do not match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: No CallAnalyticsJobSettings API Version 2017-10-26 280 Amazon Transcribe LanguageOptions API Reference You can specify two or more language codes that represent the languages you think may be present in your media. Including more than ﬁve is not recommended. If you're unsure what languages are present, do not include this parameter. Including language options can improve the accuracy of language identiﬁcation. For a list of languages supported with Call Analytics, refer to the Supported languages table. To transcribe speech in Modern Standard Arabic (ar-SA) in AWS GovCloud (US) (US-West, us- gov-west-1), AWS GovCloud (US) (US-East, us-gov-east-1), Canada (Calgary) ca-west-1 and Africa (Cape Town) af-south-1, your media
transcribe-api-068	transcribe-api.pdf	68	280 Amazon Transcribe LanguageOptions API Reference You can specify two or more language codes that represent the languages you think may be present in your media. Including more than ﬁve is not recommended. If you're unsure what languages are present, do not include this parameter. Including language options can improve the accuracy of language identiﬁcation. For a list of languages supported with Call Analytics, refer to the Supported languages table. To transcribe speech in Modern Standard Arabic (ar-SA) in AWS GovCloud (US) (US-West, us- gov-west-1), AWS GovCloud (US) (US-East, us-gov-east-1), Canada (Calgary) ca-west-1 and Africa (Cape Town) af-south-1, your media ﬁle must be encoded at a sample rate of 16,000 Hz or higher. Type: Array of strings Array Members: Minimum number of 1 item. Valid Values: af-ZA \| ar-AE \| ar-SA \| da-DK \| de-CH \| de-DE \| en-AB \| en-AU \| en-GB \| en-IE \| en-IN \| en-US \| en-WL \| es-ES \| es-US \| fa-IR \| fr-CA \| fr-FR \| he-IL \| hi-IN \| id-ID \| it-IT \| ja-JP \| ko-KR \| 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-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 \| or-IN \| pa-IN \| pl-PL \| ps-AF \| ro-RO \| rw-RW \| si-LK \| sk-SK \| sl-SI \| so-SO \| 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 \| zu-ZA Required: No Summarization Contains GenerateAbstractiveSummary, which is a required parameter if you want to enable Generative call summarization in your Call Analytics request. Type: Summarization object Required: No CallAnalyticsJobSettings API Version 2017-10-26 281 Amazon Transcribe VocabularyFilterMethod API Reference Specify how you want your custom vocabulary ﬁlter applied to your transcript. To replace words with ***, choose mask. To delete words, choose remove. To ﬂag words without changing them, choose tag. Type: String Valid Values: remove \| mask \| tag Required: No VocabularyFilterName The name of the custom vocabulary ﬁlter you want to include in your Call Analytics transcription request. Custom vocabulary ﬁlter names are case sensitive. Note that if you include VocabularyFilterName in your request, you must also include VocabularyFilterMethod. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: No VocabularyName The name of the custom vocabulary you want to include in your Call Analytics transcription request. Custom vocabulary names are case sensitive. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: No CallAnalyticsJobSettings API Version 2017-10-26 282 Amazon Transcribe See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 CallAnalyticsJobSettings API Version 2017-10-26 283 Amazon Transcribe API Reference CallAnalyticsJobSummary Service: Amazon Transcribe Service Provides detailed information about a speciﬁc Call Analytics job. Contents CallAnalyticsJobDetails Provides detailed information about a call analytics job, including information about skipped analytics features. Type: CallAnalyticsJobDetails object Required: No CallAnalyticsJobName The name of the Call Analytics job. Job names are case sensitive and must be unique within an AWS account. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: No CallAnalyticsJobStatus Provides the status of your Call Analytics job. If the status is COMPLETED, the job is ﬁnished and you can ﬁnd the results at the location speciﬁed in TranscriptFileUri (or RedactedTranscriptFileUri, if you requested transcript redaction). If the status is FAILED, FailureReason provides details on why your transcription job failed. Type: String Valid Values: QUEUED \| IN_PROGRESS \| FAILED \| COMPLETED Required: No CallAnalyticsJobSummary API Version 2017-10-26 284 Amazon Transcribe CompletionTime API Reference The date and time the speciﬁed Call Analytics job ﬁnished processing. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022. Type: Timestamp Required: No CreationTime The date and time the speciﬁed Call Analytics job request was made. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022. Type: Timestamp Required: No FailureReason If CallAnalyticsJobStatus is FAILED, FailureReason contains information about why the Call Analytics
transcribe-api-069	transcribe-api.pdf	69	2017-10-26 284 Amazon Transcribe CompletionTime API Reference The date and time the speciﬁed Call Analytics job ﬁnished processing. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022. Type: Timestamp Required: No CreationTime The date and time the speciﬁed Call Analytics job request was made. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022. Type: Timestamp Required: No FailureReason If CallAnalyticsJobStatus is FAILED, FailureReason contains information about why the Call Analytics job failed. See also: Common Errors. Type: String Required: No LanguageCode The language code used to create your Call Analytics transcription. Type: String Valid Values: af-ZA \| ar-AE \| ar-SA \| da-DK \| de-CH \| de-DE \| en-AB \| en-AU \| en-GB \| en-IE \| en-IN \| en-US \| en-WL \| es-ES \| es-US \| fa-IR \| fr-CA \| fr-FR \| he-IL \| hi-IN \| id-ID \| it-IT \| ja-JP \| ko-KR \| 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- CallAnalyticsJobSummary API Version 2017-10-26 285 Amazon Transcribe API Reference BY \| bg-BG \| bn-IN \| bs-BA \| ca-ES \| ckb-IQ \| ckb-IR \| cs-CZ \| cy-WL \| el-GR \| 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 \| or-IN \| pa-IN \| pl-PL \| ps-AF \| ro-RO \| rw-RW \| si-LK \| sk-SK \| sl-SI \| so-SO \| 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 \| zu-ZA Required: No StartTime The date and time your Call Analytics job began processing. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022. Type: Timestamp Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 CallAnalyticsJobSummary API Version 2017-10-26 286 Amazon Transcribe API Reference CallAnalyticsSkippedFeature Service: Amazon Transcribe Service Represents a skipped analytics feature during the analysis of a call analytics job. The Feature ﬁeld indicates the type of analytics feature that was skipped. The Message ﬁeld contains additional information or a message explaining why the analytics feature was skipped. The ReasonCode ﬁeld provides a code indicating the reason why the analytics feature was skipped. Contents Feature Indicates the type of analytics feature that was skipped during the analysis of a call analytics job. Type: String Valid Values: GENERATIVE_SUMMARIZATION Required: No Message Contains additional information or a message explaining why a speciﬁc analytics feature was skipped during the analysis of a call analytics job. Type: String Required: No ReasonCode Provides a code indicating the reason why a speciﬁc analytics feature was skipped during the analysis of a call analytics job. Type: String Valid Values: INSUFFICIENT_CONVERSATION_CONTENT \| FAILED_SAFETY_GUIDELINES CallAnalyticsSkippedFeature API Version 2017-10-26 287 Amazon Transcribe Required: No See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 CallAnalyticsSkippedFeature API Version 2017-10-26 288 Amazon Transcribe API Reference CategoryProperties Service: Amazon Transcribe Service Provides you with the properties of the Call Analytics category you speciﬁed in your request. This includes the list of rules that deﬁne the speciﬁed category. Contents CategoryName The name of the Call Analytics category. Category names are case sensitive and must be unique within an AWS account. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: No CreateTime The date and time the speciﬁed Call Analytics category was created. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022. Type: Timestamp Required: No InputType The input type associated with the speciﬁed category. POST_CALL refers to a category that is applied to batch transcriptions; REAL_TIME refers to a category that is applied to streaming transcriptions. Type: String Valid Values: REAL_TIME \| POST_CALL Required: No CategoryProperties API Version 2017-10-26 289 Amazon Transcribe LastUpdateTime API Reference The date and time the speciﬁed Call Analytics category was last updated. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-05T12:45:32.691000-07:00 represents 12:45
transcribe-api-070	transcribe-api.pdf	70	speciﬁed Call Analytics category was created. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022. Type: Timestamp Required: No InputType The input type associated with the speciﬁed category. POST_CALL refers to a category that is applied to batch transcriptions; REAL_TIME refers to a category that is applied to streaming transcriptions. Type: String Valid Values: REAL_TIME \| POST_CALL Required: No CategoryProperties API Version 2017-10-26 289 Amazon Transcribe LastUpdateTime API Reference The date and time the speciﬁed Call Analytics category was last updated. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-05T12:45:32.691000-07:00 represents 12:45 PM UTC-7 on May 5, 2022. Type: Timestamp Required: No Rules The rules used to deﬁne a Call Analytics category. Each category can have between 1 and 20 rules. Type: Array of Rule objects Array Members: Minimum number of 1 item. Maximum number of 20 items. Required: No Tags The tags, each in the form of a key:value pair, assigned to the speciﬁed call analytics category. Type: Array of Tag objects Array Members: Minimum number of 1 item. Maximum number of 200 items. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 CategoryProperties API Version 2017-10-26 290 Amazon Transcribe API Reference ChannelDeﬁnition Service: Amazon Transcribe Service Makes it possible to specify which speaker is on which channel. For example, if your agent is the ﬁrst participant to speak, you would set ChannelId to 0 (to indicate the ﬁrst channel) and ParticipantRole to AGENT (to indicate that it's the agent speaking). Contents ChannelId Specify the audio channel you want to deﬁne. Type: Integer Valid Range: Minimum value of 0. Maximum value of 1. Required: No ParticipantRole Specify the speaker you want to deﬁne. Omitting this parameter is equivalent to specifying both participants. Type: String Valid Values: AGENT \| CUSTOMER Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ChannelDeﬁnition API Version 2017-10-26 291 Amazon Transcribe API Reference ClinicalNoteGenerationSettings Service: Amazon Transcribe Service The output conﬁguration for clinical note generation. Contents NoteTemplate Specify one of the following templates to use for the clinical note summary. The default is HISTORY_AND_PHYSICAL. • HISTORY_AND_PHYSICAL: Provides summaries for key sections of the clinical documentation. Examples of sections include Chief Complaint, History of Present Illness, Review of Systems, Past Medical History, Assessment, and Plan. • GIRPP: Provides summaries based on the patients progress toward goals. Examples of sections include Goal, Intervention, Response, Progress, and Plan. Type: String Valid Values: HISTORY_AND_PHYSICAL \| GIRPP Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ClinicalNoteGenerationSettings API Version 2017-10-26 292 Amazon Transcribe API Reference ContentRedaction Service: Amazon Transcribe Service Makes it possible to redact or ﬂag speciﬁed personally identiﬁable 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 redact. Contents RedactionOutput Specify if you want only a redacted transcript, or if you want a redacted and an unredacted transcript. When you choose redacted Amazon Transcribe creates only a redacted transcript. When you choose redacted_and_unredacted Amazon Transcribe creates a redacted and an unredacted transcript (as two separate ﬁles). Type: String Valid Values: redacted \| redacted_and_unredacted Required: Yes RedactionType Specify the category of information you want to redact; PII (personally identiﬁable information) is the only valid value. You can use PiiEntityTypes to choose which types of PII you want to redact. If you do not include PiiEntityTypes in your request, all PII is redacted. Type: String Valid Values: PII Required: Yes PiiEntityTypes Specify which types of personally identiﬁable information (PII) you want to redact in your transcript. You can include as many types as you'd like, or you can select ALL. If you do not include PiiEntityTypes in your request, all PII is redacted. ContentRedaction API Version 2017-10-26 293 Amazon Transcribe Type: Array of strings API Reference Array Members: Minimum number of 0 items. Maximum number of 11 items. Valid Values: BANK_ACCOUNT_NUMBER \| BANK_ROUTING \| CREDIT_DEBIT_NUMBER \| CREDIT_DEBIT_CVV \| CREDIT_DEBIT_EXPIRY \| PIN \| EMAIL \| ADDRESS \| NAME \| PHONE \| SSN \| ALL Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ContentRedaction
transcribe-api-071	transcribe-api.pdf	71	do not include PiiEntityTypes in your request, all PII is redacted. ContentRedaction API Version 2017-10-26 293 Amazon Transcribe Type: Array of strings API Reference Array Members: Minimum number of 0 items. Maximum number of 11 items. Valid Values: BANK_ACCOUNT_NUMBER \| BANK_ROUTING \| CREDIT_DEBIT_NUMBER \| CREDIT_DEBIT_CVV \| CREDIT_DEBIT_EXPIRY \| PIN \| EMAIL \| ADDRESS \| NAME \| PHONE \| SSN \| ALL Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ContentRedaction API Version 2017-10-26 294 Amazon Transcribe API Reference InputDataConﬁg Service: Amazon Transcribe Service 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 and DataAccessRoleArn. You can optionally include TuningDataS3Uri. Contents DataAccessRoleArn The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input ﬁles. If the role that you specify doesn’t have the appropriate permissions to access the speciﬁed Amazon S3 location, your request fails. IAM role ARNs have the format arn:partition:iam::account:role/role-name-with- path. For example: arn:aws:iam::111122223333:role/Admin. For more information, see IAM ARNs. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso-{0,1}[a-z]{0,1}):iam::[0-9] {0,63}:role/[A-Za-z0-9:_/+=,@.-]{0,1024}$ Required: Yes S3Uri The Amazon S3 location (URI) of the text ﬁles you want to use to train your custom language model. Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-model-training-data/ Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. Pattern: (s3://\|http(s)://).+ InputDataConﬁg API Version 2017-10-26 295 Amazon Transcribe Required: Yes TuningDataS3Uri API Reference The Amazon S3 location (URI) of the text ﬁles you want to use to tune your custom language model. Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-model-tuning-data/ Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. Pattern: (s3://\|http(s)://).+ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 InputDataConﬁg API Version 2017-10-26 296 Amazon Transcribe API Reference InterruptionFilter Service: Amazon Transcribe Service Flag the presence or absence of interruptions in your Call Analytics transcription output. Rules using InterruptionFilter are designed to match: • Instances where an agent interrupts a customer • Instances where a customer interrupts an agent • Either participant interrupting the other • A lack of interruptions See Rule criteria for post-call categories for usage examples. Contents AbsoluteTimeRange Makes it possible to specify a time range (in milliseconds) in your audio, during which you want to search for an interruption. See AbsoluteTimeRange for more detail. Type: AbsoluteTimeRange object Required: No Negate Set to TRUE to ﬂag speech that does not contain interruptions. Set to FALSE to ﬂag speech that contains interruptions. Type: Boolean Required: No ParticipantRole Specify the interrupter that you want to ﬂag. Omitting this parameter is equivalent to specifying both participants. Type: String Valid Values: AGENT \| CUSTOMER InterruptionFilter API Version 2017-10-26 297 Amazon Transcribe Required: No RelativeTimeRange API Reference Makes it possible to specify a time range (in percentage) in your media ﬁle, during which you want to search for an interruption. See RelativeTimeRange for more detail. Type: RelativeTimeRange object Required: No Threshold Specify the duration of the interruptions in milliseconds. For example, you can ﬂag speech that contains more than 10,000 milliseconds of interruptions. Type: Long Valid Range: Minimum value of 0. Maximum value of 14400000. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 InterruptionFilter API Version 2017-10-26 298 Amazon Transcribe API Reference JobExecutionSettings Service: Amazon Transcribe Service Makes it possible to control how your transcription job is processed. Currently, the only JobExecutionSettings modiﬁcation you can choose is enabling job queueing using the AllowDeferredExecution sub-parameter. If you include JobExecutionSettings in your request, you must also include the sub- parameters: AllowDeferredExecution and DataAccessRoleArn. Contents AllowDeferredExecution Makes it possible to enable job queuing when your concurrent request limit is exceeded. When AllowDeferredExecution is set to true, transcription job requests are placed in a queue until the number of jobs falls below the concurrent request limit. If AllowDeferredExecution is set to false and the number of transcription job requests exceed the concurrent request limit, you get a LimitExceededException error. If you include AllowDeferredExecution in your request, you must also include DataAccessRoleArn. Type: Boolean Required: No DataAccessRoleArn The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input ﬁles. If the
transcribe-api-072	transcribe-api.pdf	72	enable job queuing when your concurrent request limit is exceeded. When AllowDeferredExecution is set to true, transcription job requests are placed in a queue until the number of jobs falls below the concurrent request limit. If AllowDeferredExecution is set to false and the number of transcription job requests exceed the concurrent request limit, you get a LimitExceededException error. If you include AllowDeferredExecution in your request, you must also include DataAccessRoleArn. Type: Boolean Required: No DataAccessRoleArn The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input ﬁles. If the role that you specify doesn’t have the appropriate permissions to access the speciﬁed Amazon S3 location, your request fails. IAM role ARNs have the format arn:partition:iam::account:role/role-name-with- path. For example: arn:aws:iam::111122223333:role/Admin. For more information, see IAM ARNs. Note that if you include DataAccessRoleArn in your request, you must also include AllowDeferredExecution. Type: String JobExecutionSettings API Version 2017-10-26 299 Amazon Transcribe API Reference Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso-{0,1}[a-z]{0,1}):iam::[0-9] {0,63}:role/[A-Za-z0-9:_/+=,@.-]{0,1024}$ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 JobExecutionSettings API Version 2017-10-26 300 Amazon Transcribe API Reference LanguageCodeItem Service: Amazon Transcribe Service Provides information on the speech contained in a discreet utterance when multi-language identiﬁcation is enabled in your request. This utterance represents a block of speech consisting of one language, preceded or followed by a block of speech in a diﬀerent language. Contents DurationInSeconds Provides the total time, in seconds, each identiﬁed language is spoken in your media. Type: Float Required: No LanguageCode Provides the language code for each language identiﬁed in your media. Type: String Valid Values: af-ZA \| ar-AE \| ar-SA \| da-DK \| de-CH \| de-DE \| en-AB \| en-AU \| en-GB \| en-IE \| en-IN \| en-US \| en-WL \| es-ES \| es-US \| fa-IR \| fr-CA \| fr-FR \| he-IL \| hi-IN \| id-ID \| it-IT \| ja-JP \| ko-KR \| 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-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 \| or-IN \| pa-IN \| pl-PL \| ps-AF \| ro-RO \| rw-RW \| si-LK \| sk-SK \| sl-SI \| so-SO \| 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 \| zu-ZA Required: No LanguageCodeItem API Version 2017-10-26 301 Amazon Transcribe See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 LanguageCodeItem API Version 2017-10-26 302 Amazon Transcribe API Reference LanguageIdSettings Service: Amazon Transcribe Service If using automatic language identiﬁcation in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary ﬁlter, include LanguageIdSettings with the relevant sub-parameters (VocabularyName, LanguageModelName, and VocabularyFilterName). Note that multi-language identiﬁcation (IdentifyMultipleLanguages) doesn't support custom language models. LanguageIdSettings supports two to ﬁve language codes. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary ﬁlter. The language codes that you specify must match the languages of the associated custom language models, custom vocabularies, and custom vocabulary ﬁlters. It's recommended that you include LanguageOptions when using LanguageIdSettings to ensure that the correct language dialect is identiﬁed. For example, if you specify a custom vocabulary that is in en-US but Amazon Transcribe determines that the language spoken in your media is en-AU, your custom vocabulary is not applied to your transcription. If you include LanguageOptions and include en-US as the only English language dialect, your custom vocabulary is applied to your transcription. If you want to include a custom language model with your request but do not want to use automatic language identiﬁcation, use instead the ModelSettings parameter with the LanguageModelName sub-parameter. If you want to include a custom vocabulary or a custom vocabulary ﬁlter (or both) with your request but do not want to use automatic language identiﬁcation, use instead the Settings parameter with the VocabularyName
transcribe-api-073	transcribe-api.pdf	73	in your media is en-AU, your custom vocabulary is not applied to your transcription. If you include LanguageOptions and include en-US as the only English language dialect, your custom vocabulary is applied to your transcription. If you want to include a custom language model with your request but do not want to use automatic language identiﬁcation, use instead the ModelSettings parameter with the LanguageModelName sub-parameter. If you want to include a custom vocabulary or a custom vocabulary ﬁlter (or both) with your request but do not want to use automatic language identiﬁcation, use instead the Settings parameter with the VocabularyName or VocabularyFilterName (or both) sub-parameter. Contents LanguageModelName The name of the custom language model you want to use when processing your transcription job. Note that custom language model names are case sensitive. The language of the speciﬁed custom language model must match the language code that you specify in your transcription request. If the languages do not match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch. Type: String LanguageIdSettings API Version 2017-10-26 303 Amazon Transcribe API Reference Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: No VocabularyFilterName The name of the custom vocabulary ﬁlter you want to use when processing your transcription job. Custom vocabulary ﬁlter names are case sensitive. The language of the speciﬁed custom vocabulary ﬁlter must match the language code that you specify in your transcription request. If the languages do not match, the custom vocabulary ﬁlter isn't applied. There are no errors or warnings associated with a language mismatch. Note that if you include VocabularyFilterName in your request, you must also include VocabularyFilterMethod. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: No VocabularyName The name of the custom vocabulary you want to use when processing your transcription job. Custom vocabulary names are case sensitive. The language of the speciﬁed custom vocabulary must match the language code that you specify in your transcription request. If the languages do not match, the custom vocabulary isn't applied. There are no errors or warnings associated with a language mismatch. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: No LanguageIdSettings API Version 2017-10-26 304 Amazon Transcribe See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 LanguageIdSettings API Version 2017-10-26 305 Amazon Transcribe API Reference LanguageModel Service: Amazon Transcribe Service Provides information about a custom language model, including: • The base model name • When the model was created • The location of the ﬁles used to train the model • When the model was last modiﬁed • The name you chose for the model • The model's language • The model's processing state • Any available upgrades for the base model Contents BaseModelName The Amazon Transcribe standard language model, or base model, used to create your custom language model. Type: String Valid Values: NarrowBand \| WideBand Required: No CreateTime The date and time the speciﬁed custom language model was created. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022. Type: Timestamp Required: No LanguageModel API Version 2017-10-26 306 Amazon Transcribe FailureReason API Reference If ModelStatus is FAILED, FailureReason contains information about why the custom language model request failed. See also: Common Errors. Type: String Required: No InputDataConﬁg The Amazon S3 location of the input ﬁles used to train and tune your custom language model, in addition to the data access role ARN (Amazon Resource Name) that has permissions to access these data. Type: InputDataConﬁg object Required: No LanguageCode The language code used to create your custom language 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 associated language codes, refer to the Supported languages table. Note that US English (en-US) is the only language supported with Amazon Transcribe Medical. Type: String Valid Values: en-US \| hi-IN \| es-US \| en-GB \| en-AU \| de-DE \| ja-JP Required: No LastModiﬁedTime The date and time the speciﬁed custom language model was last modiﬁed. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022. Type: Timestamp Required: No LanguageModel API Version 2017-10-26 307 Amazon Transcribe ModelName API Reference 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 AWS account. Type: String Length Constraints: Minimum length
transcribe-api-074	transcribe-api.pdf	74	with Amazon Transcribe Medical. Type: String Valid Values: en-US \| hi-IN \| es-US \| en-GB \| en-AU \| de-DE \| ja-JP Required: No LastModiﬁedTime The date and time the speciﬁed custom language model was last modiﬁed. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022. Type: Timestamp Required: No LanguageModel API Version 2017-10-26 307 Amazon Transcribe ModelName API Reference 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 AWS account. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: No ModelStatus The status of the speciﬁed custom language model. When the status displays as COMPLETED the model is ready for use. Type: String Valid Values: IN_PROGRESS \| FAILED \| COMPLETED Required: No UpgradeAvailability Shows if a more current base model is available for use with the speciﬁed custom language model. If false, your custom language model is using the most up-to-date base model. If true, there is a newer base model available than the one your language model is using. Note that to update a base model, you must recreate the custom language model using the new base model. Base model upgrades for existing custom language models are not supported. Type: Boolean Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: LanguageModel API Version 2017-10-26 308 Amazon Transcribe • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference LanguageModel API Version 2017-10-26 309 Amazon Transcribe API Reference Media Service: Amazon Transcribe Service Describes the Amazon S3 location of the media ﬁle you want to use in your request. For information on supported media formats, refer to the MediaFormat parameter or the Media formats section in the Amazon S3 Developer Guide. Contents MediaFileUri The Amazon S3 location of the media ﬁle you want to transcribe. For example: • s3://DOC-EXAMPLE-BUCKET/my-media-file.flac • s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac Note that the Amazon S3 bucket that contains your input media must be located in the same AWS Region where you're making your transcription request. Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. Pattern: (s3://\|http(s)://).+ Required: No RedactedMediaFileUri The Amazon S3 location of the media ﬁle you want to redact. For example: • s3://DOC-EXAMPLE-BUCKET/my-media-file.flac • s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac Note that the Amazon S3 bucket that contains your input media must be located in the same AWS Region where you're making your transcription request. Important RedactedMediaFileUri produces a redacted audio ﬁle in addition to a redacted transcript. It is only supported for Call Analytics (StartCallAnalyticsJob) transcription requests. Media API Version 2017-10-26 310 Amazon Transcribe Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 2000. Pattern: (s3://\|http(s)://).+ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Media API Version 2017-10-26 311 Amazon Transcribe API Reference MedicalScribeChannelDeﬁnition Service: Amazon Transcribe Service Indicates which speaker is on which channel. The options are CLINICIAN and PATIENT Contents ChannelId Specify the audio channel you want to deﬁne. Type: Integer Valid Range: Minimum value of 0. Maximum value of 1. Required: Yes ParticipantRole Specify the participant that you want to ﬂag. The options are CLINICIAN and PATIENT Type: String Valid Values: PATIENT \| CLINICIAN Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MedicalScribeChannelDeﬁnition API Version 2017-10-26 312 Amazon Transcribe API Reference MedicalScribeJob Service: Amazon Transcribe Service Provides detailed information about a Medical Scribe job. To view the status of the speciﬁed Medical Scribe job, check the MedicalScribeJobStatus ﬁeld. If the status is COMPLETED, the job is ﬁnished and you can ﬁnd the results at the locations speciﬁed in MedicalScribeOutput. If the status is FAILED, FailureReason provides details on why your Medical Scribe job failed. Contents ChannelDeﬁnitions Makes it possible to specify which speaker is on which channel. For example, if the clinician is the ﬁrst participant to speak, you would set ChannelId of the ﬁrst ChannelDefinition in the list to 0 (to indicate the ﬁrst channel) and ParticipantRole to CLINICIAN (to indicate that it's the clinician speaking). Then you would set the ChannelId of the second ChannelDefinition in the list to 1 (to indicate the second channel) and ParticipantRole to PATIENT (to indicate that it's the patient speaking). Type: Array of MedicalScribeChannelDeﬁnition objects Array Members: Fixed number of 2 items. Required: No CompletionTime The date and time the speciﬁed Medical Scribe
transcribe-api-075	transcribe-api.pdf	75	which speaker is on which channel. For example, if the clinician is the ﬁrst participant to speak, you would set ChannelId of the ﬁrst ChannelDefinition in the list to 0 (to indicate the ﬁrst channel) and ParticipantRole to CLINICIAN (to indicate that it's the clinician speaking). Then you would set the ChannelId of the second ChannelDefinition in the list to 1 (to indicate the second channel) and ParticipantRole to PATIENT (to indicate that it's the patient speaking). Type: Array of MedicalScribeChannelDeﬁnition objects Array Members: Fixed number of 2 items. Required: No CompletionTime The date and time the speciﬁed Medical Scribe job ﬁnished processing. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job that ﬁnished processing at 12:32 PM UTC-7 on May 4, 2022. Type: Timestamp Required: No CreationTime The date and time the speciﬁed Medical Scribe job request was made. MedicalScribeJob API Version 2017-10-26 313 Amazon Transcribe API Reference Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job that started processing at 12:32 PM UTC-7 on May 4, 2022. Type: Timestamp Required: No DataAccessRoleArn The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input ﬁles, write to the output bucket, and use your AWS KMS key if supplied. If the role that you specify doesn’t have the appropriate permissions your request fails. IAM role ARNs have the format arn:partition:iam::account:role/role-name-with- path. For example: arn:aws:iam::111122223333:role/Admin. For more information, see IAM ARNs. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso-{0,1}[a-z]{0,1}):iam::[0-9] {0,63}:role/[A-Za-z0-9:_/+=,@.-]{0,1024}$ Required: No FailureReason If MedicalScribeJobStatus is FAILED, FailureReason contains information about why the transcription job failed. See also: Common Errors. Type: String Required: No LanguageCode The language code used to create your Medical Scribe job. US English (en-US) is the only supported language for Medical Scribe jobs. MedicalScribeJob API Version 2017-10-26 314 Amazon Transcribe Type: String Valid Values: en-US Required: No Media API Reference Describes the Amazon S3 location of the media ﬁle you want to use in your request. For information on supported media formats, refer to the MediaFormat parameter or the Media formats section in the Amazon S3 Developer Guide. Type: Media object Required: No MedicalScribeJobName The name of the Medical Scribe job. Job names are case sensitive and must be unique within an AWS account. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: No MedicalScribeJobStatus Provides the status of the speciﬁed Medical Scribe job. If the status is COMPLETED, the job is ﬁnished and you can ﬁnd the results at the location speciﬁed in MedicalScribeOutput If the status is FAILED, FailureReason provides details on why your Medical Scribe job failed. Type: String Valid Values: QUEUED \| IN_PROGRESS \| FAILED \| COMPLETED Required: No MedicalScribeJob API Version 2017-10-26 315 Amazon Transcribe MedicalScribeOutput API Reference The location of the output of your Medical Scribe job. ClinicalDocumentUri holds the Amazon S3 URI for the Clinical Document and TranscriptFileUri holds the Amazon S3 URI for the Transcript. Type: MedicalScribeOutput object Required: No Settings 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 and ShowSpeakerLabels must be set. If ShowSpeakerLabels is set, MaxSpeakerLabels must also be set. Use Settings to specify a vocabulary or vocabulary ﬁlter or both using VocabularyName, VocabularyFilterName. VocabularyFilterMethod must be speciﬁed if VocabularyFilterName is set. Type: MedicalScribeSettings object Required: No StartTime The date and time your Medical Scribe job began processing. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.789000-07:00 represents a Medical Scribe job that started processing at 12:32 PM UTC-7 on May 4, 2022. Type: Timestamp Required: No Tags Adds one or more custom tags, each in the form of a key:value pair, to the Medica Scribe job. To learn more about using tags with Amazon Transcribe, refer to Tagging resources. Type: Array of Tag objects MedicalScribeJob API Version 2017-10-26 316 Amazon Transcribe API Reference Array Members: Minimum number of 1 item. Maximum number of 200 items. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MedicalScribeJob API Version 2017-10-26 317 Amazon Transcribe API Reference MedicalScribeJobSummary Service: Amazon Transcribe Service Provides detailed information about a speciﬁc Medical Scribe job. Contents CompletionTime The date and time the speciﬁed Medical Scribe job ﬁnished processing. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job that ﬁnished processing at 12:32 PM UTC-7 on May 4, 2022. Type: Timestamp Required: No CreationTime The date and time
transcribe-api-076	transcribe-api.pdf	76	using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MedicalScribeJob API Version 2017-10-26 317 Amazon Transcribe API Reference MedicalScribeJobSummary Service: Amazon Transcribe Service Provides detailed information about a speciﬁc Medical Scribe job. Contents CompletionTime The date and time the speciﬁed Medical Scribe job ﬁnished processing. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job that ﬁnished processing at 12:32 PM UTC-7 on May 4, 2022. Type: Timestamp Required: No CreationTime The date and time the speciﬁed Medical Scribe job request was made. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job that started processing at 12:32 PM UTC-7 on May 4, 2022. Type: Timestamp Required: No FailureReason If MedicalScribeJobStatus is FAILED, FailureReason contains information about why the transcription job failed. See also: Common Errors. Type: String Required: No LanguageCode The language code used to create your Medical Scribe job. US English (en-US) is the only supported language for Medical Scribe jobs. MedicalScribeJobSummary API Version 2017-10-26 318 Amazon Transcribe Type: String Valid Values: en-US Required: No MedicalScribeJobName API Reference The name of the Medical Scribe job. Job names are case sensitive and must be unique within an AWS account. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: No MedicalScribeJobStatus Provides the status of the speciﬁed Medical Scribe job. If the status is COMPLETED, the job is ﬁnished and you can ﬁnd the results at the location speciﬁed in MedicalScribeOutput If the status is FAILED, FailureReason provides details on why your Medical Scribe job failed. Type: String Valid Values: QUEUED \| IN_PROGRESS \| FAILED \| COMPLETED Required: No StartTime The date and time your Medical Scribe job began processing. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.789000-07:00 represents a Medical Scribe job that started processing at 12:32 PM UTC-7 on May 4, 2022. Type: Timestamp Required: No MedicalScribeJobSummary API Version 2017-10-26 319 Amazon Transcribe See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MedicalScribeJobSummary API Version 2017-10-26 320 Amazon Transcribe API Reference MedicalScribeOutput Service: Amazon Transcribe Service The location of the output of your Medical Scribe job. ClinicalDocumentUri holds the Amazon S3 URI for the Clinical Document and TranscriptFileUri holds the Amazon S3 URI for the Transcript. Contents ClinicalDocumentUri Holds the Amazon S3 URI for the Clinical Document. Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. Pattern: (s3://\|http(s)://).+ Required: Yes TranscriptFileUri Holds the Amazon S3 URI for the Transcript. Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. Pattern: (s3://\|http(s)://).+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MedicalScribeOutput API Version 2017-10-26 321 Amazon Transcribe API Reference MedicalScribeOutput API Version 2017-10-26 322 Amazon Transcribe API Reference MedicalScribeSettings Service: Amazon Transcribe Service 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 and ShowSpeakerLabels must be set. If ShowSpeakerLabels is set, MaxSpeakerLabels must also be set. Use Settings to specify a vocabulary or vocabulary ﬁlter or both using VocabularyName, VocabularyFilterName. VocabularyFilterMethod must be speciﬁed if VocabularyFilterName is set. Contents ChannelIdentiﬁcation Enables channel identiﬁcation in multi-channel audio. Channel identiﬁcation transcribes the audio on each channel independently, then appends the output for each channel into one transcript. For more information, see Transcribing multi-channel audio. Type: Boolean Required: No ClinicalNoteGenerationSettings Specify settings for the clinical note generation. Type: ClinicalNoteGenerationSettings object Required: No MaxSpeakerLabels Specify the maximum number of speakers you want to partition in your media. Note that if your media contains more speakers than the speciﬁed number, multiple speakers are treated as a single speaker. MedicalScribeSettings API Version 2017-10-26 323 Amazon Transcribe API Reference If you specify the MaxSpeakerLabels ﬁeld, you must set the ShowSpeakerLabels ﬁeld to true. Type: Integer Valid Range: Minimum value of 2. Maximum value of 30. Required: No ShowSpeakerLabels Enables speaker partitioning (diarization) in your Medical Scribe output. Speaker partitioning labels the speech from individual speakers in your media ﬁle. If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels. For more information, see Partitioning speakers (diarization). Type: Boolean Required: No VocabularyFilterMethod Specify how you want your custom vocabulary ﬁlter applied to your transcript. To replace words with ***, choose mask. To delete words, choose remove. To
transcribe-api-077	transcribe-api.pdf	77	Reference If you specify the MaxSpeakerLabels ﬁeld, you must set the ShowSpeakerLabels ﬁeld to true. Type: Integer Valid Range: Minimum value of 2. Maximum value of 30. Required: No ShowSpeakerLabels Enables speaker partitioning (diarization) in your Medical Scribe output. Speaker partitioning labels the speech from individual speakers in your media ﬁle. If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels. For more information, see Partitioning speakers (diarization). Type: Boolean Required: No VocabularyFilterMethod Specify how you want your custom vocabulary ﬁlter applied to your transcript. To replace words with **, choose mask. To delete words, choose remove. To ﬂag words without changing them, choose tag. Type: String Valid Values: remove \| mask \| tag Required: No VocabularyFilterName The name of the custom vocabulary ﬁlter you want to include in your Medical Scribe request. Custom vocabulary ﬁlter names are case sensitive. Note that if you include VocabularyFilterName in your request, you must also include VocabularyFilterMethod. MedicalScribeSettings API Version 2017-10-26 324 Amazon Transcribe Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: No VocabularyName The name of the custom vocabulary you want to include in your Medical Scribe request. Custom vocabulary names are case sensitive. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MedicalScribeSettings API Version 2017-10-26 325 Amazon Transcribe API Reference MedicalTranscript Service: Amazon Transcribe Service Provides you with the Amazon S3 URI you can use to access your transcript. Contents TranscriptFileUri The Amazon S3 location of your transcript. You can use this URI to access or download your transcript. Note that this is the Amazon S3 location you speciﬁed in your request using the OutputBucketName parameter. Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. Pattern: (s3://\|http(s)://).+ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MedicalTranscript API Version 2017-10-26 326 Amazon Transcribe API Reference MedicalTranscriptionJob Service: Amazon Transcribe Service Provides detailed information about a medical transcription job. To view the status of the speciﬁed medical transcription job, check the TranscriptionJobStatus ﬁeld. If the status is COMPLETED, the job is ﬁnished and you can ﬁnd the results at the location speciﬁed in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed. Contents CompletionTime The date and time the speciﬁed medical transcription job ﬁnished processing. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022. Type: Timestamp Required: No ContentIdentiﬁcationType Indicates whether content identiﬁcation was enabled for your transcription request. Type: String Valid Values: PHI Required: No CreationTime The date and time the speciﬁed medical transcription job request was made. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022. Type: Timestamp Required: No MedicalTranscriptionJob API Version 2017-10-26 327 Amazon Transcribe FailureReason API Reference If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job request failed. The FailureReason ﬁeld contains one of the following values: • Unsupported media format. The media format speciﬁed in MediaFormat isn't valid. Refer to refer to the MediaFormat parameter for a list of supported formats. • The media format provided does not match the detected media format. The media format speciﬁed in MediaFormat doesn't match the format of the input ﬁle. Check the media format of your media ﬁle and correct the speciﬁed value. • Invalid sample rate for audio file. The sample rate speciﬁed in MediaSampleRateHertz isn't valid. The sample rate must be between 16,000 and 48,000 hertz. • The sample rate provided does not match the detected sample rate. The sample rate speciﬁed in MediaSampleRateHertz doesn't match the sample rate detected in your input media ﬁle. Check the sample rate of your media ﬁle and correct the speciﬁed value. • Invalid file size: file size too large. The size of your media ﬁle is larger than what Amazon Transcribe can process. For more information, refer to Service quotas. • Invalid number of channels: number of channels too large. Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Service quotas. Type: String Required: No LanguageCode The language code used to create your medical transcription job. US English (en-US) is the only supported language for medical transcriptions. MedicalTranscriptionJob API Version 2017-10-26 328 Amazon Transcribe Type: String
transcribe-api-078	transcribe-api.pdf	78	media ﬁle and correct the speciﬁed value. • Invalid file size: file size too large. The size of your media ﬁle is larger than what Amazon Transcribe can process. For more information, refer to Service quotas. • Invalid number of channels: number of channels too large. Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Service quotas. Type: String Required: No LanguageCode The language code used to create your medical transcription job. US English (en-US) is the only supported language for medical transcriptions. MedicalTranscriptionJob API Version 2017-10-26 328 Amazon Transcribe Type: String API Reference Valid Values: af-ZA \| ar-AE \| ar-SA \| da-DK \| de-CH \| de-DE \| en-AB \| en-AU \| en-GB \| en-IE \| en-IN \| en-US \| en-WL \| es-ES \| es-US \| fa-IR \| fr-CA \| fr-FR \| he-IL \| hi-IN \| id-ID \| it-IT \| ja-JP \| ko-KR \| 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-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 \| or-IN \| pa-IN \| pl-PL \| ps-AF \| ro-RO \| rw-RW \| si-LK \| sk-SK \| sl-SI \| so-SO \| 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 \| zu-ZA Required: No Media Describes the Amazon S3 location of the media ﬁle you want to use in your request. For information on supported media formats, refer to the MediaFormat parameter or the Media formats section in the Amazon S3 Developer Guide. Type: Media object Required: No MediaFormat The format of the input media ﬁle. Type: String Valid Values: mp3 \| mp4 \| wav \| flac \| ogg \| amr \| webm \| m4a Required: No MediaSampleRateHertz The sample rate, in hertz, of the audio track in your input media ﬁle. Type: Integer MedicalTranscriptionJob API Version 2017-10-26 329 Amazon Transcribe API Reference Valid Range: Minimum value of 16000. Maximum value of 48000. Required: No MedicalTranscriptionJobName The name of the medical transcription job. Job names are case sensitive and must be unique within an AWS account. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: No Settings Provides information on any additional settings that were included in your request. Additional settings include channel identiﬁcation, alternative transcriptions, speaker partitioning, custom vocabularies, and custom vocabulary ﬁlters. Type: MedicalTranscriptionSetting object Required: No Specialty Describes the medical specialty represented in your media. Type: String Valid Values: PRIMARYCARE Required: No StartTime The date and time the speciﬁed medical transcription job began processing. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022. Type: Timestamp MedicalTranscriptionJob API Version 2017-10-26 330 Amazon Transcribe Required: No Tags API Reference The tags, each in the form of a key:value pair, assigned to the speciﬁed medical transcription job. Type: Array of Tag objects Array Members: Minimum number of 1 item. Maximum number of 200 items. Required: No Transcript Provides you with the Amazon S3 URI you can use to access your transcript. Type: MedicalTranscript object Required: No TranscriptionJobStatus Provides the status of the speciﬁed medical transcription job. If the status is COMPLETED, the job is ﬁnished and you can ﬁnd the results at the location speciﬁed in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed. Type: String Valid Values: QUEUED \| IN_PROGRESS \| FAILED \| COMPLETED Required: No Type Indicates whether the input media is a dictation or a conversation, as speciﬁed in the StartMedicalTranscriptionJob request. Type: String Valid Values: CONVERSATION \| DICTATION Required: No MedicalTranscriptionJob API Version 2017-10-26 331 Amazon Transcribe See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MedicalTranscriptionJob API Version 2017-10-26 332 Amazon Transcribe API Reference MedicalTranscriptionJobSummary Service: Amazon Transcribe Service Provides detailed information about a speciﬁc medical transcription job. Contents CompletionTime The date and time the speciﬁed medical transcription job ﬁnished processing. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at 12:33 PM
transcribe-api-079	transcribe-api.pdf	79	MedicalTranscriptionJob API Version 2017-10-26 331 Amazon Transcribe See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MedicalTranscriptionJob API Version 2017-10-26 332 Amazon Transcribe API Reference MedicalTranscriptionJobSummary Service: Amazon Transcribe Service Provides detailed information about a speciﬁc medical transcription job. Contents CompletionTime The date and time the speciﬁed medical transcription job ﬁnished processing. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022. Type: Timestamp Required: No ContentIdentiﬁcationType Labels all personal health information (PHI) identiﬁed in your transcript. For more information, see Identifying personal health information (PHI) in a transcription. Type: String Valid Values: PHI Required: No CreationTime The date and time the speciﬁed medical transcription job request was made. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022. Type: Timestamp Required: No FailureReason If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job failed. See also: Common Errors. MedicalTranscriptionJobSummary API Version 2017-10-26 333 Amazon Transcribe Type: String Required: No LanguageCode API Reference The language code used to create your medical transcription. US English (en-US) is the only supported language for medical transcriptions. Type: String Valid Values: af-ZA \| ar-AE \| ar-SA \| da-DK \| de-CH \| de-DE \| en-AB \| en-AU \| en-GB \| en-IE \| en-IN \| en-US \| en-WL \| es-ES \| es-US \| fa-IR \| fr-CA \| fr-FR \| he-IL \| hi-IN \| id-ID \| it-IT \| ja-JP \| ko-KR \| 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-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 \| or-IN \| pa-IN \| pl-PL \| ps-AF \| ro-RO \| rw-RW \| si-LK \| sk-SK \| sl-SI \| so-SO \| 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 \| zu-ZA Required: No MedicalTranscriptionJobName The name of the medical transcription job. Job names are case sensitive and must be unique within an AWS account. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: No OutputLocationType Indicates where the speciﬁed medical transcription output is stored. MedicalTranscriptionJobSummary API Version 2017-10-26 334 Amazon Transcribe API Reference If the value is CUSTOMER_BUCKET, the location is the Amazon S3 bucket you speciﬁed using the OutputBucketName parameter in your StartMedicalTranscriptionJob request. If you also included OutputKey in your request, your output is located in the path you speciﬁed in your request. If the value is SERVICE_BUCKET, the location is a service-managed Amazon S3 bucket. To access a transcript stored in a service-managed bucket, use the URI shown in the TranscriptFileUri ﬁeld. Type: String Valid Values: CUSTOMER_BUCKET \| SERVICE_BUCKET Required: No Specialty Provides the medical specialty represented in your media. Type: String Valid Values: PRIMARYCARE Required: No StartTime The date and time your medical transcription job began processing. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022. Type: Timestamp Required: No TranscriptionJobStatus Provides the status of your medical transcription job. If the status is COMPLETED, the job is ﬁnished and you can ﬁnd the results at the location speciﬁed in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed. MedicalTranscriptionJobSummary API Version 2017-10-26 335 Amazon Transcribe Type: String API Reference Valid Values: QUEUED \| IN_PROGRESS \| FAILED \| COMPLETED Required: No Type Indicates whether the input media is a dictation or a conversation, as speciﬁed in the StartMedicalTranscriptionJob request. Type: String Valid Values: CONVERSATION \| DICTATION Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MedicalTranscriptionJobSummary API Version 2017-10-26 336 Amazon Transcribe API Reference MedicalTranscriptionSetting Service: Amazon Transcribe Service Allows additional optional settings in your StartMedicalTranscriptionJob request, including channel identiﬁcation, alternative transcriptions, and speaker partitioning. You can use that to
transcribe-api-080	transcribe-api.pdf	80	Required: No Type Indicates whether the input media is a dictation or a conversation, as speciﬁed in the StartMedicalTranscriptionJob request. Type: String Valid Values: CONVERSATION \| DICTATION Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MedicalTranscriptionJobSummary API Version 2017-10-26 336 Amazon Transcribe API Reference MedicalTranscriptionSetting Service: Amazon Transcribe Service Allows additional optional settings in your StartMedicalTranscriptionJob request, including channel identiﬁcation, alternative transcriptions, and speaker partitioning. You can use that to apply custom vocabularies to your medical transcription job. Contents ChannelIdentiﬁcation Enables channel identiﬁcation in multi-channel audio. Channel identiﬁcation transcribes the audio on each channel independently, then appends the output for each channel into one transcript. If you have multi-channel audio and do not enable channel identiﬁcation, your audio is transcribed in a continuous manner and your transcript does not separate the speech by channel. For more information, see Transcribing multi-channel audio. Type: Boolean Required: No MaxAlternatives Indicate the maximum number of alternative transcriptions you want Amazon Transcribe Medical to include in your transcript. If you select a number greater than the number of alternative transcriptions generated by Amazon Transcribe Medical, only the actual number of alternative transcriptions are included. If you include MaxAlternatives in your request, you must also include ShowAlternatives with a value of true. For more information, see Alternative transcriptions. Type: Integer Valid Range: Minimum value of 2. Maximum value of 10. MedicalTranscriptionSetting API Version 2017-10-26 337 Amazon Transcribe Required: No MaxSpeakerLabels API Reference Specify the maximum number of speakers you want to partition in your media. Note that if your media contains more speakers than the speciﬁed number, multiple speakers are treated as a single speaker. If you specify the MaxSpeakerLabels ﬁeld, you must set the ShowSpeakerLabels ﬁeld to true. Type: Integer Valid Range: Minimum value of 2. Maximum value of 30. Required: No ShowAlternatives To include alternative transcriptions within your transcription output, include ShowAlternatives in your transcription request. If you include ShowAlternatives, you must also include MaxAlternatives, which is the maximum number of alternative transcriptions you want Amazon Transcribe Medical to generate. For more information, see Alternative transcriptions. Type: Boolean Required: No ShowSpeakerLabels Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media ﬁle. If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels. For more information, see Partitioning speakers (diarization). Type: Boolean MedicalTranscriptionSetting API Version 2017-10-26 338 Amazon Transcribe Required: No VocabularyName API Reference The name of the custom vocabulary you want to use when processing your medical transcription job. Custom vocabulary names are case sensitive. The language of the speciﬁed custom vocabulary must match the language code that you specify in your transcription request. If the languages do not match, the custom vocabulary isn't applied. There are no errors or warnings associated with a language mismatch. US English (en- US) is the only valid language for Amazon Transcribe Medical. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MedicalTranscriptionSetting API Version 2017-10-26 339 Amazon Transcribe API Reference ModelSettings Service: Amazon Transcribe Service Provides the name of the custom language model that was included in the speciﬁed transcription job. Only use ModelSettings with the LanguageModelName sub-parameter if you're not using automatic language identiﬁcation ( LanguageIdSettings ). If using LanguageIdSettings in your request, this parameter contains a LanguageModelName sub-parameter. Contents LanguageModelName The name of the custom language model you want to use when processing your transcription job. Note that custom language model names are case sensitive. The language of the speciﬁed custom language model must match the language code that you specify in your transcription request. If the languages do not match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ModelSettings API Version 2017-10-26 340 Amazon Transcribe API Reference NonTalkTimeFilter Service: Amazon Transcribe Service Flag the presence or absence of periods of silence in your Call Analytics transcription output. Rules using NonTalkTimeFilter are designed to match: • The presence of silence at speciﬁed periods throughout the call • The presence of speech at speciﬁed periods throughout the call See Rule criteria
transcribe-api-081	transcribe-api.pdf	81	^[0-9a-zA-Z._-]+ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ModelSettings API Version 2017-10-26 340 Amazon Transcribe API Reference NonTalkTimeFilter Service: Amazon Transcribe Service Flag the presence or absence of periods of silence in your Call Analytics transcription output. Rules using NonTalkTimeFilter are designed to match: • The presence of silence at speciﬁed periods throughout the call • The presence of speech at speciﬁed periods throughout the call See Rule criteria for post-call categories for usage examples. Contents AbsoluteTimeRange Makes it possible to specify a time range (in milliseconds) in your audio, during which you want to search for a period of silence. See AbsoluteTimeRange for more detail. Type: AbsoluteTimeRange object Required: No Negate Set to TRUE to ﬂag periods of speech. Set to FALSE to ﬂag periods of silence Type: Boolean Required: No RelativeTimeRange Makes it possible to specify a time range (in percentage) in your media ﬁle, during which you want to search for a period of silence. See RelativeTimeRange for more detail. Type: RelativeTimeRange object Required: No Threshold Specify the duration, in milliseconds, of the period of silence that you want to ﬂag. For example, you can ﬂag a silent period that lasts 30,000 milliseconds. NonTalkTimeFilter API Version 2017-10-26 341 Amazon Transcribe Type: Long API Reference Valid Range: Minimum value of 0. Maximum value of 14400000. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 NonTalkTimeFilter API Version 2017-10-26 342 Amazon Transcribe API Reference RelativeTimeRange Service: Amazon Transcribe Service A time range, in percentage, between two points in your media ﬁle. You can use StartPercentage and EndPercentage to search a custom segment. For example, setting StartPercentage to 10 and EndPercentage to 50 only searches for your speciﬁed criteria in the audio contained between the 10 percent mark and the 50 percent mark of your media ﬁle. You can use also First to search from the start of the media ﬁle until the time that you specify. Or use Last to search from the time that you specify until the end of the media ﬁle. For example, setting First to 10 only searches for your speciﬁed criteria in the audio contained in the ﬁrst 10 percent of the media ﬁle. If you prefer to use milliseconds instead of percentage, see AbsoluteTimeRange. Contents EndPercentage The time, in percentage, when Amazon Transcribe stops searching for the speciﬁed criteria in your media ﬁle. If you include EndPercentage in your request, you must also include StartPercentage. Type: Integer Valid Range: Minimum value of 0. Maximum value of 100. Required: No First The time, in percentage, from the start of your media ﬁle until the speciﬁed value. Amazon Transcribe searches for your speciﬁed criteria in this time segment. Type: Integer Valid Range: Minimum value of 0. Maximum value of 100. Required: No RelativeTimeRange API Version 2017-10-26 343 Amazon Transcribe Last API Reference The time, in percentage, from the speciﬁed value until the end of your media ﬁle. Amazon Transcribe searches for your speciﬁed criteria in this time segment. Type: Integer Valid Range: Minimum value of 0. Maximum value of 100. Required: No StartPercentage The time, in percentage, when Amazon Transcribe starts searching for the speciﬁed criteria in your media ﬁle. If you include StartPercentage in your request, you must also include EndPercentage. Type: Integer Valid Range: Minimum value of 0. Maximum value of 100. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RelativeTimeRange API Version 2017-10-26 344 Amazon Transcribe API Reference Rule Service: Amazon Transcribe Service A rule is a set of criteria that you can specify to ﬂag an attribute in your Call Analytics output. Rules deﬁne a Call Analytics category. Rules can include these parameters: InterruptionFilter, NonTalkTimeFilter, SentimentFilter, and TranscriptFilter. To learn more about Call Analytics rules and categories, see Creating categories for post-call transcriptions and Creating categories for real-time transcriptions. To learn more about Call Analytics, see Analyzing call center audio with Call Analytics. Contents Important This data type is a UNION, so only one of the following members can be speciﬁed when used or returned. InterruptionFilter Flag the presence or absence of interruptions in your Call Analytics transcription output. Refer to InterruptionFilter for more detail. Type: InterruptionFilter object Required: No NonTalkTimeFilter Flag the presence or absence of periods of silence in your Call Analytics transcription output. Refer to NonTalkTimeFilter for more
transcribe-api-082	transcribe-api.pdf	82	about Call Analytics rules and categories, see Creating categories for post-call transcriptions and Creating categories for real-time transcriptions. To learn more about Call Analytics, see Analyzing call center audio with Call Analytics. Contents Important This data type is a UNION, so only one of the following members can be speciﬁed when used or returned. InterruptionFilter Flag the presence or absence of interruptions in your Call Analytics transcription output. Refer to InterruptionFilter for more detail. Type: InterruptionFilter object Required: No NonTalkTimeFilter Flag the presence or absence of periods of silence in your Call Analytics transcription output. Refer to NonTalkTimeFilter for more detail. Type: NonTalkTimeFilter object Required: No SentimentFilter Flag the presence or absence of speciﬁc sentiments in your Call Analytics transcription output. Refer to SentimentFilter for more detail. Rule API Version 2017-10-26 345 Amazon Transcribe Type: SentimentFilter object Required: No TranscriptFilter API Reference Flag the presence or absence of speciﬁc words or phrases in your Call Analytics transcription output. Refer to TranscriptFilter for more detail. Type: TranscriptFilter object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Rule API Version 2017-10-26 346 Amazon Transcribe API Reference SentimentFilter Service: Amazon Transcribe Service Flag the presence or absence of speciﬁc sentiments detected in your Call Analytics transcription output. Rules using SentimentFilter are designed to match: • The presence or absence of a positive sentiment felt by the customer, agent, or both at speciﬁed points in the call • The presence or absence of a negative sentiment felt by the customer, agent, or both at speciﬁed points in the call • The presence or absence of a neutral sentiment felt by the customer, agent, or both at speciﬁed points in the call • The presence or absence of a mixed sentiment felt by the customer, the agent, or both at speciﬁed points in the call See Rule criteria for post-call categories for usage examples. Contents Sentiments Specify the sentiments that you want to ﬂag. Type: Array of strings Array Members: Fixed number of 1 item. Valid Values: POSITIVE \| NEGATIVE \| NEUTRAL \| MIXED Required: Yes AbsoluteTimeRange Makes it possible to specify a time range (in milliseconds) in your audio, during which you want to search for the speciﬁed sentiments. See AbsoluteTimeRange for more detail. Type: AbsoluteTimeRange object Required: No SentimentFilter API Version 2017-10-26 347 Amazon Transcribe Negate API Reference Set to TRUE to ﬂag the sentiments that you didn't include in your request. Set to FALSE to ﬂag the sentiments that you speciﬁed in your request. Type: Boolean Required: No ParticipantRole Specify the participant that you want to ﬂag. Omitting this parameter is equivalent to specifying both participants. Type: String Valid Values: AGENT \| CUSTOMER Required: No RelativeTimeRange Makes it possible to specify a time range (in percentage) in your media ﬁle, during which you want to search for the speciﬁed sentiments. See RelativeTimeRange for more detail. Type: RelativeTimeRange object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SentimentFilter API Version 2017-10-26 348 Amazon Transcribe API Reference Settings Service: Amazon Transcribe Service Allows additional optional settings in your StartTranscriptionJob request, including channel identiﬁcation, alternative transcriptions, and speaker partitioning. You can use that to apply custom vocabularies to your transcription job. Contents ChannelIdentiﬁcation Enables channel identiﬁcation in multi-channel audio. Channel identiﬁcation transcribes the audio on each channel independently, then appends the output for each channel into one transcript. For more information, see Transcribing multi-channel audio. Type: Boolean Required: No MaxAlternatives Indicate the maximum number of alternative transcriptions you want Amazon Transcribe to include in your transcript. If you select a number greater than the number of alternative transcriptions generated by Amazon Transcribe, only the actual number of alternative transcriptions are included. If you include MaxAlternatives in your request, you must also include ShowAlternatives with a value of true. For more information, see Alternative transcriptions. Type: Integer Valid Range: Minimum value of 2. Maximum value of 10. Required: No MaxSpeakerLabels Specify the maximum number of speakers you want to partition in your media. Settings API Version 2017-10-26 349 Amazon Transcribe API Reference Note that if your media contains more speakers than the speciﬁed number, multiple speakers are treated as a single speaker. If you specify the MaxSpeakerLabels ﬁeld, you must set the ShowSpeakerLabels ﬁeld to true. Type: Integer Valid Range: Minimum value of 2. Maximum value of 30. Required: No ShowAlternatives To include alternative transcriptions within your transcription output, include ShowAlternatives in your transcription request. If you have multi-channel audio and do not enable channel identiﬁcation,
transcribe-api-083	transcribe-api.pdf	83	10. Required: No MaxSpeakerLabels Specify the maximum number of speakers you want to partition in your media. Settings API Version 2017-10-26 349 Amazon Transcribe API Reference Note that if your media contains more speakers than the speciﬁed number, multiple speakers are treated as a single speaker. If you specify the MaxSpeakerLabels ﬁeld, you must set the ShowSpeakerLabels ﬁeld to true. Type: Integer Valid Range: Minimum value of 2. Maximum value of 30. Required: No ShowAlternatives To include alternative transcriptions within your transcription output, include ShowAlternatives in your transcription request. If you have multi-channel audio and do not enable channel identiﬁcation, your audio is transcribed in a continuous manner and your transcript does not separate the speech by channel. If you include ShowAlternatives, you must also include MaxAlternatives, which is the maximum number of alternative transcriptions you want Amazon Transcribe to generate. For more information, see Alternative transcriptions. Type: Boolean Required: No ShowSpeakerLabels Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media ﬁle. If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels. For more information, see Partitioning speakers (diarization). Type: Boolean Required: No Settings API Version 2017-10-26 350 Amazon Transcribe VocabularyFilterMethod API Reference Specify how you want your custom vocabulary ﬁlter applied to your transcript. To replace words with ***, choose mask. To delete words, choose remove. To ﬂag words without changing them, choose tag. Type: String Valid Values: remove \| mask \| tag Required: No VocabularyFilterName The name of the custom vocabulary ﬁlter you want to use in your transcription job request. This name is case sensitive, cannot contain spaces, and must be unique within an AWS account. Note that if you include VocabularyFilterName in your request, you must also include VocabularyFilterMethod. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: No VocabularyName The name of the custom vocabulary you want to use in your transcription job request. This name is case sensitive, cannot contain spaces, and must be unique within an AWS account. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: No Settings API Version 2017-10-26 351 Amazon Transcribe See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Settings API Version 2017-10-26 352 Amazon Transcribe API Reference Subtitles Service: Amazon Transcribe Service Generate subtitles for your media ﬁle with your transcription request. You can choose a start index of 0 or 1, and you can specify either WebVTT or SubRip (or both) as your output format. Note that your subtitle ﬁles are placed in the same location as your transcription output. Contents Formats Specify the output format for your subtitle ﬁle; if you select both WebVTT (vtt) and SubRip (srt) formats, two output ﬁles are generated. Type: Array of strings Valid Values: vtt \| srt Required: No OutputStartIndex Specify the starting value that is assigned to the ﬁrst subtitle segment. The default start index for Amazon Transcribe is 0, which diﬀers from the more widely used standard of 1. If you're uncertain which value to use, we recommend choosing 1, as this may improve compatibility with other services. Type: Integer Valid Range: Minimum value of 0. Maximum value of 1. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: Subtitles API Version 2017-10-26 353 Amazon Transcribe • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference Subtitles API Version 2017-10-26 354 Amazon Transcribe API Reference SubtitlesOutput Service: Amazon Transcribe Service Provides information about your subtitle ﬁle, including format, start index, and Amazon S3 location. Contents Formats Provides the format of your subtitle ﬁles. If your request included both WebVTT (vtt) and SubRip (srt) formats, both formats are shown. Type: Array of strings Valid Values: vtt \| srt Required: No OutputStartIndex Provides the start index value for your subtitle ﬁles. If you did not specify a value in your request, the default value of 0 is used. Type: Integer Valid Range: Minimum value of 0. Maximum value of 1. Required: No SubtitleFileUris The Amazon S3 location of your transcript. You can use this URI to access or download your subtitle ﬁle. Your subtitle ﬁle is stored in the same location as your transcript. If you speciﬁed both WebVTT and SubRip subtitle formats, two URIs are provided. If you included OutputBucketName in your transcription job request, this is the URI of that bucket. If you also included OutputKey in your request, your output is located in the path you speciﬁed in your request. If you
transcribe-api-084	transcribe-api.pdf	84	0 is used. Type: Integer Valid Range: Minimum value of 0. Maximum value of 1. Required: No SubtitleFileUris The Amazon S3 location of your transcript. You can use this URI to access or download your subtitle ﬁle. Your subtitle ﬁle is stored in the same location as your transcript. If you speciﬁed both WebVTT and SubRip subtitle formats, two URIs are provided. If you included OutputBucketName in your transcription job request, this is the URI of that bucket. If you also included OutputKey in your request, your output is located in the path you speciﬁed in your request. If you didn't include OutputBucketName in your transcription job request, your subtitle ﬁle is stored in a service-managed bucket, and TranscriptFileUri provides you with a temporary URI you can use for secure access to your subtitle ﬁle. SubtitlesOutput API Version 2017-10-26 355 Amazon Transcribe Note API Reference Temporary URIs for service-managed Amazon S3 buckets are only valid for 15 minutes. If you get an AccesDenied error, you can get a new temporary URI by running a GetTranscriptionJob or ListTranscriptionJob request. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 2000. Pattern: (s3://\|http(s*)://).+ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SubtitlesOutput API Version 2017-10-26 356 Amazon Transcribe API Reference Summarization Service: Amazon Transcribe Service Contains GenerateAbstractiveSummary, which is a required parameter if you want to enable Generative call summarization in your Call Analytics request. Contents GenerateAbstractiveSummary Enables Generative call summarization in your Call Analytics request Generative call summarization provides a summary of the transcript including important components discussed in the conversation. For more information, see Enabling generative call summarization. Type: Boolean Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Summarization API Version 2017-10-26 357 Amazon Transcribe API Reference Tag Service: Amazon Transcribe Service Adds metadata, in the form of a key:value pair, to the speciﬁed resource. For example, you could add the tag Department:Sales to a resource to indicate that it pertains to your organization's sales department. You can also use tags for tag-based access control. To learn more about tagging, see Tagging resources. Contents Key The ﬁrst 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'. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes Value 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 that you can set the value of a tag to an empty string, but you can't set the value of a tag to null. Omitting the tag value is the same as using an empty string. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: Tag API Version 2017-10-26 358 Amazon Transcribe • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference Tag API Version 2017-10-26 359 Amazon Transcribe API Reference ToxicityDetectionSettings Service: Amazon Transcribe Service Contains ToxicityCategories, which is a required parameter if you want to enable toxicity detection (ToxicityDetection) in your transcription request. Contents ToxicityCategories If you include ToxicityDetection in your transcription request, you must also include ToxicityCategories. The only accepted value for this parameter is ALL. Type: Array of strings Array Members: Fixed number of 1 item. Valid Values: ALL Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ToxicityDetectionSettings API Version 2017-10-26 360 Amazon Transcribe API Reference Transcript Service: Amazon Transcribe Service Provides you with the Amazon S3 URI you can use to access your transcript. Contents RedactedTranscriptFileUri The Amazon S3 location of your redacted transcript. You can use this URI to access or download your transcript. If you included OutputBucketName in your transcription job request, this is the URI of that bucket. If you also included OutputKey in your request, your output is located in the path you speciﬁed in your request. If you didn't include OutputBucketName in your transcription job request, your transcript is stored in a service-managed bucket, and RedactedTranscriptFileUri provides you with a temporary URI you can use for secure access to your transcript.
transcribe-api-085	transcribe-api.pdf	85	URI you can use to access your transcript. Contents RedactedTranscriptFileUri The Amazon S3 location of your redacted transcript. You can use this URI to access or download your transcript. If you included OutputBucketName in your transcription job request, this is the URI of that bucket. If you also included OutputKey in your request, your output is located in the path you speciﬁed in your request. If you didn't include OutputBucketName in your transcription job request, your transcript is stored in a service-managed bucket, and RedactedTranscriptFileUri provides you with a temporary URI you can use for secure access to your transcript. Note Temporary URIs for service-managed Amazon S3 buckets are only valid for 15 minutes. If you get an AccesDenied error, you can get a new temporary URI by running a GetTranscriptionJob or ListTranscriptionJob request. Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. Pattern: (s3://\|http(s)://).+ Required: No TranscriptFileUri The Amazon S3 location of your transcript. You can use this URI to access or download your transcript. Transcript API Version 2017-10-26 361 Amazon Transcribe API Reference If you included OutputBucketName in your transcription job request, this is the URI of that bucket. If you also included OutputKey in your request, your output is located in the path you speciﬁed in your request. If you didn't include OutputBucketName in your transcription job request, your transcript is stored in a service-managed bucket, and TranscriptFileUri provides you with a temporary URI you can use for secure access to your transcript. Note Temporary URIs for service-managed Amazon S3 buckets are only valid for 15 minutes. If you get an AccesDenied error, you can get a new temporary URI by running a GetTranscriptionJob or ListTranscriptionJob request. Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. Pattern: (s3://\|http(s)://).+ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Transcript API Version 2017-10-26 362 Amazon Transcribe API Reference TranscriptFilter Service: Amazon Transcribe Service Flag the presence or absence of speciﬁc words or phrases detected in your Call Analytics transcription output. Rules using TranscriptFilter are designed to match: • Custom words or phrases spoken by the agent, the customer, or both • Custom words or phrases not spoken by the agent, the customer, or either • Custom words or phrases that occur at a speciﬁc time frame See Rule criteria for post-call categories and Rule criteria for streaming categories for usage examples. Contents Targets Specify the phrases that you want to ﬂag. Type: Array of strings Array Members: Minimum number of 1 item. Length Constraints: Minimum length of 1. Maximum length of 2000. Pattern: .\S. Required: Yes TranscriptFilterType Flag the presence or absence of an exact match to the phrases that you specify. For example, if you specify the phrase "speak to a manager" as your Targets value, only that exact phrase is ﬂagged. Note that semantic matching is not supported. For example, if your customer says "speak to the manager", instead of "speak to a manager", your content is not ﬂagged. Type: String TranscriptFilter API Version 2017-10-26 363 Amazon Transcribe Valid Values: EXACT Required: Yes AbsoluteTimeRange API Reference Makes it possible to specify a time range (in milliseconds) in your audio, during which you want to search for the speciﬁed key words or phrases. See AbsoluteTimeRange for more detail. Type: AbsoluteTimeRange object Required: No Negate Set to TRUE to ﬂag the absence of the phrase that you speciﬁed in your request. Set to FALSE to ﬂag the presence of the phrase that you speciﬁed in your request. Type: Boolean Required: No ParticipantRole Specify the participant that you want to ﬂag. Omitting this parameter is equivalent to specifying both participants. Type: String Valid Values: AGENT \| CUSTOMER Required: No RelativeTimeRange Makes it possible to specify a time range (in percentage) in your media ﬁle, during which you want to search for the speciﬁed key words or phrases. See RelativeTimeRange for more detail. Type: RelativeTimeRange object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: TranscriptFilter API Version 2017-10-26 364 Amazon Transcribe • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference TranscriptFilter API Version 2017-10-26 365 Amazon Transcribe API Reference TranscriptionJob Service: Amazon Transcribe Service Provides detailed information about a transcription job. To view the status of the speciﬁed transcription job, check the TranscriptionJobStatus ﬁeld. If the status is COMPLETED, the job is ﬁnished and you can ﬁnd the results at the location speciﬁed in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed. If you enabled content
transcribe-api-086	transcribe-api.pdf	86	following: TranscriptFilter API Version 2017-10-26 364 Amazon Transcribe • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference TranscriptFilter API Version 2017-10-26 365 Amazon Transcribe API Reference TranscriptionJob Service: Amazon Transcribe Service Provides detailed information about a transcription job. To view the status of the speciﬁed transcription job, check the TranscriptionJobStatus ﬁeld. If the status is COMPLETED, the job is ﬁnished and you can ﬁnd the results at the location speciﬁed in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed. If you enabled content redaction, the redacted transcript can be found at the location speciﬁed in RedactedTranscriptFileUri. Contents CompletionTime The date and time the speciﬁed transcription job ﬁnished processing. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022. Type: Timestamp Required: No ContentRedaction Indicates whether redaction was enabled in your transcript. Type: ContentRedaction object Required: No CreationTime The date and time the speciﬁed transcription job request was made. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022. Type: Timestamp TranscriptionJob API Version 2017-10-26 366 Amazon Transcribe Required: No FailureReason API Reference If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job request failed. The FailureReason ﬁeld contains one of the following values: • Unsupported media format. The media format speciﬁed in MediaFormat isn't valid. Refer to refer to the MediaFormat parameter for a list of supported formats. • The media format provided does not match the detected media format. The media format speciﬁed in MediaFormat doesn't match the format of the input ﬁle. Check the media format of your media ﬁle and correct the speciﬁed value. • Invalid sample rate for audio file. The sample rate speciﬁed in MediaSampleRateHertz isn't valid. The sample rate must be between 8,000 and 48,000 hertz. • The sample rate provided does not match the detected sample rate. The sample rate speciﬁed in MediaSampleRateHertz doesn't match the sample rate detected in your input media ﬁle. Check the sample rate of your media ﬁle and correct the speciﬁed value. • Invalid file size: file size too large. The size of your media ﬁle is larger than what Amazon Transcribe can process. For more information, refer to Service quotas. • Invalid number of channels: number of channels too large. Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Service quotas. Type: String Required: No IdentiﬁedLanguageScore The conﬁdence score associated with the language identiﬁed in your media ﬁle. TranscriptionJob API Version 2017-10-26 367 Amazon Transcribe API Reference Conﬁdence scores are values between 0 and 1; a larger value indicates a higher probability that the identiﬁed language correctly matches the language spoken in your media. Type: Float Required: No IdentifyLanguage Indicates whether automatic language identiﬁcation was enabled (TRUE) for the speciﬁed transcription job. Type: Boolean Required: No IdentifyMultipleLanguages Indicates whether automatic multi-language identiﬁcation was enabled (TRUE) for the speciﬁed transcription job. Type: Boolean Required: No JobExecutionSettings Provides information about how your transcription job was processed. This parameter shows if your request was queued and what data access role was used. Type: JobExecutionSettings object Required: No LanguageCode The language code used to create your transcription job. This parameter is used with single- language identiﬁcation. For multi-language identiﬁcation requests, refer to the plural version of this parameter, LanguageCodes. Type: String Valid Values: af-ZA \| ar-AE \| ar-SA \| da-DK \| de-CH \| de-DE \| en-AB \| en-AU \| en-GB \| en-IE \| en-IN \| en-US \| en-WL \| es-ES \| es-US \| fa-IR \| fr-CA \| fr-FR \| he-IL \| hi-IN \| id-ID \| it-IT \| ja-JP \| ko-KR \| ms-MY \| nl-NL TranscriptionJob API Version 2017-10-26 368 Amazon Transcribe API Reference \| 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-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 \| or-IN \| pa-IN \| pl-PL \| ps-AF \| ro-RO \| rw-RW \| si-LK \| sk-SK \| sl-SI \| so-SO \| 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
transcribe-api-087	transcribe-api.pdf	87	\| el-GR \| 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 \| or-IN \| pa-IN \| pl-PL \| ps-AF \| ro-RO \| rw-RW \| si-LK \| sk-SK \| sl-SI \| so-SO \| 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 \| zu-ZA Required: No LanguageCodes The language codes used to create your transcription job. This parameter is used with multi- language identiﬁcation. For single-language identiﬁcation requests, refer to the singular version of this parameter, LanguageCode. Type: Array of LanguageCodeItem objects Required: No LanguageIdSettings Provides the name and language of all custom language models, custom vocabularies, and custom vocabulary ﬁlters that you included in your request. Type: String to LanguageIdSettings object map Map Entries: Maximum number of 5 items. Valid Keys: af-ZA \| ar-AE \| ar-SA \| da-DK \| de-CH \| de-DE \| en-AB \| en-AU \| en-GB \| en-IE \| en-IN \| en-US \| en-WL \| es-ES \| es-US \| fa-IR \| fr-CA \| fr-FR \| he-IL \| hi-IN \| id-ID \| it-IT \| ja-JP \| ko-KR \| 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-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 \| or-IN \| pa-IN \| pl-PL \| ps-AF \| ro-RO \| rw-RW \| si-LK \| sk-SK \| sl-SI \| so-SO TranscriptionJob API Version 2017-10-26 369 Amazon Transcribe API Reference \| 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 \| zu-ZA Required: No LanguageOptions Provides the language codes you speciﬁed in your request. Type: Array of strings Array Members: Minimum number of 1 item. Valid Values: af-ZA \| ar-AE \| ar-SA \| da-DK \| de-CH \| de-DE \| en-AB \| en-AU \| en-GB \| en-IE \| en-IN \| en-US \| en-WL \| es-ES \| es-US \| fa-IR \| fr-CA \| fr-FR \| he-IL \| hi-IN \| id-ID \| it-IT \| ja-JP \| ko-KR \| 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-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 \| or-IN \| pa-IN \| pl-PL \| ps-AF \| ro-RO \| rw-RW \| si-LK \| sk-SK \| sl-SI \| so-SO \| 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 \| zu-ZA Required: No Media Provides the Amazon S3 location of the media ﬁle you used in your request. Type: Media object Required: No MediaFormat The format of the input media ﬁle. Type: String Valid Values: mp3 \| mp4 \| wav \| flac \| ogg \| amr \| webm \| m4a TranscriptionJob API Version 2017-10-26 370 Amazon Transcribe Required: No MediaSampleRateHertz API Reference The sample rate, in hertz, of the audio track in your input media ﬁle. Type: Integer Valid Range: Minimum value of 8000. Maximum value of 48000. Required: No ModelSettings Provides information on the custom language model you included in your request. Type: ModelSettings object Required: No Settings Provides information on any additional settings that were included in your request. Additional settings include channel identiﬁcation, alternative transcriptions, speaker partitioning, custom vocabularies, and custom vocabulary ﬁlters. Type: Settings object Required: No StartTime The date and time the speciﬁed transcription job began processing. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.
transcribe-api-088	transcribe-api.pdf	88	Type: Integer Valid Range: Minimum value of 8000. Maximum value of 48000. Required: No ModelSettings Provides information on the custom language model you included in your request. Type: ModelSettings object Required: No Settings Provides information on any additional settings that were included in your request. Additional settings include channel identiﬁcation, alternative transcriptions, speaker partitioning, custom vocabularies, and custom vocabulary ﬁlters. Type: Settings object Required: No StartTime The date and time the speciﬁed transcription job began processing. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022. Type: Timestamp Required: No Subtitles Indicates whether subtitles were generated with your transcription. Type: SubtitlesOutput object TranscriptionJob API Version 2017-10-26 371 Amazon Transcribe Required: No Tags API Reference The tags, each in the form of a key:value pair, assigned to the speciﬁed transcription job. Type: Array of Tag objects Array Members: Minimum number of 1 item. Maximum number of 200 items. Required: No ToxicityDetection Provides information about the toxicity detection settings applied to your transcription. Type: Array of ToxicityDetectionSettings objects Array Members: Fixed number of 1 item. Required: No Transcript Provides you with the Amazon S3 URI you can use to access your transcript. Type: Transcript object Required: No TranscriptionJobName The name of the transcription job. Job names are case sensitive and must be unique within an AWS account. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: No TranscriptionJobStatus Provides the status of the speciﬁed transcription job. TranscriptionJob API Version 2017-10-26 372 Amazon Transcribe API Reference If the status is COMPLETED, the job is ﬁnished and you can ﬁnd the results at the location speciﬁed in TranscriptFileUri (or RedactedTranscriptFileUri, if you requested transcript redaction). If the status is FAILED, FailureReason provides details on why your transcription job failed. Type: String Valid Values: QUEUED \| IN_PROGRESS \| FAILED \| COMPLETED Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 TranscriptionJob API Version 2017-10-26 373 Amazon Transcribe API Reference TranscriptionJobSummary Service: Amazon Transcribe Service Provides detailed information about a speciﬁc transcription job. Contents CompletionTime The date and time the speciﬁed transcription job ﬁnished processing. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022. Type: Timestamp Required: No ContentRedaction The content redaction settings of the transcription job. Type: ContentRedaction object Required: No CreationTime The date and time the speciﬁed transcription job request was made. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022. Type: Timestamp Required: No FailureReason If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job failed. See also: Common Errors. Type: String TranscriptionJobSummary API Version 2017-10-26 374 Amazon Transcribe Required: No IdentiﬁedLanguageScore API Reference The conﬁdence score associated with the language identiﬁed in your media ﬁle. Conﬁdence scores are values between 0 and 1; a larger value indicates a higher probability that the identiﬁed language correctly matches the language spoken in your media. Type: Float Required: No IdentifyLanguage Indicates whether automatic language identiﬁcation was enabled (TRUE) for the speciﬁed transcription job. Type: Boolean Required: No IdentifyMultipleLanguages Indicates whether automatic multi-language identiﬁcation was enabled (TRUE) for the speciﬁed transcription job. Type: Boolean Required: No LanguageCode The language code used to create your transcription. Type: String Valid Values: af-ZA \| ar-AE \| ar-SA \| da-DK \| de-CH \| de-DE \| en-AB \| en-AU \| en-GB \| en-IE \| en-IN \| en-US \| en-WL \| es-ES \| es-US \| fa-IR \| fr-CA \| fr-FR \| he-IL \| hi-IN \| id-ID \| it-IT \| ja-JP \| ko-KR \| 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-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 \| TranscriptionJobSummary API Version 2017-10-26 375 Amazon Transcribe API Reference lv-LV \| mhr-RU \| mi-NZ \| mk-MK \| ml-IN \| mn-MN \| mr-IN \| mt-MT \| no-NO \| or-IN \| pa-IN \| pl-PL \| ps-AF \| ro-RO \| rw-RW \| si-LK \| sk-SK \| sl-SI \| so-SO \| sr-RS \| su-ID \| sw-BI \| sw-KE \| sw-RW \| sw-TZ \| sw-UG \| tl-PH \| tt-RU \|
transcribe-api-089	transcribe-api.pdf	89	\| 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 \| TranscriptionJobSummary API Version 2017-10-26 375 Amazon Transcribe API Reference lv-LV \| mhr-RU \| mi-NZ \| mk-MK \| ml-IN \| mn-MN \| mr-IN \| mt-MT \| no-NO \| or-IN \| pa-IN \| pl-PL \| ps-AF \| ro-RO \| rw-RW \| si-LK \| sk-SK \| sl-SI \| so-SO \| 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 \| zu-ZA Required: No LanguageCodes The language codes used to create your transcription job. This parameter is used with multi- language identiﬁcation. For single-language identiﬁcation, the singular version of this parameter, LanguageCode, is present. Type: Array of LanguageCodeItem objects Required: No ModelSettings Provides the name of the custom language model that was included in the speciﬁed transcription job. Only use ModelSettings with the LanguageModelName sub-parameter if you're not using automatic language identiﬁcation ( LanguageIdSettings ). If using LanguageIdSettings in your request, this parameter contains a LanguageModelName sub-parameter. Type: ModelSettings object Required: No OutputLocationType Indicates where the speciﬁed transcription output is stored. If the value is CUSTOMER_BUCKET, the location is the Amazon S3 bucket you speciﬁed using the OutputBucketName parameter in your StartTranscriptionJob request. If you also included OutputKey in your request, your output is located in the path you speciﬁed in your request. If the value is SERVICE_BUCKET, the location is a service-managed Amazon S3 bucket. To access a transcript stored in a service-managed bucket, use the URI shown in the TranscriptFileUri or RedactedTranscriptFileUri ﬁeld. Type: String TranscriptionJobSummary API Version 2017-10-26 376 Amazon Transcribe API Reference Valid Values: CUSTOMER_BUCKET \| SERVICE_BUCKET Required: No StartTime The date and time your transcription job began processing. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022. Type: Timestamp Required: No ToxicityDetection Indicates whether toxicity detection was enabled for the speciﬁed transcription job. Type: Array of ToxicityDetectionSettings objects Array Members: Fixed number of 1 item. Required: No TranscriptionJobName The name of the transcription job. Job names are case sensitive and must be unique within an AWS account. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: No TranscriptionJobStatus Provides the status of your transcription job. If the status is COMPLETED, the job is ﬁnished and you can ﬁnd the results at the location speciﬁed in TranscriptFileUri (or RedactedTranscriptFileUri, if you requested TranscriptionJobSummary API Version 2017-10-26 377 Amazon Transcribe API Reference transcript redaction). If the status is FAILED, FailureReason provides details on why your transcription job failed. Type: String Valid Values: QUEUED \| IN_PROGRESS \| FAILED \| COMPLETED Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 TranscriptionJobSummary API Version 2017-10-26 378 Amazon Transcribe API Reference VocabularyFilterInfo Service: Amazon Transcribe Service Provides information about a custom vocabulary ﬁlter, including the language of the ﬁlter, when it was last modiﬁed, and its name. Contents LanguageCode The language code that represents the language of the entries in your vocabulary ﬁlter. Each custom vocabulary ﬁlter must contain terms in only one language. A custom vocabulary ﬁlter can only be used to transcribe ﬁles in the same language as the ﬁlter. For example, if you create a custom vocabulary ﬁlter using US English (en-US), you can only apply this ﬁlter to ﬁles that contain English audio. For a list of supported languages and their associated language codes, refer to the Supported languages table. Type: String Valid Values: af-ZA \| ar-AE \| ar-SA \| da-DK \| de-CH \| de-DE \| en-AB \| en-AU \| en-GB \| en-IE \| en-IN \| en-US \| en-WL \| es-ES \| es-US \| fa-IR \| fr-CA \| fr-FR \| he-IL \| hi-IN \| id-ID \| it-IT \| ja-JP \| ko-KR \| 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-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 \| or-IN \| pa-IN \| pl-PL \| ps-AF
transcribe-api-090	transcribe-api.pdf	90	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-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 \| or-IN \| pa-IN \| pl-PL \| ps-AF \| ro-RO \| rw-RW \| si-LK \| sk-SK \| sl-SI \| so-SO \| 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 \| zu-ZA Required: No LastModiﬁedTime The date and time the speciﬁed custom vocabulary ﬁlter was last modiﬁed. VocabularyFilterInfo API Version 2017-10-26 379 Amazon Transcribe API Reference Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022. Type: Timestamp Required: No VocabularyFilterName A unique name, chosen by you, for your custom vocabulary ﬁlter. This name is case sensitive, cannot contain spaces, and must be unique within an AWS account. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 VocabularyFilterInfo API Version 2017-10-26 380 Amazon Transcribe API Reference VocabularyInfo Service: Amazon Transcribe Service Provides information about a custom vocabulary, including the language of the custom vocabulary, when it was last modiﬁed, its name, and the processing state. Contents LanguageCode The language code used to create your custom vocabulary. Each custom vocabulary must contain terms in only one language. A custom vocabulary can only be used to transcribe ﬁles in the same language as the custom vocabulary. For example, if you create a custom vocabulary using US English (en-US), you can only apply this custom vocabulary to ﬁles that contain English audio. Type: String Valid Values: af-ZA \| ar-AE \| ar-SA \| da-DK \| de-CH \| de-DE \| en-AB \| en-AU \| en-GB \| en-IE \| en-IN \| en-US \| en-WL \| es-ES \| es-US \| fa-IR \| fr-CA \| fr-FR \| he-IL \| hi-IN \| id-ID \| it-IT \| ja-JP \| ko-KR \| 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-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 \| or-IN \| pa-IN \| pl-PL \| ps-AF \| ro-RO \| rw-RW \| si-LK \| sk-SK \| sl-SI \| so-SO \| 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 \| zu-ZA Required: No LastModiﬁedTime The date and time the speciﬁed custom vocabulary was last modiﬁed. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022. VocabularyInfo API Version 2017-10-26 381 Amazon Transcribe Type: Timestamp Required: No VocabularyName API Reference A unique name, chosen by you, for your custom vocabulary. This name is case sensitive, cannot contain spaces, and must be unique within an AWS account. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: No VocabularyState The processing state of your custom vocabulary. If the state is READY, you can use the custom vocabulary in a StartTranscriptionJob request. Type: String Valid Values: PENDING \| READY \| FAILED Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Amazon Transcribe Streaming Service The following data types are supported by Amazon Transcribe Streaming Service: • Alternative Amazon Transcribe Streaming Service API Version 2017-10-26 382 API Reference Amazon Transcribe • AudioEvent • AudioStream • CallAnalyticsEntity • CallAnalyticsItem • CallAnalyticsTranscriptResultStream • CategoryEvent • ChannelDeﬁnition • CharacterOﬀsets • ClinicalNoteGenerationResult • ClinicalNoteGenerationSettings • ConﬁgurationEvent • Entity • IssueDetected • Item • LanguageWithScore • MedicalAlternative • MedicalEntity • MedicalItem •
transcribe-api-091	transcribe-api.pdf	91	For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Amazon Transcribe Streaming Service The following data types are supported by Amazon Transcribe Streaming Service: • Alternative Amazon Transcribe Streaming Service API Version 2017-10-26 382 API Reference Amazon Transcribe • AudioEvent • AudioStream • CallAnalyticsEntity • CallAnalyticsItem • CallAnalyticsTranscriptResultStream • CategoryEvent • ChannelDeﬁnition • CharacterOﬀsets • ClinicalNoteGenerationResult • ClinicalNoteGenerationSettings • ConﬁgurationEvent • Entity • IssueDetected • Item • LanguageWithScore • MedicalAlternative • MedicalEntity • MedicalItem • MedicalResult • MedicalScribeAudioEvent • MedicalScribeChannelDeﬁnition • MedicalScribeConﬁgurationEvent • MedicalScribeEncryptionSettings • MedicalScribeInputStream • MedicalScribePostStreamAnalyticsResult • MedicalScribePostStreamAnalyticsSettings • MedicalScribeResultStream • MedicalScribeSessionControlEvent • MedicalScribeStreamDetails • MedicalScribeTranscriptEvent Amazon Transcribe Streaming Service API Version 2017-10-26 383 Amazon Transcribe API Reference • MedicalScribeTranscriptItem • MedicalScribeTranscriptSegment • MedicalTranscript • MedicalTranscriptEvent • MedicalTranscriptResultStream • PointsOfInterest • PostCallAnalyticsSettings • Result • TimestampRange • Transcript • TranscriptEvent • TranscriptResultStream • UtteranceEvent Amazon Transcribe Streaming Service API Version 2017-10-26 384 Amazon Transcribe API Reference Alternative Service: Amazon Transcribe Streaming Service A list of possible alternative transcriptions for the input audio. Each alternative may contain one or more of Items, Entities, or Transcript. Contents Entities Contains entities identiﬁed as personally identiﬁable information (PII) in your transcription output. Type: Array of Entity objects Required: No Items Contains words, phrases, or punctuation marks in your transcription output. Type: Array of Item objects Required: No Transcript Contains transcribed text. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Alternative API Version 2017-10-26 385 Amazon Transcribe API Reference AudioEvent Service: Amazon Transcribe Streaming Service A wrapper for your audio chunks. Your audio stream consists of one or more audio events, which consist of one or more audio chunks. For more information, see Event stream encoding. Contents AudioChunk An audio blob containing the next segment of audio from your application, with a maximum duration of 1 second. The maximum size in bytes varies based on audio properties. Find recommended size in Transcribing streaming best practices. Size calculation: Duration (s) * Sample Rate (Hz) * Number of Channels * 2 (Bytes per Sample) For example, a 1-second chunk of 16 kHz, 2-channel, 16-bit audio would be 1 * 16000 * 2 * 2 = 64000 bytes. For 8 kHz, 1-channel, 16-bit audio, a 1-second chunk would be 1 * 8000 * 1 * 2 = 16000 bytes. Type: Base64-encoded binary data object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 AudioEvent API Version 2017-10-26 386 Amazon Transcribe API Reference AudioStream Service: Amazon Transcribe Streaming Service An encoded stream of audio blobs. Audio streams are encoded as either HTTP/2 or WebSocket data frames. For more information, see Transcribing streaming audio. Contents AudioEvent A blob of audio from your application. Your audio stream consists of one or more audio events. For more information, see Event stream encoding. Type: AudioEvent object Required: No ConﬁgurationEvent Contains audio channel deﬁnitions and post-call analytics settings. Type: ConﬁgurationEvent object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 AudioStream API Version 2017-10-26 387 Amazon Transcribe API Reference CallAnalyticsEntity Service: Amazon Transcribe Streaming Service Contains entities identiﬁed as personally identiﬁable information (PII) in your transcription output, along with various associated attributes. Examples include category, conﬁdence score, content, type, and start and end times. Contents BeginOﬀsetMillis The time, in milliseconds, from the beginning of the audio stream to the start of the identiﬁed entity. Type: Long Required: No Category The category of information identiﬁed. For example, PII. Type: String Required: No Conﬁdence The conﬁdence score associated with the identiﬁcation of an entity in your transcript. Conﬁdence scores are values between 0 and 1. A larger value indicates a higher probability that the identiﬁed entity correctly matches the entity spoken in your media. Type: Double Required: No Content The word or words that represent the identiﬁed entity. Type: String Required: No CallAnalyticsEntity API Version 2017-10-26 388 Amazon Transcribe EndOﬀsetMillis API Reference The time, in milliseconds, from the beginning of the audio stream to the end of the identiﬁed entity. Type: Long Required: No Type The type of PII identiﬁed. For example, NAME or CREDIT_DEBIT_NUMBER. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: •
transcribe-api-092	transcribe-api.pdf	92	a higher probability that the identiﬁed entity correctly matches the entity spoken in your media. Type: Double Required: No Content The word or words that represent the identiﬁed entity. Type: String Required: No CallAnalyticsEntity API Version 2017-10-26 388 Amazon Transcribe EndOﬀsetMillis API Reference The time, in milliseconds, from the beginning of the audio stream to the end of the identiﬁed entity. Type: Long Required: No Type The type of PII identiﬁed. For example, NAME or CREDIT_DEBIT_NUMBER. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 CallAnalyticsEntity API Version 2017-10-26 389 Amazon Transcribe API Reference CallAnalyticsItem Service: Amazon Transcribe Streaming Service A word, phrase, or punctuation mark in your Call Analytics transcription output, along with various associated attributes, such as conﬁdence score, type, and start and end times. Contents BeginOﬀsetMillis The time, in milliseconds, from the beginning of the audio stream to the start of the identiﬁed item. Type: Long Required: No Conﬁdence The conﬁdence score associated with a word or phrase in your transcript. Conﬁdence scores are values between 0 and 1. A larger value indicates a higher probability that the identiﬁed item correctly matches the item spoken in your media. Type: Double Required: No Content The word or punctuation that was transcribed. Type: String Required: No EndOﬀsetMillis The time, in milliseconds, from the beginning of the audio stream to the end of the identiﬁed item. Type: Long Required: No CallAnalyticsItem API Version 2017-10-26 390 Amazon Transcribe Stable API Reference If partial result stabilization is enabled, Stable indicates whether the speciﬁed item is stable (true) or if it may change when the segment is complete (false). Type: Boolean Required: No Type The type of item identiﬁed. Options are: PRONUNCIATION (spoken words) and PUNCTUATION. Type: String Valid Values: pronunciation \| punctuation Required: No VocabularyFilterMatch Indicates whether the speciﬁed item matches a word in the vocabulary ﬁlter included in your Call Analytics request. If true, there is a vocabulary ﬁlter match. Type: Boolean Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 CallAnalyticsItem API Version 2017-10-26 391 Amazon Transcribe API Reference CallAnalyticsTranscriptResultStream Service: Amazon Transcribe Streaming Service Contains detailed information about your real-time Call Analytics session. These details are provided in the UtteranceEvent and CategoryEvent objects. Contents BadRequestException One or more arguments to the StartStreamTranscription, StartMedicalStreamTranscription, or StartCallAnalyticsStreamTranscription operation was not valid. For example, MediaEncoding or LanguageCode used unsupported values. Check the speciﬁed parameters and try your request again. Type: Exception HTTP Status Code: 400 Required: No CategoryEvent Provides information on matched categories that were used to generate real-time supervisor alerts. Type: CategoryEvent object Required: No ConﬂictException A new stream started with the same session ID. The current stream has been terminated. Type: Exception HTTP Status Code: 409 Required: No InternalFailureException A problem occurred while processing the audio. Amazon Transcribe terminated processing. Type: Exception CallAnalyticsTranscriptResultStream API Version 2017-10-26 392 Amazon Transcribe HTTP Status Code: 500 Required: No LimitExceededException API Reference Your client has exceeded one of the Amazon Transcribe limits. This is typically the audio length limit. Break your audio stream into smaller chunks and try your request again. Type: Exception HTTP Status Code: 429 Required: No ServiceUnavailableException The service is currently unavailable. Try your request later. Type: Exception HTTP Status Code: 503 Required: No UtteranceEvent Contains set of transcription results from one or more audio segments, along with additional information per your request parameters. This can include information relating to channel deﬁnitions, partial result stabilization, sentiment, issue detection, and other transcription- related data. Type: UtteranceEvent object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 CallAnalyticsTranscriptResultStream API Version 2017-10-26 393 Amazon Transcribe API Reference CallAnalyticsTranscriptResultStream API Version 2017-10-26 394 Amazon Transcribe API Reference CategoryEvent Service: Amazon Transcribe Streaming Service Provides information on any TranscriptFilterType categories that matched your transcription output. Matches are identiﬁed for each segment upon completion of that segment. Contents MatchedCategories Lists the categories that were matched in your audio segment. Type: Array of strings Required: No MatchedDetails Contains information about the matched categories, including category names and timestamps. Type: String to PointsOfInterest object map Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 CategoryEvent API Version 2017-10-26 395 Amazon Transcribe
transcribe-api-093	transcribe-api.pdf	93	any TranscriptFilterType categories that matched your transcription output. Matches are identiﬁed for each segment upon completion of that segment. Contents MatchedCategories Lists the categories that were matched in your audio segment. Type: Array of strings Required: No MatchedDetails Contains information about the matched categories, including category names and timestamps. Type: String to PointsOfInterest object map Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 CategoryEvent API Version 2017-10-26 395 Amazon Transcribe API Reference ChannelDeﬁnition Service: Amazon Transcribe Streaming Service Makes it possible to specify which speaker is on which audio channel. For example, if your agent is the ﬁrst participant to speak, you would set ChannelId to 0 (to indicate the ﬁrst channel) and ParticipantRole to AGENT (to indicate that it's the agent speaking). Contents ChannelId Specify the audio channel you want to deﬁne. Type: Integer Valid Range: Minimum value of 0. Maximum value of 1. Required: Yes ParticipantRole Specify the speaker you want to deﬁne. Omitting this parameter is equivalent to specifying both participants. Type: String Valid Values: AGENT \| CUSTOMER Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ChannelDeﬁnition API Version 2017-10-26 396 Amazon Transcribe API Reference CharacterOﬀsets Service: Amazon Transcribe Streaming Service Provides the location, using character count, in your transcript where a match is identiﬁed. For example, the location of an issue or a category match within a segment. Contents Begin Provides the character count of the ﬁrst character where a match is identiﬁed. For example, the ﬁrst character associated with an issue or a category match in a segment transcript. Type: Integer Required: No End Provides the character count of the last character where a match is identiﬁed. For example, the last character associated with an issue or a category match in a segment transcript. Type: Integer Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 CharacterOﬀsets API Version 2017-10-26 397 Amazon Transcribe API Reference ClinicalNoteGenerationResult Service: Amazon Transcribe Streaming Service The details for clinical note generation, including status, and output locations for clinical note and aggregated transcript if the analytics completed, or failure reason if the analytics failed. Contents ClinicalNoteOutputLocation Holds the Amazon S3 URI for the output Clinical Note. Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. Pattern: (s3://\|http(s)://).+ Required: No FailureReason If ClinicalNoteGenerationResult is FAILED, information about why it failed. Type: String Required: No Status The status of the clinical note generation. Possible Values: • IN_PROGRESS • FAILED • COMPLETED After audio streaming ﬁnishes, and you send a MedicalScribeSessionControlEvent event (with END_OF_SESSION as the Type), the status is set to IN_PROGRESS. If the status is COMPLETED, the analytics completed successfully, and you can ﬁnd the results at the locations speciﬁed in ClinicalNoteOutputLocation and TranscriptOutputLocation. If the status is FAILED, FailureReason provides details about the failure. ClinicalNoteGenerationResult API Version 2017-10-26 398 Amazon Transcribe Type: String API Reference Valid Values: IN_PROGRESS \| FAILED \| COMPLETED Required: No TranscriptOutputLocation Holds the Amazon S3 URI for the output Transcript. Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. Pattern: (s3://\|http(s)://).+ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ClinicalNoteGenerationResult API Version 2017-10-26 399 Amazon Transcribe API Reference ClinicalNoteGenerationSettings Service: Amazon Transcribe Streaming Service The output conﬁguration for aggregated transcript and clinical note generation. Contents OutputBucketName The name of the Amazon S3 bucket where you want the output of AWS HealthScribe post- stream analytics stored. Don't include the S3:// preﬁx of the speciﬁed bucket. HealthScribe outputs transcript and clinical note ﬁles under the preﬁx: S3://$output- bucket-name/healthscribe-streaming/session-id/post-stream-analytics/ clinical-notes The role ResourceAccessRoleArn speciﬁed in the MedicalScribeConfigurationEvent must have permission to use the speciﬁed location. You can change Amazon S3 permissions using the AWS Management Console. See also Permissions Required for IAM User Roles . Type: String Length Constraints: Maximum length of 64. Pattern: [a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9] Required: Yes NoteTemplate Specify one of the following templates to use for the clinical note summary. The default is HISTORY_AND_PHYSICAL. • HISTORY_AND_PHYSICAL: Provides summaries for key sections of the clinical documentation. Examples of sections include Chief Complaint, History of Present Illness, Review of Systems, Past Medical History, Assessment, and Plan. • GIRPP: Provides summaries based on the patients progress toward
transcribe-api-094	transcribe-api.pdf	94	the MedicalScribeConfigurationEvent must have permission to use the speciﬁed location. You can change Amazon S3 permissions using the AWS Management Console. See also Permissions Required for IAM User Roles . Type: String Length Constraints: Maximum length of 64. Pattern: [a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9] Required: Yes NoteTemplate Specify one of the following templates to use for the clinical note summary. The default is HISTORY_AND_PHYSICAL. • HISTORY_AND_PHYSICAL: Provides summaries for key sections of the clinical documentation. Examples of sections include Chief Complaint, History of Present Illness, Review of Systems, Past Medical History, Assessment, and Plan. • GIRPP: Provides summaries based on the patients progress toward goals. Examples of sections include Goal, Intervention, Response, Progress, and Plan. Type: String Valid Values: HISTORY_AND_PHYSICAL \| GIRPP ClinicalNoteGenerationSettings API Version 2017-10-26 400 Amazon Transcribe Required: No See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ClinicalNoteGenerationSettings API Version 2017-10-26 401 Amazon Transcribe API Reference ConﬁgurationEvent Service: Amazon Transcribe Streaming Service Allows you to set audio channel deﬁnitions and post-call analytics settings. Contents ChannelDeﬁnitions Indicates which speaker is on which audio channel. Type: Array of ChannelDeﬁnition objects Array Members: Fixed number of 2 items. Required: No PostCallAnalyticsSettings Provides additional optional settings for your Call Analytics post-call request, including encryption and output locations for your redacted transcript. PostCallAnalyticsSettings provides you with the same insights as a Call Analytics post- call transcription. Refer to Post-call analytics for more information on this feature. Type: PostCallAnalyticsSettings object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ConﬁgurationEvent API Version 2017-10-26 402 Amazon Transcribe API Reference Entity Service: Amazon Transcribe Streaming Service Contains entities identiﬁed as personally identiﬁable information (PII) in your transcription output, along with various associated attributes. Examples include category, conﬁdence score, type, stability score, and start and end times. Contents Category The category of information identiﬁed. The only category is PII. Type: String Required: No Conﬁdence The conﬁdence score associated with the identiﬁed PII entity in your audio. Conﬁdence scores are values between 0 and 1. A larger value indicates a higher probability that the identiﬁed entity correctly matches the entity spoken in your media. Type: Double Required: No Content The word or words identiﬁed as PII. Type: String Required: No EndTime The end time of the utterance that was identiﬁed as PII in seconds, with millisecond precision (e.g., 1.056) Type: Double Required: No Entity API Version 2017-10-26 403 Amazon Transcribe StartTime API Reference The start time of the utterance that was identiﬁed as PII in seconds, with millisecond precision (e.g., 1.056) Type: Double Required: No Type The type of PII identiﬁed. For example, NAME or CREDIT_DEBIT_NUMBER. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Entity API Version 2017-10-26 404 Amazon Transcribe API Reference IssueDetected Service: Amazon Transcribe Streaming Service Lists the issues that were identiﬁed in your audio segment. Contents CharacterOﬀsets Provides the timestamps that identify when in an audio segment the speciﬁed issue occurs. Type: CharacterOﬀsets object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 IssueDetected API Version 2017-10-26 405 Amazon Transcribe API Reference Item Service: Amazon Transcribe Streaming Service A word, phrase, or punctuation mark in your transcription output, along with various associated attributes, such as conﬁdence score, type, and start and end times. Contents Conﬁdence The conﬁdence score associated with a word or phrase in your transcript. Conﬁdence scores are values between 0 and 1. A larger value indicates a higher probability that the identiﬁed item correctly matches the item spoken in your media. Type: Double Required: No Content The word or punctuation that was transcribed. Type: String Required: No EndTime The end time of the transcribed item in seconds, with millisecond precision (e.g., 1.056) Type: Double Required: No Speaker If speaker partitioning is enabled, Speaker labels the speaker of the speciﬁed item. Type: String Required: No Stable If partial result stabilization is enabled, Stable indicates whether the speciﬁed item is stable (true) or if it may change when the segment is complete (false). Item API Version 2017-10-26 406 Amazon Transcribe Type: Boolean Required: No StartTime API Reference The start time of the transcribed item in seconds, with millisecond precision (e.g., 1.056) Type: Double Required: No Type The
transcribe-api-095	transcribe-api.pdf	95	Required: No EndTime The end time of the transcribed item in seconds, with millisecond precision (e.g., 1.056) Type: Double Required: No Speaker If speaker partitioning is enabled, Speaker labels the speaker of the speciﬁed item. Type: String Required: No Stable If partial result stabilization is enabled, Stable indicates whether the speciﬁed item is stable (true) or if it may change when the segment is complete (false). Item API Version 2017-10-26 406 Amazon Transcribe Type: Boolean Required: No StartTime API Reference The start time of the transcribed item in seconds, with millisecond precision (e.g., 1.056) Type: Double Required: No Type The type of item identiﬁed. Options are: PRONUNCIATION (spoken words) and PUNCTUATION. Type: String Valid Values: pronunciation \| punctuation Required: No VocabularyFilterMatch Indicates whether the speciﬁed item matches a word in the vocabulary ﬁlter included in your request. If true, there is a vocabulary ﬁlter match. Type: Boolean Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Item API Version 2017-10-26 407 Amazon Transcribe API Reference LanguageWithScore Service: Amazon Transcribe Streaming Service The language code that represents the language identiﬁed in your audio, including the associated conﬁdence score. If you enabled channel identiﬁcation in your request and each channel contained a diﬀerent language, you will have more than one LanguageWithScore result. Contents LanguageCode The language code of the identiﬁed language. Type: String Valid Values: en-US \| en-GB \| es-US \| fr-CA \| fr-FR \| en-AU \| it-IT \| de-DE \| pt-BR \| ja-JP \| ko-KR \| zh-CN \| th-TH \| es-ES \| ar-SA \| pt-PT \| ca-ES \| ar-AE \| hi-IN \| zh-HK \| nl-NL \| no-NO \| sv-SE \| pl-PL \| fi-FI \| zh-TW \| en-IN \| en-IE \| en-NZ \| en-AB \| en-ZA \| en-WL \| de-CH \| af-ZA \| eu-ES \| hr-HR \| cs-CZ \| da-DK \| fa-IR \| gl-ES \| el-GR \| he-IL \| id-ID \| lv-LV \| ms-MY \| ro-RO \| ru-RU \| sr-RS \| sk-SK \| so-SO \| tl-PH \| uk-UA \| vi-VN \| zu-ZA Required: No Score The conﬁdence score associated with the identiﬁed language code. Conﬁdence scores are values between zero and one; larger values indicate a higher conﬁdence in the identiﬁed language. Type: Double Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 LanguageWithScore API Version 2017-10-26 408 Amazon Transcribe • AWS SDK for Ruby V3 API Reference LanguageWithScore API Version 2017-10-26 409 Amazon Transcribe API Reference MedicalAlternative Service: Amazon Transcribe Streaming Service A list of possible alternative transcriptions for the input audio. Each alternative may contain one or more of Items, Entities, or Transcript. Contents Entities Contains entities identiﬁed as personal health information (PHI) in your transcription output. Type: Array of MedicalEntity objects Required: No Items Contains words, phrases, or punctuation marks in your transcription output. Type: Array of MedicalItem objects Required: No Transcript Contains transcribed text. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MedicalAlternative API Version 2017-10-26 410 Amazon Transcribe API Reference MedicalEntity Service: Amazon Transcribe Streaming Service Contains entities identiﬁed as personal health information (PHI) in your transcription output, along with various associated attributes. Examples include category, conﬁdence score, type, stability score, and start and end times. Contents Category The category of information identiﬁed. The only category is PHI. Type: String Required: No Conﬁdence The conﬁdence score associated with the identiﬁed PHI entity in your audio. Conﬁdence scores are values between 0 and 1. A larger value indicates a higher probability that the identiﬁed entity correctly matches the entity spoken in your media. Type: Double Required: No Content The word or words identiﬁed as PHI. Type: String Required: No EndTime The end time, in seconds, of the utterance that was identiﬁed as PHI. Type: Double Required: No MedicalEntity API Version 2017-10-26 411 Amazon Transcribe StartTime API Reference The start time, in seconds, of the utterance that was identiﬁed as PHI. Type: Double Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MedicalEntity API Version 2017-10-26 412 Amazon Transcribe API Reference MedicalItem Service: Amazon Transcribe Streaming Service A word, phrase, or punctuation mark in your transcription output, along with various associated attributes, such as conﬁdence score, type, and start and end times. Contents Conﬁdence The conﬁdence
transcribe-api-096	transcribe-api.pdf	96	StartTime API Reference The start time, in seconds, of the utterance that was identiﬁed as PHI. Type: Double Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MedicalEntity API Version 2017-10-26 412 Amazon Transcribe API Reference MedicalItem Service: Amazon Transcribe Streaming Service A word, phrase, or punctuation mark in your transcription output, along with various associated attributes, such as conﬁdence score, type, and start and end times. Contents Conﬁdence The conﬁdence score associated with a word or phrase in your transcript. Conﬁdence scores are values between 0 and 1. A larger value indicates a higher probability that the identiﬁed item correctly matches the item spoken in your media. Type: Double Required: No Content The word or punctuation that was transcribed. Type: String Required: No EndTime The end time, in seconds, of the transcribed item. Type: Double Required: No Speaker If speaker partitioning is enabled, Speaker labels the speaker of the speciﬁed item. Type: String Required: No StartTime The start time, in seconds, of the transcribed item. MedicalItem API Version 2017-10-26 413 Amazon Transcribe Type: Double Required: No Type API Reference The type of item identiﬁed. Options are: PRONUNCIATION (spoken words) and PUNCTUATION. Type: String Valid Values: pronunciation \| punctuation Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MedicalItem API Version 2017-10-26 414 Amazon Transcribe API Reference MedicalResult Service: Amazon Transcribe Streaming Service The Result associated with a MedicalTranscript . Contains a set of transcription results from one or more audio segments, along with additional information per your request parameters. This can include information relating to alternative transcriptions, channel identiﬁcation, partial result stabilization, language identiﬁcation, and other transcription-related data. Contents Alternatives A list of possible alternative transcriptions for the input audio. Each alternative may contain one or more of Items, Entities, or Transcript. Type: Array of MedicalAlternative objects Required: No ChannelId Indicates the channel identiﬁed for the Result. Type: String Required: No EndTime The end time, in seconds, of the Result. Type: Double Required: No IsPartial Indicates if the segment is complete. If IsPartial is true, the segment is not complete. If IsPartial is false, the segment is complete. MedicalResult API Version 2017-10-26 415 API Reference Amazon Transcribe Type: Boolean Required: No ResultId Provides a unique identiﬁer for the Result. Type: String Required: No StartTime The start time, in seconds, of the Result. Type: Double Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MedicalResult API Version 2017-10-26 416 Amazon Transcribe API Reference MedicalScribeAudioEvent Service: Amazon Transcribe Streaming Service A wrapper for your audio chunks For more information, see Event stream encoding. Contents AudioChunk An audio blob containing the next segment of audio from your application, with a maximum duration of 1 second. The maximum size in bytes varies based on audio properties. Find recommended size in Transcribing streaming best practices. Size calculation: Duration (s) * Sample Rate (Hz) * Number of Channels * 2 (Bytes per Sample) For example, a 1-second chunk of 16 kHz, 2-channel, 16-bit audio would be 1 * 16000 * 2 * 2 = 64000 bytes. For 8 kHz, 1-channel, 16-bit audio, a 1-second chunk would be 1 * 8000 * 1 * 2 = 16000 bytes. Type: Base64-encoded binary data object Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MedicalScribeAudioEvent API Version 2017-10-26 417 Amazon Transcribe API Reference MedicalScribeChannelDeﬁnition Service: Amazon Transcribe Streaming Service Makes it possible to specify which speaker is on which channel. For example, if the clinician is the ﬁrst participant to speak, you would set the ChannelId of the ﬁrst ChannelDefinition in the list to 0 (to indicate the ﬁrst channel) and ParticipantRole to CLINICIAN (to indicate that it's the clinician speaking). Then you would set the ChannelId of the second ChannelDefinition in the list to 1 (to indicate the second channel) and ParticipantRole to PATIENT (to indicate that it's the patient speaking). If you don't specify a channel deﬁnition, HealthScribe will diarize the transcription and identify speaker roles for each speaker. Contents ChannelId Specify the audio channel you want to deﬁne. Type: Integer Valid Range: Minimum value of 0. Maximum value of 1. Required: Yes ParticipantRole Specify the participant that you want
transcribe-api-097	transcribe-api.pdf	97	list to 0 (to indicate the ﬁrst channel) and ParticipantRole to CLINICIAN (to indicate that it's the clinician speaking). Then you would set the ChannelId of the second ChannelDefinition in the list to 1 (to indicate the second channel) and ParticipantRole to PATIENT (to indicate that it's the patient speaking). If you don't specify a channel deﬁnition, HealthScribe will diarize the transcription and identify speaker roles for each speaker. Contents ChannelId Specify the audio channel you want to deﬁne. Type: Integer Valid Range: Minimum value of 0. Maximum value of 1. Required: Yes ParticipantRole Specify the participant that you want to ﬂag. The allowed options are CLINICIAN and PATIENT. Type: String Valid Values: PATIENT \| CLINICIAN Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ MedicalScribeChannelDeﬁnition API Version 2017-10-26 418 Amazon Transcribe • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference MedicalScribeChannelDeﬁnition API Version 2017-10-26 419 Amazon Transcribe API Reference MedicalScribeConﬁgurationEvent Service: Amazon Transcribe Streaming Service Specify details to conﬁgure the streaming session, including channel deﬁnitions, encryption settings, post-stream analytics settings, resource access role ARN and vocabulary settings. Whether you are starting a new session or resuming an existing session, your ﬁrst event must be a MedicalScribeConfigurationEvent. If you are resuming a session, then this event must have the same conﬁgurations that you provided to start the session. Contents PostStreamAnalyticsSettings Specify settings for post-stream analytics. Type: MedicalScribePostStreamAnalyticsSettings object Required: Yes ResourceAccessRoleArn The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 output bucket you speciﬁed, and use your AWS KMS key if supplied. If the role that you specify doesn’t have the appropriate permissions, your request fails. IAM role ARNs have the format arn:partition:iam::account:role/role-name-with- path. For example: arn:aws:iam::111122223333:role/Admin. For more information, see AWS HealthScribe. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso-{0,1}[a-z]{0,1}):iam::[0-9] {0,63}:role/[A-Za-z0-9:_/+=,@.-]{0,1024}$ Required: Yes ChannelDeﬁnitions Specify which speaker is on which audio channel. MedicalScribeConﬁgurationEvent API Version 2017-10-26 420 Amazon Transcribe API Reference Type: Array of MedicalScribeChannelDeﬁnition objects Array Members: Fixed number of 2 items. Required: No EncryptionSettings Specify the encryption settings for your streaming session. Type: MedicalScribeEncryptionSettings object Required: No VocabularyFilterMethod Specify how you want your custom vocabulary ﬁlter applied to the streaming session. To replace words with ***, specify mask. To delete words, specify remove. To ﬂag words without changing them, specify tag. Type: String Valid Values: remove \| mask \| tag Required: No VocabularyFilterName Specify the name of the custom vocabulary ﬁlter you want to include in your streaming session. Custom vocabulary ﬁlter names are case-sensitive. If you include VocabularyFilterName in the MedicalScribeConfigurationEvent, you must also include VocabularyFilterMethod. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: No MedicalScribeConﬁgurationEvent API Version 2017-10-26 421 Amazon Transcribe VocabularyName API Reference Specify the name of the custom vocabulary you want to use for your streaming session. Custom vocabulary names are case-sensitive. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MedicalScribeConﬁgurationEvent API Version 2017-10-26 422 Amazon Transcribe API Reference MedicalScribeEncryptionSettings Service: Amazon Transcribe Streaming Service Contains encryption related settings to be used for data encryption with AWS Key Management Service, including KmsEncryptionContext and KmsKeyId. The KmsKeyId is required, while KmsEncryptionContext is optional for additional layer of security. By default, AWS HealthScribe provides encryption at rest to protect sensitive customer data using Amazon S3-managed keys. HealthScribe uses the KMS key you specify as a second layer of encryption. Your ResourceAccessRoleArn must permission to use your KMS key. For more information, see Data Encryption at rest for AWS HealthScribe. Contents KmsKeyId The ID of the KMS key you want to use for your streaming session. You can specify its KMS key ID, key Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, preﬁx it with "alias/". To specify a KMS key in a diﬀerent AWS account, you must use the key ARN or alias ARN. For example: • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab • Key ARN: arn:aws:kms:us- east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab • Alias name: alias/ExampleAlias • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias To get the key ID and key ARN for a KMS key, use the ListKeys or DescribeKey KMS API operations. To get the alias name and alias ARN, use ListKeys API operation. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$ Required: Yes MedicalScribeEncryptionSettings API Version 2017-10-26 423 Amazon Transcribe KmsEncryptionContext API Reference A map of plain text, non-secret key:value pairs, known as encryption
transcribe-api-098	transcribe-api.pdf	98	diﬀerent AWS account, you must use the key ARN or alias ARN. For example: • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab • Key ARN: arn:aws:kms:us- east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab • Alias name: alias/ExampleAlias • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias To get the key ID and key ARN for a KMS key, use the ListKeys or DescribeKey KMS API operations. To get the alias name and alias ARN, use ListKeys API operation. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$ Required: Yes MedicalScribeEncryptionSettings API Version 2017-10-26 423 Amazon Transcribe KmsEncryptionContext API Reference 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 AWS KMSencryption context and Asymmetric keys in AWS KMS. Type: String to string map Map Entries: Maximum number of 10 items. Key Length Constraints: Minimum length of 1. Maximum length of 2000. Key Pattern: .\S. Value Length Constraints: Minimum length of 1. Maximum length of 2000. Value Pattern: .\S. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MedicalScribeEncryptionSettings API Version 2017-10-26 424 Amazon Transcribe API Reference MedicalScribeInputStream Service: Amazon Transcribe Streaming Service An encoded stream of events. The stream is encoded as HTTP/2 data frames. An input stream consists of the following types of events. The ﬁrst element of the input stream must be the MedicalScribeConfigurationEvent event type. • MedicalScribeConfigurationEvent • MedicalScribeAudioEvent • MedicalScribeSessionControlEvent Contents AudioEvent A wrapper for your audio chunks For more information, see Event stream encoding. Type: MedicalScribeAudioEvent object Required: No ConﬁgurationEvent Specify additional streaming session conﬁgurations beyond those provided in your initial start request headers. For example, specify channel deﬁnitions, encryption settings, and post-stream analytics settings. Whether you are starting a new session or resuming an existing session, your ﬁrst event must be a MedicalScribeConfigurationEvent. Type: MedicalScribeConﬁgurationEvent object Required: No SessionControlEvent Specify the lifecycle of your streaming session, such as ending the session. Type: MedicalScribeSessionControlEvent object MedicalScribeInputStream API Version 2017-10-26 425 Amazon Transcribe Required: No See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MedicalScribeInputStream API Version 2017-10-26 426 Amazon Transcribe API Reference MedicalScribePostStreamAnalyticsResult Service: Amazon Transcribe Streaming Service Contains details for the result of post-stream analytics. Contents ClinicalNoteGenerationResult Provides the Clinical Note Generation result for post-stream analytics. Type: ClinicalNoteGenerationResult object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MedicalScribePostStreamAnalyticsResult API Version 2017-10-26 427 Amazon Transcribe API Reference MedicalScribePostStreamAnalyticsSettings Service: Amazon Transcribe Streaming Service The settings for post-stream analytics. Contents ClinicalNoteGenerationSettings Specify settings for the post-stream clinical note generation. Type: ClinicalNoteGenerationSettings object Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MedicalScribePostStreamAnalyticsSettings API Version 2017-10-26 428 Amazon Transcribe API Reference MedicalScribeResultStream Service: Amazon Transcribe Streaming Service Result stream where you will receive the output events. The details are provided in the MedicalScribeTranscriptEvent object. Contents BadRequestException One or more arguments to the StartStreamTranscription, StartMedicalStreamTranscription, or StartCallAnalyticsStreamTranscription operation was not valid. For example, MediaEncoding or LanguageCode used unsupported values. Check the speciﬁed parameters and try your request again. Type: Exception HTTP Status Code: 400 Required: No ConﬂictException A new stream started with the same session ID. The current stream has been terminated. Type: Exception HTTP Status Code: 409 Required: No InternalFailureException A problem occurred while processing the audio. Amazon Transcribe terminated processing. Type: Exception HTTP Status Code: 500 Required: No LimitExceededException Your client has exceeded one of the Amazon Transcribe limits. This is typically the audio length limit. Break your audio stream into smaller chunks and try your request again. Type: Exception MedicalScribeResultStream API Version 2017-10-26 429 API Reference Amazon Transcribe HTTP Status Code: 429 Required: No ServiceUnavailableException The service is currently unavailable. Try your request later. Type: Exception HTTP Status Code: 503 Required: No TranscriptEvent The transcript event that contains real-time transcription results. Type: MedicalScribeTranscriptEvent object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MedicalScribeResultStream API Version 2017-10-26 430 Amazon Transcribe API Reference MedicalScribeSessionControlEvent Service: Amazon Transcribe Streaming Service Specify the lifecycle of your streaming session. Contents Type The type of MedicalScribeSessionControlEvent. Possible
transcribe-api-099	transcribe-api.pdf	99	429 Required: No ServiceUnavailableException The service is currently unavailable. Try your request later. Type: Exception HTTP Status Code: 503 Required: No TranscriptEvent The transcript event that contains real-time transcription results. Type: MedicalScribeTranscriptEvent object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MedicalScribeResultStream API Version 2017-10-26 430 Amazon Transcribe API Reference MedicalScribeSessionControlEvent Service: Amazon Transcribe Streaming Service Specify the lifecycle of your streaming session. Contents Type The type of MedicalScribeSessionControlEvent. Possible Values: • END_OF_SESSION - Indicates the audio streaming is complete. After you send an END_OF_SESSION event, AWS HealthScribe starts the post-stream analytics. The session can't be resumed after this event is sent. After AWS HealthScribe processes the event, the real-time StreamStatus is COMPLETED. You get the StreamStatus and other stream details with the GetMedicalScribeStream API operation. For more information about diﬀerent streaming statuses, see the StreamStatus description in the MedicalScribeStreamDetails. Type: String Valid Values: END_OF_SESSION Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MedicalScribeSessionControlEvent API Version 2017-10-26 431 Amazon Transcribe API Reference MedicalScribeStreamDetails Service: Amazon Transcribe Streaming Service Contains details about a AWS HealthScribe streaming session. Contents ChannelDeﬁnitions The Channel Deﬁnitions of the HealthScribe streaming session. Type: Array of MedicalScribeChannelDeﬁnition objects Array Members: Fixed number of 2 items. Required: No EncryptionSettings The Encryption Settings of the HealthScribe streaming session. Type: MedicalScribeEncryptionSettings object Required: No LanguageCode The Language Code of the HealthScribe streaming session. Type: String Valid Values: en-US Required: No MediaEncoding The Media Encoding of the HealthScribe streaming session. Type: String Valid Values: pcm \| ogg-opus \| flac Required: No MedicalScribeStreamDetails API Version 2017-10-26 432 Amazon Transcribe MediaSampleRateHertz API Reference The sample rate (in hertz) of the HealthScribe streaming session. Type: Integer Valid Range: Minimum value of 16000. Maximum value of 48000. Required: No PostStreamAnalyticsResult The result of post-stream analytics for the HealthScribe streaming session. Type: MedicalScribePostStreamAnalyticsResult object Required: No PostStreamAnalyticsSettings The post-stream analytics settings of the HealthScribe streaming session. Type: MedicalScribePostStreamAnalyticsSettings object Required: No ResourceAccessRoleArn The Amazon Resource Name (ARN) of the role used in the HealthScribe streaming session. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso-{0,1}[a-z]{0,1}):iam::[0-9] {0,63}:role/[A-Za-z0-9:_/+=,@.-]{0,1024}$ Required: No SessionId The identiﬁer of the HealthScribe streaming session. Type: String Length Constraints: Fixed length of 36. MedicalScribeStreamDetails API Version 2017-10-26 433 Amazon Transcribe API Reference Pattern: [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA- F0-9]{12} Required: No StreamCreatedAt The date and time when the HealthScribe streaming session was created. Type: Timestamp Required: No StreamEndedAt The date and time when the HealthScribe streaming session was ended. Type: Timestamp Required: No StreamStatus The streaming status of the HealthScribe streaming session. Possible Values: • IN_PROGRESS • PAUSED • FAILED • COMPLETED Note This status is speciﬁc to real-time streaming. A COMPLETED status doesn't mean that the post-stream analytics is complete. To get status of an analytics result, check the Status ﬁeld for the analytics result within the MedicalScribePostStreamAnalyticsResult. For example, you can view the status of the ClinicalNoteGenerationResult. Type: String MedicalScribeStreamDetails API Version 2017-10-26 434 Amazon Transcribe API Reference Valid Values: IN_PROGRESS \| PAUSED \| FAILED \| COMPLETED Required: No VocabularyFilterMethod The method of the vocabulary ﬁlter for the HealthScribe streaming session. Type: String Valid Values: remove \| mask \| tag Required: No VocabularyFilterName The name of the vocabulary ﬁlter used for the HealthScribe streaming session . Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: No VocabularyName The vocabulary name of the HealthScribe streaming session. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ MedicalScribeStreamDetails API Version 2017-10-26 435 Amazon Transcribe • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference MedicalScribeStreamDetails API Version 2017-10-26 436 Amazon Transcribe API Reference MedicalScribeTranscriptEvent Service: Amazon Transcribe Streaming Service The event associated with MedicalScribeResultStream. Contains MedicalScribeTranscriptSegment, which contains segment related information. Contents TranscriptSegment The TranscriptSegment associated with a MedicalScribeTranscriptEvent. Type: MedicalScribeTranscriptSegment object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MedicalScribeTranscriptEvent API Version 2017-10-26 437 Amazon Transcribe API Reference MedicalScribeTranscriptItem Service: Amazon Transcribe Streaming Service A word, phrase, or punctuation mark in your transcription output, along with various associated attributes, such as conﬁdence score, type, and start and end times. Contents BeginAudioTime The start
transcribe-api-100	transcribe-api.pdf	100	Contains MedicalScribeTranscriptSegment, which contains segment related information. Contents TranscriptSegment The TranscriptSegment associated with a MedicalScribeTranscriptEvent. Type: MedicalScribeTranscriptSegment object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MedicalScribeTranscriptEvent API Version 2017-10-26 437 Amazon Transcribe API Reference MedicalScribeTranscriptItem Service: Amazon Transcribe Streaming Service A word, phrase, or punctuation mark in your transcription output, along with various associated attributes, such as conﬁdence score, type, and start and end times. Contents BeginAudioTime The start time, in milliseconds, of the transcribed item. Type: Double Required: No Conﬁdence The conﬁdence score associated with a word or phrase in your transcript. Conﬁdence scores are values between 0 and 1. A larger value indicates a higher probability that the identiﬁed item correctly matches the item spoken in your media. Type: Double Required: No Content The word, phrase or punctuation mark that was transcribed. Type: String Required: No EndAudioTime The end time, in milliseconds, of the transcribed item. Type: Double Required: No Type The type of item identiﬁed. Options are: PRONUNCIATION (spoken words) and PUNCTUATION. MedicalScribeTranscriptItem API Version 2017-10-26 438 Amazon Transcribe Type: String Valid Values: pronunciation \| punctuation Required: No VocabularyFilterMatch API Reference Indicates whether the speciﬁed item matches a word in the vocabulary ﬁlter included in your conﬁguration event. If true, there is a vocabulary ﬁlter match. Type: Boolean Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MedicalScribeTranscriptItem API Version 2017-10-26 439 Amazon Transcribe API Reference MedicalScribeTranscriptSegment Service: Amazon Transcribe Streaming Service Contains a set of transcription results, along with additional information of the segment. Contents BeginAudioTime The start time, in milliseconds, of the segment. Type: Double Required: No ChannelId Indicates which audio channel is associated with the MedicalScribeTranscriptSegment. If MedicalScribeChannelDefinition is not provided in the MedicalScribeConfigurationEvent, then this ﬁeld will not be included. Type: String Required: No Content Contains transcribed text of the segment. Type: String Required: No EndAudioTime The end time, in milliseconds, of the segment. Type: Double Required: No IsPartial Indicates if the segment is complete. MedicalScribeTranscriptSegment API Version 2017-10-26 440 Amazon Transcribe API Reference If IsPartial is true, the segment is not complete. If IsPartial is false, the segment is complete. Type: Boolean Required: No Items Contains words, phrases, or punctuation marks in your segment. Type: Array of MedicalScribeTranscriptItem objects Required: No SegmentId The identiﬁer of the segment. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MedicalScribeTranscriptSegment API Version 2017-10-26 441 Amazon Transcribe API Reference MedicalTranscript Service: Amazon Transcribe Streaming Service The MedicalTranscript associated with a MedicalTranscriptEvent . MedicalTranscript contains Results, which contains a set of transcription results from one or more audio segments, along with additional information per your request parameters. Contents Results Contains a set of transcription results from one or more audio segments, along with additional information per your request parameters. This can include information relating to alternative transcriptions, channel identiﬁcation, partial result stabilization, language identiﬁcation, and other transcription-related data. Type: Array of MedicalResult objects Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MedicalTranscript API Version 2017-10-26 442 Amazon Transcribe API Reference MedicalTranscriptEvent Service: Amazon Transcribe Streaming Service The MedicalTranscriptEvent associated with a MedicalTranscriptResultStream. Contains a set of transcription results from one or more audio segments, along with additional information per your request parameters. Contents Transcript Contains Results, which contains a set of transcription results from one or more audio segments, along with additional information per your request parameters. This can include information relating to alternative transcriptions, channel identiﬁcation, partial result stabilization, language identiﬁcation, and other transcription-related data. Type: MedicalTranscript object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MedicalTranscriptEvent API Version 2017-10-26 443 Amazon Transcribe API Reference MedicalTranscriptResultStream Service: Amazon Transcribe Streaming Service Contains detailed information about your streaming session. Contents BadRequestException One or more arguments to the StartStreamTranscription, StartMedicalStreamTranscription, or StartCallAnalyticsStreamTranscription operation was not valid. For example, MediaEncoding or LanguageCode used unsupported values. Check the speciﬁed parameters and try your request again. Type: Exception HTTP Status Code: 400 Required: No ConﬂictException A new stream started with
transcribe-api-101	transcribe-api.pdf	101	about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MedicalTranscriptEvent API Version 2017-10-26 443 Amazon Transcribe API Reference MedicalTranscriptResultStream Service: Amazon Transcribe Streaming Service Contains detailed information about your streaming session. Contents BadRequestException One or more arguments to the StartStreamTranscription, StartMedicalStreamTranscription, or StartCallAnalyticsStreamTranscription operation was not valid. For example, MediaEncoding or LanguageCode used unsupported values. Check the speciﬁed parameters and try your request again. Type: Exception HTTP Status Code: 400 Required: No ConﬂictException A new stream started with the same session ID. The current stream has been terminated. Type: Exception HTTP Status Code: 409 Required: No InternalFailureException A problem occurred while processing the audio. Amazon Transcribe terminated processing. Type: Exception HTTP Status Code: 500 Required: No LimitExceededException Your client has exceeded one of the Amazon Transcribe limits. This is typically the audio length limit. Break your audio stream into smaller chunks and try your request again. Type: Exception MedicalTranscriptResultStream API Version 2017-10-26 444 API Reference Amazon Transcribe HTTP Status Code: 429 Required: No ServiceUnavailableException The service is currently unavailable. Try your request later. Type: Exception HTTP Status Code: 503 Required: No TranscriptEvent The MedicalTranscriptEvent associated with a MedicalTranscriptResultStream. Contains a set of transcription results from one or more audio segments, along with additional information per your request parameters. This can include information relating to alternative transcriptions, channel identiﬁcation, partial result stabilization, language identiﬁcation, and other transcription-related data. Type: MedicalTranscriptEvent object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MedicalTranscriptResultStream API Version 2017-10-26 445 Amazon Transcribe API Reference PointsOfInterest Service: Amazon Transcribe Streaming Service Contains the timestamps of matched categories. Contents TimestampRanges Contains the timestamp ranges (start time through end time) of matched categories and rules. Type: Array of TimestampRange objects Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 PointsOfInterest API Version 2017-10-26 446 Amazon Transcribe API Reference PostCallAnalyticsSettings Service: Amazon Transcribe Streaming Service Allows you to specify additional settings for your Call Analytics post-call request, including output locations for your redacted transcript, which IAM role to use, and which encryption key to use. DataAccessRoleArn and OutputLocation are required ﬁelds. PostCallAnalyticsSettings provides you with the same insights as a Call Analytics post-call transcription. Refer to Post-call analytics for more information on this feature. Contents DataAccessRoleArn The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input ﬁles. If the role that you specify doesn’t have the appropriate permissions to access the speciﬁed Amazon S3 location, your request fails. IAM role ARNs have the format arn:partition:iam::account:role/role-name-with- path. For example: arn:aws:iam::111122223333:role/Admin. For more information, see IAM ARNs. Type: String Required: Yes OutputLocation The Amazon S3 location where you want your Call Analytics post-call transcription output stored. You can use any of the following formats to specify the output location: 1. s3://DOC-EXAMPLE-BUCKET 2. s3://DOC-EXAMPLE-BUCKET/my-output-folder/ 3. s3://DOC-EXAMPLE-BUCKET/my-output-folder/my-call-analytics-job.json Type: String Required: Yes PostCallAnalyticsSettings API Version 2017-10-26 447 Amazon Transcribe ContentRedactionOutput API Reference Specify whether you want only a redacted transcript or both a redacted and an unredacted transcript. If you choose redacted and unredacted, two JSON ﬁles are generated and stored in the Amazon S3 output location you specify. Note that to include ContentRedactionOutput in your request, you must enable content redaction (ContentRedactionType). Type: String Valid Values: redacted \| redacted_and_unredacted Required: No OutputEncryptionKMSKeyId The KMS key you want to use to encrypt your Call Analytics post-call output. If using a key located in the current AWS account, you can specify your KMS key in one of four ways: 1. Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. 2. Use an alias for the KMS key ID. For example, alias/ExampleAlias. 3. Use the Amazon Resource Name (ARN) for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. 4. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account- ID:alias/ExampleAlias. If using a key located in a diﬀerent AWS account than the current AWS account, you can specify your KMS key in one of two ways: 1. Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account- ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. 2. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account- ID:alias/ExampleAlias. Note that the role making the StartCallAnalyticsStreamTranscription request must have permission to use the speciﬁed KMS key. Type: String PostCallAnalyticsSettings API Version 2017-10-26 448 Amazon Transcribe Required: No See Also API Reference For more information about using this API in one of the
transcribe-api-102	transcribe-api.pdf	102	alias. For example, arn:aws:kms:region:account- ID:alias/ExampleAlias. If using a key located in a diﬀerent AWS account than the current AWS account, you can specify your KMS key in one of two ways: 1. Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account- ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. 2. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account- ID:alias/ExampleAlias. Note that the role making the StartCallAnalyticsStreamTranscription request must have permission to use the speciﬁed KMS key. Type: String PostCallAnalyticsSettings API Version 2017-10-26 448 Amazon Transcribe Required: No See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 PostCallAnalyticsSettings API Version 2017-10-26 449 Amazon Transcribe API Reference Result Service: Amazon Transcribe Streaming Service The Result associated with a Transcript . Contains a set of transcription results from one or more audio segments, along with additional information per your request parameters. This can include information relating to alternative transcriptions, channel identiﬁcation, partial result stabilization, language identiﬁcation, and other transcription-related data. Contents Alternatives A list of possible alternative transcriptions for the input audio. Each alternative may contain one or more of Items, Entities, or Transcript. Type: Array of Alternative objects Required: No ChannelId Indicates which audio channel is associated with the Result. Type: String Required: No EndTime The end time of the Result in seconds, with millisecond precision (e.g., 1.056). Type: Double Required: No IsPartial Indicates if the segment is complete. If IsPartial is true, the segment is not complete. If IsPartial is false, the segment is complete. Result API Version 2017-10-26 450 Amazon Transcribe Type: Boolean Required: No LanguageCode API Reference The language code that represents the language spoken in your audio stream. Type: String Valid Values: en-US \| en-GB \| es-US \| fr-CA \| fr-FR \| en-AU \| it-IT \| de-DE \| pt-BR \| ja-JP \| ko-KR \| zh-CN \| th-TH \| es-ES \| ar-SA \| pt-PT \| ca-ES \| ar-AE \| hi-IN \| zh-HK \| nl-NL \| no-NO \| sv-SE \| pl-PL \| fi-FI \| zh-TW \| en-IN \| en-IE \| en-NZ \| en-AB \| en-ZA \| en-WL \| de-CH \| af-ZA \| eu-ES \| hr-HR \| cs-CZ \| da-DK \| fa-IR \| gl-ES \| el-GR \| he-IL \| id-ID \| lv-LV \| ms-MY \| ro-RO \| ru-RU \| sr-RS \| sk-SK \| so-SO \| tl-PH \| uk-UA \| vi-VN \| zu-ZA Required: No LanguageIdentiﬁcation The language code of the dominant language identiﬁed in your stream. If you enabled channel identiﬁcation and each channel of your audio contains a diﬀerent language, you may have more than one result. Type: Array of LanguageWithScore objects Required: No ResultId Provides a unique identiﬁer for the Result. Type: String Required: No StartTime The start time of the Result in seconds, with millisecond precision (e.g., 1.056). Type: Double Result API Version 2017-10-26 451 Amazon Transcribe Required: No See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Result API Version 2017-10-26 452 Amazon Transcribe API Reference TimestampRange Service: Amazon Transcribe Streaming Service Contains the timestamp range (start time through end time) of a matched category. Contents BeginOﬀsetMillis The time, in milliseconds, from the beginning of the audio stream to the start of the category match. Type: Long Required: No EndOﬀsetMillis The time, in milliseconds, from the beginning of the audio stream to the end of the category match. Type: Long Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 TimestampRange API Version 2017-10-26 453 Amazon Transcribe API Reference Transcript Service: Amazon Transcribe Streaming Service The Transcript associated with a TranscriptEvent . Transcript contains Results, which contains a set of transcription results from one or more audio segments, along with additional information per your request parameters. Contents Results Contains a set of transcription results from one or more audio segments, along with additional information per your request parameters. This can include information relating to alternative transcriptions, channel identiﬁcation, partial result stabilization, language identiﬁcation, and other transcription-related data. Type: Array of Result objects Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Transcript API Version 2017-10-26 454 Amazon Transcribe API Reference TranscriptEvent Service: Amazon Transcribe Streaming Service The TranscriptEvent associated with a TranscriptResultStream. Contains a set of transcription results from one or more audio segments,
transcribe-api-103	transcribe-api.pdf	103	information per your request parameters. This can include information relating to alternative transcriptions, channel identiﬁcation, partial result stabilization, language identiﬁcation, and other transcription-related data. Type: Array of Result objects Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Transcript API Version 2017-10-26 454 Amazon Transcribe API Reference TranscriptEvent Service: Amazon Transcribe Streaming Service The TranscriptEvent associated with a TranscriptResultStream. Contains a set of transcription results from one or more audio segments, along with additional information per your request parameters. Contents Transcript Contains Results, which contains a set of transcription results from one or more audio segments, along with additional information per your request parameters. This can include information relating to alternative transcriptions, channel identiﬁcation, partial result stabilization, language identiﬁcation, and other transcription-related data. Type: Transcript object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 TranscriptEvent API Version 2017-10-26 455 Amazon Transcribe API Reference TranscriptResultStream Service: Amazon Transcribe Streaming Service Contains detailed information about your streaming session. Contents BadRequestException A client error occurred when the stream was created. Check the parameters of the request and try your request again. Type: Exception HTTP Status Code: 400 Required: No ConﬂictException A new stream started with the same session ID. The current stream has been terminated. Type: Exception HTTP Status Code: 409 Required: No InternalFailureException A problem occurred while processing the audio. Amazon Transcribe terminated processing. Type: Exception HTTP Status Code: 500 Required: No LimitExceededException Your client has exceeded one of the Amazon Transcribe limits. This is typically the audio length limit. Break your audio stream into smaller chunks and try your request again. Type: Exception HTTP Status Code: 429 Required: No TranscriptResultStream API Version 2017-10-26 456 Amazon Transcribe ServiceUnavailableException The service is currently unavailable. Try your request later. API Reference Type: Exception HTTP Status Code: 503 Required: No TranscriptEvent Contains Transcript, which contains Results. The Result object contains a set of transcription results from one or more audio segments, along with additional information per your request parameters. Type: TranscriptEvent object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 TranscriptResultStream API Version 2017-10-26 457 Amazon Transcribe API Reference UtteranceEvent Service: Amazon Transcribe Streaming Service Contains set of transcription results from one or more audio segments, along with additional information about the parameters included in your request. For example, channel deﬁnitions, partial result stabilization, sentiment, and issue detection. Contents BeginOﬀsetMillis The time, in milliseconds, from the beginning of the audio stream to the start of the UtteranceEvent. Type: Long Required: No EndOﬀsetMillis The time, in milliseconds, from the beginning of the audio stream to the start of the UtteranceEvent. Type: Long Required: No Entities Contains entities identiﬁed as personally identiﬁable information (PII) in your transcription output. Type: Array of CallAnalyticsEntity objects Required: No IsPartial Indicates whether the segment in the UtteranceEvent is complete (FALSE) or partial (TRUE). Type: Boolean Required: No UtteranceEvent API Version 2017-10-26 458 Amazon Transcribe IssuesDetected API Reference Provides the issue that was detected in the speciﬁed segment. Type: Array of IssueDetected objects Required: No Items Contains words, phrases, or punctuation marks that are associated with the speciﬁed UtteranceEvent. Type: Array of CallAnalyticsItem objects Required: No ParticipantRole Provides the role of the speaker for each audio channel, either CUSTOMER or AGENT. Type: String Valid Values: AGENT \| CUSTOMER Required: No Sentiment Provides the sentiment that was detected in the speciﬁed segment. Type: String Valid Values: POSITIVE \| NEGATIVE \| MIXED \| NEUTRAL Required: No Transcript Contains transcribed text. Type: String Required: No UtteranceId The unique identiﬁer that is associated with the speciﬁed UtteranceEvent. UtteranceEvent API Version 2017-10-26 459 Amazon Transcribe Type: String Required: No See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 UtteranceEvent API Version 2017-10-26 460 Amazon Transcribe API Reference Common Parameters The following list contains the parameters that all actions use for signing Signature Version 4 requests with a query string. Any action-speciﬁc parameters are listed in the topic for that action. For more information about Signature Version 4, see Signing AWS API requests in the IAM User Guide. Action The action to be performed. Type: string Required: Yes Version The API version that the request is written for, expressed in
transcribe-api-104	transcribe-api.pdf	104	the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 UtteranceEvent API Version 2017-10-26 460 Amazon Transcribe API Reference Common Parameters The following list contains the parameters that all actions use for signing Signature Version 4 requests with a query string. Any action-speciﬁc parameters are listed in the topic for that action. For more information about Signature Version 4, see Signing AWS API requests in the IAM User Guide. Action The action to be performed. Type: string Required: Yes Version The API version that the request is written for, expressed in the format YYYY-MM-DD. Type: string Required: Yes X-Amz-Algorithm The hash algorithm that you used to create the request signature. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Valid Values: AWS4-HMAC-SHA256 Required: Conditional X-Amz-Credential The credential scope value, which is a string that includes your access key, the date, the region you are targeting, the service you are requesting, and a termination string ("aws4_request"). The value is expressed in the following format: access_key/YYYYMMDD/region/service/ aws4_request. API Version 2017-10-26 461 Amazon Transcribe API Reference For more information, see Create a signed AWS API request in the IAM User Guide. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional X-Amz-Date The date that is used to create the signature. The format must be ISO 8601 basic format (YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value: 20120325T120000Z. Condition: X-Amz-Date is optional for all requests; it can be used to override the date used for signing requests. If the Date header is speciﬁed in the ISO 8601 basic format, X-Amz-Date is not required. When X-Amz-Date is used, it always overrides the value of the Date header. For more information, see Elements of an AWS API request signature in the IAM User Guide. Type: string Required: Conditional X-Amz-Security-Token The temporary security token that was obtained through a call to AWS Security Token Service (AWS STS). For a list of services that support temporary security credentials from AWS STS, see AWS services that work with IAM in the IAM User Guide. Condition: If you're using temporary security credentials from AWS STS, you must include the security token. Type: string Required: Conditional X-Amz-Signature Speciﬁes the hex-encoded signature that was calculated from the string to sign and the derived signing key. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. API Version 2017-10-26 462 Amazon Transcribe Type: string Required: Conditional X-Amz-SignedHeaders API Reference Speciﬁes all the HTTP headers that were included as part of the canonical request. For more information about specifying signed headers, see Create a signed AWS API request in the IAM User Guide. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional API Version 2017-10-26 463 Amazon Transcribe API Reference Common Errors This section lists the errors common to the API actions of all AWS services. For errors speciﬁc to an API action for this service, see the topic for that API action. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 400 IncompleteSignature The request signature does not conform to AWS standards. HTTP Status Code: 400 InternalFailure The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 InvalidAction The action or operation requested is invalid. Verify that the action is typed correctly. HTTP Status Code: 400 InvalidClientTokenId The X.509 certiﬁcate or AWS access key ID provided does not exist in our records. HTTP Status Code: 403 NotAuthorized You do not have permission to perform this action. HTTP Status Code: 400 OptInRequired The AWS access key ID needs a subscription for the service. HTTP Status Code: 403 API Version 2017-10-26 464 Amazon Transcribe RequestExpired API Reference The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future. HTTP Status Code: 400 ServiceUnavailable The request has failed due to a temporary failure of the server. HTTP Status Code: 503 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 ValidationError The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 API Version 2017-10-26 465
transcribe-dg-001	transcribe-dg.pdf	1	Developer Guide Amazon Transcribe Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon Transcribe Developer Guide Amazon Transcribe: Developer Guide Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon. Amazon Transcribe Table of Contents Developer Guide What is Amazon Transcribe? ........................................................................................................... 1 Amazon Transcribe and HIPAA eligibility ................................................................................................ 1 Pricing ............................................................................................................................................................. 2 Region availability and quotas .................................................................................................................. 2 Available features ............................................................................................................................ 4 Supported languages ...................................................................................................................... 7 Supported programming languages ...................................................................................................... 15 Character sets ............................................................................................................................................. 16 Abkhaz ..................................................................................................................................................... 20 Afrikaans ................................................................................................................................................. 22 Arabic ....................................................................................................................................................... 23 Asturian ................................................................................................................................................... 24 Azerbaijani .............................................................................................................................................. 25 Armenian ................................................................................................................................................. 25 Bashkir ..................................................................................................................................................... 27 Basque ..................................................................................................................................................... 29 Belarusian ............................................................................................................................................... 30 Bengali ..................................................................................................................................................... 31 Bosnian .................................................................................................................................................... 33 Bulgarian ................................................................................................................................................. 33 Catalan .................................................................................................................................................... 34 Central Kurdish ...................................................................................................................................... 35 Chinese, Simpliﬁed ............................................................................................................................... 36 Chinese, Traditional .............................................................................................................................. 37 Chinese, Cantonese ............................................................................................................................... 38 Croatian ................................................................................................................................................... 38 Czech ........................................................................................................................................................ 39 Danish ...................................................................................................................................................... 40 Dutch ....................................................................................................................................................... 40 English ..................................................................................................................................................... 41 Estonian .................................................................................................................................................. 42 Farsi .......................................................................................................................................................... 42 Finnish ..................................................................................................................................................... 43 French ...................................................................................................................................................... 44 iii Amazon Transcribe Developer Guide Galician .................................................................................................................................................... 45 Georgian .................................................................................................................................................. 45 German .................................................................................................................................................... 47 Greek ........................................................................................................................................................ 47 Gujarati .................................................................................................................................................... 48 Hausa ....................................................................................................................................................... 50 Hebrew .................................................................................................................................................... 51 Hindi ......................................................................................................................................................... 52 Hungarian ............................................................................................................................................... 54 Icelandic .................................................................................................................................................. 55 Indonesian .............................................................................................................................................. 55 Italian ....................................................................................................................................................... 56 Japanese .................................................................................................................................................. 57 Kabyle ...................................................................................................................................................... 57 Kannada .................................................................................................................................................. 57 Kazakh ..................................................................................................................................................... 59 Kinyarwanda ........................................................................................................................................... 61 Korean ..................................................................................................................................................... 62 Kyrgyz ...................................................................................................................................................... 62 Latvian ..................................................................................................................................................... 64 Lithuanian ............................................................................................................................................... 65 Luganda ................................................................................................................................................... 65 Macedonian ............................................................................................................................................ 66 Malay ....................................................................................................................................................... 68 Malayalam ............................................................................................................................................... 69 Maltese .................................................................................................................................................... 71 Marathi .................................................................................................................................................... 71 Meadow Mari ......................................................................................................................................... 73 Mongolian ............................................................................................................................................... 76 Norwegian Bokmål ............................................................................................................................... 78 Odia/Oriya .............................................................................................................................................. 78 Pashto ...................................................................................................................................................... 80 Polish ....................................................................................................................................................... 82 Portuguese ............................................................................................................................................. 83 Punjabi ..................................................................................................................................................... 84 Romanian ................................................................................................................................................ 86 iv Amazon Transcribe Developer Guide Russian .................................................................................................................................................... 86 Serbian .................................................................................................................................................... 87 Sinhala ..................................................................................................................................................... 90 Slovak ...................................................................................................................................................... 92 Slovenian ................................................................................................................................................ 93 Somali ...................................................................................................................................................... 93 Spanish .................................................................................................................................................... 94 Sundanese .............................................................................................................................................. 95 Swahili ..................................................................................................................................................... 95 Swedish ................................................................................................................................................... 96 Tagalog/Filipino ..................................................................................................................................... 96 Tamil ........................................................................................................................................................ 97 Tatar ......................................................................................................................................................... 98 Telugu .................................................................................................................................................... 101 Thai ........................................................................................................................................................ 102 Turkish ................................................................................................................................................... 104 Ukrainian .............................................................................................................................................. 105 Uyghur ................................................................................................................................................... 106 Uzbek .................................................................................................................................................... 109 Vietnamese ........................................................................................................................................... 110 Welsh ..................................................................................................................................................... 114 Wolof ..................................................................................................................................................... 115 Zulu ........................................................................................................................................................ 116 How it works ................................................................................................................................ 117 Data input and output ............................................................................................................................ 117 Media formats ..................................................................................................................................... 118 Audio channels .................................................................................................................................... 119 Sample rates ........................................................................................................................................ 120 Output ................................................................................................................................................... 120 Transcribing numbers .............................................................................................................................. 123 Getting started ............................................................................................................................ 125 Signing up for an AWS account ............................................................................................................ 126 Installing the AWS CLI and SDKs ......................................................................................................... 126 Conﬁgure IAM credentials ...................................................................................................................... 127 Creating an Amazon S3 bucket ............................................................................................................ 127 Creating an IAM policy ........................................................................................................................... 127 v Amazon Transcribe Developer Guide Transcribing with the AWS Management Console ............................................................................ 130 Transcribing with the AWS CLI ............................................................................................................. 139 Starting a new transcription job ..................................................................................................... 139 Getting the status of a transcription job ...................................................................................... 140 Listing your transcription jobs ......................................................................................................... 142 Deleting your transcription job ....................................................................................................... 142 Transcribing with the AWS SDKs .......................................................................................................... 143 Working with AWS SDKs ................................................................................................................... 154 Transcribing with HTTP or WebSockets .............................................................................................. 156 Streaming transcriptions ............................................................................................................. 158 Best practices ............................................................................................................................................ 159 Streaming and partial results ............................................................................................................... 160 Partial-result stabilization ................................................................................................................. 161 Setting up a streaming transcription .................................................................................................. 165 Event stream encoding ...................................................................................................................... 179 Data frames ......................................................................................................................................... 182 Job queueing ............................................................................................................................... 183 Enabling job queueing ............................................................................................................................ 183 Tagging resources ........................................................................................................................ 188 Tag-based access control ....................................................................................................................... 189 Adding tags to your Amazon Transcribe resources .......................................................................... 190 Partitioning speakers (diarization) ............................................................................................. 194 Partitioning speakers in a batch transcription ................................................................................... 195 Partitioning speakers in a streaming transcription ........................................................................... 198 Example output ........................................................................................................................................ 201 Transcribing multi-channel audio .............................................................................................. 208 Using channel identiﬁcation in a batch transcription ...................................................................... 209 Using channel identiﬁcation in a streaming transcription .............................................................. 213 Example output ........................................................................................................................................ 214 Identifying languages ................................................................................................................. 223 Batch language identiﬁcation ............................................................................................................... 223 Identifying languages in multi-language audio ........................................................................... 224 Improving language identiﬁcation accuracy ................................................................................. 225 Combining language identiﬁcation with other Amazon Transcribe features ......................... 226 Using language identiﬁcation with batch transcriptions ........................................................... 227 Streaming language identiﬁcation ....................................................................................................... 234 vi Amazon Transcribe Developer Guide Identifying languages in multi-language audio ........................................................................... 235 Using language identiﬁcation with streaming media ................................................................. 235 Alternative transcriptions ........................................................................................................... 242 Requesting alternative transcriptions .................................................................................................. 244 Improving transcription accuracy ............................................................................................... 249 Custom vocabularies ............................................................................................................................... 250 Custom vocabulary tables versus lists ........................................................................................... 251 Creating a custom vocabulary using a table ................................................................................ 252 Creating a custom vocabulary using a list .................................................................................... 263 Using a custom vocabulary .............................................................................................................. 266 Custom language models ...................................................................................................................... 273 Data sources ........................................................................................................................................ 273 Training versus tuning data ..............................................................................................................
transcribe-dg-002	transcribe-dg.pdf	2	Transcribe features ......................... 226 Using language identiﬁcation with batch transcriptions ........................................................... 227 Streaming language identiﬁcation ....................................................................................................... 234 vi Amazon Transcribe Developer Guide Identifying languages in multi-language audio ........................................................................... 235 Using language identiﬁcation with streaming media ................................................................. 235 Alternative transcriptions ........................................................................................................... 242 Requesting alternative transcriptions .................................................................................................. 244 Improving transcription accuracy ............................................................................................... 249 Custom vocabularies ............................................................................................................................... 250 Custom vocabulary tables versus lists ........................................................................................... 251 Creating a custom vocabulary using a table ................................................................................ 252 Creating a custom vocabulary using a list .................................................................................... 263 Using a custom vocabulary .............................................................................................................. 266 Custom language models ...................................................................................................................... 273 Data sources ........................................................................................................................................ 273 Training versus tuning data .............................................................................................................. 274 Creating a custom language model ............................................................................................... 275 Using a custom language model .................................................................................................... 280 Filtering words ............................................................................................................................. 288 Creating a vocabulary ﬁlter ................................................................................................................... 289 Creating custom vocabulary ﬁlters ................................................................................................. 290 Using a custom vocabulary ﬁlter ......................................................................................................... 294 Using a custom vocabulary ﬁlter in a batch transcription ......................................................... 266 Using a custom vocabulary ﬁlter in a streaming transcription ................................................. 270 Detecting toxic speech ................................................................................................................ 303 Using toxic speech detection ................................................................................................................ 304 Using toxic speech detection in a batch transcription ................................................................ 304 Example output ................................................................................................................................... 309 Redacting transcripts .................................................................................................................. 311 Redacting PII in your batch job ............................................................................................................ 312 Redacting or identifying PII in a real-time stream ........................................................................... 319 Example output ........................................................................................................................................ 325 Example redacted output (batch) ................................................................................................... 325 Example redacted streaming output .............................................................................................. 328 Example PII identiﬁcation output ................................................................................................... 329 Creating subtitles ........................................................................................................................ 332 Generating subtitle ﬁles ......................................................................................................................... 333 Analyzing call center audio ........................................................................................................ 336 Common use cases .................................................................................................................................. 336 vii Amazon Transcribe Developer Guide Considerations and additional information ........................................................................................ 338 Region availability and quotas .............................................................................................................. 339 Post-call analytics .................................................................................................................................... 340 Post-call insights ................................................................................................................................. 340 Creating categories ............................................................................................................................ 343 Starting a transcription ..................................................................................................................... 355 Post-call analytics output ................................................................................................................. 363 Enabling generative call summarization ....................................................................................... 376 Real-time Call Analytics ......................................................................................................................... 380 Real-time insights ............................................................................................................................... 381 Creating categories ............................................................................................................................ 383 Post-call analytics with real-time transcriptions .......................................................................... 390 Starting a transcription ..................................................................................................................... 397 Real-time Call Analytics output ...................................................................................................... 406 Transcribing Amazon Chime calls .............................................................................................. 412 Code examples ............................................................................................................................. 414 Basics .......................................................................................................................................................... 415 Actions .................................................................................................................................................. 415 Scenarios .................................................................................................................................................... 477 Build an Amazon Transcribe streaming app ................................................................................. 477 Convert text to speech and back to text ...................................................................................... 478 Create and reﬁne a custom vocabulary ......................................................................................... 479 Transcribe audio and get job data .................................................................................................. 489 Security ........................................................................................................................................ 501 Identity and Access Management ........................................................................................................ 502 Audience ............................................................................................................................................... 502 Authenticating with identities ......................................................................................................... 503 Managing access using policies ....................................................................................................... 506 How Amazon Transcribe works with IAM ...................................................................................... 508 Confused deputy prevention ............................................................................................................ 515 Identity-based policy examples ....................................................................................................... 516 Troubleshooting .................................................................................................................................. 525 Data protection ........................................................................................................................................ 526 Inter-network traﬃc privacy ............................................................................................................ 527 Data encryption .................................................................................................................................. 528 Opting out of using your data for service improvement ........................................................... 531 viii Amazon Transcribe Developer Guide Monitoring Amazon Transcribe ............................................................................................................. 531 Monitoring with CloudWatch ........................................................................................................... 532 Monitoring Amazon Transcribe with CloudTrail ........................................................................... 532 Using Amazon EventBridge with Amazon Transcribe ................................................................. 536 Compliance validation ............................................................................................................................ 545 Resilience ................................................................................................................................................... 546 Infrastructure security ............................................................................................................................. 546 Vulnerability analysis and management ............................................................................................. 546 VPC endpoints (AWS PrivateLink) ................................................................................................... 547 Shared subnets .................................................................................................................................... 549 Security best practices ............................................................................................................................ 549 Amazon Transcribe Medical ........................................................................................................ 551 Region availability and quotas .............................................................................................................. 552 Medical specialties ................................................................................................................................... 553 Transcribing medical terms and measurements .......................................................................... 554 Transcribing numbers ........................................................................................................................ 557 Transcribing a medical conversation .................................................................................................... 559 Transcribing an audio ﬁle ................................................................................................................. 560 Transcribing a real-time stream ...................................................................................................... 564 Enabling speaker partitioning .......................................................................................................... 567 Transcribing multi-channel audio ................................................................................................... 577 Transcribing a medical dictation .......................................................................................................... 585 Transcribing an audio ﬁle ................................................................................................................. 586 Transcribing a streaming medical dictation .................................................................................. 590 Creating and using medical custom vocabularies ............................................................................. 593 Creating a text ﬁle for your medical custom vocabulary ........................................................... 594 Using a text ﬁle to create a medical custom vocabulary ........................................................... 598 Transcribing an audio ﬁle using a medical custom vocabulary ................................................. 600 Transcribing a real-time stream using a medical custom vocabulary ...................................... 602 Character set for Amazon Transcribe Medical .............................................................................. 605 Identifying PHI in a transcript .............................................................................................................. 607 Identifying PHI in an audio ﬁle ....................................................................................................... 608 Identifying PHI in a real-time stream ............................................................................................ 613 Generating alternative transcriptions .................................................................................................. 614 VPC endpoints (AWS PrivateLink) ........................................................................................................ 617 Considerations for Amazon Transcribe Medical VPC endpoints ................................................ 617 ix Amazon Transcribe Developer Guide Creating an interface VPC endpoint for Amazon Transcribe Medical ...................................... 618 Creating a VPC endpoint policy for Amazon Transcribe Medical streaming ........................... 618 Shared subnets .................................................................................................................................... 619 AWS HealthScribe ........................................................................................................................ 621 Security ...................................................................................................................................................... 622 Service availability ................................................................................................................................... 622 Technical requirements ........................................................................................................................... 622 Supported Medical Specialties .............................................................................................................. 623 Workﬂows .................................................................................................................................................. 623 Transcript ﬁle ............................................................................................................................................ 624 Clinical Documentation ﬁle ................................................................................................................... 625 HISTORY_AND_PHYSICAL template sections ............................................................................... 625 GIRPP template sections ................................................................................................................... 627 Transcription jobs ..................................................................................................................................... 627 Starting an AWS HealthScribe transcription job .......................................................................... 628 Streaming .................................................................................................................................................. 643 Guidelines and requirements ........................................................................................................... 643 ResourceAccessRoleArn role permissions ...................................................................................... 644 Starting AWS HealthScribe streaming transcription ................................................................... 645 Data Encryption at rest for AWS HealthScribe .................................................................................. 662
transcribe-dg-003	transcribe-dg.pdf	3	618 Creating a VPC endpoint policy for Amazon Transcribe Medical streaming ........................... 618 Shared subnets .................................................................................................................................... 619 AWS HealthScribe ........................................................................................................................ 621 Security ...................................................................................................................................................... 622 Service availability ................................................................................................................................... 622 Technical requirements ........................................................................................................................... 622 Supported Medical Specialties .............................................................................................................. 623 Workﬂows .................................................................................................................................................. 623 Transcript ﬁle ............................................................................................................................................ 624 Clinical Documentation ﬁle ................................................................................................................... 625 HISTORY_AND_PHYSICAL template sections ............................................................................... 625 GIRPP template sections ................................................................................................................... 627 Transcription jobs ..................................................................................................................................... 627 Starting an AWS HealthScribe transcription job .......................................................................... 628 Streaming .................................................................................................................................................. 643 Guidelines and requirements ........................................................................................................... 643 ResourceAccessRoleArn role permissions ...................................................................................... 644 Starting AWS HealthScribe streaming transcription ................................................................... 645 Data Encryption at rest for AWS HealthScribe .................................................................................. 662 Creating a customer managed key ................................................................................................. 663 Specifying a customer managed key for AWS HealthScribe ..................................................... 667 AWS KMS encryption context .......................................................................................................... 667 Monitoring your encryption keys for AWS HealthScribe ............................................................ 670 Document history ........................................................................................................................ 674 AWS Glossary ............................................................................................................................... 685 x Amazon Transcribe Developer Guide What is Amazon Transcribe? Amazon Transcribe is an automatic speech recognition service that uses machine learning models to convert audio to text. You can use Amazon Transcribe as a standalone transcription service or to add speech-to-text capabilities to any application. With Amazon Transcribe, you can improve accuracy for your speciﬁc use case with language customization, ﬁlter content to ensure customer privacy or audience-appropriate language, analyze content in multi-channel audio, partition the speech of individual speakers, and more. You can transcribe media in real time (streaming) or you can transcribe media ﬁles located in an Amazon S3 bucket (batch). To see which languages are supported for each type of transcription, refer to the Supported languages and language-speciﬁc features table. Topics • Amazon Transcribe and HIPAA eligibility • Pricing • Region availability and quotas See What is Amazon Transcribe? for a short video tour of this service. To learn more, see How Amazon Transcribe works and Getting started with Amazon Transcribe. Tip Information on the Amazon Transcribe API is located in the API Reference. Amazon Transcribe and HIPAA eligibility Amazon Transcribe is covered under AWS’s HIPAA eligibility and BAA which requires BAA customers to encrypt all PHI at rest and in transit when in use. Automatic PHI identiﬁcation is available at no additional charge and in all regions where Amazon Transcribe operates. For more information, refer to HIPAA eligibility and BAA. Amazon Transcribe and HIPAA eligibility 1 Amazon Transcribe Pricing Developer Guide Amazon Transcribe is a pay-as-you-go service; pricing is based on seconds of transcribed audio, billed on a monthly basis. Usage is billed in one-second increments, with a minimum per request charge of 15 seconds. Note that additional charges apply for features such as PII content redaction and custom language models. For cost information for each AWS Region, refer to Amazon Transcribe Pricing. Region availability and quotas Amazon Transcribe is supported in the following AWS Regions: Region Transcription type af-south-1 (Cape Town) batch, streaming ap-east-1 (Hong Kong) batch ap-northeast-1 (Tokyo) ap-northeast-2 (Seoul) ap-south-1 (Mumbai) batch, streaming batch, streaming batch, streaming ap-southeast-1 (Singapore) batch, streaming ap-southeast-2 (Sydney) batch, streaming ca-central-1 (Canada, Central) batch, streaming eu-central-1 (Frankfurt) batch, streaming eu-north-1 (Stockholm) batch eu-west-1 (Ireland) eu-west-2 (London) batch, streaming batch, streaming Pricing 2 Developer Guide Amazon Transcribe Region eu-west-3 (Paris) me-south-1 (Bahrain) sa-east-1 (São Paulo) us-east-1 (N. Virginia) us-east-2 (Ohio) Transcription type batch batch batch, streaming batch, streaming batch, streaming us-gov-east-1 (GovCloud, US-East) batch, streaming us-gov-west-1 (GovCloud, US-West) batch, streaming us-west-1 (San Francisco) batch us-west-2 (Oregon) batch, streaming Important Region support diﬀers for Amazon Transcribe, Amazon Transcribe Medical, and Call Analytics. To get the endpoints for each supported Region, see Service endpoints in the AWS General Reference. For a list of quotas that pertain to your transcriptions, refer to the Service quotas in the AWS General Reference. Some quotas can be changed upon request. If the Adjustable column contains 'Yes', you can request an increase. To do so, select the provided link. Region availability and quotas 3 Amazon Transcribe Developer Guide Amazon Transcribe features To help you decide which Amazon Transcribe solution best ﬁts your use case, the following table oﬀers a feature comparison. Note that 'batch' and 'post-call' refer to transcribing a ﬁle that is located in an Amazon S3 bucket and 'streaming' and 'real-time' refer to transcribing media in real time. Feature Amazon Transcribe Amazon Transcribe Medical1 Amazon Transcribe Call Analytics Conﬁguration options Alternative transcrip tions Channel identiﬁc ation batch, streaming batch, streaming no batch, streaming batch, streaming post-call, real-time Job queueing batch Language identiﬁc ation Multi-language identiﬁcation batch, streaming batch, streaming no no no post-call post-call no Speaker diarization batch, streaming batch, streaming post-call Transcribing digits2 batch, streaming batch, streaming post-call, real-time Conversation analytics Call characteristics Call summarization2 Custom categoriz ation no no no no no no post-call post-call post-call 4 Amazon Transcribe Developer Guide Feature Amazon Transcribe Amazon Transcribe Medical1 Amazon Transcribe Call Analytics Real-time category events Real-time issue detection2 Real-time speaker sentiment no no
transcribe-dg-004	transcribe-dg.pdf	4	Amazon Transcribe Call Analytics Conﬁguration options Alternative transcrip tions Channel identiﬁc ation batch, streaming batch, streaming no batch, streaming batch, streaming post-call, real-time Job queueing batch Language identiﬁc ation Multi-language identiﬁcation batch, streaming batch, streaming no no no post-call post-call no Speaker diarization batch, streaming batch, streaming post-call Transcribing digits2 batch, streaming batch, streaming post-call, real-time Conversation analytics Call characteristics Call summarization2 Custom categoriz ation no no no no no no post-call post-call post-call 4 Amazon Transcribe Developer Guide Feature Amazon Transcribe Amazon Transcribe Medical1 Amazon Transcribe Call Analytics Real-time category events Real-time issue detection2 Real-time speaker sentiment no no no Speaker sentiment no Language customization no no no no real-time real-time real-time post-call Custom language models2 batch, streaming no post-call, real-time Custom vocabularies batch, streaming batch, streaming post-call, real-time Resource organization Tagging batch batch post-call Sensitive data Identifying personal health information2 no Identifying personally identiﬁable informati on2 streaming Redacting audio2 no Redacting transcrip ts2 batch, streaming Vocabulary ﬁltering batch, streaming batch, streaming no no no no no real-time post-call, real-time post-call, real-time post-call, real-time 5 Amazon Transcribe Developer Guide Feature Amazon Transcribe Amazon Transcribe Medical1 Amazon Transcribe Call Analytics Video Subtitles batch no no 1 Amazon Transcribe Medical is only available in US English. 2 This feature is not available for all languages; review the Supported languages and language-speciﬁc features table for more details. 6 Amazon Transcribe Developer Guide Supported languages and language-speciﬁc features The languages supported by Amazon Transcribe are listed in the following table; also listed are the features that are language-speciﬁc. Please verify that the feature you want to use is supported for the language in your media before proceeding with your transcription. To view the complete list of Amazon Transcribe features, refer to the Feature summary. In the following table, 'batch' refers to transcribing a media ﬁle located in an Amazon S3 bucket and 'streaming' refers to transcribing streamed media in real time. For Call Analytics transcriptions, 'post-call' refers to transcribing a media ﬁle located in an Amazon S3 bucket and 'real-time' refers to transcribing streamed media in real time. Acronyms Custom Redaction Call Language Language code# Data input Transcrib ing numbers Abkhaz ab-GE batch Afrikaans af-ZA ar-AE ar-SA Arabic, Gulf Arabic, Modern Standard batch, streaming batch, streaming batch, streaming Armenian hy-AM batch Asturian ast-ES batch Azerbaija ni az-AZ batch no no no no no no no language models batch batch, streaming no no batch batch batch no no no no no no no Bashkir ba-RU batch no batch no no no no no no no no no Analytics * no no post-call no no no no no 7 Amazon Transcribe Developer Guide Language Language code# Data input Transcrib ing numbers language models Acronyms Custom Redaction Call Basque eu-ES batch, streaming no batch, streaming no Belarusia n be-BY batch no batch no Bengali bn-IN batch Bosnian bs-BA batch Bulgarian bg-BG batch no no no batch batch batch Catalan ca-ES batch, streaming streaming batch, streaming no no no no ckb-IR batch no batch no Analytics * no no no no no no no no no no no no no no Central Kurdish, Iran Central Kurdish, Iraq ckb-IQ batch no batch no no no Chinese, Cantonese zh-HK (yue- batch, streaming no no no no no HK) zh-CN batch, streaming no zh-TW batch, streaming no Chinese, Simpliﬁe d Chinese, Tradition al no no no post-call no no no no 8 Amazon Transcribe Developer Guide Language Language code# Data input Transcrib ing numbers language models Acronyms Custom Redaction Call Analytics * no no no no Croatian hr-HR Czech cs-CZ Danish da-DK Dutch nl-NL batch, streaming batch, streaming batch, streaming batch, streaming no no no no batch, streaming batch, streaming batch, streaming batch, streaming no no no no no no no no English, Australia n English, British English, Indian English, Irish English, New Zealand English, Scottish English, South African en-AU batch, streaming batch, streaming batch, streaming batch, streaming streaming post-call, real-time en-GB en-IN en-IE en-NZ en-AB en-ZA batch, streaming batch, streaming batch, streaming batch, streaming streaming post-call, real-time batch, streaming batch, streaming batch, streaming batch, streaming batch, streaming batch, streaming batch, streaming batch, streaming batch, streaming batch, streaming batch, streaming batch, streaming batch, streaming batch, streaming batch, streaming no no no no no no no no no no post-call post-call no post-call no 9 Developer Guide Data input Transcrib ing numbers Acronyms Custom Redaction Call language models Analytics * batch, streaming batch, streaming batch, streaming batch, streaming batch, streaming post-call, real-time Amazon Transcribe Language Language code# en-US en-WL English, US English, Welsh batch, streaming batch, streaming batch, streaming Estonian et-ET batch Farsi fa-IR Finnish fi-FI batch, streaming batch, streaming no no no batch no batch, streaming French fr-FR batch, streaming batch, streaming batch, streaming French, Canadian fr-CA batch, streaming batch, streaming batch, streaming Galician gl-ES batch, streaming no batch, streaming
transcribe-dg-005	transcribe-dg.pdf	5	no no no no no no no no post-call post-call no post-call no 9 Developer Guide Data input Transcrib ing numbers Acronyms Custom Redaction Call language models Analytics * batch, streaming batch, streaming batch, streaming batch, streaming batch, streaming post-call, real-time Amazon Transcribe Language Language code# en-US en-WL English, US English, Welsh batch, streaming batch, streaming batch, streaming Estonian et-ET batch Farsi fa-IR Finnish fi-FI batch, streaming batch, streaming no no no batch no batch, streaming French fr-FR batch, streaming batch, streaming batch, streaming French, Canadian fr-CA batch, streaming batch, streaming batch, streaming Galician gl-ES batch, streaming no batch, streaming no no no no no no no Georgian ka-GE batch no batch no German de-DE batch, streaming batch, streaming batch, streaming batch, streaming German, Swiss de-CH batch, streaming batch, streaming batch, streaming Greek el-GR batch, streaming no batch, streaming no no Gujarati gu-IN batch no batch no no no no no no no no no no no no no post-call no no no post-call, real-time post-call, real-time no no post-call, real-time post-call no no 10 Amazon Transcribe Developer Guide Acronyms Custom Redaction Call language models batch no no no no no Analytics * no no batch no post-call Language Language code# Data input Transcrib ing numbers Hausa ha-NG batch Hebrew he-IL Hindi, Indian hi-IN batch, streaming batch, streaming Hungarian hu-HU batch Icelandic is-IS batch Indonesia n id-ID batch, streaming no no no no no no batch, streaming batch batch batch, streaming no no no no Italian it-IT batch, streaming batch, streaming batch, streaming Japanese ja-JP batch, streaming batch, streaming no batch, streaming Kabyle kab-DZ batch Kannada kn-IN batch Kazakh kk-KZ batch Kinyarwan da rw-RW batch Korean ko-KR batch, streaming no no no no no batch batch batch batch no no no no no no Kyrgyz ky-KG batch no batch no no no no no no no no no no no no no no no post-call, real-time post-call no no no no post-call no 11 Amazon Transcribe Developer Guide Language Language code# Data input Transcrib ing numbers language models Acronyms Custom Redaction Call Latvian lv-LV batch, streaming no batch, streaming no Lithuania n lt-LT batch no batch no Luganda lg-IN batch Macedonia n mk-MK batch Malay ms-MY batch, streaming Malayalam ml-IN batch Maltese mt-MT batch Marathi mr-IN batch Meadow Mari mhr-RU batch Mongolian mn-MN batch Norwegian Bokmål no-NO batch, streaming no no no no no no no no no batch batch batch, streaming batch batch batch batch batch batch, streaming no no no no no no no no no Odia/ Oriya or-IN batch no batch no Pashto ps-AF batch Polish pl-PL batch, streaming no no batch batch, streaming no no no no no no no no no no no no no no no no Analytics * no no no no no no no no no no no no no no 12 Amazon Transcribe Developer Guide Language Language code# Data input Transcrib ing numbers language models Acronyms Custom Redaction Call Portugues e pt-PT batch, streaming batch, streaming batch, streaming Portugues e, Brazilian pt-BR batch, streaming batch, streaming batch, streaming Punjabi pa-IN batch Romanian ro-RO Russian ru-RU Serbian sr-RS batch, streaming batch, streaming batch, streaming Sinhala si-LK batch Slovak sk-SK batch, streaming Slovenian sl-SI batch Somali so-SO batch, streaming no no no no no no no no batch batch, streaming no batch, streaming batch batch, streaming batch batch, streaming Spanish es-ES batch, streaming batch, streaming batch, streaming no no no no no no no no no no no no no no no no no no no no no no Analytics * post-call post-call, real-time no no no no no no no no post-call Spanish, US es-US batch, streaming batch, streaming batch, streaming batch, streaming batch, streaming post-call, real-time Sundanese su-ID batch no batch no no no 13 Amazon Transcribe Developer Guide Language Language code# Data input Transcrib ing numbers language models Acronyms Custom Redaction Call Swahili, Kenya Swahili, Burundi Swahili, Rwanda Swahili, Tanzania Swahili, Uganda sw-KE batch no batch no sw-BI batch no batch no sw-RW batch no batch no sw-TZ batch no batch no sw-UG batch no batch no Swedish sv-SE Tagalog/ Filipino tl-PH batch, streaming batch, streaming Tamil ta-IN batch Tatar tt-RU batch Telugu te-IN batch Thai th-TH batch, streaming Turkish tr-TR batch Ukrainian uk-UA batch, streaming no no no no no no no no batch, streaming batch, streaming no batch no batch, streaming batch batch, streaming no no no no no no no no Uyghur ug-CN batch no batch no no no no no no no no no no no no no no no Analytics * no no no no no no no no no no no no no no 14 Amazon Transcribe Developer Guide Language Language code# Data input Transcrib ing numbers language models Acronyms Custom Redaction Call Uzbek uz-UZ batch Vietnames e vi-VN batch, streaming Welsh cy-WL batch
transcribe-dg-006	transcribe-dg.pdf	6	tr-TR batch Ukrainian uk-UA batch, streaming no no no no no no no no batch, streaming batch, streaming no batch no batch, streaming batch batch, streaming no no no no no no no no Uyghur ug-CN batch no batch no no no no no no no no no no no no no no no Analytics * no no no no no no no no no no no no no no 14 Amazon Transcribe Developer Guide Language Language code# Data input Transcrib ing numbers language models Acronyms Custom Redaction Call Uzbek uz-UZ batch Vietnames e vi-VN batch, streaming Welsh cy-WL batch Wolof wo-SN batch Zulu zu-ZA batch, streaming no no no no no batch batch, streaming batch batch batch, streaming no no no no no no no no no no Analytics * no no no no no The following Call Analytics insights are only supported in select English dialects: • Call summarization: en- (all English dialects) • Issue detection: en-AU, en-GB, en-US #Language Code not supported in AWS GovCloud (US) (US-West, us-gov-west-1), AWS GovCloud (US) (US-East, us-gov-east-1), or Africa (Cape Town, af-south-1) regions: • Language code: 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-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 ,or-IN ,pa-IN ,pl-PL ,ps-AF ,ro-RO ,rw- RW ,si-LK ,sk-SK ,sl-SI ,so-SO ,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 ,zu-ZA Supported programming languages Amazon Transcribe supports the following AWS SDKs: Supported programming languages 15 Amazon Transcribe Developer Guide Batch transcriptions Streaming transcriptions .NET .NET is not supported for streaming. AWS Command Line Interface (CLI) The CLI is not supported for streaming. C++ Go Java V2 JavaScript PHP V3 C++ Go Java V2 JavaScript V3 PHP V3 Python Boto3 Python Streaming SDK for Amazon Transcribe Ruby V3 Rust Ruby V3 Rust For information on using SDKs with Amazon Transcribe, refer to Transcribing with the AWS SDKs. For more information on all available AWS SDKs and builder tools, refer to Tools to Build on AWS. Tip You can ﬁnd SDK code samples in these GitHub repositories: • AWS Code Examples • Amazon Transcribe Examples Character sets for custom vocabularies and vocabulary ﬁlters For each language Amazon Transcribe supports, there is a speciﬁc set of characters Amazon Transcribe can recognize. When you create a custom vocabulary or vocabulary ﬁlter, use only the Character sets 16 Amazon Transcribe Developer Guide characters listed in your language's character set. If you use unsupported characters, your custom vocabulary or vocabulary ﬁlter fails. Important Be sure to check that your custom vocabulary ﬁle uses only the supported Unicode code points and code point sequences listed within the following character sets. Many Unicode characters can appear identical in popular fonts, even if they use diﬀerent code points. Only the code points listed in this guide are supported. For example, the French word déjà can be rendered using precomposed characters (where one Unicode value represents an accented character) or decomposed characters (where two Unicode values represent an accented character, one value for the base character and another for the accent). • Precomposed version: 0064 00E9 006A 00E0 (renders as déjà) • Decomposed version: 0064 0065 0301 006A 0061 0300 (renders as d ́ej ̀a) Topics • Abkhaz character set • Afrikaans character set • Arabic character set • Asturian character set • Azerbaijani character set • Armenian character set • Bashkir character set • Basque character set • Belarusian character set • Bengali character set • Bosnian character set • Bulgarian character set • Catalan character set • Central Kurdish character set • Chinese, Mandarin (Mainland China), Simpliﬁed character set Character sets 17 Amazon Transcribe Developer Guide • Chinese, Mandarin (Taiwan), Traditional character set • Chinese, Cantonese (Hong Kong), Traditional character set • Croatian character set • Czech character set • Danish character set • Dutch character set • English character set • Estonian character set • Farsi character set • Finnish character set • French character set • Galician character set • Georgian character set • German character set • Greek character set • Gujarati character set • Hausa character set • Hebrew character set • Hindi character set • Hungarian character set • Icelandic character set • Indonesian character set • Italian character set • Japanese character set • Kabyle character set • Kannada character set • Kazakh character set • Kinyarwanda character set • Korean character set • Kyrgyz character set Character sets 18 Amazon Transcribe • Latvian character set • Lithuanian character set • Luganda character set • Macedonian character set • Malay character set • Malayalam character set • Maltese character set • Marathi character set • Meadow Mari character set •
transcribe-dg-007	transcribe-dg.pdf	7	set • Hausa character set • Hebrew character set • Hindi character set • Hungarian character set • Icelandic character set • Indonesian character set • Italian character set • Japanese character set • Kabyle character set • Kannada character set • Kazakh character set • Kinyarwanda character set • Korean character set • Kyrgyz character set Character sets 18 Amazon Transcribe • Latvian character set • Lithuanian character set • Luganda character set • Macedonian character set • Malay character set • Malayalam character set • Maltese character set • Marathi character set • Meadow Mari character set • Mongolian character set • Norwegian Bokmål character set • Odia/Oriya character set • Pashto character set • Polish character set • Portuguese character set • Punjabi character set • Romanian character set • Russian character set • Serbian character set • Sinhala character set • Slovak character set • Slovenian character set • Somali character set • Spanish character set • Sundanese character set • Swahili character set • Swedish character set • Tagalog/Filipino character set • Tamil character set • Tatar character set Character sets Developer Guide 19 Developer Guide Amazon Transcribe • Telugu character set • Thai character set • Turkish character set • Ukrainian character set • Uyghur character set • Uzbek character set • Vietnamese character set • Welsh character set • Wolof character set • Zulu character set Abkhaz character set For Abkhaz custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Character а б в г д е ж Code 0430 0431 0432 0433 0434 0435 0436 Character љ њ ћ ќ ѝ ў џ Code 0459 045A 045B 045C 045D 045E 045F Abkhaz 20 Amazon Transcribe Character з и й к л м н о п р с т у ф х ц ч ш щ ъ Code 0437 0438 0439 043A 043B 043C 043D 043E 043F 0440 0441 0442 0443 0444 0445 0446 0447 0448 0449 044A Developer Guide Character ґ ғ җ ҙ қ ҟ ҡ ң ҥ ҩ ҫ ҭ ү ұ ҳ ҵ ҷ һ ҽ ҿ Code 0491 0493 0497 0499 049B 049F 04A1 04A3 04A5 04A9 04AB 04AD 04AF 04B1 04B3 04B5 04B7 04BB 04BD 04BF Abkhaz 21 Amazon Transcribe Character ы ь э ю я ѐ ё ђ ѓ є ѕ і ї ј # Code 044B 044C 044D 044E 044F 0450 0451 0452 0453 0454 0455 0456 0457 0458 0525 Developer Guide Character ӊ ӑ ӓ ӗ ә ӡ ӣ ӧ ө ӯ ӱ ӳ ӷ ӹ Code 04CA 04D1 04D3 04D7 04D9 04E1 04E3 04E7 04E9 04EF 04F1 04F3 04F7 04F9 Afrikaans character set For Afrikaans custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) Afrikaans 22 Amazon Transcribe Developer Guide You can also use the following Unicode characters in the Phrase ﬁeld: Character á è é ê ë í î Code 00E1 00E8 00E9 00EA 00EB 00ED 00EE Character ï ó ô ö ú û ü Code 00EF 00F3 00F4 00F6 00FA 00FB 00FC Arabic character set For Arabic custom vocabularies, you can use the following Unicode characters in the Phrase ﬁeld. You can also use the hyphen (-) character to separate words. Character ء آ أ ؤ إ ئ ا ب Arabic Code 0621 0622 0623 0624 0625 0626 0627 0628 Character س ش ص ض ط ظ ع غ Code 0633 0634 0635 0636 0637 0638 0639 063A 23 Amazon Transcribe Character ة ت ث ج ح خ د ذ ر ز Code 0629 062A 062B 062C 062D 062E 062F 0630 0631 0632 Developer Guide Character ف ق ك ل م ن ه و ى ي Code 0641 0642 0643 0644 0645 0646 0647 0648 0649 064A Asturian character set For Asturian custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Character á é í Asturian Code 00E1 00E9 00ED Character ñ ó ú Code 00F1 00F3 00FA 24 Amazon Transcribe Character ü Code 00FC Azerbaijani character set Character Code Developer Guide For Azerbaijani custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Character ä ç ö ü Code 00E4 00E7 00F6 00FC 0307 Armenian character set Character ğ ı ş ə Code 011F 0131 015F 0259 For Armenian custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a
transcribe-dg-008	transcribe-dg.pdf	8	00E9 00ED Character ñ ó ú Code 00F1 00F3 00FA 24 Amazon Transcribe Character ü Code 00FC Azerbaijani character set Character Code Developer Guide For Azerbaijani custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Character ä ç ö ü Code 00E4 00E7 00F6 00FC 0307 Armenian character set Character ğ ı ş ə Code 011F 0131 015F 0259 For Armenian custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Azerbaijani 25 ̇ Amazon Transcribe Character ա բ գ դ ե զ է ը թ ժ ի լ խ ծ կ հ ձ ղ ճ Code 0561 0562 0563 0564 0565 0566 0567 0568 0569 056A 056B 056C 056D 056E 056F 0570 0571 0572 0573 Developer Guide Character մ յ ն շ ո չ պ ջ ռ ս վ տ ր ց ւ փ ք օ ֆ Code 0574 0575 0576 0577 0578 0579 057A 057B 057C 057D 057E 057F 0580 0581 0582 0583 0584 0585 0586 Armenian 26 Amazon Transcribe Bashkir character set Developer Guide For Bashkir custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Character а б в г д е ж з и й к л м н Code 0430 0431 0432 0433 0434 0435 0436 0437 0438 0439 043A 043B 043C 043D Character љ њ ћ ќ ѝ ў џ ґ ғ җ ҙ қ ҟ ҡ Code 0459 045A 045B 045C 045D 045E 045F 0491 0493 0497 0499 049B 049F 04A1 Bashkir 27 Amazon Transcribe Character о п р с т у ф х ц ч ш щ ъ ы ь э ю я ѐ ё Code 043E 043F 0440 0441 0442 0443 0444 0445 0446 0447 0448 0449 044A 044B 044C 044D 044E 044F 0450 0451 Developer Guide Character ң ҥ ҩ ҫ ҭ ү ұ ҳ ҵ ҷ һ ҽ ҿ ӊ ӑ ӓ ӗ ә ӡ ӣ Code 04A3 04A5 04A9 04AB 04AD 04AF 04B1 04B3 04B5 04B7 04BB 04BD 04BF 04CA 04D1 04D3 04D7 04D9 04E1 04E3 Bashkir 28 Amazon Transcribe Character ђ ѓ є ѕ і ї ј Code 0452 0453 0454 0455 0456 0457 0458 Developer Guide Character ӧ ө ӯ ӱ ӳ ӷ ӹ Code 04E7 04E9 04EF 04F1 04F3 04F7 04F9 Basque character set For Basque custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Code 00E1 00E9 00ED 00FC Character ñ ó ú Code 00F1 00F3 00FA Character á é í ü Basque 29 Amazon Transcribe Developer Guide Belarusian character set For Belarusian custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Character а б в г д е ж з й к л м н о Code 0430 0431 0432 0433 0434 0435 0436 0437 0439 043A 043B 043C 043D 043E Character с т у ф х ц ч ш ы ь э ю я ё Code 0441 0442 0443 0444 0445 0446 0447 0448 044B 044C 044D 044E 044F 0451 Belarusian 30 Amazon Transcribe Character п р Code 043F 0440 Character і ў Code 0456 045E Developer Guide Bengali character set For Bengali custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Character ং ঃ অ আ ই ঈ উ ঊ ঋ এ Code 0981 0982 0983 0985 0986 0987 0988 0989 098A 098B 098F Character দ ধ ন প ফ ব ভ ম য র ল Code 09A6 09A7 09A8 09AA 09AB 09AC 09AD 09AE 09AF 09B0 09B2 Bengali 31 ঁ Amazon Transcribe Character ঐ ও ঔ ক খ গ ঘ ঙ চ ছ জ ঝ ঞ ট ঠ ড ঢ ণ ত থ Code 0990 0993 0994 0995 0996 0997 0998 0999 099A 099B 099C 099D 099E 099F 09A0 09A1 09A2 09A3 09A4 09A5 Developer Guide Character শ ষ স হ # া ি ী ে ৈ ো ৌ # ৗ Code 09B6 09B7 09B8 09B9 09BC 09BD 09BE 09BF 09C0 09C1 09C2 09C3 09C4 09C7 09C8 09CB 09CC 09CD 09CE 09D7 Bengali 32 ় ু ূ ৃ ৄ ্ Amazon
transcribe-dg-009	transcribe-dg.pdf	9	09AC 09AD 09AE 09AF 09B0 09B2 Bengali 31 ঁ Amazon Transcribe Character ঐ ও ঔ ক খ গ ঘ ঙ চ ছ জ ঝ ঞ ট ঠ ড ঢ ণ ত থ Code 0990 0993 0994 0995 0996 0997 0998 0999 099A 099B 099C 099D 099E 099F 09A0 09A1 09A2 09A3 09A4 09A5 Developer Guide Character শ ষ স হ # া ি ী ে ৈ ো ৌ # ৗ Code 09B6 09B7 09B8 09B9 09BC 09BD 09BE 09BF 09C0 09C1 09C2 09C3 09C4 09C7 09C8 09CB 09CC 09CD 09CE 09D7 Bengali 32 ় ু ূ ৃ ৄ ্ Amazon Transcribe Bosnian character set Developer Guide For Bosnian custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Character ć č ž Code 0107 010D 017E Bulgarian character set Character đ š Code 0111 0161 For Bulgarian custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Character а б в г Bosnian Code 0430 0431 0432 0433 Character п р с т Code 043F 0440 0441 0442 33 Amazon Transcribe Character д е ж з и й к л м н о Code 0434 0435 0436 0437 0438 0439 043A 043B 043C 043D 043E Developer Guide Character у ф х ц ч ш щ ъ ь ю я Code 0443 0444 0445 0446 0447 0448 0449 044A 044C 044E 044F Catalan character set For Catalan custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Character à ç Catalan Code 00E0 00E7 Character ï ò Code 00EF 00F2 34 Amazon Transcribe Character è é í ŀ Code 00E8 00E9 00ED 0140 Developer Guide Character ó ú ü Code 00F3 00FA 00FC Central Kurdish character set For Central Kurdish custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Character ئ ا ب ت ج ح خ د ر Code 0626 0627 0628 062A 062C 062D 062E 062F 0631 Character م ن و پ چ ڕ ژ ڤ ک Code 0645 0646 0648 067E 0686 0695 0698 06A4 06A9 Central Kurdish 35 Amazon Transcribe Character ز س ش ع غ ف ق ل Code 0632 0633 0634 0639 063A 0641 0642 0644 Developer Guide Character گ ڵ ھ ۆ ۇ ی ێ ە Code 06AF 06B5 06BE 06C6 06C7 06CC 06CE 06D5 Chinese, Mandarin (Mainland China), Simpliﬁed character set For Chinese (Simpliﬁed) custom vocabularies, the Phrase ﬁeld can use any of the characters listed in the following ﬁle: • zh-cn-character-set The SoundsLike ﬁeld can contain the pinyin syllables listed in the following ﬁle: • pinyin-character-set When you use pinyin syllables in the SoundsLike ﬁeld, separate the syllables with a hyphen (-). Amazon Transcribe represents the four tones in Chinese (Simpliﬁed) using numbers. The following table shows how tone marks are mapped for the word 'ma'. Tone Tone 1 Tone 2 Tone mark Tone number mā má ma1 ma2 Chinese, Simpliﬁed 36 Amazon Transcribe Developer Guide Tone mark Tone number mǎ mà ma3 ma4 Tone Tone 3 Tone 4 Note For the 5th (neutral) tone, you can use Tone 1, with the exception of 'er', which must be mapped to Tone 2. For example, 打转儿 would be represented as 'da3-zhuan4-er2'. Chinese (Simpliﬁed) custom vocabularies don't use the IPA ﬁeld, but you must still include the IPA header in the custom vocabulary table. The following example is an input ﬁle in text format. The example uses spaces to align the columns. Your input ﬁles should use TAB characters to separate the columns. Include spaces only in the DisplayAs column. Phrase SoundsLike IPA DisplayAs ## kang1-jian4 ## qian3-ze2 #### guo2-fang2-da4-chen2 ##### shi4-jie4-bo2-lan3-hui4 ### Chinese, Mandarin (Taiwan), Traditional character set For Chinese (Traditional) custom vocabularies, the Phrase ﬁeld can use any of the characters listed in the following ﬁle: • zh-tw-character-set The SoundsLike ﬁeld can contain the zhuyin syllables listed in the following ﬁle: • zhuyin-character-set When you use zhuyin syllables in the SoundsLike ﬁeld, separate the syllables with a hyphen (-). Chinese, Traditional 37 Amazon Transcribe Developer Guide Amazon Transcribe represents the four tones in Chinese (Traditional) using numbers. The following table shows how tone marks are mapped for the word ㄇㄚ. Tone Tone 1 Tone 2 Tone 3 Tone 4 Tone mark ㄇㄚㄇㄚˊ ㄇㄚˇ ㄇㄚˋ Chinese (Traditional) custom vocabularies don't use the IPA ﬁeld, but
transcribe-dg-010	transcribe-dg.pdf	10	can use any of the characters listed in the following ﬁle: • zh-tw-character-set The SoundsLike ﬁeld can contain the zhuyin syllables listed in the following ﬁle: • zhuyin-character-set When you use zhuyin syllables in the SoundsLike ﬁeld, separate the syllables with a hyphen (-). Chinese, Traditional 37 Amazon Transcribe Developer Guide Amazon Transcribe represents the four tones in Chinese (Traditional) using numbers. The following table shows how tone marks are mapped for the word ㄇㄚ. Tone Tone 1 Tone 2 Tone 3 Tone 4 Tone mark ㄇㄚㄇㄚˊ ㄇㄚˇ ㄇㄚˋ Chinese (Traditional) custom vocabularies don't use the IPA ﬁeld, but you must still include the IPA header in the custom vocabulary table. The following example is an input ﬁle in text format. The example uses spaces to align the columns. Your input ﬁles should use TAB characters to separate the columns. Include spaces only in the DisplayAs column. Phrase SoundsLike IPA DisplayAs ## ###ˋ-## ## ###ˇ-##ˊ #### ###ˊ-##ˊ-##ˋ-##ˇ ##### #ˋ-###ˋ-##ˊ-##ˇ-###ˋ ### Chinese, Cantonese (Hong Kong), Traditional character set For Chinese (Cantonese) Hong Kong custom vocabularies, the Phrase ﬁeld can use any of the characters listed in the following ﬁle: • zh-hk-character-set Croatian character set For Croatian custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) Chinese, Cantonese 38 Amazon Transcribe • . (period) Developer Guide You can also use the following Unicode characters in the Phrase ﬁeld: Character ć č ž Code 0107 010D 017E Czech character set Character đ š Code 0111 0161 For Czech custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Character á é í ó ú ý č Czech Code 00E1 00E9 00ED 00F3 00FA 00FD 010D Character ď ě ň ř š ť ů Code 010F 011B 0148 0159 0161 0165 016F 39 Amazon Transcribe Character ž Code 017E Danish character set Character Code Developer Guide For Danish custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • A - Z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Character Å Æ Ø å Code 00C5 00C6 00D8 00E5 Dutch character set Character æ é ø Code 00E6 00E9 00F8 For Dutch custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • A - Z • ' (apostrophe) • - (hyphen) • . (period) Danish 40 Amazon Transcribe Developer Guide You can also use the following Unicode characters in the Phrase ﬁeld: Character à á â ä ç è é ê ë ì í Code 00E0 00E1 00E2 00E4 00E7 00E8 00E9 00EA 00EB 00EC 00ED Character î ï ñ ò ó ô ö ù ú û ü Code 00EE 00EF 00F1 00F2 00F3 00F4 00F6 00F9 00FA 00FB 00FC English character set For English custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • A - Z • ' (apostrophe) • - (hyphen) • . (period) English 41 Amazon Transcribe Estonian character set Developer Guide For Estonian custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Character ä õ ö Code 00E4 00F5 00F6 Farsi character set Character ü š ž Code 00FC 0161 017E For Farsi custom vocabularies, you can use the following characters in the Phrase ﬁeld. Character ء آ أ ؤ ئ ا ب Code 0621 0622 0623 0624 0626 0627 0628 Character ظ ع غ ف ق ل م Code 0638 0639 063A 0641 0642 0644 0645 Estonian 42 Amazon Transcribe Character ت ث ج ح خ د ذ ر ز س ش ص ض ط Code 062A 062B 062C 062D 062E 062F 0630 0631 0632 0633 0634 0635 0636 0637 Developer Guide Character ن ه و پ چ ژ ک گ ی Code 0646 0647 0648 064E 064F 0650 0651 067E 0686 0698 06A9 06AF 06CC Finnish character set For Finnish custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Finnish 43 َ ُ ِ ّ Amazon Transcribe Character ä å ž Code 00E4 00E5 017E French character set Developer Guide Character ö š Code 00F6 0161 For French custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • A - Z • ' (apostrophe) • - (hyphen) • . (period) You can also use
transcribe-dg-011	transcribe-dg.pdf	11	character set For Finnish custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Finnish 43 َ ُ ِ ّ Amazon Transcribe Character ä å ž Code 00E4 00E5 017E French character set Developer Guide Character ö š Code 00F6 0161 For French custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • A - Z • ' (apostrophe) • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Character À Â Ç È É Ê Ë Î Code 00C0 00C2 00C7 00C8 00C9 00CA 00CB 00CE Character à â ç è é ê ë î Code 00E0 00E2 00E7 00E8 00E9 00EA 00EB 00EE French 44 Amazon Transcribe Character Ï Ô Ö Ù Û Ü Code 00CF 00D4 00D6 00D9 00DB 00DC Developer Guide Character ï ô ö ù û ü Code 00EF 00F4 00F6 00F9 00FB 00FC Galician character set For Galician custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Character á é í ü Code 00E1 00E9 00ED 00FC Georgian character set Character ñ ó ú Code 00F1 00F3 00FA For Georgian custom vocabularies, you can use the following characters in the Phrase ﬁeld: Galician 45 Amazon Transcribe • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Developer Guide Character ა ბ გ დ ე ვ ზ თ ი კ ლ მ ნ ო პ ჟ Code 10D0 10D1 10D2 10D3 10D4 10D5 10D6 10D7 10D8 10D9 10DA 10DB 10DC 10DD 10DE 10DF Character რ ს ტ უ ფ ქ ღ ყ შ ჩ ც ძ წ ჭ ხ ჯ Code 10E0 10E1 10E2 10E3 10E4 10E5 10E6 10E7 10E8 10E9 10EA 10EB 10EC 10ED 10EE 10EF Georgian 46 Amazon Transcribe Character ჰ Code 10F0 German character set Character Code Developer Guide For German custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • A - Z • ' (apostrophe) • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Character ä ö ü ß Code 00E4 00F6 00FC 00DF Greek character set Character Ä Ö Ü Code 00C4 00D6 00DC For Greek custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: German 47 Amazon Transcribe Character ά έ ή ί ΰ α β γ δ ε ζ η θ ι κ λ μ ΐ Code 03AC 03AD 03AE 03AF 03B0 03B1 03B2 03B3 03B4 03B5 03B6 03B7 03B8 03B9 03BA 03BB 03BC 0390 Developer Guide Character ν ξ ο π ρ ς σ τ υ φ χ ψ ω ϊ ϋ ό ώ Code 03BD 03BE 03BF 03C0 03C1 03C2 03C3 03C4 03C5 03C6 03C7 03C8 03C9 03CA 03CB 03CC 03CE Gujarati character set For Gujarati custom vocabularies, you can use the following characters in the Phrase ﬁeld: Gujarati 48 Amazon Transcribe • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Developer Guide Character ઃ અ આ ઇ ઈ ઉ ઊ ઋ ઍ એ ઐ ઑ ઓ ઔ Code 0A81 0A82 0A83 0A85 0A86 0A87 0A88 0A89 0A8A 0A8B 0A8D 0A8F 0A90 0A91 0A93 0A94 Character દ ધ ન પ ફ બ ભ મ ય ર લ ળ વ શ ષ સ Code 0AA6 0AA7 0AA8 0AAA 0AAB 0AAC 0AAD 0AAE 0AAF 0AB0 0AB2 0AB3 0AB5 0AB6 0AB7 0AB8 Gujarati 49 ઁ ં Amazon Transcribe Character ક ખ ગ ઘ ઙ ચ છ જ ઝ ઞ ટ ઠ ડ ઢ ણ ત થ Code 0A95 0A96 0A97 0A98 0A99 0A9A 0A9B 0A9C 0A9D 0A9E 0A9F 0AA0 0AA1 0AA2 0AA3 0AA4 0AA5 Developer Guide Character હ ા િ ી ૉ ો ૌ ૐ ૠ Code 0AB9 0ABC 0ABE 0ABF 0AC0 0AC1 0AC2 0AC3 0AC5 0AC7 0AC8 0AC9 0ACB 0ACC 0ACD 0AD0 0AE0 Hausa character set For Hausa custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z Hausa 50 ઼ ુ ૂ ૃ ૅ ે ૈ ્ Amazon Transcribe • - (hyphen) • . (period) Developer Guide You can also use the following Unicode characters in the Phrase ﬁeld: Character ƙ ƴ Code 0199 01B4 0303 Hebrew character set Character ɓ ɗ Code 0253 0257 For Hebrew custom vocabularies, you
transcribe-dg-012	transcribe-dg.pdf	12	ા િ ી ૉ ો ૌ ૐ ૠ Code 0AB9 0ABC 0ABE 0ABF 0AC0 0AC1 0AC2 0AC3 0AC5 0AC7 0AC8 0AC9 0ACB 0ACC 0ACD 0AD0 0AE0 Hausa character set For Hausa custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z Hausa 50 ઼ ુ ૂ ૃ ૅ ે ૈ ્ Amazon Transcribe • - (hyphen) • . (period) Developer Guide You can also use the following Unicode characters in the Phrase ﬁeld: Character ƙ ƴ Code 0199 01B4 0303 Hebrew character set Character ɓ ɗ Code 0253 0257 For Hebrew custom vocabularies, you can use the following Unicode characters in the Phrase ﬁeld: Character - א ב ג ד ה ו ז ח ט Code 002D 05D0 05D1 05D2 05D3 05D4 05D5 05D6 05D7 05D8 Character ם מ ן נ ס ע ף פ ץ צ Code 05DD 05DE 05DF 05E0 05E1 05E2 05E3 05E4 05E5 05E6 Hebrew 51 ̃ Amazon Transcribe Character י ך כ ל Code 05D9 05DA 05DB 05DC Hindi character set Developer Guide Character ק ר ש ת Code 05E7 05E8 05E9 05EA For Hindi custom vocabularies, you can use the following Unicode characters in the Phrase ﬁeld: Code 002D 002E 0901 0902 0903 0905 0906 0907 0908 0909 090A 090B Character - . ः अ आ इ ई उ ऊ ऋ Hindi Character थ द ध न प फ ब भ म य र ल Code 0925 0926 0927 0928 092A 092B 092C 092D 092E 092F 0930 0932 52 ँ ं Amazon Transcribe Character ए ऐ ऑ ओ औ क ख ग घ ङ च छ ज झ ञ ट ठ ड ढ ण Code 090F 0910 0911 0913 0914 0915 0916 0917 0918 0919 091A 091B 091C 091D 091E 091F 0920 0921 0922 0923 Developer Guide Character व श ष स ह ा ि ी ॉ ो ौ ज़ ड़ Code 0935 0936 0937 0938 0939 093E 093F 0940 0941 0942 0943 0945 0947 0948 0949 094B 094C 094D 095B 095C Hindi 53 ु ू ृ ॅ े ै ् Amazon Transcribe Character त Code 0924 Character ढ़ Code 095D Developer Guide Amazon Transcribe maps the following characters: Character ऩ (0929) ऱ (0931) क़ (0958) ख़ (0959) ग़ (095A) फ़ (095E) य़ (095F) Mapped to न (0928) र (0930) क (0915) ख (0916) ग (0917) फ (092B) य (092F) Hungarian character set For Hungarian custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Character á é Hungarian Code 00E1 00E9 Character ö ú Code 00F6 00FA 54 Amazon Transcribe Character í ó ű Code 00ED 00F3 0171 Icelandic character set Developer Guide Character ü ő Code 00FC 0151 For Icelandic custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Character á é ð í ó Code 00E1 00E9 00F0 00ED 00F3 Indonesian character set Character ú ý þ æ ö Code 00FA 00FD 00FE 00E6 00F6 For Indonesian custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • A - Z • ' (apostrophe) Icelandic 55 Amazon Transcribe • - (hyphen) • . (period) Italian character set Developer Guide For Italian custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • A - Z • ' (apostrophe) • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Character À Ä Ç È É Ê Ë Ì Ò Ù Ü Code 00C0 00C4 00C7 00C8 00C9 00CA 00CB 00CC 00D2 00D9 00DC Character à ä ç è é ê ë ì ò ù ü Code 00E0 00E4 00E7 00E8 00E9 00EA 00EB 00EC 00F2 00F9 00FC Italian 56 Amazon Transcribe Developer Guide Japanese character set For Japanese custom vocabularies, the DisplayAs ﬁeld supports all hiragana, katakana, and kanji characters, and fullwidth romaji capital letters. The Phrase ﬁeld supports the characters listed in the following ﬁle: • ja-jp-character-set Kabyle character set For Kabyle custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Character ï č ř ǧ ɛ ɣ Code 00EF 010D 0159 01E7 025B 0263 Character ḍ ḥ ṛ ṣ ṭ ẓ Code 1E0D 1E25 1E5B 1E63 1E6D 1E93 Kannada character set For Kannada custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z Japanese 57 Amazon Transcribe • - (hyphen) • . (period) Developer
transcribe-dg-013	transcribe-dg.pdf	13	ja-jp-character-set Kabyle character set For Kabyle custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Character ï č ř ǧ ɛ ɣ Code 00EF 010D 0159 01E7 025B 0263 Character ḍ ḥ ṛ ṣ ṭ ẓ Code 1E0D 1E25 1E5B 1E63 1E6D 1E93 Kannada character set For Kannada custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z Japanese 57 Amazon Transcribe • - (hyphen) • . (period) Developer Guide You can also use the following Unicode characters in the Phrase ﬁeld: Character ಂ ಃ ಅ ಆ ಇ ಈ ಉ ಊ ಋ ಎ ಏ ಐ ಒ ಓ ಔ ಕ ಖ Code 0C82 0C83 0C85 0C86 0C87 0C88 0C89 0C8A 0C8B 0C8E 0C8F 0C90 0C92 0C93 0C94 0C95 0C96 Character ಧ ನ ಪ ಫ ಬ ಭ ಮ ಯ ರ ಲ ಳ ವ ಶ ಷ ಸ ಹ # Code 0CA7 0CA8 0CAA 0CAB 0CAC 0CAD 0CAE 0CAF 0CB0 0CB2 0CB3 0CB5 0CB6 0CB7 0CB8 0CB9 0CBC Kannada 58 Amazon Transcribe Character ಗ ಘ ಙ ಚ ಛ ಜ ಝ ಞ ಟ ಠ ಡ ಢ ಣ ತ ಥ ದ ೠ Code 0C97 0C98 0C99 0C9A 0C9B 0C9C 0C9D 0C9E 0C9F 0CA0 0CA1 0CA2 0CA3 0CA4 0CA5 0CA6 0CE0 Developer Guide Character # ಾ ಿ ೀ ು ೂ ೃ ೆ ೇ ೈ ೊ ೋ ೌ ್ ೕ ೖ Code 0CBD 0CBE 0CBF 0CC0 0CC1 0CC2 0CC3 0CC6 0CC7 0CC8 0CCA 0CCB 0CCC 0CCD 0CD5 0CD6 Kazakh character set For Kazakh custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z Kazakh 59 Amazon Transcribe • - (hyphen) • . (period) Developer Guide You can also use the following Unicode characters in the Phrase ﬁeld: Character т б о п ш и ч н қ і щ е ә ю з х ц Code 0442 0431 043E 043F 0448 0438 0447 043D 049B 0456 0449 0435 04D9 044E 0437 0445 0446 Character ы я с һ д р г ё й ө в э ң л ф к у Code 044B 044F 0441 04BB 0434 0440 0433 0451 0439 04E9 0432 044D 04A3 043B 0444 043A 0443 Kazakh 60 Amazon Transcribe Character ү м ь ъ Code 04AF 043C 044C 044A Kinyarwanda character set Developer Guide Character ж ғ а ұ Code 0436 0493 0430 04B1 For Kinyarwanda custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Character á â ã ç è é ê ë í Code 00E1 00E2 00E3 00E7 00E8 00E9 00EA 00EB 00ED Character ó ô ú ü ā ē ī ō ū Code 00F3 00F4 00FA 00FC 0101 0113 012B 014D 016B Kinyarwanda 61 Amazon Transcribe Character ï Code 00EF Character Code 0301 Developer Guide Korean character set For Korean custom vocabularies, you can use any of the Hangul syllables in the Phrase ﬁeld. For more information, see Hangul Syllables on Wikipedia. Kyrgyz character set For Kyrgyz custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Character а б в г д е ж з и Code 0430 0431 0432 0433 0434 0435 0436 0437 0438 Character љ њ ћ ќ ѝ ў џ ґ ғ Code 0459 045A 045B 045C 045D 045E 045F 0491 0493 Korean 62 ́ Amazon Transcribe Character й к л м н о п р с т у ф х ц ч ш щ ъ ы ь Code 0439 043A 043B 043C 043D 043E 043F 0440 0441 0442 0443 0444 0445 0446 0447 0448 0449 044A 044B 044C Developer Guide Character җ ҙ қ ҟ ҡ ң ҥ ҩ ҫ ҭ ү ұ ҳ ҵ ҷ һ ҽ ҿ ӊ ӑ Code 0497 0499 049B 049F 04A1 04A3 04A5 04A9 04AB 04AD 04AF 04B1 04B3 04B5 04B7 04BB 04BD 04BF 04CA 04D1 Kyrgyz 63 Amazon Transcribe Character э ю я ѐ ё ђ ѓ є ѕ і ї ј Code 044D 044E 044F 0450 0451 0452 0453 0454 0455 0456 0457 0458 Developer Guide Character ӓ ӗ ә ӡ ӣ ӧ ө ӯ ӱ ӳ ӷ ӹ Code 04D3 04D7 04D9 04E1 04E3 04E7 04E9 04EF 04F1 04F3 04F7 04F9 Latvian character set For Latvian custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Character ā Latvian Code 0101 Character ķ Code 0137 64
transcribe-dg-014	transcribe-dg.pdf	14	я ѐ ё ђ ѓ є ѕ і ї ј Code 044D 044E 044F 0450 0451 0452 0453 0454 0455 0456 0457 0458 Developer Guide Character ӓ ӗ ә ӡ ӣ ӧ ө ӯ ӱ ӳ ӷ ӹ Code 04D3 04D7 04D9 04E1 04E3 04E7 04E9 04EF 04F1 04F3 04F7 04F9 Latvian character set For Latvian custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Character ā Latvian Code 0101 Character ķ Code 0137 64 Amazon Transcribe Character č ē ģ ī ž Code 010D 0113 0123 012B 017E Lithuanian character set Developer Guide Character ļ ņ š ū Code 013C 0146 0161 016B For Lithuanian custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Character ą č ę ė ž Code 0105 010D 0119 0117 017E Luganda character set Character į š ų ū Code 012F 0161 0173 016B For Luganda custom vocabularies, you can use the following characters in the Phrase ﬁeld: Lithuanian 65 Amazon Transcribe • a - z • - (hyphen) • . (period) Developer Guide You can also use the following Unicode characters in the Phrase ﬁeld: Character ÿ Code 00FF Character ŋ Code 014B Macedonian character set For Macedonian custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Character а б в г д е ж з Code 0430 0431 0432 0433 0434 0435 0436 0437 Character љ њ ћ ќ ѝ ў џ ґ Code 0459 045A 045B 045C 045D 045E 045F 0491 Macedonian 66 Amazon Transcribe Character и й к л м н о п р с т у ф х ц ч ш щ ъ ы Code 0438 0439 043A 043B 043C 043D 043E 043F 0440 0441 0442 0443 0444 0445 0446 0447 0448 0449 044A 044B Developer Guide Character ғ җ ҙ қ ҟ ҡ ң ҥ ҩ ҫ ҭ ү ұ ҳ ҵ ҷ һ ҽ ҿ ӊ Code 0493 0497 0499 049B 049F 04A1 04A3 04A5 04A9 04AB 04AD 04AF 04B1 04B3 04B5 04B7 04BB 04BD 04BF 04CA Macedonian 67 Amazon Transcribe Character ь э ю я ѐ ё ђ ѓ є ѕ і ї ј Code 044C 044D 044E 044F 0450 0451 0452 0453 0454 0455 0456 0457 0458 Developer Guide Character ӑ ӓ ӗ ә ӡ ӣ ӧ ө ӯ ӱ ӳ ӷ ӹ Code 04D1 04D3 04D7 04D9 04E1 04E3 04E7 04E9 04EF 04F1 04F3 04F7 04F9 Malay character set For Malay custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • A - Z • ' (apostrophe) • - (hyphen) • . (period) Malay 68 Amazon Transcribe Developer Guide Malayalam character set For Malayalam custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Character ം ഃ അ ആ ഇ ഈ ഉ ഊ ഋ എ ഏ ഐ ഒ ഓ Code 0D02 0D03 0D05 0D06 0D07 0D08 0D09 0D0A 0D0B 0D0E 0D0F 0D10 0D12 0D13 Character ന പ ഫ ബ ഭ മ യ ര റ ല ള ഴ വ ശ Code 0D28 0D2A 0D2B 0D2C 0D2D 0D2E 0D2F 0D30 0D31 0D32 0D33 0D34 0D35 0D36 Malayalam 69 Amazon Transcribe Character ഔ ക ഖ ഗ ഘ ങ ച ഛ ജ ഝ ഞ ട ഠ ഡ ഢ ണ ത ഥ ദ ധ Code 0D14 0D15 0D16 0D17 0D18 0D19 0D1A 0D1B 0D1C 0D1D 0D1E 0D1F 0D20 0D21 0D22 0D23 0D24 0D25 0D26 0D27 Developer Guide Character ഷ സ ഹ ാ ി ീ ു ൂ ൃ െ േ ൈ ൊ ോ ൌ # # # # Code 0D37 0D38 0D39 0D3E 0D3F 0D40 0D41 0D42 0D43 0D46 0D47 0D48 0D4A 0D4B 0D4C 0D4D 0D7A 0D7B 0D7C 0D7D Malayalam 70 ് Amazon Transcribe Maltese character set Developer Guide For Maltese custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Character à è ì ò ż Code 00E0 00E8 00EC 00F2 017C Marathi character set Character ù ċ ġ ħ Code 00F9 010B 0121 0127 For Marathi custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the
transcribe-dg-015	transcribe-dg.pdf	15	Maltese character set Developer Guide For Maltese custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Character à è ì ò ż Code 00E0 00E8 00EC 00F2 017C Marathi character set Character ù ċ ġ ħ Code 00F9 010B 0121 0127 For Marathi custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Character Code 0901 0902 Character थ द Code 0925 0926 Maltese 71 ँ ं Amazon Transcribe Character ः अ आ इ ई उ ऊ ऋ ऍ ए ऐ ऑ ओ औ क ख ग घ ङ च Code 0903 0905 0906 0907 0908 0909 090A 090B 090D 090F 0910 0911 0913 0914 0915 0916 0917 0918 0919 091A Developer Guide Character ध न प फ ब भ म य र ल ळ व श ष स ह ा ि ी Code 0927 0928 092A 092B 092C 092D 092E 092F 0930 0932 0933 0935 0936 0937 0938 0939 093C 093E 093F 0940 Marathi 72 ़ Amazon Transcribe Character छ ज झ ञ ट ठ ड ढ ण त ॐ Code 091B 091C 091D 091E 091F 0920 0921 0922 0923 0924 0950 Developer Guide Character ॉ ो ौ Code 0941 0942 0943 0945 0947 0948 0949 094B 094C 094D Meadow Mari character set For Meadow Mari custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Character а б Meadow Mari Code 0430 0431 Character љ њ Code 0459 045A 73 ु ू ृ ॅ े ै ् Amazon Transcribe Character в г д е ж з и й к л м н о п р с т у ф х Code 0432 0433 0434 0435 0436 0437 0438 0439 043A 043B 043C 043D 043E 043F 0440 0441 0442 0443 0444 0445 Developer Guide Character ћ ќ ѝ ў џ ґ ғ җ ҙ қ ҟ ҡ ң ҥ ҩ ҫ ҭ ү ұ ҳ Code 045B 045C 045D 045E 045F 0491 0493 0497 0499 049B 049F 04A1 04A3 04A5 04A9 04AB 04AD 04AF 04B1 04B3 Meadow Mari 74 Amazon Transcribe Character ц ч ш щ ъ ы ь э ю я ѐ ё ђ ѓ є ѕ і ї ј Code 0446 0447 0448 0449 044A 044B 044C 044D 044E 044F 0450 0451 0452 0453 0454 0455 0456 0457 0458 Developer Guide Character ҵ ҷ һ ҽ ҿ ӊ ӑ ӓ ӗ ә ӡ ӣ ӧ ө ӯ ӱ ӳ ӷ ӹ Code 04B5 04B7 04BB 04BD 04BF 04CA 04D1 04D3 04D7 04D9 04E1 04E3 04E7 04E9 04EF 04F1 04F3 04F7 04F9 Meadow Mari 75 Amazon Transcribe Developer Guide Mongolian character set For Mongolian custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Character а б в г д е ж з и й к л м н Code 0430 0431 0432 0433 0434 0435 0436 0437 0438 0439 043A 043B 043C 043D Character љ њ ћ ќ ѝ ў џ ґ ғ җ ҙ қ ҟ ҡ Code 0459 045A 045B 045C 045D 045E 045F 0491 0493 0497 0499 049B 049F 04A1 Mongolian 76 Amazon Transcribe Character о п р с т у ф х ц ч ш щ ъ ы ь э ю я ѐ ё Code 043E 043F 0440 0441 0442 0443 0444 0445 0446 0447 0448 0449 044A 044B 044C 044D 044E 044F 0450 0451 Developer Guide Character ң ҥ ҩ ҫ ҭ ү ұ ҳ ҵ ҷ һ ҽ ҿ ӊ ӑ ӓ ӗ ә ӡ ӣ Code 04A3 04A5 04A9 04AB 04AD 04AF 04B1 04B3 04B5 04B7 04BB 04BD 04BF 04CA 04D1 04D3 04D7 04D9 04E1 04E3 Mongolian 77 Amazon Transcribe Character ђ ѓ є ѕ і ї ј Code 0452 0453 0454 0455 0456 0457 0458 Developer Guide Character ӧ ө ӯ ӱ ӳ ӷ ӹ Code 04E7 04E9 04EF 04F1 04F3 04F7 04F9 Norwegian Bokmål character set For Norwegian Bokmål custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Character å ø Code 00E5 00F8 Odia/Oriya character set Character æ Code 00E6 For Odia/Oriya custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z Norwegian Bokmål 78 Amazon Transcribe • -
transcribe-dg-016	transcribe-dg.pdf	16	0456 0457 0458 Developer Guide Character ӧ ө ӯ ӱ ӳ ӷ ӹ Code 04E7 04E9 04EF 04F1 04F3 04F7 04F9 Norwegian Bokmål character set For Norwegian Bokmål custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Character å ø Code 00E5 00F8 Odia/Oriya character set Character æ Code 00E6 For Odia/Oriya custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z Norwegian Bokmål 78 Amazon Transcribe • - (hyphen) • . (period) Developer Guide You can also use the following Unicode characters in the Phrase ﬁeld: Character ଂ ଃ ଅ ଆ ଇ ଈ ଉ ଊ ଋ ଏ ଐ ଓ ଔ କ ଖ ଗ Code 0B01 0B02 0B03 0B05 0B06 0B07 0B08 0B09 0B0A 0B0B 0B0F 0B10 0B13 0B14 0B15 0B16 0B17 Character ଦ ଧ ନ ପ ଫ ବ ଭ ମ ଯ ର ଲ ଳ ଶ ଷ ସ ହ Code 0B26 0B27 0B28 0B2A 0B2B 0B2C 0B2D 0B2E 0B2F 0B30 0B32 0B33 0B36 0B37 0B38 0B39 0B3C Odia/Oriya 79 ଁ ଼ Amazon Transcribe Character ଘ ଙ ଚ ଛ ଜ ଝ ଞ ଟ ଠ ଡ ଢ ଣ ତ ଥ # Code 0B18 0B19 0B1A 0B1B 0B1C 0B1D 0B1E 0B1F 0B20 0B21 0B22 0B23 0B24 0B25 0B71 Developer Guide Character ା ୀ େ ୈ େ# ୌ ୟ ୠ Code 0B3E 0B3F 0B40 0B41 0B42 0B43 0B47 0B48 0B4B 0B4C 0B4D 0B56 0B5F 0B60 Pashto character set For Pashto custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) Pashto 80 ି ୁ ୂ ୃ ୍ ୖ Amazon Transcribe Developer Guide You can also use the following Unicode characters in the Phrase ﬁeld: Code 0622 0623 0624 0626 0627 0628 062A 062B 062C 062D 062E 062F 0630 0631 0632 0633 0634 0635 0636 Character آ أ ؤ ئ ا ب ت ث ج ح خ د ذ ر ز س ش ص ض Pashto Character و ي # ټ پ ځ څ چ ډ ړ Code 0648 064A 064B 064C 064D 064E 064F 0650 0651 0652 0654 0670 067C 067E 0681 0685 0686 0689 0693 81 ً ٌ ٍ َ ُ ِ ّ ْ ٰ Amazon Transcribe Character ط ظ ع غ ف ق ل م ن ه Code 0637 0638 0639 063A 0641 0642 0644 0645 0646 0647 Developer Guide Character ږ ژ ښ ک ګ گ ڼ ی ۍ ې Code 0696 0698 069A 06A9 06AB 06AF 06BC 06CC 06CD 06D0 Polish character set For Polish custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Character ó ą ć Polish Code 00F3 0105 0107 Character ł ń ś Code 0142 0144 015B 82 Amazon Transcribe Character ę ż Code 0119 017C Portuguese character set Developer Guide Character ź Code 017A For Portuguese custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • A - Z • ' (apostrophe) • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Character À Á Â Ã Ä Ç È É Ê Code 00C0 00C1 00C2 00C3 00C4 00C7 00C8 00C9 00CA Character à á â ã ä ç è é ê Code 00E0 00E1 00E2 00E3 00E4 00E7 00E8 00E9 00EA Portuguese 83 Amazon Transcribe Character Ë Í Ñ Ó Ô Õ Ö Ú Ü Code 00CB 00CD 00D1 00D3 00D4 00D5 00D6 00DA 00DC Developer Guide Character ë í ñ ó ô õ ö ú ü Code 00EB 00ED 00F1 00F3 00F4 00F5 00F6 00FA 00FC Punjabi character set For Punjabi custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Character ਅ ਆ ਇ ਈ Punjabi Code 0A05 0A06 0A07 0A08 Character ਧ ਨ ਪ ਫ Code 0A27 0A28 0A2A 0A2B 84 Amazon Transcribe Character ਉ ਊ ਏ ਐ ਓ ਔ ਕ ਖ ਗ ਘ ਙ ਚ ਛ ਜ ਝ ਞ ਟ ਠ ਡ ਢ Code 0A09 0A0A 0A0F 0A10 0A13 0A14 0A15 0A16 0A17 0A18 0A19 0A1A 0A1B 0A1C 0A1D 0A1E 0A1F 0A20 0A21 0A22 Developer Guide Character ਬ ਭ ਮ ਯ ਰ ਲ ਵ ਸ ਹ ਾ ਿ ੀ Code 0A2C 0A2D 0A2E 0A2F 0A30 0A32 0A35 0A38 0A39 0A3C 0A3E 0A3F 0A40 0A41 0A42 0A47 0A48 0A4B 0A4C 0A4D Punjabi 85 ਼ ੁ ੂ ੇ ੈ ੋ ੌ ੍ Amazon Transcribe Character ਣ ਤ ਥ ਦ ੳ Code 0A23 0A24 0A25 0A26
transcribe-dg-017	transcribe-dg.pdf	17	ਉ ਊ ਏ ਐ ਓ ਔ ਕ ਖ ਗ ਘ ਙ ਚ ਛ ਜ ਝ ਞ ਟ ਠ ਡ ਢ Code 0A09 0A0A 0A0F 0A10 0A13 0A14 0A15 0A16 0A17 0A18 0A19 0A1A 0A1B 0A1C 0A1D 0A1E 0A1F 0A20 0A21 0A22 Developer Guide Character ਬ ਭ ਮ ਯ ਰ ਲ ਵ ਸ ਹ ਾ ਿ ੀ Code 0A2C 0A2D 0A2E 0A2F 0A30 0A32 0A35 0A38 0A39 0A3C 0A3E 0A3F 0A40 0A41 0A42 0A47 0A48 0A4B 0A4C 0A4D Punjabi 85 ਼ ੁ ੂ ੇ ੈ ੋ ੌ ੍ Amazon Transcribe Character ਣ ਤ ਥ ਦ ੳ Code 0A23 0A24 0A25 0A26 0A73 Romanian character set Developer Guide Character ੜ ੲ Code 0A5C 0A70 0A71 0A72 For Romanian custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Character ă â î ţ Code 0103 00E2 00EE 0163 Russian character set Character ș ț ş Code 0219 021B 015F For Russian custom vocabularies, you can use the following characters in the Phrase ﬁeld: Romanian 86 ੰ ੱ Amazon Transcribe Character ' - . а б в г д е ж з и й к л м н о Code 0027 002D 002E 0430 0431 0432 0433 0434 0435 0436 0437 0438 0439 043A 043B 043C 043D 043E Developer Guide Character п р с т у ф х ц ч ш щ ъ ы ь э ю я ё Code 043F 0440 0441 0442 0443 0444 0445 0446 0447 0448 0449 044A 044B 044C 044D 044E 044F 0451 Serbian character set For Serbian custom vocabularies, you can use the following characters in the Phrase ﬁeld: Serbian 87 Amazon Transcribe • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Developer Guide Character ć č đ š ž а б в г д е ж з и й к Code 0107 010D 0111 0161 017E 0430 0431 0432 0433 0434 0435 0436 0437 0438 0439 043A Character і ї ј љ њ ћ ќ ѝ ў џ ґ ғ җ ҙ қ ҟ Code 0456 0457 0458 0459 045A 045B 045C 045D 045E 045F 0491 0493 0497 0499 049B 049F Serbian 88 Amazon Transcribe Character л м н о п р с т у ф х ц ч ш щ ъ ы ь э ю Code 043B 043C 043D 043E 043F 0440 0441 0442 0443 0444 0445 0446 0447 0448 0449 044A 044B 044C 044D 044E Developer Guide Character ҡ ң ҥ ҩ ҫ ҭ ү ұ ҳ ҵ ҷ һ ҽ ҿ ӊ ӑ ӓ ӗ ә ӡ Code 04A1 04A3 04A5 04A9 04AB 04AD 04AF 04B1 04B3 04B5 04B7 04BB 04BD 04BF 04CA 04D1 04D3 04D7 04D9 04E1 Serbian 89 Amazon Transcribe Character я ѐ ё ђ ѓ є ѕ ӹ Code 044F 0450 0451 0452 0453 0454 0455 04F9 Developer Guide Character ӣ ӧ ө ӯ ӱ ӳ ӷ Code 04E3 04E7 04E9 04EF 04F1 04F3 04F7 Sinhala character set For Sinhala custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Character # # # # # Sinhala Code 0D82 0D83 0D85 0D86 0D87 Character # # # # # Code 0DAF 0DB0 0DB1 0DB3 0DB4 90 Amazon Transcribe Character # # # # # # # # # # # # # # # # # # # # Code 0D88 0D89 0D8A 0D8B 0D8C 0D8D 0D91 0D92 0D93 0D94 0D95 0D96 0D9A 0D9B 0D9C 0D9D 0D9E 0D9F 0DA0 0DA1 Developer Guide Character # # # # # # # # # # # # # # # # # # # # Code 0DB5 0DB6 0DB7 0DB8 0DB9 0DBA 0DBB 0DBD 0DC0 0DC1 0DC2 0DC3 0DC4 0DC5 0DC6 0DCA 0DCF 0DD0 0DD1 0DD2 Sinhala 91 Amazon Transcribe Character # # # # # # # # # # # # Code 0DA2 0DA3 0DA4 0DA5 0DA7 0DA8 0DA9 0DAA 0DAB 0DAC 0DAD 0DAE Developer Guide Character # # # # # ## # ## ### ## # # Code 0DD3 0DD4 0DD6 0DD8 0DD9 0DDA 0DDB 0DDC 0DDD 0DDE 0DDF 0DF2 Slovak character set For Slovak custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Character á Slovak Code 00E1 Character ň Code 0148 92 Amazon Transcribe Character ä č ď é í ĺ ľ ž Code 00E4 010D 010F 00E9 00ED 013A 013E 017E Developer Guide Character ó ô ŕ š ť
transcribe-dg-018	transcribe-dg.pdf	18	# # # ## # ## ### ## # # Code 0DD3 0DD4 0DD6 0DD8 0DD9 0DDA 0DDB 0DDC 0DDD 0DDE 0DDF 0DF2 Slovak character set For Slovak custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Character á Slovak Code 00E1 Character ň Code 0148 92 Amazon Transcribe Character ä č ď é í ĺ ľ ž Code 00E4 010D 010F 00E9 00ED 013A 013E 017E Developer Guide Character ó ô ŕ š ť ú ý Code 00F3 00F4 0155 0161 0165 00FA 00FD Slovenian character set For Slovenian custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Character č ž Code 010D 017E Somali character set Character š Code 0161 For Somali custom vocabularies, you can use the following characters in the Phrase ﬁeld: Slovenian 93 Amazon Transcribe • a - z • - (hyphen) • . (period) Developer Guide You can also use the following Unicode characters in the Phrase ﬁeld: Character s t a n Code 0073 0074 0061 006E Spanish character set Character d a r d Code 0064 0061 0072 0064 For Spanish custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • A - Z • ' (apostrophe) • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Character Á É Í Spanish Code 00C1 00C9 00CD Character á é í Code 00E1 00E9 00ED 94 Amazon Transcribe Character Ó Ú Ñ ü Code 00D3 00DA 00D1 00FC Sundanese character set Developer Guide Character ó ú ñ Code 0XF3 00FA 0XF1 For Sundanese custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Character s t a n Code 0073 0074 0061 006E Swahili character set Character d a r d Code 0064 0061 0072 0064 For Swahili custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) Sundanese 95 Amazon Transcribe Developer Guide You can also use the following Unicode characters in the Phrase ﬁeld: Character s t a n Code 0073 0074 0061 006E Swedish character set Character d a r d Code 0064 0061 0072 0064 For Swedish custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • A - Z • ' (apostrophe) • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Character Ä Å Ö Code 00C4 00C5 00D6 Character ä å ö Code 00E4 00E5 00F6 Tagalog/Filipino character set For Tagalog/Filipino custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z Swedish 96 Amazon Transcribe • - (hyphen) • . (period) Developer Guide You can also use the following Unicode characters in the Phrase ﬁeld: Character ñ Code 00F1 Tamil character set For Tamil custom vocabularies, you can use the following characters in the Phrase ﬁeld: Character அ ஆ இ ஈ உ ஊ எ ஏ ஐ ஒ ஓ ஔ Tamil Code 0B85 0B86 0B87 0B88 0B89 0B8A 0B8E 0B8F 0B90 0B92 0B93 0B94 Character ர ல வ ழ ள ற ன ஜ # ஷ ஸ ஹ Code 0BB0 0BB2 0BB5 0BB4 0BB3 0BB1 0BA9 0B9C 0BB6 0BB7 0BB8 0BB9 97 Amazon Transcribe Character ஃ க ங ச ஞ ட ண த ந ப ம ய Code 0B83 0B95 0B99 0B9A 0B9E 0B9F 0BA3 0BA4 0BA8 0BAA 0BAE 0BAF Developer Guide Character ா ி ீ ு ூ ெ ே ை ொ ோ ௌ Code 0BCD 0BBE 0BBF 0BC0 0BC1 0BC2 0BC6 0BC7 0BC8 0BCA 0BCB 0BCC Tatar character set For Tatar custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Character а Tatar Code 0430 Character љ Code 0459 98 ் Amazon Transcribe Character б в г д е ж з и й к л м н о п р с т у ф Code 0431 0432 0433 0434 0435 0436 0437 0438 0439 043A 043B 043C 043D 043E 043F 0440 0441 0442 0443 0444 Developer Guide Character њ ћ ќ ѝ ў џ ґ ғ җ ҙ қ ҟ ҡ ң ҥ ҩ ҫ ҭ ү ұ Code 045A 045B 045C 045D 045E 045F 0491 0493 0497 0499 049B
transcribe-dg-019	transcribe-dg.pdf	19	also use the following Unicode characters in the Phrase ﬁeld: Character а Tatar Code 0430 Character љ Code 0459 98 ் Amazon Transcribe Character б в г д е ж з и й к л м н о п р с т у ф Code 0431 0432 0433 0434 0435 0436 0437 0438 0439 043A 043B 043C 043D 043E 043F 0440 0441 0442 0443 0444 Developer Guide Character њ ћ ќ ѝ ў џ ґ ғ җ ҙ қ ҟ ҡ ң ҥ ҩ ҫ ҭ ү ұ Code 045A 045B 045C 045D 045E 045F 0491 0493 0497 0499 049B 049F 04A1 04A3 04A5 04A9 04AB 04AD 04AF 04B1 Tatar 99 Amazon Transcribe Character х ц ч ш щ ъ ы ь э ю я ѐ ё ђ ѓ є ѕ і ї ј Code 0445 0446 0447 0448 0449 044A 044B 044C 044D 044E 044F 0450 0451 0452 0453 0454 0455 0456 0457 0458 Developer Guide Character ҳ ҵ ҷ һ ҽ ҿ ӊ ӑ ӓ ӗ ә ӡ ӣ ӧ ө ӯ ӱ ӳ ӷ ӹ Code 04B3 04B5 04B7 04BB 04BD 04BF 04CA 04D1 04D3 04D7 04D9 04E1 04E3 04E7 04E9 04EF 04F1 04F3 04F7 04F9 Tatar 100 Amazon Transcribe Telugu character set Developer Guide For Telugu custom vocabularies, you can use the following characters in the Phrase ﬁeld: Character - ఁ ం ః అ ఆ ఇ ఈ ఉ ఊ ఋ ర ఱ ల ళ వ శ ష Code 002D 0C01 0C02 0C03 0C05 0C06 0C07 0C08 0C09 0C0A 0C0B 0C30 0C31 0C32 0C33 0C35 0C36 0C37 Character త థ ద ధ న ప ఫ బ భ మ య ఎ ఏ ఐ ఒ ఓ ఔ క Code 0C24 0C25 0C26 0C27 0C28 0C2A 0C2B 0C2C 0C2D 0C2E 0C2F 0C0E 0C0F 0C10 0C12 0C13 0C14 0C15 Telugu 101 Amazon Transcribe Character స హ ా ి ీ ు ూ ృ ౄ ే ై ొ ో ౌ ్ Code 0C38 0C39 0C3E 0C3F 0C40 0C41 0C42 0C43 0C44 0C47 0C48 0C4A 0C4B 0C4C 0C4D Developer Guide Character ఖ గ ఘ ఙ చ ఛ జ ఝ ఞ ట ఠ డ ఢ ణ Code 0C16 0C17 0C18 0C19 0C1A 0C1B 0C1C 0C1D 0C1E 0C1F 0C20 0C21 0C22 0C23 Thai character set For Thai custom vocabularies, you can use the following characters in the Phrase ﬁeld: • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Thai 102 Amazon Transcribe Character ก ข ฃ ค ฅ ฆ ง จ ฉ ช ซ ฌ ญ ฎ ฏ ฐ ฑ ฒ ณ ด Code 0E01 0E02 0E03 0E04 0E05 0E06 0E07 0E08 0E09 0E0A 0E0B 0E0C 0E0D 0E0E 0E0F 0E10 0E11 0E12 0E13 0E14 Developer Guide Character ล ฦ ว ศ ษ ส ห ฬ อ ฮ ฯ ะ า Code 0E25 0E26 0E27 0E28 0E29 0E2A 0E2B 0E2C 0E2D 0E2E 0E2F 0E30 0E31 0E32 0E34 0E35 0E36 0E37 0E38 0E39 Thai 103 ั ิ ี ึ ื ุ ู Amazon Transcribe Character ต ถ ท ธ น บ ป ผ ฝ พ ฟ ภ ม ย ร ฤ Code 0E15 0E16 0E17 0E18 0E19 0E1A 0E1B 0E1C 0E1D 0E1E 0E1F 0E20 0E21 0E22 0E23 0E24 Character เ แ โ ใ ไ ๅ ๆ Developer Guide Code 0E3A 0E40 0E41 0E42 0E43 0E44 0E45 0E46 0E47 0E48 0E49 0E4A 0E4B 0E4C 0E4D Turkish character set For Turkish custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • A - Z Turkish 104 ฺ ็ ่ ้ ๊ ๋ ์ ํ Amazon Transcribe • ' (apostrophe) • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Developer Guide Character Ç Ö Ü â ä ç è é ê í î ó Code 00C7 00D6 00DC 00E2 00E4 00E7 00E8 00E9 00EA 00ED 00EE 00F3 Character ö û ü Ğ ğ İ ı Ş ş š ž Code 00F6 00FB 00FC 011E 011F 0130 0131 015E 015F 0161 017E Ukrainian character set For Ukrainian custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) Ukrainian 105 Amazon Transcribe Developer Guide You can also use the following Unicode characters in the Phrase ﬁeld: Character а б в г д е ж з и й к л м н о п ґ Code 0430 0431 0432 0433 0434 0435 0436 0437 0438 0439 043A 043B 043C 043D 043E 043F 0491 Character р с т у ф х ц ч ш щ ь ю я є і ї Code 0440 0441 0442 0443 0444 0445 0446 0447 0448 0449 044C 044E 044F 0454 0456 0457 Uyghur character set For Uyghur custom vocabularies, you can use the following characters in the Phrase ﬁeld: Uyghur 106 Amazon
transcribe-dg-020	transcribe-dg.pdf	20	also use the following Unicode characters in the Phrase ﬁeld: Character а б в г д е ж з и й к л м н о п ґ Code 0430 0431 0432 0433 0434 0435 0436 0437 0438 0439 043A 043B 043C 043D 043E 043F 0491 Character р с т у ф х ц ч ш щ ь ю я є і ї Code 0440 0441 0442 0443 0444 0445 0446 0447 0448 0449 044C 044E 044F 0454 0456 0457 Uyghur character set For Uyghur custom vocabularies, you can use the following characters in the Phrase ﬁeld: Uyghur 106 Amazon Transcribe • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Developer Guide Character # # # ء آ أ ؤ إ ئ ا ب ة ت ث ج ح Code 0611 0613 0614 0621 0622 0623 0624 0625 0626 0627 0628 0629 062A 062B 062C 062D Character و ى ي # # # ٹ Code 0648 0649 064A 064B 064C 064D 064E 064F 0650 0651 0652 0653 0654 0657 0670 0679 Uyghur 107 ً ٌ ٍ َ ُ ِ ّ ْ ٰ Amazon Transcribe Character خ د ذ ر ز س ش ص ض ط ظ ع غ ـ ف ق ك ل م ن Code 062E 062F 0630 0631 0632 0633 0634 0635 0636 0637 0638 0639 063A 0640 0641 0642 0643 0644 0645 0646 Developer Guide Character ٺ ٻ ټ ٽ پ ٿ ڀ ځ ڃ ڄ څ چ ڇ ڈ ډ ڊ ڌ ڍ ڏ ڑ Code 067A 067B 067C 067D 067E 067F 0680 0681 0683 0684 0685 0686 0687 0688 0689 068A 068C 068D 068F 0691 Uyghur 108 Amazon Transcribe Character ه ڕ Code 0647 0695 Uzbek character set Developer Guide Character ړ Code 0693 For Uzbek custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Character т б о п ш и ч н қ е ю Code 0442 0431 043E 043F 0448 0438 0447 043D 049B 0435 044E Character я с ҳ д р ў г ё й в э Code 044F 0441 04B3 0434 0440 045E 0433 0451 0439 0432 044D Uzbek 109 Amazon Transcribe Character з х ц м ь ъ а Code 0437 0445 0446 043C 044C 044A 0430 Developer Guide Character л ф к у ж ғ Code 043B 0444 043A 0443 0436 0493 Vietnamese character set Amazon Transcribe represents the six tones in Vietnamese using numbers. The following table shows how tone marks are mapped for the word 'ma'. Tone name Tone mark Tone number ngang sắc huyền hỏi ngã nặng ma má mà mả mã mạ ma1 ma2 ma3 ma4 ma5 ma6 For Vietnamese custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • A - Z Vietnamese 110 Amazon Transcribe • ' (apostrophe) • - (hyphen) • . (period) • & (ampersand) • ; (semicolon) • _ (low line) Developer Guide You can also use the following Unicode characters in the Phrase ﬁeld: Character à á â ã è é ê ì í ò ó ô õ ù Code 00E0 00E1 00E2 00E3 00E8 00E9 00EA 00EC 00ED 00F2 00F3 00F4 00F5 00F9 Character À Á Â Ã È É Ê Ì Í Ò Ó Ô Õ Ù Code 00C0 00C1 00C2 00C3 00C8 00C9 00CA 00CC 00CD 00D2 00D3 00D4 00D5 00D9 Vietnamese 111 Amazon Transcribe Character ú ý ă đ ĩ ũ ơ ư ạ ả ấ ầ ẩ ẫ ậ ắ ằ ẳ ẵ ặ Code 00FA 00FD 0103 0111 0129 0169 01A1 01B0 1EA1 1EA3 1EA5 1EA7 1EA9 1EAB 1EAD 1EAF 1EB1 1EB3 1EB5 1EB7 Developer Guide Character Ú Ý Ă Đ Ĩ Ũ Ơ Ư Ạ Ả Ấ Ầ Ẩ Ẫ Ậ Ắ Ằ Ẳ Ẵ Ặ Code 00DA 00DD 0102 0110 0128 0168 01A0 01AF 1EA0 1EA2 1EA4 1EA6 1EA8 1EAA 1EAC 1EAE 1EB0 1EB2 1EB4 1EB6 Vietnamese 112 Amazon Transcribe Character ẹ ẻ ẽ ế ề ể ễ ệ ỉ ị ọ ỏ ố ồ ổ ỗ ộ ớ ờ ở Code 1EB9 1EBB 1EBD 1EBF 1EC1 1EC3 1EC5 1EC7 1EC9 1ECB 1ECD 1ECF 1ED1 1ED3 1ED5 1ED7 1ED9 1EDB 1EDD 1EDF Developer Guide Character Ẹ Ẻ Ẽ Ế Ề Ể Ễ Ệ Ỉ Ị Ọ Ỏ Ố Ồ Ổ Ỗ Ộ Ớ Ờ Ở Code 1EB8 1EBA 1EBC 1EBE 1EC0 1EC2 1EC4 1EC6 1EC8 1ECA 1ECC 1ECE 1ED0 1ED2 1ED4 1ED6 1ED8 1EDA 1EDC 1EDE Vietnamese 113 Amazon Transcribe Character ỡ ợ ụ ủ ứ ừ ử ữ ự ỳ ỵ ỷ ỹ Code 1EE1 1EE3 1EE5 1EE7 1EE9 1EEB 1EED 1EEF 1EF1 1EF3
transcribe-dg-021	transcribe-dg.pdf	21	ổ ỗ ộ ớ ờ ở Code 1EB9 1EBB 1EBD 1EBF 1EC1 1EC3 1EC5 1EC7 1EC9 1ECB 1ECD 1ECF 1ED1 1ED3 1ED5 1ED7 1ED9 1EDB 1EDD 1EDF Developer Guide Character Ẹ Ẻ Ẽ Ế Ề Ể Ễ Ệ Ỉ Ị Ọ Ỏ Ố Ồ Ổ Ỗ Ộ Ớ Ờ Ở Code 1EB8 1EBA 1EBC 1EBE 1EC0 1EC2 1EC4 1EC6 1EC8 1ECA 1ECC 1ECE 1ED0 1ED2 1ED4 1ED6 1ED8 1EDA 1EDC 1EDE Vietnamese 113 Amazon Transcribe Character ỡ ợ ụ ủ ứ ừ ử ữ ự ỳ ỵ ỷ ỹ Code 1EE1 1EE3 1EE5 1EE7 1EE9 1EEB 1EED 1EEF 1EF1 1EF3 1EF5 1EF7 1EF9 Developer Guide Character Ỡ Ợ Ụ Ủ Ứ Ừ Ử Ữ Ự Ỳ Ỵ Ỷ Ỹ Code 1EE0 1EE2 1EE4 1EE6 1EE8 1EEA 1EEC 1EEE 1EF0 1EF2 1EF4 1EF6 1EF8 Welsh character set For Welsh custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Welsh 114 Amazon Transcribe Character à á â ä è é ê ë ì í î ï ỳ Code 00E0 00E1 00E2 00E4 00E8 00E9 00EA 00EB 00EC 00ED 00EE 00EF 1EF3 Developer Guide Character ò ó ô ö ù ú û ü ý ÿ ŵ ŷ Code 00F2 00F3 00F4 00F6 00F9 00FA 00FB 00FC 00FD 00FF 0175 0177 Wolof character set For Wolof custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Wolof 115 Amazon Transcribe Character à ã ç è é ŋ Code 00E0 00E3 00E7 00E8 00E9 014B Developer Guide Character ê ë ñ ó ô Code 00EA 00EB 00F1 00F3 00F4 Zulu character set For Zulu custom vocabularies, you can use the following characters in the Phrase ﬁeld: • a - z • - (hyphen) • . (period) You can also use the following Unicode characters in the Phrase ﬁeld: Code 0073 0074 0061 006E Character d a r d Code 0064 0061 0072 0064 Character s t a n Zulu 116 Amazon Transcribe Developer Guide How Amazon Transcribe works Amazon Transcribe uses machine learning models to convert speech to text. In addition to the transcribed text, transcripts contains data about the transcribed content, including conﬁdence scores and timestamps for each word or punctuation mark. To see an output example, refer to the Data input and output section. For a complete list of features that you can apply to your transcription, refer to the feature summary. Transcription methods can be separated into two main categories: • Batch transcriptions: Transcribe media ﬁles that have been uploaded into an Amazon S3 bucket. You can use the AWS CLI, AWS Management Console, and various AWS SDKs for batch transcriptions. • Streaming transcriptions: Transcribe media streams in real time. You can use the AWS Management Console, HTTP/2, WebSockets, and various AWS SDKs for streaming transcriptions. Note that feature and language support diﬀers for batch and streaming transcriptions. For more information, refer to Amazon Transcribe features and Supported languages. Topics • Data input and output • Transcribing numbers and punctuation API operations to get you started Batch: StartTranscriptionJob Streaming: StartStreamTranscription, StartStreamTranscriptionWebSocket Data input and output Amazon Transcribe takes audio data, as a media ﬁle in an Amazon S3 bucket or a media stream, and converts it to text data. Data input and output 117 Amazon Transcribe Developer Guide If you're transcribing media ﬁles stored in an Amazon S3 bucket, you're performing batch transcriptions. If you're transcribing media streams, you're performing streaming transcriptions. These two processes have diﬀerent rules and requirements. With batch transcriptions, you can use Job queueing if you don't need to process all of your transcription jobs concurrently. This allows Amazon Transcribe to keep track of your transcription jobs and process them when slots are available. Note Amazon Transcribe may temporarily store your content to continuously improve the quality of its analysis models. See the Amazon Transcribe FAQ to learn more. To request the deletion of content that may have been stored by Amazon Transcribe, open a case with Support. Topics • Media formats • Audio channels • Sample rates • Output Media formats Supported media types diﬀer between batch transcriptions and streaming transcriptions, though lossless formats are recommended for both. See the following table for details: Supported formats Batch • AMR • FLAC • M4A • MP3 • MP4 • Ogg Streaming • FLAC • Ogg Opus • PCM encoding Media formats 118 Amazon Transcribe Developer Guide Batch • WebM • WAV Streaming Recommended formats • FLAC • FLAC • WAV with PCM 16-bit • PCM signed 16-bit little-en encoding dian audio (note that this does not include WAV) For
transcribe-dg-022	transcribe-dg.pdf	22	• Media formats • Audio channels • Sample rates • Output Media formats Supported media types diﬀer between batch transcriptions and streaming transcriptions, though lossless formats are recommended for both. See the following table for details: Supported formats Batch • AMR • FLAC • M4A • MP3 • MP4 • Ogg Streaming • FLAC • Ogg Opus • PCM encoding Media formats 118 Amazon Transcribe Developer Guide Batch • WebM • WAV Streaming Recommended formats • FLAC • FLAC • WAV with PCM 16-bit • PCM signed 16-bit little-en encoding dian audio (note that this does not include WAV) For best results, use a lossless format, such as FLAC or WAV with PCM 16-bit encoding. Note Streaming transcriptions are not supported with all languages. Refer to the 'Data input' column in the supported languages table for details. Audio channels Amazon Transcribe supports single-channel and dual-channel media. Media with more than two channels is not currently supported. If your audio contains multiple speakers on one channel and you want to partition and label each speaker in your transcription output, you can use Speaker partitioning (diarization). If your audio contains speech on two separate channels, you can use Channel identiﬁcation to transcribe each channel separately within your transcript. Both of these options produce one transcript ﬁle. Note If you don't enable Speaker partitioning or Channel identiﬁcation, your transcript text is provided as one continuous section. Audio channels 119 Amazon Transcribe Sample rates Developer Guide With batch transcription jobs, you can choose to provide a sample rate, though this parameter is optional. If you include it in your request, make sure the value you provide matches the actual sample rate in your audio. If you provide a sample rate that doesn't match your audio, your job may fail. With streaming transcriptions, you must include a sample rate in your request. As with batch transcription jobs, make sure the value you provide matches the actual sample rate in your audio. Sample rates for low ﬁdelity audio, such as telephone recordings, typically use 8,000 Hz. For high ﬁdelity audio, Amazon Transcribe supports values between 16,000 Hz and 48,000 Hz. Output Transcription output is in JSON format. The ﬁrst part of your transcript contains the transcript itself in paragraph form, followed by additional data for every word and punctuation mark. The data provided depends on the features you include in your request. At a minimum, your transcript contains the start time, end time, and conﬁdence score for every word. The following section shows example output from a basic transcription request that didn't include any additional options or features. All batch transcripts are stored in Amazon S3 buckets. You can choose to save your transcript in your own Amazon S3 bucket, or have Amazon Transcribe use a secure default bucket. To learn more about creating and using Amazon S3 buckets, see Working with buckets. If you want your transcript stored in an Amazon S3 bucket that you own, specify the bucket's URI in your transcription request. Make sure you give Amazon Transcribe write permissions for this bucket before starting your batch transcription job. If you specify your own bucket, your transcript remains in that bucket until you remove it. If you don't specify an Amazon S3 bucket, Amazon Transcribe uses a secure service-managed bucket and provides you with a temporary URI you can use to download your transcript. Note that temporary URIs are valid for 15 minutes. If you get an AccessDenied error when using the provided URI, make a GetTranscriptionJob request to get a new temporary URI for your transcript. If you opt for a default bucket, your transcript is deleted when your job expires (90 days). If you want to keep your transcript past this expiration date, you must download it. Sample rates 120 Amazon Transcribe Developer Guide Streaming transcripts are returned via the same method you're using for your stream. Tip If you want to convert your JSON output into a turn-by-turn transcript in Word format, see this GitHub example (for Python3). This script works with post-call analytics transcripts and standard batch transcripts with diarization enabled. Example output Transcripts provide a complete transcription in paragraph form, followed by a word-for-word breakdown, which provides data for every word and punctuation mark. This includes start time, end time, a conﬁdence score, and a type (pronunciation or punctuation). The following example is from a simple batch transcription job that didn't include any additional features. With each additional feature that you apply to your transcription request, you get additional data in your transcript output ﬁle. Basic batch transcripts contain two main sections: 1. transcripts: Contains the entire transcript in one text block. 2. items: Contains information on each word and punctuation mark from the transcripts section. 3. audio_segments: An audio segment is a speciﬁc portion of an audio
transcribe-dg-023	transcribe-dg.pdf	23	for every word and punctuation mark. This includes start time, end time, a conﬁdence score, and a type (pronunciation or punctuation). The following example is from a simple batch transcription job that didn't include any additional features. With each additional feature that you apply to your transcription request, you get additional data in your transcript output ﬁle. Basic batch transcripts contain two main sections: 1. transcripts: Contains the entire transcript in one text block. 2. items: Contains information on each word and punctuation mark from the transcripts section. 3. audio_segments: An audio segment is a speciﬁc portion of an audio recording that contains uninterrupted spoken language, with minimal pauses or breaks. This segment captures a natural ﬂow of speech and is captured in audio_segments with a start time and end time. The items element within an audio segment is a sequence of identiﬁers that correspond to each item within the segment. Each additional feature you include in your transcription request produces additional information in your transcript. { "jobName": "my-first-transcription-job", "accountId": "111122223333", "results": { "transcripts": [ { Output 121 Amazon Transcribe Developer Guide "transcript": "Welcome to Amazon Transcribe." } ], "items": [ { "id": 0, "start_time": "0.64", "end_time": "1.09", "alternatives": [ { "confidence": "1.0", "content": "Welcome" } ], "type": "pronunciation" }, { "id": 1, "start_time": "1.09", "end_time": "1.21", "alternatives": [ { "confidence": "1.0", "content": "to" } ], "type": "pronunciation" }, { "id": 2, "start_time": "1.21", "end_time": "1.74", "alternatives": [ { "confidence": "1.0", "content": "Amazon" } ], "type": "pronunciation" }, { "id": 3, "start_time": "1.74", "end_time": "2.56", Output 122 Amazon Transcribe Developer Guide "alternatives": [ { "confidence": "1.0", "content": "Transcribe" } ], "type": "pronunciation" }, { "id": 4, "alternatives": [ { "confidence": "0.0", "content": "." } ], "type": "punctuation" } ], "audio_segments": [ { "id": 0, "transcript": "Welcome to Amazon Transcribe.", "start_time": "0.64", "end_time": "2.56", "items": [ 0, 1, 2, 3, 4 ] } ] }, "status": "COMPLETED" } Transcribing numbers and punctuation Amazon Transcribe automatically adds punctuation to all supported languages, and capitalizes words appropriately for languages that use case distinction in their writing systems. Transcribing numbers 123 Amazon Transcribe Developer Guide For most languages, numbers are transcribed into their word forms. However, for languages with support for transcribing numbers, Amazon Transcribe treats numbers diﬀerently depending on the context in which they're used. For example, if a speaker says "Meet me at eight-thirty AM on June ﬁrst at one-hundred Main Street with three-dollars-and-ﬁfty-cents and one-point-ﬁve chocolate bars," this is transcribed as: • Languages with number transcription support: Meet me at 8:30 a.m. on June 1st at 100 Main Street with $3.50 and 1.5 chocolate bars • All other languages: Meet me at eight thirty a m on June ﬁrst at one hundred Main Street with three dollars and ﬁfty cents and one point ﬁve chocolate bars To view the languages with support for transcribing numbers, refer to Supported languages and language-speciﬁc features. Transcribing numbers 124 Amazon Transcribe Developer Guide Getting started with Amazon Transcribe Before you can create transcriptions, you have a few prerequisites: • Sign up for an AWS account • Install the AWS CLI and SDKs (if you're using the AWS Management Console for your transcriptions, you can skip this step) • Conﬁgure IAM credentials • Set up an Amazon S3 bucket • Create an IAM policy Once you complete these prerequisites, you're ready to transcribe. Select your preferred transcription method from the following list to get started. • AWS CLI • AWS Management Console • AWS SDK • HTTP • WebSockets Tip If you're new to Amazon Transcribe or would like to explore our features, we recommend using the AWS Management Console. This is also the easiest option if you'd like to start a stream using your computer microphone. Because streaming using HTTP/2 and WebSockets is more complicated than the other transcription methods, we recommend reviewing the Setting up a streaming transcription section before getting started with these methods. Note that we strongly recommend using an SDK for streaming transcriptions. 125 Amazon Transcribe Developer Guide Signing up for an AWS account You can sign up for a free tier account or a paid account. Both options give you access to all AWS services. The free tier has a trial period during which you can explore AWS services and estimate your usage. Once your trial period expires, you can migrate to a paid account. Fees are accrued on a pay-as-you-use basis; see Amazon Transcribe Pricing for details. Tip When setting up your account, make note of your AWS account ID because you need it to create IAM entities. Installing the AWS CLI and SDKs To use the Amazon Transcribe API, you must ﬁrst install the AWS CLI. The current AWS CLI is version 2. You can ﬁnd installation instructions for Linux, Mac, Windows, and Docker in the AWS Command
transcribe-dg-024	transcribe-dg.pdf	24	trial period during which you can explore AWS services and estimate your usage. Once your trial period expires, you can migrate to a paid account. Fees are accrued on a pay-as-you-use basis; see Amazon Transcribe Pricing for details. Tip When setting up your account, make note of your AWS account ID because you need it to create IAM entities. Installing the AWS CLI and SDKs To use the Amazon Transcribe API, you must ﬁrst install the AWS CLI. The current AWS CLI is version 2. You can ﬁnd installation instructions for Linux, Mac, Windows, and Docker in the AWS Command Line Interface User Guide. Once you have the AWS CLI installed, you must conﬁgure it for your security credentials and AWS Region. If you want to use Amazon Transcribe with an SDK, select your preferred language for installation instructions: • .NET • C++ • Go • Java V2 • JavaScript • PHP V3 • AWS SDK for Python (Boto3) (batch transcriptions) • Python (streaming transcriptions) • Ruby V3 • Rust (batch transcriptions) • Rust (streaming transcriptions) Signing up for an AWS account 126 Amazon Transcribe Developer Guide Conﬁgure IAM credentials When you create an AWS account, you begin with one sign-in identity that has complete access to all AWS services and resources in your account. This identity is called the AWS account root user and is accessed by signing in with the email address and password that you used to create the account. We strongly recommend that you do not use the root user for your everyday tasks. Safeguard your root user credentials and use them to perform the tasks that only the root user can perform. As a best practice, require users—including those that require administrator access—to use federation with an identity provider to access AWS services by using temporary credentials. A federated identity is any user who accesses AWS services by using credentials provided through an identity source. When federated identities access AWS accounts, they assume roles, and the roles provide temporary credentials. For centralized access management, we recommend that you use AWS IAM Identity Center. You can create users and groups in IAM Identity Center. Or you can connect and synchronize to a set of users and groups in your own identity source for use across all your AWS accounts and applications. For more information, see Identity and Access Management for Amazon Transcribe. To learn more about IAM best practices, refer to Security best practices in IAM. Creating an Amazon S3 bucket Amazon S3 is a secure object storage service. Amazon S3 stores your ﬁles (called objects) in containers (called buckets). To run a batch transcription, you must ﬁrst upload your media ﬁles into an Amazon S3 bucket. If you don't specify an Amazon S3 bucket for your transcription output, Amazon Transcribe puts your transcript in a temporary AWS-managed Amazon S3 bucket. Transcription output in AWS-managed buckets is automatically deleted after 90 days. Learn how to Create your ﬁrst S3 bucket and Upload an object to your bucket. Creating an IAM policy To manage access in AWS, you must create policies and attach them to IAM identities (users, groups, or roles) or AWS resources. A policy deﬁnes the permissions of the entity it is attached Conﬁgure IAM credentials 127 Amazon Transcribe Developer Guide to. For example, a role can only access a media ﬁle located in your Amazon S3 bucket if you've attached a policy to that role which grants it access. If you want to further restrict that role, you can instead limit its access to a speciﬁc ﬁle within an Amazon S3 bucket. To learn more about using AWS policies see: • Policies and permissions in IAM • Creating IAM policies • How Amazon Transcribe works with IAM For example policies you can use with Amazon Transcribe, see Amazon Transcribe identity-based policy examples. If you want to generate custom policies, consider using the AWS Policy Generator. You can add a policy using the AWS Management Console, AWS CLI, or AWS SDK. For instructions, see Adding and removing IAM identity permissions. Policies have the format: { "Version": "2012-10-17", "Statement": [ { "Sid": "my-policy-name", "Effect": "Allow", "Action": [ "service:action" ], "Resource": [ "amazon-resource-name" ] } ] } Amazon Resource Names (ARNs) uniquely identify all AWS resources, such as an Amazon S3 bucket. You can use ARNs in your policy to grant permissions for speciﬁc actions to use speciﬁc resources. For example, if you want to grant read access to an Amazon S3 bucket and its sub-folders, you can add the following code to your trust policy's Statement section: { Creating an IAM policy 128 Amazon Transcribe Developer Guide "Effect": "Allow", "Action": [ "s3:GetObject", "s3:ListBucket" ], "Resource": [ "arn:aws:s3:::amzn-s3-demo-bucket", "arn:aws:s3:::amzn-s3-demo-bucket/*" ] } Here's an example policy that grants Amazon Transcribe read (GetObject, ListBucket) and write (PutObject) permissions to

Subsets and Splits

No community queries yet

The top public SQL queries from the community will appear here once available.