TranscribeService / Client / list_medical_scribe_jobs

list_medical_scribe_jobs#

TranscribeService.Client.list_medical_scribe_jobs(**kwargs)#

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

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

See also: AWS API Documentation

Request Syntax

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

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

  • JobNameContains (string) – Returns only the Medical Scribe jobs that contain the specified string. The search is not case sensitive.

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

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

Return type:

dict

Returns:

Response Syntax

{
    'Status': 'QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
    'NextToken': 'string',
    'MedicalScribeJobSummaries': [
        {
            'MedicalScribeJobName': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'StartTime': datetime(2015, 1, 1),
            'CompletionTime': datetime(2015, 1, 1),
            'LanguageCode': 'en-US',
            'MedicalScribeJobStatus': 'QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
            'FailureReason': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • Status (string) –

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

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

    • MedicalScribeJobSummaries (list) –

      Provides a summary of information about each result.

      • (dict) –

        Provides detailed information about a specific Medical Scribe job.

        • MedicalScribeJobName (string) –

          The name of the Medical Scribe 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 Scribe job request was made.

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

        • StartTime (datetime) –

          The date and time your Medical Scribe job began processing.

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

        • CompletionTime (datetime) –

          The date and time the specified Medical Scribe job finished processing.

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

        • LanguageCode (string) –

          The language code used to create your Medical Scribe job. US English ( en-US) is the only supported language for Medical Scribe jobs.

        • MedicalScribeJobStatus (string) –

          Provides the status of the specified Medical Scribe job.

          If the status is COMPLETED, the job is finished and you can find the results at the location specified in MedicalScribeOutput If the status is FAILED, FailureReason provides details on why your Medical Scribe job failed.

        • FailureReason (string) –

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

Exceptions

  • TranscribeService.Client.exceptions.BadRequestException

  • TranscribeService.Client.exceptions.LimitExceededException

  • TranscribeService.Client.exceptions.InternalFailureException