AWS SDK for PHP 3.x

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 */).

CreateVocabulary ( array $params = [] )
Creates a new custom vocabulary that you can use to change the way Amazon Transcribe handles transcription of an audio file.
DeleteVocabulary ( array $params = [] )
Deletes a vocabulary from Amazon Transcribe.
GetTranscriptionJob ( array $params = [] )
Returns information about a transcription job.
GetVocabulary ( array $params = [] )
Gets information about a vocabulary.
ListTranscriptionJobs ( array $params = [] )
Lists transcription jobs with the specified status.
ListVocabularies ( array $params = [] )
Returns a list of vocabularies that match the specified criteria.
StartTranscriptionJob ( array $params = [] )
Starts an asynchronous job to transcribe speech to text.
UpdateVocabulary ( array $params = [] )
Updates an existing vocabulary with new values.

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:

ListTranscriptionJobs
ListVocabularies

Operations

CreateVocabulary

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

Creates a new custom vocabulary that you can use to change the way Amazon Transcribe handles transcription of an audio file.

Parameter Syntax

$result = $client->createVocabulary([
    'LanguageCode' => 'en-US|es-US', // REQUIRED
    'Phrases' => ['<string>', ...], // REQUIRED
    'VocabularyName' => '<string>', // REQUIRED
]);

Parameter Details

Members

LanguageCode

Type: string

The language code of the vocabulary entries.

Phrases

Type: Array of strings

An array of strings that contains the vocabulary entries.

VocabularyName

Type: string

The name of the vocabulary. The name must be unique within an AWS account. The name is case-sensitive.

Result Syntax

[
    'FailureReason' => '<string>',
    'LanguageCode' => 'en-US|es-US',
    'LastModifiedTime' => <DateTime>,
    'VocabularyName' => '<string>',
    'VocabularyState' => 'PENDING|READY|FAILED',
]

Result Details

Members

FailureReason

Type: string

If the VocabularyState field is FAILED, this field contains information about why the job failed.

LanguageCode

Type: string

The language code of the vocabulary entries.

LastModifiedTime

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

The date and time that the vocabulary was created.

VocabularyName

Type: string

The name of the vocabulary.

VocabularyState

Type: string

The processing state of the vocabulary. When the VocabularyState field contains READY the vocabulary is ready to be used in a StartTranscriptionJob request.

Errors

BadRequestException:
Your request didn't pass one or more validation tests. For example, a name already exists when createing a resource or a name may not exist when getting a transcription job or custom vocabulary. See the exception Message field for more information.
LimitExceededException:
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
InternalFailureException:
There was an internal error. Check the error message and try your request again.
ConflictException:
The JobName field is a duplicate of a previously entered job name. Resend your request with a different name.

DeleteVocabulary

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

Deletes a vocabulary from Amazon Transcribe.

Parameter Syntax

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

Parameter Details

Members

VocabularyName

Type: string

The name of the vocabulary to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

NotFoundException:
We can't find the requested transcription job or custom vocabulary. Check the name and try your request again.
LimitExceededException:
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
InternalFailureException:
There was an internal error. Check the error message and try your request again.

GetTranscriptionJob

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

Returns information about a transcription job. To see the status of the job, check the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished and you can find the results at the location specified in the TranscriptionFileUri field.

Parameter Syntax

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

Parameter Details

Members

TranscriptionJobName

Type: string

The name of the job.

Result Syntax

[
    'TranscriptionJob' => [
        'CompletionTime' => <DateTime>,
        'CreationTime' => <DateTime>,
        'FailureReason' => '<string>',
        'LanguageCode' => 'en-US|es-US',
        'Media' => [
            'MediaFileUri' => '<string>',
        ],
        'MediaFormat' => 'mp3|mp4|wav|flac',
        'MediaSampleRateHertz' => <integer>,
        'Settings' => [
            'MaxSpeakerLabels' => <integer>,
            'ShowSpeakerLabels' => true || false,
            'VocabularyName' => '<string>',
        ],
        'Transcript' => [
            'TranscriptFileUri' => '<string>',
        ],
        'TranscriptionJobName' => '<string>',
        'TranscriptionJobStatus' => 'IN_PROGRESS|FAILED|COMPLETED',
    ],
]

Result Details

Members

TranscriptionJob

Type: TranscriptionJob structure

An object that contains the results of the transcription job.

Errors

