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 GetMedicalScribeJob operation.
Request Syntax
{
"JobNameContains": "string",
"MaxResults": number,
"NextToken": "string",
"Status": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- JobNameContains
-
Returns only the Medical Scribe jobs that contain the specified string. The search is not case sensitive.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
^[0-9a-zA-Z._-]+Required: No
- MaxResults
-
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.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
-
If your
ListMedicalScribeJobsrequest returns more results than can be displayed,NextTokenis displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, includingNextTokenwith the value of the copied string. Repeat as needed to view all your results.Type: String
Length Constraints: Maximum length of 8192.
Pattern:
.+Required: No
- Status
-
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.Type: String
Valid Values:
QUEUED | IN_PROGRESS | FAILED | COMPLETEDRequired: No
Response Syntax
{
"MedicalScribeJobSummaries": [
{
"CompletionTime": number,
"CreationTime": number,
"FailureReason": "string",
"LanguageCode": "string",
"MedicalScribeJobName": "string",
"MedicalScribeJobStatus": "string",
"StartTime": number
}
],
"NextToken": "string",
"Status": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- MedicalScribeJobSummaries
-
Provides a summary of information about each result.
Type: Array of MedicalScribeJobSummary objects
- NextToken
-
If
NextTokenis present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with theNextTokenparameter in your results output, then run your request again includingNextTokenwith the value of the copied string. Repeat as needed to view all your results.Type: String
Length Constraints: Maximum length of 8192.
Pattern:
.+ - Status
-
Lists all Medical Scribe jobs that have the status specified in your request. Jobs are ordered by creation date, with the newest job first.
Type: String
Valid Values:
QUEUED | IN_PROGRESS | FAILED | COMPLETED
Errors
For information about the errors that are common to all actions, see Common Errors.
- BadRequestException
-
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.HTTP Status Code: 400
- InternalFailureException
-
There was an internal error. Check the error message, correct the issue, and try your request again.
HTTP Status Code: 500
- LimitExceededException
-
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.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
