amazonka-transcribe-2.0: Amazon Transcribe Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Transcribe.Lens

Description

 
Synopsis

Operations

CreateCallAnalyticsCategory

createCallAnalyticsCategory_inputType :: Lens' CreateCallAnalyticsCategory (Maybe InputType) Source #

Choose whether you want to create a streaming or a batch category for your Call Analytics transcription.

Specifying POST_CALL assigns your category to batch transcriptions; categories with this input type cannot be applied to streaming (real-time) transcriptions.

Specifying REAL_TIME assigns your category to streaming transcriptions; categories with this input type cannot be applied to batch (post-call) transcriptions.

If you do not include InputType, your category is created as a batch category by default.

createCallAnalyticsCategory_categoryName :: Lens' CreateCallAnalyticsCategory Text Source #

A unique name, chosen by you, for your Call Analytics category. It's helpful to use a detailed naming system that will make sense to you in the future. For example, it's better to use sentiment-positive-last30seconds for a category over a generic name like test-category.

Category names are case sensitive.

createCallAnalyticsCategory_rules :: Lens' CreateCallAnalyticsCategory (NonEmpty Rule) Source #

Rules define a Call Analytics category. When creating a new category, you must create between 1 and 20 rules for that category. For each rule, you specify a filter you want applied to the attributes of a call. For example, you can choose a sentiment filter that detects if a customer's sentiment was positive during the last 30 seconds of the call.

createCallAnalyticsCategoryResponse_categoryProperties :: Lens' CreateCallAnalyticsCategoryResponse (Maybe CategoryProperties) Source #

Provides you with the properties of your new category, including its associated rules.

CreateLanguageModel

createLanguageModel_tags :: Lens' CreateLanguageModel (Maybe (NonEmpty Tag)) Source #

Adds one or more custom tags, each in the form of a key:value pair, to a new custom language model at the time you create this new model.

To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

createLanguageModel_languageCode :: Lens' CreateLanguageModel CLMLanguageCode Source #

The language code that represents the language of your model. Each custom language model must contain terms in only one language, and the language you select for your custom language model must match the language of your training and tuning data.

For a list of supported languages and their associated language codes, refer to the Supported languages table. Note that US English (en-US) is the only language supported with Amazon Transcribe Medical.

A custom language model can only be used to transcribe files in the same language as the model. For example, if you create a custom language model using US English (en-US), you can only apply this model to files that contain English audio.

createLanguageModel_baseModelName :: Lens' CreateLanguageModel BaseModelName Source #

The Amazon Transcribe standard language model, or base model, used to create your custom language model. Amazon Transcribe offers two options for base models: Wideband and Narrowband.

If the audio you want to transcribe has a sample rate of 16,000 Hz or greater, choose WideBand. To transcribe audio with a sample rate less than 16,000 Hz, choose NarrowBand.

createLanguageModel_modelName :: Lens' CreateLanguageModel Text Source #

A unique name, chosen by you, for your custom language model.

This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new custom language model with the same name as an existing custom language model, you get a ConflictException error.

createLanguageModel_inputDataConfig :: Lens' CreateLanguageModel InputDataConfig Source #

Contains the Amazon S3 location of the training data you want to use to create a new custom language model, and permissions to access this location.

When using InputDataConfig, you must include these sub-parameters: S3Uri, which is the Amazon S3 location of your training data, and DataAccessRoleArn, which is the Amazon Resource Name (ARN) of the role that has permission to access your specified Amazon S3 location. You can optionally include TuningDataS3Uri, which is the Amazon S3 location of your tuning data. If you specify different Amazon S3 locations for training and tuning data, the ARN you use must have permissions to access both locations.

createLanguageModelResponse_baseModelName :: Lens' CreateLanguageModelResponse (Maybe BaseModelName) Source #

The Amazon Transcribe standard language model, or base model, you specified when creating your custom language model.

createLanguageModelResponse_inputDataConfig :: Lens' CreateLanguageModelResponse (Maybe InputDataConfig) Source #

Lists your data access role ARN (Amazon Resource Name) and the Amazon S3 locations you provided for your training (S3Uri) and tuning (TuningDataS3Uri) data.

createLanguageModelResponse_languageCode :: Lens' CreateLanguageModelResponse (Maybe CLMLanguageCode) Source #

The language code you selected for your custom language model.

createLanguageModelResponse_modelStatus :: Lens' CreateLanguageModelResponse (Maybe ModelStatus) Source #

The status of your custom language model. When the status displays as COMPLETED, your model is ready to use.

CreateMedicalVocabulary

createMedicalVocabulary_tags :: Lens' CreateMedicalVocabulary (Maybe (NonEmpty Tag)) Source #

Adds one or more custom tags, each in the form of a key:value pair, to a new custom medical vocabulary at the time you create this new custom vocabulary.

To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

createMedicalVocabulary_vocabularyName :: Lens' CreateMedicalVocabulary Text Source #

A unique name, chosen by you, for your new custom medical vocabulary.

This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new custom medical vocabulary with the same name as an existing custom medical vocabulary, you get a ConflictException error.

createMedicalVocabulary_languageCode :: Lens' CreateMedicalVocabulary LanguageCode Source #

The language code that represents the language of the entries in your custom vocabulary. US English (en-US) is the only language supported with Amazon Transcribe Medical.

createMedicalVocabulary_vocabularyFileUri :: Lens' CreateMedicalVocabulary Text Source #

The Amazon S3 location (URI) of the text file that contains your custom medical vocabulary. The URI must be in the same Amazon Web Services Region as the resource you're calling.

Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt

createMedicalVocabularyResponse_failureReason :: Lens' CreateMedicalVocabularyResponse (Maybe Text) Source #

If VocabularyState is FAILED, FailureReason contains information about why the medical transcription job request failed. See also: Common Errors.

createMedicalVocabularyResponse_languageCode :: Lens' CreateMedicalVocabularyResponse (Maybe LanguageCode) Source #

The language code you selected for your custom medical vocabulary. US English (en-US) is the only language supported with Amazon Transcribe Medical.

createMedicalVocabularyResponse_lastModifiedTime :: Lens' CreateMedicalVocabularyResponse (Maybe UTCTime) Source #

The date and time you created your custom medical vocabulary.

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.

createMedicalVocabularyResponse_vocabularyState :: Lens' CreateMedicalVocabularyResponse (Maybe VocabularyState) Source #

The processing state of your custom medical vocabulary. If the state is READY, you can use the custom vocabulary in a StartMedicalTranscriptionJob request.

CreateVocabulary

createVocabulary_phrases :: Lens' CreateVocabulary (Maybe [Text]) Source #

Use this parameter if you want to create your custom vocabulary by including all desired terms, as comma-separated values, within your request. The other option for creating your custom vocabulary is to save your entries in a text file and upload them to an Amazon S3 bucket, then specify the location of your file using the VocabularyFileUri parameter.

Note that if you include Phrases in your request, you cannot use VocabularyFileUri; you must choose one or the other.

Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.

createVocabulary_tags :: Lens' CreateVocabulary (Maybe (NonEmpty Tag)) Source #

Adds one or more custom tags, each in the form of a key:value pair, to a new custom vocabulary at the time you create this new custom vocabulary.

To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

createVocabulary_vocabularyFileUri :: Lens' CreateVocabulary (Maybe Text) Source #

The Amazon S3 location of the text file that contains your custom vocabulary. The URI must be located in the same Amazon Web Services Region as the resource you're calling.

Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt

Note that if you include VocabularyFileUri in your request, you cannot use the Phrases flag; you must choose one or the other.

createVocabulary_vocabularyName :: Lens' CreateVocabulary Text Source #

A unique name, chosen by you, for your new custom vocabulary.

This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new custom vocabulary with the same name as an existing custom vocabulary, you get a ConflictException error.

createVocabulary_languageCode :: Lens' CreateVocabulary LanguageCode Source #

The language code that represents the language of the entries in your custom vocabulary. Each custom vocabulary must contain terms in only one language.

A custom vocabulary can only be used to transcribe files in the same language as the custom vocabulary. For example, if you create a custom vocabulary using US English (en-US), you can only apply this custom vocabulary to files that contain English audio.

For a list of supported languages and their associated language codes, refer to the Supported languages table.

createVocabularyResponse_failureReason :: Lens' CreateVocabularyResponse (Maybe Text) Source #

If VocabularyState is FAILED, FailureReason contains information about why the custom vocabulary request failed. See also: Common Errors.

createVocabularyResponse_languageCode :: Lens' CreateVocabularyResponse (Maybe LanguageCode) Source #

The language code you selected for your custom vocabulary.

createVocabularyResponse_lastModifiedTime :: Lens' CreateVocabularyResponse (Maybe UTCTime) Source #

The date and time you created your custom vocabulary.

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.

createVocabularyResponse_vocabularyName :: Lens' CreateVocabularyResponse (Maybe Text) Source #

The name you chose for your custom vocabulary.

createVocabularyResponse_vocabularyState :: Lens' CreateVocabularyResponse (Maybe VocabularyState) Source #

The processing state of your custom vocabulary. If the state is READY, you can use the custom vocabulary in a StartTranscriptionJob request.

CreateVocabularyFilter

createVocabularyFilter_tags :: Lens' CreateVocabularyFilter (Maybe (NonEmpty Tag)) Source #

Adds one or more custom tags, each in the form of a key:value pair, to a new custom vocabulary filter at the time you create this new vocabulary filter.

To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

createVocabularyFilter_vocabularyFilterFileUri :: Lens' CreateVocabularyFilter (Maybe Text) Source #

The Amazon S3 location of the text file that contains your custom vocabulary filter terms. The URI must be located in the same Amazon Web Services Region as the resource you're calling.

Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt

Note that if you include VocabularyFilterFileUri in your request, you cannot use Words; you must choose one or the other.

createVocabularyFilter_words :: Lens' CreateVocabularyFilter (Maybe (NonEmpty Text)) Source #

Use this parameter if you want to create your custom vocabulary filter by including all desired terms, as comma-separated values, within your request. The other option for creating your vocabulary filter is to save your entries in a text file and upload them to an Amazon S3 bucket, then specify the location of your file 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 specific language. If you use unsupported characters, your custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.

createVocabularyFilter_vocabularyFilterName :: Lens' CreateVocabularyFilter Text Source #

A unique name, chosen by you, for your new custom vocabulary filter.

This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new custom vocabulary filter with the same name as an existing custom vocabulary filter, you get a ConflictException error.

createVocabularyFilter_languageCode :: Lens' CreateVocabularyFilter LanguageCode Source #

The language code that represents the language of the entries in your vocabulary filter. Each custom vocabulary filter must contain terms in only one language.

A custom vocabulary filter can only be used to transcribe files in the same language as the filter. For example, if you create a custom vocabulary filter using US English (en-US), you can only apply this filter to files that contain English audio.

For a list of supported languages and their associated language codes, refer to the Supported languages table.

createVocabularyFilterResponse_languageCode :: Lens' CreateVocabularyFilterResponse (Maybe LanguageCode) Source #

The language code you selected for your custom vocabulary filter.

createVocabularyFilterResponse_lastModifiedTime :: Lens' CreateVocabularyFilterResponse (Maybe UTCTime) Source #