BadRequestException:
Your request didn't pass one or more validation tests. For example, a name already exists when createing a resource or a name may not exist when getting a transcription job or custom vocabulary. See the exception Message field for more information.
LimitExceededException:
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
InternalFailureException:
There was an internal error. Check the error message and try your request again.
NotFoundException:
We can't find the requested transcription job or custom vocabulary. Check the name and try your request again.

GetVocabulary

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

Gets information about a vocabulary.

Parameter Syntax

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

Parameter Details

Members

VocabularyName

Type: string

The name of the vocabulary to return information about. The name is case-sensitive.

Result Syntax

[
    'DownloadUri' => '<string>',
    'FailureReason' => '<string>',
    'LanguageCode' => 'en-US|es-US',
    'LastModifiedTime' => <DateTime>,
    'VocabularyName' => '<string>',
    'VocabularyState' => 'PENDING|READY|FAILED',
]

Result Details

Members

DownloadUri

Type: string

The S3 location where the vocabulary is stored. Use this URI to get the contents of the vocabulary. The URI is available for a limited time.

FailureReason

Type: string

If the VocabularyState field is FAILED, this field contains information about why the job failed.

LanguageCode

Type: string

The language code of the vocabulary entries.

LastModifiedTime

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

The date and time that the vocabulary was last modified.

VocabularyName

Type: string

The name of the vocabulary to return.

VocabularyState

Type: string

The processing state of the vocabulary.

Errors

NotFoundException:
We can't find the requested transcription job or custom vocabulary. Check the name and try your request again.
LimitExceededException:
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
InternalFailureException:
There was an internal error. Check the error message and try your request again.
BadRequestException:
Your request didn't pass one or more validation tests. For example, a name already exists when createing a resource or a name may not exist when getting a transcription job or custom vocabulary. See the exception Message field for more information.

ListTranscriptionJobs

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

Lists transcription jobs with the specified status.

Parameter Syntax

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

Parameter Details

Members

JobNameContains

Type: string

When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.

MaxResults

Type: int

The maximum number of jobs to return in the response. If there are fewer results in the list, this response contains only the actual results.

NextToken

Type: string

If the result of the previous request to ListTranscriptionJobs was truncated, include the NextToken to fetch the next set of jobs.

Status

Type: string

When specified, returns only transcription jobs with the specified status.

Result Syntax

