SDK for PHP 3.x

Amazon Transcribe Service 2017-10-26

Client: Aws\TranscribeService\TranscribeServiceClient
Service ID: transcribe
Version: 2017-10-26

This page describes the parameters and results for the operations of the Amazon Transcribe Service (2017-10-26), and shows how to use the Aws\TranscribeService\TranscribeServiceClient object to call the described operations. This documentation is specific to the 2017-10-26 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CreateCallAnalyticsCategory ( array $params = [] )
Creates a new Call Analytics category.
CreateLanguageModel ( array $params = [] )
Creates a new custom language model.
CreateMedicalVocabulary ( array $params = [] )
Creates a new custom medical vocabulary.
CreateVocabulary ( array $params = [] )
Creates a new custom vocabulary.
CreateVocabularyFilter ( array $params = [] )
Creates a new custom vocabulary filter.
DeleteCallAnalyticsCategory ( array $params = [] )
Deletes a Call Analytics category.
DeleteCallAnalyticsJob ( array $params = [] )
Deletes a Call Analytics job.
DeleteLanguageModel ( array $params = [] )
Deletes a custom language model.
DeleteMedicalScribeJob ( array $params = [] )
Deletes a Medical Scribe job.
DeleteMedicalTranscriptionJob ( array $params = [] )
Deletes a medical transcription job.
DeleteMedicalVocabulary ( array $params = [] )
Deletes a custom medical vocabulary.
DeleteTranscriptionJob ( array $params = [] )
Deletes a transcription job.
DeleteVocabulary ( array $params = [] )
Deletes a custom vocabulary.
DeleteVocabularyFilter ( array $params = [] )
Deletes a custom vocabulary filter.
DescribeLanguageModel ( array $params = [] )
Provides information about the specified custom language model.
GetCallAnalyticsCategory ( array $params = [] )
Provides information about the specified Call Analytics category.
GetCallAnalyticsJob ( array $params = [] )
Provides information about the specified Call Analytics job.
GetMedicalScribeJob ( array $params = [] )
Provides information about the specified Medical Scribe job.
GetMedicalTranscriptionJob ( array $params = [] )
Provides information about the specified medical transcription job.
GetMedicalVocabulary ( array $params = [] )
Provides information about the specified custom medical vocabulary.
GetTranscriptionJob ( array $params = [] )
Provides information about the specified transcription job.
GetVocabulary ( array $params = [] )
Provides information about the specified custom vocabulary.
GetVocabularyFilter ( array $params = [] )
Provides information about the specified custom vocabulary filter.
ListCallAnalyticsCategories ( array $params = [] )
Provides a list of Call Analytics categories, including all rules that make up each category.
ListCallAnalyticsJobs ( array $params = [] )
Provides a list of Call Analytics jobs that match the specified criteria.
ListLanguageModels ( array $params = [] )
Provides a list of custom language models that match the specified criteria.
ListMedicalScribeJobs ( array $params = [] )
Provides a list of Medical Scribe jobs that match the specified criteria.
ListMedicalTranscriptionJobs ( array $params = [] )
Provides a list of medical transcription jobs that match the specified criteria.
ListMedicalVocabularies ( array $params = [] )
Provides a list of custom medical vocabularies that match the specified criteria.
ListTagsForResource ( array $params = [] )
Lists all tags associated with the specified transcription job, vocabulary, model, or resource.
ListTranscriptionJobs ( array $params = [] )
Provides a list of transcription jobs that match the specified criteria.
ListVocabularies ( array $params = [] )
Provides a list of custom vocabularies that match the specified criteria.
ListVocabularyFilters ( array $params = [] )
Provides a list of custom vocabulary filters that match the specified criteria.
StartCallAnalyticsJob ( array $params = [] )
Transcribes the audio from a customer service call and applies any additional Request Parameters you choose to include in your request.
StartMedicalScribeJob ( array $params = [] )
Transcribes patient-clinician conversations and generates clinical notes.
StartMedicalTranscriptionJob ( array $params = [] )
Transcribes the audio from a medical dictation or conversation and applies any additional Request Parameters you choose to include in your request.
StartTranscriptionJob ( array $params = [] )
Transcribes the audio from a media file and applies any additional Request Parameters you choose to include in your request.
TagResource ( array $params = [] )
Adds one or more custom tags, each in the form of a key:value pair, to the specified resource.
UntagResource ( array $params = [] )
Removes the specified tags from the specified Amazon Transcribe resource.
UpdateCallAnalyticsCategory ( array $params = [] )
Updates the specified Call Analytics category with new rules.
UpdateMedicalVocabulary ( array $params = [] )
Updates an existing custom medical vocabulary with new values.
UpdateVocabulary ( array $params = [] )
Updates an existing custom vocabulary with new values.
UpdateVocabularyFilter ( array $params = [] )
Updates an existing custom vocabulary filter with a new list of 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:

ListCallAnalyticsCategories
ListCallAnalyticsJobs
ListLanguageModels
ListMedicalScribeJobs
ListMedicalTranscriptionJobs
ListMedicalVocabularies
ListTranscriptionJobs
ListVocabularies
ListVocabularyFilters

Operations

CreateCallAnalyticsCategory 

$result = $client->createCallAnalyticsCategory([/* ... */]);
$promise = $client->createCallAnalyticsCategoryAsync([/* ... */]);

Creates a new Call Analytics category.

All categories are automatically applied to your Call Analytics transcriptions. Note that in order to apply categories to your transcriptions, you must create them before submitting your transcription request, as categories cannot be applied retroactively.

When creating a new category, you can use the InputType parameter to label the category as a POST_CALL or a REAL_TIME category. POST_CALL categories can only be applied to post-call transcriptions and REAL_TIME categories can only be applied to real-time transcriptions. If you do not include InputType, your category is created as a POST_CALL category by default.

Call Analytics categories are composed of rules. For each category, you must create between 1 and 20 rules. Rules can include these parameters: , , , and .

To update an existing category, see .

To learn more about Call Analytics categories, see Creating categories for post-call transcriptions and Creating categories for real-time transcriptions.

Parameter Syntax

$result = $client->createCallAnalyticsCategory([
    'CategoryName' => '<string>', // REQUIRED
    'InputType' => 'REAL_TIME|POST_CALL',
    'Rules' => [ // REQUIRED
        [
            'InterruptionFilter' => [
                'AbsoluteTimeRange' => [
                    'EndTime' => <integer>,
                    'First' => <integer>,
                    'Last' => <integer>,
                    'StartTime' => <integer>,
                ],
                'Negate' => true || false,
                'ParticipantRole' => 'AGENT|CUSTOMER',
                'RelativeTimeRange' => [
                    'EndPercentage' => <integer>,
                    'First' => <integer>,
                    'Last' => <integer>,
                    'StartPercentage' => <integer>,
                ],
                'Threshold' => <integer>,
            ],
            'NonTalkTimeFilter' => [
                'AbsoluteTimeRange' => [
                    'EndTime' => <integer>,
                    'First' => <integer>,
                    'Last' => <integer>,
                    'StartTime' => <integer>,
                ],
                'Negate' => true || false,
                'RelativeTimeRange' => [
                    'EndPercentage' => <integer>,
                    'First' => <integer>,
                    'Last' => <integer>,
                    'StartPercentage' => <integer>,
                ],
                'Threshold' => <integer>,
            ],
            'SentimentFilter' => [
                'AbsoluteTimeRange' => [
                    'EndTime' => <integer>,
                    'First' => <integer>,
                    'Last' => <integer>,
                    'StartTime' => <integer>,
                ],
                'Negate' => true || false,
                'ParticipantRole' => 'AGENT|CUSTOMER',
                'RelativeTimeRange' => [
                    'EndPercentage' => <integer>,
                    'First' => <integer>,
                    'Last' => <integer>,
                    'StartPercentage' => <integer>,
                ],
                'Sentiments' => ['<string>', ...], // REQUIRED
            ],
            'TranscriptFilter' => [
                'AbsoluteTimeRange' => [
                    'EndTime' => <integer>,
                    'First' => <integer>,
                    'Last' => <integer>,
                    'StartTime' => <integer>,
                ],
                'Negate' => true || false,
                'ParticipantRole' => 'AGENT|CUSTOMER',
                'RelativeTimeRange' => [
                    'EndPercentage' => <integer>,
                    'First' => <integer>,
                    'Last' => <integer>,
                    'StartPercentage' => <integer>,
                ],
                'Targets' => ['<string>', ...], // REQUIRED
                'TranscriptFilterType' => 'EXACT', // REQUIRED
            ],
        ],
        // ...
    ],
]);

Parameter Details

Members
CategoryName
Required: Yes
Type: string

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

Category names are case sensitive.

InputType
Type: string

Choose whether you want to create a real-time or a post-call category for your Call Analytics transcription.

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

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

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

Rules
Required: Yes
Type: Array of Rule structures

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

Result Syntax

[
    'CategoryProperties' => [
        'CategoryName' => '<string>',
        'CreateTime' => <DateTime>,
        'InputType' => 'REAL_TIME|POST_CALL',
        'LastUpdateTime' => <DateTime>,
        'Rules' => [
            [
                'InterruptionFilter' => [
                    'AbsoluteTimeRange' => [
                        'EndTime' => <integer>,
                        'First' => <integer>,
                        'Last' => <integer>,
                        'StartTime' => <integer>,
                    ],
                    'Negate' => true || false,
                    'ParticipantRole' => 'AGENT|CUSTOMER',
                    'RelativeTimeRange' => [
                        'EndPercentage' => <integer>,
                        'First' => <integer>,
                        'Last' => <integer>,
                        'StartPercentage' => <integer>,
                    ],
                    'Threshold' => <integer>,
                ],
                'NonTalkTimeFilter' => [
                    'AbsoluteTimeRange' => [
                        'EndTime' => <integer>,
                        'First' => <integer>,
                        'Last' => <integer>,
                        'StartTime' => <integer>,
                    ],
                    'Negate' => true || false,
                    'RelativeTimeRange' => [
                        'EndPercentage' => <integer>,
                        'First' => <integer>,
                        'Last' => <integer>,
                        'StartPercentage' => <integer>,
                    ],
                    'Threshold' => <integer>,
                ],
                'SentimentFilter' => [
                    'AbsoluteTimeRange' => [
                        'EndTime' => <integer>,
                        'First' => <integer>,
                        'Last' => <integer>,
                        'StartTime' => <integer>,
                    ],
                    'Negate' => true || false,
                    'ParticipantRole' => 'AGENT|CUSTOMER',
                    'RelativeTimeRange' => [
                        'EndPercentage' => <integer>,
                        'First' => <integer>,
                        'Last' => <integer>,
                        'StartPercentage' => <integer>,
                    ],
                    'Sentiments' => ['<string>', ...],
                ],
                'TranscriptFilter' => [
                    'AbsoluteTimeRange' => [
                        'EndTime' => <integer>,
                        'First' => <integer>,
                        'Last' => <integer>,
                        'StartTime' => <integer>,
                    ],
                    'Negate' => true || false,
                    'ParticipantRole' => 'AGENT|CUSTOMER',
                    'RelativeTimeRange' => [
                        'EndPercentage' => <integer>,
                        'First' => <integer>,
                        'Last' => <integer>,
                        'StartPercentage' => <integer>,
                    ],
                    'Targets' => ['<string>', ...],
                    'TranscriptFilterType' => 'EXACT',
                ],
            ],
            // ...
        ],
    ],
]

Result Details

Members
CategoryProperties
Type: CategoryProperties structure

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

Errors

BadRequestException:

Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

LimitExceededException:

You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

InternalFailureException:

There was an internal error. Check the error message, correct the issue, and try your request again.

ConflictException:

A resource already exists with this name. Resource names must be unique within an Amazon Web Services account.

CreateLanguageModel 

$result = $client->createLanguageModel([/* ... */]);
$promise = $client->createLanguageModelAsync([/* ... */]);

Creates a new custom language model.

When creating a new custom language model, you must specify:

  • If you want a Wideband (audio sample rates over 16,000 Hz) or Narrowband (audio sample rates under 16,000 Hz) base model

  • The location of your training and tuning files (this must be an Amazon S3 URI)

  • The language of your model

  • A unique name for your model

Parameter Syntax