The date and time you created your custom vocabulary filter.

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.

DeleteCallAnalyticsCategory

deleteCallAnalyticsCategory_categoryName :: Lens' DeleteCallAnalyticsCategory Text Source #

The name of the Call Analytics category you want to delete. Category names are case sensitive.

DeleteCallAnalyticsJob

deleteCallAnalyticsJob_callAnalyticsJobName :: Lens' DeleteCallAnalyticsJob Text Source #

The name of the Call Analytics job you want to delete. Job names are case sensitive.

DeleteLanguageModel

deleteLanguageModel_modelName :: Lens' DeleteLanguageModel Text Source #

The name of the custom language model you want to delete. Model names are case sensitive.

DeleteMedicalTranscriptionJob

deleteMedicalTranscriptionJob_medicalTranscriptionJobName :: Lens' DeleteMedicalTranscriptionJob Text Source #

The name of the medical transcription job you want to delete. Job names are case sensitive.

DeleteMedicalVocabulary

deleteMedicalVocabulary_vocabularyName :: Lens' DeleteMedicalVocabulary Text Source #

The name of the custom medical vocabulary you want to delete. Custom medical vocabulary names are case sensitive.

DeleteTranscriptionJob

deleteTranscriptionJob_transcriptionJobName :: Lens' DeleteTranscriptionJob Text Source #

The name of the transcription job you want to delete. Job names are case sensitive.

DeleteVocabulary

deleteVocabulary_vocabularyName :: Lens' DeleteVocabulary Text Source #

The name of the custom vocabulary you want to delete. Custom vocabulary names are case sensitive.

DeleteVocabularyFilter

deleteVocabularyFilter_vocabularyFilterName :: Lens' DeleteVocabularyFilter Text Source #

The name of the custom vocabulary filter you want to delete. Custom vocabulary filter names are case sensitive.

DescribeLanguageModel

describeLanguageModel_modelName :: Lens' DescribeLanguageModel Text Source #

The name of the custom language model you want information about. Model names are case sensitive.

describeLanguageModelResponse_languageModel :: Lens' DescribeLanguageModelResponse (Maybe LanguageModel) Source #

Provides information about the specified custom language model.

This parameter also shows if the base language model you used to create your custom language model has been updated. If Amazon Transcribe has updated the base model, you can create a new custom language model using the updated base model.

If you tried to create a new custom language model and the request wasn't successful, you can use this DescribeLanguageModel to help identify the reason for this failure.

GetCallAnalyticsCategory

getCallAnalyticsCategory_categoryName :: Lens' GetCallAnalyticsCategory Text Source #

The name of the Call Analytics category you want information about. Category names are case sensitive.

getCallAnalyticsCategoryResponse_categoryProperties :: Lens' GetCallAnalyticsCategoryResponse (Maybe CategoryProperties) Source #

Provides you with the properties of the Call Analytics category you specified in your GetCallAnalyticsCategory request.

GetCallAnalyticsJob

getCallAnalyticsJob_callAnalyticsJobName :: Lens' GetCallAnalyticsJob Text Source #

The name of the Call Analytics job you want information about. Job names are case sensitive.

getCallAnalyticsJobResponse_callAnalyticsJob :: Lens' GetCallAnalyticsJobResponse (Maybe CallAnalyticsJob) Source #

Provides detailed information about the specified Call Analytics job, including job status and, if applicable, failure reason.

GetMedicalTranscriptionJob

getMedicalTranscriptionJob_medicalTranscriptionJobName :: Lens' GetMedicalTranscriptionJob Text Source #

The name of the medical transcription job you want information about. Job names are case sensitive.

getMedicalTranscriptionJobResponse_medicalTranscriptionJob :: Lens' GetMedicalTranscriptionJobResponse (Maybe MedicalTranscriptionJob) Source #

Provides detailed information about the specified medical transcription job, including job status and, if applicable, failure reason.

GetMedicalVocabulary

getMedicalVocabulary_vocabularyName :: Lens' GetMedicalVocabulary Text Source #

The name of the custom medical vocabulary you want information about. Custom medical vocabulary names are case sensitive.

getMedicalVocabularyResponse_downloadUri :: Lens' GetMedicalVocabularyResponse (Maybe Text) Source #

The S3 location where the specified custom medical vocabulary is stored; use this URI to view or download the custom vocabulary.

getMedicalVocabularyResponse_failureReason :: Lens' GetMedicalVocabularyResponse (Maybe Text) Source #

If VocabularyState is FAILED, FailureReason contains information about why the custom medical vocabulary request failed. See also: Common Errors.

getMedicalVocabularyResponse_languageCode :: Lens' GetMedicalVocabularyResponse (Maybe LanguageCode) Source #

The language code you selected for your custom medical vocabulary. US English (en-US) is the only language supported with Amazon Transcribe Medical.

getMedicalVocabularyResponse_lastModifiedTime :: Lens' GetMedicalVocabularyResponse (Maybe UTCTime) Source #

The date and time the specified custom medical vocabulary was last modified.

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.

getMedicalVocabularyResponse_vocabularyName :: Lens' GetMedicalVocabularyResponse (Maybe Text) Source #

The name of the custom medical vocabulary you requested information about.

getMedicalVocabularyResponse_vocabularyState :: Lens' GetMedicalVocabularyResponse (Maybe VocabularyState) Source #

The processing state of your custom medical vocabulary. If the state is READY, you can use the custom vocabulary in a StartMedicalTranscriptionJob request.

GetTranscriptionJob

getTranscriptionJob_transcriptionJobName :: Lens' GetTranscriptionJob Text Source #

The name of the transcription job you want information about. Job names are case sensitive.

getTranscriptionJobResponse_transcriptionJob :: Lens' GetTranscriptionJobResponse (Maybe TranscriptionJob) Source #

Provides detailed information about the specified transcription job, including job status and, if applicable, failure reason.

GetVocabulary

getVocabulary_vocabularyName :: Lens' GetVocabulary Text Source #

The name of the custom vocabulary you want information about. Custom vocabulary names are case sensitive.

getVocabularyResponse_downloadUri :: Lens' GetVocabularyResponse (Maybe Text) Source #

The S3 location where the custom vocabulary is stored; use this URI to view or download the custom vocabulary.

getVocabularyResponse_failureReason :: Lens' GetVocabularyResponse (Maybe Text) Source #

If VocabularyState is FAILED, FailureReason contains information about why the custom vocabulary request failed. See also: Common Errors.

getVocabularyResponse_languageCode :: Lens' GetVocabularyResponse (Maybe LanguageCode) Source #

The language code you selected for your custom vocabulary.

getVocabularyResponse_lastModifiedTime :: Lens' GetVocabularyResponse (Maybe UTCTime) Source #

The date and time the specified custom vocabulary was last modified.

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.

getVocabularyResponse_vocabularyName :: Lens' GetVocabularyResponse (Maybe Text) Source #

The name of the custom vocabulary you requested information about.

getVocabularyResponse_vocabularyState :: Lens' GetVocabularyResponse (Maybe VocabularyState) Source #

The processing state of your custom vocabulary. If the state is READY, you can use the custom vocabulary in a StartTranscriptionJob request.

GetVocabularyFilter

getVocabularyFilter_vocabularyFilterName :: Lens' GetVocabularyFilter Text Source #

The name of the custom vocabulary filter you want information about. Custom vocabulary filter names are case sensitive.

getVocabularyFilterResponse_downloadUri :: Lens' GetVocabularyFilterResponse (Maybe Text) Source #

The Amazon S3 location where the custom vocabulary filter is stored; use this URI to view or download the custom vocabulary filter.

getVocabularyFilterResponse_languageCode :: Lens' GetVocabularyFilterResponse (Maybe LanguageCode) Source #

The language code you selected for your custom vocabulary filter.

getVocabularyFilterResponse_lastModifiedTime :: Lens' GetVocabularyFilterResponse (Maybe UTCTime) Source #

The date and time the specified custom vocabulary filter was last modified.

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.

getVocabularyFilterResponse_vocabularyFilterName :: Lens' GetVocabularyFilterResponse (Maybe Text) Source #

The name of the custom vocabulary filter you requested information about.

ListCallAnalyticsCategories

listCallAnalyticsCategories_maxResults :: Lens' ListCallAnalyticsCategories (Maybe Natural) Source #

The maximum number of Call Analytics categories to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.

listCallAnalyticsCategories_nextToken :: Lens' ListCallAnalyticsCategories (Maybe Text) Source #

If your ListCallAnalyticsCategories request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results.

listCallAnalyticsCategoriesResponse_categories :: Lens' ListCallAnalyticsCategoriesResponse (Maybe [CategoryProperties]) Source #

Provides detailed information about your Call Analytics categories, including all the rules associated with each category.

listCallAnalyticsCategoriesResponse_nextToken :: Lens' ListCallAnalyticsCategoriesResponse (Maybe Text) Source #

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.

ListCallAnalyticsJobs

listCallAnalyticsJobs_jobNameContains :: Lens' ListCallAnalyticsJobs (Maybe Text) Source #

Returns only the Call Analytics jobs that contain the specified string. The search is not case sensitive.

listCallAnalyticsJobs_maxResults :: Lens' ListCallAnalyticsJobs (Maybe Natural) Source #

The maximum number of Call Analytics jobs to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.

listCallAnalyticsJobs_nextToken :: Lens' ListCallAnalyticsJobs (Maybe Text) Source #

If your ListCallAnalyticsJobs request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results.

listCallAnalyticsJobs_status :: Lens' ListCallAnalyticsJobs (Maybe CallAnalyticsJobStatus) Source #

Returns only Call Analytics jobs with the specified status. Jobs are ordered by creation date, with the newest job first. If you don't include Status, all Call Analytics jobs are returned.

listCallAnalyticsJobsResponse_nextToken :: Lens' ListCallAnalyticsJobsResponse (Maybe Text) Source #

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.

listCallAnalyticsJobsResponse_status :: Lens' ListCallAnalyticsJobsResponse (Maybe CallAnalyticsJobStatus) Source #

Lists all Call Analytics jobs that have the status specified in your request. Jobs are ordered by creation date, with the newest job first.

ListLanguageModels

listLanguageModels_maxResults :: Lens' ListLanguageModels (Maybe Natural) Source #

The maximum number of custom language models to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.

listLanguageModels_nameContains :: Lens' ListLanguageModels (Maybe Text) Source #

Returns only the custom language models that contain the specified string. The search is not case sensitive.

listLanguageModels_nextToken :: Lens' ListLanguageModels (Maybe Text) Source #

If your ListLanguageModels request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results.

listLanguageModels_statusEquals :: Lens' ListLanguageModels (Maybe ModelStatus) Source #

Returns only custom language models with the specified status. Language models are ordered by creation date, with the newest model first. If you don't include StatusEquals, all custom language models are returned.

listLanguageModelsResponse_models :: Lens' ListLanguageModelsResponse (Maybe [LanguageModel]) Source #

Provides information about the custom language models that match the criteria specified in your request.

listLanguageModelsResponse_nextToken :: Lens' ListLanguageModelsResponse (Maybe Text) Source #

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.

