Provides details about the specified AWS HealthScribe streaming session.
To view the status of the streaming session, check the StreamStatus field in the response. To get the
details of post-stream analytics, including its status, check the PostStreamAnalyticsResult field in the response.
Request Syntax
GET /medical-scribe-stream/SessionId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- SessionId
-
The identifier of the HealthScribe streaming session you want information about.
Length Constraints: Fixed length of 36.
Pattern:
[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"MedicalScribeStreamDetails": {
"ChannelDefinitions": [
{
"ChannelId": number,
"ParticipantRole": "string"
}
],
"EncryptionSettings": {
"KmsEncryptionContext": {
"string" : "string"
},
"KmsKeyId": "string"
},
"LanguageCode": "string",
"MediaEncoding": "string",
"MediaSampleRateHertz": number,
"PostStreamAnalyticsResult": {
"ClinicalNoteGenerationResult": {
"ClinicalNoteOutputLocation": "string",
"FailureReason": "string",
"Status": "string",
"TranscriptOutputLocation": "string"
}
},
"PostStreamAnalyticsSettings": {
"ClinicalNoteGenerationSettings": {
"NoteTemplate": "string",
"OutputBucketName": "string"
}
},
"ResourceAccessRoleArn": "string",
"SessionId": "string",
"StreamCreatedAt": number,
"StreamEndedAt": number,
"StreamStatus": "string",
"VocabularyFilterMethod": "string",
"VocabularyFilterName": "string",
"VocabularyName": "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.
- MedicalScribeStreamDetails
-
Provides details about a HealthScribe streaming session.
Type: MedicalScribeStreamDetails object
Errors
For information about the errors that are common to all actions, see Common Errors.
- BadRequestException
-
One or more arguments to the
StartStreamTranscription,StartMedicalStreamTranscription, orStartCallAnalyticsStreamTranscriptionoperation was not valid. For example,MediaEncodingorLanguageCodeused unsupported values. Check the specified parameters and try your request again.HTTP Status Code: 400
- InternalFailureException
-
A problem occurred while processing the audio. Amazon Transcribe terminated processing.
HTTP Status Code: 500
- LimitExceededException
-
Your client has exceeded one of the Amazon Transcribe limits. This is typically the audio length limit. Break your audio stream into smaller chunks and try your request again.
HTTP Status Code: 429
- ResourceNotFoundException
-
The request references a resource which doesn't exist.
HTTP Status Code: 404
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
