[ aws . nimble ]

get-streaming-session-stream

Description

Gets a StreamingSessionStream for a streaming session.

Invoke this operation to poll the resource after invoking CreateStreamingSessionStream.

After the StreamingSessionStream changes to the state READY, the url property will contain a stream to be used with the DCV streaming client.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-streaming-session-stream
--session-id <value>
--stream-id <value>
--studio-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--session-id (string)

The streaming session ID.

--stream-id (string)

The streaming session stream ID.

--studio-id (string)

The studio ID.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

stream -> (structure)

The stream.

createdAt -> (timestamp)

The Unix epoch timestamp in seconds for when the resource was created.

createdBy -> (string)

The user ID of the user that created the streaming session stream.

expiresAt -> (timestamp)

The Unix epoch timestamp in seconds for when the resource expires.

ownedBy -> (string)

The user ID of the user that owns the streaming session. The user that owns the session will be logging into the session and interacting with the virtual workstation.

state -> (string)

The current state.

statusCode -> (string)

The streaming session stream status code.

streamId -> (string)

The stream ID.

url -> (string)

The URL to connect to this stream using the DCV client.