ListMedicalTranscriptionJobs

listMedicalTranscriptionJobs_jobNameContains :: Lens' ListMedicalTranscriptionJobs (Maybe Text) Source #

Returns only the medical transcription jobs that contain the specified string. The search is not case sensitive.

listMedicalTranscriptionJobs_maxResults :: Lens' ListMedicalTranscriptionJobs (Maybe Natural) Source #

The maximum number of medical transcription jobs to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.

listMedicalTranscriptionJobs_nextToken :: Lens' ListMedicalTranscriptionJobs (Maybe Text) Source #

If your ListMedicalTranscriptionJobs request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results.

listMedicalTranscriptionJobs_status :: Lens' ListMedicalTranscriptionJobs (Maybe TranscriptionJobStatus) Source #

Returns only medical transcription jobs with the specified status. Jobs are ordered by creation date, with the newest job first. If you don't include Status, all medical transcription jobs are returned.

listMedicalTranscriptionJobsResponse_nextToken :: Lens' ListMedicalTranscriptionJobsResponse (Maybe Text) Source #

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.

listMedicalTranscriptionJobsResponse_status :: Lens' ListMedicalTranscriptionJobsResponse (Maybe TranscriptionJobStatus) Source #

Lists all medical transcription jobs that have the status specified in your request. Jobs are ordered by creation date, with the newest job first.

ListMedicalVocabularies

listMedicalVocabularies_maxResults :: Lens' ListMedicalVocabularies (Maybe Natural) Source #

The maximum number of custom medical vocabularies to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.

listMedicalVocabularies_nameContains :: Lens' ListMedicalVocabularies (Maybe Text) Source #

Returns only the custom medical vocabularies that contain the specified string. The search is not case sensitive.

listMedicalVocabularies_nextToken :: Lens' ListMedicalVocabularies (Maybe Text) Source #

If your ListMedicalVocabularies request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results.

listMedicalVocabularies_stateEquals :: Lens' ListMedicalVocabularies (Maybe VocabularyState) Source #

Returns only custom medical vocabularies with the specified state. Custom vocabularies are ordered by creation date, with the newest vocabulary first. If you don't include StateEquals, all custom medical vocabularies are returned.

listMedicalVocabulariesResponse_nextToken :: Lens' ListMedicalVocabulariesResponse (Maybe Text) Source #

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.

listMedicalVocabulariesResponse_status :: Lens' ListMedicalVocabulariesResponse (Maybe VocabularyState) Source #

Lists all custom medical vocabularies that have the status specified in your request. Custom vocabularies are ordered by creation date, with the newest vocabulary first.

listMedicalVocabulariesResponse_vocabularies :: Lens' ListMedicalVocabulariesResponse (Maybe [VocabularyInfo]) Source #

Provides information about the custom medical vocabularies that match the criteria specified in your request.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

Returns a list of all tags associated with the specified Amazon Resource Name (ARN). ARNs have the format arn:partition:service:region:account-id:resource-type/resource-id.

For example, arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name.

Valid values for resource-type are: transcription-job, medical-transcription-job, vocabulary, medical-vocabulary, vocabulary-filter, and language-model.

listTagsForResourceResponse_resourceArn :: Lens' ListTagsForResourceResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) specified in your request.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (NonEmpty Tag)) Source #

Lists all tags associated with the given transcription job, vocabulary, model, or resource.

ListTranscriptionJobs

listTranscriptionJobs_jobNameContains :: Lens' ListTranscriptionJobs (Maybe Text) Source #

Returns only the transcription jobs that contain the specified string. The search is not case sensitive.

listTranscriptionJobs_maxResults :: Lens' ListTranscriptionJobs (Maybe Natural) Source #

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 don't specify a value, a default of 5 is used.

listTranscriptionJobs_nextToken :: Lens' ListTranscriptionJobs (Maybe Text) Source #

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.

listTranscriptionJobs_status :: Lens' ListTranscriptionJobs (Maybe TranscriptionJobStatus) Source #

Returns only transcription jobs with the specified status. Jobs are ordered by creation date, with the newest job first. If you don't include Status, all transcription jobs are returned.

listTranscriptionJobsResponse_nextToken :: Lens' ListTranscriptionJobsResponse (Maybe Text) Source #

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.

listTranscriptionJobsResponse_status :: Lens' ListTranscriptionJobsResponse (Maybe TranscriptionJobStatus) Source #

Lists all transcription jobs that have the status specified in your request. Jobs are ordered by creation date, with the newest job first.

ListVocabularies

listVocabularies_maxResults :: Lens' ListVocabularies (Maybe Natural) Source #

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 don't specify a value, a default of 5 is used.

listVocabularies_nameContains :: Lens' ListVocabularies (Maybe Text) Source #

Returns only the custom vocabularies that contain the specified string. The search is not case sensitive.

listVocabularies_nextToken :: Lens' ListVocabularies (Maybe Text) Source #

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.

listVocabularies_stateEquals :: Lens' ListVocabularies (Maybe VocabularyState) Source #

Returns only custom vocabularies with the specified state. Vocabularies are ordered by creation date, with the newest vocabulary first. If you don't include StateEquals, all custom medical vocabularies are returned.

listVocabulariesResponse_nextToken :: Lens' ListVocabulariesResponse (Maybe Text) Source #

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.

listVocabulariesResponse_status :: Lens' ListVocabulariesResponse (Maybe VocabularyState) Source #

Lists all custom vocabularies that have the status specified in your request. Vocabularies are ordered by creation date, with the newest vocabulary first.

listVocabulariesResponse_vocabularies :: Lens' ListVocabulariesResponse (Maybe [VocabularyInfo]) Source #

Provides information about the custom vocabularies that match the criteria specified in your request.

ListVocabularyFilters

listVocabularyFilters_maxResults :: Lens' ListVocabularyFilters (Maybe Natural) Source #

The maximum number of custom vocabulary filters to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.

listVocabularyFilters_nameContains :: Lens' ListVocabularyFilters (Maybe Text) Source #

Returns only the custom vocabulary filters that contain the specified string. The search is not case sensitive.

listVocabularyFilters_nextToken :: Lens' ListVocabularyFilters (Maybe Text) Source #

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.

listVocabularyFiltersResponse_nextToken :: Lens' ListVocabularyFiltersResponse (Maybe Text) Source #

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.

listVocabularyFiltersResponse_vocabularyFilters :: Lens' ListVocabularyFiltersResponse (Maybe [VocabularyFilterInfo]) Source #

Provides information about the custom vocabulary filters that match the criteria specified in your request.

StartCallAnalyticsJob

startCallAnalyticsJob_channelDefinitions :: Lens' StartCallAnalyticsJob (Maybe (NonEmpty ChannelDefinition)) Source #