$result = $client->createLanguageModel([
    'BaseModelName' => 'NarrowBand|WideBand', // REQUIRED
    'InputDataConfig' => [ // REQUIRED
        'DataAccessRoleArn' => '<string>', // REQUIRED
        'S3Uri' => '<string>', // REQUIRED
        'TuningDataS3Uri' => '<string>',
    ],
    'LanguageCode' => 'en-US|hi-IN|es-US|en-GB|en-AU|de-DE|ja-JP', // REQUIRED
    'ModelName' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
BaseModelName
Required: Yes
Type: string

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

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

InputDataConfig
Required: Yes
Type: InputDataConfig structure

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

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

LanguageCode
Required: Yes
Type: string

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

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

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

ModelName
Required: Yes
Type: string

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

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

Tags
Type: Array of Tag structures

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

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

Result Syntax

[
    'BaseModelName' => 'NarrowBand|WideBand',
    'InputDataConfig' => [
        'DataAccessRoleArn' => '<string>',
        'S3Uri' => '<string>',
        'TuningDataS3Uri' => '<string>',
    ],
    'LanguageCode' => 'en-US|hi-IN|es-US|en-GB|en-AU|de-DE|ja-JP',
    'ModelName' => '<string>',
    'ModelStatus' => 'IN_PROGRESS|FAILED|COMPLETED',
]

Result Details

Members
BaseModelName
Type: string

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

InputDataConfig
Type: InputDataConfig structure

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

LanguageCode
Type: string

The language code you selected for your custom language model.

ModelName
Type: string

The name of your custom language model.

ModelStatus
Type: string

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

Errors

BadRequestException:

Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

LimitExceededException:

You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

InternalFailureException:

There was an internal error. Check the error message, correct the issue, and try your request again.

ConflictException:

A resource already exists with this name. Resource names must be unique within an Amazon Web Services account.

CreateMedicalVocabulary 

$result = $client->createMedicalVocabulary([/* ... */]);
$promise = $client->createMedicalVocabularyAsync([/* ... */]);

Creates a new custom medical vocabulary.

Before creating a new custom medical vocabulary, you must first upload a text file that contains your vocabulary table into an Amazon S3 bucket. Note that this differs from , where you can include a list of terms within your request using the Phrases flag; CreateMedicalVocabulary does not support the Phrases flag and only accepts vocabularies in table format.

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

For more information, see Custom vocabularies.

Parameter Syntax

$result = $client->createMedicalVocabulary([
    'LanguageCode' => 'af-ZA|ar-AE|ar-SA|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ|vi-VN|sv-SE|ab-GE|ast-ES|az-AZ|ba-RU|be-BY|bg-BG|bn-IN|bs-BA|ca-ES|ckb-IQ|ckb-IR|cs-CZ|cy-WL|el-GR|et-ET|eu-ES|fi-FI|gl-ES|gu-IN|ha-NG|hr-HR|hu-HU|hy-AM|is-IS|ka-GE|kab-DZ|kk-KZ|kn-IN|ky-KG|lg-IN|lt-LT|lv-LV|mhr-RU|mi-NZ|mk-MK|ml-IN|mn-MN|mr-IN|mt-MT|no-NO|or-IN|pa-IN|pl-PL|ps-AF|ro-RO|rw-RW|si-LK|sk-SK|sl-SI|so-SO|sr-RS|su-ID|sw-BI|sw-KE|sw-RW|sw-TZ|sw-UG|tl-PH|tt-RU|ug-CN|uk-UA|uz-UZ|wo-SN|zu-ZA', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'VocabularyFileUri' => '<string>', // REQUIRED
    'VocabularyName' => '<string>', // REQUIRED
]);

Parameter Details

Members
LanguageCode
Required: Yes
Type: string

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

Tags
Type: Array of Tag structures

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

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

VocabularyFileUri
Required: Yes
Type: string

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

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

VocabularyName
Required: Yes
Type: string

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

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

Result Syntax

[
    'FailureReason' => '<string>',
    'LanguageCode' => 'af-ZA|ar-AE|ar-SA|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ|vi-VN|sv-SE|ab-GE|ast-ES|az-AZ|ba-RU|be-BY|bg-BG|bn-IN|bs-BA|ca-ES|ckb-IQ|ckb-IR|cs-CZ|cy-WL|el-GR|et-ET|eu-ES|fi-FI|gl-ES|gu-IN|ha-NG|hr-HR|hu-HU|hy-AM|is-IS|ka-GE|kab-DZ|kk-KZ|kn-IN|ky-KG|lg-IN|lt-LT|lv-LV|mhr-RU|mi-NZ|mk-MK|ml-IN|mn-MN|mr-IN|mt-MT|no-NO|or-IN|pa-IN|pl-PL|ps-AF|ro-RO|rw-RW|si-LK|sk-SK|sl-SI|so-SO|sr-RS|su-ID|sw-BI|sw-KE|sw-RW|sw-TZ|sw-UG|tl-PH|tt-RU|ug-CN|uk-UA|uz-UZ|wo-SN|zu-ZA',
    'LastModifiedTime' => <DateTime>,
    'VocabularyName' => '<string>',
    'VocabularyState' => 'PENDING|READY|FAILED',
]

Result Details

Members
FailureReason
Type: string

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

LanguageCode
Type: string

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

LastModifiedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time you created your custom medical vocabulary.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.

VocabularyName
Type: string

The name you chose for your custom medical vocabulary.

VocabularyState
Type: string

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

Errors

BadRequestException:

Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

LimitExceededException:

You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

InternalFailureException:

There was an internal error. Check the error message, correct the issue, and try your request again.

ConflictException:

A resource already exists with this name. Resource names must be unique within an Amazon Web Services account.

CreateVocabulary 

$result = $client->createVocabulary([/* ... */]);
$promise = $client->createVocabularyAsync([/* ... */]);

Creates a new custom vocabulary.

When creating a new custom vocabulary, you can either upload a text file that contains your new entries, phrases, and terms into an Amazon S3 bucket and include the URI in your request. Or you can include a list of terms directly in your request using the Phrases flag.

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

For more information, see Custom vocabularies.

Parameter Syntax

$result = $client->createVocabulary([
    'DataAccessRoleArn' => '<string>',
    'LanguageCode' => 'af-ZA|ar-AE|ar-SA|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ|vi-VN|sv-SE|ab-GE|ast-ES|az-AZ|ba-RU|be-BY|bg-BG|bn-IN|bs-BA|ca-ES|ckb-IQ|ckb-IR|cs-CZ|cy-WL|el-GR|et-ET|eu-ES|fi-FI|gl-ES|gu-IN|ha-NG|hr-HR|hu-HU|hy-AM|is-IS|ka-GE|kab-DZ|kk-KZ|kn-IN|ky-KG|lg-IN|lt-LT|lv-LV|mhr-RU|mi-NZ|mk-MK|ml-IN|mn-MN|mr-IN|mt-MT|no-NO|or-IN|pa-IN|pl-PL|ps-AF|ro-RO|rw-RW|si-LK|sk-SK|sl-SI|so-SO|sr-RS|su-ID|sw-BI|sw-KE|sw-RW|sw-TZ|sw-UG|tl-PH|tt-RU|ug-CN|uk-UA|uz-UZ|wo-SN|zu-ZA', // REQUIRED
    'Phrases' => ['<string>', ...],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'VocabularyFileUri' => '<string>',
    'VocabularyName' => '<string>', // REQUIRED
]);

Parameter Details

Members
DataAccessRoleArn
Type: string

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

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

For more information, see IAM ARNs.

LanguageCode
Required: Yes
Type: string

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

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

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

Phrases
Type: Array of strings

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

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

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

Tags
Type: Array of Tag structures

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

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

VocabularyFileUri
Type: string

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

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

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

VocabularyName
Required: Yes
Type: string

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

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

Result Syntax

[
    'FailureReason' => '<string>',
    'LanguageCode' => 'af-ZA|ar-AE|ar-SA|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ|vi-VN|sv-SE|ab-GE|ast-ES|az-AZ|ba-RU|be-BY|bg-BG|bn-IN|bs-BA|ca-ES|ckb-IQ|ckb-IR|cs-CZ|cy-WL|el-GR|et-ET|eu-ES|fi-FI|gl-ES|gu-IN|ha-NG|hr-HR|hu-HU|hy-AM|is-IS|ka-GE|kab-DZ|kk-KZ|kn-IN|ky-KG|lg-IN|lt-LT|lv-LV|mhr-RU|mi-NZ|mk-MK|ml-IN|mn-MN|mr-IN|mt-MT|no-NO|or-IN|pa-IN|pl-PL|ps-AF|ro-RO|rw-RW|si-LK|sk-SK|sl-SI|so-SO|sr-RS|su-ID|sw-BI|sw-KE|sw-RW|sw-TZ|sw-UG|tl-PH|tt-RU|ug-CN|uk-UA|uz-UZ|wo-SN|zu-ZA',
    'LastModifiedTime' => <DateTime>,
    'VocabularyName' => '<string>',
    'VocabularyState' => 'PENDING|READY|FAILED',
]

Result Details

Members
FailureReason
Type: string

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

LanguageCode
Type: string

The language code you selected for your custom vocabulary.

LastModifiedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time you created your custom vocabulary.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.

VocabularyName
Type: string

The name you chose for your custom vocabulary.

VocabularyState
Type: string

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

Errors

BadRequestException:

Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

LimitExceededException:

You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

InternalFailureException:

There was an internal error. Check the error message, correct the issue, and try your request again.

ConflictException:

A resource already exists with this name. Resource names must be unique within an Amazon Web Services account.

CreateVocabularyFilter 

$result = $client->createVocabularyFilter([/* ... */]);
$promise = $client->createVocabularyFilterAsync([/* ... */]);

Creates a new custom vocabulary filter.

You can use custom vocabulary filters to mask, delete, or flag specific words from your transcript. Custom vocabulary filters are commonly used to mask profanity in transcripts.

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

For more information, see Vocabulary filtering.

Parameter Syntax

$result = $client->createVocabularyFilter([
    'DataAccessRoleArn' => '<string>',
    'LanguageCode' => 'af-ZA|ar-AE|ar-SA|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ|vi-VN|sv-SE|ab-GE|ast-ES|az-AZ|ba-RU|be-BY|bg-BG|bn-IN|bs-BA|ca-ES|ckb-IQ|ckb-IR|cs-CZ|cy-WL|el-GR|et-ET|eu-ES|fi-FI|gl-ES|gu-IN|ha-NG|hr-HR|hu-HU|hy-AM|is-IS|ka-GE|kab-DZ|kk-KZ|kn-IN|ky-KG|lg-IN|lt-LT|lv-LV|mhr-RU|mi-NZ|mk-MK|ml-IN|mn-MN|mr-IN|mt-MT|no-NO|or-IN|pa-IN|pl-PL|ps-AF|ro-RO|rw-RW|si-LK|sk-SK|sl-SI|so-SO|sr-RS|su-ID|sw-BI|sw-KE|sw-RW|sw-TZ|sw-UG|tl-PH|tt-RU|ug-CN|uk-UA|uz-UZ|wo-SN|zu-ZA', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'VocabularyFilterFileUri' => '<string>',
    'VocabularyFilterName' => '<string>', // REQUIRED
    'Words' => ['<string>', ...],
]);

Parameter Details

Members
DataAccessRoleArn
Type: string

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

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

For more information, see IAM ARNs.

LanguageCode
Required: Yes
Type: string

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

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

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

Tags
Type: Array of Tag structures

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

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

VocabularyFilterFileUri
Type: string

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

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

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

VocabularyFilterName
Required: Yes
Type: string

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

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

Words
Type: Array of strings

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

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

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

Result Syntax

[
    'LanguageCode' => 'af-ZA|ar-AE|ar-SA|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ|vi-VN|sv-SE|ab-GE|ast-ES|az-AZ|ba-RU|be-BY|bg-BG|bn-IN|bs-BA|ca-ES|ckb-IQ|ckb-IR|cs-CZ|cy-WL|el-GR|et-ET|eu-ES|fi-FI|gl-ES|gu-IN|ha-NG|hr-HR|hu-HU|hy-AM|is-IS|ka-GE|kab-DZ|kk-KZ|kn-IN|ky-KG|lg-IN|lt-LT|lv-LV|mhr-RU|mi-NZ|mk-MK|ml-IN|mn-MN|mr-IN|mt-MT|no-NO|or-IN|pa-IN|pl-PL|ps-AF|ro-RO|rw-RW|si-LK|sk-SK|sl-SI|so-SO|sr-RS|su-ID|sw-BI|sw-KE|sw-RW|sw-TZ|sw-UG|tl-PH|tt-RU|ug-CN|uk-UA|uz-UZ|wo-SN|zu-ZA',
    'LastModifiedTime' => <DateTime>,
    'VocabularyFilterName' => '<string>',
]

Result Details

Members
LanguageCode
Type: string

The language code you selected for your custom vocabulary filter.

LastModifiedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time you created your custom vocabulary filter.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.

VocabularyFilterName
Type: string

The name you chose for your custom vocabulary filter.

Errors

BadRequestException:

Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

LimitExceededException:

You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

InternalFailureException:

There was an internal error. Check the error message, correct the issue, and try your request again.

ConflictException:

A resource already exists with this name. Resource names must be unique within an Amazon Web Services account.

DeleteCallAnalyticsCategory 

$result = $client->deleteCallAnalyticsCategory([/* ... */]);
$promise = $client->deleteCallAnalyticsCategoryAsync([/* ... */]);

Deletes a Call Analytics category. To use this operation, specify the name of the category you want to delete using CategoryName. Category names are case sensitive.

Parameter Syntax

$result = $client->deleteCallAnalyticsCategory([
    'CategoryName' => '<string>', // REQUIRED
]);

Parameter Details

Members
CategoryName
Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

NotFoundException:

We can't find the requested resource. Check that the specified name is correct and try your request again.

LimitExceededException:

You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

BadRequestException:

Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

InternalFailureException:

There was an internal error. Check the error message, correct the issue, and try your request again.

DeleteCallAnalyticsJob 

$result = $client->deleteCallAnalyticsJob([/* ... */]);
$promise = $client->deleteCallAnalyticsJobAsync([/* ... */]);

Deletes a Call Analytics job. To use this operation, specify the name of the job you want to delete using CallAnalyticsJobName. Job names are case sensitive.

Parameter Syntax

$result = $client->deleteCallAnalyticsJob([
    'CallAnalyticsJobName' => '<string>', // REQUIRED
]);

Parameter Details

Members
CallAnalyticsJobName
Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

LimitExceededException:

You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

BadRequestException:

Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

InternalFailureException:

There was an internal error. Check the error message, correct the issue, and try your request again.

DeleteLanguageModel 

$result = $client->deleteLanguageModel([/* ... */]);
$promise = $client->deleteLanguageModelAsync([/* ... */]);

Deletes a custom language model. To use this operation, specify the name of the language model you want to delete using ModelName. custom language model names are case sensitive.

Parameter Syntax

$result = $client->deleteLanguageModel([
    'ModelName' => '<string>', // REQUIRED
]);

Parameter Details

Members
ModelName
Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

BadRequestException:

Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

LimitExceededException:

You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

InternalFailureException:

There was an internal error. Check the error message, correct the issue, and try your request again.

DeleteMedicalScribeJob 

$result = $client->deleteMedicalScribeJob([/* ... */]);
$promise = $client->deleteMedicalScribeJobAsync([/* ... */]);

Deletes a Medical Scribe job. To use this operation, specify the name of the job you want to delete using MedicalScribeJobName. Job names are case sensitive.

Parameter Syntax

$result = $client->deleteMedicalScribeJob([
    'MedicalScribeJobName' => '<string>', // REQUIRED
]);

Parameter Details

Members
MedicalScribeJobName
Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

LimitExceededException:

You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

BadRequestException:

Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

InternalFailureException:

There was an internal error. Check the error message, correct the issue, and try your request again.

DeleteMedicalTranscriptionJob 

$result = $client->deleteMedicalTranscriptionJob([/* ... */]);
$promise = $client->deleteMedicalTranscriptionJobAsync([/* ... */]);

Deletes a medical transcription job. To use this operation, specify the name of the job you want to delete using MedicalTranscriptionJobName. Job names are case sensitive.

Parameter Syntax

$result = $client->deleteMedicalTranscriptionJob([
    'MedicalTranscriptionJobName' => '<string>', // REQUIRED
]);

Parameter Details

Members
MedicalTranscriptionJobName
Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

LimitExceededException:

You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

BadRequestException:

Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

InternalFailureException:

There was an internal error. Check the error message, correct the issue, and try your request again.

DeleteMedicalVocabulary 

$result = $client->deleteMedicalVocabulary([/* ... */]);
$promise = $client->deleteMedicalVocabularyAsync([/* ... */]);

Deletes a custom medical vocabulary. To use this operation, specify the name of the custom vocabulary you want to delete using VocabularyName. Custom vocabulary names are case sensitive.

Parameter Syntax

$result = $client->deleteMedicalVocabulary([
    'VocabularyName' => '<string>', // REQUIRED
]);

Parameter Details

Members
VocabularyName
Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

NotFoundException:

We can't find the requested resource. Check that the specified name is correct and try your request again.

LimitExceededException:

You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

BadRequestException:

Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

InternalFailureException:

There was an internal error. Check the error message, correct the issue, and try your request again.

DeleteTranscriptionJob 

$result = $client->deleteTranscriptionJob([/* ... */]);
$promise = $client->deleteTranscriptionJobAsync([/* ... */]);

Deletes a transcription job. To use this operation, specify the name of the job you want to delete using TranscriptionJobName. Job names are case sensitive.

Parameter Syntax

$result = $client->deleteTranscriptionJob([
    'TranscriptionJobName' => '<string>', // REQUIRED
]);

Parameter Details

Members
TranscriptionJobName
Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

LimitExceededException:

You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

BadRequestException:

Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

InternalFailureException:

There was an internal error. Check the error message, correct the issue, and try your request again.

DeleteVocabulary 

$result = $client->deleteVocabulary([/* ... */]);
$promise = $client->deleteVocabularyAsync([/* ... */]);

Deletes a custom vocabulary. To use this operation, specify the name of the custom vocabulary you want to delete using VocabularyName. Custom vocabulary names are case sensitive.

Parameter Syntax

$result = $client->deleteVocabulary([
    'VocabularyName' => '<string>', // REQUIRED
]);

Parameter Details

Members
VocabularyName
Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

NotFoundException:

We can't find the requested resource. Check that the specified name is correct and try your request again.

LimitExceededException:

You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

BadRequestException:

Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

InternalFailureException:

There was an internal error. Check the error message, correct the issue, and try your request again.

DeleteVocabularyFilter 

$result = $client->deleteVocabularyFilter([/* ... */]);
$promise = $client->deleteVocabularyFilterAsync([/* ... */]);

Deletes a custom vocabulary filter. To use this operation, specify the name of the custom vocabulary filter you want to delete using VocabularyFilterName. Custom vocabulary filter names are case sensitive.

Parameter Syntax

$result = $client->deleteVocabularyFilter([
    'VocabularyFilterName' => '<string>', // REQUIRED
]);

Parameter Details

Members
VocabularyFilterName
Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

NotFoundException:

We can't find the requested resource. Check that the specified name is correct and try your request again.

LimitExceededException:

You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

BadRequestException:

Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

InternalFailureException:

There was an internal error. Check the error message, correct the issue, and try your request again.

DescribeLanguageModel 

$result = $client->describeLanguageModel([/* ... */]);
$promise = $client->describeLanguageModelAsync([/* ... */]);

Provides information about the specified custom language model.

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

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

Parameter Syntax

$result = $client->describeLanguageModel([
    'ModelName' => '<string>', // REQUIRED
]);

Parameter Details

Members
ModelName
Required: Yes
Type: string

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

Result Syntax

[
    'LanguageModel' => [
        'BaseModelName' => 'NarrowBand|WideBand',
        'CreateTime' => <DateTime>,
        'FailureReason' => '<string>',
        'InputDataConfig' => [
            'DataAccessRoleArn' => '<string>',
            'S3Uri' => '<string>',
            'TuningDataS3Uri' => '<string>',
        ],
        'LanguageCode' => 'en-US|hi-IN|es-US|en-GB|en-AU|de-DE|ja-JP',
        'LastModifiedTime' => <DateTime>,
        'ModelName' => '<string>',
        'ModelStatus' => 'IN_PROGRESS|FAILED|COMPLETED',
        'UpgradeAvailability' => true || false,
    ],
]

Result Details

Members
LanguageModel
Type: LanguageModel structure

Provides information about the specified custom language model.

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

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

Errors

BadRequestException:

Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

LimitExceededException:

You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

InternalFailureException:

There was an internal error. Check the error message, correct the issue, and try your request again.

NotFoundException:

We can't find the requested resource. Check that the specified name is correct and try your request again.

GetCallAnalyticsCategory 

$result = $client->getCallAnalyticsCategory([/* ... */]);
$promise = $client->getCallAnalyticsCategoryAsync([/* ... */]);

Provides information about the specified Call Analytics category.

To get a list of your Call Analytics categories, use the operation.

Parameter Syntax

$result = $client->getCallAnalyticsCategory([
    'CategoryName' => '<string>', // REQUIRED
]);

Parameter Details

Members
CategoryName
Required: Yes
Type: string

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

Result Syntax

[
    'CategoryProperties' => [
        'CategoryName' => '<string>',
        'CreateTime' => <DateTime>,
        'InputType' => 'REAL_TIME|POST_CALL',
        'LastUpdateTime' => <DateTime>,
        'Rules' => [
            [
                'InterruptionFilter' => [
                    'AbsoluteTimeRange' => [
                        'EndTime' => <integer>,
                        'First' => <integer>,
                        'Last' => <integer>,
                        'StartTime' => <integer>,
                    ],
                    'Negate' => true || false,
                    'ParticipantRole' => 'AGENT|CUSTOMER',
                    'RelativeTimeRange' => [
                        'EndPercentage' => <integer>,
                        'First' => <integer>,
                        'Last' => <integer>,
                        'StartPercentage' => <integer>,
                    ],
                    'Threshold' => <integer>,
                ],
                'NonTalkTimeFilter' => [
                    'AbsoluteTimeRange' => [
                        'EndTime' => <integer>,
                        'First' => <integer>,
                        'Last' => <integer>,
                        'StartTime' => <integer>,
                    ],
                    'Negate' => true || false,
                    'RelativeTimeRange' => [
                        'EndPercentage' => <integer>,
                        'First' => <integer>,
                        'Last' => <integer>,
                        'StartPercentage' => <integer>,
                    ],
                    'Threshold' => <integer>,
                ],
                'SentimentFilter' => [
                    'AbsoluteTimeRange' => [
                        'EndTime' => <integer>,
                        'First' => <integer>,
                        'Last' => <integer>,
                        'StartTime' => <integer>,
                    ],
                    'Negate' => true || false,
                    'ParticipantRole' => 'AGENT|CUSTOMER',
                    'RelativeTimeRange' => [
                        'EndPercentage' => <integer>,
                        'First' => <integer>,
                        'Last' => <integer>,
                        'StartPercentage' => <integer>,
                    ],
                    'Sentiments' => ['<string>', ...],
                ],
                'TranscriptFilter' => [
                    'AbsoluteTimeRange' => [
                        'EndTime' => <integer>,
                        'First' => <integer>,
                        'Last' => <integer>,
                        'StartTime' => <integer>,
                    ],
                    'Negate' => true || false,
                    'ParticipantRole' => 'AGENT|CUSTOMER',
                    'RelativeTimeRange' => [
                        'EndPercentage' => <integer>,
                        'First' => <integer>,
                        'Last' => <integer>,
                        'StartPercentage' => <integer>,
                    ],
                    'Targets' => ['<string>', ...],
                    'TranscriptFilterType' => 'EXACT',
                ],
            ],
            // ...
        ],
    ],
]

Result Details

Members
CategoryProperties
Type: CategoryProperties structure

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

Errors

NotFoundException:

We can't find the requested resource. Check that the specified name is correct and try your request again.

LimitExceededException:

You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

InternalFailureException:

There was an internal error. Check the error message, correct the issue, and try your request again.

BadRequestException:

Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

GetCallAnalyticsJob 

$result = $client->getCallAnalyticsJob([/* ... */]);
$promise = $client->getCallAnalyticsJobAsync([/* ... */]);

Provides information about the specified Call Analytics job.

To view the job's status, refer to CallAnalyticsJobStatus. If the status is COMPLETED, the job is finished. You can find your completed transcript at the URI specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed.

If you enabled personally identifiable information (PII) redaction, the redacted transcript appears at the location specified in RedactedTranscriptFileUri.

If you chose to redact the audio in your media file, you can find your redacted media file at the location specified in RedactedMediaFileUri.

To get a list of your Call Analytics jobs, use the operation.

Parameter Syntax

$result = $client->getCallAnalyticsJob([
    'CallAnalyticsJobName' => '<string>', // REQUIRED
]);

Parameter Details

Members
CallAnalyticsJobName
Required: Yes
Type: string

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

Result Syntax

[
    'CallAnalyticsJob' => [
        'CallAnalyticsJobDetails' => [
            'Skipped' => [
                [
                    'Feature' => 'GENERATIVE_SUMMARIZATION',
                    'Message' => '<string>',
                    'ReasonCode' => 'INSUFFICIENT_CONVERSATION_CONTENT|FAILED_SAFETY_GUIDELINES',
                ],
                // ...
            ],
        ],
        'CallAnalyticsJobName' => '<string>',
        'CallAnalyticsJobStatus' => 'QUEUED|IN_PROGRESS|FAILED|COMPLETED',
        'ChannelDefinitions' => [
            [
                'ChannelId' => <integer>,
                'ParticipantRole' => 'AGENT|CUSTOMER',
            ],
            // ...
        ],
        'CompletionTime' => <DateTime>,
        'CreationTime' => <DateTime>,
        'DataAccessRoleArn' => '<string>',
        'FailureReason' => '<string>',
        'IdentifiedLanguageScore' => <float>,
        'LanguageCode' => 'af-ZA|ar-AE|ar-SA|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ|vi-VN|sv-SE|ab-GE|ast-ES|az-AZ|ba-RU|be-BY|bg-BG|bn-IN|bs-BA|ca-ES|ckb-IQ|ckb-IR|cs-CZ|cy-WL|el-GR|et-ET|eu-ES|fi-FI|gl-ES|gu-IN|ha-NG|hr-HR|hu-HU|hy-AM|is-IS|ka-GE|kab-DZ|kk-KZ|kn-IN|ky-KG|lg-IN|lt-LT|lv-LV|mhr-RU|mi-NZ|mk-MK|ml-IN|mn-MN|mr-IN|mt-MT|no-NO|or-IN|pa-IN|pl-PL|ps-AF|ro-RO|rw-RW|si-LK|sk-SK|sl-SI|so-SO|sr-RS|su-ID|sw-BI|sw-KE|sw-RW|sw-TZ|sw-UG|tl-PH|tt-RU|ug-CN|uk-UA|uz-UZ|wo-SN|zu-ZA',
        'Media' => [
            'MediaFileUri' => '<string>',
            'RedactedMediaFileUri' => '<string>',
        ],
        'MediaFormat' => 'mp3|mp4|wav|flac|ogg|amr|webm|m4a',
        'MediaSampleRateHertz' => <integer>,
        'Settings' => [
            'ContentRedaction' => [
                'PiiEntityTypes' => ['<string>', ...],
                'RedactionOutput' => 'redacted|redacted_and_unredacted',
                'RedactionType' => 'PII',
            ],
            'LanguageIdSettings' => [
                '<LanguageCode>' => [
                    'LanguageModelName' => '<string>',
                    'VocabularyFilterName' => '<string>',
                    'VocabularyName' => '<string>',
                ],
                // ...
            ],
            'LanguageModelName' => '<string>',
            'LanguageOptions' => ['<string>', ...],
            'Summarization' => [
                'GenerateAbstractiveSummary' => true || false,
            ],
            'VocabularyFilterMethod' => 'remove|mask|tag',
            'VocabularyFilterName' => '<string>',
            'VocabularyName' => '<string>',
        ],
        'StartTime' => <DateTime>,
        'Transcript' => [
            'RedactedTranscriptFileUri' => '<string>',
            'TranscriptFileUri' => '<string>',
        ],
    ],
]

Result Details

Members
CallAnalyticsJob
Type: CallAnalyticsJob structure

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

Errors

BadRequestException:

Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

LimitExceededException:

You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

InternalFailureException:

There was an internal error. Check the error message, correct the issue, and try your request again.

NotFoundException:

We can't find the requested resource. Check that the specified name is correct and try your request again.

GetMedicalScribeJob 

$result = $client->getMedicalScribeJob([/* ... */]);
$promise = $client->getMedicalScribeJobAsync([/* ... */]);

Provides information about the specified Medical Scribe job.

To view the status of the specified medical transcription job, check the MedicalScribeJobStatus field. If the status is COMPLETED, the job is finished. You can find the results at the location specified in MedicalScribeOutput. If the status is FAILED, FailureReason provides details on why your Medical Scribe job failed.

To get a list of your Medical Scribe jobs, use the operation.

Parameter Syntax

$result = $client->getMedicalScribeJob([
    'MedicalScribeJobName' => '<string>', // REQUIRED
]);

Parameter Details

Members
MedicalScribeJobName
Required: Yes
Type: string

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

Result Syntax

[
    'MedicalScribeJob' => [
        'ChannelDefinitions' => [
            [
                'ChannelId' => <integer>,
                'ParticipantRole' => 'PATIENT|CLINICIAN',
            ],
            // ...
        ],
        'CompletionTime' => <DateTime>,
        'CreationTime' => <DateTime>,
        'DataAccessRoleArn' => '<string>',
        'FailureReason' => '<string>',
        'LanguageCode' => 'en-US',
        'Media' => [
            'MediaFileUri' => '<string>',
            'RedactedMediaFileUri' => '<string>',
        ],
        'MedicalScribeJobName' => '<string>',
        'MedicalScribeJobStatus' => 'QUEUED|IN_PROGRESS|FAILED|COMPLETED',
        'MedicalScribeOutput' => [
            'ClinicalDocumentUri' => '<string>',
            'TranscriptFileUri' => '<string>',
        ],
        'Settings' => [
            'ChannelIdentification' => true || false,
            'MaxSpeakerLabels' => <integer>,
            'ShowSpeakerLabels' => true || false,
            'VocabularyFilterMethod' => 'remove|mask|tag',
            'VocabularyFilterName' => '<string>',
            'VocabularyName' => '<string>',
        ],
        'StartTime' => <DateTime>,
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
MedicalScribeJob
Type: MedicalScribeJob structure

Provides detailed information about the specified Medical Scribe job, including job status and, if applicable, failure reason

Errors

BadRequestException:

Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

LimitExceededException:

You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

InternalFailureException:

There was an internal error. Check the error message, correct the issue, and try your request again.

NotFoundException:

We can't find the requested resource. Check that the specified name is correct and try your request again.

GetMedicalTranscriptionJob 

$result = $client->getMedicalTranscriptionJob([/* ... */]);
$promise = $client->getMedicalTranscriptionJobAsync([/* ... */]);

Provides information about the specified medical transcription job.

To view the status of the specified medical transcription job, check the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished. You can find the results at the location specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed.

To get a list of your medical transcription jobs, use the operation.

Parameter Syntax

$result = $client->getMedicalTranscriptionJob([
    'MedicalTranscriptionJobName' => '<string>', // REQUIRED
]);

Parameter Details

Members
MedicalTranscriptionJobName
Required: Yes
Type: string

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

Result Syntax

[
    'MedicalTranscriptionJob' => [
        'CompletionTime' => <DateTime>,
        'ContentIdentificationType' => 'PHI',
        'CreationTime' => <DateTime>,
        'FailureReason' => '<string>',
        'LanguageCode' => 'af-ZA|ar-AE|ar-SA|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ|vi-VN|sv-SE|ab-GE|ast-ES|az-AZ|ba-RU|be-BY|bg-BG|bn-IN|bs-BA|ca-ES|ckb-IQ|ckb-IR|cs-CZ|cy-WL|el-GR|et-ET|eu-ES|fi-FI|gl-ES|gu-IN|ha-NG|hr-HR|hu-HU|hy-AM|is-IS|ka-GE|kab-DZ|kk-KZ|kn-IN|ky-KG|lg-IN|lt-LT|lv-LV|mhr-RU|mi-NZ|mk-MK|ml-IN|mn-MN|mr-IN|mt-MT|no-NO|or-IN|pa-IN|pl-PL|ps-AF|ro-RO|rw-RW|si-LK|sk-SK|sl-SI|so-SO|sr-RS|su-ID|sw-BI|sw-KE|sw-RW|sw-TZ|sw-UG|tl-PH|tt-RU|ug-CN|uk-UA|uz-UZ|wo-SN|zu-ZA',
        'Media' => [
            'MediaFileUri' => '<string>',
            'RedactedMediaFileUri' => '<string>',
        ],
        'MediaFormat' => 'mp3|mp4|wav|flac|ogg|amr|webm|m4a',
        'MediaSampleRateHertz' => <integer>,
        'MedicalTranscriptionJobName' => '<string>',
        'Settings' => [
            'ChannelIdentification' => true || false,
            'MaxAlternatives' => <integer>,
            'MaxSpeakerLabels' => <integer>,
            'ShowAlternatives' => true || false,
            'ShowSpeakerLabels' => true || false,
            'VocabularyName' => '<string>',
        ],
        'Specialty' => 'PRIMARYCARE',
        'StartTime' => <DateTime>,
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Transcript' => [
            'TranscriptFileUri' => '<string>',
        ],
        'TranscriptionJobStatus' => 'QUEUED|IN_PROGRESS|FAILED|COMPLETED',
        'Type' => 'CONVERSATION|DICTATION',
    ],
]

Result Details

Members
MedicalTranscriptionJob
Type: MedicalTranscriptionJob structure

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

Errors

BadRequestException:

Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

LimitExceededException:

You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

InternalFailureException:

There was an internal error. Check the error message, correct the issue, and try your request again.

NotFoundException:

We can't find the requested resource. Check that the specified name is correct and try your request again.

GetMedicalVocabulary 

$result = $client->getMedicalVocabulary([/* ... */]);
$promise = $client->getMedicalVocabularyAsync([/* ... */]);

Provides information about the specified custom medical vocabulary.

To view the status of the specified custom medical vocabulary, check the VocabularyState field. If the status is READY, your custom vocabulary is available to use. If the status is FAILED, FailureReason provides details on why your vocabulary failed.

To get a list of your custom medical vocabularies, use the operation.

Parameter Syntax

$result = $client->getMedicalVocabulary([
    'VocabularyName' => '<string>', // REQUIRED
]);

Parameter Details

Members
VocabularyName
Required: Yes
Type: string

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

Result Syntax

[
    'DownloadUri' => '<string>',
    'FailureReason' => '<string>',
    'LanguageCode' => 'af-ZA|ar-AE|ar-SA|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ|vi-VN|sv-SE|ab-GE|ast-ES|az-AZ|ba-RU|be-BY|bg-BG|bn-IN|bs-BA|ca-ES|ckb-IQ|ckb-IR|cs-CZ|cy-WL|el-GR|et-ET|eu-ES|fi-FI|gl-ES|gu-IN|ha-NG|hr-HR|hu-HU|hy-AM|is-IS|ka-GE|kab-DZ|kk-KZ|kn-IN|ky-KG|lg-IN|lt-LT|lv-LV|mhr-RU|mi-NZ|mk-MK|ml-IN|mn-MN|mr-IN|mt-MT|no-NO|or-IN|pa-IN|pl-PL|ps-AF|ro-RO|rw-RW|si-LK|sk-SK|sl-SI|so-SO|sr-RS|su-ID|sw-BI|sw-KE|sw-RW|sw-TZ|sw-UG|tl-PH|tt-RU|ug-CN|uk-UA|uz-UZ|wo-SN|zu-ZA',
    'LastModifiedTime' => <DateTime>,
    'VocabularyName' => '<string>',
    'VocabularyState' => 'PENDING|READY|FAILED',
]

Result Details

Members
DownloadUri
Type: string

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

FailureReason
Type: string

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

LanguageCode
Type: string

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

LastModifiedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.

VocabularyName
Type: string

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

VocabularyState
Type: string

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

Errors

NotFoundException:

We can't find the requested resource. Check that the specified name is correct and try your request again.

LimitExceededException:

You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

InternalFailureException:

There was an internal error. Check the error message, correct the issue, and try your request again.

BadRequestException:

Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

GetTranscriptionJob 

$result = $client->getTranscriptionJob([/* ... */]);
$promise = $client->getTranscriptionJobAsync([/* ... */]);

Provides information about the specified transcription job.

To view the status of the specified transcription job, check the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished. You can find the results at the location specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed.

If you enabled content redaction, the redacted transcript can be found at the location specified in RedactedTranscriptFileUri.

To get a list of your transcription jobs, use the operation.

Parameter Syntax

$result = $client->getTranscriptionJob([
    'TranscriptionJobName' => '<string>', // REQUIRED
]);

Parameter Details

Members
TranscriptionJobName
Required: Yes
Type: string

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

Result Syntax

[
    'TranscriptionJob' => [
        'CompletionTime' => <DateTime>,
        'ContentRedaction' => [
            'PiiEntityTypes' => ['<string>', ...],
            'RedactionOutput' => 'redacted|redacted_and_unredacted',
            'RedactionType' => 'PII',
        ],
        'CreationTime' => <DateTime>,
        'FailureReason' => '<string>',
        'IdentifiedLanguageScore' => <float>,
        'IdentifyLanguage' => true || false,
        'IdentifyMultipleLanguages' => true || false,
        'JobExecutionSettings' => [
            'AllowDeferredExecution' => true || false,
            'DataAccessRoleArn' => '<string>',
        ],
        'LanguageCode' => 'af-ZA|ar-AE|ar-SA|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ|vi-VN|sv-SE|ab-GE|ast-ES|az-AZ|ba-RU|be-BY|bg-BG|bn-IN|bs-BA|ca-ES|ckb-IQ|ckb-IR|cs-CZ|cy-WL|el-GR|et-ET|eu-ES|fi-FI|gl-ES|gu-IN|ha-NG|hr-HR|hu-HU|hy-AM|is-IS|ka-GE|kab-DZ|kk-KZ|kn-IN|ky-KG|lg-IN|lt-LT|lv-LV|mhr-RU|mi-NZ|mk-MK|ml-IN|mn-MN|mr-IN|mt-MT|no-NO|or-IN|pa-IN|pl-PL|ps-AF|ro-RO|rw-RW|si-LK|sk-SK|sl-SI|so-SO|sr-RS|su-ID|sw-BI|sw-KE|sw-RW|sw-TZ|sw-UG|tl-PH|tt-RU|ug-CN|uk-UA|uz-UZ|wo-SN|zu-ZA',
        'LanguageCodes' => [
            [
                'DurationInSeconds' => <float>,
                'LanguageCode' => 'af-ZA|ar-AE|ar-SA|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ|vi-VN|sv-SE|ab-GE|ast-ES|az-AZ|ba-RU|be-BY|bg-BG|bn-IN|bs-BA|ca-ES|ckb-IQ|ckb-IR|cs-CZ|cy-WL|el-GR|et-ET|eu-ES|fi-FI|gl-ES|gu-IN|ha-NG|hr-HR|hu-HU|hy-AM|is-IS|ka-GE|kab-DZ|kk-KZ|kn-IN|ky-KG|lg-IN|lt-LT|lv-LV|mhr-RU|mi-NZ|mk-MK|ml-IN|mn-MN|mr-IN|mt-MT|no-NO|or-IN|pa-IN|pl-PL|ps-AF|ro-RO|rw-RW|si-LK|sk-SK|sl-SI|so-SO|sr-RS|su-ID|sw-BI|sw-KE|sw-RW|sw-TZ|sw-UG|tl-PH|tt-RU|ug-CN|uk-UA|uz-UZ|wo-SN|zu-ZA',
            ],
            // ...
        ],
        'LanguageIdSettings' => [
            '<LanguageCode>' => [
                'LanguageModelName' => '<string>',
                'VocabularyFilterName' => '<string>',
                'VocabularyName' => '<string>',
            ],
            // ...
        ],
        'LanguageOptions' => ['<string>', ...],
        'Media' => [
            'MediaFileUri' => '<string>',
            'RedactedMediaFileUri' => '<string>',
        ],
        'MediaFormat' => 'mp3|mp4|wav|flac|ogg|amr|webm|m4a',
        'MediaSampleRateHertz' => <integer>,
        'ModelSettings' => [
            'LanguageModelName' => '<string>',
        ],
        'Settings' => [
            'ChannelIdentification' => true || false,
            'MaxAlternatives' => <integer>,
            'MaxSpeakerLabels' => <integer>,
            'ShowAlternatives' => true || false,
            'ShowSpeakerLabels' => true || false,
            'VocabularyFilterMethod' => 'remove|mask|tag',
            'VocabularyFilterName' => '<string>',
            'VocabularyName' => '<string>',
        ],
        'StartTime' => <DateTime>,
        'Subtitles' => [
            'Formats' => ['<string>', ...],
            'OutputStartIndex' => <integer>,
            'SubtitleFileUris' => ['<string>', ...],
        ],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ToxicityDetection' => [
            [
                'ToxicityCategories' => ['<string>', ...],
            ],
            // ...
        ],
        'Transcript' => [
            'RedactedTranscriptFileUri' => '<string>',
            'TranscriptFileUri' => '<string>',
        ],
        'TranscriptionJobName' => '<string>',
        'TranscriptionJobStatus' => 'QUEUED|IN_PROGRESS|FAILED|COMPLETED',
    ],
]

Result Details

Members
TranscriptionJob
Type: TranscriptionJob structure

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

Errors

BadRequestException:

Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

LimitExceededException:

You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

InternalFailureException:

There was an internal error. Check the error message, correct the issue, and try your request again.

NotFoundException:

We can't find the requested resource. Check that the specified name is correct and try your request again.

GetVocabulary 

$result = $client->getVocabulary([/* ... */]);
$promise = $client->getVocabularyAsync([/* ... */]);

Provides information about the specified custom vocabulary.

To view the status of the specified custom vocabulary, check the VocabularyState field. If the status is READY, your custom vocabulary is available to use. If the status is FAILED, FailureReason provides details on why your custom vocabulary failed.

To get a list of your custom vocabularies, use the operation.

Parameter Syntax

$result = $client->getVocabulary([
    'VocabularyName' => '<string>', // REQUIRED
]);

Parameter Details

Members
VocabularyName
Required: Yes
Type: string

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

Result Syntax

[
    'DownloadUri' => '<string>',
    'FailureReason' => '<string>',
    'LanguageCode' => 'af-ZA|ar-AE|ar-SA|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ|vi-VN|sv-SE|ab-GE|ast-ES|az-AZ|ba-RU|be-BY|bg-BG|bn-IN|bs-BA|ca-ES|ckb-IQ|ckb-IR|cs-CZ|cy-WL|el-GR|et-ET|eu-ES|fi-FI|gl-ES|gu-IN|ha-NG|hr-HR|hu-HU|hy-AM|is-IS|ka-GE|kab-DZ|kk-KZ|kn-IN|ky-KG|lg-IN|lt-LT|lv-LV|mhr-RU|mi-NZ|mk-MK|ml-IN|mn-MN|mr-IN|mt-MT|no-NO|or-IN|pa-IN|pl-PL|ps-AF|ro-RO|rw-RW|si-LK|sk-SK|sl-SI|so-SO|sr-RS|su-ID|sw-BI|sw-KE|sw-RW|sw-TZ|sw-UG|tl-PH|tt-RU|ug-CN|uk-UA|uz-UZ|wo-SN|zu-ZA',
    'LastModifiedTime' => <DateTime>,
    'VocabularyName' => '<string>',
    'VocabularyState' => 'PENDING|READY|FAILED',
]

Result Details

Members
DownloadUri
Type: string

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

FailureReason
Type: string

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

LanguageCode
Type: string

The language code you selected for your custom vocabulary.

LastModifiedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.

VocabularyName
Type: string

The name of the custom vocabulary you requested information about.

VocabularyState
Type: string

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

Errors

NotFoundException:

We can't find the requested resource. Check that the specified name is correct and try your request again.

LimitExceededException:

You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

InternalFailureException:

There was an internal error. Check the error message, correct the issue, and try your request again.

BadRequestException:

Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

GetVocabularyFilter 

$result = $client->getVocabularyFilter([/* ... */]);
$promise = $client->getVocabularyFilterAsync([/* ... */]);

Provides information about the specified custom vocabulary filter.

To get a list of your custom vocabulary filters, use the operation.

Parameter Syntax

$result = $client->getVocabularyFilter([
    'VocabularyFilterName' => '<string>', // REQUIRED
]);

Parameter Details

Members
VocabularyFilterName
Required: Yes
Type: string

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

Result Syntax

[
    'DownloadUri' => '<string>',
    'LanguageCode' => 'af-ZA|ar-AE|ar-SA|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ|vi-VN|sv-SE|ab-GE|ast-ES|az-AZ|ba-RU|be-BY|bg-BG|bn-IN|bs-BA|ca-ES|ckb-IQ|ckb-IR|cs-CZ|cy-WL|el-GR|et-ET|eu-ES|fi-FI|gl-ES|gu-IN|ha-NG|hr-HR|hu-HU|hy-AM|is-IS|ka-GE|kab-DZ|kk-KZ|kn-IN|ky-KG|lg-IN|lt-LT|lv-LV|mhr-RU|mi-NZ|mk-MK|ml-IN|mn-MN|mr-IN|mt-MT|no-NO|or-IN|pa-IN|pl-PL|ps-AF|ro-RO|rw-RW|si-LK|sk-SK|sl-SI|so-SO|sr-RS|su-ID|sw-BI|sw-KE|sw-RW|sw-TZ|sw-UG|tl-PH|tt-RU|ug-CN|uk-UA|uz-UZ|wo-SN|zu-ZA',
    'LastModifiedTime' => <DateTime>,
    'VocabularyFilterName' => '<string>',
]

Result Details

Members
DownloadUri
Type: string

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

LanguageCode
Type: string

The language code you selected for your custom vocabulary filter.

LastModifiedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.

VocabularyFilterName
Type: string

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

Errors

NotFoundException:

We can't find the requested resource. Check that the specified name is correct and try your request again.

LimitExceededException:

You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

InternalFailureException:

There was an internal error. Check the error message, correct the issue, and try your request again.

BadRequestException:

Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

ListCallAnalyticsCategories 

$result = $client->listCallAnalyticsCategories([/* ... */]);
$promise = $client->listCallAnalyticsCategoriesAsync([/* ... */]);

Provides a list of Call Analytics categories, including all rules that make up each category.

To get detailed information about a specific Call Analytics category, use the operation.

Parameter Syntax

$result = $client->listCallAnalyticsCategories([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
MaxResults
Type: int

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

NextToken
Type: string

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

Result Syntax

[
    'Categories' => [
        [
            'CategoryName' => '<string>',
            'CreateTime' => <DateTime>,
            'InputType' => 'REAL_TIME|POST_CALL',
            'LastUpdateTime' => <DateTime>,
            'Rules' => [
                [
                    'InterruptionFilter' => [
                        'AbsoluteTimeRange' => [
                            'EndTime' => <integer>,
                            'First' => <integer>,
                            'Last' => <integer>,
                            'StartTime' => <integer>,
                        ],
                        'Negate' => true || false,
                        'ParticipantRole' => 'AGENT|CUSTOMER',
                        'RelativeTimeRange' => [
                            'EndPercentage' => <integer>,
                            'First' => <integer>,
                            'Last' => <integer>,
                            'StartPercentage' => <integer>,
                        ],
                        'Threshold' => <integer>,
                    ],
                    'NonTalkTimeFilter' => [
                        'AbsoluteTimeRange' => [
                            'EndTime' => <integer>,
                            'First' => <integer>,
                            'Last' => <integer>,
                            'StartTime' => <integer>,
                        ],
                        'Negate' => true || false,
                        'RelativeTimeRange' => [
                            'EndPercentage' => <integer>,
                            'First' => <integer>,
                            'Last' => <integer>,
                            'StartPercentage' => <integer>,
                        ],
                        'Threshold' => <integer>,
                    ],
                    'SentimentFilter' => [
                        'AbsoluteTimeRange' => [
                            'EndTime' => <integer>,
                            'First' => <integer>,
                            'Last' => <integer>,
                            'StartTime' => <integer>,
                        ],
                        'Negate' => true || false,
                        'ParticipantRole' => 'AGENT|CUSTOMER',
                        'RelativeTimeRange' => [
                            'EndPercentage' => <integer>,
                            'First' => <integer>,
                            'Last' => <integer>,
                            'StartPercentage' => <integer>,
                        ],
                        'Sentiments' => ['<string>', ...],
                    ],
                    'TranscriptFilter' => [
                        'AbsoluteTimeRange' => [
                            'EndTime' => <integer>,
                            'First' => <integer>,
                            'Last' => <integer>,
                            'StartTime' => <integer>,
                        ],
                        'Negate' => true || false,
                        'ParticipantRole' => 'AGENT|CUSTOMER',
                        'RelativeTimeRange' => [
                            'EndPercentage' => <integer>,
                            'First' => <integer>,
                            'Last' => <integer>,
                            'StartPercentage' => <integer>,
                        ],
                        'Targets' => ['<string>', ...],
                        'TranscriptFilterType' => 'EXACT',
                    ],
                ],
                // ...
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Categories
Type: Array of CategoryProperties structures

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

NextToken
Type: string

If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results.

Errors

BadRequestException:

Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

LimitExceededException:

You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

InternalFailureException:

There was an internal error. Check the error message, correct the issue, and try your request again.

ListCallAnalyticsJobs 

$result = $client->listCallAnalyticsJobs([/* ... */]);
$promise = $client->listCallAnalyticsJobsAsync([/* ... */]);

Provides a list of Call Analytics jobs that match the specified criteria. If no criteria are specified, all Call Analytics jobs are returned.

To get detailed information about a specific Call Analytics job, use the operation.

Parameter Syntax

$result = $client->listCallAnalyticsJobs([
    'JobNameContains' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'Status' => 'QUEUED|IN_PROGRESS|FAILED|COMPLETED',
]);

Parameter Details

Members
JobNameContains
Type: string

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

MaxResults
Type: int

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

NextToken
Type: string

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

Status
Type: string

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

Result Syntax

[
    'CallAnalyticsJobSummaries' => [
        [
            'CallAnalyticsJobDetails' => [
                'Skipped' => [
                    [
                        'Feature' => 'GENERATIVE_SUMMARIZATION',
                        'Message' => '<string>',
                        'ReasonCode' => 'INSUFFICIENT_CONVERSATION_CONTENT|FAILED_SAFETY_GUIDELINES',
                    ],
                    // ...
                ],
            ],
            'CallAnalyticsJobName' => '<string>',
            'CallAnalyticsJobStatus' => 'QUEUED|IN_PROGRESS|FAILED|COMPLETED',
            'CompletionTime' => <DateTime>,
            'CreationTime' => <DateTime>,
            'FailureReason' => '<string>',
            'LanguageCode' => 'af-ZA|ar-AE|ar-SA|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ|vi-VN|sv-SE|ab-GE|ast-ES|az-AZ|ba-RU|be-BY|bg-BG|bn-IN|bs-BA|ca-ES|ckb-IQ|ckb-IR|cs-CZ|cy-WL|el-GR|et-ET|eu-ES|fi-FI|gl-ES|gu-IN|ha-NG|hr-HR|hu-HU|hy-AM|is-IS|ka-GE|kab-DZ|kk-KZ|kn-IN|ky-KG|lg-IN|lt-LT|lv-LV|mhr-RU|mi-NZ|mk-MK|ml-IN|mn-MN|mr-IN|mt-MT|no-NO|or-IN|pa-IN|pl-PL|ps-AF|ro-RO|rw-RW|si-LK|sk-SK|sl-SI|so-SO|sr-RS|su-ID|sw-BI|sw-KE|sw-RW|sw-TZ|sw-UG|tl-PH|tt-RU|ug-CN|uk-UA|uz-UZ|wo-SN|zu-ZA',
            'StartTime' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
    'Status' => 'QUEUED|IN_PROGRESS|FAILED|COMPLETED',
]

Result Details

Members
CallAnalyticsJobSummaries
Type: Array of CallAnalyticsJobSummary structures

Provides a summary of information about each result.

NextToken
Type: string

If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results.

Status
Type: string

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

Errors

BadRequestException:

Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

LimitExceededException:

You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

InternalFailureException:

There was an internal error. Check the error message, correct the issue, and try your request again.

ListLanguageModels 

$result = $client->listLanguageModels([/* ... */]);
$promise = $client->listLanguageModelsAsync([/* ... */]);

Provides a list of custom language models that match the specified criteria. If no criteria are specified, all custom language models are returned.

To get detailed information about a specific custom language model, use the operation.

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 custom language models to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you do not specify a value, a default of 5 is used.

NameContains
Type: string

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

NextToken
Type: string

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

StatusEquals
Type: string

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

Result Syntax

[
    'Models' => [
        [
            'BaseModelName' => 'NarrowBand|WideBand',
            'CreateTime' => <DateTime>,
            'FailureReason' => '<string>',
            'InputDataConfig' => [
                'DataAccessRoleArn' => '<string>',
                'S3Uri' => '<string>',
                'TuningDataS3Uri' => '<string>',
            ],
            'LanguageCode' => 'en-US|hi-IN|es-US|en-GB|en-AU|de-DE|ja-JP',
            'LastModifiedTime' => <DateTime>,
            'ModelName' => '<string>',
            'ModelStatus' => 'IN_PROGRESS|FAILED|COMPLETED',
            'UpgradeAvailability' => true || false,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Models
Type: Array of LanguageModel structures

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

NextToken
Type: string

If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results.

Errors

BadRequestException:

Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

LimitExceededException:

You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

InternalFailureException:

There was an internal error. Check the error message, correct the issue, and try your request again.

ListMedicalScribeJobs 

$result = $client->listMedicalScribeJobs([/* ... */]);
$promise = $client->listMedicalScribeJobsAsync([/* ... */]);

Provides a list of Medical Scribe jobs that match the specified criteria. If no criteria are specified, all Medical Scribe jobs are returned.

To get detailed information about a specific Medical Scribe job, use the operation.

Parameter Syntax

$result = $client->listMedicalScribeJobs([
    'JobNameContains' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'Status' => 'QUEUED|IN_PROGRESS|FAILED|COMPLETED',
]);

Parameter Details

Members
JobNameContains
Type: string

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

MaxResults
Type: int

The maximum number of Medical Scribe jobs to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you do not specify a value, a default of 5 is used.

NextToken
Type: string

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

Status
Type: string

Returns only Medical Scribe jobs with the specified status. Jobs are ordered by creation date, with the newest job first. If you do not include Status, all Medical Scribe jobs are returned.

Result Syntax

[
    'MedicalScribeJobSummaries' => [
        [
            'CompletionTime' => <DateTime>,
            'CreationTime' => <DateTime>,
            'FailureReason' => '<string>',
            'LanguageCode' => 'en-US',
            'MedicalScribeJobName' => '<string>',
            'MedicalScribeJobStatus' => 'QUEUED|IN_PROGRESS|FAILED|COMPLETED',
            'StartTime' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
    'Status' => 'QUEUED|IN_PROGRESS|FAILED|COMPLETED',
]

Result Details

Members
MedicalScribeJobSummaries
Type: Array of MedicalScribeJobSummary structures

Provides a summary of information about each result.

NextToken
Type: string

If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results.

Status
Type: string

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

Errors

BadRequestException:

Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

LimitExceededException:

You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

InternalFailureException:

There was an internal error. Check the error message, correct the issue, and try your request again.

ListMedicalTranscriptionJobs 

$result = $client->listMedicalTranscriptionJobs([/* ... */]);
$promise = $client->listMedicalTranscriptionJobsAsync([/* ... */]);

Provides a list of medical transcription jobs that match the specified criteria. If no criteria are specified, all medical transcription jobs are returned.

To get detailed information about a specific medical transcription job, use the operation.

Parameter Syntax

$result = $client->listMedicalTranscriptionJobs([
    'JobNameContains' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'Status' => 'QUEUED|IN_PROGRESS|FAILED|COMPLETED',
]);

Parameter Details

Members
JobNameContains
Type: string

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

MaxResults
Type: int

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

NextToken
Type: string

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

Status
Type: string

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

Result Syntax

[
    'MedicalTranscriptionJobSummaries' => [
        [
            'CompletionTime' => <DateTime>,
            'ContentIdentificationType' => 'PHI',
            'CreationTime' => <DateTime>,
            'FailureReason' => '<string>',
            'LanguageCode' => 'af-ZA|ar-AE|ar-SA|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ|vi-VN|sv-SE|ab-GE|ast-ES|az-AZ|ba-RU|be-BY|bg-BG|bn-IN|bs-BA|ca-ES|ckb-IQ|ckb-IR|cs-CZ|cy-WL|el-GR|et-ET|eu-ES|fi-FI|gl-ES|gu-IN|ha-NG|hr-HR|hu-HU|hy-AM|is-IS|ka-GE|kab-DZ|kk-KZ|kn-IN|ky-KG|lg-IN|lt-LT|lv-LV|mhr-RU|mi-NZ|mk-MK|ml-IN|mn-MN|mr-IN|mt-MT|no-NO|or-IN|pa-IN|pl-PL|ps-AF|ro-RO|rw-RW|si-LK|sk-SK|sl-SI|so-SO|sr-RS|su-ID|sw-BI|sw-KE|sw-RW|sw-TZ|sw-UG|tl-PH|tt-RU|ug-CN|uk-UA|uz-UZ|wo-SN|zu-ZA',
            '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

Provides a summary of information about each result.

NextToken
Type: string

If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results.

Status
Type: string

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

Errors

BadRequestException:

Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

LimitExceededException:

You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

InternalFailureException:

There was an internal error. Check the error message, correct the issue, and try your request again.

ListMedicalVocabularies 

$result = $client->listMedicalVocabularies([/* ... */]);
$promise = $client->listMedicalVocabulariesAsync([/* ... */]);

Provides a list of custom medical vocabularies that match the specified criteria. If no criteria are specified, all custom medical vocabularies are returned.

To get detailed information about a specific custom medical vocabulary, use the operation.

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 custom medical vocabularies to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you do not specify a value, a default of 5 is used.

NameContains
Type: string

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

NextToken
Type: string

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

StateEquals
Type: string

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

Result Syntax

[
    'NextToken' => '<string>',
    'Status' => 'PENDING|READY|FAILED',
    'Vocabularies' => [
        [
            'LanguageCode' => 'af-ZA|ar-AE|ar-SA|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ|vi-VN|sv-SE|ab-GE|ast-ES|az-AZ|ba-RU|be-BY|bg-BG|bn-IN|bs-BA|ca-ES|ckb-IQ|ckb-IR|cs-CZ|cy-WL|el-GR|et-ET|eu-ES|fi-FI|gl-ES|gu-IN|ha-NG|hr-HR|hu-HU|hy-AM|is-IS|ka-GE|kab-DZ|kk-KZ|kn-IN|ky-KG|lg-IN|lt-LT|lv-LV|mhr-RU|mi-NZ|mk-MK|ml-IN|mn-MN|mr-IN|mt-MT|no-NO|or-IN|pa-IN|pl-PL|ps-AF|ro-RO|rw-RW|si-LK|sk-SK|sl-SI|so-SO|sr-RS|su-ID|sw-BI|sw-KE|sw-RW|sw-TZ|sw-UG|tl-PH|tt-RU|ug-CN|uk-UA|uz-UZ|wo-SN|zu-ZA',
            'LastModifiedTime' => <DateTime>,
            'VocabularyName' => '<string>',
            'VocabularyState' => 'PENDING|READY|FAILED',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results.

Status
Type: string

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

Vocabularies
Type: Array of VocabularyInfo structures

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

Errors

BadRequestException:

Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

LimitExceededException:

You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

InternalFailureException:

There was an internal error. Check the error message, correct the issue, and try your request again.

ListTagsForResource 

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
ResourceArn
Required: Yes
Type: string

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

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

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

Result Syntax

[
    'ResourceArn' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
ResourceArn
Type: string

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

Tags
Type: Array of Tag structures

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

Errors

BadRequestException:

Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

NotFoundException:

We can't find the requested resource. Check that the specified name is correct and try your request again.

LimitExceededException:

You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

InternalFailureException:

There was an internal error. Check the error message, correct the issue, and try your request again.

ListTranscriptionJobs 

$result = $client->listTranscriptionJobs([/* ... */]);
$promise = $client->listTranscriptionJobsAsync([/* ... */]);

Provides a list of transcription jobs that match the specified criteria. If no criteria are specified, all transcription jobs are returned.

To get detailed information about a specific transcription job, use the operation.

Parameter Syntax

$result = $client->listTranscriptionJobs([
    'JobNameContains' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'Status' => 'QUEUED|IN_PROGRESS|FAILED|COMPLETED',
]);

Parameter Details

Members
JobNameContains
Type: string

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

MaxResults
Type: int

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

NextToken
Type: string

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

Status
Type: string

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

Result Syntax

[
    'NextToken' => '<string>',
    'Status' => 'QUEUED|IN_PROGRESS|FAILED|COMPLETED',
    'TranscriptionJobSummaries' => [
        [
            'CompletionTime' => <DateTime>,
            'ContentRedaction' => [
                'PiiEntityTypes' => ['<string>', ...],
                'RedactionOutput' => 'redacted|redacted_and_unredacted',
                'RedactionType' => 'PII',
            ],
            'CreationTime' => <DateTime>,
            'FailureReason' => '<string>',
            'IdentifiedLanguageScore' => <float>,
            'IdentifyLanguage' => true || false,
            'IdentifyMultipleLanguages' => true || false,
            'LanguageCode' => 'af-ZA|ar-AE|ar-SA|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ|vi-VN|sv-SE|ab-GE|ast-ES|az-AZ|ba-RU|be-BY|bg-BG|bn-IN|bs-BA|ca-ES|ckb-IQ|ckb-IR|cs-CZ|cy-WL|el-GR|et-ET|eu-ES|fi-FI|gl-ES|gu-IN|ha-NG|hr-HR|hu-HU|hy-AM|is-IS|ka-GE|kab-DZ|kk-KZ|kn-IN|ky-KG|lg-IN|lt-LT|lv-LV|mhr-RU|mi-NZ|mk-MK|ml-IN|mn-MN|mr-IN|mt-MT|no-NO|or-IN|pa-IN|pl-PL|ps-AF|ro-RO|rw-RW|si-LK|sk-SK|sl-SI|so-SO|sr-RS|su-ID|sw-BI|sw-KE|sw-RW|sw-TZ|sw-UG|tl-PH|tt-RU|ug-CN|uk-UA|uz-UZ|wo-SN|zu-ZA',
            'LanguageCodes' => [
                [
                    'DurationInSeconds' => <float>,
                    'LanguageCode' => 'af-ZA|ar-AE|ar-SA|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ|vi-VN|sv-SE|ab-GE|ast-ES|az-AZ|ba-RU|be-BY|bg-BG|bn-IN|bs-BA|ca-ES|ckb-IQ|ckb-IR|cs-CZ|cy-WL|el-GR|et-ET|eu-ES|fi-FI|gl-ES|gu-IN|ha-NG|hr-HR|hu-HU|hy-AM|is-IS|ka-GE|kab-DZ|kk-KZ|kn-IN|ky-KG|lg-IN|lt-LT|lv-LV|mhr-RU|mi-NZ|mk-MK|ml-IN|mn-MN|mr-IN|mt-MT|no-NO|or-IN|pa-IN|pl-PL|ps-AF|ro-RO|rw-RW|si-LK|sk-SK|sl-SI|so-SO|sr-RS|su-ID|sw-BI|sw-KE|sw-RW|sw-TZ|sw-UG|tl-PH|tt-RU|ug-CN|uk-UA|uz-UZ|wo-SN|zu-ZA',
                ],
                // ...
            ],
            'ModelSettings' => [
                'LanguageModelName' => '<string>',
            ],
            'OutputLocationType' => 'CUSTOMER_BUCKET|SERVICE_BUCKET',
            'StartTime' => <DateTime>,
            'ToxicityDetection' => [
                [
                    'ToxicityCategories' => ['<string>', ...],
                ],
                // ...
            ],
            'TranscriptionJobName' => '<string>',
            'TranscriptionJobStatus' => 'QUEUED|IN_PROGRESS|FAILED|COMPLETED',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results.

Status
Type: string

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

TranscriptionJobSummaries
Type: Array of TranscriptionJobSummary structures

Provides a summary of information about each result.

Errors

BadRequestException:

Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

LimitExceededException:

You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

InternalFailureException:

There was an internal error. Check the error message, correct the issue, and try your request again.

ListVocabularies 

$result = $client->listVocabularies([/* ... */]);
$promise = $client->listVocabulariesAsync([/* ... */]);

Provides a list of custom vocabularies that match the specified criteria. If no criteria are specified, all custom vocabularies are returned.

To get detailed information about a specific custom vocabulary, use the operation.

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 custom vocabularies to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you do not specify a value, a default of 5 is used.

NameContains
Type: string

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

NextToken
Type: string

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

StateEquals
Type: string

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

Result Syntax

[
    'NextToken' => '<string>',
    'Status' => 'PENDING|READY|FAILED',
    'Vocabularies' => [
        [
            'LanguageCode' => 'af-ZA|ar-AE|ar-SA|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ|vi-VN|sv-SE|ab-GE|ast-ES|az-AZ|ba-RU|be-BY|bg-BG|bn-IN|bs-BA|ca-ES|ckb-IQ|ckb-IR|cs-CZ|cy-WL|el-GR|et-ET|eu-ES|fi-FI|gl-ES|gu-IN|ha-NG|hr-HR|hu-HU|hy-AM|is-IS|ka-GE|kab-DZ|kk-KZ|kn-IN|ky-KG|lg-IN|lt-LT|lv-LV|mhr-RU|mi-NZ|mk-MK|ml-IN|mn-MN|mr-IN|mt-MT|no-NO|or-IN|pa-IN|pl-PL|ps-AF|ro-RO|rw-RW|si-LK|sk-SK|sl-SI|so-SO|sr-RS|su-ID|sw-BI|sw-KE|sw-RW|sw-TZ|sw-UG|tl-PH|tt-RU|ug-CN|uk-UA|uz-UZ|wo-SN|zu-ZA',
            'LastModifiedTime' => <DateTime>,
            'VocabularyName' => '<string>',
            'VocabularyState' => 'PENDING|READY|FAILED',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results.

Status
Type: string

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

Vocabularies
Type: Array of VocabularyInfo structures

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

Errors

BadRequestException:

Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

LimitExceededException:

You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

InternalFailureException:

There was an internal error. Check the error message, correct the issue, and try your request again.

ListVocabularyFilters 

$result = $client->listVocabularyFilters([/* ... */]);
$promise = $client->listVocabularyFiltersAsync([/* ... */]);

Provides a list of custom vocabulary filters that match the specified criteria. If no criteria are specified, all custom vocabularies are returned.

To get detailed information about a specific custom vocabulary filter, use the operation.

Parameter Syntax

$result = $client->listVocabularyFilters([
    'MaxResults' => <integer>,
    'NameContains' => '<string>',
    'NextToken' => '<string>',
]);

Parameter Details

Members
MaxResults
Type: int

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

NameContains
Type: string

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

NextToken
Type: string

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

Result Syntax

[
    'NextToken' => '<string>',
    'VocabularyFilters' => [
        [
            'LanguageCode' => 'af-ZA|ar-AE|ar-SA|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ|vi-VN|sv-SE|ab-GE|ast-ES|az-AZ|ba-RU|be-BY|bg-BG|bn-IN|bs-BA|ca-ES|ckb-IQ|ckb-IR|cs-CZ|cy-WL|el-GR|et-ET|eu-ES|fi-FI|gl-ES|gu-IN|ha-NG|hr-HR|hu-HU|hy-AM|is-IS|ka-GE|kab-DZ|kk-KZ|kn-IN|ky-KG|lg-IN|lt-LT|lv-LV|mhr-RU|mi-NZ|mk-MK|ml-IN|mn-MN|mr-IN|mt-MT|no-NO|or-IN|pa-IN|pl-PL|ps-AF|ro-RO|rw-RW|si-LK|sk-SK|sl-SI|so-SO|sr-RS|su-ID|sw-BI|sw-KE|sw-RW|sw-TZ|sw-UG|tl-PH|tt-RU|ug-CN|uk-UA|uz-UZ|wo-SN|zu-ZA',
            'LastModifiedTime' => <DateTime>,
            'VocabularyFilterName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results.

VocabularyFilters
Type: Array of VocabularyFilterInfo structures

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

Errors

BadRequestException:

Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

LimitExceededException:

You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

InternalFailureException:

There was an internal error. Check the error message, correct the issue, and try your request again.

StartCallAnalyticsJob 

$result = $client->startCallAnalyticsJob([/* ... */]);
$promise = $client->startCallAnalyticsJobAsync([/* ... */]);

Transcribes the audio from a customer service call and applies any additional Request Parameters you choose to include in your request.

In addition to many standard transcription features, Call Analytics provides you with call characteristics, call summarization, speaker sentiment, and optional redaction of your text transcript and your audio file. You can also apply custom categories to flag specified conditions. To learn more about these features and insights, refer to Analyzing call center audio with Call Analytics.

If you want to apply categories to your Call Analytics job, you must create them before submitting your job request. Categories cannot be retroactively applied to a job. To create a new category, use the operation. To learn more about Call Analytics categories, see Creating categories for post-call transcriptions and Creating categories for real-time transcriptions.

To make a StartCallAnalyticsJob request, you must first upload your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location of the file using the Media parameter.

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

You must include the following parameters in your StartCallAnalyticsJob request:

  • region: The Amazon Web Services Region where you are making your request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas.

  • CallAnalyticsJobName: A custom name that you create for your transcription job that's unique within your Amazon Web Services account.

  • DataAccessRoleArn: The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files.

  • Media (MediaFileUri or RedactedMediaFileUri): The Amazon S3 location of your media file.

With Call Analytics, you can redact the audio contained in your media file by including RedactedMediaFileUri, instead of MediaFileUri, to specify the location of your input audio. If you choose to redact your audio, you can find your redacted media at the location specified in the RedactedMediaFileUri field of your response.

Parameter Syntax

$result = $client->startCallAnalyticsJob([
    'CallAnalyticsJobName' => '<string>', // REQUIRED
    'ChannelDefinitions' => [
        [
            'ChannelId' => <integer>,
            'ParticipantRole' => 'AGENT|CUSTOMER',
        ],
        // ...
    ],
    'DataAccessRoleArn' => '<string>',
    'Media' => [ // REQUIRED
        'MediaFileUri' => '<string>',
        'RedactedMediaFileUri' => '<string>',
    ],
    'OutputEncryptionKMSKeyId' => '<string>',
    'OutputLocation' => '<string>',
    'Settings' => [
        'ContentRedaction' => [
            'PiiEntityTypes' => ['<string>', ...],
            'RedactionOutput' => 'redacted|redacted_and_unredacted', // REQUIRED
            'RedactionType' => 'PII', // REQUIRED
        ],
        'LanguageIdSettings' => [
            '<LanguageCode>' => [
                'LanguageModelName' => '<string>',
                'VocabularyFilterName' => '<string>',
                'VocabularyName' => '<string>',
            ],
            // ...
        ],
        'LanguageModelName' => '<string>',
        'LanguageOptions' => ['<string>', ...],
        'Summarization' => [
            'GenerateAbstractiveSummary' => true || false, // REQUIRED
        ],
        'VocabularyFilterMethod' => 'remove|mask|tag',
        'VocabularyFilterName' => '<string>',
        'VocabularyName' => '<string>',
    ],
]);

Parameter Details

Members
CallAnalyticsJobName
Required: Yes
Type: string

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

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

ChannelDefinitions
Type: Array of ChannelDefinition structures

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

DataAccessRoleArn
Type: string

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

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

For more information, see IAM ARNs.

Media
Required: Yes
Type: Media structure

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

OutputEncryptionKMSKeyId
Type: string

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

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

  1. Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.

  2. Use an alias for the KMS key ID. For example, alias/ExampleAlias.

  3. Use the Amazon Resource Name (ARN) for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

  4. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.

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

  1. Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

  2. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.

If you do not specify an encryption key, your output is encrypted with the default Amazon S3 key (SSE-S3).

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

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

OutputLocation
Type: string

The Amazon S3 location where you want your Call Analytics transcription output stored. You can use any of the following formats to specify the output location:

  1. s3://DOC-EXAMPLE-BUCKET

  2. s3://DOC-EXAMPLE-BUCKET/my-output-folder/

  3. s3://DOC-EXAMPLE-BUCKET/my-output-folder/my-call-analytics-job.json

Unless you specify a file name (option 3), the name of your output file has a default value that matches the name you specified for your transcription job using the CallAnalyticsJobName parameter.

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

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

Settings
Type: CallAnalyticsJobSettings structure

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

Result Syntax

[
    'CallAnalyticsJob' => [
        'CallAnalyticsJobDetails' => [
            'Skipped' => [
                [
                    'Feature' => 'GENERATIVE_SUMMARIZATION',
                    'Message' => '<string>',
                    'ReasonCode' => 'INSUFFICIENT_CONVERSATION_CONTENT|FAILED_SAFETY_GUIDELINES',
                ],
                // ...
            ],
        ],
        'CallAnalyticsJobName' => '<string>',
        'CallAnalyticsJobStatus' => 'QUEUED|IN_PROGRESS|FAILED|COMPLETED',
        'ChannelDefinitions' => [
            [
                'ChannelId' => <integer>,
                'ParticipantRole' => 'AGENT|CUSTOMER',
            ],
            // ...
        ],
        'CompletionTime' => <DateTime>,
        'CreationTime' => <DateTime>,
        'DataAccessRoleArn' => '<string>',
        'FailureReason' => '<string>',
        'IdentifiedLanguageScore' => <float>,
        'LanguageCode' => 'af-ZA|ar-AE|ar-SA|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ|vi-VN|sv-SE|ab-GE|ast-ES|az-AZ|ba-RU|be-BY|bg-BG|bn-IN|bs-BA|ca-ES|ckb-IQ|ckb-IR|cs-CZ|cy-WL|el-GR|et-ET|eu-ES|fi-FI|gl-ES|gu-IN|ha-NG|hr-HR|hu-HU|hy-AM|is-IS|ka-GE|kab-DZ|kk-KZ|kn-IN|ky-KG|lg-IN|lt-LT|lv-LV|mhr-RU|mi-NZ|mk-MK|ml-IN|mn-MN|mr-IN|mt-MT|no-NO|or-IN|pa-IN|pl-PL|ps-AF|ro-RO|rw-RW|si-LK|sk-SK|sl-SI|so-SO|sr-RS|su-ID|sw-BI|sw-KE|sw-RW|sw-TZ|sw-UG|tl-PH|tt-RU|ug-CN|uk-UA|uz-UZ|wo-SN|zu-ZA',
        'Media' => [
            'MediaFileUri' => '<string>',
            'RedactedMediaFileUri' => '<string>',
        ],
        'MediaFormat' => 'mp3|mp4|wav|flac|ogg|amr|webm|m4a',
        'MediaSampleRateHertz' => <integer>,
        'Settings' => [
            'ContentRedaction' => [
                'PiiEntityTypes' => ['<string>', ...],
                'RedactionOutput' => 'redacted|redacted_and_unredacted',
                'RedactionType' => 'PII',
            ],
            'LanguageIdSettings' => [
                '<LanguageCode>' => [
                    'LanguageModelName' => '<string>',
                    'VocabularyFilterName' => '<string>',
                    'VocabularyName' => '<string>',
                ],
                // ...
            ],
            'LanguageModelName' => '<string>',
            'LanguageOptions' => ['<string>', ...],
            'Summarization' => [
                'GenerateAbstractiveSummary' => true || false,
            ],
            'VocabularyFilterMethod' => 'remove|mask|tag',
            'VocabularyFilterName' => '<string>',
            'VocabularyName' => '<string>',
        ],
        'StartTime' => <DateTime>,
        'Transcript' => [
            'RedactedTranscriptFileUri' => '<string>',
            'TranscriptFileUri' => '<string>',
        ],
    ],
]

Result Details

Members
CallAnalyticsJob
Type: CallAnalyticsJob structure

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

Errors

BadRequestException:

Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

LimitExceededException:

You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

InternalFailureException:

There was an internal error. Check the error message, correct the issue, and try your request again.

ConflictException:

A resource already exists with this name. Resource names must be unique within an Amazon Web Services account.

StartMedicalScribeJob 

$result = $client->startMedicalScribeJob([/* ... */]);
$promise = $client->startMedicalScribeJobAsync([/* ... */]);

Transcribes patient-clinician conversations and generates clinical notes.

Amazon Web Services HealthScribe automatically provides rich conversation transcripts, identifies speaker roles, classifies dialogues, extracts medical terms, and generates preliminary clinical notes. To learn more about these features, refer to Amazon Web Services HealthScribe.

To make a StartMedicalScribeJob request, you must first upload your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location of the file using the Media parameter.

You must include the following parameters in your StartMedicalTranscriptionJob request:

  • DataAccessRoleArn: The ARN of an IAM role with the these minimum permissions: read permission on input file Amazon S3 bucket specified in Media, write permission on the Amazon S3 bucket specified in OutputBucketName, and full permissions on the KMS key specified in OutputEncryptionKMSKeyId (if set). The role should also allow transcribe.amazonaws.com to assume it.

  • Media (MediaFileUri): The Amazon S3 location of your media file.

  • MedicalScribeJobName: A custom name you create for your MedicalScribe job that is unique within your Amazon Web Services account.

  • OutputBucketName: The Amazon S3 bucket where you want your output files stored.

  • Settings: A MedicalScribeSettings obect that must set exactly one of ShowSpeakerLabels or ChannelIdentification to true. If ShowSpeakerLabels is true, MaxSpeakerLabels must also be set.

  • ChannelDefinitions: A MedicalScribeChannelDefinitions array should be set if and only if the ChannelIdentification value of Settings is set to true.

Parameter Syntax

$result = $client->startMedicalScribeJob([
    'ChannelDefinitions' => [
        [
            'ChannelId' => <integer>, // REQUIRED
            'ParticipantRole' => 'PATIENT|CLINICIAN', // REQUIRED
        ],
        // ...
    ],
    'DataAccessRoleArn' => '<string>', // REQUIRED
    'KMSEncryptionContext' => ['<string>', ...],
    'Media' => [ // REQUIRED
        'MediaFileUri' => '<string>',
        'RedactedMediaFileUri' => '<string>',
    ],
    'MedicalScribeJobName' => '<string>', // REQUIRED
    'OutputBucketName' => '<string>', // REQUIRED
    'OutputEncryptionKMSKeyId' => '<string>',
    'Settings' => [ // REQUIRED
        'ChannelIdentification' => true || false,
        'MaxSpeakerLabels' => <integer>,
        'ShowSpeakerLabels' => true || false,
        'VocabularyFilterMethod' => 'remove|mask|tag',
        'VocabularyFilterName' => '<string>',
        'VocabularyName' => '<string>',
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
ChannelDefinitions
Type: Array of MedicalScribeChannelDefinition structures

Makes it possible to specify which speaker is on which channel. For example, if the clinician is the first participant to speak, you would set ChannelId of the first ChannelDefinition in the list to 0 (to indicate the first channel) and ParticipantRole to CLINICIAN (to indicate that it's the clinician speaking). Then you would set the ChannelId of the second ChannelDefinition in the list to 1 (to indicate the second channel) and ParticipantRole to PATIENT (to indicate that it's the patient speaking).

DataAccessRoleArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files, write to the output bucket, and use your KMS key if supplied. If the role that you specify doesn’t have the appropriate permissions your request fails.

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

For more information, see IAM ARNs.

KMSEncryptionContext
Type: Associative array of custom strings keys (NonEmptyString) to strings

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

Media
Required: Yes
Type: Media structure

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

For information on supported media formats, refer to the MediaFormat parameter or the Media formats section in the Amazon S3 Developer Guide.

MedicalScribeJobName
Required: Yes
Type: string

A unique name, chosen by you, for your Medical Scribe job.

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

OutputBucketName
Required: Yes
Type: string

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

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

OutputEncryptionKMSKeyId
Type: string

The KMS key you want to use to encrypt your Medical Scribe output.

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

  1. Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.

  2. Use an alias for the KMS key ID. For example, alias/ExampleAlias.

  3. Use the Amazon Resource Name (ARN) for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

  4. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.

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

  1. Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

  2. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.

If you do not specify an encryption key, your output is encrypted with the default Amazon S3 key (SSE-S3).

Note that the role specified in the DataAccessRoleArn request parameter must have permission to use the specified KMS key.

Settings
Required: Yes
Type: MedicalScribeSettings structure

Makes it possible to control how your Medical Scribe job is processed using a MedicalScribeSettings object. Specify ChannelIdentification if ChannelDefinitions are set. Enabled ShowSpeakerLabels if ChannelIdentification and ChannelDefinitions are not set. One and only one of ChannelIdentification and ShowSpeakerLabels must be set. If ShowSpeakerLabels is set, MaxSpeakerLabels must also be set. Use Settings to specify a vocabulary or vocabulary filter or both using VocabularyName, VocabularyFilterName. VocabularyFilterMethod must be specified if VocabularyFilterName is set.

Tags
Type: Array of Tag structures

Adds one or more custom tags, each in the form of a key:value pair, to the Medica Scribe job.

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

Result Syntax

[
    'MedicalScribeJob' => [
        'ChannelDefinitions' => [
            [
                'ChannelId' => <integer>,
                'ParticipantRole' => 'PATIENT|CLINICIAN',
            ],
            // ...
        ],
        'CompletionTime' => <DateTime>,
        'CreationTime' => <DateTime>,
        'DataAccessRoleArn' => '<string>',
        'FailureReason' => '<string>',
        'LanguageCode' => 'en-US',
        'Media' => [
            'MediaFileUri' => '<string>',
            'RedactedMediaFileUri' => '<string>',
        ],
        'MedicalScribeJobName' => '<string>',
        'MedicalScribeJobStatus' => 'QUEUED|IN_PROGRESS|FAILED|COMPLETED',
        'MedicalScribeOutput' => [
            'ClinicalDocumentUri' => '<string>',
            'TranscriptFileUri' => '<string>',
        ],
        'Settings' => [
            'ChannelIdentification' => true || false,
            'MaxSpeakerLabels' => <integer>,
            'ShowSpeakerLabels' => true || false,
            'VocabularyFilterMethod' => 'remove|mask|tag',
            'VocabularyFilterName' => '<string>',
            'VocabularyName' => '<string>',
        ],
        'StartTime' => <DateTime>,
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
MedicalScribeJob
Type: MedicalScribeJob structure

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

Errors

BadRequestException:

Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

LimitExceededException:

You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

InternalFailureException:

There was an internal error. Check the error message, correct the issue, and try your request again.

ConflictException:

A resource already exists with this name. Resource names must be unique within an Amazon Web Services account.

StartMedicalTranscriptionJob 

$result = $client->startMedicalTranscriptionJob([/* ... */]);
$promise = $client->startMedicalTranscriptionJobAsync([/* ... */]);

Transcribes the audio from a medical dictation or conversation and applies any additional Request Parameters you choose to include in your request.

In addition to many standard transcription features, Amazon Transcribe Medical provides you with a robust medical vocabulary and, optionally, content identification, which adds flags to personal health information (PHI). To learn more about these features, refer to How Amazon Transcribe Medical works.

To make a StartMedicalTranscriptionJob request, you must first upload your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location of the file using the Media parameter.

You must include the following parameters in your StartMedicalTranscriptionJob request:

  • region: The Amazon Web Services Region where you are making your request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas.

  • MedicalTranscriptionJobName: A custom name you create for your transcription job that is unique within your Amazon Web Services account.

  • Media (MediaFileUri): The Amazon S3 location of your media file.

  • LanguageCode: This must be en-US.

  • OutputBucketName: The Amazon S3 bucket where you want your transcript stored. If you want your output stored in a sub-folder of this bucket, you must also include OutputKey.

  • Specialty: This must be PRIMARYCARE.

  • Type: Choose whether your audio is a conversation or a dictation.

Parameter Syntax

$result = $client->startMedicalTranscriptionJob([
    'ContentIdentificationType' => 'PHI',
    'KMSEncryptionContext' => ['<string>', ...],
    'LanguageCode' => 'af-ZA|ar-AE|ar-SA|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ|vi-VN|sv-SE|ab-GE|ast-ES|az-AZ|ba-RU|be-BY|bg-BG|bn-IN|bs-BA|ca-ES|ckb-IQ|ckb-IR|cs-CZ|cy-WL|el-GR|et-ET|eu-ES|fi-FI|gl-ES|gu-IN|ha-NG|hr-HR|hu-HU|hy-AM|is-IS|ka-GE|kab-DZ|kk-KZ|kn-IN|ky-KG|lg-IN|lt-LT|lv-LV|mhr-RU|mi-NZ|mk-MK|ml-IN|mn-MN|mr-IN|mt-MT|no-NO|or-IN|pa-IN|pl-PL|ps-AF|ro-RO|rw-RW|si-LK|sk-SK|sl-SI|so-SO|sr-RS|su-ID|sw-BI|sw-KE|sw-RW|sw-TZ|sw-UG|tl-PH|tt-RU|ug-CN|uk-UA|uz-UZ|wo-SN|zu-ZA', // REQUIRED
    'Media' => [ // REQUIRED
        'MediaFileUri' => '<string>',
        'RedactedMediaFileUri' => '<string>',
    ],
    'MediaFormat' => 'mp3|mp4|wav|flac|ogg|amr|webm|m4a',
    'MediaSampleRateHertz' => <integer>,
    'MedicalTranscriptionJobName' => '<string>', // REQUIRED
    'OutputBucketName' => '<string>', // REQUIRED
    'OutputEncryptionKMSKeyId' => '<string>',
    'OutputKey' => '<string>',
    'Settings' => [
        'ChannelIdentification' => true || false,
        'MaxAlternatives' => <integer>,
        'MaxSpeakerLabels' => <integer>,
        'ShowAlternatives' => true || false,
        'ShowSpeakerLabels' => true || false,
        'VocabularyName' => '<string>',
    ],
    'Specialty' => 'PRIMARYCARE', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Type' => 'CONVERSATION|DICTATION', // REQUIRED
]);

Parameter Details

Members
ContentIdentificationType
Type: string

Labels all personal health information (PHI) identified in your transcript. For more information, see Identifying personal health information (PHI) in a transcription.

KMSEncryptionContext
Type: Associative array of custom strings keys (NonEmptyString) to strings

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

LanguageCode
Required: Yes
Type: string

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

Media
Required: Yes
Type: Media structure

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

For information on supported media formats, refer to the MediaFormat parameter or the Media formats section in the Amazon S3 Developer Guide.

MediaFormat
Type: string

Specify the format of your input media file.

MediaSampleRateHertz
Type: int

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

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

MedicalTranscriptionJobName
Required: Yes
Type: string

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

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

OutputBucketName
Required: Yes
Type: string

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

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

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

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

OutputEncryptionKMSKeyId
Type: string

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

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

  1. Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.

  2. Use an alias for the KMS key ID. For example, alias/ExampleAlias.

  3. Use the Amazon Resource Name (ARN) for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

  4. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.

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

  1. Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

  2. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.

If you do not specify an encryption key, your output is encrypted with the default Amazon S3 key (SSE-S3).

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

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

OutputKey
Type: string

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

Here are some examples of how you can use OutputKey:

  • If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'my-transcript.json' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my-transcript.json.

  • If you specify 'my-first-transcription' as the MedicalTranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and 'my-transcript' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json.

  • If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'test-files/my-transcript.json' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json.

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

If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist, one is created for you.

Settings
Type: MedicalTranscriptionSetting structure

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

Specialty
Required: Yes
Type: string

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

Tags
Type: Array of Tag structures

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

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

Type
Required: Yes
Type: string

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

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

Result Syntax

[
    'MedicalTranscriptionJob' => [
        'CompletionTime' => <DateTime>,
        'ContentIdentificationType' => 'PHI',
        'CreationTime' => <DateTime>,
        'FailureReason' => '<string>',
        'LanguageCode' => 'af-ZA|ar-AE|ar-SA|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ|vi-VN|sv-SE|ab-GE|ast-ES|az-AZ|ba-RU|be-BY|bg-BG|bn-IN|bs-BA|ca-ES|ckb-IQ|ckb-IR|cs-CZ|cy-WL|el-GR|et-ET|eu-ES|fi-FI|gl-ES|gu-IN|ha-NG|hr-HR|hu-HU|hy-AM|is-IS|ka-GE|kab-DZ|kk-KZ|kn-IN|ky-KG|lg-IN|lt-LT|lv-LV|mhr-RU|mi-NZ|mk-MK|ml-IN|mn-MN|mr-IN|mt-MT|no-NO|or-IN|pa-IN|pl-PL|ps-AF|ro-RO|rw-RW|si-LK|sk-SK|sl-SI|so-SO|sr-RS|su-ID|sw-BI|sw-KE|sw-RW|sw-TZ|sw-UG|tl-PH|tt-RU|ug-CN|uk-UA|uz-UZ|wo-SN|zu-ZA',
        'Media' => [
            'MediaFileUri' => '<string>',
            'RedactedMediaFileUri' => '<string>',
        ],
        'MediaFormat' => 'mp3|mp4|wav|flac|ogg|amr|webm|m4a',
        'MediaSampleRateHertz' => <integer>,
        'MedicalTranscriptionJobName' => '<string>',
        'Settings' => [
            'ChannelIdentification' => true || false,
            'MaxAlternatives' => <integer>,
            'MaxSpeakerLabels' => <integer>,
            'ShowAlternatives' => true || false,
            'ShowSpeakerLabels' => true || false,
            'VocabularyName' => '<string>',
        ],
        'Specialty' => 'PRIMARYCARE',
        'StartTime' => <DateTime>,
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Transcript' => [
            'TranscriptFileUri' => '<string>',
        ],
        'TranscriptionJobStatus' => 'QUEUED|IN_PROGRESS|FAILED|COMPLETED',
        'Type' => 'CONVERSATION|DICTATION',
    ],
]

Result Details

Members
MedicalTranscriptionJob
Type: MedicalTranscriptionJob structure

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

Errors

BadRequestException:

Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

LimitExceededException:

You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

InternalFailureException:

There was an internal error. Check the error message, correct the issue, and try your request again.

ConflictException:

A resource already exists with this name. Resource names must be unique within an Amazon Web Services account.

StartTranscriptionJob 

$result = $client->startTranscriptionJob([/* ... */]);
$promise = $client->startTranscriptionJobAsync([/* ... */]);

Transcribes the audio from a media file and applies any additional Request Parameters you choose to include in your request.

To make a StartTranscriptionJob request, you must first upload your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location of the file using the Media parameter.

You must include the following parameters in your StartTranscriptionJob request:

  • region: The Amazon Web Services Region where you are making your request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas.

  • TranscriptionJobName: A custom name you create for your transcription job that is unique within your Amazon Web Services account.

  • Media (MediaFileUri): The Amazon S3 location of your media file.

  • One of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages: If you know the language of your media file, specify it using the LanguageCode parameter; you can find all valid language codes in the Supported languages table. If you do not know the languages spoken in your media, use either IdentifyLanguage or IdentifyMultipleLanguages and let Amazon Transcribe identify the languages for you.

Parameter Syntax

$result = $client->startTranscriptionJob([
    'ContentRedaction' => [
        'PiiEntityTypes' => ['<string>', ...],
        'RedactionOutput' => 'redacted|redacted_and_unredacted', // REQUIRED
        'RedactionType' => 'PII', // REQUIRED
    ],
    'IdentifyLanguage' => true || false,
    'IdentifyMultipleLanguages' => true || false,
    'JobExecutionSettings' => [
        'AllowDeferredExecution' => true || false,
        'DataAccessRoleArn' => '<string>',
    ],
    'KMSEncryptionContext' => ['<string>', ...],
    'LanguageCode' => 'af-ZA|ar-AE|ar-SA|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ|vi-VN|sv-SE|ab-GE|ast-ES|az-AZ|ba-RU|be-BY|bg-BG|bn-IN|bs-BA|ca-ES|ckb-IQ|ckb-IR|cs-CZ|cy-WL|el-GR|et-ET|eu-ES|fi-FI|gl-ES|gu-IN|ha-NG|hr-HR|hu-HU|hy-AM|is-IS|ka-GE|kab-DZ|kk-KZ|kn-IN|ky-KG|lg-IN|lt-LT|lv-LV|mhr-RU|mi-NZ|mk-MK|ml-IN|mn-MN|mr-IN|mt-MT|no-NO|or-IN|pa-IN|pl-PL|ps-AF|ro-RO|rw-RW|si-LK|sk-SK|sl-SI|so-SO|sr-RS|su-ID|sw-BI|sw-KE|sw-RW|sw-TZ|sw-UG|tl-PH|tt-RU|ug-CN|uk-UA|uz-UZ|wo-SN|zu-ZA',
    'LanguageIdSettings' => [
        '<LanguageCode>' => [
            'LanguageModelName' => '<string>',
            'VocabularyFilterName' => '<string>',
            'VocabularyName' => '<string>',
        ],
        // ...
    ],
    'LanguageOptions' => ['<string>', ...],
    'Media' => [ // REQUIRED
        'MediaFileUri' => '<string>',
        'RedactedMediaFileUri' => '<string>',
    ],
    'MediaFormat' => 'mp3|mp4|wav|flac|ogg|amr|webm|m4a',
    'MediaSampleRateHertz' => <integer>,
    'ModelSettings' => [
        'LanguageModelName' => '<string>',
    ],
    'OutputBucketName' => '<string>',
    'OutputEncryptionKMSKeyId' => '<string>',
    'OutputKey' => '<string>',
    'Settings' => [
        'ChannelIdentification' => true || false,
        'MaxAlternatives' => <integer>,
        'MaxSpeakerLabels' => <integer>,
        'ShowAlternatives' => true || false,
        'ShowSpeakerLabels' => true || false,
        'VocabularyFilterMethod' => 'remove|mask|tag',
        'VocabularyFilterName' => '<string>',
        'VocabularyName' => '<string>',
    ],
    'Subtitles' => [
        'Formats' => ['<string>', ...],
        'OutputStartIndex' => <integer>,
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'ToxicityDetection' => [
        [
            'ToxicityCategories' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'TranscriptionJobName' => '<string>', // REQUIRED
]);

Parameter Details

Members
ContentRedaction
Type: ContentRedaction structure

Makes it possible to redact or flag specified personally identifiable information (PII) in your transcript. If you use ContentRedaction, you must also include the sub-parameters: RedactionOutput and RedactionType. You can optionally include PiiEntityTypes to choose which types of PII you want to redact. If you do not include PiiEntityTypes in your request, all PII is redacted.

IdentifyLanguage
Type: boolean

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

If you include IdentifyLanguage, you can optionally include a list of language codes, using LanguageOptions, that you think may be present in your media file. Including LanguageOptions restricts IdentifyLanguage to only the language options that you specify, which can improve transcription accuracy.

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

Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails.

IdentifyMultipleLanguages
Type: boolean

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

If you include IdentifyMultipleLanguages, you can optionally include a list of language codes, using LanguageOptions, that you think may be present in your media file. Including LanguageOptions restricts IdentifyLanguage to only the language options that you specify, which can improve transcription accuracy.

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

Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails.

JobExecutionSettings
Type: JobExecutionSettings structure

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

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

KMSEncryptionContext
Type: Associative array of custom strings keys (NonEmptyString) to strings

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

LanguageCode
Type: string

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

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

Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails.

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

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

LanguageIdSettings
Type: Associative array of custom strings keys (LanguageCode) to LanguageIdSettings structures

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

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

It's recommended that you include LanguageOptions when using LanguageIdSettings to ensure that the correct language dialect is identified. For example, if you specify a custom vocabulary that is in en-US but Amazon Transcribe determines that the language spoken in your media is en-AU, your custom vocabulary is not applied to your transcription. If you include LanguageOptions and include en-US as the only English language dialect, your custom vocabulary is applied to your transcription.

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

LanguageOptions
Type: Array of strings

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

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

For more information, refer to Supported languages.

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

Media
Required: Yes
Type: Media structure

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

MediaFormat
Type: string

Specify the format of your input media file.

MediaSampleRateHertz
Type: int

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

If you do not specify the media sample rate, Amazon Transcribe determines it for you. If you specify the sample rate, it must match the rate detected by Amazon Transcribe. If there's a mismatch between the value that you specify and the value detected, your job fails. In most cases, you can omit MediaSampleRateHertz and let Amazon Transcribe determine the sample rate.

ModelSettings
Type: ModelSettings structure

Specify the custom language model you want to include with your transcription job. If you include ModelSettings in your request, you must include the LanguageModelName sub-parameter.

For more information, see Custom language models.

OutputBucketName
Type: string

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

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

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

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

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

OutputEncryptionKMSKeyId
Type: string

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

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

  1. Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.

  2. Use an alias for the KMS key ID. For example, alias/ExampleAlias.

  3. Use the Amazon Resource Name (ARN) for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

  4. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.

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

  1. Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

  2. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.

If you do not specify an encryption key, your output is encrypted with the default Amazon S3 key (SSE-S3).

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

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

OutputKey
Type: string

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

Here are some examples of how you can use OutputKey:

  • If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'my-transcript.json' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my-transcript.json.

  • If you specify 'my-first-transcription' as the TranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and 'my-transcript' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json.

  • If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'test-files/my-transcript.json' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json.

  • If you specify 'my-first-transcription' as the TranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and 'test-files/my-transcript' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json.

If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist, one is created for you.

Settings
Type: Settings structure

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

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

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

Subtitles
Type: Subtitles structure

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

Tags
Type: Array of Tag structures

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

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

ToxicityDetection
Type: Array of ToxicityDetectionSettings structures

Enables toxic speech detection in your transcript. If you include ToxicityDetection in your request, you must also include ToxicityCategories.

For information on the types of toxic speech Amazon Transcribe can detect, see Detecting toxic speech.

TranscriptionJobName
Required: Yes
Type: string

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

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

Result Syntax

[
    'TranscriptionJob' => [
        'CompletionTime' => <DateTime>,
        'ContentRedaction' => [
            'PiiEntityTypes' => ['<string>', ...],
            'RedactionOutput' => 'redacted|redacted_and_unredacted',
            'RedactionType' => 'PII',
        ],
        'CreationTime' => <DateTime>,
        'FailureReason' => '<string>',
        'IdentifiedLanguageScore' => <float>,
        'IdentifyLanguage' => true || false,
        'IdentifyMultipleLanguages' => true || false,
        'JobExecutionSettings' => [
            'AllowDeferredExecution' => true || false,
            'DataAccessRoleArn' => '<string>',
        ],
        'LanguageCode' => 'af-ZA|ar-AE|ar-SA|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ|vi-VN|sv-SE|ab-GE|ast-ES|az-AZ|ba-RU|be-BY|bg-BG|bn-IN|bs-BA|ca-ES|ckb-IQ|ckb-IR|cs-CZ|cy-WL|el-GR|et-ET|eu-ES|fi-FI|gl-ES|gu-IN|ha-NG|hr-HR|hu-HU|hy-AM|is-IS|ka-GE|kab-DZ|kk-KZ|kn-IN|ky-KG|lg-IN|lt-LT|lv-LV|mhr-RU|mi-NZ|mk-MK|ml-IN|mn-MN|mr-IN|mt-MT|no-NO|or-IN|pa-IN|pl-PL|ps-AF|ro-RO|rw-RW|si-LK|sk-SK|sl-SI|so-SO|sr-RS|su-ID|sw-BI|sw-KE|sw-RW|sw-TZ|sw-UG|tl-PH|tt-RU|ug-CN|uk-UA|uz-UZ|wo-SN|zu-ZA',
        'LanguageCodes' => [
            [
                'DurationInSeconds' => <float>,
                'LanguageCode' => 'af-ZA|ar-AE|ar-SA|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ|vi-VN|sv-SE|ab-GE|ast-ES|az-AZ|ba-RU|be-BY|bg-BG|bn-IN|bs-BA|ca-ES|ckb-IQ|ckb-IR|cs-CZ|cy-WL|el-GR|et-ET|eu-ES|fi-FI|gl-ES|gu-IN|ha-NG|hr-HR|hu-HU|hy-AM|is-IS|ka-GE|kab-DZ|kk-KZ|kn-IN|ky-KG|lg-IN|lt-LT|lv-LV|mhr-RU|mi-NZ|mk-MK|ml-IN|mn-MN|mr-IN|mt-MT|no-NO|or-IN|pa-IN|pl-PL|ps-AF|ro-RO|rw-RW|si-LK|sk-SK|sl-SI|so-SO|sr-RS|su-ID|sw-BI|sw-KE|sw-RW|sw-TZ|sw-UG|tl-PH|tt-RU|ug-CN|uk-UA|uz-UZ|wo-SN|zu-ZA',
            ],
            // ...
        ],
        'LanguageIdSettings' => [
            '<LanguageCode>' => [
                'LanguageModelName' => '<string>',
                'VocabularyFilterName' => '<string>',
                'VocabularyName' => '<string>',
            ],
            // ...
        ],
        'LanguageOptions' => ['<string>', ...],
        'Media' => [
            'MediaFileUri' => '<string>',
            'RedactedMediaFileUri' => '<string>',
        ],
        'MediaFormat' => 'mp3|mp4|wav|flac|ogg|amr|webm|m4a',
        'MediaSampleRateHertz' => <integer>,
        'ModelSettings' => [
            'LanguageModelName' => '<string>',
        ],
        'Settings' => [
            'ChannelIdentification' => true || false,
            'MaxAlternatives' => <integer>,
            'MaxSpeakerLabels' => <integer>,
            'ShowAlternatives' => true || false,
            'ShowSpeakerLabels' => true || false,
            'VocabularyFilterMethod' => 'remove|mask|tag',
            'VocabularyFilterName' => '<string>',
            'VocabularyName' => '<string>',
        ],
        'StartTime' => <DateTime>,
        'Subtitles' => [
            'Formats' => ['<string>', ...],
            'OutputStartIndex' => <integer>,
            'SubtitleFileUris' => ['<string>', ...],
        ],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ToxicityDetection' => [
            [
                'ToxicityCategories' => ['<string>', ...],
            ],
            // ...
        ],
        'Transcript' => [
            'RedactedTranscriptFileUri' => '<string>',
            'TranscriptFileUri' => '<string>',
        ],
        'TranscriptionJobName' => '<string>',
        'TranscriptionJobStatus' => 'QUEUED|IN_PROGRESS|FAILED|COMPLETED',
    ],
]

Result Details

Members
TranscriptionJob
Type: TranscriptionJob structure

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

Errors

BadRequestException:

Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

LimitExceededException:

You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

InternalFailureException:

There was an internal error. Check the error message, correct the issue, and try your request again.

ConflictException:

A resource already exists with this name. Resource names must be unique within an Amazon Web Services account.

TagResource 

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
ResourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource you want to tag. ARNs have the format arn:partition:service:region:account-id:resource-type/resource-id.

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

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

Tags
Required: Yes
Type: Array of Tag structures

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

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

BadRequestException:

Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

ConflictException:

A resource already exists with this name. Resource names must be unique within an Amazon Web Services account.

NotFoundException:

We can't find the requested resource. Check that the specified name is correct and try your request again.

LimitExceededException:

You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

InternalFailureException:

There was an internal error. Check the error message, correct the issue, and try your request again.

UntagResource 

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes the specified tags from the specified Amazon Transcribe resource.

If you include UntagResource in your request, you must also include ResourceArn and TagKeys.

Parameter Syntax

$result = $client->untagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
ResourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the Amazon Transcribe resource you want to remove tags from. ARNs have the format arn:partition:service:region:account-id:resource-type/resource-id.

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

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

TagKeys
Required: Yes
Type: Array of strings

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

LimitExceededException:

You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

BadRequestException:

Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

ConflictException:

A resource already exists with this name. Resource names must be unique within an Amazon Web Services account.

NotFoundException:

We can't find the requested resource. Check that the specified name is correct and try your request again.

InternalFailureException:

There was an internal error. Check the error message, correct the issue, and try your request again.

UpdateCallAnalyticsCategory 

$result = $client->updateCallAnalyticsCategory([/* ... */]);
$promise = $client->updateCallAnalyticsCategoryAsync([/* ... */]);

Updates the specified Call Analytics category with new rules. Note that the UpdateCallAnalyticsCategory operation overwrites all existing rules contained in the specified category. You cannot append additional rules onto an existing category.

To create a new category, see .

Parameter Syntax

$result = $client->updateCallAnalyticsCategory([
    'CategoryName' => '<string>', // REQUIRED
    'InputType' => 'REAL_TIME|POST_CALL',
    'Rules' => [ // REQUIRED
        [
            'InterruptionFilter' => [
                'AbsoluteTimeRange' => [
                    'EndTime' => <integer>,
                    'First' => <integer>,
                    'Last' => <integer>,
                    'StartTime' => <integer>,
                ],
                'Negate' => true || false,
                'ParticipantRole' => 'AGENT|CUSTOMER',
                'RelativeTimeRange' => [
                    'EndPercentage' => <integer>,
                    'First' => <integer>,
                    'Last' => <integer>,
                    'StartPercentage' => <integer>,
                ],
                'Threshold' => <integer>,
            ],
            'NonTalkTimeFilter' => [
                'AbsoluteTimeRange' => [
                    'EndTime' => <integer>,
                    'First' => <integer>,
                    'Last' => <integer>,
                    'StartTime' => <integer>,
                ],
                'Negate' => true || false,
                'RelativeTimeRange' => [
                    'EndPercentage' => <integer>,
                    'First' => <integer>,
                    'Last' => <integer>,
                    'StartPercentage' => <integer>,
                ],
                'Threshold' => <integer>,
            ],
            'SentimentFilter' => [
                'AbsoluteTimeRange' => [
                    'EndTime' => <integer>,
                    'First' => <integer>,
                    'Last' => <integer>,
                    'StartTime' => <integer>,
                ],
                'Negate' => true || false,
                'ParticipantRole' => 'AGENT|CUSTOMER',
                'RelativeTimeRange' => [
                    'EndPercentage' => <integer>,
                    'First' => <integer>,
                    'Last' => <integer>,
                    'StartPercentage' => <integer>,
                ],
                'Sentiments' => ['<string>', ...], // REQUIRED
            ],
            'TranscriptFilter' => [
                'AbsoluteTimeRange' => [
                    'EndTime' => <integer>,
                    'First' => <integer>,
                    'Last' => <integer>,
                    'StartTime' => <integer>,
                ],
                'Negate' => true || false,
                'ParticipantRole' => 'AGENT|CUSTOMER',
                'RelativeTimeRange' => [
                    'EndPercentage' => <integer>,
                    'First' => <integer>,
                    'Last' => <integer>,
                    'StartPercentage' => <integer>,
                ],
                'Targets' => ['<string>', ...], // REQUIRED
                'TranscriptFilterType' => 'EXACT', // REQUIRED
            ],
        ],
        // ...
    ],
]);

Parameter Details

Members
CategoryName
Required: Yes
Type: string

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

InputType
Type: string

Choose whether you want to update a real-time or a post-call category. The input type you specify must match the input type specified when the category was created. For example, if you created a category with the POST_CALL input type, you must use POST_CALL as the input type when updating this category.

Rules
Required: Yes
Type: Array of Rule structures

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

Result Syntax

[
    'CategoryProperties' => [
        'CategoryName' => '<string>',
        'CreateTime' => <DateTime>,
        'InputType' => 'REAL_TIME|POST_CALL',
        'LastUpdateTime' => <DateTime>,
        'Rules' => [
            [
                'InterruptionFilter' => [
                    'AbsoluteTimeRange' => [
                        'EndTime' => <integer>,
                        'First' => <integer>,
                        'Last' => <integer>,
                        'StartTime' => <integer>,
                    ],
                    'Negate' => true || false,
                    'ParticipantRole' => 'AGENT|CUSTOMER',
                    'RelativeTimeRange' => [
                        'EndPercentage' => <integer>,
                        'First' => <integer>,
                        'Last' => <integer>,
                        'StartPercentage' => <integer>,
                    ],
                    'Threshold' => <integer>,
                ],
                'NonTalkTimeFilter' => [
                    'AbsoluteTimeRange' => [
                        'EndTime' => <integer>,
                        'First' => <integer>,
                        'Last' => <integer>,
                        'StartTime' => <integer>,
                    ],
                    'Negate' => true || false,
                    'RelativeTimeRange' => [
                        'EndPercentage' => <integer>,
                        'First' => <integer>,
                        'Last' => <integer>,
                        'StartPercentage' => <integer>,
                    ],
                    'Threshold' => <integer>,
                ],
                'SentimentFilter' => [
                    'AbsoluteTimeRange' => [
                        'EndTime' => <integer>,
                        'First' => <integer>,
                        'Last' => <integer>,
                        'StartTime' => <integer>,
                    ],
                    'Negate' => true || false,
                    'ParticipantRole' => 'AGENT|CUSTOMER',
                    'RelativeTimeRange' => [
                        'EndPercentage' => <integer>,
                        'First' => <integer>,
                        'Last' => <integer>,
                        'StartPercentage' => <integer>,
                    ],
                    'Sentiments' => ['<string>', ...],
                ],
                'TranscriptFilter' => [
                    'AbsoluteTimeRange' => [
                        'EndTime' => <integer>,
                        'First' => <integer>,
                        'Last' => <integer>,
                        'StartTime' => <integer>,
                    ],
                    'Negate' => true || false,
                    'ParticipantRole' => 'AGENT|CUSTOMER',
                    'RelativeTimeRange' => [
                        'EndPercentage' => <integer>,
                        'First' => <integer>,
                        'Last' => <integer>,
                        'StartPercentage' => <integer>,
                    ],
                    'Targets' => ['<string>', ...],
                    'TranscriptFilterType' => 'EXACT',
                ],
            ],
            // ...
        ],
    ],
]

Result Details

Members
CategoryProperties
Type: CategoryProperties structure

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

Errors

BadRequestException:

Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

LimitExceededException:

You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

InternalFailureException:

There was an internal error. Check the error message, correct the issue, and try your request again.

NotFoundException:

We can't find the requested resource. Check that the specified name is correct and try your request again.

ConflictException:

A resource already exists with this name. Resource names must be unique within an Amazon Web Services account.

UpdateMedicalVocabulary 

$result = $client->updateMedicalVocabulary([/* ... */]);
$promise = $client->updateMedicalVocabularyAsync([/* ... */]);

Updates an existing custom medical vocabulary with new values. This operation overwrites all existing information with your new values; you cannot append new terms onto an existing custom vocabulary.

Parameter Syntax

$result = $client->updateMedicalVocabulary([
    'LanguageCode' => 'af-ZA|ar-AE|ar-SA|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ|vi-VN|sv-SE|ab-GE|ast-ES|az-AZ|ba-RU|be-BY|bg-BG|bn-IN|bs-BA|ca-ES|ckb-IQ|ckb-IR|cs-CZ|cy-WL|el-GR|et-ET|eu-ES|fi-FI|gl-ES|gu-IN|ha-NG|hr-HR|hu-HU|hy-AM|is-IS|ka-GE|kab-DZ|kk-KZ|kn-IN|ky-KG|lg-IN|lt-LT|lv-LV|mhr-RU|mi-NZ|mk-MK|ml-IN|mn-MN|mr-IN|mt-MT|no-NO|or-IN|pa-IN|pl-PL|ps-AF|ro-RO|rw-RW|si-LK|sk-SK|sl-SI|so-SO|sr-RS|su-ID|sw-BI|sw-KE|sw-RW|sw-TZ|sw-UG|tl-PH|tt-RU|ug-CN|uk-UA|uz-UZ|wo-SN|zu-ZA', // REQUIRED
    'VocabularyFileUri' => '<string>', // REQUIRED
    'VocabularyName' => '<string>', // REQUIRED
]);

Parameter Details

Members
LanguageCode
Required: Yes
Type: string

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

VocabularyFileUri
Required: Yes
Type: string

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

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

VocabularyName
Required: Yes
Type: string

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

Result Syntax

[
    'LanguageCode' => 'af-ZA|ar-AE|ar-SA|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ|vi-VN|sv-SE|ab-GE|ast-ES|az-AZ|ba-RU|be-BY|bg-BG|bn-IN|bs-BA|ca-ES|ckb-IQ|ckb-IR|cs-CZ|cy-WL|el-GR|et-ET|eu-ES|fi-FI|gl-ES|gu-IN|ha-NG|hr-HR|hu-HU|hy-AM|is-IS|ka-GE|kab-DZ|kk-KZ|kn-IN|ky-KG|lg-IN|lt-LT|lv-LV|mhr-RU|mi-NZ|mk-MK|ml-IN|mn-MN|mr-IN|mt-MT|no-NO|or-IN|pa-IN|pl-PL|ps-AF|ro-RO|rw-RW|si-LK|sk-SK|sl-SI|so-SO|sr-RS|su-ID|sw-BI|sw-KE|sw-RW|sw-TZ|sw-UG|tl-PH|tt-RU|ug-CN|uk-UA|uz-UZ|wo-SN|zu-ZA',
    'LastModifiedTime' => <DateTime>,
    'VocabularyName' => '<string>',
    'VocabularyState' => 'PENDING|READY|FAILED',
]

Result Details

Members
LanguageCode
Type: string

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

LastModifiedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.

VocabularyName
Type: string

The name of the updated custom medical vocabulary.

VocabularyState
Type: string

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

Errors

BadRequestException:

Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

LimitExceededException:

You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

InternalFailureException:

There was an internal error. Check the error message, correct the issue, and try your request again.

NotFoundException:

We can't find the requested resource. Check that the specified name is correct and try your request again.

ConflictException:

A resource already exists with this name. Resource names must be unique within an Amazon Web Services account.

UpdateVocabulary 

$result = $client->updateVocabulary([/* ... */]);
$promise = $client->updateVocabularyAsync([/* ... */]);

Updates an existing custom vocabulary with new values. This operation overwrites all existing information with your new values; you cannot append new terms onto an existing custom vocabulary.

Parameter Syntax

$result = $client->updateVocabulary([
    'DataAccessRoleArn' => '<string>',
    'LanguageCode' => 'af-ZA|ar-AE|ar-SA|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ|vi-VN|sv-SE|ab-GE|ast-ES|az-AZ|ba-RU|be-BY|bg-BG|bn-IN|bs-BA|ca-ES|ckb-IQ|ckb-IR|cs-CZ|cy-WL|el-GR|et-ET|eu-ES|fi-FI|gl-ES|gu-IN|ha-NG|hr-HR|hu-HU|hy-AM|is-IS|ka-GE|kab-DZ|kk-KZ|kn-IN|ky-KG|lg-IN|lt-LT|lv-LV|mhr-RU|mi-NZ|mk-MK|ml-IN|mn-MN|mr-IN|mt-MT|no-NO|or-IN|pa-IN|pl-PL|ps-AF|ro-RO|rw-RW|si-LK|sk-SK|sl-SI|so-SO|sr-RS|su-ID|sw-BI|sw-KE|sw-RW|sw-TZ|sw-UG|tl-PH|tt-RU|ug-CN|uk-UA|uz-UZ|wo-SN|zu-ZA', // REQUIRED
    'Phrases' => ['<string>', ...],
    'VocabularyFileUri' => '<string>',
    'VocabularyName' => '<string>', // REQUIRED
]);

Parameter Details

Members
DataAccessRoleArn
Type: string

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

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

For more information, see IAM ARNs.

LanguageCode
Required: Yes
Type: string

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

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

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

Phrases
Type: Array of strings

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

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

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

VocabularyFileUri
Type: string

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

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

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

VocabularyName
Required: Yes
Type: string

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

Result Syntax

[
    'LanguageCode' => 'af-ZA|ar-AE|ar-SA|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ|vi-VN|sv-SE|ab-GE|ast-ES|az-AZ|ba-RU|be-BY|bg-BG|bn-IN|bs-BA|ca-ES|ckb-IQ|ckb-IR|cs-CZ|cy-WL|el-GR|et-ET|eu-ES|fi-FI|gl-ES|gu-IN|ha-NG|hr-HR|hu-HU|hy-AM|is-IS|ka-GE|kab-DZ|kk-KZ|kn-IN|ky-KG|lg-IN|lt-LT|lv-LV|mhr-RU|mi-NZ|mk-MK|ml-IN|mn-MN|mr-IN|mt-MT|no-NO|or-IN|pa-IN|pl-PL|ps-AF|ro-RO|rw-RW|si-LK|sk-SK|sl-SI|so-SO|sr-RS|su-ID|sw-BI|sw-KE|sw-RW|sw-TZ|sw-UG|tl-PH|tt-RU|ug-CN|uk-UA|uz-UZ|wo-SN|zu-ZA',
    'LastModifiedTime' => <DateTime>,
    'VocabularyName' => '<string>',
    'VocabularyState' => 'PENDING|READY|FAILED',
]

Result Details

Members
LanguageCode
Type: string

The language code you selected for your custom vocabulary.

LastModifiedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.

VocabularyName
Type: string

The name of the updated custom vocabulary.

VocabularyState
Type: string

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

Errors

BadRequestException:

Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

LimitExceededException:

You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

InternalFailureException:

There was an internal error. Check the error message, correct the issue, and try your request again.

NotFoundException:

We can't find the requested resource. Check that the specified name is correct and try your request again.

ConflictException:

A resource already exists with this name. Resource names must be unique within an Amazon Web Services account.

UpdateVocabularyFilter 

$result = $client->updateVocabularyFilter([/* ... */]);
$promise = $client->updateVocabularyFilterAsync([/* ... */]);

Updates an existing custom vocabulary filter with a new list of words. The new list you provide overwrites all previous entries; you cannot append new terms onto an existing custom vocabulary filter.

Parameter Syntax

$result = $client->updateVocabularyFilter([
    'DataAccessRoleArn' => '<string>',
    'VocabularyFilterFileUri' => '<string>',
    'VocabularyFilterName' => '<string>', // REQUIRED
    'Words' => ['<string>', ...],
]);

Parameter Details

Members
DataAccessRoleArn
Type: string

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

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

For more information, see IAM ARNs.

VocabularyFilterFileUri
Type: string

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

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

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

VocabularyFilterName
Required: Yes
Type: string

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

Words
Type: Array of strings

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

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

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

Result Syntax

[
    'LanguageCode' => 'af-ZA|ar-AE|ar-SA|da-DK|de-CH|de-DE|en-AB|en-AU|en-GB|en-IE|en-IN|en-US|en-WL|es-ES|es-US|fa-IR|fr-CA|fr-FR|he-IL|hi-IN|id-ID|it-IT|ja-JP|ko-KR|ms-MY|nl-NL|pt-BR|pt-PT|ru-RU|ta-IN|te-IN|tr-TR|zh-CN|zh-TW|th-TH|en-ZA|en-NZ|vi-VN|sv-SE|ab-GE|ast-ES|az-AZ|ba-RU|be-BY|bg-BG|bn-IN|bs-BA|ca-ES|ckb-IQ|ckb-IR|cs-CZ|cy-WL|el-GR|et-ET|eu-ES|fi-FI|gl-ES|gu-IN|ha-NG|hr-HR|hu-HU|hy-AM|is-IS|ka-GE|kab-DZ|kk-KZ|kn-IN|ky-KG|lg-IN|lt-LT|lv-LV|mhr-RU|mi-NZ|mk-MK|ml-IN|mn-MN|mr-IN|mt-MT|no-NO|or-IN|pa-IN|pl-PL|ps-AF|ro-RO|rw-RW|si-LK|sk-SK|sl-SI|so-SO|sr-RS|su-ID|sw-BI|sw-KE|sw-RW|sw-TZ|sw-UG|tl-PH|tt-RU|ug-CN|uk-UA|uz-UZ|wo-SN|zu-ZA',
    'LastModifiedTime' => <DateTime>,
    'VocabularyFilterName' => '<string>',
]

Result Details

Members
LanguageCode
Type: string

The language code you selected for your custom vocabulary filter.

LastModifiedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.

VocabularyFilterName
Type: string

The name of the updated custom vocabulary filter.

Errors

BadRequestException:

Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

LimitExceededException:

You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

InternalFailureException:

There was an internal error. Check the error message, correct the issue, and try your request again.

NotFoundException:

We can't find the requested resource. Check that the specified name is correct and try your request again.

Shapes

AbsoluteTimeRange

Description

A time range, in milliseconds, between two points in your media file.

You can use StartTime and EndTime to search a custom segment. For example, setting StartTime to 10000 and EndTime to 50000 only searches for your specified criteria in the audio contained between the 10,000 millisecond mark and the 50,000 millisecond mark of your media file. You must use StartTime and EndTime as a set; that is, if you include one, you must include both.

You can use also First to search from the start of the audio until the time that you specify, or Last to search from the time that you specify until the end of the audio. For example, setting First to 50000 only searches for your specified criteria in the audio contained between the start of the media file to the 50,000 millisecond mark. You can use First and Last independently of each other.

If you prefer to use percentage instead of milliseconds, see .

Members
EndTime
Type: long (int|float)

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

First
Type: long (int|float)

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

Last
Type: long (int|float)

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

StartTime
Type: long (int|float)

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

BadRequestException

Description

Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

Members
Message
Type: string

CallAnalyticsJob

Description

Provides detailed information about a Call Analytics job.

To view the job's status, refer to CallAnalyticsJobStatus. If the status is COMPLETED, the job is finished. You can find your completed transcript at the URI specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed.

If you enabled personally identifiable information (PII) redaction, the redacted transcript appears at the location specified in RedactedTranscriptFileUri.

If you chose to redact the audio in your media file, you can find your redacted media file at the location specified in the RedactedMediaFileUri field of your response.

Members
CallAnalyticsJobDetails
Type: CallAnalyticsJobDetails structure

Provides detailed information about a call analytics job, including information about skipped analytics features.

CallAnalyticsJobName
Type: string

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

CallAnalyticsJobStatus
Type: string

Provides the status of the specified Call Analytics job.

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

ChannelDefinitions
Type: Array of ChannelDefinition structures

Indicates which speaker is on which channel.

CompletionTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the specified Call Analytics job finished processing.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022.

CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the specified Call Analytics job request was made.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

DataAccessRoleArn
Type: string

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

FailureReason
Type: string

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

The FailureReason field contains one of the following values:

  • Unsupported media format.

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

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

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

  • Invalid sample rate for audio file.

    The sample rate specified in MediaSampleRateHertz isn't valid. The sample rate must be between 8,000 and 48,000 hertz.

  • The sample rate provided does not match the detected sample rate.

    The sample rate specified in MediaSampleRateHertz doesn't match the sample rate detected in your input media file. Check the sample rate of your media file and correct the specified value.

  • Invalid file size: file size too large.

    The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Service quotas.

  • Invalid number of channels: number of channels too large.

    Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Service quotas.

IdentifiedLanguageScore
Type: float

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

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

LanguageCode
Type: string

The language code used to create your Call Analytics job. For a list of supported languages and their associated language codes, refer to the Supported languages table.

If you do not know the language spoken in your media file, you can omit this field and let Amazon Transcribe automatically identify the language of your media. To improve the accuracy of language identification, you can include several language codes and Amazon Transcribe chooses the closest match for your transcription.

Media
Type: Media structure

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

MediaFormat
Type: string

The format of the input media file.

MediaSampleRateHertz
Type: int

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

Settings
Type: CallAnalyticsJobSettings structure

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

StartTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the specified Call Analytics job began processing.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

Transcript
Type: Transcript structure

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

CallAnalyticsJobDetails

Description

Contains details about a call analytics job, including information about skipped analytics features.

Members
Skipped
Type: Array of CallAnalyticsSkippedFeature structures

Contains information about any skipped analytics features during the analysis of a call analytics job.

This array lists all the analytics features that were skipped, along with their corresponding reason code and message.

CallAnalyticsJobSettings

Description

Provides additional optional settings for your request, including content redaction, automatic language identification; allows you to apply custom language models, custom vocabulary filters, and custom vocabularies.

Members
ContentRedaction
Type: ContentRedaction structure

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

LanguageIdSettings
Type: Associative array of custom strings keys (LanguageCode) to LanguageIdSettings structures

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

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

It's recommended that you include LanguageOptions when using LanguageIdSettings to ensure that the correct language dialect is identified. For example, if you specify a custom vocabulary that is in en-US but Amazon Transcribe determines that the language spoken in your media is en-AU, your custom vocabulary is not applied to your transcription. If you include LanguageOptions and include en-US as the only English language dialect, your custom vocabulary is applied to your transcription.

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

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

LanguageModelName
Type: string

The name of the custom language model you want to use when processing your Call Analytics job. Note that custom language model names are case sensitive.

The language of the specified custom language model must match the language code that you specify in your transcription request. If the languages do not match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch.

LanguageOptions
Type: Array of strings

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

Including language options can improve the accuracy of language identification.

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

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

Summarization
Type: Summarization structure

Contains GenerateAbstractiveSummary, which is a required parameter if you want to enable Generative call summarization in your Call Analytics request.

VocabularyFilterMethod
Type: string

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

To replace words with ***, choose mask.

To delete words, choose remove.

To flag words without changing them, choose tag.

VocabularyFilterName
Type: string

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

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

VocabularyName
Type: string

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

CallAnalyticsJobSummary

Description

Provides detailed information about a specific Call Analytics job.

Members
CallAnalyticsJobDetails
Type: CallAnalyticsJobDetails structure

Provides detailed information about a call analytics job, including information about skipped analytics features.

CallAnalyticsJobName
Type: string

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

CallAnalyticsJobStatus
Type: string

Provides the status of your Call Analytics job.

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

CompletionTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the specified Call Analytics job finished processing.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022.

CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the specified Call Analytics job request was made.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

FailureReason
Type: string

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

LanguageCode
Type: string

The language code used to create your Call Analytics transcription.

StartTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time your Call Analytics job began processing.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

CallAnalyticsSkippedFeature

Description

Represents a skipped analytics feature during the analysis of a call analytics job.

The Feature field indicates the type of analytics feature that was skipped.

The Message field contains additional information or a message explaining why the analytics feature was skipped.

The ReasonCode field provides a code indicating the reason why the analytics feature was skipped.

Members
Feature
Type: string

Indicates the type of analytics feature that was skipped during the analysis of a call analytics job.

Message
Type: string

Contains additional information or a message explaining why a specific analytics feature was skipped during the analysis of a call analytics job.

ReasonCode
Type: string

Provides a code indicating the reason why a specific analytics feature was skipped during the analysis of a call analytics job.

CategoryProperties

Description

Provides you with the properties of the Call Analytics category you specified in your request. This includes the list of rules that define the specified category.

Members
CategoryName
Type: string

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

CreateTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the specified Call Analytics category was created.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.

InputType
Type: string

The input type associated with the specified category. POST_CALL refers to a category that is applied to batch transcriptions; REAL_TIME refers to a category that is applied to streaming transcriptions.

LastUpdateTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the specified Call Analytics category was last updated.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-05T12:45:32.691000-07:00 represents 12:45 PM UTC-7 on May 5, 2022.

Rules
Type: Array of Rule structures

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

ChannelDefinition

Description

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

Members
ChannelId
Type: int

Specify the audio channel you want to define.

ParticipantRole
Type: string

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

ConflictException

Description

A resource already exists with this name. Resource names must be unique within an Amazon Web Services account.

Members
Message
Type: string

ContentRedaction

Description

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

Members
PiiEntityTypes
Type: Array of strings

Specify which types of personally identifiable information (PII) you want to redact in your transcript. You can include as many types as you'd like, or you can select ALL. If you do not include PiiEntityTypes in your request, all PII is redacted.

RedactionOutput
Required: Yes
Type: string

Specify if you want only a redacted transcript, or if you want a redacted and an unredacted transcript.

When you choose redacted Amazon Transcribe creates only a redacted transcript.

When you choose redacted_and_unredacted Amazon Transcribe creates a redacted and an unredacted transcript (as two separate files).

RedactionType
Required: Yes
Type: string

Specify the category of information you want to redact; PII (personally identifiable information) is the only valid value. You can use PiiEntityTypes to choose which types of PII you want to redact. If you do not include PiiEntityTypes in your request, all PII is redacted.

InputDataConfig

Description

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

When using InputDataConfig, you must include these sub-parameters: S3Uri and DataAccessRoleArn. You can optionally include TuningDataS3Uri.

Members
DataAccessRoleArn
Required: Yes
Type: string

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

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

For more information, see IAM ARNs.

S3Uri
Required: Yes
Type: string

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

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

TuningDataS3Uri
Type: string

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

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

InternalFailureException

Description

There was an internal error. Check the error message, correct the issue, and try your request again.

Members
Message
Type: string

InterruptionFilter

Description

Flag the presence or absence of interruptions in your Call Analytics transcription output.

Rules using InterruptionFilter are designed to match:

  • Instances where an agent interrupts a customer

  • Instances where a customer interrupts an agent

  • Either participant interrupting the other

  • A lack of interruptions

See Rule criteria for post-call categories for usage examples.

Members
AbsoluteTimeRange
Type: AbsoluteTimeRange structure

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

Negate
Type: boolean

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

ParticipantRole
Type: string

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

RelativeTimeRange
Type: RelativeTimeRange structure

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

Threshold
Type: long (int|float)

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

JobExecutionSettings

Description

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

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

Members
AllowDeferredExecution
Type: boolean

Makes it possible to enable job queuing when your concurrent request limit is exceeded. When AllowDeferredExecution is set to true, transcription job requests are placed in a queue until the number of jobs falls below the concurrent request limit. If AllowDeferredExecution is set to false and the number of transcription job requests exceed the concurrent request limit, you get a LimitExceededException error.

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

DataAccessRoleArn
Type: string

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

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

Note that if you include DataAccessRoleArn in your request, you must also include AllowDeferredExecution.

LanguageCodeItem

Description

Provides information on the speech contained in a discreet utterance when multi-language identification is enabled in your request. This utterance represents a block of speech consisting of one language, preceded or followed by a block of speech in a different language.

Members
DurationInSeconds
Type: float

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

LanguageCode
Type: string

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

LanguageIdSettings

Description

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

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

It's recommended that you include LanguageOptions when using LanguageIdSettings to ensure that the correct language dialect is identified. For example, if you specify a custom vocabulary that is in en-US but Amazon Transcribe determines that the language spoken in your media is en-AU, your custom vocabulary is not applied to your transcription. If you include LanguageOptions and include en-US as the only English language dialect, your custom vocabulary is applied to your transcription.

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

Members
LanguageModelName
Type: string

The name of the custom language model you want to use when processing your transcription job. Note that custom language model names are case sensitive.

The language of the specified custom language model must match the language code that you specify in your transcription request. If the languages do not match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch.

VocabularyFilterName
Type: string

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

The language of the specified custom vocabulary filter must match the language code that you specify in your transcription request. If the languages do not match, the custom vocabulary filter isn't applied. There are no errors or warnings associated with a language mismatch.

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

VocabularyName
Type: string

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

The language of the specified custom vocabulary must match the language code that you specify in your transcription request. If the languages do not match, the custom vocabulary isn't applied. There are no errors or warnings associated with a language mismatch.

LanguageModel

Description

Provides information about a custom language model, including:

  • The base model name

  • When the model was created

  • The location of the files used to train the model

  • When the model was last modified

  • The name you chose for the model

  • The model's language

  • The model's processing state

  • Any available upgrades for the base model

Members
BaseModelName
Type: string

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

CreateTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the specified custom language model was created.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.

FailureReason
Type: string

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

InputDataConfig
Type: InputDataConfig structure

The Amazon S3 location of the input files used to train and tune your custom language model, in addition to the data access role ARN (Amazon Resource Name) that has permissions to access these data.

LanguageCode
Type: string

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

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

LastModifiedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.

ModelName
Type: string

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

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

ModelStatus
Type: string

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

UpgradeAvailability
Type: boolean

Shows if a more current base model is available for use with the specified custom language model.

If false, your custom language model is using the most up-to-date base model.

If true, there is a newer base model available than the one your language model is using.

Note that to update a base model, you must recreate the custom language model using the new base model. Base model upgrades for existing custom language models are not supported.

LimitExceededException

Description

You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

Members
Message
Type: string

Media

Description

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

For information on supported media formats, refer to the MediaFormat parameter or the Media formats section in the Amazon S3 Developer Guide.

Members
MediaFileUri
Type: string

The Amazon S3 location of the media file you want to transcribe. For example:

  • s3://DOC-EXAMPLE-BUCKET/my-media-file.flac

  • s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac

Note that the Amazon S3 bucket that contains your input media must be located in the same Amazon Web Services Region where you're making your transcription request.

RedactedMediaFileUri
Type: string

The Amazon S3 location of the media file you want to redact. For example:

  • s3://DOC-EXAMPLE-BUCKET/my-media-file.flac

  • s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac

Note that the Amazon S3 bucket that contains your input media must be located in the same Amazon Web Services Region where you're making your transcription request.

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

MedicalScribeChannelDefinition

Description

Indicates which speaker is on which channel. The options are CLINICIAN and PATIENT

Members
ChannelId
Required: Yes
Type: int

Specify the audio channel you want to define.

ParticipantRole
Required: Yes
Type: string

Specify the participant that you want to flag. The options are CLINICIAN and PATIENT

MedicalScribeJob

Description

Provides detailed information about a Medical Scribe job.

To view the status of the specified Medical Scribe job, check the MedicalScribeJobStatus field. If the status is COMPLETED, the job is finished and you can find the results at the locations specified in MedicalScribeOutput. If the status is FAILED, FailureReason provides details on why your Medical Scribe job failed.

Members
ChannelDefinitions
Type: Array of MedicalScribeChannelDefinition structures

Makes it possible to specify which speaker is on which channel. For example, if the clinician is the first participant to speak, you would set ChannelId of the first ChannelDefinition in the list to 0 (to indicate the first channel) and ParticipantRole to CLINICIAN (to indicate that it's the clinician speaking). Then you would set the ChannelId of the second ChannelDefinition in the list to 1 (to indicate the second channel) and ParticipantRole to PATIENT (to indicate that it's the patient speaking).

CompletionTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the specified Medical Scribe job finished processing.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job that finished processing at 12:32 PM UTC-7 on May 4, 2022.

CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the specified Medical Scribe job request was made.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job that started processing at 12:32 PM UTC-7 on May 4, 2022.

DataAccessRoleArn
Type: string

The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files, write to the output bucket, and use your KMS key if supplied. If the role that you specify doesn’t have the appropriate permissions your request fails.

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

For more information, see IAM ARNs.

FailureReason
Type: string

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

LanguageCode
Type: string

The language code used to create your Medical Scribe job. US English (en-US) is the only supported language for Medical Scribe jobs.

Media
Type: Media structure

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

For information on supported media formats, refer to the MediaFormat parameter or the Media formats section in the Amazon S3 Developer Guide.

MedicalScribeJobName
Type: string

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

MedicalScribeJobStatus
Type: string

Provides the status of the specified Medical Scribe job.

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

MedicalScribeOutput
Type: MedicalScribeOutput structure

The location of the output of your Medical Scribe job. ClinicalDocumentUri holds the Amazon S3 URI for the Clinical Document and TranscriptFileUri holds the Amazon S3 URI for the Transcript.

Settings
Type: MedicalScribeSettings structure

Makes it possible to control how your Medical Scribe job is processed using a MedicalScribeSettings object. Specify ChannelIdentification if ChannelDefinitions are set. Enabled ShowSpeakerLabels if ChannelIdentification and ChannelDefinitions are not set. One and only one of ChannelIdentification and ShowSpeakerLabels must be set. If ShowSpeakerLabels is set, MaxSpeakerLabels must also be set. Use Settings to specify a vocabulary or vocabulary filter or both using VocabularyName, VocabularyFilterName. VocabularyFilterMethod must be specified if VocabularyFilterName is set.

StartTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time your Medical Scribe job began processing.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.789000-07:00 represents a Medical Scribe job that started processing at 12:32 PM UTC-7 on May 4, 2022.

Tags
Type: Array of Tag structures

Adds one or more custom tags, each in the form of a key:value pair, to the Medica Scribe job.

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

MedicalScribeJobSummary

Description

Provides detailed information about a specific Medical Scribe job.

Members
CompletionTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the specified Medical Scribe job finished processing.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job that finished processing at 12:32 PM UTC-7 on May 4, 2022.

CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the specified Medical Scribe job request was made.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job that started processing at 12:32 PM UTC-7 on May 4, 2022.

FailureReason
Type: string

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

LanguageCode
Type: string

The language code used to create your Medical Scribe job. US English (en-US) is the only supported language for Medical Scribe jobs.

MedicalScribeJobName
Type: string

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

MedicalScribeJobStatus
Type: string

Provides the status of the specified Medical Scribe job.

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

StartTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time your Medical Scribe job began processing.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.789000-07:00 represents a Medical Scribe job that started processing at 12:32 PM UTC-7 on May 4, 2022.

MedicalScribeOutput

Description

The location of the output of your Medical Scribe job. ClinicalDocumentUri holds the Amazon S3 URI for the Clinical Document and TranscriptFileUri holds the Amazon S3 URI for the Transcript.

Members
ClinicalDocumentUri
Required: Yes
Type: string

Holds the Amazon S3 URI for the Clinical Document.

TranscriptFileUri
Required: Yes
Type: string

Holds the Amazon S3 URI for the Transcript.

MedicalScribeSettings

Description

Makes it possible to control how your Medical Scribe job is processed using a MedicalScribeSettings object. Specify ChannelIdentification if ChannelDefinitions are set. Enabled ShowSpeakerLabels if ChannelIdentification and ChannelDefinitions are not set. One and only one of ChannelIdentification and ShowSpeakerLabels must be set. If ShowSpeakerLabels is set, MaxSpeakerLabels must also be set. Use Settings to specify a vocabulary or vocabulary filter or both using VocabularyName, VocabularyFilterName. VocabularyFilterMethod must be specified if VocabularyFilterName is set.

Members
ChannelIdentification
Type: boolean

Enables channel identification in multi-channel audio.

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

For more information, see Transcribing multi-channel audio.

MaxSpeakerLabels
Type: int

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

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

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

ShowSpeakerLabels
Type: boolean

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

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

For more information, see Partitioning speakers (diarization).

VocabularyFilterMethod
Type: string

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

To replace words with ***, choose mask.

To delete words, choose remove.

To flag words without changing them, choose tag.

VocabularyFilterName
Type: string

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

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

VocabularyName
Type: string

The name of the custom vocabulary you want to include in your Medical Scribe request. Custom vocabulary names are case sensitive.

MedicalTranscript

Description

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

Members
TranscriptFileUri
Type: string

The Amazon S3 location of your transcript. You can use this URI to access or download your transcript.

Note that this is the Amazon S3 location you specified in your request using the OutputBucketName parameter.

MedicalTranscriptionJob

Description

Provides detailed information about a medical transcription job.

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

Members
CompletionTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the specified medical transcription job finished processing.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022.

ContentIdentificationType
Type: string

Indicates whether content identification was enabled for your transcription request.

CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the specified medical transcription job request was made.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

FailureReason
Type: string

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

The FailureReason field contains one of the following values:

  • Unsupported media format.

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

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

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

  • Invalid sample rate for audio file.

    The sample rate specified in MediaSampleRateHertz isn't valid. The sample rate must be between 16,000 and 48,000 hertz.

  • The sample rate provided does not match the detected sample rate.

    The sample rate specified in MediaSampleRateHertz doesn't match the sample rate detected in your input media file. Check the sample rate of your media file and correct the specified value.

  • Invalid file size: file size too large.

    The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Service quotas.

  • Invalid number of channels: number of channels too large.

    Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Service quotas.

LanguageCode
Type: string

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

Media
Type: Media structure

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

For information on supported media formats, refer to the MediaFormat parameter or the Media formats section in the Amazon S3 Developer Guide.

MediaFormat
Type: string

The format of the input media file.

MediaSampleRateHertz
Type: int

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

MedicalTranscriptionJobName
Type: string

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

Settings
Type: MedicalTranscriptionSetting structure

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

Specialty
Type: string

Describes the medical specialty represented in your media.

StartTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the specified medical transcription job began processing.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

Tags
Type: Array of Tag structures

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

Transcript
Type: MedicalTranscript structure

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

TranscriptionJobStatus
Type: string

Provides the status of the specified medical transcription job.

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

Type
Type: string

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

MedicalTranscriptionJobSummary

Description

Provides detailed information about a specific medical transcription job.

Members
CompletionTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the specified medical transcription job finished processing.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022.

ContentIdentificationType
Type: string

Labels all personal health information (PHI) identified in your transcript. For more information, see Identifying personal health information (PHI) in a transcription.

CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the specified medical transcription job request was made.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

FailureReason
Type: string

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

LanguageCode
Type: string

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

MedicalTranscriptionJobName
Type: string

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

OutputLocationType
Type: string

Indicates where the specified medical transcription output is stored.

If the value is CUSTOMER_BUCKET, the location is the Amazon S3 bucket you specified using the OutputBucketName parameter in your request. If you also included OutputKey in your request, your output is located in the path you specified in your request.

If the value is SERVICE_BUCKET, the location is a service-managed Amazon S3 bucket. To access a transcript stored in a service-managed bucket, use the URI shown in the TranscriptFileUri field.

Specialty
Type: string

Provides the medical specialty represented in your media.

StartTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time your medical transcription job began processing.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

TranscriptionJobStatus
Type: string

Provides the status of your medical transcription job.

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

Type
Type: string

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

MedicalTranscriptionSetting

Description

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

Members
ChannelIdentification
Type: boolean

Enables channel identification in multi-channel audio.

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

If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript does not separate the speech by channel.

For more information, see Transcribing multi-channel audio.

MaxAlternatives
Type: int

Indicate the maximum number of alternative transcriptions you want Amazon Transcribe Medical to include in your transcript.

If you select a number greater than the number of alternative transcriptions generated by Amazon Transcribe Medical, only the actual number of alternative transcriptions are included.

If you include MaxAlternatives in your request, you must also include ShowAlternatives with a value of true.

For more information, see Alternative transcriptions.

MaxSpeakerLabels
Type: int

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

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

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

ShowAlternatives
Type: boolean

To include alternative transcriptions within your transcription output, include ShowAlternatives in your transcription request.

If you include ShowAlternatives, you must also include MaxAlternatives, which is the maximum number of alternative transcriptions you want Amazon Transcribe Medical to generate.

For more information, see Alternative transcriptions.

ShowSpeakerLabels
Type: boolean

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

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

For more information, see Partitioning speakers (diarization).

VocabularyName
Type: string

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

The language of the specified custom vocabulary must match the language code that you specify in your transcription request. If the languages do not match, the custom vocabulary isn't applied. There are no errors or warnings associated with a language mismatch. US English (en-US) is the only valid language for Amazon Transcribe Medical.

ModelSettings

Description

Provides the name of the custom language model that was included in the specified transcription job.

Only use ModelSettings with the LanguageModelName sub-parameter if you're not using automatic language identification (). If using LanguageIdSettings in your request, this parameter contains a LanguageModelName sub-parameter.

Members
LanguageModelName
Type: string

The name of the custom language model you want to use when processing your transcription job. Note that custom language model names are case sensitive.

The language of the specified custom language model must match the language code that you specify in your transcription request. If the languages do not match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch.

NonTalkTimeFilter

Description

Flag the presence or absence of periods of silence in your Call Analytics transcription output.

Rules using NonTalkTimeFilter are designed to match:

  • The presence of silence at specified periods throughout the call

  • The presence of speech at specified periods throughout the call

See Rule criteria for post-call categories for usage examples.

Members
AbsoluteTimeRange
Type: AbsoluteTimeRange structure

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

Negate
Type: boolean

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

RelativeTimeRange
Type: RelativeTimeRange structure

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

Threshold
Type: long (int|float)

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

NotFoundException

Description

We can't find the requested resource. Check that the specified name is correct and try your request again.

Members
Message
Type: string

RelativeTimeRange

Description

A time range, in percentage, between two points in your media file.

You can use StartPercentage and EndPercentage to search a custom segment. For example, setting StartPercentage to 10 and EndPercentage to 50 only searches for your specified criteria in the audio contained between the 10 percent mark and the 50 percent mark of your media file.

You can use also First to search from the start of the media file until the time that you specify. Or use Last to search from the time that you specify until the end of the media file. For example, setting First to 10 only searches for your specified criteria in the audio contained in the first 10 percent of the media file.

If you prefer to use milliseconds instead of percentage, see .

Members
EndPercentage
Type: int

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

First
Type: int

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

Last
Type: int

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

StartPercentage
Type: int

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

Rule

Description

A rule is a set of criteria that you can specify to flag an attribute in your Call Analytics output. Rules define a Call Analytics category.

Rules can include these parameters: , , , and .

To learn more about Call Analytics rules and categories, see Creating categories for post-call transcriptions and Creating categories for real-time transcriptions.

To learn more about Call Analytics, see Analyzing call center audio with Call Analytics.

Members
InterruptionFilter
Type: InterruptionFilter structure

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

NonTalkTimeFilter
Type: NonTalkTimeFilter structure

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

SentimentFilter
Type: SentimentFilter structure

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

TranscriptFilter
Type: TranscriptFilter structure

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

SentimentFilter

Description

Flag the presence or absence of specific sentiments detected in your Call Analytics transcription output.

Rules using SentimentFilter are designed to match:

  • The presence or absence of a positive sentiment felt by the customer, agent, or both at specified points in the call

  • The presence or absence of a negative sentiment felt by the customer, agent, or both at specified points in the call

  • The presence or absence of a neutral sentiment felt by the customer, agent, or both at specified points in the call

  • The presence or absence of a mixed sentiment felt by the customer, the agent, or both at specified points in the call

See Rule criteria for post-call categories for usage examples.

Members
AbsoluteTimeRange
Type: AbsoluteTimeRange structure

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

Negate
Type: boolean

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

ParticipantRole
Type: string

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

RelativeTimeRange
Type: RelativeTimeRange structure

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

Sentiments
Required: Yes
Type: Array of strings

Specify the sentiments that you want to flag.

Settings

Description

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

Members
ChannelIdentification
Type: boolean

Enables channel identification in multi-channel audio.

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

For more information, see Transcribing multi-channel audio.

MaxAlternatives
Type: int

Indicate the maximum number of alternative transcriptions you want Amazon Transcribe to include in your transcript.

If you select a number greater than the number of alternative transcriptions generated by Amazon Transcribe, only the actual number of alternative transcriptions are included.

If you include MaxAlternatives in your request, you must also include ShowAlternatives with a value of true.

For more information, see Alternative transcriptions.

MaxSpeakerLabels
Type: int

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

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

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

ShowAlternatives
Type: boolean

To include alternative transcriptions within your transcription output, include ShowAlternatives in your transcription request.

If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript does not separate the speech by channel.

If you include ShowAlternatives, you must also include MaxAlternatives, which is the maximum number of alternative transcriptions you want Amazon Transcribe to generate.

For more information, see Alternative transcriptions.

ShowSpeakerLabels
Type: boolean

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

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

For more information, see Partitioning speakers (diarization).

VocabularyFilterMethod
Type: string

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

To replace words with ***, choose mask.

To delete words, choose remove.

To flag words without changing them, choose tag.

VocabularyFilterName
Type: string

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

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

VocabularyName
Type: string

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

Subtitles

Description

Generate subtitles for your media file with your transcription request.

You can choose a start index of 0 or 1, and you can specify either WebVTT or SubRip (or both) as your output format.

Note that your subtitle files are placed in the same location as your transcription output.

Members
Formats
Type: Array of strings

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

OutputStartIndex
Type: int

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

The default start index for Amazon Transcribe is 0, which differs from the more widely used standard of 1. If you're uncertain which value to use, we recommend choosing 1, as this may improve compatibility with other services.

SubtitlesOutput

Description

Provides information about your subtitle file, including format, start index, and Amazon S3 location.

Members
Formats
Type: Array of strings

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

OutputStartIndex
Type: int

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

SubtitleFileUris
Type: Array of strings

The Amazon S3 location of your transcript. You can use this URI to access or download your subtitle file. Your subtitle file is stored in the same location as your transcript. If you specified both WebVTT and SubRip subtitle formats, two URIs are provided.

If you included OutputBucketName in your transcription job request, this is the URI of that bucket. If you also included OutputKey in your request, your output is located in the path you specified in your request.

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

Temporary URIs for service-managed Amazon S3 buckets are only valid for 15 minutes. If you get an AccesDenied error, you can get a new temporary URI by running a GetTranscriptionJob or ListTranscriptionJob request.

Summarization

Description

Contains GenerateAbstractiveSummary, which is a required parameter if you want to enable Generative call summarization in your Call Analytics request.

Members
GenerateAbstractiveSummary
Required: Yes
Type: boolean

Enables Generative call summarization in your Call Analytics request

Generative call summarization provides a summary of the transcript including important components discussed in the conversation.

For more information, see Enabling generative call summarization.

Tag

Description

Adds metadata, in the form of a key:value pair, to the specified resource.

For example, you could add the tag Department:Sales to a resource to indicate that it pertains to your organization's sales department. You can also use tags for tag-based access control.

To learn more about tagging, see Tagging resources.

Members
Key
Required: Yes
Type: string

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

Value
Required: Yes
Type: string

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

Note that you can set the value of a tag to an empty string, but you can't set the value of a tag to null. Omitting the tag value is the same as using an empty string.

ToxicityDetectionSettings

Description

Contains ToxicityCategories, which is a required parameter if you want to enable toxicity detection (ToxicityDetection) in your transcription request.

Members
ToxicityCategories
Required: Yes
Type: Array of strings

If you include ToxicityDetection in your transcription request, you must also include ToxicityCategories. The only accepted value for this parameter is ALL.

Transcript

Description

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

Members
RedactedTranscriptFileUri
Type: string

The Amazon S3 location of your redacted transcript. You can use this URI to access or download your transcript.

If you included OutputBucketName in your transcription job request, this is the URI of that bucket. If you also included OutputKey in your request, your output is located in the path you specified in your request.

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

Temporary URIs for service-managed Amazon S3 buckets are only valid for 15 minutes. If you get an AccesDenied error, you can get a new temporary URI by running a GetTranscriptionJob or ListTranscriptionJob request.

TranscriptFileUri
Type: string

The Amazon S3 location of your transcript. You can use this URI to access or download your transcript.

If you included OutputBucketName in your transcription job request, this is the URI of that bucket. If you also included OutputKey in your request, your output is located in the path you specified in your request.

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

Temporary URIs for service-managed Amazon S3 buckets are only valid for 15 minutes. If you get an AccesDenied error, you can get a new temporary URI by running a GetTranscriptionJob or ListTranscriptionJob request.

TranscriptFilter

Description

Flag the presence or absence of specific words or phrases detected in your Call Analytics transcription output.

Rules using TranscriptFilter are designed to match:

  • Custom words or phrases spoken by the agent, the customer, or both

  • Custom words or phrases not spoken by the agent, the customer, or either

  • Custom words or phrases that occur at a specific time frame

See Rule criteria for post-call categories and Rule criteria for streaming categories for usage examples.

Members
AbsoluteTimeRange
Type: AbsoluteTimeRange structure

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

Negate
Type: boolean

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

ParticipantRole
Type: string

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

RelativeTimeRange
Type: RelativeTimeRange structure

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

Targets
Required: Yes
Type: Array of strings

Specify the phrases that you want to flag.

TranscriptFilterType
Required: Yes
Type: string

Flag the presence or absence of an exact match to the phrases that you specify. For example, if you specify the phrase "speak to a manager" as your Targets value, only that exact phrase is flagged.

Note that semantic matching is not supported. For example, if your customer says "speak to the manager", instead of "speak to a manager", your content is not flagged.

TranscriptionJob

Description

Provides detailed information about a transcription job.

To view the status of the specified transcription 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 TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed.

If you enabled content redaction, the redacted transcript can be found at the location specified in RedactedTranscriptFileUri.

Members
CompletionTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the specified transcription job finished processing.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022.

ContentRedaction
Type: ContentRedaction structure

Indicates whether redaction was enabled in your transcript.

CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the specified transcription job request was made.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

FailureReason
Type: string

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

The FailureReason field contains one of the following values:

  • Unsupported media format.

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

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

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

  • Invalid sample rate for audio file.

    The sample rate specified in MediaSampleRateHertz isn't valid. The sample rate must be between 8,000 and 48,000 hertz.

  • The sample rate provided does not match the detected sample rate.

    The sample rate specified in MediaSampleRateHertz doesn't match the sample rate detected in your input media file. Check the sample rate of your media file and correct the specified value.

  • Invalid file size: file size too large.

    The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Service quotas.

  • Invalid number of channels: number of channels too large.

    Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Service quotas.

IdentifiedLanguageScore
Type: float

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

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

IdentifyLanguage
Type: boolean

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

IdentifyMultipleLanguages
Type: boolean

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

JobExecutionSettings
Type: JobExecutionSettings structure

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

LanguageCode
Type: string

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

LanguageCodes
Type: Array of LanguageCodeItem structures

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

LanguageIdSettings
Type: Associative array of custom strings keys (LanguageCode) to LanguageIdSettings structures

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

LanguageOptions
Type: Array of strings

Provides the language codes you specified in your request.

Media
Type: Media structure

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

MediaFormat
Type: string

The format of the input media file.

MediaSampleRateHertz
Type: int

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

ModelSettings
Type: ModelSettings structure

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

Settings
Type: Settings structure

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

StartTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the specified transcription job began processing.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

Subtitles
Type: SubtitlesOutput structure

Indicates whether subtitles were generated with your transcription.

Tags
Type: Array of Tag structures

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

ToxicityDetection
Type: Array of ToxicityDetectionSettings structures

Provides information about the toxicity detection settings applied to your transcription.

Transcript
Type: Transcript structure

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

TranscriptionJobName
Type: string

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

TranscriptionJobStatus
Type: string

Provides the status of the specified transcription job.

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

TranscriptionJobSummary

Description

Provides detailed information about a specific transcription job.

Members
CompletionTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the specified transcription job finished processing.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022.

ContentRedaction
Type: ContentRedaction structure

The content redaction settings of the transcription job.

CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the specified transcription job request was made.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

FailureReason
Type: string

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

IdentifiedLanguageScore
Type: float

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

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

IdentifyLanguage
Type: boolean

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

IdentifyMultipleLanguages
Type: boolean

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

LanguageCode
Type: string

The language code used to create your transcription.

LanguageCodes
Type: Array of LanguageCodeItem structures

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

ModelSettings
Type: ModelSettings structure

Provides the name of the custom language model that was included in the specified transcription job.

Only use ModelSettings with the LanguageModelName sub-parameter if you're not using automatic language identification (). If using LanguageIdSettings in your request, this parameter contains a LanguageModelName sub-parameter.

OutputLocationType
Type: string

Indicates where the specified transcription output is stored.

If the value is CUSTOMER_BUCKET, the location is the Amazon S3 bucket you specified using the OutputBucketName parameter in your request. If you also included OutputKey in your request, your output is located in the path you specified in your request.

If the value is SERVICE_BUCKET, the location is a service-managed Amazon S3 bucket. To access a transcript stored in a service-managed bucket, use the URI shown in the TranscriptFileUri or RedactedTranscriptFileUri field.

StartTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time your transcription job began processing.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

ToxicityDetection
Type: Array of ToxicityDetectionSettings structures

Indicates whether toxicity detection was enabled for the specified transcription job.

TranscriptionJobName
Type: string

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

TranscriptionJobStatus
Type: string

Provides the status of your transcription job.

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

VocabularyFilterInfo

Description

Provides information about a custom vocabulary filter, including the language of the filter, when it was last modified, and its name.

Members
LanguageCode
Type: string

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

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

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

LastModifiedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.

VocabularyFilterName
Type: string

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

VocabularyInfo

Description

Provides information about a custom vocabulary, including the language of the custom vocabulary, when it was last modified, its name, and the processing state.

Members
LanguageCode
Type: string

The language code used to create your custom vocabulary. Each custom vocabulary must contain terms in only one language.

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

LastModifiedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.

VocabularyName
Type: string

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

VocabularyState
Type: string

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