TranscribeService / Client / list_transcription_jobs

list_transcription_jobs#

TranscribeService.Client.list_transcription_jobs(**kwargs)#

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.

Request Syntax

response = client.list_transcription_jobs(
    Status='QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
    JobNameContains='string',
    NextToken='string',
    MaxResults=123
)

Parameters:

Status (string) – Returns only transcription jobs with the specified status. Jobs are ordered by creation date, with the newest job first. If you don’t include Status, all transcription jobs are returned.
JobNameContains (string) – Returns only the transcription jobs that contain the specified string. The search is not case sensitive.
NextToken (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.
MaxResults (integer) – 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 don’t specify a value, a default of 5 is used.

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': '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',
            'TranscriptionJobStatus': 'QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
            'FailureReason': 'string',
            'OutputLocationType': 'CUSTOMER_BUCKET'|'SERVICE_BUCKET',
            'ContentRedaction': {
                'RedactionType': 'PII',
                'RedactionOutput': 'redacted'|'redacted_and_unredacted',
                'PiiEntityTypes': [
                    'BANK_ACCOUNT_NUMBER'|'BANK_ROUTING'|'CREDIT_DEBIT_NUMBER'|'CREDIT_DEBIT_CVV'|'CREDIT_DEBIT_EXPIRY'|'PIN'|'EMAIL'|'ADDRESS'|'NAME'|'PHONE'|'SSN'|'ALL',
                ]
            },
            'ModelSettings': {
                'LanguageModelName': 'string'
            },
            'IdentifyLanguage': True|False,
            'IdentifyMultipleLanguages': True|False,
            'IdentifiedLanguageScore': ...,
            'LanguageCodes': [
                {
                    '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',
                    'DurationInSeconds': ...
                },
            ],
            'ToxicityDetection': [
                {
                    'ToxicityCategories': [
                        'ALL',
                    ]
                },
            ]
        },
    ]
}

Response Structure

(dict) –
- Status (string) –
  
  Lists all transcription jobs that have the status specified in your request. Jobs are ordered by creation date, with the newest job first.
- NextToken (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.
- TranscriptionJobSummaries (list) –
  
  Provides a summary of information about each result.
  - (dict) –
    
    Provides detailed information about a specific transcription job.
    - TranscriptionJobName (string) –
      
      The name of the transcription job. Job names are case sensitive and must be unique within an Amazon Web Services account.
    - CreationTime (datetime) –
      
      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.
    - StartTime (datetime) –
      
      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.
    - CompletionTime (datetime) –
      
      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.
    - LanguageCode (string) –
      
      The language code used to create your transcription.
    - TranscriptionJobStatus (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.
    - FailureReason (string) –
      
      If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job failed. See also: Common Errors.
    - OutputLocationType (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.
    - ContentRedaction (dict) –
      
      The content redaction settings of the transcription job.
      - RedactionType (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.
      - RedactionOutput (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).
      - PiiEntityTypes (list) –
        
        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.
        
        (string) –
    - ModelSettings (dict) –
      
      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.
      - LanguageModelName (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 don’t match, the custom language model isn’t applied. There are no errors or warnings associated with a language mismatch.
    - IdentifyLanguage (boolean) –
      
      Indicates whether automatic language identification was enabled ( TRUE) for the specified transcription job.
    - IdentifyMultipleLanguages (boolean) –
      
      Indicates whether automatic multi-language identification was enabled ( TRUE) for the specified transcription job.
    - IdentifiedLanguageScore (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.
    - LanguageCodes (list) –
      
      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.
      - (dict) –
        
        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.
        
        LanguageCode (string) –
        
        Provides the language code for each language identified in your media.
        
        DurationInSeconds (float) –
        
        Provides the total time, in seconds, each identified language is spoken in your media.
    - ToxicityDetection (list) –
      
      Indicates whether toxicity detection was enabled for the specified transcription job.
      - (dict) –
        
        Contains ToxicityCategories, which is a required parameter if you want to enable toxicity detection ( ToxicityDetection) in your transcription request.
        
        ToxicityCategories (list) –
        
        If you include ToxicityDetection in your transcription request, you must also include ToxicityCategories. The only accepted value for this parameter is ALL.
        
        (string) –

Exceptions

TranscribeService.Client.exceptions.BadRequestException
TranscribeService.Client.exceptions.LimitExceededException
TranscribeService.Client.exceptions.InternalFailureException