Makes it possible to specify which speaker is on which channel. For example, if your agent is the first participant to speak, you would set ChannelId to 0 (to indicate the first channel) and ParticipantRole to AGENT (to indicate that it's the agent speaking).

startCallAnalyticsJob_dataAccessRoleArn :: Lens' StartCallAnalyticsJob (Maybe Text) Source #

The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files. If the role that you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.

IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example: arn:aws:iam::111122223333:role/Admin.

For more information, see IAM ARNs.

startCallAnalyticsJob_outputEncryptionKMSKeyId :: Lens' StartCallAnalyticsJob (Maybe Text) Source #

The KMS key you want to use to encrypt your Call Analytics output.

If using a key located in the current Amazon Web Services 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 different Amazon Web Services account than the current Amazon Web Services 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 don't specify an encryption key, your output is encrypted with the default Amazon S3 key (SSE-S3).

If you specify a KMS key to encrypt your output, you must also specify an output location using the OutputLocation parameter.

Note that the user making the request must have permission to use the specified KMS key.

startCallAnalyticsJob_outputLocation :: Lens' StartCallAnalyticsJob (Maybe Text) Source #

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 file name (option 3), the name of your output file has a default value that matches the name you specified for your transcription job using the CallAnalyticsJobName parameter.

You can specify a KMS key to encrypt your output using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption.

If you don't specify OutputLocation, your transcript is placed in a service-managed Amazon S3 bucket and you are provided with a URI to access your transcript.

startCallAnalyticsJob_settings :: Lens' StartCallAnalyticsJob (Maybe CallAnalyticsJobSettings) Source #

Specify additional optional settings in your request, including content redaction; allows you to apply custom language models, vocabulary filters, and custom vocabularies to your Call Analytics job.

startCallAnalyticsJob_callAnalyticsJobName :: Lens' StartCallAnalyticsJob Text Source #

A unique name, chosen by you, for your Call Analytics job.

This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new job with the same name as an existing job, you get a ConflictException error.

startCallAnalyticsJob_media :: Lens' StartCallAnalyticsJob Media Source #

Describes the Amazon S3 location of the media file you want to use in your Call Analytics request.

startCallAnalyticsJobResponse_callAnalyticsJob :: Lens' StartCallAnalyticsJobResponse (Maybe CallAnalyticsJob) Source #

Provides detailed information about the current Call Analytics job, including job status and, if applicable, failure reason.

StartMedicalTranscriptionJob

startMedicalTranscriptionJob_kmsEncryptionContext :: Lens' StartMedicalTranscriptionJob (Maybe (HashMap Text Text)) Source #

A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data. For more information, see KMS encryption context and Asymmetric keys in KMS.

startMedicalTranscriptionJob_mediaSampleRateHertz :: Lens' StartMedicalTranscriptionJob (Maybe Natural) Source #

The sample rate, in hertz, of the audio track in your input media file.

If you don't specify the media sample rate, Amazon Transcribe Medical determines it for you. If you specify the sample rate, it must match the rate detected by Amazon Transcribe Medical; if there's a mismatch between the value that you specify and the value detected, your job fails. Therefore, in most cases, it's advised to omit MediaSampleRateHertz and let Amazon Transcribe Medical determine the sample rate.

startMedicalTranscriptionJob_outputEncryptionKMSKeyId :: Lens' StartMedicalTranscriptionJob (Maybe Text) Source #

The KMS key you want to use to encrypt your medical transcription output.

If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways:

  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 different Amazon Web Services account than the current Amazon Web Services 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 don't specify an encryption key, your output is encrypted with the default Amazon S3 key (SSE-S3).

If you specify a KMS key to encrypt your output, you must also specify an output location using the OutputLocation parameter.

Note that the user making the request must have permission to use the specified KMS key.

startMedicalTranscriptionJob_outputKey :: Lens' StartMedicalTranscriptionJob (Maybe Text) Source #

Use in combination with OutputBucketName to specify the output location of your transcript and, optionally, a unique name for your output file. The default name for your transcription output is the same as the name you specified for your medical transcription job (MedicalTranscriptionJobName).

Here are some examples of how you can use OutputKey:

  • If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'my-transcript.json' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my-transcript.json.
  • If you specify 'my-first-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-files/my-transcript.json' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json.
  • If you specify 'my-first-transcription' as the MedicalTranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and 'test-files/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.

startMedicalTranscriptionJob_settings :: Lens' StartMedicalTranscriptionJob (Maybe MedicalTranscriptionSetting) Source #

Specify additional optional settings in your request, including channel identification, alternative transcriptions, and speaker partitioning. You can use that to apply custom vocabularies to your transcription job.

startMedicalTranscriptionJob_tags :: Lens' StartMedicalTranscriptionJob (Maybe (NonEmpty Tag)) Source #

Adds one or more custom tags, each in the form of a key:value pair, to a new medical transcription job at the time you start this new job.

To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

startMedicalTranscriptionJob_medicalTranscriptionJobName :: Lens' StartMedicalTranscriptionJob Text Source #

A unique name, chosen by you, for your medical transcription job. The name that you specify is also used as the default name of your transcription output file. If you want to specify a different name for your transcription output, use the OutputKey parameter.

This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new job with the same name as an existing job, you get a ConflictException error.

startMedicalTranscriptionJob_languageCode :: Lens' StartMedicalTranscriptionJob LanguageCode Source #

The language code that represents the language spoken in the input media file. US English (en-US) is the only valid value for medical transcription jobs. Any other value you enter for language code results in a BadRequestException error.

startMedicalTranscriptionJob_outputBucketName :: Lens' StartMedicalTranscriptionJob Text Source #

The name of the Amazon S3 bucket where you want your medical transcription output stored. Do not include the S3:// prefix of the specified bucket.

If you want your output to go to a sub-folder of this bucket, specify it using the OutputKey parameter; OutputBucketName only accepts the name of a bucket.

For example, if you want your output stored in S3://DOC-EXAMPLE-BUCKET, set OutputBucketName to DOC-EXAMPLE-BUCKET. However, if you want your output stored in S3://DOC-EXAMPLE-BUCKET/test-files/, set OutputBucketName to DOC-EXAMPLE-BUCKET and OutputKey to test-files/.

Note that Amazon Transcribe must have permission to use the specified location. You can change Amazon S3 permissions using the Amazon Web Services Management Console. See also Permissions Required for IAM User Roles.

startMedicalTranscriptionJob_specialty :: Lens' StartMedicalTranscriptionJob Specialty Source #

Specify the predominant medical specialty represented in your media. For batch transcriptions, PRIMARYCARE is the only valid value. If you require additional specialties, refer to .

startMedicalTranscriptionJob_type :: Lens' StartMedicalTranscriptionJob Type Source #

Specify whether your input media contains only one person (DICTATION) or contains a conversation between two people (CONVERSATION).

For example, DICTATION could be used for a medical professional wanting to transcribe voice memos; CONVERSATION could be used for transcribing the doctor-patient dialogue during the patient's office visit.

startMedicalTranscriptionJobResponse_medicalTranscriptionJob :: Lens' StartMedicalTranscriptionJobResponse (Maybe MedicalTranscriptionJob) Source #

Provides detailed information about the current medical transcription job, including job status and, if applicable, failure reason.

StartTranscriptionJob

startTranscriptionJob_contentRedaction :: Lens' StartTranscriptionJob (Maybe ContentRedaction) Source #

Makes it possible to redact or flag specified personally identifiable information (PII) in your transcript. If you use ContentRedaction, you must also include the sub-parameters: PiiEntityTypes, RedactionOutput, and RedactionType.

startTranscriptionJob_identifyLanguage :: Lens' StartTranscriptionJob (Maybe Bool) Source #

Enables automatic language identification in your transcription job request. Use this parameter if your media file contains only one language. If your media contains multiple languages, use IdentifyMultipleLanguages instead.

If you include IdentifyLanguage, you can optionally include a list of language codes, using LanguageOptions, that you think may be present in your media file. 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 filter to your automatic language identification request, include LanguageIdSettings with the relevant sub-parameters (VocabularyName, LanguageModelName, 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.

startTranscriptionJob_identifyMultipleLanguages :: Lens' StartTranscriptionJob (Maybe Bool) Source #

Enables automatic multi-language identification in your transcription job request. Use this parameter if your media file contains more than one language. If your media contains only one language, use IdentifyLanguage instead.

If you include IdentifyMultipleLanguages, you can optionally include a list of language codes, using LanguageOptions, that you think may be present in your media file. 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 filter to your automatic language identification 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.

startTranscriptionJob_jobExecutionSettings :: Lens' StartTranscriptionJob (Maybe JobExecutionSettings) Source #

Makes it possible to control how your transcription job is processed. Currently, the only JobExecutionSettings modification you can choose is enabling job queueing using the AllowDeferredExecution sub-parameter.

If you include JobExecutionSettings in your request, you must also include the sub-parameters: AllowDeferredExecution and DataAccessRoleArn.

startTranscriptionJob_kmsEncryptionContext :: Lens' StartTranscriptionJob (Maybe (HashMap Text Text)) Source #

A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data. For more information, see KMS encryption context and Asymmetric keys in KMS.

startTranscriptionJob_languageCode :: Lens' StartTranscriptionJob (Maybe LanguageCode) Source #

The language code that represents the language spoken in the input media file.

If you're unsure of the language spoken in your media file, consider using IdentifyLanguage or IdentifyMultipleLanguages to enable automatic language identification.

Note that you must include one of LanguageCode, 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.

To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a sample rate of 16,000 Hz or higher.

startTranscriptionJob_languageIdSettings :: Lens' StartTranscriptionJob (Maybe (HashMap LanguageCode LanguageIdSettings)) Source #

If using automatic language identification in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter, include LanguageIdSettings with the relevant sub-parameters (VocabularyName, LanguageModelName, and VocabularyFilterName). Note that multi-language identification (IdentifyMultipleLanguages) doesn't support custom language models.

LanguageIdSettings supports two to five language codes. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The language codes that you specify must match the languages of the associated custom language models, custom vocabularies, and custom vocabulary filters.

It's recommended that you include LanguageOptions when using LanguageIdSettings to ensure that the correct language dialect is identified. 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 identification, use instead the parameter with the LanguageModelName sub-parameter. If you want to include a custom vocabulary or a custom vocabulary filter (or both) with your request but do not want to use automatic language identification, use instead the parameter with the VocabularyName or VocabularyFilterName (or both) sub-parameter.

startTranscriptionJob_languageOptions :: Lens' StartTranscriptionJob (Maybe (NonEmpty LanguageCode)) Source #

You can specify two or more language codes that represent the languages you think may be present in your media. Including more than five is not recommended. If you're unsure what languages are present, do not include this parameter.

If you include LanguageOptions in your request, you must also include IdentifyLanguage.

For more information, refer to Supported languages.

To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a sample rate of 16,000 Hz or higher.

startTranscriptionJob_mediaFormat :: Lens' StartTranscriptionJob (Maybe MediaFormat) Source #

Specify the format of your input media file.

startTranscriptionJob_mediaSampleRateHertz :: Lens' StartTranscriptionJob (Maybe Natural) Source #

The sample rate, in hertz, of the audio track in your input media file.

If you don't specify the media sample rate, Amazon Transcribe 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.

startTranscriptionJob_modelSettings :: Lens' StartTranscriptionJob (Maybe ModelSettings) Source #

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.

startTranscriptionJob_outputBucketName :: Lens' StartTranscriptionJob (Maybe Text) Source #

The name of the Amazon S3 bucket where you want your transcription output stored. Do not include the S3:// prefix of the specified bucket.

If you want your output to go to a sub-folder of this bucket, specify it using the OutputKey parameter; OutputBucketName only accepts the name of a bucket.

For example, if you want your output stored in S3://DOC-EXAMPLE-BUCKET, set OutputBucketName to DOC-EXAMPLE-BUCKET. However, if you want your output stored in S3://DOC-EXAMPLE-BUCKET/test-files/, set OutputBucketName to DOC-EXAMPLE-BUCKET and OutputKey to test-files/.

Note that Amazon Transcribe must have permission to use the specified location. You can change Amazon S3 permissions using the Amazon Web Services Management Console. See also Permissions Required for IAM User Roles.

If you don't specify OutputBucketName, your transcript is placed in a service-managed Amazon S3 bucket and you are provided with a URI to access your transcript.

startTranscriptionJob_outputEncryptionKMSKeyId :: Lens' StartTranscriptionJob (Maybe Text) Source #

The KMS key you want to use to encrypt your transcription output.

If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways:

  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 different Amazon Web Services account than the current Amazon Web Services 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 don't specify an encryption key, your output is encrypted with the default Amazon S3 key (SSE-S3).

If you specify a KMS key to encrypt your output, you must also specify an output location using the OutputLocation parameter.

Note that the user making the request must have permission to use the specified KMS key.

startTranscriptionJob_outputKey :: Lens' StartTranscriptionJob (Maybe Text) Source #

Use in combination with OutputBucketName to specify the output location of your transcript and, optionally, a unique name for your output file. The default name for your transcription output is the same as the name you specified for your 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-first-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-files/my-transcript.json' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json.
  • If you specify 'my-first-transcription' as the TranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and 'test-files/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.

startTranscriptionJob_settings :: Lens' StartTranscriptionJob (Maybe Settings) Source #

Specify additional optional settings in your request, including channel identification, alternative transcriptions, speaker partitioning. You can use that to apply custom vocabularies and vocabulary filters.

If you want to include a custom vocabulary or a custom vocabulary filter (or both) with your request but do not want to use automatic language identification, use Settings with the VocabularyName or VocabularyFilterName (or both) sub-parameter.

If you're using automatic language identification with your request and want to include a custom language model, a custom vocabulary, or a custom vocabulary filter, use instead the parameter with the LanguageModelName, VocabularyName or VocabularyFilterName sub-parameters.

startTranscriptionJob_subtitles :: Lens' StartTranscriptionJob (Maybe Subtitles) Source #

Produces subtitle files for your input media. You can specify WebVTT (*.vtt) and SubRip (*.srt) formats.

startTranscriptionJob_tags :: Lens' StartTranscriptionJob (Maybe (NonEmpty Tag)) Source #

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.

startTranscriptionJob_transcriptionJobName :: Lens' StartTranscriptionJob Text Source #

A unique name, chosen by you, for your transcription job. The name that you specify is also used as the default name of your transcription output file. If you want to specify a different name for your transcription output, use the OutputKey parameter.

This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new job with the same name as an existing job, you get a ConflictException error.

startTranscriptionJob_media :: Lens' StartTranscriptionJob Media Source #

Describes the Amazon S3 location of the media file you want to use in your request.

startTranscriptionJobResponse_transcriptionJob :: Lens' StartTranscriptionJobResponse (Maybe TranscriptionJob) Source #

Provides detailed information about the current transcription job, including job status and, if applicable, failure reason.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

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.

tagResource_tags :: Lens' TagResource (NonEmpty Tag) Source #

Adds one or more custom tags, each in the form of a key:value pair, to the specified resource.

To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

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.

untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text) Source #

Removes the specified tag keys from the specified Amazon Transcribe resource.

UpdateCallAnalyticsCategory

updateCallAnalyticsCategory_inputType :: Lens' UpdateCallAnalyticsCategory (Maybe InputType) Source #

Choose whether you want to update a streaming or a batch Call Analytics category. The input type you specify must match the input type specified when the category was created. For example, if you created a category with the POST_CALL input type, you must use POST_CALL as the input type when updating this category.

updateCallAnalyticsCategory_categoryName :: Lens' UpdateCallAnalyticsCategory Text Source #

The name of the Call Analytics category you want to update. Category names are case sensitive.

updateCallAnalyticsCategory_rules :: Lens' UpdateCallAnalyticsCategory (NonEmpty Rule) Source #

The rules used for the updated Call Analytics category. The rules you provide in this field replace the ones that are currently being used in the specified category.

updateCallAnalyticsCategoryResponse_categoryProperties :: Lens' UpdateCallAnalyticsCategoryResponse (Maybe CategoryProperties) Source #

Provides you with the properties of the Call Analytics category you specified in your UpdateCallAnalyticsCategory request.

UpdateMedicalVocabulary

updateMedicalVocabulary_vocabularyName :: Lens' UpdateMedicalVocabulary Text Source #

The name of the custom medical vocabulary you want to update. Custom medical vocabulary names are case sensitive.

updateMedicalVocabulary_languageCode :: Lens' UpdateMedicalVocabulary LanguageCode Source #

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.

updateMedicalVocabulary_vocabularyFileUri :: Lens' UpdateMedicalVocabulary Text Source #

The Amazon S3 location of the text file that contains your custom medical vocabulary. The URI must be located in the same Amazon Web Services Region as the resource you're calling.

Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt

updateMedicalVocabularyResponse_languageCode :: Lens' UpdateMedicalVocabularyResponse (Maybe LanguageCode) Source #

The language code you selected for your custom medical vocabulary. US English (en-US) is the only language supported with Amazon Transcribe Medical.

updateMedicalVocabularyResponse_lastModifiedTime :: Lens' UpdateMedicalVocabularyResponse (Maybe UTCTime) Source #

The date and time the specified 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.

updateMedicalVocabularyResponse_vocabularyState :: Lens' UpdateMedicalVocabularyResponse (Maybe VocabularyState) Source #

The processing state of your custom medical vocabulary. If the state is READY, you can use the custom vocabulary in a StartMedicalTranscriptionJob request.

UpdateVocabulary

updateVocabulary_phrases :: Lens' UpdateVocabulary (Maybe [Text]) Source #

Use this parameter if you want to update your custom vocabulary by including all desired terms, as comma-separated values, within your request. The other option for updating your custom vocabulary is to save your entries in a text file and upload them to an Amazon S3 bucket, then specify the location of your file using the VocabularyFileUri parameter.

Note that if you include Phrases in your request, you cannot use VocabularyFileUri; you must choose one or the other.

Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.

updateVocabulary_vocabularyFileUri :: Lens' UpdateVocabulary (Maybe Text) Source #

The Amazon S3 location of the text file that contains your custom vocabulary. The URI must be located in the same Amazon Web Services Region as the resource you're calling.

Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt

Note that if you include VocabularyFileUri in your request, you cannot use the Phrases flag; you must choose one or the other.

updateVocabulary_vocabularyName :: Lens' UpdateVocabulary Text Source #

The name of the custom vocabulary you want to update. Custom vocabulary names are case sensitive.

updateVocabulary_languageCode :: Lens' UpdateVocabulary LanguageCode Source #

The language code that represents the language of the entries in the custom vocabulary you want to update. Each custom vocabulary must contain terms in only one language.

A custom vocabulary can only be used to transcribe files in the same language as the custom vocabulary. For example, if you create a custom vocabulary using US English (en-US), you can only apply this custom vocabulary to files that contain English audio.

For a list of supported languages and their associated language codes, refer to the Supported languages table.

updateVocabularyResponse_languageCode :: Lens' UpdateVocabularyResponse (Maybe LanguageCode) Source #

The language code you selected for your custom vocabulary.

updateVocabularyResponse_lastModifiedTime :: Lens' UpdateVocabularyResponse (Maybe UTCTime) Source #

The date and time the specified 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.

updateVocabularyResponse_vocabularyState :: Lens' UpdateVocabularyResponse (Maybe VocabularyState) Source #

The processing state of your custom vocabulary. If the state is READY, you can use the custom vocabulary in a StartTranscriptionJob request.

UpdateVocabularyFilter

updateVocabularyFilter_vocabularyFilterFileUri :: Lens' UpdateVocabularyFilter (Maybe Text) Source #

The Amazon S3 location of the text file that contains your custom vocabulary filter terms. The URI must be located in the same Amazon Web Services Region as the resource you're calling.

Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt

Note that if you include VocabularyFilterFileUri in your request, you cannot use Words; you must choose one or the other.

updateVocabularyFilter_words :: Lens' UpdateVocabularyFilter (Maybe (NonEmpty Text)) Source #

Use this parameter if you want to update your custom vocabulary filter by including all desired terms, as comma-separated values, within your request. The other option for updating your vocabulary filter is to save your entries in a text file and upload them to an Amazon S3 bucket, then specify the location of your file 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 specific language. If you use unsupported characters, your custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.

updateVocabularyFilter_vocabularyFilterName :: Lens' UpdateVocabularyFilter Text Source #

The name of the custom vocabulary filter you want to update. Custom vocabulary filter names are case sensitive.

updateVocabularyFilterResponse_languageCode :: Lens' UpdateVocabularyFilterResponse (Maybe LanguageCode) Source #

The language code you selected for your custom vocabulary filter.

updateVocabularyFilterResponse_lastModifiedTime :: Lens' UpdateVocabularyFilterResponse (Maybe UTCTime) Source #

The date and time the specified custom vocabulary filter 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.

Types

AbsoluteTimeRange

absoluteTimeRange_endTime :: Lens' AbsoluteTimeRange (Maybe Natural) Source #

The time, in milliseconds, when Amazon Transcribe stops searching for the specified criteria in your audio. If you include EndTime in your request, you must also include StartTime.

absoluteTimeRange_first :: Lens' AbsoluteTimeRange (Maybe Natural) Source #

The time, in milliseconds, from the start of your media file until the specified value. Amazon Transcribe searches for your specified criteria in this time segment.

absoluteTimeRange_last :: Lens' AbsoluteTimeRange (Maybe Natural) Source #

The time, in milliseconds, from the specified value until the end of your media file. Amazon Transcribe searches for your specified criteria in this time segment.

absoluteTimeRange_startTime :: Lens' AbsoluteTimeRange (Maybe Natural) Source #

The time, in milliseconds, when Amazon Transcribe starts searching for the specified criteria in your audio. If you include StartTime in your request, you must also include EndTime.

CallAnalyticsJob

callAnalyticsJob_callAnalyticsJobName :: Lens' CallAnalyticsJob (Maybe Text) Source #

The name of the Call Analytics job. Job names are case sensitive and must be unique within an Amazon Web Services account.

callAnalyticsJob_callAnalyticsJobStatus :: Lens' CallAnalyticsJob (Maybe CallAnalyticsJobStatus) Source #

Provides the status of the specified Call Analytics job.

If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri (or RedactedTranscriptFileUri, if you requested transcript redaction). If the status is FAILED, FailureReason provides details on why your transcription job failed.

callAnalyticsJob_completionTime :: Lens' CallAnalyticsJob (Maybe UTCTime) Source #

The date and time the specified Call Analytics job finished 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.

callAnalyticsJob_creationTime :: Lens' CallAnalyticsJob (Maybe UTCTime) Source #

The date and time the specified 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.

callAnalyticsJob_dataAccessRoleArn :: Lens' CallAnalyticsJob (Maybe Text) Source #

The Amazon Resource Name (ARN) you included in your request.

callAnalyticsJob_failureReason :: Lens' CallAnalyticsJob (Maybe Text) Source #

If CallAnalyticsJobStatus is FAILED, FailureReason contains information about why the Call Analytics job request failed.

The FailureReason field contains one of the following values:

  • Unsupported media format.

    The media format specified in MediaFormat isn't valid. Refer to MediaFormat for a list of supported formats.

  • The media format provided does not match the detected media format.

    The media format specified in MediaFormat doesn't match the format of the input file. Check the media format of your media file and correct the specified value.

  • Invalid sample rate for audio file.

    The sample rate specified 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 specified in MediaSampleRateHertz doesn't match the sample rate detected in your input media file. Check the sample rate of your media file and correct the specified value.

  • Invalid file size: file size too large.

    The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Guidelines and 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 Guidelines and quotas.

callAnalyticsJob_identifiedLanguageScore :: Lens' CallAnalyticsJob (Maybe Double) Source #

The confidence score associated with the language identified in your media file.

Confidence scores are values between 0 and 1; a larger value indicates a higher probability that the identified language correctly matches the language spoken in your media.

callAnalyticsJob_languageCode :: Lens' CallAnalyticsJob (Maybe LanguageCode) Source #

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 don't know the language spoken in your media file, you can omit this field and let Amazon Transcribe automatically identify the language of your media. To improve the accuracy of language identification, you can include several language codes and Amazon Transcribe chooses the closest match for your transcription.

callAnalyticsJob_media :: Lens' CallAnalyticsJob (Maybe Media) Source #

Provides the Amazon S3 location of the media file you used in your Call Analytics request.

callAnalyticsJob_mediaSampleRateHertz :: Lens' CallAnalyticsJob (Maybe Natural) Source #

The sample rate, in hertz, of the audio track in your input media file.

callAnalyticsJob_settings :: Lens' CallAnalyticsJob (Maybe CallAnalyticsJobSettings) Source #

Provides information on any additional settings that were included in your request. Additional settings include content redaction and language identification settings.

callAnalyticsJob_startTime :: Lens' CallAnalyticsJob (Maybe UTCTime) Source #

The date and time the specified 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.

CallAnalyticsJobSettings

callAnalyticsJobSettings_languageIdSettings :: Lens' CallAnalyticsJobSettings (Maybe (HashMap LanguageCode LanguageIdSettings)) Source #

If using automatic language identification in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter, include LanguageIdSettings with the relevant sub-parameters (VocabularyName, LanguageModelName, and VocabularyFilterName).

LanguageIdSettings supports two to five language codes. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The language codes that you specify must match the languages of the associated custom language models, custom vocabularies, and custom vocabulary filters.

It's recommended that you include LanguageOptions when using LanguageIdSettings to ensure that the correct language dialect is identified. 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 filter with your request but do not want to use automatic language identification, use instead the parameter with the LanguageModelName, VocabularyName, or VocabularyFilterName sub-parameters.

For a list of languages supported with Call Analytics, refer to Supported languages and language-specific features.

callAnalyticsJobSettings_languageModelName :: Lens' CallAnalyticsJobSettings (Maybe Text) Source #

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 specified custom language model must match the language code that 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.

callAnalyticsJobSettings_languageOptions :: Lens' CallAnalyticsJobSettings (Maybe (NonEmpty LanguageCode)) Source #

You can specify two or more language codes that represent the languages you think may be present in your media. Including more than five is not recommended. If you're unsure what languages are present, do not include this parameter.

Including language options can improve the accuracy of language identification.

For a list of languages supported with Call Analytics, refer to the Supported languages table.

To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a sample rate of 16,000 Hz or higher.

callAnalyticsJobSettings_vocabularyFilterMethod :: Lens' CallAnalyticsJobSettings (Maybe VocabularyFilterMethod) Source #

Specify how you want your custom vocabulary filter applied to your transcript.

To replace words with ***, choose mask.

To delete words, choose remove.

To flag words without changing them, choose tag.

callAnalyticsJobSettings_vocabularyFilterName :: Lens' CallAnalyticsJobSettings (Maybe Text) Source #

The name of the custom vocabulary filter you want to include in your Call Analytics transcription request. Custom vocabulary filter names are case sensitive.

Note that if you include VocabularyFilterName in your request, you must also include VocabularyFilterMethod.

callAnalyticsJobSettings_vocabularyName :: Lens' CallAnalyticsJobSettings (Maybe Text) Source #

The name of the custom vocabulary you want to include in your Call Analytics transcription request. Custom vocabulary names are case sensitive.

CallAnalyticsJobSummary

callAnalyticsJobSummary_callAnalyticsJobName :: Lens' CallAnalyticsJobSummary (Maybe Text) Source #

The name of the Call Analytics job. Job names are case sensitive and must be unique within an Amazon Web Services account.

callAnalyticsJobSummary_callAnalyticsJobStatus :: Lens' CallAnalyticsJobSummary (Maybe CallAnalyticsJobStatus) Source #

Provides the status of your Call Analytics job.

If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri (or RedactedTranscriptFileUri, if you requested transcript redaction). If the status is FAILED, FailureReason provides details on why your transcription job failed.

callAnalyticsJobSummary_completionTime :: Lens' CallAnalyticsJobSummary (Maybe UTCTime) Source #

The date and time the specified Call Analytics job finished 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.

callAnalyticsJobSummary_creationTime :: Lens' CallAnalyticsJobSummary (Maybe UTCTime) Source #

The date and time the specified 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.

callAnalyticsJobSummary_failureReason :: Lens' CallAnalyticsJobSummary (Maybe Text) Source #

If CallAnalyticsJobStatus is FAILED, FailureReason contains information about why the Call Analytics job failed. See also: Common Errors.

callAnalyticsJobSummary_languageCode :: Lens' CallAnalyticsJobSummary (Maybe LanguageCode) Source #

The language code used to create your Call Analytics transcription.

callAnalyticsJobSummary_startTime :: Lens' CallAnalyticsJobSummary (Maybe UTCTime) Source #

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.

CategoryProperties

categoryProperties_categoryName :: Lens' CategoryProperties (Maybe Text) Source #

The name of the Call Analytics category. Category names are case sensitive and must be unique within an Amazon Web Services account.

categoryProperties_createTime :: Lens' CategoryProperties (Maybe UTCTime) Source #

The date and time the specified 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.

categoryProperties_inputType :: Lens' CategoryProperties (Maybe InputType) Source #

The input type associated with the specified 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.

categoryProperties_lastUpdateTime :: Lens' CategoryProperties (Maybe UTCTime) Source #

The date and time the specified 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.

categoryProperties_rules :: Lens' CategoryProperties (Maybe (NonEmpty Rule)) Source #

The rules used to define a Call Analytics category. Each category can have between 1 and 20 rules.

ChannelDefinition

channelDefinition_channelId :: Lens' ChannelDefinition (Maybe Natural) Source #

Specify the audio channel you want to define.

channelDefinition_participantRole :: Lens' ChannelDefinition (Maybe ParticipantRole) Source #

Specify the speaker you want to define. Omitting this parameter is equivalent to specifying both participants.

ContentRedaction

contentRedaction_piiEntityTypes :: Lens' ContentRedaction (Maybe [PiiEntityType]) Source #

Specify which types of personally identifiable information (PII) you want to redact in your transcript. You can include as many types as you'd like, or you can select ALL.

contentRedaction_redactionType :: Lens' ContentRedaction RedactionType Source #

Specify the category of information you want to redact; PII (personally identifiable information) is the only valid value. You can use PiiEntityTypes to choose which types of PII you want to redact.

contentRedaction_redactionOutput :: Lens' ContentRedaction RedactionOutput Source #

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 files).

InputDataConfig

inputDataConfig_tuningDataS3Uri :: Lens' InputDataConfig (Maybe Text) Source #

The Amazon S3 location (URI) of the text files you want to use to tune your custom language model.

Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-model-tuning-data/

inputDataConfig_s3Uri :: Lens' InputDataConfig Text Source #

The Amazon S3 location (URI) of the text files you want to use to train your custom language model.

Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-model-training-data/

inputDataConfig_dataAccessRoleArn :: Lens' InputDataConfig Text Source #

The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files. If the role that you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.

IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example: arn:aws:iam::111122223333:role/Admin.

For more information, see IAM ARNs.

InterruptionFilter

interruptionFilter_absoluteTimeRange :: Lens' InterruptionFilter (Maybe AbsoluteTimeRange) Source #

Makes it possible to specify a time range (in milliseconds) in your audio, during which you want to search for an interruption. See for more detail.

interruptionFilter_negate :: Lens' InterruptionFilter (Maybe Bool) Source #

Set to TRUE to flag speech that does not contain interruptions. Set to FALSE to flag speech that contains interruptions.

interruptionFilter_participantRole :: Lens' InterruptionFilter (Maybe ParticipantRole) Source #

Specify the interrupter that you want to flag. Omitting this parameter is equivalent to specifying both participants.

