AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . connecthealth ]

get-medical-scribe-listening-session

Description

Retrieves details about an existing Medical Scribe listening session

See also: AWS API Documentation

Synopsis

  get-medical-scribe-listening-session
--session-id <value>
--domain-id <value>
--subscription-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]

Options

--session-id (string)

The Session identifier

--domain-id (string)

The Domain identifier

--subscription-id (string)

The Subscription identifier

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

medicalScribeListeningSessionDetails -> (structure)

Details about the Medical Scribe listening session

sessionId -> (string)

The Session identifier

domainId -> (string)

The Domain identifier

subscriptionId -> (string)

The Subscription identifier

languageCode -> (string)

The Language Code for the audio in the session

mediaSampleRateHertz -> (integer)

The sample rate of the input audio

mediaEncoding -> (string)

The encoding for the input audio

channelDefinitions -> (list)

Channel definitions for the audio stream

(structure)

Defines a channel in the audio stream

channelId -> (integer)

The channel identifier

participantRole -> (string)

The role of the participant on this channel

postStreamActionSettings -> (structure)

Settings for post-stream actions

outputS3Uri -> (string)

clinicalNoteGenerationSettings -> (structure)

Settings for clinical note generation

noteTemplateSettings -> (tagged union structure)

Settings for the note template used

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: managedTemplate, customTemplate.

managedTemplate -> (structure)

templateType -> (string)

The type of managed template used

customTemplate -> (structure)

templateType -> (string)

The base template type that was customized

postStreamActionResult -> (structure)

Results of post-stream actions

clinicalNoteGenerationResult -> (structure)

Results of clinical note generation

noteResult -> (structure)

Details about the generated clinical note

outputLocation -> (string)

status -> (string)

The generation status of the artifact

failureReason -> (string)

The reason for failure if the artifact generation failed

transcriptResult -> (structure)

Details about the generated transcript

outputLocation -> (string)

status -> (string)

The generation status of the artifact

failureReason -> (string)

The reason for failure if the artifact generation failed

afterVisitSummaryResult -> (structure)

Details about the generated after visit summary

outputLocation -> (string)

status -> (string)

The generation status of the artifact

failureReason -> (string)

The reason for failure if the artifact generation failed

encounterContextProvided -> (boolean)

Indicates whether encounter context was provided

streamStatus -> (string)

The current status of the stream

streamCreationTime -> (timestamp)

The timestamp when the stream was created

streamEndTime -> (timestamp)

The timestamp when the stream ended