ListMedicalScribeJobsCommand

Suggest an Edit

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { TranscribeClient, ListMedicalScribeJobsCommand } from "@aws-sdk/client-transcribe"; // ES Modules import
// const { TranscribeClient, ListMedicalScribeJobsCommand } = require("@aws-sdk/client-transcribe"); // CommonJS import
const client = new TranscribeClient(config);
const input = { // ListMedicalScribeJobsRequest
  Status: "QUEUED" || "IN_PROGRESS" || "FAILED" || "COMPLETED",
  JobNameContains: "STRING_VALUE",
  NextToken: "STRING_VALUE",
  MaxResults: Number("int"),
};
const command = new ListMedicalScribeJobsCommand(input);
const response = await client.send(command);
// { // ListMedicalScribeJobsResponse
//   Status: "QUEUED" || "IN_PROGRESS" || "FAILED" || "COMPLETED",
//   NextToken: "STRING_VALUE",
//   MedicalScribeJobSummaries: [ // MedicalScribeJobSummaries
//     { // MedicalScribeJobSummary
//       MedicalScribeJobName: "STRING_VALUE",
//       CreationTime: new Date("TIMESTAMP"),
//       StartTime: new Date("TIMESTAMP"),
//       CompletionTime: new Date("TIMESTAMP"),
//       LanguageCode: "en-US",
//       MedicalScribeJobStatus: "QUEUED" || "IN_PROGRESS" || "FAILED" || "COMPLETED",
//       FailureReason: "STRING_VALUE",
//     },
//   ],
// };

ListMedicalScribeJobsCommand Input

See ListMedicalScribeJobsCommandInput for more details

Parameter
Type
Description
JobNameContains
string | undefined

Returns only the Medical Scribe jobs that contain the specified string. The search is not case sensitive.

MaxResults
number | undefined

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.

NextToken
string | undefined

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.

Status
MedicalScribeJobStatus | undefined

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.

ListMedicalScribeJobsCommand Output

See ListMedicalScribeJobsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
MedicalScribeJobSummaries
MedicalScribeJobSummary[] | undefined

Provides a summary of information about each result.

NextToken
string | undefined

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.

Status
MedicalScribeJobStatus | undefined

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

Throws

Name
Fault
Details
BadRequestException
client

Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

InternalFailureException
server

There was an internal error. Check the error message, correct the issue, and try your request again.

LimitExceededException
client

You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

TranscribeServiceException
Base exception class for all service exceptions from Transcribe service.