interruptionFilter_relativeTimeRange :: Lens' InterruptionFilter (Maybe RelativeTimeRange) Source #

Makes it possible to specify a time range (in percentage) in your media file, during which you want to search for an interruption. See for more detail.

interruptionFilter_threshold :: Lens' InterruptionFilter (Maybe Natural) Source #

Specify the duration of the interruptions in milliseconds. For example, you can flag speech that contains more than 10,000 milliseconds of interruptions.

JobExecutionSettings

jobExecutionSettings_allowDeferredExecution :: Lens' JobExecutionSettings (Maybe Bool) Source #

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.

Note that job queuing is enabled by default for Call Analytics jobs.

If you include AllowDeferredExecution in your request, you must also include DataAccessRoleArn.

jobExecutionSettings_dataAccessRoleArn :: Lens' JobExecutionSettings (Maybe Text) Source #

The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files. If the role that you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.

IAM role ARNs have the format 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.

LanguageCodeItem

languageCodeItem_durationInSeconds :: Lens' LanguageCodeItem (Maybe Double) Source #

Provides the total time, in seconds, each identified language is spoken in your media.

languageCodeItem_languageCode :: Lens' LanguageCodeItem (Maybe LanguageCode) Source #

Provides the language code for each language identified in your media.

LanguageIdSettings

languageIdSettings_languageModelName :: Lens' LanguageIdSettings (Maybe Text) Source #

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 specified custom language model must match the language code that 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.

languageIdSettings_vocabularyFilterName :: Lens' LanguageIdSettings (Maybe Text) Source #

The name of the custom vocabulary filter you want to use when processing your transcription job. Custom vocabulary filter names are case sensitive.

The language of the specified custom vocabulary filter must match the language code that you specify in your transcription request. If the languages don't match, the custom vocabulary filter 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.

languageIdSettings_vocabularyName :: Lens' LanguageIdSettings (Maybe Text) Source #

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 specified custom vocabulary must match the language code that you specify in your transcription request. If the languages don't match, the custom vocabulary isn't applied. There are no errors or warnings associated with a language mismatch.

LanguageModel

languageModel_baseModelName :: Lens' LanguageModel (Maybe BaseModelName) Source #

The Amazon Transcribe standard language model, or base model, used to create your custom language model.

languageModel_createTime :: Lens' LanguageModel (Maybe UTCTime) Source #

The date and time the specified 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.

languageModel_failureReason :: Lens' LanguageModel (Maybe Text) Source #

If ModelStatus is FAILED, FailureReason contains information about why the custom language model request failed. See also: Common Errors.

languageModel_inputDataConfig :: Lens' LanguageModel (Maybe InputDataConfig) Source #

The Amazon S3 location of the input files 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.

languageModel_languageCode :: Lens' LanguageModel (Maybe CLMLanguageCode) Source #

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 U.S. English (en-US) is the only language supported with Amazon Transcribe Medical.

languageModel_lastModifiedTime :: Lens' LanguageModel (Maybe UTCTime) Source #

The date and time the specified custom language model was last modified.

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.

languageModel_modelName :: Lens' LanguageModel (Maybe Text) Source #

A unique name, chosen by you, for your custom language model.

This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.

languageModel_modelStatus :: Lens' LanguageModel (Maybe ModelStatus) Source #

The status of the specified custom language model. When the status displays as COMPLETED the model is ready for use.

languageModel_upgradeAvailability :: Lens' LanguageModel (Maybe Bool) Source #

Shows if a more current base model is available for use with the specified 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.

Media

media_mediaFileUri :: Lens' Media (Maybe Text) Source #

The Amazon S3 location of the media file 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 Amazon Web Services Region where you're making your transcription request.

media_redactedMediaFileUri :: Lens' Media (Maybe Text) Source #

The Amazon S3 location of the media file 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 Amazon Web Services Region where you're making your transcription request.

RedactedMediaFileUri produces a redacted audio file in addition to a redacted transcript. It is only supported for Call Analytics (StartCallAnalyticsJob) transcription requests.

MedicalTranscript

medicalTranscript_transcriptFileUri :: Lens' MedicalTranscript (Maybe Text) Source #

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 specified in your request using the OutputBucketName parameter.

MedicalTranscriptionJob

medicalTranscriptionJob_completionTime :: Lens' MedicalTranscriptionJob (Maybe UTCTime) Source #

The date and time the specified medical transcription job finished 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.

medicalTranscriptionJob_contentIdentificationType :: Lens' MedicalTranscriptionJob (Maybe MedicalContentIdentificationType) Source #

Indicates whether content identification was enabled for your transcription request.

medicalTranscriptionJob_creationTime :: Lens' MedicalTranscriptionJob (Maybe UTCTime) Source #

The date and time the specified 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.

medicalTranscriptionJob_failureReason :: Lens' MedicalTranscriptionJob (Maybe Text) Source #

If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job request failed.

The FailureReason field contains one of the following values:

  • Unsupported media format.

    The media format specified in MediaFormat isn't valid. Refer to MediaFormat for a list of supported formats.

  • The media format provided does not match the detected media format.

    The media format specified in MediaFormat doesn't match the format of the input file. Check the media format of your media file and correct the specified value.

  • Invalid sample rate for audio file.

    The sample rate specified 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 specified in MediaSampleRateHertz doesn't match the sample rate detected in your input media file. Check the sample rate of your media file and correct the specified value.

  • Invalid file size: file size too large.

    The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Guidelines and 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 Guidelines and quotas.

medicalTranscriptionJob_languageCode :: Lens' MedicalTranscriptionJob (Maybe LanguageCode) Source #

The language code used to create your medical transcription job. US English (en-US) is the only supported language for medical transcriptions.

medicalTranscriptionJob_mediaSampleRateHertz :: Lens' MedicalTranscriptionJob (Maybe Natural) Source #

The sample rate, in hertz, of the audio track in your input media file.

medicalTranscriptionJob_medicalTranscriptionJobName :: Lens' MedicalTranscriptionJob (Maybe Text) Source #

The name of the medical transcription job. Job names are case sensitive and must be unique within an Amazon Web Services account.