[
    'NextToken' => '<string>',
    'Status' => 'IN_PROGRESS|FAILED|COMPLETED',
    'TranscriptionJobSummaries' => [
        [
            'CompletionTime' => <DateTime>,
            'CreationTime' => <DateTime>,
            'FailureReason' => '<string>',
            'LanguageCode' => 'en-US|es-US',
            'TranscriptionJobName' => '<string>',
            'TranscriptionJobStatus' => 'IN_PROGRESS|FAILED|COMPLETED',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

The ListTranscriptionJobs operation returns a page of jobs at a time. The maximum size of the page is set by the MaxResults parameter. If there are more jobs in the list than the page size, Amazon Transcribe returns the NextPage token. Include the token in the next request to the ListTranscriptionJobs operation to return in the next page of jobs.

Status

Type: string

The requested status of the jobs returned.

TranscriptionJobSummaries

Type: Array of TranscriptionJobSummary structures

A list of objects containing summary information for a transcription job.

Errors

BadRequestException:
Your request didn't pass one or more validation tests. For example, a name already exists when createing a resource or a name may not exist when getting a transcription job or custom vocabulary. See the exception Message field for more information.
LimitExceededException:
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
InternalFailureException:
There was an internal error. Check the error message and try your request again.

ListVocabularies

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

Returns a list of vocabularies that match the specified criteria. If no criteria are specified, returns the entire list of vocabularies.

Parameter Syntax

$result = $client->listVocabularies([
    'MaxResults' => <integer>,
    'NameContains' => '<string>',
    'NextToken' => '<string>',
    'StateEquals' => 'PENDING|READY|FAILED',
]);

Parameter Details

Members

MaxResults

Type: int

The maximum number of vocabularies to return in the response. If there are fewer results in the list, this response contains only the actual results.

NameContains

Type: string

When specified, the vocabularies returned in the list are limited to vocabularies whose name contains the specified string. The search is case-insensitive, ListVocabularies will return both "vocabularyname" and "VocabularyName" in the response list.

NextToken

Type: string

If the result of the previous request to ListVocabularies was truncated, include the NextToken to fetch the next set of jobs.

StateEquals

Type: string

When specified, only returns vocabularies with the VocabularyState field equal to the specified state.

Result Syntax

[
    'NextToken' => '<string>',
    'Status' => 'IN_PROGRESS|FAILED|COMPLETED',
    'Vocabularies' => [
        [
            'LanguageCode' => 'en-US|es-US',
            'LastModifiedTime' => <DateTime>,
            'VocabularyName' => '<string>',
            'VocabularyState' => 'PENDING|READY|FAILED',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

The ListVocabularies operation returns a page of vocabularies at a time. The maximum size of the page is set by the MaxResults parameter. If there are more jobs in the list than the page size, Amazon Transcribe returns the NextPage token. Include the token in the next request to the ListVocabularies operation to return in the next page of jobs.

Status

Type: string

The requested vocabulary state.

Vocabularies

Type: Array of VocabularyInfo structures

A list of objects that describe the vocabularies that match the search criteria in the request.

Errors

BadRequestException:
Your request didn't pass one or more validation tests. For example, a name already exists when createing a resource or a name may not exist when getting a transcription job or custom vocabulary. See the exception Message field for more information.
LimitExceededException:
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
InternalFailureException:
There was an internal error. Check the error message and try your request again.

StartTranscriptionJob

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

Starts an asynchronous job to transcribe speech to text.

Parameter Syntax

$result = $client->startTranscriptionJob([
    'LanguageCode' => 'en-US|es-US', // REQUIRED
    'Media' => [ // REQUIRED
        'MediaFileUri' => '<string>',
    ],
    'MediaFormat' => 'mp3|mp4|wav|flac', // REQUIRED
    'MediaSampleRateHertz' => <integer>,
    'Settings' => [
        'MaxSpeakerLabels' => <integer>,
        'ShowSpeakerLabels' => true || false,
        'VocabularyName' => '<string>',
    ],
    'TranscriptionJobName' => '<string>', // REQUIRED
]);

Parameter Details

Members

LanguageCode

Type: string

The language code for the language used in the input media file.

Media

Type: Media structure

An object that describes the input media for a transcription job.

MediaFormat

Type: string

The format of the input media file.

MediaSampleRateHertz

Type: int

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

Settings

Type: Settings structure

A Settings object that provides optional settings for a transcription job.

TranscriptionJobName

Type: string

The name of the job. The name must be unique within an AWS account.

Result Syntax

[
    'TranscriptionJob' => [
        'CompletionTime' => <DateTime>,
        'CreationTime' => <DateTime>,
        'FailureReason' => '<string>',
        'LanguageCode' => 'en-US|es-US',
        'Media' => [
            'MediaFileUri' => '<string>',
        ],
        'MediaFormat' => 'mp3|mp4|wav|flac',
        'MediaSampleRateHertz' => <integer>,
        'Settings' => [
            'MaxSpeakerLabels' => <integer>,
            'ShowSpeakerLabels' => true || false,
            'VocabularyName' => '<string>',
        ],
        'Transcript' => [
            'TranscriptFileUri' => '<string>',
        ],
        'TranscriptionJobName' => '<string>',
        'TranscriptionJobStatus' => 'IN_PROGRESS|FAILED|COMPLETED',
    ],
]

Result Details

Members

TranscriptionJob

Type: TranscriptionJob structure

An object containing details of the asynchronous transcription job.

Errors

BadRequestException:
Your request didn't pass one or more validation tests. For example, a name already exists when createing a resource or a name may not exist when getting a transcription job or custom vocabulary. See the exception Message field for more information.
LimitExceededException:
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
InternalFailureException:
There was an internal error. Check the error message and try your request again.
ConflictException:
The JobName field is a duplicate of a previously entered job name. Resend your request with a different name.

UpdateVocabulary

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

Updates an existing vocabulary with new values.

Parameter Syntax

$result = $client->updateVocabulary([
    'LanguageCode' => 'en-US|es-US', // REQUIRED
    'Phrases' => ['<string>', ...], // REQUIRED
    'VocabularyName' => '<string>', // REQUIRED
]);

Parameter Details

Members

LanguageCode

Type: string

The language code of the vocabulary entries.

Phrases

Type: Array of strings

An array of strings containing the vocabulary entries.

VocabularyName

Type: string

The name of the vocabulary to update. The name is case-sensitive.

Result Syntax

[
    'LanguageCode' => 'en-US|es-US',
    'LastModifiedTime' => <DateTime>,
    'VocabularyName' => '<string>',
    'VocabularyState' => 'PENDING|READY|FAILED',
]

Result Details

Members

LanguageCode

Type: string

The language code of the vocabulary entries.

LastModifiedTime

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

The date and time that the vocabulary was updated.

VocabularyName

Type: string

The name of the vocabulary that was updated.

VocabularyState

Type: string

The processing state of the vocabulary. When the VocabularyState field contains READY the vocabulary is ready to be used in a StartTranscriptionJob request.

Errors

BadRequestException:
Your request didn't pass one or more validation tests. For example, a name already exists when createing a resource or a name may not exist when getting a transcription job or custom vocabulary. See the exception Message field for more information.
LimitExceededException:
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
InternalFailureException:
There was an internal error. Check the error message and try your request again.
NotFoundException:
We can't find the requested transcription job or custom vocabulary. Check the name and try your request again.

Type: string

The S3 location of the input media file. The URI must be in the same region as the API endpoint that you are calling. The general form is:

https://<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>

For example:

https://s3-us-east-1.amazonaws.com/examplebucket/example.mp4

https://s3-us-east-1.amazonaws.com/examplebucket/mediadocs/example.mp4

For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.

NotFoundException

Description

We can't find the requested transcription job or custom vocabulary. Check the name and try your request again.

Members

Message

Type: string

Settings

Description

Provides optional settings for the StartTranscriptionJob operation.

Members

MaxSpeakerLabels

Type: int

The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers will be identified as a single speaker. If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.

ShowSpeakerLabels

Type: boolean

Determines whether the transcription job should use speaker recognition to identify different speakers in the input audio. If you set the ShowSpeakerLabels field to true, you must also set the maximum number of speaker labels MaxSpeakerLabels field.

VocabularyName

Type: string

The name of a vocabulary to use when processing the transcription job.

Transcript

Description

Describes the output of a transcription job.

Members

TranscriptFileUri

Type: string

The S3 location where the transcription result is stored. Use this URI to access the results of the transcription job.

TranscriptionJob

Description

Describes an asynchronous transcription job that was created with the StartTranscriptionJob operation.

Members

CompletionTime

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

Timestamp of the date and time that the job completed.

CreationTime

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

Timestamp of the date and time that the job was created.

FailureReason

Type: string

If the TranscriptionJobStatus field is FAILED, this field contains information about why the job failed.

LanguageCode

Type: string

The language code for the input speech.

Media

Type: Media structure

An object that describes the input media for a transcription job.

MediaFormat

Type: string

The format of the input media file.

MediaSampleRateHertz

Type: int

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

Settings

Type: Settings structure

Optional settings for the transcription job.

Transcript

Type: Transcript structure

An object that describes the output of the transcription job.

TranscriptionJobName

Type: string

A name to identify the transcription job.

TranscriptionJobStatus

Type: string

The status of the transcription job.

TranscriptionJobSummary

Description

Provides a summary of information about a transcription job.

Members

CompletionTime

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

Timestamp of the date and time that the job completed.

CreationTime

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

Timestamp of the date and time that the job was created.

FailureReason

Type: string

If the TranscriptionJobStatus field is FAILED, this field contains a description of the error.

LanguageCode

Type: string

The language code for the input speech.

TranscriptionJobName

Type: string

The name assigned to the transcription job when it was created.

TranscriptionJobStatus

Type: string

The status of the transcription job. When the status is COMPLETED, use the GetTranscriptionJob operation to get the results of the transcription.

VocabularyInfo

Description

Provides information about a custom vocabulary.

Members

LanguageCode

Type: string

The language code of the vocabulary entries.

LastModifiedTime

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

The date and time that the vocabulary was last modified.

VocabularyName

Type: string

The name of the vocabulary.

VocabularyState

Type: string

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

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

Amazon Transcribe Service 2017-10-26

Operation Summary

Paginators

Operations

CreateVocabulary

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteVocabulary

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

GetTranscriptionJob

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetVocabulary

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListTranscriptionJobs

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListVocabularies

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

StartTranscriptionJob

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

UpdateVocabulary

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Shapes

BadRequestException

Description

Members

ConflictException

Description

Members