Amazon Transcribe Service 2017-10-26
- Client: Aws\TranscribeService\TranscribeServiceClient
- Service ID: transcribe
- Version: 2017-10-26
This page describes the parameters and results for the operations of the Amazon Transcribe Service (2017-10-26), and shows how to use the Aws\TranscribeService\TranscribeServiceClient object to call the described operations. This documentation is specific to the 2017-10-26 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName')
, where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */)
.
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */)
.
- CreateCallAnalyticsCategory ( array $params = [] )
Creates a call analytics category.
- CreateLanguageModel ( array $params = [] )
Creates a new custom language model.
- CreateMedicalVocabulary ( array $params = [] )
Creates a new custom medical vocabulary.
- CreateVocabulary ( array $params = [] )
Creates a new custom vocabulary.
- CreateVocabularyFilter ( array $params = [] )
Creates a new vocabulary filter that you can use to filter words from your transcription output.
- DeleteCallAnalyticsCategory ( array $params = [] )
Deletes a call analytics category.
- DeleteCallAnalyticsJob ( array $params = [] )
Deletes a call analytics job.
- DeleteLanguageModel ( array $params = [] )
Deletes a custom language model.
- DeleteMedicalTranscriptionJob ( array $params = [] )
Deletes a medical transcription job, along with any related information.
- DeleteMedicalVocabulary ( array $params = [] )
Deletes a custom medical vocabulary.
- DeleteTranscriptionJob ( array $params = [] )
Deletes a transcription job, along with any related information.
- DeleteVocabulary ( array $params = [] )
Deletes a custom vocabulary.
- DeleteVocabularyFilter ( array $params = [] )
Deletes a vocabulary filter.
- DescribeLanguageModel ( array $params = [] )
Provides information about a specific custom language model in your Amazon Web Services account.
- GetCallAnalyticsCategory ( array $params = [] )
Retrieves information about a call analytics category.
- GetCallAnalyticsJob ( array $params = [] )
Retrieves information about a call analytics job.
- GetMedicalTranscriptionJob ( array $params = [] )
Retrieves information about a medical transcription job.
- GetMedicalVocabulary ( array $params = [] )
Retrieves information about a medical vocabulary.
- GetTranscriptionJob ( array $params = [] )
Returns information about a transcription job.
- GetVocabulary ( array $params = [] )
Gets information about a vocabulary.
- GetVocabularyFilter ( array $params = [] )
Returns information about a vocabulary filter.
- ListCallAnalyticsCategories ( array $params = [] )
Provides more information about the call analytics categories that you've created.
- ListCallAnalyticsJobs ( array $params = [] )
List call analytics jobs with a specified status or substring that matches their names.
- ListLanguageModels ( array $params = [] )
Provides more information about the custom language models you've created.
- ListMedicalTranscriptionJobs ( array $params = [] )
Lists medical transcription jobs with a specified status or substring that matches their names.
- ListMedicalVocabularies ( array $params = [] )
Returns a list of vocabularies that match the specified criteria.
- ListTagsForResource ( array $params = [] )
Lists all tags associated with a given transcription job, vocabulary, or resource.
- ListTranscriptionJobs ( array $params = [] )
Lists transcription jobs with the specified status.
- ListVocabularies ( array $params = [] )
Returns a list of vocabularies that match the specified criteria.
- ListVocabularyFilters ( array $params = [] )
Gets information about vocabulary filters.
- StartCallAnalyticsJob ( array $params = [] )
Starts an asynchronous analytics job that not only transcribes the audio recording of a caller and agent, but also returns additional insights.
- StartMedicalTranscriptionJob ( array $params = [] )
Starts a batch job to transcribe medical speech to text.
- StartTranscriptionJob ( array $params = [] )
Starts an asynchronous job to transcribe speech to text.
- TagResource ( array $params = [] )
Tags an Amazon Transcribe resource with the given list of tags.
- UntagResource ( array $params = [] )
Removes specified tags from a specified Amazon Transcribe resource.
- UpdateCallAnalyticsCategory ( array $params = [] )
Updates the call analytics category with new values.
- UpdateMedicalVocabulary ( array $params = [] )
Updates a vocabulary with new values that you provide in a different text file from the one you used to create the vocabulary.
- UpdateVocabulary ( array $params = [] )
Updates an existing vocabulary with new values.
- UpdateVocabularyFilter ( array $params = [] )
Updates a vocabulary filter with a new list of filtered words.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
CreateCallAnalyticsCategory
$result = $client->createCallAnalyticsCategory
([/* ... */]); $promise = $client->createCallAnalyticsCategoryAsync
([/* ... */]);
Creates a call analytics category. Amazon Transcribe applies the conditions specified by your call analytics categories to your call analytics jobs. For each analytics category, you must create between 1 and 20 rules. For example, you can create a 'greeting' category with a rule that flags calls in which your agent does not use a specified phrase (for example: "Please note this call may be recorded.") in the first 15 seconds of the call. When you start a call analytics job, Amazon Transcribe applies all your existing call analytics categories to that job.
Parameter Syntax
$result = $client->createCallAnalyticsCategory([ 'CategoryName' => '<string>', // REQUIRED 'Rules' => [ // REQUIRED [ 'InterruptionFilter' => [ 'AbsoluteTimeRange' => [ 'EndTime' => <integer>, 'First' => <integer>, 'Last' => <integer>, 'StartTime' => <integer>, ], 'Negate' => true || false, 'ParticipantRole' => 'AGENT|CUSTOMER', 'RelativeTimeRange' => [ 'EndPercentage' => <integer>, 'First' => <integer>, 'Last' => <integer>, 'StartPercentage' => <integer>, ], 'Threshold' => <integer>, ], 'NonTalkTimeFilter' => [ 'AbsoluteTimeRange' => [ 'EndTime' => <integer>, 'First' => <integer>, 'Last' => <integer>, 'StartTime' => <integer>, ], 'Negate' => true || false, 'RelativeTimeRange' => [ 'EndPercentage' => <integer>, 'First' => <integer>, 'Last' => <integer>, 'StartPercentage' => <integer>, ], 'Threshold' => <integer>, ], 'SentimentFilter' => [ 'AbsoluteTimeRange' => [ 'EndTime' => <integer>, 'First' => <integer>, 'Last' => <integer>, 'StartTime' => <integer>, ], 'Negate' => true || false, 'ParticipantRole' => 'AGENT|CUSTOMER', 'RelativeTimeRange' => [ 'EndPercentage' => <integer>, 'First' => <integer>, 'Last' => <integer>, 'StartPercentage' => <integer>, ], 'Sentiments' => ['<string>', ...], // REQUIRED ], 'TranscriptFilter' => [ 'AbsoluteTimeRange' => [ 'EndTime' => <integer>, 'First' => <integer>, 'Last' => <integer>, 'StartTime' => <integer>, ], 'Negate' => true || false, 'ParticipantRole' => 'AGENT|CUSTOMER', 'RelativeTimeRange' => [ 'EndPercentage' => <integer>, 'First' => <integer>, 'Last' => <integer>, 'StartPercentage' => <integer>, ], 'Targets' => ['<string>', ...], // REQUIRED 'TranscriptFilterType' => 'EXACT', // REQUIRED ], ], // ... ], ]);
Parameter Details
Members
- CategoryName
-
- Required: Yes
- Type: string
A unique name, chosen by you, for your call analytics category. For example,
sentiment-positive-last30seconds
. - Rules
-
- Required: Yes
- Type: Array of Rule structures
Rules make up a call analytics category. When creating a call analytics category, you must create between 1 and 20 rules for your 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.
Result Syntax
[ 'CategoryProperties' => [ 'CategoryName' => '<string>', 'CreateTime' => <DateTime>, 'LastUpdateTime' => <DateTime>, 'Rules' => [ [ 'InterruptionFilter' => [ 'AbsoluteTimeRange' => [ 'EndTime' => <integer>, 'First' => <integer>, 'Last' => <integer>, 'StartTime' => <integer>, ], 'Negate' => true || false, 'ParticipantRole' => 'AGENT|CUSTOMER', 'RelativeTimeRange' => [ 'EndPercentage' => <integer>, 'First' => <integer>, 'Last' => <integer>, 'StartPercentage' => <integer>, ], 'Threshold' => <integer>, ], 'NonTalkTimeFilter' => [ 'AbsoluteTimeRange' => [ 'EndTime' => <integer>, 'First' => <integer>, 'Last' => <integer>, 'StartTime' => <integer>, ], 'Negate' => true || false, 'RelativeTimeRange' => [ 'EndPercentage' => <integer>, 'First' => <integer>, 'Last' => <integer>, 'StartPercentage' => <integer>, ], 'Threshold' => <integer>, ], 'SentimentFilter' => [ 'AbsoluteTimeRange' => [ 'EndTime' => <integer>, 'First' => <integer>, 'Last' => <integer>, 'StartTime' => <integer>, ], 'Negate' => true || false, 'ParticipantRole' => 'AGENT|CUSTOMER', 'RelativeTimeRange' => [ 'EndPercentage' => <integer>, 'First' => <integer>, 'Last' => <integer>, 'StartPercentage' => <integer>, ], 'Sentiments' => ['<string>', ...], ], 'TranscriptFilter' => [ 'AbsoluteTimeRange' => [ 'EndTime' => <integer>, 'First' => <integer>, 'Last' => <integer>, 'StartTime' => <integer>, ], 'Negate' => true || false, 'ParticipantRole' => 'AGENT|CUSTOMER', 'RelativeTimeRange' => [ 'EndPercentage' => <integer>, 'First' => <integer>, 'Last' => <integer>, 'StartPercentage' => <integer>, ], 'Targets' => ['<string>', ...], 'TranscriptFilterType' => 'EXACT', ], ], // ... ], ], ]
Result Details
Members
- CategoryProperties
-
- Type: CategoryProperties structure
If your audio matches one of your categories, this field contains data on that category and its associated rules. This parameter shows which category is flagged (
CategoryName
) along with metadata for the rules that match your audio. Metadata includes the rule filter (such asInterruptionFilter
,NonTalkTimeFilter
,SentimentFilter
, andTranscriptFilter
) and where in your audio (StartTime
andEndTime
) the rule has a match.
Errors
-
Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception
Message
field for more information. -
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
-
There was an internal error. Check the error message and try your request again.
-
There is already a resource with that name.
CreateLanguageModel
$result = $client->createLanguageModel
([/* ... */]); $promise = $client->createLanguageModelAsync
([/* ... */]);
Creates a new custom language model. When creating a new language model, you must specify if you want a Wideband (audio sample rates over 16,000 Hz) or Narrowband (audio sample rates under 16,000 Hz) base model. You then include the S3 URI location of your training and tuning files, the language for the model, a unique name, and any tags you want associated with your model.
Parameter Syntax
$result = $client->createLanguageModel([ 'BaseModelName' => 'NarrowBand|WideBand', // REQUIRED 'InputDataConfig' => [ // REQUIRED 'DataAccessRoleArn' => '<string>', // REQUIRED 'S3Uri' => '<string>', // REQUIRED 'TuningDataS3Uri' => '<string>', ], 'LanguageCode' => 'en-US|hi-IN|es-US|en-GB|en-AU', // REQUIRED 'ModelName' => '<string>', // REQUIRED 'Tags' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- BaseModelName
-
- Required: Yes
- Type: string
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, chooseNarrowBand
. - InputDataConfig
-
- Required: Yes
- Type: InputDataConfig structure
Contains your data access role ARN (Amazon Resource Name) and the Amazon S3 locations of your training (
S3Uri
) and tuning (TuningDataS3Uri
) data. - LanguageCode
-
- Required: Yes
- Type: string
The language of your custom language model; note that the language code you select must match the language of your training and tuning data.
- ModelName
-
- Required: Yes
- Type: string
The name of your new 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 language model with the same name as a previous language model, you get a
ConflictException
error. - Tags
-
- Type: Array of Tag structures
Optionally add tags, each in the form of a key:value pair, to your new language model. See also: .
Result Syntax
[ 'BaseModelName' => 'NarrowBand|WideBand', 'InputDataConfig' => [ 'DataAccessRoleArn' => '<string>', 'S3Uri' => '<string>', 'TuningDataS3Uri' => '<string>', ], 'LanguageCode' => 'en-US|hi-IN|es-US|en-GB|en-AU', 'ModelName' => '<string>', 'ModelStatus' => 'IN_PROGRESS|FAILED|COMPLETED', ]
Result Details
Members
- BaseModelName
-
- Type: string
The Amazon Transcribe standard language model, or base model, you used when creating your custom language model.
If your audio has a sample rate of 16,000 Hz or greater, this value should be
WideBand
. If your audio has a sample rate of less than 16,000 Hz, this value should beNarrowBand
. - InputDataConfig
-
- Type: InputDataConfig structure
Lists your data access role ARN (Amazon Resource Name) and the Amazon S3 locations your provided for your training (
S3Uri
) and tuning (TuningDataS3Uri
) data. - LanguageCode
-
- Type: string
The language code you selected for your custom language model.
- ModelName
-
- Type: string
The unique name you chose for your custom language model.
- ModelStatus
-
- Type: string
The status of your custom language model. When the status shows as
COMPLETED
, your model is ready to use.
Errors
-
Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception
Message
field for more information. -
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
-
There was an internal error. Check the error message and try your request again.
-
There is already a resource with that name.
CreateMedicalVocabulary
$result = $client->createMedicalVocabulary
([/* ... */]); $promise = $client->createMedicalVocabularyAsync
([/* ... */]);
Creates a new custom medical vocabulary.
When creating a new medical vocabulary, you must upload a text file that contains your new entries, phrases, and terms into an S3 bucket. Note that this differs from , where you can include a list of terms within your request using the Phrases
flag, as CreateMedicalVocabulary
does not support the Phrases
flag.
For more information on creating a custom vocabulary text file, see Creating a custom vocabulary.
Parameter Syntax
$result = $client->createMedicalVocabulary([ 'LanguageCode' => 'af-ZA|ar-AE|ar-SA|cy-GB|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|ga-IE|gd-GB|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ', // REQUIRED 'Tags' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], 'VocabularyFileUri' => '<string>', // REQUIRED 'VocabularyName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- LanguageCode
-
- Required: Yes
- Type: string
The language code that represents the language of the entries in your custom vocabulary. Note that U.S. English (
en-US
) is the only language supported with Amazon Transcribe Medical. - Tags
-
- Type: Array of Tag structures
Adds one or more tags, each in the form of a key:value pair, to a new medical vocabulary at the time you create the new vocabulary.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
- VocabularyFileUri
-
- Required: Yes
- Type: string
The Amazon S3 location (URI) of the text file that contains your custom vocabulary. The URI must be in the same Amazon Web Services Region as the resource that you're calling.
Here's an example URI path:
https://s3.us-east-1.amazonaws.com/my-s3-bucket/my-vocab-file.txt
- VocabularyName
-
- Required: Yes
- Type: string
The name of your new 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 vocabulary with the same name as a previous vocabulary, you get a
ConflictException
error.
Result Syntax
[ 'FailureReason' => '<string>', 'LanguageCode' => 'af-ZA|ar-AE|ar-SA|cy-GB|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|ga-IE|gd-GB|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ', 'LastModifiedTime' => <DateTime>, 'VocabularyName' => '<string>', 'VocabularyState' => 'PENDING|READY|FAILED', ]
Result Details
Members
- FailureReason
-
- Type: string
If the
VocabularyState
field isFAILED
,FailureReason
contains information about why the job failed. - LanguageCode
-
- Type: string
The language code you selected for your medical vocabulary. Note that U.S. English (
en-US
) is the only language supported with Amazon Transcribe Medical. - LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time you created your custom medical vocabulary.
- VocabularyName
-
- Type: string
The name you chose for your vocabulary.
- VocabularyState
-
- Type: string
The processing state of your custom medical vocabulary. If the state is
READY
, you can use the vocabulary in aStartMedicalTranscriptionJob
request.
Errors
-
Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception
Message
field for more information. -
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
-
There was an internal error. Check the error message and try your request again.
-
There is already a resource with that name.
CreateVocabulary
$result = $client->createVocabulary
([/* ... */]); $promise = $client->createVocabularyAsync
([/* ... */]);
Creates a new custom vocabulary.
When creating a new medical vocabulary, you can either upload a text file that contains your new entries, phrases, and terms into an S3 bucket or include a list of terms directly in your request using the Phrases
flag.
For more information on creating a custom vocabulary, see Creating a custom vocabulary.
Parameter Syntax
$result = $client->createVocabulary([ 'LanguageCode' => 'af-ZA|ar-AE|ar-SA|cy-GB|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|ga-IE|gd-GB|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ', // REQUIRED 'Phrases' => ['<string>', ...], 'Tags' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], 'VocabularyFileUri' => '<string>', 'VocabularyName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- LanguageCode
-
- Required: Yes
- Type: string
The language code that represents the language of the entries in your custom vocabulary. Each vocabulary must contain terms in only one language. For a list of languages and their corresponding language codes, see Supported languages.
- Phrases
-
- Type: Array of strings
Use this flag to include a list of terms within your request.
Note that if you include
Phrases
in your request, you cannot useVocabularyFileUri
; you must choose one or the other. - Tags
-
- Type: Array of Tag structures
Adds one or more tags, each in the form of a key:value pair, to a new custom vocabulary at the time you create this new vocabulary.
- VocabularyFileUri
-
- Type: string
The S3 location of the text file that contains your custom vocabulary. The URI must be located in the same region as the API endpoint you're calling.
Here's an example URI path:
https://s3.us-east-1.amazonaws.com/my-s3-bucket/my-vocab-file.txt
Note that if you include
VocabularyFileUri
in your request, you cannot use thePhrases
flag; you must choose one or the other. - VocabularyName
-
- Required: Yes
- Type: string
The name of your new 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 vocabulary with the same name as a previous vocabulary, you get a
ConflictException
error.
Result Syntax
[ 'FailureReason' => '<string>', 'LanguageCode' => 'af-ZA|ar-AE|ar-SA|cy-GB|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|ga-IE|gd-GB|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ', 'LastModifiedTime' => <DateTime>, 'VocabularyName' => '<string>', 'VocabularyState' => 'PENDING|READY|FAILED', ]
Result Details
Members
- FailureReason
-
- Type: string
If the
VocabularyState
field isFAILED
,FailureReason
contains information about why the job failed. - LanguageCode
-
- Type: string
The language code you selected for your vocabulary.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time you created your custom vocabulary.
- VocabularyName
-
- Type: string
The name you chose for your vocabulary.
- VocabularyState
-
- Type: string
The processing state of your vocabulary. If the state is
READY
, you can use the vocabulary in aStartTranscriptionJob
request.
Errors
-
Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception
Message
field for more information. -
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
-
There was an internal error. Check the error message and try your request again.
-
There is already a resource with that name.
CreateVocabularyFilter
$result = $client->createVocabularyFilter
([/* ... */]); $promise = $client->createVocabularyFilterAsync
([/* ... */]);
Creates a new vocabulary filter that you can use to filter words from your transcription output. For example, you can use this operation to remove profanity from your transcript.
Parameter Syntax
$result = $client->createVocabularyFilter([ 'LanguageCode' => 'af-ZA|ar-AE|ar-SA|cy-GB|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|ga-IE|gd-GB|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ', // REQUIRED 'Tags' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], 'VocabularyFilterFileUri' => '<string>', 'VocabularyFilterName' => '<string>', // REQUIRED 'Words' => ['<string>', ...], ]);
Parameter Details
Members
- LanguageCode
-
- Required: Yes
- Type: string
The language code of the words in the vocabulary filter. All words in the filter must be in the same language. The vocabulary filter can only be used with transcription jobs in the specified language.
- Tags
-
- Type: Array of Tag structures
Adds one or more tags, each in the form of a key:value pair, to a new vocabulary filter at the time you create this new vocabulary filter.
- VocabularyFilterFileUri
-
- Type: string
The Amazon S3 location of a text file used as input to create the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies.
Your vocabulary filter file must be less than 50 KB in size.
Note that if you include
VocabularyFilterFileUri
in your request, you cannot useWords
; you must choose one or the other. - VocabularyFilterName
-
- Required: Yes
- Type: string
The name of your new 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 vocabulary filter with the same name as a previous vocabulary filter, you get a
ConflictException
error. - Words
-
- Type: Array of strings
The words you want in your vocabulary filter. Only use characters specified in the Character sets for the language you're transcribing.
Note that if you include
Words
in your request, you cannot useVocabularyFilterFileUri
; you must choose one or the other.
Result Syntax
[ 'LanguageCode' => 'af-ZA|ar-AE|ar-SA|cy-GB|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|ga-IE|gd-GB|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ', 'LastModifiedTime' => <DateTime>, 'VocabularyFilterName' => '<string>', ]
Result Details
Members
Errors
-
Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception
Message
field for more information. -
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
-
There was an internal error. Check the error message and try your request again.
-
There is already a resource with that name.
DeleteCallAnalyticsCategory
$result = $client->deleteCallAnalyticsCategory
([/* ... */]); $promise = $client->deleteCallAnalyticsCategoryAsync
([/* ... */]);
Deletes a call analytics category. To use this operation, specify the name of the category you want to delete using CategoryName
.
Parameter Syntax
$result = $client->deleteCallAnalyticsCategory([ 'CategoryName' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
We can't find the requested resource. Check the name and try your request again.
-
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
-
Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception
Message
field for more information. -
There was an internal error. Check the error message and try your request again.
DeleteCallAnalyticsJob
$result = $client->deleteCallAnalyticsJob
([/* ... */]); $promise = $client->deleteCallAnalyticsJobAsync
([/* ... */]);
Deletes a call analytics job. To use this operation, specify the name of the job you want to delete using CallAnalyticsJobName
.
Parameter Syntax
$result = $client->deleteCallAnalyticsJob([ 'CallAnalyticsJobName' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
-
Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception
Message
field for more information. -
There was an internal error. Check the error message and try your request again.
DeleteLanguageModel
$result = $client->deleteLanguageModel
([/* ... */]); $promise = $client->deleteLanguageModelAsync
([/* ... */]);
Deletes a custom language model. To use this operation, specify the name of the language model you want to delete using ModelName
.
Parameter Syntax
$result = $client->deleteLanguageModel([ 'ModelName' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception
Message
field for more information. -
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
-
There was an internal error. Check the error message and try your request again.
DeleteMedicalTranscriptionJob
$result = $client->deleteMedicalTranscriptionJob
([/* ... */]); $promise = $client->deleteMedicalTranscriptionJobAsync
([/* ... */]);
Deletes a medical transcription job, along with any related information. To use this operation, specify the name of the job you want to delete using MedicalTranscriptionJobName
.
Parameter Syntax
$result = $client->deleteMedicalTranscriptionJob([ 'MedicalTranscriptionJobName' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
-
Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception
Message
field for more information. -
There was an internal error. Check the error message and try your request again.
DeleteMedicalVocabulary
$result = $client->deleteMedicalVocabulary
([/* ... */]); $promise = $client->deleteMedicalVocabularyAsync
([/* ... */]);
Deletes a custom medical vocabulary. To use this operation, specify the name of the vocabulary you want to delete using VocabularyName
.
Parameter Syntax
$result = $client->deleteMedicalVocabulary([ 'VocabularyName' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
We can't find the requested resource. Check the name and try your request again.
-
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
-
Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception
Message
field for more information. -
There was an internal error. Check the error message and try your request again.
DeleteTranscriptionJob
$result = $client->deleteTranscriptionJob
([/* ... */]); $promise = $client->deleteTranscriptionJobAsync
([/* ... */]);
Deletes a transcription job, along with any related information. To use this operation, specify the name of the job you want to delete using TranscriptionJobName
.
Parameter Syntax
$result = $client->deleteTranscriptionJob([ 'TranscriptionJobName' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
-
Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception
Message
field for more information. -
There was an internal error. Check the error message and try your request again.
DeleteVocabulary
$result = $client->deleteVocabulary
([/* ... */]); $promise = $client->deleteVocabularyAsync
([/* ... */]);
Deletes a custom vocabulary. To use this operation, specify the name of the vocabulary you want to delete using VocabularyName
.
Parameter Syntax
$result = $client->deleteVocabulary([ 'VocabularyName' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
We can't find the requested resource. Check the name and try your request again.
-
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
-
Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception
Message
field for more information. -
There was an internal error. Check the error message and try your request again.
DeleteVocabularyFilter
$result = $client->deleteVocabularyFilter
([/* ... */]); $promise = $client->deleteVocabularyFilterAsync
([/* ... */]);
Deletes a vocabulary filter. To use this operation, specify the name of the vocabulary filter you want to delete using VocabularyFilterName
.
Parameter Syntax
$result = $client->deleteVocabularyFilter([ 'VocabularyFilterName' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
We can't find the requested resource. Check the name and try your request again.
-
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
-
Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception
Message
field for more information. -
There was an internal error. Check the error message and try your request again.
DescribeLanguageModel
$result = $client->describeLanguageModel
([/* ... */]); $promise = $client->describeLanguageModelAsync
([/* ... */]);
Provides information about a specific custom language model in your Amazon Web Services account.
This operation 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 operation to help identify the reason.
Parameter Syntax
$result = $client->describeLanguageModel([ 'ModelName' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[ 'LanguageModel' => [ 'BaseModelName' => 'NarrowBand|WideBand', 'CreateTime' => <DateTime>, 'FailureReason' => '<string>', 'InputDataConfig' => [ 'DataAccessRoleArn' => '<string>', 'S3Uri' => '<string>', 'TuningDataS3Uri' => '<string>', ], 'LanguageCode' => 'en-US|hi-IN|es-US|en-GB|en-AU', 'LastModifiedTime' => <DateTime>, 'ModelName' => '<string>', 'ModelStatus' => 'IN_PROGRESS|FAILED|COMPLETED', 'UpgradeAvailability' => true || false, ], ]
Result Details
Members
- LanguageModel
-
- Type: LanguageModel structure
The name of the custom language model you requested more information about.
Errors
-
Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception
Message
field for more information. -
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
-
There was an internal error. Check the error message and try your request again.
-
We can't find the requested resource. Check the name and try your request again.
GetCallAnalyticsCategory
$result = $client->getCallAnalyticsCategory
([/* ... */]); $promise = $client->getCallAnalyticsCategoryAsync
([/* ... */]);
Retrieves information about a call analytics category.
Parameter Syntax
$result = $client->getCallAnalyticsCategory([ 'CategoryName' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[ 'CategoryProperties' => [ 'CategoryName' => '<string>', 'CreateTime' => <DateTime>, 'LastUpdateTime' => <DateTime>, 'Rules' => [ [ 'InterruptionFilter' => [ 'AbsoluteTimeRange' => [ 'EndTime' => <integer>, 'First' => <integer>, 'Last' => <integer>, 'StartTime' => <integer>, ], 'Negate' => true || false, 'ParticipantRole' => 'AGENT|CUSTOMER', 'RelativeTimeRange' => [ 'EndPercentage' => <integer>, 'First' => <integer>, 'Last' => <integer>, 'StartPercentage' => <integer>, ], 'Threshold' => <integer>, ], 'NonTalkTimeFilter' => [ 'AbsoluteTimeRange' => [ 'EndTime' => <integer>, 'First' => <integer>, 'Last' => <integer>, 'StartTime' => <integer>, ], 'Negate' => true || false, 'RelativeTimeRange' => [ 'EndPercentage' => <integer>, 'First' => <integer>, 'Last' => <integer>, 'StartPercentage' => <integer>, ], 'Threshold' => <integer>, ], 'SentimentFilter' => [ 'AbsoluteTimeRange' => [ 'EndTime' => <integer>, 'First' => <integer>, 'Last' => <integer>, 'StartTime' => <integer>, ], 'Negate' => true || false, 'ParticipantRole' => 'AGENT|CUSTOMER', 'RelativeTimeRange' => [ 'EndPercentage' => <integer>, 'First' => <integer>, 'Last' => <integer>, 'StartPercentage' => <integer>, ], 'Sentiments' => ['<string>', ...], ], 'TranscriptFilter' => [ 'AbsoluteTimeRange' => [ 'EndTime' => <integer>, 'First' => <integer>, 'Last' => <integer>, 'StartTime' => <integer>, ], 'Negate' => true || false, 'ParticipantRole' => 'AGENT|CUSTOMER', 'RelativeTimeRange' => [ 'EndPercentage' => <integer>, 'First' => <integer>, 'Last' => <integer>, 'StartPercentage' => <integer>, ], 'Targets' => ['<string>', ...], 'TranscriptFilterType' => 'EXACT', ], ], // ... ], ], ]
Result Details
Members
- CategoryProperties
-
- Type: CategoryProperties structure
Provides you with the rules associated with the category you specified in your
GetCallAnalyticsCategory
request.
Errors
-
We can't find the requested resource. Check the name and try your request again.
-
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
-
There was an internal error. Check the error message and try your request again.
-
Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception
Message
field for more information.
GetCallAnalyticsJob
$result = $client->getCallAnalyticsJob
([/* ... */]); $promise = $client->getCallAnalyticsJobAsync
([/* ... */]);
Retrieves information about a call analytics job.
To view the job's status, refer to the CallAnalyticsJobStatus
field. If the status is COMPLETED
, the job is finished. You can then find your transcript at the URI specified in the TranscriptFileUri
field. If you enabled personally identifiable information (PII) redaction, the redacted transcript appears in the RedactedTranscriptFileUri
field.
Parameter Syntax
$result = $client->getCallAnalyticsJob([ 'CallAnalyticsJobName' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[ 'CallAnalyticsJob' => [ 'CallAnalyticsJobName' => '<string>', 'CallAnalyticsJobStatus' => 'QUEUED|IN_PROGRESS|FAILED|COMPLETED', 'ChannelDefinitions' => [ [ 'ChannelId' => <integer>, 'ParticipantRole' => 'AGENT|CUSTOMER', ], // ... ], 'CompletionTime' => <DateTime>, 'CreationTime' => <DateTime>, 'DataAccessRoleArn' => '<string>', 'FailureReason' => '<string>', 'IdentifiedLanguageScore' => <float>, 'LanguageCode' => 'af-ZA|ar-AE|ar-SA|cy-GB|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|ga-IE|gd-GB|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ', 'Media' => [ 'MediaFileUri' => '<string>', 'RedactedMediaFileUri' => '<string>', ], 'MediaFormat' => 'mp3|mp4|wav|flac|ogg|amr|webm', 'MediaSampleRateHertz' => <integer>, 'Settings' => [ 'ContentRedaction' => [ 'PiiEntityTypes' => ['<string>', ...], 'RedactionOutput' => 'redacted|redacted_and_unredacted', 'RedactionType' => 'PII', ], 'LanguageIdSettings' => [ '<LanguageCode>' => [ 'LanguageModelName' => '<string>', 'VocabularyFilterName' => '<string>', 'VocabularyName' => '<string>', ], // ... ], 'LanguageModelName' => '<string>', 'LanguageOptions' => ['<string>', ...], 'VocabularyFilterMethod' => 'remove|mask|tag', 'VocabularyFilterName' => '<string>', 'VocabularyName' => '<string>', ], 'StartTime' => <DateTime>, 'Transcript' => [ 'RedactedTranscriptFileUri' => '<string>', 'TranscriptFileUri' => '<string>', ], ], ]
Result Details
Members
- CallAnalyticsJob
-
- Type: CallAnalyticsJob structure
An object that contains detailed information about your call analytics job. Returned fields include:
CallAnalyticsJobName
,CallAnalyticsJobStatus
,ChannelDefinitions
,CompletionTime
,CreationTime
,DataAccessRoleArn
,FailureReason
,IdentifiedLanguageScore
,LanguageCode
,Media
,MediaFormat
,MediaSampleRateHertz
,Settings
,StartTime
, andTranscript
.
Errors
-
Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception
Message
field for more information. -
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
-
There was an internal error. Check the error message and try your request again.
-
We can't find the requested resource. Check the name and try your request again.
GetMedicalTranscriptionJob
$result = $client->getMedicalTranscriptionJob
([/* ... */]); $promise = $client->getMedicalTranscriptionJobAsync
([/* ... */]);
Retrieves information about a medical transcription job.
To view the job's status, refer to the TranscriptionJobStatus
field. If the status is COMPLETED
, the job is finished. You can then find your transcript at the URI specified in the TranscriptFileUri
field.
Parameter Syntax
$result = $client->getMedicalTranscriptionJob([ 'MedicalTranscriptionJobName' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[ 'MedicalTranscriptionJob' => [ 'CompletionTime' => <DateTime>, 'ContentIdentificationType' => 'PHI', 'CreationTime' => <DateTime>, 'FailureReason' => '<string>', 'LanguageCode' => 'af-ZA|ar-AE|ar-SA|cy-GB|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|ga-IE|gd-GB|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ', 'Media' => [ 'MediaFileUri' => '<string>', 'RedactedMediaFileUri' => '<string>', ], 'MediaFormat' => 'mp3|mp4|wav|flac|ogg|amr|webm', 'MediaSampleRateHertz' => <integer>, 'MedicalTranscriptionJobName' => '<string>', 'Settings' => [ 'ChannelIdentification' => true || false, 'MaxAlternatives' => <integer>, 'MaxSpeakerLabels' => <integer>, 'ShowAlternatives' => true || false, 'ShowSpeakerLabels' => true || false, 'VocabularyName' => '<string>', ], 'Specialty' => 'PRIMARYCARE', 'StartTime' => <DateTime>, 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'Transcript' => [ 'TranscriptFileUri' => '<string>', ], 'TranscriptionJobStatus' => 'QUEUED|IN_PROGRESS|FAILED|COMPLETED', 'Type' => 'CONVERSATION|DICTATION', ], ]
Result Details
Members
- MedicalTranscriptionJob
-
- Type: MedicalTranscriptionJob structure
An object that contains detailed information about your medical transcription job. Returned fields include:
CompletionTime
,ContentIdentificationType
,CreationTime
,FailureReason
,LanguageCode
,Media
,MediaFormat
,MediaSampleRateHertz
,MedicalTranscriptionJobName
,Settings
,Specialty
,StartTime
,Tags
,Transcript
,TranscriptionJobStatus
, andType
.
Errors
-
Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception
Message
field for more information. -
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
-
There was an internal error. Check the error message and try your request again.
-
We can't find the requested resource. Check the name and try your request again.
GetMedicalVocabulary
$result = $client->getMedicalVocabulary
([/* ... */]); $promise = $client->getMedicalVocabularyAsync
([/* ... */]);
Retrieves information about a medical vocabulary.
Parameter Syntax
$result = $client->getMedicalVocabulary([ 'VocabularyName' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[ 'DownloadUri' => '<string>', 'FailureReason' => '<string>', 'LanguageCode' => 'af-ZA|ar-AE|ar-SA|cy-GB|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|ga-IE|gd-GB|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ', 'LastModifiedTime' => <DateTime>, 'VocabularyName' => '<string>', 'VocabularyState' => 'PENDING|READY|FAILED', ]
Result Details
Members
- DownloadUri
-
- Type: string
The S3 location where the vocabulary is stored; use this URI to view or download the vocabulary.
- FailureReason
-
- Type: string
If your request returns a
VocabularyState
that isFAILED
, theFailureReason
field contains information about why the request failed.For more information, refer to the Common Errors section.
- LanguageCode
-
- Type: string
The valid language code for your vocabulary entries.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the vocabulary was last modified with a text file different from the one that was previously used.
- VocabularyName
-
- Type: string
The name of the vocabulary returned by Amazon Transcribe Medical.
- VocabularyState
-
- Type: string
The processing state of the vocabulary. If the
VocabularyState
isREADY
then you can use it in theStartMedicalTranscriptionJob
operation.
Errors
-
We can't find the requested resource. Check the name and try your request again.
-
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
-
There was an internal error. Check the error message and try your request again.
-
Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception
Message
field for more information.
GetTranscriptionJob
$result = $client->getTranscriptionJob
([/* ... */]); $promise = $client->getTranscriptionJobAsync
([/* ... */]);
Returns information about a transcription job. To see the status of the job, check the TranscriptionJobStatus
field. If the status is COMPLETED
, the job is finished and you can find the results at the location specified in the TranscriptFileUri
field. If you enable content redaction, the redacted transcript appears in RedactedTranscriptFileUri
.
Parameter Syntax
$result = $client->getTranscriptionJob([ 'TranscriptionJobName' => '<string>', // REQUIRED ]);
Parameter Details
Result Syntax
[ 'TranscriptionJob' => [ 'CompletionTime' => <DateTime>, 'ContentRedaction' => [ 'PiiEntityTypes' => ['<string>', ...], 'RedactionOutput' => 'redacted|redacted_and_unredacted', 'RedactionType' => 'PII', ], 'CreationTime' => <DateTime>, 'FailureReason' => '<string>', 'IdentifiedLanguageScore' => <float>, 'IdentifyLanguage' => true || false, 'JobExecutionSettings' => [ 'AllowDeferredExecution' => true || false, 'DataAccessRoleArn' => '<string>', ], 'LanguageCode' => 'af-ZA|ar-AE|ar-SA|cy-GB|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|ga-IE|gd-GB|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ', 'LanguageIdSettings' => [ '<LanguageCode>' => [ 'LanguageModelName' => '<string>', 'VocabularyFilterName' => '<string>', 'VocabularyName' => '<string>', ], // ... ], 'LanguageOptions' => ['<string>', ...], 'Media' => [ 'MediaFileUri' => '<string>', 'RedactedMediaFileUri' => '<string>', ], 'MediaFormat' => 'mp3|mp4|wav|flac|ogg|amr|webm', 'MediaSampleRateHertz' => <integer>, 'ModelSettings' => [ 'LanguageModelName' => '<string>', ], 'Settings' => [ 'ChannelIdentification' => true || false, 'MaxAlternatives' => <integer>, 'MaxSpeakerLabels' => <integer>, 'ShowAlternatives' => true || false, 'ShowSpeakerLabels' => true || false, 'VocabularyFilterMethod' => 'remove|mask|tag', 'VocabularyFilterName' => '<string>', 'VocabularyName' => '<string>', ], 'StartTime' => <DateTime>, 'Subtitles' => [ 'Formats' => ['<string>', ...], 'OutputStartIndex' => <integer>, 'SubtitleFileUris' => ['<string>', ...], ], 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'Transcript' => [ 'RedactedTranscriptFileUri' => '<string>', 'TranscriptFileUri' => '<string>', ], 'TranscriptionJobName' => '<string>', 'TranscriptionJobStatus' => 'QUEUED|IN_PROGRESS|FAILED|COMPLETED', ], ]
Result Details
Members
- TranscriptionJob
-
- Type: TranscriptionJob structure
An object that contains the results of the transcription job.
Errors
-
Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception
Message
field for more information. -
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
-
There was an internal error. Check the error message and try your request again.
-
We can't find the requested resource. Check the name and try your request again.
GetVocabulary
$result = $client->getVocabulary
([/* ... */]); $promise = $client->getVocabularyAsync
([/* ... */]);
Gets information about a vocabulary.
Parameter Syntax
$result = $client->getVocabulary([ 'VocabularyName' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[ 'DownloadUri' => '<string>', 'FailureReason' => '<string>', 'LanguageCode' => 'af-ZA|ar-AE|ar-SA|cy-GB|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|ga-IE|gd-GB|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ', 'LastModifiedTime' => <DateTime>, 'VocabularyName' => '<string>', 'VocabularyState' => 'PENDING|READY|FAILED', ]
Result Details
Members
- DownloadUri
-
- Type: string
The S3 location where the vocabulary is stored. Use this URI to get the contents of the vocabulary. The URI is available for a limited time.
- FailureReason
-
- Type: string
If the
VocabularyState
field isFAILED
, this field contains information about why the job failed. - LanguageCode
-
- Type: string
The language code of the vocabulary entries.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the vocabulary was last modified.
- VocabularyName
-
- Type: string
The name of the vocabulary to return.
- VocabularyState
-
- Type: string
The processing state of the vocabulary.
Errors
-
We can't find the requested resource. Check the name and try your request again.
-
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
-
There was an internal error. Check the error message and try your request again.
-
Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception
Message
field for more information.
GetVocabularyFilter
$result = $client->getVocabularyFilter
([/* ... */]); $promise = $client->getVocabularyFilterAsync
([/* ... */]);
Returns information about a vocabulary filter.
Parameter Syntax
$result = $client->getVocabularyFilter([ 'VocabularyFilterName' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[ 'DownloadUri' => '<string>', 'LanguageCode' => 'af-ZA|ar-AE|ar-SA|cy-GB|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|ga-IE|gd-GB|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ', 'LastModifiedTime' => <DateTime>, 'VocabularyFilterName' => '<string>', ]
Result Details
Members
- DownloadUri
-
- Type: string
The URI of the list of words in the vocabulary filter. You can use this URI to get the list of words.
- LanguageCode
-
- Type: string
The language code of the words in the vocabulary filter.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the contents of the vocabulary filter were updated.
- VocabularyFilterName
-
- Type: string
The name of the vocabulary filter.
Errors
-
We can't find the requested resource. Check the name and try your request again.
-
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
-
There was an internal error. Check the error message and try your request again.
-
Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception
Message
field for more information.
ListCallAnalyticsCategories
$result = $client->listCallAnalyticsCategories
([/* ... */]); $promise = $client->listCallAnalyticsCategoriesAsync
([/* ... */]);
Provides more information about the call analytics categories that you've created. You can use the information in this list to find a specific category. You can then use the operation to get more information about it.
Parameter Syntax
$result = $client->listCallAnalyticsCategories([ 'MaxResults' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- MaxResults
-
- Type: int
The maximum number of categories to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.
- NextToken
-
- Type: string
When included,
NextToken
fetches the next set of categories if the result of the previous request was truncated.
Result Syntax
[ 'Categories' => [ [ 'CategoryName' => '<string>', 'CreateTime' => <DateTime>, 'LastUpdateTime' => <DateTime>, 'Rules' => [ [ 'InterruptionFilter' => [ 'AbsoluteTimeRange' => [ 'EndTime' => <integer>, 'First' => <integer>, 'Last' => <integer>, 'StartTime' => <integer>, ], 'Negate' => true || false, 'ParticipantRole' => 'AGENT|CUSTOMER', 'RelativeTimeRange' => [ 'EndPercentage' => <integer>, 'First' => <integer>, 'Last' => <integer>, 'StartPercentage' => <integer>, ], 'Threshold' => <integer>, ], 'NonTalkTimeFilter' => [ 'AbsoluteTimeRange' => [ 'EndTime' => <integer>, 'First' => <integer>, 'Last' => <integer>, 'StartTime' => <integer>, ], 'Negate' => true || false, 'RelativeTimeRange' => [ 'EndPercentage' => <integer>, 'First' => <integer>, 'Last' => <integer>, 'StartPercentage' => <integer>, ], 'Threshold' => <integer>, ], 'SentimentFilter' => [ 'AbsoluteTimeRange' => [ 'EndTime' => <integer>, 'First' => <integer>, 'Last' => <integer>, 'StartTime' => <integer>, ], 'Negate' => true || false, 'ParticipantRole' => 'AGENT|CUSTOMER', 'RelativeTimeRange' => [ 'EndPercentage' => <integer>, 'First' => <integer>, 'Last' => <integer>, 'StartPercentage' => <integer>, ], 'Sentiments' => ['<string>', ...], ], 'TranscriptFilter' => [ 'AbsoluteTimeRange' => [ 'EndTime' => <integer>, 'First' => <integer>, 'Last' => <integer>, 'StartTime' => <integer>, ], 'Negate' => true || false, 'ParticipantRole' => 'AGENT|CUSTOMER', 'RelativeTimeRange' => [ 'EndPercentage' => <integer>, 'First' => <integer>, 'Last' => <integer>, 'StartPercentage' => <integer>, ], 'Targets' => ['<string>', ...], 'TranscriptFilterType' => 'EXACT', ], ], // ... ], ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- Categories
-
- Type: Array of CategoryProperties structures
A list of objects containing information about analytics categories.
- NextToken
-
- Type: string
The operation returns a page of jobs at a time. The maximum size of the list is set by the
MaxResults
parameter. If there are more categories in the list than the page size, Amazon Transcribe returns theNextPage
token. Include the token in the next request to the operation to return the next page of analytics categories.
Errors
-
Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception
Message
field for more information. -
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
-
There was an internal error. Check the error message and try your request again.
ListCallAnalyticsJobs
$result = $client->listCallAnalyticsJobs
([/* ... */]); $promise = $client->listCallAnalyticsJobsAsync
([/* ... */]);
List call analytics jobs with a specified status or substring that matches their names.
Parameter Syntax
$result = $client->listCallAnalyticsJobs([ 'JobNameContains' => '<string>', 'MaxResults' => <integer>, 'NextToken' => '<string>', 'Status' => 'QUEUED|IN_PROGRESS|FAILED|COMPLETED', ]);
Parameter Details
Members
- JobNameContains
-
- Type: string
When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.
- MaxResults
-
- Type: int
The maximum number of call analytics jobs to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.
- NextToken
-
- Type: string
If you receive a truncated result in the previous request of , include
NextToken
to fetch the next set of jobs. - Status
-
- Type: string
When specified, returns only call analytics jobs with the specified status. Jobs are ordered by creation date, with the most recent jobs returned first. If you don't specify a status, Amazon Transcribe returns all analytics jobs ordered by creation date.
Result Syntax
[ 'CallAnalyticsJobSummaries' => [ [ 'CallAnalyticsJobName' => '<string>', 'CallAnalyticsJobStatus' => 'QUEUED|IN_PROGRESS|FAILED|COMPLETED', 'CompletionTime' => <DateTime>, 'CreationTime' => <DateTime>, 'FailureReason' => '<string>', 'LanguageCode' => 'af-ZA|ar-AE|ar-SA|cy-GB|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|ga-IE|gd-GB|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ', 'StartTime' => <DateTime>, ], // ... ], 'NextToken' => '<string>', 'Status' => 'QUEUED|IN_PROGRESS|FAILED|COMPLETED', ]
Result Details
Members
- CallAnalyticsJobSummaries
-
- Type: Array of CallAnalyticsJobSummary structures
A list of objects containing summary information for a transcription job.
- NextToken
-
- Type: string
The operation returns a page of jobs at a time. The maximum size of the page is set by the
MaxResults
parameter. If there are more jobs in the list than the page size, Amazon Transcribe returns theNextPage
token. Include the token in your next request to the operation to return next page of jobs. - Status
-
- Type: string
When specified, returns only call analytics jobs with that status. Jobs are ordered by creation date, with the most recent jobs returned first. If you don't specify a status, Amazon Transcribe returns all transcription jobs ordered by creation date.
Errors
-
Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception
Message
field for more information. -
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
-
There was an internal error. Check the error message and try your request again.
ListLanguageModels
$result = $client->listLanguageModels
([/* ... */]); $promise = $client->listLanguageModelsAsync
([/* ... */]);
Provides more information about the custom language models you've created. You can use the information in this list to find a specific custom language model. You can then use the operation to get more information about it.
Parameter Syntax
$result = $client->listLanguageModels([ 'MaxResults' => <integer>, 'NameContains' => '<string>', 'NextToken' => '<string>', 'StatusEquals' => 'IN_PROGRESS|FAILED|COMPLETED', ]);
Parameter Details
Members
- MaxResults
-
- Type: int
The maximum number of language models to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.
- NameContains
-
- Type: string
When specified, the custom language model names returned contain the substring you've specified.
- NextToken
-
- Type: string
When included, fetches the next set of jobs if the result of the previous request was truncated.
- StatusEquals
-
- Type: string
When specified, returns only custom language models with the specified status. Language models are ordered by creation date, with the newest models first. If you don't specify a status, Amazon Transcribe returns all custom language models ordered by date.
Result Syntax
[ 'Models' => [ [ 'BaseModelName' => 'NarrowBand|WideBand', 'CreateTime' => <DateTime>, 'FailureReason' => '<string>', 'InputDataConfig' => [ 'DataAccessRoleArn' => '<string>', 'S3Uri' => '<string>', 'TuningDataS3Uri' => '<string>', ], 'LanguageCode' => 'en-US|hi-IN|es-US|en-GB|en-AU', 'LastModifiedTime' => <DateTime>, 'ModelName' => '<string>', 'ModelStatus' => 'IN_PROGRESS|FAILED|COMPLETED', 'UpgradeAvailability' => true || false, ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- Models
-
- Type: Array of LanguageModel structures
A list of objects containing information about custom language models.
- NextToken
-
- Type: string
The operation returns a page of jobs at a time. The maximum size of the list is set by the MaxResults parameter. If there are more language models in the list than the page size, Amazon Transcribe returns the
NextPage
token. Include the token in the next request to the operation to return the next page of language models.
Errors
-
Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception
Message
field for more information. -
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
-
There was an internal error. Check the error message and try your request again.
ListMedicalTranscriptionJobs
$result = $client->listMedicalTranscriptionJobs
([/* ... */]); $promise = $client->listMedicalTranscriptionJobsAsync
([/* ... */]);
Lists medical transcription jobs with a specified status or substring that matches their names.
Parameter Syntax
$result = $client->listMedicalTranscriptionJobs([ 'JobNameContains' => '<string>', 'MaxResults' => <integer>, 'NextToken' => '<string>', 'Status' => 'QUEUED|IN_PROGRESS|FAILED|COMPLETED', ]);
Parameter Details
Members
- JobNameContains
-
- Type: string
When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.
- MaxResults
-
- Type: int
The maximum number of medical transcription jobs to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.
- NextToken
-
- Type: string
If you a receive a truncated result in the previous request of
ListMedicalTranscriptionJobs
, includeNextToken
to fetch the next set of jobs. - Status
-
- Type: string
When specified, returns only medical transcription jobs with the specified status. Jobs are ordered by creation date, with the newest jobs returned first. If you don't specify a status, Amazon Transcribe Medical returns all transcription jobs ordered by creation date.
Result Syntax
[ 'MedicalTranscriptionJobSummaries' => [ [ 'CompletionTime' => <DateTime>, 'ContentIdentificationType' => 'PHI', 'CreationTime' => <DateTime>, 'FailureReason' => '<string>', 'LanguageCode' => 'af-ZA|ar-AE|ar-SA|cy-GB|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|ga-IE|gd-GB|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ', 'MedicalTranscriptionJobName' => '<string>', 'OutputLocationType' => 'CUSTOMER_BUCKET|SERVICE_BUCKET', 'Specialty' => 'PRIMARYCARE', 'StartTime' => <DateTime>, 'TranscriptionJobStatus' => 'QUEUED|IN_PROGRESS|FAILED|COMPLETED', 'Type' => 'CONVERSATION|DICTATION', ], // ... ], 'NextToken' => '<string>', 'Status' => 'QUEUED|IN_PROGRESS|FAILED|COMPLETED', ]
Result Details
Members
- MedicalTranscriptionJobSummaries
-
- Type: Array of MedicalTranscriptionJobSummary structures
A list of objects containing summary information for a transcription job.
- NextToken
-
- Type: string
The
ListMedicalTranscriptionJobs
operation returns a page of jobs at a time. The maximum size of the page is set by theMaxResults
parameter. If the number of jobs exceeds what can fit on a page, Amazon Transcribe Medical returns theNextPage
token. Include the token in the next request to theListMedicalTranscriptionJobs
operation to return in the next page of jobs. - Status
-
- Type: string
The requested status of the medical transcription jobs returned.
Errors
-
Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception
Message
field for more information. -
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
-
There was an internal error. Check the error message and try your request again.
ListMedicalVocabularies
$result = $client->listMedicalVocabularies
([/* ... */]); $promise = $client->listMedicalVocabulariesAsync
([/* ... */]);
Returns a list of vocabularies that match the specified criteria. If you don't enter a value in any of the request parameters, returns the entire list of vocabularies.
Parameter Syntax
$result = $client->listMedicalVocabularies([ 'MaxResults' => <integer>, 'NameContains' => '<string>', 'NextToken' => '<string>', 'StateEquals' => 'PENDING|READY|FAILED', ]);
Parameter Details
Members
- MaxResults
-
- Type: int
The maximum number of vocabularies to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.
- NameContains
-
- Type: string
Returns vocabularies whose names contain the specified string. The search is not case sensitive.
ListMedicalVocabularies
returns both "vocabularyname
" and "VocabularyName
". - NextToken
-
- Type: string
If the result of your previous request to
ListMedicalVocabularies
was truncated, include theNextToken
to fetch the next set of vocabularies. - StateEquals
-
- Type: string
When specified, returns only vocabularies with the
VocabularyState
equal to the specified vocabulary state. Use this field to see which vocabularies are ready for your medical transcription jobs.
Result Syntax
[ 'NextToken' => '<string>', 'Status' => 'PENDING|READY|FAILED', 'Vocabularies' => [ [ 'LanguageCode' => 'af-ZA|ar-AE|ar-SA|cy-GB|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|ga-IE|gd-GB|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ', 'LastModifiedTime' => <DateTime>, 'VocabularyName' => '<string>', 'VocabularyState' => 'PENDING|READY|FAILED', ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: string
The
ListMedicalVocabularies
operation returns a page of vocabularies at a time. You set the maximum number of vocabularies to return on a page with theMaxResults
parameter. If there are more jobs in the list will fit on a page, Amazon Transcribe Medical returns theNextPage
token. To return the next page of vocabularies, include the token in the next request to theListMedicalVocabularies
operation. - Status
-
- Type: string
The requested vocabulary state.
- Vocabularies
-
- Type: Array of VocabularyInfo structures
A list of objects that describe the vocabularies that match your search criteria.
Errors
-
Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception
Message
field for more information. -
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
-
There was an internal error. Check the error message and try your request again.
ListTagsForResource
$result = $client->listTagsForResource
([/* ... */]); $promise = $client->listTagsForResourceAsync
([/* ... */]);
Lists all tags associated with a given transcription job, vocabulary, or resource.
Parameter Syntax
$result = $client->listTagsForResource([ 'ResourceArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ResourceArn
-
- Required: Yes
- Type: string
Lists all tags associated with a given Amazon Resource Name (ARN). ARNs have the format
arn:partition:service:region:account-id:resource-type/resource-id
(for example,arn:aws:transcribe:us-east-1:account-id:transcription-job/your-job-name
). Valid values forresource-type
are:transcription-job
,medical-transcription-job
,vocabulary
,medical-vocabulary
,vocabulary-filter
, andlanguage-model
.
Result Syntax
[ 'ResourceArn' => '<string>', 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ]
Result Details
Members
- ResourceArn
-
- Type: string
Lists all tags associated with the given Amazon Resource Name (ARN).
- Tags
-
- Type: Array of Tag structures
Lists all tags associated with the given transcription job, vocabulary, or resource.
Errors
-
Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception
Message
field for more information. -
We can't find the requested resource. Check the name and try your request again.
-
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
-
There was an internal error. Check the error message and try your request again.
ListTranscriptionJobs
$result = $client->listTranscriptionJobs
([/* ... */]); $promise = $client->listTranscriptionJobsAsync
([/* ... */]);
Lists transcription jobs with the specified status.
Parameter Syntax
$result = $client->listTranscriptionJobs([ 'JobNameContains' => '<string>', 'MaxResults' => <integer>, 'NextToken' => '<string>', 'Status' => 'QUEUED|IN_PROGRESS|FAILED|COMPLETED', ]);
Parameter Details
Members
- JobNameContains
-
- Type: string
When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.
- MaxResults
-
- Type: int
The maximum number of jobs to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.
- NextToken
-
- Type: string
If the result of the previous request to
ListTranscriptionJobs
is truncated, include theNextToken
to fetch the next set of jobs. - Status
-
- Type: string
When specified, returns only transcription jobs with the specified status. Jobs are ordered by creation date, with the newest jobs returned first. If you don’t specify a status, Amazon Transcribe returns all transcription jobs ordered by creation date.
Result Syntax
[ 'NextToken' => '<string>', 'Status' => 'QUEUED|IN_PROGRESS|FAILED|COMPLETED', 'TranscriptionJobSummaries' => [ [ 'CompletionTime' => <DateTime>, 'ContentRedaction' => [ 'PiiEntityTypes' => ['<string>', ...], 'RedactionOutput' => 'redacted|redacted_and_unredacted', 'RedactionType' => 'PII', ], 'CreationTime' => <DateTime>, 'FailureReason' => '<string>', 'IdentifiedLanguageScore' => <float>, 'IdentifyLanguage' => true || false, 'LanguageCode' => 'af-ZA|ar-AE|ar-SA|cy-GB|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|ga-IE|gd-GB|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ', 'ModelSettings' => [ 'LanguageModelName' => '<string>', ], 'OutputLocationType' => 'CUSTOMER_BUCKET|SERVICE_BUCKET', 'StartTime' => <DateTime>, 'TranscriptionJobName' => '<string>', 'TranscriptionJobStatus' => 'QUEUED|IN_PROGRESS|FAILED|COMPLETED', ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: string
The
ListTranscriptionJobs
operation returns a page of jobs at a time. The maximum size of the page is set by theMaxResults
parameter. If there are more jobs in the list than the page size, Amazon Transcribe returns theNextPage
token. Include the token in the next request to theListTranscriptionJobs
operation to return in the next page of jobs. - Status
-
- Type: string
The requested status of the jobs returned.
- TranscriptionJobSummaries
-
- Type: Array of TranscriptionJobSummary structures
A list of objects containing summary information for a transcription job.
Errors
-
Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception
Message
field for more information. -
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
-
There was an internal error. Check the error message and try your request again.
ListVocabularies
$result = $client->listVocabularies
([/* ... */]); $promise = $client->listVocabulariesAsync
([/* ... */]);
Returns a list of vocabularies that match the specified criteria. If no criteria are specified, returns the entire list of vocabularies.
Parameter Syntax
$result = $client->listVocabularies([ 'MaxResults' => <integer>, 'NameContains' => '<string>', 'NextToken' => '<string>', 'StateEquals' => 'PENDING|READY|FAILED', ]);
Parameter Details
Members
- MaxResults
-
- Type: int
The maximum number of vocabularies to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.
- NameContains
-
- Type: string
When specified, the vocabularies returned in the list are limited to vocabularies whose name contains the specified string. The search is not case sensitive,
ListVocabularies
returns both "vocabularyname" and "VocabularyName" in the response list. - NextToken
-
- Type: string
If the result of the previous request to
ListVocabularies
was truncated, include theNextToken
to fetch the next set of jobs. - StateEquals
-
- Type: string
When specified, only returns vocabularies with the
VocabularyState
field equal to the specified state.
Result Syntax
[ 'NextToken' => '<string>', 'Status' => 'PENDING|READY|FAILED', 'Vocabularies' => [ [ 'LanguageCode' => 'af-ZA|ar-AE|ar-SA|cy-GB|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|ga-IE|gd-GB|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ', 'LastModifiedTime' => <DateTime>, 'VocabularyName' => '<string>', 'VocabularyState' => 'PENDING|READY|FAILED', ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: string
The
ListVocabularies
operation returns a page of vocabularies at a time. The maximum size of the page is set in theMaxResults
parameter. If there are more jobs in the list than will fit on the page, Amazon Transcribe returns theNextPage
token. To return in the next page of jobs, include the token in the next request to theListVocabularies
operation. - Status
-
- Type: string
The requested vocabulary state.
- Vocabularies
-
- Type: Array of VocabularyInfo structures
A list of objects that describe the vocabularies that match the search criteria in the request.
Errors
-
Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception
Message
field for more information. -
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
-
There was an internal error. Check the error message and try your request again.
ListVocabularyFilters
$result = $client->listVocabularyFilters
([/* ... */]); $promise = $client->listVocabularyFiltersAsync
([/* ... */]);
Gets information about vocabulary filters.
Parameter Syntax
$result = $client->listVocabularyFilters([ 'MaxResults' => <integer>, 'NameContains' => '<string>', 'NextToken' => '<string>', ]);
Parameter Details
Members
- MaxResults
-
- Type: int
The maximum number of filters to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.
- NameContains
-
- Type: string
Filters the response so that it only contains vocabulary filters whose name contains the specified string.
- NextToken
-
- Type: string
If the result of the previous request to
ListVocabularyFilters
was truncated, include theNextToken
to fetch the next set of collections.
Result Syntax
[ 'NextToken' => '<string>', 'VocabularyFilters' => [ [ 'LanguageCode' => 'af-ZA|ar-AE|ar-SA|cy-GB|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|ga-IE|gd-GB|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ', 'LastModifiedTime' => <DateTime>, 'VocabularyFilterName' => '<string>', ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: string
The
ListVocabularyFilters
operation returns a page of collections at a time. The maximum size of the page is set by theMaxResults
parameter. If there are more jobs in the list than the page size, Amazon Transcribe returns theNextPage
token. Include the token in the next request to theListVocabularyFilters
operation to return in the next page of jobs. - VocabularyFilters
-
- Type: Array of VocabularyFilterInfo structures
The list of vocabulary filters. It contains at most
MaxResults
number of filters. If there are more filters, call theListVocabularyFilters
operation again with theNextToken
parameter in the request set to the value of theNextToken
field in the response.
Errors
-
Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception
Message
field for more information. -
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
-
There was an internal error. Check the error message and try your request again.
StartCallAnalyticsJob
$result = $client->startCallAnalyticsJob
([/* ... */]); $promise = $client->startCallAnalyticsJobAsync
([/* ... */]);
Starts an asynchronous analytics job that not only transcribes the audio recording of a caller and agent, but also returns additional insights. These insights include how quickly or loudly the caller or agent was speaking. To retrieve additional insights with your analytics jobs, create categories. A category is a way to classify analytics jobs based on attributes, such as a customer's sentiment or a particular phrase being used during the call. For more information, see the operation.
Parameter Syntax
$result = $client->startCallAnalyticsJob([ 'CallAnalyticsJobName' => '<string>', // REQUIRED 'ChannelDefinitions' => [ [ 'ChannelId' => <integer>, 'ParticipantRole' => 'AGENT|CUSTOMER', ], // ... ], 'DataAccessRoleArn' => '<string>', // REQUIRED 'Media' => [ // REQUIRED 'MediaFileUri' => '<string>', 'RedactedMediaFileUri' => '<string>', ], 'OutputEncryptionKMSKeyId' => '<string>', 'OutputLocation' => '<string>', 'Settings' => [ 'ContentRedaction' => [ 'PiiEntityTypes' => ['<string>', ...], 'RedactionOutput' => 'redacted|redacted_and_unredacted', // REQUIRED 'RedactionType' => 'PII', // REQUIRED ], 'LanguageIdSettings' => [ '<LanguageCode>' => [ 'LanguageModelName' => '<string>', 'VocabularyFilterName' => '<string>', 'VocabularyName' => '<string>', ], // ... ], 'LanguageModelName' => '<string>', 'LanguageOptions' => ['<string>', ...], 'VocabularyFilterMethod' => 'remove|mask|tag', 'VocabularyFilterName' => '<string>', 'VocabularyName' => '<string>', ], ]);
Parameter Details
Members
- CallAnalyticsJobName
-
- Required: Yes
- Type: string
The name of the call analytics job. You can't use the string "." or ".." by themselves as the job name. The name must also be unique within an Amazon Web Services account. If you try to create a call analytics job with the same name as a previous call analytics job, you get a
ConflictException
error. - ChannelDefinitions
-
- Type: Array of ChannelDefinition structures
When you start a call analytics job, you must pass an array that maps the agent and the customer to specific audio channels. The values you can assign to a channel are 0 and 1. The agent and the customer must each have their own channel. You can't assign more than one channel to an agent or customer.
- DataAccessRoleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that contains your input files. Amazon Transcribe assumes this role to read queued audio files. If you have specified an output S3 bucket for your transcription results, this role should have access to the output bucket as well.
- Media
-
- Required: Yes
- Type: Media structure
Describes the input media file in a transcription request.
- OutputEncryptionKMSKeyId
-
- Type: string
The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service key used to encrypt the output of the call analytics job. The user calling the operation must have permission to use the specified KMS key.
You use either of the following to identify an Amazon Web Services KMS key in the current account:
-
KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
-
KMS Key Alias: "alias/ExampleAlias"
You can use either of the following to identify a KMS key in the current account or another account:
-
Amazon Resource Name (ARN) of a KMS key in the current account or another account: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef1234567890ab"
-
ARN of a KMS Key Alias: "arn:aws:kms:region:accountID:alias/ExampleAlias"
If you don't specify an encryption key, the output of the call analytics job is encrypted with the default Amazon S3 key (SSE-S3).
If you specify a KMS key to encrypt your output, you must also specify an output location in the
OutputLocation
parameter. - OutputLocation
-
- Type: string
The Amazon S3 location where the output of the call analytics job is stored. You can provide the following location types to store the output of call analytics job:
-
s3://DOC-EXAMPLE-BUCKET1
If you specify a bucket, Amazon Transcribe saves the output of the analytics job as a JSON file at the root level of the bucket.
-
s3://DOC-EXAMPLE-BUCKET1/folder/
f you specify a path, Amazon Transcribe saves the output of the analytics job as s3://DOC-EXAMPLE-BUCKET1/folder/your-transcription-job-name.json.
If you specify a folder, you must provide a trailing slash.
-
s3://DOC-EXAMPLE-BUCKET1/folder/filename.json.
If you provide a path that has the filename specified, Amazon Transcribe saves the output of the analytics job as s3://DOC-EXAMPLEBUCKET1/folder/filename.json.
You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the output of our analytics job using the
OutputEncryptionKMSKeyId
parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of the analytics job output that is placed in your S3 bucket. - Settings
-
- Type: CallAnalyticsJobSettings structure
A
Settings
object that provides optional settings for a call analytics job.
Result Syntax
[ 'CallAnalyticsJob' => [ 'CallAnalyticsJobName' => '<string>', 'CallAnalyticsJobStatus' => 'QUEUED|IN_PROGRESS|FAILED|COMPLETED', 'ChannelDefinitions' => [ [ 'ChannelId' => <integer>, 'ParticipantRole' => 'AGENT|CUSTOMER', ], // ... ], 'CompletionTime' => <DateTime>, 'CreationTime' => <DateTime>, 'DataAccessRoleArn' => '<string>', 'FailureReason' => '<string>', 'IdentifiedLanguageScore' => <float>, 'LanguageCode' => 'af-ZA|ar-AE|ar-SA|cy-GB|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|ga-IE|gd-GB|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ', 'Media' => [ 'MediaFileUri' => '<string>', 'RedactedMediaFileUri' => '<string>', ], 'MediaFormat' => 'mp3|mp4|wav|flac|ogg|amr|webm', 'MediaSampleRateHertz' => <integer>, 'Settings' => [ 'ContentRedaction' => [ 'PiiEntityTypes' => ['<string>', ...], 'RedactionOutput' => 'redacted|redacted_and_unredacted', 'RedactionType' => 'PII', ], 'LanguageIdSettings' => [ '<LanguageCode>' => [ 'LanguageModelName' => '<string>', 'VocabularyFilterName' => '<string>', 'VocabularyName' => '<string>', ], // ... ], 'LanguageModelName' => '<string>', 'LanguageOptions' => ['<string>', ...], 'VocabularyFilterMethod' => 'remove|mask|tag', 'VocabularyFilterName' => '<string>', 'VocabularyName' => '<string>', ], 'StartTime' => <DateTime>, 'Transcript' => [ 'RedactedTranscriptFileUri' => '<string>', 'TranscriptFileUri' => '<string>', ], ], ]
Result Details
Members
- CallAnalyticsJob
-
- Type: CallAnalyticsJob structure
An object containing the details of the asynchronous call analytics job.
Errors
-
Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception
Message
field for more information. -
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
-
There was an internal error. Check the error message and try your request again.
-
There is already a resource with that name.
StartMedicalTranscriptionJob
$result = $client->startMedicalTranscriptionJob
([/* ... */]); $promise = $client->startMedicalTranscriptionJobAsync
([/* ... */]);
Starts a batch job to transcribe medical speech to text.
Parameter Syntax
$result = $client->startMedicalTranscriptionJob([ 'ContentIdentificationType' => 'PHI', 'KMSEncryptionContext' => ['<string>', ...], 'LanguageCode' => 'af-ZA|ar-AE|ar-SA|cy-GB|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|ga-IE|gd-GB|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ', // REQUIRED 'Media' => [ // REQUIRED 'MediaFileUri' => '<string>', 'RedactedMediaFileUri' => '<string>', ], 'MediaFormat' => 'mp3|mp4|wav|flac|ogg|amr|webm', 'MediaSampleRateHertz' => <integer>, 'MedicalTranscriptionJobName' => '<string>', // REQUIRED 'OutputBucketName' => '<string>', // REQUIRED 'OutputEncryptionKMSKeyId' => '<string>', 'OutputKey' => '<string>', 'Settings' => [ 'ChannelIdentification' => true || false, 'MaxAlternatives' => <integer>, 'MaxSpeakerLabels' => <integer>, 'ShowAlternatives' => true || false, 'ShowSpeakerLabels' => true || false, 'VocabularyName' => '<string>', ], 'Specialty' => 'PRIMARYCARE', // REQUIRED 'Tags' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], 'Type' => 'CONVERSATION|DICTATION', // REQUIRED ]);
Parameter Details
Members
- ContentIdentificationType
-
- Type: string
You can configure Amazon Transcribe Medical to label content in the transcription output. If you specify
PHI
, Amazon Transcribe Medical labels the personal health information (PHI) that it identifies in the transcription output. - KMSEncryptionContext
-
- Type: Associative array of custom strings keys (NonEmptyString) to strings
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.
- LanguageCode
-
- Required: Yes
- Type: string
The language code for the language spoken in the input media file. US English (en-US) is the valid value for medical transcription jobs. Any other value you enter for language code results in a
BadRequestException
error. - Media
-
- Required: Yes
- Type: Media structure
Describes the input media file in a transcription request.
- MediaFormat
-
- Type: string
The audio format of the input media file.
- MediaSampleRateHertz
-
- Type: int
The sample rate, in Hertz, of the audio track in the input media file.
If you do not specify the media sample rate, Amazon Transcribe Medical determines the sample rate. If you specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you should leave the
MediaSampleRateHertz
field blank and let Amazon Transcribe Medical determine the sample rate. - MedicalTranscriptionJobName
-
- Required: Yes
- Type: string
The name of the medical transcription job. You can't use the strings "
.
" or "..
" by themselves as the job name. The name must also be unique within an Amazon Web Services account. If you try to create a medical transcription job with the same name as a previous medical transcription job, you get aConflictException
error. - OutputBucketName
-
- Required: Yes
- Type: string
The Amazon S3 location where the transcription is stored.
You must set
OutputBucketName
for Amazon Transcribe Medical to store the transcription results. Your transcript appears in the S3 location you specify. When you call the GetMedicalTranscriptionJob, the operation returns this location in theTranscriptFileUri
field. The S3 bucket must have permissions that allow Amazon Transcribe Medical to put files in the bucket. For more information, see Permissions Required for IAM User Roles.You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the output of your transcription using the
OutputEncryptionKMSKeyId
parameter. If you don't specify a KMS key, Amazon Transcribe Medical uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket. - OutputEncryptionKMSKeyId
-
- Type: string
The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the StartMedicalTranscriptionJob operation must have permission to use the specified KMS key.
You use either of the following to identify a KMS key in the current account:
-
KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
-
KMS Key Alias: "alias/ExampleAlias"
You can use either of the following to identify a KMS key in the current account or another account:
-
Amazon Resource Name (ARN) of a KMS key in the current account or another account: "arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"
-
ARN of a KMS Key Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"
If you don't specify an encryption key, the output of the medical transcription job is encrypted with the default Amazon S3 key (SSE-S3).
If you specify a KMS key to encrypt your output, you must also specify an output location in the
OutputBucketName
parameter. - OutputKey
-
- Type: string
You can specify a location in an Amazon S3 bucket to store the output of your medical transcription job.
If you don't specify an output key, Amazon Transcribe Medical stores the output of your transcription job in the Amazon S3 bucket you specified. By default, the object key is "your-transcription-job-name.json".
You can use output keys to specify the Amazon S3 prefix and file name of the transcription output. For example, specifying the Amazon S3 prefix, "folder1/folder2/", as an output key would lead to the output being stored as "folder1/folder2/your-transcription-job-name.json". If you specify "my-other-job-name.json" as the output key, the object key is changed to "my-other-job-name.json". You can use an output key to change both the prefix and the file name, for example "folder/my-other-job-name.json".
If you specify an output key, you must also specify an S3 bucket in the
OutputBucketName
parameter. - Settings
-
- Type: MedicalTranscriptionSetting structure
Optional settings for the medical transcription job.
- Specialty
-
- Required: Yes
- Type: string
The medical specialty of any clinician speaking in the input media.
- Tags
-
- Type: Array of Tag structures
Add tags to an Amazon Transcribe Medical transcription job.
- Type
-
- Required: Yes
- Type: string
The type of speech in the input audio.
CONVERSATION
refers to conversations between two or more speakers, e.g., a conversations between doctors and patients.DICTATION
refers to single-speaker dictated speech, such as clinical notes.
Result Syntax
[ 'MedicalTranscriptionJob' => [ 'CompletionTime' => <DateTime>, 'ContentIdentificationType' => 'PHI', 'CreationTime' => <DateTime>, 'FailureReason' => '<string>', 'LanguageCode' => 'af-ZA|ar-AE|ar-SA|cy-GB|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|ga-IE|gd-GB|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ', 'Media' => [ 'MediaFileUri' => '<string>', 'RedactedMediaFileUri' => '<string>', ], 'MediaFormat' => 'mp3|mp4|wav|flac|ogg|amr|webm', 'MediaSampleRateHertz' => <integer>, 'MedicalTranscriptionJobName' => '<string>', 'Settings' => [ 'ChannelIdentification' => true || false, 'MaxAlternatives' => <integer>, 'MaxSpeakerLabels' => <integer>, 'ShowAlternatives' => true || false, 'ShowSpeakerLabels' => true || false, 'VocabularyName' => '<string>', ], 'Specialty' => 'PRIMARYCARE', 'StartTime' => <DateTime>, 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'Transcript' => [ 'TranscriptFileUri' => '<string>', ], 'TranscriptionJobStatus' => 'QUEUED|IN_PROGRESS|FAILED|COMPLETED', 'Type' => 'CONVERSATION|DICTATION', ], ]
Result Details
Members
- MedicalTranscriptionJob
-
- Type: MedicalTranscriptionJob structure
A batch job submitted to transcribe medical speech to text.
Errors
-
Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception
Message
field for more information. -
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
-
There was an internal error. Check the error message and try your request again.
-
There is already a resource with that name.
StartTranscriptionJob
$result = $client->startTranscriptionJob
([/* ... */]); $promise = $client->startTranscriptionJobAsync
([/* ... */]);
Starts an asynchronous job to transcribe speech to text.
Parameter Syntax
$result = $client->startTranscriptionJob([ 'ContentRedaction' => [ 'PiiEntityTypes' => ['<string>', ...], 'RedactionOutput' => 'redacted|redacted_and_unredacted', // REQUIRED 'RedactionType' => 'PII', // REQUIRED ], 'IdentifyLanguage' => true || false, 'JobExecutionSettings' => [ 'AllowDeferredExecution' => true || false, 'DataAccessRoleArn' => '<string>', ], 'KMSEncryptionContext' => ['<string>', ...], 'LanguageCode' => 'af-ZA|ar-AE|ar-SA|cy-GB|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|ga-IE|gd-GB|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ', 'LanguageIdSettings' => [ '<LanguageCode>' => [ 'LanguageModelName' => '<string>', 'VocabularyFilterName' => '<string>', 'VocabularyName' => '<string>', ], // ... ], 'LanguageOptions' => ['<string>', ...], 'Media' => [ // REQUIRED 'MediaFileUri' => '<string>', 'RedactedMediaFileUri' => '<string>', ], 'MediaFormat' => 'mp3|mp4|wav|flac|ogg|amr|webm', 'MediaSampleRateHertz' => <integer>, 'ModelSettings' => [ 'LanguageModelName' => '<string>', ], 'OutputBucketName' => '<string>', 'OutputEncryptionKMSKeyId' => '<string>', 'OutputKey' => '<string>', 'Settings' => [ 'ChannelIdentification' => true || false, 'MaxAlternatives' => <integer>, 'MaxSpeakerLabels' => <integer>, 'ShowAlternatives' => true || false, 'ShowSpeakerLabels' => true || false, 'VocabularyFilterMethod' => 'remove|mask|tag', 'VocabularyFilterName' => '<string>', 'VocabularyName' => '<string>', ], 'Subtitles' => [ 'Formats' => ['<string>', ...], 'OutputStartIndex' => <integer>, ], 'Tags' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], 'TranscriptionJobName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ContentRedaction
-
- Type: ContentRedaction structure
An object that contains the request parameters for content redaction.
- IdentifyLanguage
-
- Type: boolean
Set this field to
true
to enable automatic language identification. Automatic language identification is disabled by default. You receive aBadRequestException
error if you enter a value for aLanguageCode
.You must include either
LanguageCode
orIdentifyLanguage
in your request. - JobExecutionSettings
-
- Type: JobExecutionSettings structure
Provides information about how a transcription job is executed. Use this field to indicate that the job can be queued for deferred execution if the concurrency limit is reached and there are no slots available to immediately run the job.
- KMSEncryptionContext
-
- Type: Associative array of custom strings keys (NonEmptyString) to strings
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.
- LanguageCode
-
- Type: string
The language code for the language used in the input media file. You must include either
LanguageCode
orIdentifyLanguage
in your request.To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a sample rate of 16,000 Hz or higher.
- LanguageIdSettings
-
- Type: Associative array of custom strings keys (LanguageCode) to LanguageIdSettings structures
The language identification settings associated with your transcription job. These settings include
VocabularyName
,VocabularyFilterName
, andLanguageModelName
. - LanguageOptions
-
- Type: Array of strings
An object containing a list of languages that might be present in your collection of audio files. Automatic language identification chooses a language that best matches the source audio from that list.
To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a sample rate of 16,000 Hz or higher.
- Media
-
- Required: Yes
- Type: Media structure
An object that describes the input media for a transcription job.
- MediaFormat
-
- Type: string
The format of the input media file.
- MediaSampleRateHertz
-
- Type: int
The sample rate, in Hertz, of the audio track in the input media file.
If you do not specify the media sample rate, Amazon Transcribe determines the sample rate. If you specify the sample rate, it must match the sample rate detected by Amazon Transcribe. In most cases, you should leave the
MediaSampleRateHertz
field blank and let Amazon Transcribe determine the sample rate. - ModelSettings
-
- Type: ModelSettings structure
Choose the custom language model you use for your transcription job in this parameter.
- OutputBucketName
-
- Type: string
The location where the transcription is stored.
If you set the
OutputBucketName
, Amazon Transcribe puts the transcript in the specified S3 bucket. When you call the GetTranscriptionJob operation, the operation returns this location in theTranscriptFileUri
field. If you enable content redaction, the redacted transcript appears inRedactedTranscriptFileUri
. If you enable content redaction and choose to output an unredacted transcript, that transcript's location still appears in theTranscriptFileUri
. The S3 bucket must have permissions that allow Amazon Transcribe to put files in the bucket. For more information, see Permissions Required for IAM User Roles.You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the output of your transcription using the
OutputEncryptionKMSKeyId
parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.If you don't set the
OutputBucketName
, Amazon Transcribe generates a pre-signed URL, a shareable URL that provides secure access to your transcription, and returns it in theTranscriptFileUri
field. Use this URL to download the transcription. - OutputEncryptionKMSKeyId
-
- Type: string
The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the
StartTranscriptionJob
operation must have permission to use the specified KMS key.You can use either of the following to identify a KMS key in the current account:
-
KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
-
KMS Key Alias: "alias/ExampleAlias"
You can use either of the following to identify a KMS key in the current account or another account:
-
Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"
-
ARN of a KMS Key Alias: "arn:aws:kms:region:account-ID:alias/ExampleAlias"
If you don't specify an encryption key, the output of the transcription job is encrypted with the default Amazon S3 key (SSE-S3).
If you specify a KMS key to encrypt your output, you must also specify an output location in the
OutputBucketName
parameter. - OutputKey
-
- Type: string
You can specify a location in an Amazon S3 bucket to store the output of your transcription job.
If you don't specify an output key, Amazon Transcribe stores the output of your transcription job in the Amazon S3 bucket you specified. By default, the object key is "your-transcription-job-name.json".
You can use output keys to specify the Amazon S3 prefix and file name of the transcription output. For example, specifying the Amazon S3 prefix, "folder1/folder2/", as an output key would lead to the output being stored as "folder1/folder2/your-transcription-job-name.json". If you specify "my-other-job-name.json" as the output key, the object key is changed to "my-other-job-name.json". You can use an output key to change both the prefix and the file name, for example "folder/my-other-job-name.json".
If you specify an output key, you must also specify an S3 bucket in the
OutputBucketName
parameter. - Settings
-
- Type: Settings structure
A
Settings
object that provides optional settings for a transcription job. - Subtitles
-
- Type: Subtitles structure
Add subtitles to your batch transcription job.
- Tags
-
- Type: Array of Tag structures
Add tags to an Amazon Transcribe transcription job.
- TranscriptionJobName
-
- Required: Yes
- Type: string
The name of the job. You can't use the strings "
.
" or "..
" by themselves as the job name. The name must also be unique within an Amazon Web Services account. If you try to create a transcription job with the same name as a previous transcription job, you get aConflictException
error.
Result Syntax
[ 'TranscriptionJob' => [ 'CompletionTime' => <DateTime>, 'ContentRedaction' => [ 'PiiEntityTypes' => ['<string>', ...], 'RedactionOutput' => 'redacted|redacted_and_unredacted', 'RedactionType' => 'PII', ], 'CreationTime' => <DateTime>, 'FailureReason' => '<string>', 'IdentifiedLanguageScore' => <float>, 'IdentifyLanguage' => true || false, 'JobExecutionSettings' => [ 'AllowDeferredExecution' => true || false, 'DataAccessRoleArn' => '<string>', ], 'LanguageCode' => 'af-ZA|ar-AE|ar-SA|cy-GB|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|ga-IE|gd-GB|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ', 'LanguageIdSettings' => [ '<LanguageCode>' => [ 'LanguageModelName' => '<string>', 'VocabularyFilterName' => '<string>', 'VocabularyName' => '<string>', ], // ... ], 'LanguageOptions' => ['<string>', ...], 'Media' => [ 'MediaFileUri' => '<string>', 'RedactedMediaFileUri' => '<string>', ], 'MediaFormat' => 'mp3|mp4|wav|flac|ogg|amr|webm', 'MediaSampleRateHertz' => <integer>, 'ModelSettings' => [ 'LanguageModelName' => '<string>', ], 'Settings' => [ 'ChannelIdentification' => true || false, 'MaxAlternatives' => <integer>, 'MaxSpeakerLabels' => <integer>, 'ShowAlternatives' => true || false, 'ShowSpeakerLabels' => true || false, 'VocabularyFilterMethod' => 'remove|mask|tag', 'VocabularyFilterName' => '<string>', 'VocabularyName' => '<string>', ], 'StartTime' => <DateTime>, 'Subtitles' => [ 'Formats' => ['<string>', ...], 'OutputStartIndex' => <integer>, 'SubtitleFileUris' => ['<string>', ...], ], 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'Transcript' => [ 'RedactedTranscriptFileUri' => '<string>', 'TranscriptFileUri' => '<string>', ], 'TranscriptionJobName' => '<string>', 'TranscriptionJobStatus' => 'QUEUED|IN_PROGRESS|FAILED|COMPLETED', ], ]
Result Details
Members
- TranscriptionJob
-
- Type: TranscriptionJob structure
Provides information about your asynchronous transcription job.
Errors
-
Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception
Message
field for more information. -
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
-
There was an internal error. Check the error message and try your request again.
-
There is already a resource with that name.
TagResource
$result = $client->tagResource
([/* ... */]); $promise = $client->tagResourceAsync
([/* ... */]);
Tags an Amazon Transcribe resource with the given list of tags.
Parameter Syntax
$result = $client->tagResource([ 'ResourceArn' => '<string>', // REQUIRED 'Tags' => [ // REQUIRED [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- ResourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the Amazon Transcribe 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-east-1:account-id:transcription-job/your-job-name
). Valid values forresource-type
are:transcription-job
,medical-transcription-job
,vocabulary
,medical-vocabulary
,vocabulary-filter
, andlanguage-model
. - Tags
-
- Required: Yes
- Type: Array of Tag structures
The tags you are assigning to a given Amazon Transcribe resource.
Result Syntax
[]
Result Details
Errors
-
Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception
Message
field for more information. -
There is already a resource with that name.
-
We can't find the requested resource. Check the name and try your request again.
-
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
-
There was an internal error. Check the error message and try your request again.
UntagResource
$result = $client->untagResource
([/* ... */]); $promise = $client->untagResourceAsync
([/* ... */]);
Removes specified tags from a specified Amazon Transcribe resource.
Parameter Syntax
$result = $client->untagResource([ 'ResourceArn' => '<string>', // REQUIRED 'TagKeys' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- ResourceArn
-
- Required: Yes
- Type: string
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-east-1:account-id:transcription-job/your-job-name
). Valid values forresource-type
are:transcription-job
,medical-transcription-job
,vocabulary
,medical-vocabulary
,vocabulary-filter
, andlanguage-model
. - TagKeys
-
- Required: Yes
- Type: Array of strings
A list of tag keys you want to remove from a specified Amazon Transcribe resource.
Result Syntax
[]
Result Details
Errors
-
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
-
Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception
Message
field for more information. -
There is already a resource with that name.
-
We can't find the requested resource. Check the name and try your request again.
-
There was an internal error. Check the error message and try your request again.
UpdateCallAnalyticsCategory
$result = $client->updateCallAnalyticsCategory
([/* ... */]); $promise = $client->updateCallAnalyticsCategoryAsync
([/* ... */]);
Updates the call analytics category with new values. The UpdateCallAnalyticsCategory
operation overwrites all of the existing information with the values that you provide in the request.
Parameter Syntax
$result = $client->updateCallAnalyticsCategory([ 'CategoryName' => '<string>', // REQUIRED 'Rules' => [ // REQUIRED [ 'InterruptionFilter' => [ 'AbsoluteTimeRange' => [ 'EndTime' => <integer>, 'First' => <integer>, 'Last' => <integer>, 'StartTime' => <integer>, ], 'Negate' => true || false, 'ParticipantRole' => 'AGENT|CUSTOMER', 'RelativeTimeRange' => [ 'EndPercentage' => <integer>, 'First' => <integer>, 'Last' => <integer>, 'StartPercentage' => <integer>, ], 'Threshold' => <integer>, ], 'NonTalkTimeFilter' => [ 'AbsoluteTimeRange' => [ 'EndTime' => <integer>, 'First' => <integer>, 'Last' => <integer>, 'StartTime' => <integer>, ], 'Negate' => true || false, 'RelativeTimeRange' => [ 'EndPercentage' => <integer>, 'First' => <integer>, 'Last' => <integer>, 'StartPercentage' => <integer>, ], 'Threshold' => <integer>, ], 'SentimentFilter' => [ 'AbsoluteTimeRange' => [ 'EndTime' => <integer>, 'First' => <integer>, 'Last' => <integer>, 'StartTime' => <integer>, ], 'Negate' => true || false, 'ParticipantRole' => 'AGENT|CUSTOMER', 'RelativeTimeRange' => [ 'EndPercentage' => <integer>, 'First' => <integer>, 'Last' => <integer>, 'StartPercentage' => <integer>, ], 'Sentiments' => ['<string>', ...], // REQUIRED ], 'TranscriptFilter' => [ 'AbsoluteTimeRange' => [ 'EndTime' => <integer>, 'First' => <integer>, 'Last' => <integer>, 'StartTime' => <integer>, ], 'Negate' => true || false, 'ParticipantRole' => 'AGENT|CUSTOMER', 'RelativeTimeRange' => [ 'EndPercentage' => <integer>, 'First' => <integer>, 'Last' => <integer>, 'StartPercentage' => <integer>, ], 'Targets' => ['<string>', ...], // REQUIRED 'TranscriptFilterType' => 'EXACT', // REQUIRED ], ], // ... ], ]);
Parameter Details
Members
- CategoryName
-
- Required: Yes
- Type: string
The name of the analytics category to update. The name is case sensitive. If you try to update a call analytics category with the same name as a previous category you will receive a
ConflictException
error. - Rules
-
- Required: Yes
- Type: Array of Rule structures
The rules used for the updated analytics category. The rules that you provide in this field replace the ones that are currently being used.
Result Syntax
[ 'CategoryProperties' => [ 'CategoryName' => '<string>', 'CreateTime' => <DateTime>, 'LastUpdateTime' => <DateTime>, 'Rules' => [ [ 'InterruptionFilter' => [ 'AbsoluteTimeRange' => [ 'EndTime' => <integer>, 'First' => <integer>, 'Last' => <integer>, 'StartTime' => <integer>, ], 'Negate' => true || false, 'ParticipantRole' => 'AGENT|CUSTOMER', 'RelativeTimeRange' => [ 'EndPercentage' => <integer>, 'First' => <integer>, 'Last' => <integer>, 'StartPercentage' => <integer>, ], 'Threshold' => <integer>, ], 'NonTalkTimeFilter' => [ 'AbsoluteTimeRange' => [ 'EndTime' => <integer>, 'First' => <integer>, 'Last' => <integer>, 'StartTime' => <integer>, ], 'Negate' => true || false, 'RelativeTimeRange' => [ 'EndPercentage' => <integer>, 'First' => <integer>, 'Last' => <integer>, 'StartPercentage' => <integer>, ], 'Threshold' => <integer>, ], 'SentimentFilter' => [ 'AbsoluteTimeRange' => [ 'EndTime' => <integer>, 'First' => <integer>, 'Last' => <integer>, 'StartTime' => <integer>, ], 'Negate' => true || false, 'ParticipantRole' => 'AGENT|CUSTOMER', 'RelativeTimeRange' => [ 'EndPercentage' => <integer>, 'First' => <integer>, 'Last' => <integer>, 'StartPercentage' => <integer>, ], 'Sentiments' => ['<string>', ...], ], 'TranscriptFilter' => [ 'AbsoluteTimeRange' => [ 'EndTime' => <integer>, 'First' => <integer>, 'Last' => <integer>, 'StartTime' => <integer>, ], 'Negate' => true || false, 'ParticipantRole' => 'AGENT|CUSTOMER', 'RelativeTimeRange' => [ 'EndPercentage' => <integer>, 'First' => <integer>, 'Last' => <integer>, 'StartPercentage' => <integer>, ], 'Targets' => ['<string>', ...], 'TranscriptFilterType' => 'EXACT', ], ], // ... ], ], ]
Result Details
Members
- CategoryProperties
-
- Type: CategoryProperties structure
The attributes describing the analytics category. You can see information such as the rules that you've used to update the category and when the category was originally created.
Errors
-
Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception
Message
field for more information. -
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
-
There was an internal error. Check the error message and try your request again.
-
We can't find the requested resource. Check the name and try your request again.
-
There is already a resource with that name.
UpdateMedicalVocabulary
$result = $client->updateMedicalVocabulary
([/* ... */]); $promise = $client->updateMedicalVocabularyAsync
([/* ... */]);
Updates a vocabulary with new values that you provide in a different text file from the one you used to create the vocabulary. The UpdateMedicalVocabulary
operation overwrites all of the existing information with the values that you provide in the request.
Parameter Syntax
$result = $client->updateMedicalVocabulary([ 'LanguageCode' => 'af-ZA|ar-AE|ar-SA|cy-GB|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|ga-IE|gd-GB|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ', // REQUIRED 'VocabularyFileUri' => '<string>', 'VocabularyName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- LanguageCode
-
- Required: Yes
- Type: string
The language code of the language used for the entries in the updated vocabulary. U.S. English (en-US) is the only valid language code in Amazon Transcribe Medical.
- VocabularyFileUri
-
- Type: string
The location in Amazon S3 of the text file that contains your custom vocabulary. The URI must be in the same Amazon Web Services Region as the resource that you are calling. The following is the format for a URI:
https://s3.aws-region.amazonaws.com/bucket-name/keyprefix/objectkey
For example:
https://s3.us-east-1.amazonaws.com/DOC-EXAMPLE-BUCKET/vocab.txt
For more information about Amazon S3 object names, see Object Keys in the Amazon S3 Developer Guide.
For more information about custom vocabularies in Amazon Transcribe Medical, see Medical Custom Vocabularies.
- VocabularyName
-
- Required: Yes
- Type: string
The name of the vocabulary to update. The name is case sensitive. If you try to update a vocabulary with the same name as a vocabulary you've already made, you get a
ConflictException
error.
Result Syntax
[ 'LanguageCode' => 'af-ZA|ar-AE|ar-SA|cy-GB|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|ga-IE|gd-GB|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ', 'LastModifiedTime' => <DateTime>, 'VocabularyName' => '<string>', 'VocabularyState' => 'PENDING|READY|FAILED', ]
Result Details
Members
- LanguageCode
-
- Type: string
The language code for the language of the text file used to update the custom vocabulary. US English (en-US) is the only language supported in Amazon Transcribe Medical.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the vocabulary was updated.
- VocabularyName
-
- Type: string
The name of the updated vocabulary.
- VocabularyState
-
- Type: string
The processing state of the update to the vocabulary. When the
VocabularyState
field isREADY
, the vocabulary is ready to be used in aStartMedicalTranscriptionJob
request.
Errors
-
Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception
Message
field for more information. -
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
-
There was an internal error. Check the error message and try your request again.
-
We can't find the requested resource. Check the name and try your request again.
-
There is already a resource with that name.
UpdateVocabulary
$result = $client->updateVocabulary
([/* ... */]); $promise = $client->updateVocabularyAsync
([/* ... */]);
Updates an existing vocabulary with new values. The UpdateVocabulary
operation overwrites all of the existing information with the values that you provide in the request.
Parameter Syntax
$result = $client->updateVocabulary([ 'LanguageCode' => 'af-ZA|ar-AE|ar-SA|cy-GB|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|ga-IE|gd-GB|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ', // REQUIRED 'Phrases' => ['<string>', ...], 'VocabularyFileUri' => '<string>', 'VocabularyName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- LanguageCode
-
- Required: Yes
- Type: string
The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see Supported languages.
- Phrases
-
- Type: Array of strings
An array of strings containing the vocabulary entries.
- VocabularyFileUri
-
- Type: string
The S3 location of the text file that contains the definition of the custom vocabulary. The URI must be in the same region as the API endpoint that you are calling. The general form is:
https://s3.aws-region.amazonaws.com/bucket-name/keyprefix/objectkey
For example:
https://s3.us-east-1.amazonaws.com/DOC-EXAMPLE-BUCKET/vocab.txt
For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.
For more information about custom vocabularies, see Custom Vocabularies.
- VocabularyName
-
- Required: Yes
- Type: string
The name of the vocabulary to update. The name is case sensitive. If you try to update a vocabulary with the same name as a previous vocabulary you will receive a
ConflictException
error.
Result Syntax
[ 'LanguageCode' => 'af-ZA|ar-AE|ar-SA|cy-GB|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|ga-IE|gd-GB|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ', 'LastModifiedTime' => <DateTime>, 'VocabularyName' => '<string>', 'VocabularyState' => 'PENDING|READY|FAILED', ]
Result Details
Members
- LanguageCode
-
- Type: string
The language code of the vocabulary entries.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the vocabulary was updated.
- VocabularyName
-
- Type: string
The name of the vocabulary that was updated.
- VocabularyState
-
- Type: string
The processing state of the vocabulary. When the
VocabularyState
field containsREADY
the vocabulary is ready to be used in aStartTranscriptionJob
request.
Errors
-
Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception
Message
field for more information. -
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
-
There was an internal error. Check the error message and try your request again.
-
We can't find the requested resource. Check the name and try your request again.
-
There is already a resource with that name.
UpdateVocabularyFilter
$result = $client->updateVocabularyFilter
([/* ... */]); $promise = $client->updateVocabularyFilterAsync
([/* ... */]);
Updates a vocabulary filter with a new list of filtered words.
Parameter Syntax
$result = $client->updateVocabularyFilter([ 'VocabularyFilterFileUri' => '<string>', 'VocabularyFilterName' => '<string>', // REQUIRED 'Words' => ['<string>', ...], ]);
Parameter Details
Members
- VocabularyFilterFileUri
-
- Type: string
The Amazon S3 location of a text file used as input to create the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies.
The specified file must be less than 50 KB of UTF-8 characters.
If you provide the location of a list of words in the
VocabularyFilterFileUri
parameter, you can't use theWords
parameter. - VocabularyFilterName
-
- Required: Yes
- Type: string
The name of the vocabulary filter to update. If you try to update a vocabulary filter with the same name as another vocabulary filter, you get a
ConflictException
error. - Words
-
- Type: Array of strings
The words to use in the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies.
If you provide a list of words in the
Words
parameter, you can't use theVocabularyFilterFileUri
parameter.
Result Syntax
[ 'LanguageCode' => 'af-ZA|ar-AE|ar-SA|cy-GB|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|ga-IE|gd-GB|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ', 'LastModifiedTime' => <DateTime>, 'VocabularyFilterName' => '<string>', ]
Result Details
Members
- LanguageCode
-
- Type: string
The language code of the words in the vocabulary filter.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the vocabulary filter was updated.
- VocabularyFilterName
-
- Type: string
The name of the updated vocabulary filter.
Errors
-
Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception
Message
field for more information. -
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
-
There was an internal error. Check the error message and try your request again.
-
We can't find the requested resource. Check the name and try your request again.
Shapes
AbsoluteTimeRange
Description
A time range, set in seconds, between two points in the call.
Members
- EndTime
-
- Type: long (int|float)
A value that indicates the end of the time range in milliseconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
-
StartTime - 10000
-
Endtime - 50000
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
- First
-
- Type: long (int|float)
A time range from the beginning of the call to the value that you've specified. For example, if you specify
100000
, the time range is set to the first 100,000 milliseconds of the call. - Last
-
- Type: long (int|float)
A time range from the value that you've specified to the end of the call. For example, if you specify
100000
, the time range is set to the last 100,000 milliseconds of the call. - StartTime
-
- Type: long (int|float)
A value that indicates the beginning of the time range in seconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
-
StartTime - 10000
-
Endtime - 50000
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
BadRequestException
Description
Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message
field for more information.
Members
CallAnalyticsJob
Description
Describes an asynchronous analytics job that was created with the StartAnalyticsJob
operation.
Members
- CallAnalyticsJobName
-
- Type: string
The name of the call analytics job.
- CallAnalyticsJobStatus
-
- Type: string
The status of the analytics job.
- ChannelDefinitions
-
- Type: Array of ChannelDefinition structures
Shows numeric values to indicate the channel assigned to the agent's audio and the channel assigned to the customer's audio.
- CompletionTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp that shows when the analytics job was completed.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp that shows when the analytics job was created.
- DataAccessRoleArn
-
- Type: string
The Amazon Resource Number (ARN) that you use to access the analytics job. ARNs have the format
arn:partition:service:region:account-id:resource-type/resource-id
. - FailureReason
-
- Type: string
If the
AnalyticsJobStatus
isFAILED
, this field contains information about why the job failed.The
FailureReason
field can contain one of the following values:-
Unsupported media format
: The media format specified in theMediaFormat
field of the request isn't valid. See the description of theMediaFormat
field for a list of valid values. -
The media format provided does not match the detected media format
: The media format of the audio file doesn't match the format specified in theMediaFormat
field in the request. Check the media format of your media file and make sure the two values match. -
Invalid sample rate for audio file
: The sample rate specified in theMediaSampleRateHertz
of the request isn't valid. The sample rate must be between 8,000 and 48,000 Hertz. -
The sample rate provided does not match the detected sample rate
: The sample rate in the audio file doesn't match the sample rate specified in theMediaSampleRateHertz
field in the request. Check the sample rate of your media file and make sure that the two values match. -
Invalid file size: file size too large
: The size of your audio file is larger than what Amazon Transcribe Medical can process. For more information, see Guidelines and Quotas in the Amazon Transcribe Medical Guide. -
Invalid number of channels: number of channels too large
: Your audio contains more channels than Amazon Transcribe Medical is configured to process. To request additional channels, see Amazon Transcribe Medical Endpoints and Quotas in the Amazon Web Services General Reference.
- IdentifiedLanguageScore
-
- Type: float
A value between zero and one that Amazon Transcribe assigned to the language that it identified in the source audio. This value appears only when you don't provide a single language code. Larger values indicate that Amazon Transcribe has higher confidence in the language that it identified.
- LanguageCode
-
- Type: string
If you know the language spoken between the customer and the agent, specify a language code for this field.
If you don't know the language, you can leave this field blank, and Amazon Transcribe will use machine learning to automatically identify the language. To improve the accuracy of language identification, you can provide an array containing the possible language codes for the language spoken in your audio. Refer to Supported languages for additional information.
- Media
-
- Type: Media structure
Describes the input media file in a transcription request.
- MediaFormat
-
- Type: string
The format of the input audio file. Note: for call analytics jobs, only the following media formats are supported: MP3, MP4, WAV, FLAC, OGG, and WebM.
- MediaSampleRateHertz
-
- Type: int
The sample rate, in Hertz, of the input audio.
- Settings
-
- Type: CallAnalyticsJobSettings structure
Provides information about the settings used to run a transcription job.
- StartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp that shows when the analytics job started processing.
- Transcript
-
- Type: Transcript structure
Identifies the location of a transcription.
CallAnalyticsJobSettings
Description
Provides optional settings for the CallAnalyticsJob
operation.
Members
- ContentRedaction
-
- Type: ContentRedaction structure
Settings for content redaction within a transcription job.
- LanguageIdSettings
-
- Type: Associative array of custom strings keys (LanguageCode) to LanguageIdSettings structures
The language identification settings associated with your call analytics job. These settings include
VocabularyName
,VocabularyFilterName
, andLanguageModelName
. - LanguageModelName
-
- Type: string
The structure used to describe a custom language model.
- LanguageOptions
-
- Type: Array of strings
When you run a call analytics job, you can specify the language spoken in the audio, or you can have Amazon Transcribe identify the language for you.
To specify a language, specify an array with one language code. If you don't know the language, you can leave this field blank and Amazon Transcribe will use machine learning to identify the language for you. To improve the ability of Amazon Transcribe to correctly identify the language, you can provide an array of the languages that can be present in the audio. Refer to Supported languages for additional information.
- VocabularyFilterMethod
-
- Type: string
Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text. Set to
remove
to remove filtered text from the transcript without using placeholder text. Set totag
to mark the word in the transcription output that matches the vocabulary filter. When you set the filter method totag
, the words matching your vocabulary filter are not masked or removed. - VocabularyFilterName
-
- Type: string
The name of the vocabulary filter to use when running a call analytics job. The filter that you specify must have the same language code as the analytics job.
- VocabularyName
-
- Type: string
The name of a vocabulary to use when processing the call analytics job.
CallAnalyticsJobSummary
Description
Provides summary information about a call analytics job.
Members
- CallAnalyticsJobName
-
- Type: string
The name of the call analytics job.
- CallAnalyticsJobStatus
-
- Type: string
The status of the call analytics job.
- CompletionTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp that shows when the job was completed.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp that shows when the call analytics job was created.
- FailureReason
-
- Type: string
If the
CallAnalyticsJobStatus
isFAILED
, a description of the error. - LanguageCode
-
- Type: string
The language of the transcript in the source audio file.
- StartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp that shows when the job began processing.
CategoryProperties
Description
An object that contains the rules and additional information about a call analytics category.
Members
- CategoryName
-
- Type: string
The name of the call analytics category.
- CreateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp that shows when the call analytics category was created.
- LastUpdateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp that shows when the call analytics category was most recently updated.
- Rules
-
- Type: Array of Rule structures
The rules used to create a call analytics category.
ChannelDefinition
Description
For a call analytics job, an object that indicates the audio channel that belongs to the agent and the audio channel that belongs to the customer.
Members
ConflictException
ContentRedaction
Description
Settings for content redaction within a transcription job.
Members
- PiiEntityTypes
-
- Type: Array of strings
The types of personally identifiable information (PII) you want to redact in your transcript.
- RedactionOutput
-
- Required: Yes
- Type: string
The output transcript file stored in either the default S3 bucket or in a bucket you specify.
When you choose
redacted
Amazon Transcribe outputs only the redacted transcript.When you choose
redacted_and_unredacted
Amazon Transcribe outputs both the redacted and unredacted transcripts. - RedactionType
-
- Required: Yes
- Type: string
Request parameter that defines the entities to be redacted. The only accepted value is
PII
.
InputDataConfig
Description
The object that contains the Amazon S3 object location and access role required to train and tune your custom language model.
Members
- DataAccessRoleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) that uniquely identifies the permissions you've given Amazon Transcribe to access your Amazon S3 buckets containing your media files or text data. ARNs have the format
arn:partition:service:region:account-id:resource-type/resource-id
. - S3Uri
-
- Required: Yes
- Type: string
The Amazon S3 prefix you specify to access the plain text files that you use to train your custom language model.
- TuningDataS3Uri
-
- Type: string
The Amazon S3 prefix you specify to access the plain text files that you use to tune your custom language model.
InternalFailureException
Description
There was an internal error. Check the error message and try your request again.
Members
InterruptionFilter
Description
An object that enables you to configure your category to be applied to call analytics jobs where either the customer or agent was interrupted.
Members
- AbsoluteTimeRange
-
- Type: AbsoluteTimeRange structure
An object you can use to specify a time range (in milliseconds) for when you'd want to find the interruption. For example, you could search for an interruption between the 30,000 millisecond mark and the 45,000 millisecond mark. You could also specify the time period as the first 15,000 milliseconds or the last 15,000 milliseconds.
- Negate
-
- Type: boolean
Set to
TRUE
to look for a time period where there was no interruption. - ParticipantRole
-
- Type: string
Indicates whether the caller or customer was interrupting.
- RelativeTimeRange
-
- Type: RelativeTimeRange structure
An object that allows percentages to specify the proportion of the call where there was a interruption. For example, you can specify the first half of the call. You can also specify the period of time between halfway through to three-quarters of the way through the call. Because the length of conversation can vary between calls, you can apply relative time ranges across all calls.
- Threshold
-
- Type: long (int|float)
The duration of the interruption.
JobExecutionSettings
Description
Provides information about when a transcription job should be executed.
Members
- AllowDeferredExecution
-
- Type: boolean
Indicates whether a job should be queued by Amazon Transcribe when the concurrent execution limit is exceeded. When the
AllowDeferredExecution
field is true, jobs are queued and executed when the number of executing jobs falls below the concurrent execution limit. If the field is false, Amazon Transcribe returns aLimitExceededException
exception.Note that job queuing is enabled by default for call analytics jobs.
If you specify the
AllowDeferredExecution
field, you must specify theDataAccessRoleArn
field. - DataAccessRoleArn
-
- Type: string
The Amazon Resource Name (ARN), in the form
arn:partition:service:region:account-id:resource-type/resource-id
, of a role that has access to the S3 bucket that contains the input files. Amazon Transcribe assumes this role to read queued media files. If you have specified an output S3 bucket for the transcription results, this role should have access to the output bucket as well.If you specify the
AllowDeferredExecution
field, you must specify theDataAccessRoleArn
field.
LanguageIdSettings
Description
Language-specific settings that can be specified when language identification is enabled.
Members
- LanguageModelName
-
- Type: string
The name of the language model you want to use when transcribing your audio. The model you specify must have the same language codes as the transcription job; if the languages don't match, the language model isn't be applied.
- VocabularyFilterName
-
- Type: string
The name of the vocabulary filter you want to use when transcribing your audio. The filter you specify must have the same language codes as the transcription job; if the languages don't match, the vocabulary filter isn't be applied.
- VocabularyName
-
- Type: string
The name of the vocabulary you want to use when processing your transcription job. The vocabulary you specify must have the same language codes as the transcription job; if the languages don't match, the vocabulary isn't applied.
LanguageModel
Description
The structure used to describe a custom language model.
Members
- BaseModelName
-
- Type: string
The Amazon Transcribe standard language model, or base model used to create the custom language model.
- CreateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the custom language model was created.
- FailureReason
-
- Type: string
The reason why the custom language model couldn't be created.
- InputDataConfig
-
- Type: InputDataConfig structure
The data access role and Amazon S3 prefixes for the input files used to train the custom language model.
- LanguageCode
-
- Type: string
The language code you used to create your custom language model.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The most recent time the custom language model was modified.
- ModelName
-
- Type: string
The name of the custom language model.
- ModelStatus
-
- Type: string
The creation status of a custom language model. When the status is
COMPLETED
the model is ready for use. - UpgradeAvailability
-
- Type: boolean
Whether the base model used for the custom language model is up to date. If this field is
false
then you are running the most up-to-date version of the base model in your custom language model.
LimitExceededException
Description
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
Members
Media
Description
Describes the input media file in a transcription request.
Members
- MediaFileUri
-
- Type: string
The S3 object location of the input media file. The URI must be in the same region as the API endpoint that you are calling. The general form is:
s3://DOC-EXAMPLE-BUCKET/keyprefix/objectkey
For example:
s3://DOC-EXAMPLE-BUCKET/example.flac
s3://DOC-EXAMPLE-BUCKET/mediafiles/example.flac
For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.
- RedactedMediaFileUri
-
- Type: string
The S3 object location for your redacted output media file. This is only supported for call analytics jobs.
MedicalTranscript
Description
Identifies the location of a medical transcript.
Members
MedicalTranscriptionJob
Description
The data structure that contains the information for a medical transcription job.
Members
- CompletionTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp that shows when the job was completed.
- ContentIdentificationType
-
- Type: string
Shows the type of content that you've configured Amazon Transcribe Medical to identify in a transcription job. If the value is
PHI
, you've configured the job to identify personal health information (PHI) in the transcription output. - CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp that shows when the job was created.
- FailureReason
-
- Type: string
If the
TranscriptionJobStatus
field isFAILED
, this field contains information about why the job failed.The
FailureReason
field contains one of the following values:-
Unsupported media format
- The media format specified in theMediaFormat
field of the request isn't valid. See the description of theMediaFormat
field for a list of valid values. -
The media format provided does not match the detected media format
- The media format of the audio file doesn't match the format specified in theMediaFormat
field in the request. Check the media format of your media file and make sure the two values match. -
Invalid sample rate for audio file
- The sample rate specified in theMediaSampleRateHertz
of the request isn't valid. The sample rate must be between 8,000 and 48,000 Hertz. -
The sample rate provided does not match the detected sample rate
- The sample rate in the audio file doesn't match the sample rate specified in theMediaSampleRateHertz
field in the request. Check the sample rate of your media file and make sure that the two values match. -
Invalid file size: file size too large
- The size of your audio file is larger than what Amazon Transcribe Medical can process. For more information, see Guidelines and Quotas in the Amazon Transcribe Medical Guide. -
Invalid number of channels: number of channels too large
- Your audio contains more channels than Amazon Transcribe Medical is configured to process. To request additional channels, see Amazon Transcribe Medical Endpoints and Quotas in the Amazon Web Services General Reference.
- LanguageCode
-
- Type: string
The language code for the language spoken in the source audio file. US English (en-US) is the only supported language for medical transcriptions. Any other value you enter for language code results in a
BadRequestException
error. - Media
-
- Type: Media structure
Describes the input media file in a transcription request.
- MediaFormat
-
- Type: string
The format of the input media file.
- MediaSampleRateHertz
-
- Type: int
The sample rate, in Hertz, of the source audio containing medical information.
If you don't specify the sample rate, Amazon Transcribe Medical determines it for you. If you choose to specify the sample rate, it must match the rate detected by Amazon Transcribe Medical.
- MedicalTranscriptionJobName
-
- Type: string
The name for a given medical transcription job.
- Settings
-
- Type: MedicalTranscriptionSetting structure
Object that contains object.
- Specialty
-
- Type: string
The medical specialty of any clinicians providing a dictation or having a conversation. Refer to Transcribing a medical conversationfor a list of supported specialties.
- StartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp that shows when the job started processing.
- Tags
-
- Type: Array of Tag structures
A key:value pair assigned to a given medical transcription job.
- Transcript
-
- Type: MedicalTranscript structure
An object that contains the
MedicalTranscript
. TheMedicalTranscript
contains theTranscriptFileUri
. - TranscriptionJobStatus
-
- Type: string
The completion status of a medical transcription job.
- Type
-
- Type: string
The type of speech in the transcription job.
CONVERSATION
is generally used for patient-physician dialogues.DICTATION
is the setting for physicians speaking their notes after seeing a patient. For more information, see What is Amazon Transcribe Medical?.
MedicalTranscriptionJobSummary
Description
Provides summary information about a transcription job.
Members
- CompletionTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp that shows when the job was completed.
- ContentIdentificationType
-
- Type: string
Shows the type of information you've configured Amazon Transcribe Medical to identify in a transcription job. If the value is
PHI
, you've configured the transcription job to identify personal health information (PHI). - CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp that shows when the medical transcription job was created.
- FailureReason
-
- Type: string
If the
TranscriptionJobStatus
field isFAILED
, a description of the error. - LanguageCode
-
- Type: string
The language of the transcript in the source audio file.
- MedicalTranscriptionJobName
-
- Type: string
The name of a medical transcription job.
- OutputLocationType
-
- Type: string
Indicates the location of the transcription job's output. This field must be the path of an S3 bucket; if you don't already have an S3 bucket, one is created based on the path you add.
- Specialty
-
- Type: string
The medical specialty of the transcription job. Refer to Transcribing a medical conversationfor a list of supported specialties.
- StartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp that shows when the job began processing.
- TranscriptionJobStatus
-
- Type: string
The status of the medical transcription job.
- Type
-
- Type: string
The speech of the clinician in the input audio.
MedicalTranscriptionSetting
Description
Optional settings for the StartMedicalTranscriptionJob operation.
Members
- ChannelIdentification
-
- Type: boolean
Instructs Amazon Transcribe Medical to process each audio channel separately and then merge the transcription output of each channel into a single transcription.
Amazon Transcribe Medical also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of item. The alternative transcriptions also come with confidence scores provided by Amazon Transcribe Medical.
You can't set both
ShowSpeakerLabels
andChannelIdentification
in the same request. If you set both, your request returns aBadRequestException
. - MaxAlternatives
-
- Type: int
The maximum number of alternatives that you tell the service to return. If you specify the
MaxAlternatives
field, you must set theShowAlternatives
field to true. - MaxSpeakerLabels
-
- Type: int
The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers are identified as a single speaker. If you specify the
MaxSpeakerLabels
field, you must set theShowSpeakerLabels
field to true. - ShowAlternatives
-
- Type: boolean
Determines whether alternative transcripts are generated along with the transcript that has the highest confidence. If you set
ShowAlternatives
field to true, you must also set the maximum number of alternatives to return in theMaxAlternatives
field. - ShowSpeakerLabels
-
- Type: boolean
Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recognition labels individual speakers in the audio file. If you set the
ShowSpeakerLabels
field to true, you must also set the maximum number of speaker labels in theMaxSpeakerLabels
field.You can't set both
ShowSpeakerLabels
andChannelIdentification
in the same request. If you set both, your request returns aBadRequestException
. - VocabularyName
-
- Type: string
The name of the vocabulary to use when processing a medical transcription job.
ModelSettings
Description
The object used to call your custom language model to your transcription job.
Members
NonTalkTimeFilter
Description
An object that enables you to configure your category to be applied to call analytics jobs where either the customer or agent was interrupted.
Members
- AbsoluteTimeRange
-
- Type: AbsoluteTimeRange structure
An object you can use to specify a time range (in milliseconds) for when no one is talking. For example, you could specify a time period between the 30,000 millisecond mark and the 45,000 millisecond mark. You could also specify the time period as the first 15,000 milliseconds or the last 15,000 milliseconds.
- Negate
-
- Type: boolean
Set to
TRUE
to look for a time period when people were talking. - RelativeTimeRange
-
- Type: RelativeTimeRange structure
An object that allows percentages to specify the proportion of the call where there was silence. For example, you can specify the first half of the call. You can also specify the period of time between halfway through to three-quarters of the way through the call. Because the length of conversation can vary between calls, you can apply relative time ranges across all calls.
- Threshold
-
- Type: long (int|float)
The duration of the period when neither the customer nor agent was talking.
NotFoundException
Description
We can't find the requested resource. Check the name and try your request again.
Members
RelativeTimeRange
Description
An object that allows percentages to specify the proportion of the call where you would like to apply a filter. For example, you can specify the first half of the call. You can also specify the period of time between halfway through to three-quarters of the way through the call. Because the length of conversation can vary between calls, you can apply relative time ranges across all calls.
Members
- EndPercentage
-
- Type: int
A value that indicates the percentage of the end of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
-
StartPercentage - 10
-
EndPercentage - 50
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
- First
-
- Type: int
A range that takes the portion of the call up to the time in milliseconds set by the value that you've specified. For example, if you specify
120000
, the time range is set for the first 120,000 milliseconds of the call. - Last
-
- Type: int
A range that takes the portion of the call from the time in milliseconds set by the value that you've specified to the end of the call. For example, if you specify
120000
, the time range is set for the last 120,000 milliseconds of the call. - StartPercentage
-
- Type: int
A value that indicates the percentage of the beginning of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
-
StartPercentage - 10
-
EndPercentage - 50
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
Rule
Description
A condition in the call between the customer and the agent that you want to filter for.
Members
- InterruptionFilter
-
- Type: InterruptionFilter structure
A condition for a time period when either the customer or agent was interrupting the other person.
- NonTalkTimeFilter
-
- Type: NonTalkTimeFilter structure
A condition for a time period when neither the customer nor the agent was talking.
- SentimentFilter
-
- Type: SentimentFilter structure
A condition that is applied to a particular customer sentiment.
- TranscriptFilter
-
- Type: TranscriptFilter structure
A condition that catches particular words or phrases based on a exact match. For example, if you set the phrase "I want to speak to the manager", only that exact phrase will be returned.
SentimentFilter
Description
An object that enables you to specify a particular customer or agent sentiment. If at least 50 percent of the conversation turns (the back-and-forth between two speakers) in a specified time period match the specified sentiment, Amazon Transcribe will consider the sentiment a match.
Members
- AbsoluteTimeRange
-
- Type: AbsoluteTimeRange structure
The time range, measured in seconds, of the sentiment.
- Negate
-
- Type: boolean
Set to
TRUE
to look for sentiments that weren't specified in the request. - ParticipantRole
-
- Type: string
A value that determines whether the sentiment belongs to the customer or the agent.
- RelativeTimeRange
-
- Type: RelativeTimeRange structure
The time range, set in percentages, that correspond to proportion of the call.
- Sentiments
-
- Required: Yes
- Type: Array of strings
An array that enables you to specify sentiments for the customer or agent. You can specify one or more values.
Settings
Description
Provides optional settings for the StartTranscriptionJob
operation.
Members
- ChannelIdentification
-
- Type: boolean
Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription.
Amazon Transcribe also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of the item including the confidence that Amazon Transcribe has in the transcription.
You can't set both
ShowSpeakerLabels
andChannelIdentification
in the same request. If you set both, your request returns aBadRequestException
. - MaxAlternatives
-
- Type: int
The number of alternative transcriptions that the service should return. If you specify the
MaxAlternatives
field, you must set theShowAlternatives
field to true. - MaxSpeakerLabels
-
- Type: int
The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers are identified as a single speaker. If you specify the
MaxSpeakerLabels
field, you must set theShowSpeakerLabels
field to true. - ShowAlternatives
-
- Type: boolean
Determines whether the transcription contains alternative transcriptions. If you set the
ShowAlternatives
field to true, you must also set the maximum number of alternatives to return in theMaxAlternatives
field. - ShowSpeakerLabels
-
- Type: boolean
Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recognition labels individual speakers in the audio file. If you set the
ShowSpeakerLabels
field to true, you must also set the maximum number of speaker labelsMaxSpeakerLabels
field.You can't set both
ShowSpeakerLabels
andChannelIdentification
in the same request. If you set both, your request returns aBadRequestException
. - VocabularyFilterMethod
-
- Type: string
Set to
mask
to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text. Set toremove
to remove filtered text from the transcript without using placeholder text. Set totag
to mark the word in the transcription output that matches the vocabulary filter. When you set the filter method totag
, the words matching your vocabulary filter are not masked or removed. - VocabularyFilterName
-
- Type: string
The name of the vocabulary filter to use when transcribing the audio. The filter that you specify must have the same language code as the transcription job.
- VocabularyName
-
- Type: string
The name of a vocabulary to use when processing the transcription job.
Subtitles
Description
Generate subtitles for your batch transcription job. Note that your subtitle files are placed in the same location as your transcription output.
Members
- Formats
-
- Type: Array of strings
Specify the output format for your subtitle file; if you select both
srt
andvtt
formats, two output files are generated. - OutputStartIndex
-
- Type: int
Defines 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 of1
. If you're uncertain which value to use, we recommend choosing1
, as this may improve compatibility with other services.
SubtitlesOutput
Description
The S3 location where your subtitle files are located. Note that your subtitle files are placed in the same location as your transcription output. Refer to TranscriptFileUri
to download your files.
Members
- Formats
-
- Type: Array of strings
The format of your subtitle files. If your request specified both
srt
andvtt
formats, both formats are shown. - OutputStartIndex
-
- Type: int
Shows the output start index value for your subtitle files. If you did not specify a value in your request, the default value of
0
is used. - SubtitleFileUris
-
- Type: Array of strings
Contains the output location for your subtitle file. This location must be an S3 bucket.
Tag
Description
A key:value pair that adds metadata to a resource used by Amazon Transcribe. For example, a tag with the key:value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by your organization's sales department.
Members
- Key
-
- Required: Yes
- Type: string
The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the key is 'Department'.
- Value
-
- Required: Yes
- Type: string
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'.
Transcript
Description
Identifies the location of a transcription.
Members
- RedactedTranscriptFileUri
-
- Type: string
The S3 object location of the redacted transcript.
Use this URI to access the redacted transcript. If you specified an S3 bucket in the
OutputBucketName
field when you created the job, this is the URI of that bucket. If you chose to store the transcript in Amazon Transcribe, this is a shareable URL that provides secure access to that location. - TranscriptFileUri
-
- Type: string
The S3 object location of the transcript.
Use this URI to access the transcript. If you specified an S3 bucket in the
OutputBucketName
field when you created the job, this is the URI of that bucket. If you chose to store the transcript in Amazon Transcribe, this is a shareable URL that provides secure access to that location.
TranscriptFilter
Description
Matches the output of the transcription to either the specific phrases that you specify, or the intent of the phrases that you specify.
Members
- AbsoluteTimeRange
-
- Type: AbsoluteTimeRange structure
A time range, set in seconds, between two points in the call.
- Negate
-
- Type: boolean
If
TRUE
, the rule that you specify is applied to everything except for the phrases that you specify. - ParticipantRole
-
- Type: string
Determines whether the customer or the agent is speaking the phrases that you've specified.
- RelativeTimeRange
-
- Type: RelativeTimeRange structure
An object that allows percentages to specify the proportion of the call where you would like to apply a filter. For example, you can specify the first half of the call. You can also specify the period of time between halfway through to three-quarters of the way through the call. Because the length of conversation can vary between calls, you can apply relative time ranges across all calls.
- Targets
-
- Required: Yes
- Type: Array of strings
The phrases that you're specifying for the transcript filter to match.
- TranscriptFilterType
-
- Required: Yes
- Type: string
Matches the phrase to the transcription output in a word for word fashion. For example, if you specify the phrase "I want to speak to the manager." Amazon Transcribe attempts to match that specific phrase to the transcription.
TranscriptionJob
Description
Describes an asynchronous transcription job that was created with the StartTranscriptionJob
operation.
Members
- CompletionTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp that shows when the job completed.
- ContentRedaction
-
- Type: ContentRedaction structure
An object that describes content redaction settings for the transcription job.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp that shows when the job was created.
- FailureReason
-
- Type: string
If the
TranscriptionJobStatus
field isFAILED
, this field contains information about why the job failed.The
FailureReason
field can contain one of the following values:-
Unsupported media format
- The media format specified in theMediaFormat
field of the request isn't valid. See the description of theMediaFormat
field for a list of valid values. -
The media format provided does not match the detected media format
- The media format of the audio file doesn't match the format specified in theMediaFormat
field in the request. Check the media format of your media file and make sure that the two values match. -
Invalid sample rate for audio file
- The sample rate specified in theMediaSampleRateHertz
of the request isn't valid. The sample rate must be between 8,000 and 48,000 Hertz. -
The sample rate provided does not match the detected sample rate
- The sample rate in the audio file doesn't match the sample rate specified in theMediaSampleRateHertz
field in the request. Check the sample rate of your media file and make sure that the two values match. -
Invalid file size: file size too large
- The size of your audio file is larger than Amazon Transcribe can process. For more information, see Limits in the Amazon Transcribe Developer Guide. -
Invalid number of channels: number of channels too large
- Your audio contains more channels than Amazon Transcribe is configured to process. To request additional channels, see Amazon Transcribe Limits in the Amazon Web Services General Reference.
- IdentifiedLanguageScore
-
- Type: float
A value between zero and one that Amazon Transcribe assigned to the language that it identified in the source audio. Larger values indicate that Amazon Transcribe has higher confidence in the language it identified.
- IdentifyLanguage
-
- Type: boolean
A value that shows if automatic language identification was enabled for a transcription job.
- JobExecutionSettings
-
- Type: JobExecutionSettings structure
Provides information about how a transcription job is executed.
- LanguageCode
-
- Type: string
The language code for the input speech.
- LanguageIdSettings
-
- Type: Associative array of custom strings keys (LanguageCode) to LanguageIdSettings structures
Language-specific settings that can be specified when language identification is enabled for your transcription job. These settings include
VocabularyName
,VocabularyFilterName
, andLanguageModelName
. - LanguageOptions
-
- Type: Array of strings
An object that shows the optional array of languages inputted for transcription jobs with automatic language identification enabled.
- Media
-
- Type: Media structure
An object that describes the input media for the transcription job.
- MediaFormat
-
- Type: string
The format of the input media file.
- MediaSampleRateHertz
-
- Type: int
The sample rate, in Hertz (Hz), of the audio track in the input media file.
- ModelSettings
-
- Type: ModelSettings structure
An object containing the details of your custom language model.
- Settings
-
- Type: Settings structure
Optional settings for the transcription job. Use these settings to turn on speaker recognition, to set the maximum number of speakers that should be identified and to specify a custom vocabulary to use when processing the transcription job.
- StartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp that shows when the job started processing.
- Subtitles
-
- Type: SubtitlesOutput structure
Generate subtitles for your batch transcription job.
- Tags
-
- Type: Array of Tag structures
A key:value pair assigned to a given transcription job.
- Transcript
-
- Type: Transcript structure
An object that describes the output of the transcription job.
- TranscriptionJobName
-
- Type: string
The name of the transcription job.
- TranscriptionJobStatus
-
- Type: string
The status of the transcription job.
TranscriptionJobSummary
Description
Provides a summary of information about a transcription job.
Members
- CompletionTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp that shows when the job was completed.
- ContentRedaction
-
- Type: ContentRedaction structure
The content redaction settings of the transcription job.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp that shows when the job was created.
- FailureReason
-
- Type: string
If the
TranscriptionJobStatus
field isFAILED
, a description of the error. - IdentifiedLanguageScore
-
- Type: float
A value between zero and one that Amazon Transcribe assigned to the language it identified in the source audio. A higher score indicates that Amazon Transcribe is more confident in the language it identified.
- IdentifyLanguage
-
- Type: boolean
Whether automatic language identification was enabled for a transcription job.
- LanguageCode
-
- Type: string
The language code for the input speech.
- ModelSettings
-
- Type: ModelSettings structure
The object used to call your custom language model to your transcription job.
- OutputLocationType
-
- Type: string
Indicates the location of the output of the transcription job.
If the value is
CUSTOMER_BUCKET
then the location is the S3 bucket specified in theoutputBucketName
field when the transcription job was started with theStartTranscriptionJob
operation.If the value is
SERVICE_BUCKET
then the output is stored by Amazon Transcribe and can be retrieved using the URI in theGetTranscriptionJob
response'sTranscriptFileUri
field. - StartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp that shows when the job started processing.
- TranscriptionJobName
-
- Type: string
The name of the transcription job.
- TranscriptionJobStatus
-
- Type: string
The status of the transcription job. When the status is
COMPLETED
, use theGetTranscriptionJob
operation to get the results of the transcription.
VocabularyFilterInfo
Description
Provides information about a vocabulary filter.
Members
- LanguageCode
-
- Type: string
The language code of the words in the vocabulary filter.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the vocabulary was last updated.
- VocabularyFilterName
-
- Type: string
The name of the vocabulary filter. The name must be unique in the account that holds the filter.
VocabularyInfo
Description
Provides information about a custom vocabulary.
Members
- LanguageCode
-
- Type: string
The language code of the vocabulary entries.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the vocabulary was last modified.
- VocabularyName
-
- Type: string
The name of the vocabulary.
- VocabularyState
-
- Type: string
The processing state of the vocabulary. If the state is
READY
you can use the vocabulary in aStartTranscriptionJob
request.