medicalTranscriptionJob_settings :: Lens' MedicalTranscriptionJob (Maybe MedicalTranscriptionSetting) Source #

Provides information on any additional settings that were included in your request. Additional settings include channel identification, alternative transcriptions, speaker partitioning, custom vocabularies, and custom vocabulary filters.

medicalTranscriptionJob_specialty :: Lens' MedicalTranscriptionJob (Maybe Specialty) Source #

Describes the medical specialty represented in your media.

medicalTranscriptionJob_startTime :: Lens' MedicalTranscriptionJob (Maybe UTCTime) Source #

The date and time the specified 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.

medicalTranscriptionJob_tags :: Lens' MedicalTranscriptionJob (Maybe (NonEmpty Tag)) Source #

The tags, each in the form of a key:value pair, assigned to the specified medical transcription job.

medicalTranscriptionJob_transcript :: Lens' MedicalTranscriptionJob (Maybe MedicalTranscript) Source #

Provides you with the Amazon S3 URI you can use to access your transcript.

medicalTranscriptionJob_transcriptionJobStatus :: Lens' MedicalTranscriptionJob (Maybe TranscriptionJobStatus) Source #

Provides the status of the specified medical transcription job.

If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed.

medicalTranscriptionJob_type :: Lens' MedicalTranscriptionJob (Maybe Type) Source #

Indicates whether the input media is a dictation or a conversation, as specified in the StartMedicalTranscriptionJob request.

MedicalTranscriptionJobSummary

medicalTranscriptionJobSummary_completionTime :: Lens' MedicalTranscriptionJobSummary (Maybe UTCTime) Source #

The date and time the specified medical transcription job finished 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.

medicalTranscriptionJobSummary_creationTime :: Lens' MedicalTranscriptionJobSummary (Maybe UTCTime) Source #

The date and time the specified 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.

medicalTranscriptionJobSummary_failureReason :: Lens' MedicalTranscriptionJobSummary (Maybe Text) Source #

If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job failed. See also: Common Errors.

medicalTranscriptionJobSummary_languageCode :: Lens' MedicalTranscriptionJobSummary (Maybe LanguageCode) Source #

The language code used to create your medical transcription. US English (en-US) is the only supported language for medical transcriptions.

medicalTranscriptionJobSummary_medicalTranscriptionJobName :: Lens' MedicalTranscriptionJobSummary (Maybe Text) Source #

The name of the medical transcription job. Job names are case sensitive and must be unique within an Amazon Web Services account.

medicalTranscriptionJobSummary_outputLocationType :: Lens' MedicalTranscriptionJobSummary (Maybe OutputLocationType) Source #

Indicates where the specified medical transcription output is stored.

If the value is CUSTOMER_BUCKET, the location is the Amazon S3 bucket you specified using the OutputBucketName parameter in your request. If you also included OutputKey in your request, your output is located in the path you specified 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 field.

medicalTranscriptionJobSummary_specialty :: Lens' MedicalTranscriptionJobSummary (Maybe Specialty) Source #

Provides the medical specialty represented in your media.

medicalTranscriptionJobSummary_startTime :: Lens' MedicalTranscriptionJobSummary (Maybe UTCTime) Source #

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.

medicalTranscriptionJobSummary_transcriptionJobStatus :: Lens' MedicalTranscriptionJobSummary (Maybe TranscriptionJobStatus) Source #

Provides the status of your medical transcription job.

If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed.

medicalTranscriptionJobSummary_type :: Lens' MedicalTranscriptionJobSummary (Maybe Type) Source #

Indicates whether the input media is a dictation or a conversation, as specified in the StartMedicalTranscriptionJob request.

MedicalTranscriptionSetting

medicalTranscriptionSetting_channelIdentification :: Lens' MedicalTranscriptionSetting (Maybe Bool) Source #

Enables channel identification in multi-channel audio.

Channel identification 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 identification, your audio is transcribed in a continuous manner and your transcript does not separate the speech by channel.

You can't include both ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException.

For more information, see Transcribing multi-channel audio.

medicalTranscriptionSetting_maxAlternatives :: Lens' MedicalTranscriptionSetting (Maybe Natural) Source #

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.

medicalTranscriptionSetting_maxSpeakerLabels :: Lens' MedicalTranscriptionSetting (Maybe Natural) Source #

Specify the maximum number of speakers you want to partition in your media.

Note that if your media contains more speakers than the specified number, multiple speakers are treated as a single speaker.

If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.

medicalTranscriptionSetting_showAlternatives :: Lens' MedicalTranscriptionSetting (Maybe Bool) Source #

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.

medicalTranscriptionSetting_showSpeakerLabels :: Lens' MedicalTranscriptionSetting (Maybe Bool) Source #

Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file.

If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels.

You can't include ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException.

For more information, see Partitioning speakers (diarization).

medicalTranscriptionSetting_vocabularyName :: Lens' MedicalTranscriptionSetting (Maybe Text) Source #

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 specified custom vocabulary must match the language code that you specify in your transcription request. If the languages don't 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.

ModelSettings

modelSettings_languageModelName :: Lens' ModelSettings (Maybe Text) Source #

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 specified custom language model must match the language code that 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.

NonTalkTimeFilter

nonTalkTimeFilter_absoluteTimeRange :: Lens' NonTalkTimeFilter (Maybe AbsoluteTimeRange) Source #

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 for more detail.

nonTalkTimeFilter_negate :: Lens' NonTalkTimeFilter (Maybe Bool) Source #

Set to TRUE to flag periods of speech. Set to FALSE to flag periods of silence

nonTalkTimeFilter_relativeTimeRange :: Lens' NonTalkTimeFilter (Maybe RelativeTimeRange) Source #

Makes it possible to specify a time range (in percentage) in your media file, during which you want to search for a period of silence. See for more detail.

nonTalkTimeFilter_threshold :: Lens' NonTalkTimeFilter (Maybe Natural) Source #

Specify the duration, in milliseconds, of the period of silence that you want to flag. For example, you can flag a silent period that lasts 30,000 milliseconds.

RelativeTimeRange

relativeTimeRange_endPercentage :: Lens' RelativeTimeRange (Maybe Natural) Source #

The time, in percentage, when Amazon Transcribe stops searching for the specified criteria in your media file. If you include EndPercentage in your request, you must also include StartPercentage.

relativeTimeRange_first :: Lens' RelativeTimeRange (Maybe Natural) Source #

The time, in percentage, from the start of your media file until the specified value. Amazon Transcribe searches for your specified criteria in this time segment.

relativeTimeRange_last :: Lens' RelativeTimeRange (Maybe Natural) Source #

The time, in percentage, from the specified value until the end of your media file. Amazon Transcribe searches for your specified criteria in this time segment.

relativeTimeRange_startPercentage :: Lens' RelativeTimeRange (Maybe Natural) Source #

The time, in percentage, when Amazon Transcribe starts searching for the specified criteria in your media file. If you include StartPercentage in your request, you must also include EndPercentage.

Rule

rule_interruptionFilter :: Lens' Rule (Maybe InterruptionFilter) Source #

Flag the presence or absence of interruptions in your Call Analytics transcription output. Refer to for more detail.

rule_nonTalkTimeFilter :: Lens' Rule (Maybe NonTalkTimeFilter) Source #

Flag the presence or absence of periods of silence in your Call Analytics transcription output. Refer to for more detail.

rule_sentimentFilter :: Lens' Rule (Maybe SentimentFilter) Source #

Flag the presence or absence of specific sentiments in your Call Analytics transcription output. Refer to for more detail.

rule_transcriptFilter :: Lens' Rule (Maybe TranscriptFilter) Source #

Flag the presence or absence of specific words or phrases in your Call Analytics transcription output. Refer to for more detail.

SentimentFilter

sentimentFilter_absoluteTimeRange :: Lens' SentimentFilter (Maybe AbsoluteTimeRange) Source #

Makes it possible to specify a time range (in milliseconds) in your audio, during which you want to search for the specified sentiments. See for more detail.

sentimentFilter_negate :: Lens' SentimentFilter (Maybe Bool) Source #

Set to TRUE to flag the sentiments that you didn't include in your request. Set to FALSE to flag the sentiments that you specified in your request.

sentimentFilter_participantRole :: Lens' SentimentFilter (Maybe ParticipantRole) Source #

Specify the participant that you want to flag. Omitting this parameter is equivalent to specifying both participants.

sentimentFilter_relativeTimeRange :: Lens' SentimentFilter (Maybe RelativeTimeRange) Source #

Makes it possible to specify a time range (in percentage) in your media file, during which you want to search for the specified sentiments. See for more detail.

sentimentFilter_sentiments :: Lens' SentimentFilter (NonEmpty SentimentValue) Source #

Specify the sentiments that you want to flag.

Settings

settings_channelIdentification :: Lens' Settings (Maybe Bool) Source #

Enables channel identification in multi-channel audio.

Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.

You can't include both ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException.

For more information, see Transcribing multi-channel audio.

settings_maxAlternatives :: Lens' Settings (Maybe Natural) Source #

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.

settings_maxSpeakerLabels :: Lens' Settings (Maybe Natural) Source #

Specify the maximum number of speakers you want to partition in your media.

Note that if your media contains more speakers than the specified number, multiple speakers are treated as a single speaker.

If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.

settings_showAlternatives :: Lens' Settings (Maybe Bool) Source #

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 identification, 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.

settings_showSpeakerLabels :: Lens' Settings (Maybe Bool) Source #

Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file.

If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels.

You can't include both ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException.

For more information, see Partitioning speakers (diarization).

settings_vocabularyFilterMethod :: Lens' Settings (Maybe VocabularyFilterMethod) Source #

Specify how you want your custom vocabulary filter applied to your transcript.

To replace words with ***, choose mask.

To delete words, choose remove.

To flag words without changing them, choose tag.

settings_vocabularyFilterName :: Lens' Settings (Maybe Text) Source #

The name of the custom vocabulary filter you want to use in your transcription job request. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.

Note that if you include VocabularyFilterName in your request, you must also include VocabularyFilterMethod.

settings_vocabularyName :: Lens' Settings (Maybe Text) Source #

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 Amazon Web Services account.

Subtitles

subtitles_formats :: Lens' Subtitles (Maybe [SubtitleFormat]) Source #

Specify the output format for your subtitle file; if you select both WebVTT (vtt) and SubRip (srt) formats, two output files are generated.

subtitles_outputStartIndex :: Lens' Subtitles (Maybe Natural) Source #

Specify the starting value that is assigned to the first subtitle segment.

The default start index for Amazon Transcribe is 0, which differs 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.

SubtitlesOutput

subtitlesOutput_formats :: Lens' SubtitlesOutput (Maybe [SubtitleFormat]) Source #

Provides the format of your subtitle files. If your request included both WebVTT (vtt) and SubRip (srt) formats, both formats are shown.

subtitlesOutput_outputStartIndex :: Lens' SubtitlesOutput (Maybe Natural) Source #

Provides the start index value for your subtitle files. If you did not specify a value in your request, the default value of 0 is used.

subtitlesOutput_subtitleFileUris :: Lens' SubtitlesOutput (Maybe [Text]) Source #

