TranscribeService / Client / list_medical_transcription_jobs

list_medical_transcription_jobs#

TranscribeService.Client.list_medical_transcription_jobs(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

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

Parameters:

Status (string) – Returns only medical transcription jobs with the specified status. Jobs are ordered by creation date, with the newest job first. If you don’t include Status, all medical transcription jobs are returned.
JobNameContains (string) – Returns only the medical transcription jobs that contain the specified string. The search is not case sensitive.
NextToken (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.
MaxResults (integer) – 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 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',
    'MedicalTranscriptionJobSummaries': [
        {
            'MedicalTranscriptionJobName': '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',
            'Specialty': 'PRIMARYCARE',
            'ContentIdentificationType': 'PHI',
            'Type': 'CONVERSATION'|'DICTATION'
        },
    ]
}

Response Structure

(dict) –
- Status (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.
- 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.
- MedicalTranscriptionJobSummaries (list) –
  
  Provides a summary of information about each result.
  - (dict) –
    
    Provides detailed information about a specific medical transcription job.
    - MedicalTranscriptionJobName (string) –
      
      The name of the medical 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 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.
    - StartTime (datetime) –
      
      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.
    - CompletionTime (datetime) –
      
      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.
    - LanguageCode (string) –
      
      The language code used to create your medical transcription. US English ( en-US) is the only supported language for medical transcriptions.
    - TranscriptionJobStatus (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.
    - 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 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 (string) –
      
      Provides the medical specialty represented in your media.
    - ContentIdentificationType (string) –
      
      Labels all personal health information (PHI) identified in your transcript. For more information, see Identifying personal health information (PHI) in a transcription.
    - Type (string) –
      
      Indicates whether the input media is a dictation or a conversation, as specified in the StartMedicalTranscriptionJob request.

Exceptions

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