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 */)
.
- CreateLanguageModel ( array $params = [] )
Creates a new custom language model.
- CreateMedicalVocabulary ( array $params = [] )
Creates a new custom vocabulary that you can use to change how Amazon Transcribe Medical transcribes your audio file.
- CreateVocabulary ( array $params = [] )
Creates a new custom vocabulary that you can use to change the way Amazon Transcribe handles transcription of an audio file.
- CreateVocabularyFilter ( array $params = [] )
Creates a new vocabulary filter that you can use to filter words, such as profane words, from the output of a transcription job.
- DeleteLanguageModel ( array $params = [] )
Deletes a custom language model using its name.
- DeleteMedicalTranscriptionJob ( array $params = [] )
Deletes a transcription job generated by Amazon Transcribe Medical and any related information.
- DeleteMedicalVocabulary ( array $params = [] )
Deletes a vocabulary from Amazon Transcribe Medical.
- DeleteTranscriptionJob ( array $params = [] )
Deletes a previously submitted transcription job along with any other generated results such as the transcription, models, and so on.
- DeleteVocabulary ( array $params = [] )
Deletes a vocabulary from Amazon Transcribe.
- DeleteVocabularyFilter ( array $params = [] )
Removes a vocabulary filter.
- DescribeLanguageModel ( array $params = [] )
Gets information about a single custom language model.
- GetMedicalTranscriptionJob ( array $params = [] )
Returns information about a transcription job from Amazon Transcribe Medical.
- 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.
- 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.
- 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.
- 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.
- 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
CreateLanguageModel
$result = $client->createLanguageModel
([/* ... */]); $promise = $client->createLanguageModelAsync
([/* ... */]);
Creates a new custom language model. Use Amazon S3 prefixes to provide the location of your input files. The time it takes to create your model depends on the size of your training data.
Parameter Syntax
$result = $client->createLanguageModel([ 'BaseModelName' => 'NarrowBand|WideBand', // REQUIRED 'InputDataConfig' => [ // REQUIRED 'DataAccessRoleArn' => '<string>', // REQUIRED 'S3Uri' => '<string>', // REQUIRED 'TuningDataS3Uri' => '<string>', ], 'LanguageCode' => 'en-US', // REQUIRED 'ModelName' => '<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.
If you want to use your custom language model to transcribe audio with a sample rate of 16 kHz or greater, choose
Wideband
.If you want to use your custom language model to transcribe audio with a sample rate that is less than 16 kHz, choose
Narrowband
. - InputDataConfig
-
- Required: Yes
- Type: InputDataConfig structure
Contains the data access role and the Amazon S3 prefixes to read the required input files to create a custom language model.
- LanguageCode
-
- Required: Yes
- Type: string
The language of the input text you're using to train your custom language model.
- ModelName
-
- Required: Yes
- Type: string
The name you choose for your custom language model when you create it.
Result Syntax
[ 'BaseModelName' => 'NarrowBand|WideBand', 'InputDataConfig' => [ 'DataAccessRoleArn' => '<string>', 'S3Uri' => '<string>', 'TuningDataS3Uri' => '<string>', ], 'LanguageCode' => 'en-US', 'ModelName' => '<string>', 'ModelStatus' => 'IN_PROGRESS|FAILED|COMPLETED', ]
Result Details
Members
- BaseModelName
-
- Type: string
The Amazon Transcribe standard language model, or base model you've used to create a custom language model.
- InputDataConfig
-
- Type: InputDataConfig structure
The data access role and Amazon S3 prefixes you've chosen to create your custom language model.
- LanguageCode
-
- Type: string
The language code of the text you've used to create a custom language model.
- ModelName
-
- Type: string
The name you've chosen for your custom language model.
- ModelStatus
-
- Type: string
The status of the custom language model. When the status is
COMPLETED
the 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 vocabulary that you can use to change how Amazon Transcribe Medical transcribes your audio file.
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', // REQUIRED 'VocabularyFileUri' => '<string>', // REQUIRED 'VocabularyName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- LanguageCode
-
- Required: Yes
- Type: string
The language code for the language used for the entries in your custom vocabulary. The language code of your custom vocabulary must match the language code of your transcription job. US English (en-US) is the only language code available for Amazon Transcribe Medical.
- VocabularyFileUri
-
- Required: Yes
- Type: string
The location in Amazon S3 of the text file you use to define your custom vocabulary. The URI must be in the same AWS Region as the resource that you're calling. Enter information about your
VocabularyFileUri
in the following format:https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>
The following is an example URI for a vocabulary file that is stored in Amazon S3:
https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt
For more information about Amazon S3 object names, see Object Keys in the Amazon S3 Developer Guide.
For more information about custom vocabularies, see Medical Custom Vocabularies.
- VocabularyName
-
- Required: Yes
- Type: string
The name of the custom vocabulary. This case-sensitive name must be unique within an AWS 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', 'LastModifiedTime' => <DateTime>, 'VocabularyName' => '<string>', 'VocabularyState' => 'PENDING|READY|FAILED', ]
Result Details
Members
- FailureReason
-
- Type: string
If the
VocabularyState
field isFAILED
, this field contains information about why the job failed. - LanguageCode
-
- Type: string
The language code for the entries in your custom vocabulary. US English (en-US) is the only valid language code for Amazon Transcribe Medical.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that you created the vocabulary.
- VocabularyName
-
- Type: string
The name of the vocabulary. The name must be unique within an AWS account and is case sensitive.
- VocabularyState
-
- Type: string
The processing state of your custom vocabulary in Amazon Transcribe Medical. 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 that you can use to change the way Amazon Transcribe handles transcription of an audio file.
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', // REQUIRED 'Phrases' => ['<string>', ...], 'VocabularyFileUri' => '<string>', 'VocabularyName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- LanguageCode
-
- Required: Yes
- Type: string
The language code of the vocabulary entries.
- Phrases
-
- Type: Array of strings
An array of strings that contains 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
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. The name must be unique within an AWS account. The name is case sensitive. If you try to create a vocabulary with the same name as a previous vocabulary you will receive 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', 'LastModifiedTime' => <DateTime>, 'VocabularyName' => '<string>', 'VocabularyState' => 'PENDING|READY|FAILED', ]
Result Details
Members
- 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 created.
- VocabularyName
-
- Type: string
The name of the vocabulary.
- 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.
-
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, such as profane words, from the output of a transcription job.
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', // 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.
- 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 vocabulary filter name. The name must be unique within the account that contains it. If you try to create 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', '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.
DeleteLanguageModel
$result = $client->deleteLanguageModel
([/* ... */]); $promise = $client->deleteLanguageModelAsync
([/* ... */]);
Deletes a custom language model using its name.
Parameter Syntax
$result = $client->deleteLanguageModel([ 'ModelName' => '<string>', // REQUIRED ]);
Parameter Details
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 transcription job generated by Amazon Transcribe Medical and any related information.
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 vocabulary from Amazon Transcribe Medical.
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 previously submitted transcription job along with any other generated results such as the transcription, models, and so on.
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 vocabulary from Amazon Transcribe.
Parameter Syntax
$result = $client->deleteVocabulary([ 'VocabularyName' => '<string>', // REQUIRED ]);
Parameter Details
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
([/* ... */]);
Removes a vocabulary filter.
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
([/* ... */]);
Gets information about a single custom language model. Use this information to see details about the language model in your AWS account. You can also see whether the base language model 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 the language model wasn't created, you can use this operation to understand why Amazon Transcribe couldn't create it.
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', '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.
GetMedicalTranscriptionJob
$result = $client->getMedicalTranscriptionJob
([/* ... */]); $promise = $client->getMedicalTranscriptionJobAsync
([/* ... */]);
Returns information about a transcription job from Amazon Transcribe Medical. To see the status of the job, check the TranscriptionJobStatus
field. If the status is COMPLETED
, the job is finished. You find the results of the completed job in the TranscriptFileUri
field.
Parameter Syntax
$result = $client->getMedicalTranscriptionJob([ 'MedicalTranscriptionJobName' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[ 'MedicalTranscriptionJob' => [ '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', 'Media' => [ 'MediaFileUri' => '<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>, 'Transcript' => [ 'TranscriptFileUri' => '<string>', ], 'TranscriptionJobStatus' => 'QUEUED|IN_PROGRESS|FAILED|COMPLETED', 'Type' => 'CONVERSATION|DICTATION', ], ]
Result Details
Members
- MedicalTranscriptionJob
-
- Type: MedicalTranscriptionJob structure
An object that contains the results of the medical 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.
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', 'LastModifiedTime' => <DateTime>, 'VocabularyName' => '<string>', 'VocabularyState' => 'PENDING|READY|FAILED', ]
Result Details
Members
- DownloadUri
-
- Type: string
The location in Amazon S3 where the vocabulary is stored. Use this URI to get the contents of the vocabulary. You can download your vocabulary from the URI for a limited time.
- FailureReason
-
- Type: string
If the
VocabularyState
isFAILED
, this field contains information about why the job failed. - 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' => [ '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', 'LanguageOptions' => ['<string>', ...], 'Media' => [ 'MediaFileUri' => '<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', 'VocabularyFilterName' => '<string>', 'VocabularyName' => '<string>', ], 'StartTime' => <DateTime>, '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', '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', '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.
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 the response. If there are fewer results in the list, the response contains only the actual results.
- 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', '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 the response. IF there are fewer results in the list, this response contains only the actual results.
- 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>, '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', '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 the response.
- 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', '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.
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 the response. If there are fewer results in the list, this response contains only the actual results.
- NextToken
-
- Type: string
If the result of the previous request to
ListTranscriptionJobs
was 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' => [ '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', '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 the response. If there are fewer results in the list, this response contains only the actual results.
- 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', '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 the response. If there are fewer results in the list, this response contains only the actual results.
- 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', '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.
StartMedicalTranscriptionJob
$result = $client->startMedicalTranscriptionJob
([/* ... */]); $promise = $client->startMedicalTranscriptionJobAsync
([/* ... */]);
Starts a batch job to transcribe medical speech to text.
Parameter Syntax
$result = $client->startMedicalTranscriptionJob([ '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', // REQUIRED 'Media' => [ // REQUIRED 'MediaFileUri' => '<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 'Type' => 'CONVERSATION|DICTATION', // REQUIRED ]);
Parameter Details
Members
- 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 AWS 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 AWS 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 AWS 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.
- 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, e.g., for clinical notes.
Result Syntax
[ 'MedicalTranscriptionJob' => [ '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', 'Media' => [ 'MediaFileUri' => '<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>, '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' => [ 'RedactionOutput' => 'redacted|redacted_and_unredacted', // REQUIRED 'RedactionType' => 'PII', // REQUIRED ], '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', 'LanguageOptions' => ['<string>', ...], 'Media' => [ // REQUIRED 'MediaFileUri' => '<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', 'VocabularyFilterName' => '<string>', 'VocabularyName' => '<string>', ], '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
. - 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.
- LanguageCode
-
- Type: string
The language code for the language used in the input media file.
- 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.
- 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 AWS 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 AWS 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. - 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 AWS 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' => [ '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', 'LanguageOptions' => ['<string>', ...], 'Media' => [ 'MediaFileUri' => '<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', 'VocabularyFilterName' => '<string>', 'VocabularyName' => '<string>', ], 'StartTime' => <DateTime>, 'Transcript' => [ 'RedactedTranscriptFileUri' => '<string>', 'TranscriptFileUri' => '<string>', ], 'TranscriptionJobName' => '<string>', 'TranscriptionJobStatus' => 'QUEUED|IN_PROGRESS|FAILED|COMPLETED', ], ]
Result Details
Members
- TranscriptionJob
-
- Type: TranscriptionJob structure
An object containing details of the 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.
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', // 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. US 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 the you use for your custom vocabulary. The URI must be in the same AWS Region as the resource that you are calling. The following is the format for a URI:
https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>
For example:
https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt
For more information about Amazon S3 object names, see Object Keys in the Amazon S3 Developer Guide.
For more information about custom vocabularies in Amazon Transcribe Medical, see Medical Custom Vocabularies.
- 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', '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', // REQUIRED 'Phrases' => ['<string>', ...], 'VocabularyFileUri' => '<string>', 'VocabularyName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- LanguageCode
-
- Required: Yes
- Type: string
The language code of the vocabulary entries.
- 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
For example:
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', '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', '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
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
ConflictException
ContentRedaction
Description
Settings for content redaction within a transcription job.
Members
- 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.
- 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
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.If you specify the
AllowDeferredExecution
field, you must specify theDataAccessRoleArn
field. - DataAccessRoleArn
-
- Type: string
The Amazon Resource Name (ARN) 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.
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
true
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:
For example:
For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.
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.
- 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 8000 and 48000 Hertz. -
The sample rate provided does not match the detected sample rate
- The sample rate in the audio file doesn't match the sample rate specified in 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. In most cases, you should leave the
MediaSampleHertz
blank and let Amazon Transcribe Medical determine the sample rate. - 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.
PRIMARYCARE
is the only available setting for this object. This specialty enables you to generate transcriptions for the following medical fields:-
Family Medicine
- StartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp that shows when the job started processing.
- 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 how-it-works-med
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.
- 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.
The
CUSTOMER_BUCKET
is the S3 location provided in theOutputBucketName
field when the - Specialty
-
- Type: string
The medical specialty of the transcription job.
Primary care
is the only valid value. - 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
NotFoundException
Description
We can't find the requested resource. Check the name and try your request again.
Members
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. - 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.
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.
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 was 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 8000 and 48000 Hertz. -
The sample rate provided does not match the detected sample rate
- The sample rate in the audio file doesn't match the sample rate specified in 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.
- 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, 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 with the job was started processing.
- 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.