The Amazon S3 location of your transcript. You can use this URI to access or download your subtitle file. Your subtitle file is stored in the same location as your transcript. If you specified 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 specified in your request.

If you didn't include OutputBucketName in your transcription job request, your subtitle file is stored in a service-managed bucket, and TranscriptFileUri provides you with a temporary URI you can use for secure access to your subtitle file.

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.

Tag

tag_key :: Lens' Tag Text Source #

The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag Department:Sales, the key is 'Department'.

tag_value :: Lens' Tag Text Source #

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.

Transcript

transcript_redactedTranscriptFileUri :: Lens' Transcript (Maybe Text) Source #

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 specified 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.

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.

transcript_transcriptFileUri :: Lens' Transcript (Maybe Text) Source #

The Amazon S3 location of your 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 specified 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.

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.

TranscriptFilter

transcriptFilter_absoluteTimeRange :: Lens' TranscriptFilter (Maybe AbsoluteTimeRange) Source #

Makes it possible to specify a time range (in milliseconds) in your audio, during which you want to search for the specified key words or phrases. See for more detail.

transcriptFilter_negate :: Lens' TranscriptFilter (Maybe Bool) Source #

Set to TRUE to flag the absence of the phrase that you specified in your request. Set to FALSE to flag the presence of the phrase that you specified in your request.

transcriptFilter_participantRole :: Lens' TranscriptFilter (Maybe ParticipantRole) Source #

Specify the participant that you want to flag. Omitting this parameter is equivalent to specifying both participants.

transcriptFilter_relativeTimeRange :: Lens' TranscriptFilter (Maybe RelativeTimeRange) Source #

Makes it possible to specify a time range (in percentage) in your media file, during which you want to search for the specified key words or phrases. See for more detail.

transcriptFilter_transcriptFilterType :: Lens' TranscriptFilter TranscriptFilterType Source #

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 flagged.

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 flagged.

transcriptFilter_targets :: Lens' TranscriptFilter (NonEmpty Text) Source #

Specify the phrases that you want to flag.

TranscriptionJob

transcriptionJob_completionTime :: Lens' TranscriptionJob (Maybe UTCTime) Source #

The date and time the specified transcription job finished 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.

transcriptionJob_contentRedaction :: Lens' TranscriptionJob (Maybe ContentRedaction) Source #

Indicates whether redaction was enabled in your transcript.

transcriptionJob_creationTime :: Lens' TranscriptionJob (Maybe UTCTime) Source #

The date and time the specified 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.

transcriptionJob_failureReason :: Lens' TranscriptionJob (Maybe Text) Source #

If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job request failed.

The FailureReason field contains one of the following values:

  • Unsupported media format.

    The media format specified in MediaFormat isn't valid. Refer to MediaFormat for a list of supported formats.

  • The media format provided does not match the detected media format.

    The media format specified in MediaFormat doesn't match the format of the input file. Check the media format of your media file and correct the specified value.

  • Invalid sample rate for audio file.

    The sample rate specified 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 specified in MediaSampleRateHertz doesn't match the sample rate detected in your input media file. Check the sample rate of your media file and correct the specified value.

  • Invalid file size: file size too large.

    The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Guidelines and 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 Guidelines and quotas.

transcriptionJob_identifiedLanguageScore :: Lens' TranscriptionJob (Maybe Double) Source #

The confidence score associated with the language identified in your media file.

Confidence scores are values between 0 and 1; a larger value indicates a higher probability that the identified language correctly matches the language spoken in your media.

transcriptionJob_identifyLanguage :: Lens' TranscriptionJob (Maybe Bool) Source #

Indicates whether automatic language identification was enabled (TRUE) for the specified transcription job.

transcriptionJob_identifyMultipleLanguages :: Lens' TranscriptionJob (Maybe Bool) Source #

Indicates whether automatic multi-language identification was enabled (TRUE) for the specified transcription job.

transcriptionJob_jobExecutionSettings :: Lens' TranscriptionJob (Maybe JobExecutionSettings) Source #

Provides information about how your transcription job was processed. This parameter shows if your request was queued and what data access role was used.

transcriptionJob_languageCode :: Lens' TranscriptionJob (Maybe LanguageCode) Source #

The language code used to create your transcription job. This parameter is used with single-language identification. For multi-language identification requests, refer to the plural version of this parameter, LanguageCodes.

transcriptionJob_languageCodes :: Lens' TranscriptionJob (Maybe [LanguageCodeItem]) Source #

The language codes used to create your transcription job. This parameter is used with multi-language identification. For single-language identification requests, refer to the singular version of this parameter, LanguageCode.

transcriptionJob_languageIdSettings :: Lens' TranscriptionJob (Maybe (HashMap LanguageCode LanguageIdSettings)) Source #

Provides the name and language of all custom language models, custom vocabularies, and custom vocabulary filters that you included in your request.

transcriptionJob_languageOptions :: Lens' TranscriptionJob (Maybe (NonEmpty LanguageCode)) Source #

Provides the language codes you specified in your request.

transcriptionJob_media :: Lens' TranscriptionJob (Maybe Media) Source #

Provides the Amazon S3 location of the media file you used in your request.

transcriptionJob_mediaSampleRateHertz :: Lens' TranscriptionJob (Maybe Natural) Source #

The sample rate, in hertz, of the audio track in your input media file.

transcriptionJob_modelSettings :: Lens' TranscriptionJob (Maybe ModelSettings) Source #

Provides information on the custom language model you included in your request.

transcriptionJob_settings :: Lens' TranscriptionJob (Maybe Settings) Source #

Provides information on any additional settings that were included in your request. Additional settings include channel identification, alternative transcriptions, speaker partitioning, custom vocabularies, and custom vocabulary filters.

transcriptionJob_startTime :: Lens' TranscriptionJob (Maybe UTCTime) Source #

The date and time the specified 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.

transcriptionJob_subtitles :: Lens' TranscriptionJob (Maybe SubtitlesOutput) Source #

Indicates whether subtitles were generated with your transcription.

transcriptionJob_tags :: Lens' TranscriptionJob (Maybe (NonEmpty Tag)) Source #

The tags, each in the form of a key:value pair, assigned to the specified transcription job.

transcriptionJob_transcript :: Lens' TranscriptionJob (Maybe Transcript) Source #

Provides you with the Amazon S3 URI you can use to access your transcript.

transcriptionJob_transcriptionJobName :: Lens' TranscriptionJob (Maybe Text) Source #

The name of the transcription job. Job names are case sensitive and must be unique within an Amazon Web Services account.

transcriptionJob_transcriptionJobStatus :: Lens' TranscriptionJob (Maybe TranscriptionJobStatus) Source #

Provides the status of the specified transcription job.

If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri (or RedactedTranscriptFileUri, if you requested transcript redaction). If the status is FAILED, FailureReason provides details on why your transcription job failed.

TranscriptionJobSummary

transcriptionJobSummary_completionTime :: Lens' TranscriptionJobSummary (Maybe UTCTime) Source #

The date and time the specified transcription job finished 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.

transcriptionJobSummary_contentRedaction :: Lens' TranscriptionJobSummary (Maybe ContentRedaction) Source #

The content redaction settings of the transcription job.

transcriptionJobSummary_creationTime :: Lens' TranscriptionJobSummary (Maybe UTCTime) Source #

The date and time the specified 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.

transcriptionJobSummary_failureReason :: Lens' TranscriptionJobSummary (Maybe Text) Source #

If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job failed. See also: Common Errors.

transcriptionJobSummary_identifiedLanguageScore :: Lens' TranscriptionJobSummary (Maybe Double) Source #

The confidence score associated with the language identified in your media file.

Confidence scores are values between 0 and 1; a larger value indicates a higher probability that the identified language correctly matches the language spoken in your media.

transcriptionJobSummary_identifyLanguage :: Lens' TranscriptionJobSummary (Maybe Bool) Source #

Indicates whether automatic language identification was enabled (TRUE) for the specified transcription job.

transcriptionJobSummary_identifyMultipleLanguages :: Lens' TranscriptionJobSummary (Maybe Bool) Source #

Indicates whether automatic multi-language identification was enabled (TRUE) for the specified transcription job.

transcriptionJobSummary_languageCode :: Lens' TranscriptionJobSummary (Maybe LanguageCode) Source #

The language code used to create your transcription.

transcriptionJobSummary_languageCodes :: Lens' TranscriptionJobSummary (Maybe [LanguageCodeItem]) Source #

The language codes used to create your transcription job. This parameter is used with multi-language identification. For single-language identification, the singular version of this parameter, LanguageCode, is present.

transcriptionJobSummary_outputLocationType :: Lens' TranscriptionJobSummary (Maybe OutputLocationType) Source #

Indicates where the specified transcription output is stored.

If the value is CUSTOMER_BUCKET, the location is the Amazon S3 bucket you specified using the OutputBucketName parameter in your request. If you also included OutputKey in your request, your output is located in the path you specified 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 field.

transcriptionJobSummary_startTime :: Lens' TranscriptionJobSummary (Maybe UTCTime) Source #

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.

transcriptionJobSummary_transcriptionJobName :: Lens' TranscriptionJobSummary (Maybe Text) Source #

The name of the transcription job. Job names are case sensitive and must be unique within an Amazon Web Services account.

transcriptionJobSummary_transcriptionJobStatus :: Lens' TranscriptionJobSummary (Maybe TranscriptionJobStatus) Source #

Provides the status of your transcription job.

If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri (or RedactedTranscriptFileUri, if you requested transcript redaction). If the status is FAILED, FailureReason provides details on why your transcription job failed.

VocabularyFilterInfo

vocabularyFilterInfo_languageCode :: Lens' VocabularyFilterInfo (Maybe LanguageCode) Source #

The language code that represents the language of the entries in your vocabulary filter. Each custom vocabulary filter must contain terms in only one language.

A custom vocabulary filter can only be used to transcribe files in the same language as the filter. For example, if you create a custom vocabulary filter using US English (en-US), you can only apply this filter to files that contain English audio.

For a list of supported languages and their associated language codes, refer to the Supported languages table.

vocabularyFilterInfo_lastModifiedTime :: Lens' VocabularyFilterInfo (Maybe UTCTime) Source #

The date and time the specified custom vocabulary filter was last modified.

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.

vocabularyFilterInfo_vocabularyFilterName :: Lens' VocabularyFilterInfo (Maybe Text) Source #

A unique name, chosen by you, for your custom vocabulary filter. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.

VocabularyInfo

vocabularyInfo_languageCode :: Lens' VocabularyInfo (Maybe LanguageCode) Source #

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 files 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 files that contain English audio.

vocabularyInfo_lastModifiedTime :: Lens' VocabularyInfo (Maybe UTCTime) Source #

The date and time the specified custom vocabulary was last modified.

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_vocabularyName :: Lens' VocabularyInfo (Maybe Text) Source #

A unique name, chosen by you, for your custom vocabulary. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.

vocabularyInfo_vocabularyState :: Lens' VocabularyInfo (Maybe VocabularyState) Source #

The processing state of your custom vocabulary. If the state is READY, you can use the custom vocabulary in a StartTranscriptionJob request.