TranscribeService

Table of Contents

Client

class TranscribeService.Client

A low-level client representing Amazon Transcribe Service:

import boto3

client = boto3.client('transcribe')

These are the available methods:

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
create_vocabulary(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.create_vocabulary(
    VocabularyName='string',
    LanguageCode='en-US'|'es-US'|'en-AU'|'fr-CA'|'en-GB'|'de-DE'|'pt-BR'|'fr-FR'|'it-IT'|'ko-KR'|'es-ES'|'en-IN'|'hi-IN'|'ar-SA'|'ru-RU'|'zh-CN'|'nl-NL'|'id-ID'|'ta-IN'|'fa-IR'|'en-IE'|'en-AB'|'en-WL'|'pt-PT'|'te-IN'|'tr-TR'|'de-CH'|'he-IL'|'ms-MY'|'ja-JP'|'ar-AE',
    Phrases=[
        'string',
    ],
    VocabularyFileUri='string'
)
Parameters
  • VocabularyName (string) --

    [REQUIRED]

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

  • LanguageCode (string) --

    [REQUIRED]

    The language code of the vocabulary entries.

  • Phrases (list) --

    An array of strings that contains the vocabulary entries.

    • (string) --
  • VocabularyFileUri (string) --

    The S3 location of the text file that contains the definition of the custom vocabulary. The URI must be in the same region as the API endpoint that you are calling. The general form is

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

    For example:

    https://s3.us-east-1.amazonaws.com/examplebucket/vocab.txt

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

    For more information about custom vocabularies, see Custom Vocabularies .

Return type

dict

Returns

Response Syntax

{
    'VocabularyName': 'string',
    'LanguageCode': 'en-US'|'es-US'|'en-AU'|'fr-CA'|'en-GB'|'de-DE'|'pt-BR'|'fr-FR'|'it-IT'|'ko-KR'|'es-ES'|'en-IN'|'hi-IN'|'ar-SA'|'ru-RU'|'zh-CN'|'nl-NL'|'id-ID'|'ta-IN'|'fa-IR'|'en-IE'|'en-AB'|'en-WL'|'pt-PT'|'te-IN'|'tr-TR'|'de-CH'|'he-IL'|'ms-MY'|'ja-JP'|'ar-AE',
    'VocabularyState': 'PENDING'|'READY'|'FAILED',
    'LastModifiedTime': datetime(2015, 1, 1),
    'FailureReason': 'string'
}

Response Structure

  • (dict) --

    • VocabularyName (string) --

      The name of the vocabulary.

    • LanguageCode (string) --

      The language code of the vocabulary entries.

    • VocabularyState (string) --

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

    • LastModifiedTime (datetime) --

      The date and time that the vocabulary was created.

    • FailureReason (string) --

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

create_vocabulary_filter(**kwargs)

Creates a new vocabulary filter that you can use to filter words, such as profane words, from the output of a transcription job.

See also: AWS API Documentation

Request Syntax

response = client.create_vocabulary_filter(
    VocabularyFilterName='string',
    LanguageCode='en-US'|'es-US'|'en-AU'|'fr-CA'|'en-GB'|'de-DE'|'pt-BR'|'fr-FR'|'it-IT'|'ko-KR'|'es-ES'|'en-IN'|'hi-IN'|'ar-SA'|'ru-RU'|'zh-CN'|'nl-NL'|'id-ID'|'ta-IN'|'fa-IR'|'en-IE'|'en-AB'|'en-WL'|'pt-PT'|'te-IN'|'tr-TR'|'de-CH'|'he-IL'|'ms-MY'|'ja-JP'|'ar-AE',
    Words=[
        'string',
    ],
    VocabularyFilterFileUri='string'
)
Parameters
  • VocabularyFilterName (string) --

    [REQUIRED]

    The vocabulary filter name. The name must be unique within the account that contains it.

  • LanguageCode (string) --

    [REQUIRED]

    The language code of the words in the vocabulary filter. All words in the filter must be in the same language. The vocabulary filter can only be used with transcription jobs in the specified language.

  • Words (list) --

    The words to use in the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies .

    If you provide a list of words in the Words parameter, you can't use the VocabularyFilterFileUri parameter.

    • (string) --
  • VocabularyFilterFileUri (string) --

    The Amazon S3 location of a text file used as input to create the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies .

    The specified file must be less than 50 KB of UTF-8 characters.

    If you provide the location of a list of words in the VocabularyFilterFileUri parameter, you can't use the Words parameter.

Return type

dict

Returns

Response Syntax

{
    'VocabularyFilterName': 'string',
    'LanguageCode': 'en-US'|'es-US'|'en-AU'|'fr-CA'|'en-GB'|'de-DE'|'pt-BR'|'fr-FR'|'it-IT'|'ko-KR'|'es-ES'|'en-IN'|'hi-IN'|'ar-SA'|'ru-RU'|'zh-CN'|'nl-NL'|'id-ID'|'ta-IN'|'fa-IR'|'en-IE'|'en-AB'|'en-WL'|'pt-PT'|'te-IN'|'tr-TR'|'de-CH'|'he-IL'|'ms-MY'|'ja-JP'|'ar-AE',
    'LastModifiedTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • VocabularyFilterName (string) --

      The name of the vocabulary filter.

    • LanguageCode (string) --

      The language code of the words in the collection.

    • LastModifiedTime (datetime) --

      The date and time that the vocabulary filter was modified.

delete_transcription_job(**kwargs)

Deletes a previously submitted transcription job along with any other generated results such as the transcription, models, and so on.

See also: AWS API Documentation

Request Syntax

response = client.delete_transcription_job(
    TranscriptionJobName='string'
)
Parameters
TranscriptionJobName (string) --

[REQUIRED]

The name of the transcription job to be deleted.

Returns
None
delete_vocabulary(**kwargs)

Deletes a vocabulary from Amazon Transcribe.

See also: AWS API Documentation

Request Syntax

response = client.delete_vocabulary(
    VocabularyName='string'
)
Parameters
VocabularyName (string) --

[REQUIRED]

The name of the vocabulary to delete.

Returns
None
delete_vocabulary_filter(**kwargs)

Removes a vocabulary filter.

See also: AWS API Documentation

Request Syntax

response = client.delete_vocabulary_filter(
    VocabularyFilterName='string'
)
Parameters
VocabularyFilterName (string) --

[REQUIRED]

The name of the vocabulary filter to remove.

Returns
None
generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_transcription_job(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.get_transcription_job(
    TranscriptionJobName='string'
)
Parameters
TranscriptionJobName (string) --

[REQUIRED]

The name of the job.

Return type
dict
Returns
Response Syntax
{
    'TranscriptionJob': {
        'TranscriptionJobName': 'string',
        'TranscriptionJobStatus': 'QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
        'LanguageCode': 'en-US'|'es-US'|'en-AU'|'fr-CA'|'en-GB'|'de-DE'|'pt-BR'|'fr-FR'|'it-IT'|'ko-KR'|'es-ES'|'en-IN'|'hi-IN'|'ar-SA'|'ru-RU'|'zh-CN'|'nl-NL'|'id-ID'|'ta-IN'|'fa-IR'|'en-IE'|'en-AB'|'en-WL'|'pt-PT'|'te-IN'|'tr-TR'|'de-CH'|'he-IL'|'ms-MY'|'ja-JP'|'ar-AE',
        'MediaSampleRateHertz': 123,
        'MediaFormat': 'mp3'|'mp4'|'wav'|'flac',
        'Media': {
            'MediaFileUri': 'string'
        },
        'Transcript': {
            'TranscriptFileUri': 'string'
        },
        'StartTime': datetime(2015, 1, 1),
        'CreationTime': datetime(2015, 1, 1),
        'CompletionTime': datetime(2015, 1, 1),
        'FailureReason': 'string',
        'Settings': {
            'VocabularyName': 'string',
            'ShowSpeakerLabels': True|False,
            'MaxSpeakerLabels': 123,
            'ChannelIdentification': True|False,
            'ShowAlternatives': True|False,
            'MaxAlternatives': 123,
            'VocabularyFilterName': 'string',
            'VocabularyFilterMethod': 'remove'|'mask'
        },
        'JobExecutionSettings': {
            'AllowDeferredExecution': True|False,
            'DataAccessRoleArn': 'string'
        }
    }
}

Response Structure

  • (dict) --
    • TranscriptionJob (dict) --

      An object that contains the results of the transcription job.

      • TranscriptionJobName (string) --

        The name of the transcription job.

      • TranscriptionJobStatus (string) --

        The status of the transcription job.

      • LanguageCode (string) --

        The language code for the input speech.

      • MediaSampleRateHertz (integer) --

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

      • MediaFormat (string) --

        The format of the input media file.

      • Media (dict) --

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

        • MediaFileUri (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://s3.<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 .

      • Transcript (dict) --

        An object that describes the output of the transcription job.

        • TranscriptFileUri (string) --

          The location where the transcription is stored.

          Use this URI to access the transcription. If you specified an S3 bucket in the OutputBucketName field when you created the job, this is the URI of that bucket. If you chose to store the transcription in Amazon Transcribe, this is a shareable URL that provides secure access to that location.

      • StartTime (datetime) --

        A timestamp that shows with the job was started processing.

      • CreationTime (datetime) --

        A timestamp that shows when the job was created.

      • CompletionTime (datetime) --

        A timestamp that shows when the job was completed.

      • FailureReason (string) --

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

        The FailureReason field can contain one of the following values:

        • Unsupported media format - The media format specified in the MediaFormat field of the request isn't valid. See the description of the MediaFormat field for a list of valid values.
        • The media format provided does not match the detected media format - The media format of the audio file doesn't match the format specified in the MediaFormat field in the request. Check the media format of your media file and make sure that the two values match.
        • Invalid sample rate for audio file - The sample rate specified in the MediaSampleRateHertz of the request isn't valid. The sample rate must be between 8000 and 48000 Hertz.
        • The sample rate provided does not match the detected sample rate - The sample rate in the audio file doesn't match the sample rate specified in the MediaSampleRateHertz field in the request. Check the sample rate of your media file and make sure that the two values match.
        • Invalid file size: file size too large - The size of your audio file is larger than Amazon Transcribe can process. For more information, see Limits in the Amazon Transcribe Developer Guide .
        • Invalid number of channels: number of channels too large - Your audio contains more channels than Amazon Transcribe is configured to process. To request additional channels, see Amazon Transcribe Limits in the Amazon Web Services General Reference .
      • Settings (dict) --

        Optional settings for the transcription job. Use these settings to turn on speaker recognition, to set the maximum number of speakers that should be identified and to specify a custom vocabulary to use when processing the transcription job.

        • VocabularyName (string) --

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

        • ShowSpeakerLabels (boolean) --

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

          You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException .

        • MaxSpeakerLabels (integer) --

          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.

        • ChannelIdentification (boolean) --

          Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription.

          Amazon Transcribe also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of the item including the confidence that Amazon Transcribe has in the transcription.

          You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException .

        • ShowAlternatives (boolean) --

          Determines whether the transcription contains alternative transcriptions. If you set the ShowAlternatives field to true, you must also set the maximum number of alternatives to return in the MaxAlternatives field.

        • MaxAlternatives (integer) --

          The number of alternative transcriptions that the service should return. If you specify the MaxAlternatives field, you must set the ShowAlternatives field to true.

        • VocabularyFilterName (string) --

          The name of the vocabulary filter to use when transcribing the audio. The filter that you specify must have the same language code as the transcription job.

        • VocabularyFilterMethod (string) --

          Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text. Set to remove to remove filtered text from the transcript without using placeholder text.

      • JobExecutionSettings (dict) --

        Provides information about how a transcription job is executed.

        • AllowDeferredExecution (boolean) --

          Indicates whether a job should be queued by Amazon Transcribe when the concurrent execution limit is exceeded. When the AllowDeferredExecution field is true, jobs are queued and will be executed when the number of executing jobs falls below the concurrent execution limit. If the field is false, Amazon Transcribe returns a LimitExceededException exception.

          If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn field.

        • DataAccessRoleArn (string) --

          The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that contains the input files. Amazon Transcribe will assume this role to read queued media files. If you have specified an output S3 bucket for the transcription results, this role should have access to the output bucket as well.

          If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn field.

get_vocabulary(**kwargs)

Gets information about a vocabulary.

See also: AWS API Documentation

Request Syntax

response = client.get_vocabulary(
    VocabularyName='string'
)
Parameters
VocabularyName (string) --

[REQUIRED]

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

Return type
dict
Returns
Response Syntax
{
    'VocabularyName': 'string',
    'LanguageCode': 'en-US'|'es-US'|'en-AU'|'fr-CA'|'en-GB'|'de-DE'|'pt-BR'|'fr-FR'|'it-IT'|'ko-KR'|'es-ES'|'en-IN'|'hi-IN'|'ar-SA'|'ru-RU'|'zh-CN'|'nl-NL'|'id-ID'|'ta-IN'|'fa-IR'|'en-IE'|'en-AB'|'en-WL'|'pt-PT'|'te-IN'|'tr-TR'|'de-CH'|'he-IL'|'ms-MY'|'ja-JP'|'ar-AE',
    'VocabularyState': 'PENDING'|'READY'|'FAILED',
    'LastModifiedTime': datetime(2015, 1, 1),
    'FailureReason': 'string',
    'DownloadUri': 'string'
}

Response Structure

  • (dict) --
    • VocabularyName (string) --

      The name of the vocabulary to return.

    • LanguageCode (string) --

      The language code of the vocabulary entries.

    • VocabularyState (string) --

      The processing state of the vocabulary.

    • LastModifiedTime (datetime) --

      The date and time that the vocabulary was last modified.

    • FailureReason (string) --

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

    • DownloadUri (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.

get_vocabulary_filter(**kwargs)

Returns information about a vocabulary filter.

See also: AWS API Documentation

Request Syntax

response = client.get_vocabulary_filter(
    VocabularyFilterName='string'
)
Parameters
VocabularyFilterName (string) --

[REQUIRED]

The name of the vocabulary filter for which to return information.

Return type
dict
Returns
Response Syntax
{
    'VocabularyFilterName': 'string',
    'LanguageCode': 'en-US'|'es-US'|'en-AU'|'fr-CA'|'en-GB'|'de-DE'|'pt-BR'|'fr-FR'|'it-IT'|'ko-KR'|'es-ES'|'en-IN'|'hi-IN'|'ar-SA'|'ru-RU'|'zh-CN'|'nl-NL'|'id-ID'|'ta-IN'|'fa-IR'|'en-IE'|'en-AB'|'en-WL'|'pt-PT'|'te-IN'|'tr-TR'|'de-CH'|'he-IL'|'ms-MY'|'ja-JP'|'ar-AE',
    'LastModifiedTime': datetime(2015, 1, 1),
    'DownloadUri': 'string'
}

Response Structure

  • (dict) --
    • VocabularyFilterName (string) --

      The name of the vocabulary filter.

    • LanguageCode (string) --

      The language code of the words in the vocabulary filter.

    • LastModifiedTime (datetime) --

      The date and time that the contents of the vocabulary filter were updated.

    • DownloadUri (string) --

      The URI of the list of words in the vocabulary filter. You can use this URI to get the list of words.

get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_transcription_jobs(**kwargs)

Lists transcription jobs with the specified status.

See also: AWS API Documentation

Request Syntax

response = client.list_transcription_jobs(
    Status='QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
    JobNameContains='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • Status (string) -- When specified, returns only transcription jobs with the specified status. Jobs are ordered by creation date, with the newest jobs returned first. If you don’t specify a status, Amazon Transcribe returns all transcription jobs ordered by creation date.
  • JobNameContains (string) -- When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.
  • NextToken (string) -- If the result of the previous request to ListTranscriptionJobs was truncated, include the NextToken to fetch the next set of jobs.
  • MaxResults (integer) -- 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.
Return type

dict

Returns

Response Syntax

{
    'Status': 'QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
    'NextToken': 'string',
    'TranscriptionJobSummaries': [
        {
            'TranscriptionJobName': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'StartTime': datetime(2015, 1, 1),
            'CompletionTime': datetime(2015, 1, 1),
            'LanguageCode': 'en-US'|'es-US'|'en-AU'|'fr-CA'|'en-GB'|'de-DE'|'pt-BR'|'fr-FR'|'it-IT'|'ko-KR'|'es-ES'|'en-IN'|'hi-IN'|'ar-SA'|'ru-RU'|'zh-CN'|'nl-NL'|'id-ID'|'ta-IN'|'fa-IR'|'en-IE'|'en-AB'|'en-WL'|'pt-PT'|'te-IN'|'tr-TR'|'de-CH'|'he-IL'|'ms-MY'|'ja-JP'|'ar-AE',
            'TranscriptionJobStatus': 'QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
            'FailureReason': 'string',
            'OutputLocationType': 'CUSTOMER_BUCKET'|'SERVICE_BUCKET'
        },
    ]
}

Response Structure

  • (dict) --

    • Status (string) --

      The requested status of the jobs returned.

    • NextToken (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.

    • TranscriptionJobSummaries (list) --

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

      • (dict) --

        Provides a summary of information about a transcription job.

        • TranscriptionJobName (string) --

          The name of the transcription job.

        • CreationTime (datetime) --

          A timestamp that shows when the job was created.

        • StartTime (datetime) --

          A timestamp that shows when the job started processing.

        • CompletionTime (datetime) --

          A timestamp that shows when the job was completed.

        • LanguageCode (string) --

          The language code for the input speech.

        • TranscriptionJobStatus (string) --

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

        • FailureReason (string) --

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

        • OutputLocationType (string) --

          Indicates the location of the output of the transcription job.

          If the value is CUSTOMER_BUCKET then the location is the S3 bucket specified in the outputBucketName field when the transcription job was started with the StartTranscriptionJob operation.

          If the value is SERVICE_BUCKET then the output is stored by Amazon Transcribe and can be retrieved using the URI in the GetTranscriptionJob response's TranscriptFileUri field.

list_vocabularies(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_vocabularies(
    NextToken='string',
    MaxResults=123,
    StateEquals='PENDING'|'READY'|'FAILED',
    NameContains='string'
)
Parameters
  • NextToken (string) -- If the result of the previous request to ListVocabularies was truncated, include the NextToken to fetch the next set of jobs.
  • MaxResults (integer) -- 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.
  • StateEquals (string) -- When specified, only returns vocabularies with the VocabularyState field equal to the specified state.
  • NameContains (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.
Return type

dict

Returns

Response Syntax

{
    'Status': 'QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
    'NextToken': 'string',
    'Vocabularies': [
        {
            'VocabularyName': 'string',
            'LanguageCode': 'en-US'|'es-US'|'en-AU'|'fr-CA'|'en-GB'|'de-DE'|'pt-BR'|'fr-FR'|'it-IT'|'ko-KR'|'es-ES'|'en-IN'|'hi-IN'|'ar-SA'|'ru-RU'|'zh-CN'|'nl-NL'|'id-ID'|'ta-IN'|'fa-IR'|'en-IE'|'en-AB'|'en-WL'|'pt-PT'|'te-IN'|'tr-TR'|'de-CH'|'he-IL'|'ms-MY'|'ja-JP'|'ar-AE',
            'LastModifiedTime': datetime(2015, 1, 1),
            'VocabularyState': 'PENDING'|'READY'|'FAILED'
        },
    ]
}

Response Structure

  • (dict) --

    • Status (string) --

      The requested vocabulary state.

    • NextToken (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.

    • Vocabularies (list) --

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

      • (dict) --

        Provides information about a custom vocabulary.

        • VocabularyName (string) --

          The name of the vocabulary.

        • LanguageCode (string) --

          The language code of the vocabulary entries.

        • LastModifiedTime (datetime) --

          The date and time that the vocabulary was last modified.

        • VocabularyState (string) --

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

list_vocabulary_filters(**kwargs)

Gets information about vocabulary filters.

See also: AWS API Documentation

Request Syntax

response = client.list_vocabulary_filters(
    NextToken='string',
    MaxResults=123,
    NameContains='string'
)
Parameters
  • NextToken (string) -- If the result of the previous request to ListVocabularyFilters was truncated, include the NextToken to fetch the next set of collections.
  • MaxResults (integer) -- The maximum number of filters to return in the response. If there are fewer results in the list, this response contains only the actual results.
  • NameContains (string) -- Filters the response so that it only contains vocabulary filters whose name contains the specified string.
Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'VocabularyFilters': [
        {
            'VocabularyFilterName': 'string',
            'LanguageCode': 'en-US'|'es-US'|'en-AU'|'fr-CA'|'en-GB'|'de-DE'|'pt-BR'|'fr-FR'|'it-IT'|'ko-KR'|'es-ES'|'en-IN'|'hi-IN'|'ar-SA'|'ru-RU'|'zh-CN'|'nl-NL'|'id-ID'|'ta-IN'|'fa-IR'|'en-IE'|'en-AB'|'en-WL'|'pt-PT'|'te-IN'|'tr-TR'|'de-CH'|'he-IL'|'ms-MY'|'ja-JP'|'ar-AE',
            'LastModifiedTime': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      The ListVocabularyFilters operation returns a page of collections 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 ListVocabularyFilters operation to return in the next page of jobs.

    • VocabularyFilters (list) --

      The list of vocabulary filters. It will contain at most MaxResults number of filters. If there are more filters, call the ListVocabularyFilters operation again with the NextToken parameter in the request set to the value of the NextToken field in the response.

      • (dict) --

        Provides information about a vocabulary filter.

        • VocabularyFilterName (string) --

          The name of the vocabulary filter. The name must be unique in the account that holds the filter.

        • LanguageCode (string) --

          The language code of the words in the vocabulary filter.

        • LastModifiedTime (datetime) --

          The date and time that the vocabulary was last updated.

start_transcription_job(**kwargs)

Starts an asynchronous job to transcribe speech to text.

See also: AWS API Documentation

Request Syntax

response = client.start_transcription_job(
    TranscriptionJobName='string',
    LanguageCode='en-US'|'es-US'|'en-AU'|'fr-CA'|'en-GB'|'de-DE'|'pt-BR'|'fr-FR'|'it-IT'|'ko-KR'|'es-ES'|'en-IN'|'hi-IN'|'ar-SA'|'ru-RU'|'zh-CN'|'nl-NL'|'id-ID'|'ta-IN'|'fa-IR'|'en-IE'|'en-AB'|'en-WL'|'pt-PT'|'te-IN'|'tr-TR'|'de-CH'|'he-IL'|'ms-MY'|'ja-JP'|'ar-AE',
    MediaSampleRateHertz=123,
    MediaFormat='mp3'|'mp4'|'wav'|'flac',
    Media={
        'MediaFileUri': 'string'
    },
    OutputBucketName='string',
    OutputEncryptionKMSKeyId='string',
    Settings={
        'VocabularyName': 'string',
        'ShowSpeakerLabels': True|False,
        'MaxSpeakerLabels': 123,
        'ChannelIdentification': True|False,
        'ShowAlternatives': True|False,
        'MaxAlternatives': 123,
        'VocabularyFilterName': 'string',
        'VocabularyFilterMethod': 'remove'|'mask'
    },
    JobExecutionSettings={
        'AllowDeferredExecution': True|False,
        'DataAccessRoleArn': 'string'
    }
)
Parameters
  • TranscriptionJobName (string) --

    [REQUIRED]

    The name of the job. Note that you can't use the strings "." or ".." by themselves as the job name. The name must also be unique within an AWS account.

  • LanguageCode (string) --

    [REQUIRED]

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

  • MediaSampleRateHertz (integer) --

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

    If you do not specify the media sample rate, Amazon Transcribe determines the sample rate. If you specify the sample rate, it must match the sample rate detected by Amazon Transcribe. In most cases, you should leave the MediaSampleRateHertz field blank and let Amazon Transcribe determine the sample rate.

  • MediaFormat (string) -- The format of the input media file.
  • Media (dict) --

    [REQUIRED]

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

    • MediaFileUri (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://s3.<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 .

  • OutputBucketName (string) --

    The location where the transcription is stored.

    If you set the OutputBucketName , Amazon Transcribe puts the transcription in the specified S3 bucket. When you call the GetTranscriptionJob operation, the operation returns this location in the TranscriptFileUri field. The S3 bucket must have permissions that allow Amazon Transcribe to put files in the bucket. For more information, see Permissions Required for IAM User Roles .

    You can specify an AWS Key Management Service (KMS) key to encrypt the output of your transcription using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.

    If you don't set the OutputBucketName , Amazon Transcribe generates a pre-signed URL, a shareable URL that provides secure access to your transcription, and returns it in the TranscriptFileUri field. Use this URL to download the transcription.

  • OutputEncryptionKMSKeyId (string) --

    The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the StartTranscriptionJob operation must have permission to use the specified KMS key.

    You can use either of the following to identify a KMS key in the current account:

    • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
    • KMS Key Alias: "alias/ExampleAlias"

    You can use either of the following to identify a KMS key in the current account or another account:

    • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    • ARN of a KMS Key Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"

    If you don't specify an encryption key, the output of the transcription job is encrypted with the default Amazon S3 key (SSE-S3).

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

  • Settings (dict) --

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

    • VocabularyName (string) --

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

    • ShowSpeakerLabels (boolean) --

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

      You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException .

    • MaxSpeakerLabels (integer) --

      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.

    • ChannelIdentification (boolean) --

      Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription.

      Amazon Transcribe also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of the item including the confidence that Amazon Transcribe has in the transcription.

      You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException .

    • ShowAlternatives (boolean) --

      Determines whether the transcription contains alternative transcriptions. If you set the ShowAlternatives field to true, you must also set the maximum number of alternatives to return in the MaxAlternatives field.

    • MaxAlternatives (integer) --

      The number of alternative transcriptions that the service should return. If you specify the MaxAlternatives field, you must set the ShowAlternatives field to true.

    • VocabularyFilterName (string) --

      The name of the vocabulary filter to use when transcribing the audio. The filter that you specify must have the same language code as the transcription job.

    • VocabularyFilterMethod (string) --

      Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text. Set to remove to remove filtered text from the transcript without using placeholder text.

  • JobExecutionSettings (dict) --

    Provides information about how a transcription job is executed. Use this field to indicate that the job can be queued for deferred execution if the concurrency limit is reached and there are no slots available to immediately run the job.

    • AllowDeferredExecution (boolean) --

      Indicates whether a job should be queued by Amazon Transcribe when the concurrent execution limit is exceeded. When the AllowDeferredExecution field is true, jobs are queued and will be executed when the number of executing jobs falls below the concurrent execution limit. If the field is false, Amazon Transcribe returns a LimitExceededException exception.

      If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn field.

    • DataAccessRoleArn (string) --

      The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that contains the input files. Amazon Transcribe will assume this role to read queued media files. If you have specified an output S3 bucket for the transcription results, this role should have access to the output bucket as well.

      If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn field.

Return type

dict

Returns

Response Syntax

{
    'TranscriptionJob': {
        'TranscriptionJobName': 'string',
        'TranscriptionJobStatus': 'QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
        'LanguageCode': 'en-US'|'es-US'|'en-AU'|'fr-CA'|'en-GB'|'de-DE'|'pt-BR'|'fr-FR'|'it-IT'|'ko-KR'|'es-ES'|'en-IN'|'hi-IN'|'ar-SA'|'ru-RU'|'zh-CN'|'nl-NL'|'id-ID'|'ta-IN'|'fa-IR'|'en-IE'|'en-AB'|'en-WL'|'pt-PT'|'te-IN'|'tr-TR'|'de-CH'|'he-IL'|'ms-MY'|'ja-JP'|'ar-AE',
        'MediaSampleRateHertz': 123,
        'MediaFormat': 'mp3'|'mp4'|'wav'|'flac',
        'Media': {
            'MediaFileUri': 'string'
        },
        'Transcript': {
            'TranscriptFileUri': 'string'
        },
        'StartTime': datetime(2015, 1, 1),
        'CreationTime': datetime(2015, 1, 1),
        'CompletionTime': datetime(2015, 1, 1),
        'FailureReason': 'string',
        'Settings': {
            'VocabularyName': 'string',
            'ShowSpeakerLabels': True|False,
            'MaxSpeakerLabels': 123,
            'ChannelIdentification': True|False,
            'ShowAlternatives': True|False,
            'MaxAlternatives': 123,
            'VocabularyFilterName': 'string',
            'VocabularyFilterMethod': 'remove'|'mask'
        },
        'JobExecutionSettings': {
            'AllowDeferredExecution': True|False,
            'DataAccessRoleArn': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • TranscriptionJob (dict) --

      An object containing details of the asynchronous transcription job.

      • TranscriptionJobName (string) --

        The name of the transcription job.

      • TranscriptionJobStatus (string) --

        The status of the transcription job.

      • LanguageCode (string) --

        The language code for the input speech.

      • MediaSampleRateHertz (integer) --

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

      • MediaFormat (string) --

        The format of the input media file.

      • Media (dict) --

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

        • MediaFileUri (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://s3.<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 .

      • Transcript (dict) --

        An object that describes the output of the transcription job.

        • TranscriptFileUri (string) --

          The location where the transcription is stored.

          Use this URI to access the transcription. If you specified an S3 bucket in the OutputBucketName field when you created the job, this is the URI of that bucket. If you chose to store the transcription in Amazon Transcribe, this is a shareable URL that provides secure access to that location.

      • StartTime (datetime) --

        A timestamp that shows with the job was started processing.

      • CreationTime (datetime) --

        A timestamp that shows when the job was created.

      • CompletionTime (datetime) --

        A timestamp that shows when the job was completed.

      • FailureReason (string) --

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

        The FailureReason field can contain one of the following values:

        • Unsupported media format - The media format specified in the MediaFormat field of the request isn't valid. See the description of the MediaFormat field for a list of valid values.
        • The media format provided does not match the detected media format - The media format of the audio file doesn't match the format specified in the MediaFormat field in the request. Check the media format of your media file and make sure that the two values match.
        • Invalid sample rate for audio file - The sample rate specified in the MediaSampleRateHertz of the request isn't valid. The sample rate must be between 8000 and 48000 Hertz.
        • The sample rate provided does not match the detected sample rate - The sample rate in the audio file doesn't match the sample rate specified in the MediaSampleRateHertz field in the request. Check the sample rate of your media file and make sure that the two values match.
        • Invalid file size: file size too large - The size of your audio file is larger than Amazon Transcribe can process. For more information, see Limits in the Amazon Transcribe Developer Guide .
        • Invalid number of channels: number of channels too large - Your audio contains more channels than Amazon Transcribe is configured to process. To request additional channels, see Amazon Transcribe Limits in the Amazon Web Services General Reference .
      • Settings (dict) --

        Optional settings for the transcription job. Use these settings to turn on speaker recognition, to set the maximum number of speakers that should be identified and to specify a custom vocabulary to use when processing the transcription job.

        • VocabularyName (string) --

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

        • ShowSpeakerLabels (boolean) --

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

          You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException .

        • MaxSpeakerLabels (integer) --

          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.

        • ChannelIdentification (boolean) --

          Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription.

          Amazon Transcribe also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of the item including the confidence that Amazon Transcribe has in the transcription.

          You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException .

        • ShowAlternatives (boolean) --

          Determines whether the transcription contains alternative transcriptions. If you set the ShowAlternatives field to true, you must also set the maximum number of alternatives to return in the MaxAlternatives field.

        • MaxAlternatives (integer) --

          The number of alternative transcriptions that the service should return. If you specify the MaxAlternatives field, you must set the ShowAlternatives field to true.

        • VocabularyFilterName (string) --

          The name of the vocabulary filter to use when transcribing the audio. The filter that you specify must have the same language code as the transcription job.

        • VocabularyFilterMethod (string) --

          Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text. Set to remove to remove filtered text from the transcript without using placeholder text.

      • JobExecutionSettings (dict) --

        Provides information about how a transcription job is executed.

        • AllowDeferredExecution (boolean) --

          Indicates whether a job should be queued by Amazon Transcribe when the concurrent execution limit is exceeded. When the AllowDeferredExecution field is true, jobs are queued and will be executed when the number of executing jobs falls below the concurrent execution limit. If the field is false, Amazon Transcribe returns a LimitExceededException exception.

          If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn field.

        • DataAccessRoleArn (string) --

          The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that contains the input files. Amazon Transcribe will assume this role to read queued media files. If you have specified an output S3 bucket for the transcription results, this role should have access to the output bucket as well.

          If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn field.

update_vocabulary(**kwargs)

Updates an existing vocabulary with new values. The UpdateVocabulary operation overwrites all of the existing information with the values that you provide in the request.

See also: AWS API Documentation

Request Syntax

response = client.update_vocabulary(
    VocabularyName='string',
    LanguageCode='en-US'|'es-US'|'en-AU'|'fr-CA'|'en-GB'|'de-DE'|'pt-BR'|'fr-FR'|'it-IT'|'ko-KR'|'es-ES'|'en-IN'|'hi-IN'|'ar-SA'|'ru-RU'|'zh-CN'|'nl-NL'|'id-ID'|'ta-IN'|'fa-IR'|'en-IE'|'en-AB'|'en-WL'|'pt-PT'|'te-IN'|'tr-TR'|'de-CH'|'he-IL'|'ms-MY'|'ja-JP'|'ar-AE',
    Phrases=[
        'string',
    ],
    VocabularyFileUri='string'
)
Parameters
  • VocabularyName (string) --

    [REQUIRED]

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

  • LanguageCode (string) --

    [REQUIRED]

    The language code of the vocabulary entries.

  • Phrases (list) --

    An array of strings containing the vocabulary entries.

    • (string) --
  • VocabularyFileUri (string) --

    The S3 location of the text file that contains the definition of the custom vocabulary. The URI must be in the same region as the API endpoint that you are calling. The general form is

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

    For example:

    https://s3.us-east-1.amazonaws.com/examplebucket/vocab.txt

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

    For more information about custom vocabularies, see Custom Vocabularies .

Return type

dict

Returns

Response Syntax

{
    'VocabularyName': 'string',
    'LanguageCode': 'en-US'|'es-US'|'en-AU'|'fr-CA'|'en-GB'|'de-DE'|'pt-BR'|'fr-FR'|'it-IT'|'ko-KR'|'es-ES'|'en-IN'|'hi-IN'|'ar-SA'|'ru-RU'|'zh-CN'|'nl-NL'|'id-ID'|'ta-IN'|'fa-IR'|'en-IE'|'en-AB'|'en-WL'|'pt-PT'|'te-IN'|'tr-TR'|'de-CH'|'he-IL'|'ms-MY'|'ja-JP'|'ar-AE',
    'LastModifiedTime': datetime(2015, 1, 1),
    'VocabularyState': 'PENDING'|'READY'|'FAILED'
}

Response Structure

  • (dict) --

    • VocabularyName (string) --

      The name of the vocabulary that was updated.

    • LanguageCode (string) --

      The language code of the vocabulary entries.

    • LastModifiedTime (datetime) --

      The date and time that the vocabulary was updated.

    • VocabularyState (string) --

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

update_vocabulary_filter(**kwargs)

Updates a vocabulary filter with a new list of filtered words.

See also: AWS API Documentation

Request Syntax

response = client.update_vocabulary_filter(
    VocabularyFilterName='string',
    Words=[
        'string',
    ],
    VocabularyFilterFileUri='string'
)
Parameters
  • VocabularyFilterName (string) --

    [REQUIRED]

    The name of the vocabulary filter to update.

  • Words (list) --

    The words to use in the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies .

    If you provide a list of words in the Words parameter, you can't use the VocabularyFilterFileUri parameter.

    • (string) --
  • VocabularyFilterFileUri (string) --

    The Amazon S3 location of a text file used as input to create the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies .

    The specified file must be less than 50 KB of UTF-8 characters.

    If you provide the location of a list of words in the VocabularyFilterFileUri parameter, you can't use the Words parameter.

Return type

dict

Returns

Response Syntax

{
    'VocabularyFilterName': 'string',
    'LanguageCode': 'en-US'|'es-US'|'en-AU'|'fr-CA'|'en-GB'|'de-DE'|'pt-BR'|'fr-FR'|'it-IT'|'ko-KR'|'es-ES'|'en-IN'|'hi-IN'|'ar-SA'|'ru-RU'|'zh-CN'|'nl-NL'|'id-ID'|'ta-IN'|'fa-IR'|'en-IE'|'en-AB'|'en-WL'|'pt-PT'|'te-IN'|'tr-TR'|'de-CH'|'he-IL'|'ms-MY'|'ja-JP'|'ar-AE',
    'LastModifiedTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • VocabularyFilterName (string) --

      The name of the updated vocabulary filter.

    • LanguageCode (string) --

      The language code of the words in the vocabulary filter.

    • LastModifiedTime (datetime) --

      The date and time that the vocabulary filter was updated.

Paginators

The available paginators are: