Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetMedicalScribeJob

Provides information about the specified Medical Scribe job.

To view the status of the specified medical transcription job, check the MedicalScribeJobStatus field. If the status is COMPLETED, the job is finished. 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.

To get a list of your Medical Scribe jobs, use the ListMedicalScribeJobs operation.

Request Syntax


{
   "MedicalScribeJobName": "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.

MedicalScribeJobName

The name of the Medical Scribe job you want information about. Job names are case sensitive.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Pattern: ^[0-9a-zA-Z._-]+

Required: Yes

Response Syntax


{
   "MedicalScribeJob": { 
      "ChannelDefinitions": [ 
         { 
            "ChannelId": number,
            "ParticipantRole": "string"
         }
      ],
      "CompletionTime": number,
      "CreationTime": number,
      "DataAccessRoleArn": "string",
      "FailureReason": "string",
      "LanguageCode": "string",
      "Media": { 
         "MediaFileUri": "string",
         "RedactedMediaFileUri": "string"
      },
      "MedicalScribeJobName": "string",
      "MedicalScribeJobStatus": "string",
      "MedicalScribeOutput": { 
         "ClinicalDocumentUri": "string",
         "TranscriptFileUri": "string"
      },
      "Settings": { 
         "ChannelIdentification": boolean,
         "MaxSpeakerLabels": number,
         "ShowSpeakerLabels": boolean,
         "VocabularyFilterMethod": "string",
         "VocabularyFilterName": "string",
         "VocabularyName": "string"
      },
      "StartTime": number,
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "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.

MedicalScribeJob

Provides detailed information about the specified Medical Scribe job, including job status and, if applicable, failure reason

Type: MedicalScribeJob object

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

NotFoundException

We can't find the requested resource. Check that the specified name is correct and try your request again.

HTTP Status Code: 400