start-streaming-session¶
Description¶
Transitions sessions from the STOPPED state into the READY state. The START_IN_PROGRESS state is the intermediate state between the STOPPED and READY states.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
start-streaming-session
[--client-token <value>]
--session-id <value>
--studio-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--client-token (string)
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.
--session-id (string)
The streaming session ID for the StartStreamingSessionRequest.
--studio-id (string)
The studio ID for the StartStreamingSessionRequest.
--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¶
session -> (structure)
A streaming session is a virtual workstation created using a particular launch profile.
arn -> (string)
The ARN of the resource.
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.
ec2InstanceType -> (string)
The EC2 Instance type used for the streaming session.
launchProfileId -> (string)
The ID of the launch profile used to control access from the streaming session.
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.
sessionId -> (string)
The session ID.
startedAt -> (timestamp)
The time the session entered START_IN_PROGRESS state.
startedBy -> (string)
The user ID of the user that started the streaming session.
state -> (string)
The current state.
statusCode -> (string)
The status code.
statusMessage -> (string)
The status message for the streaming session.
stopAt -> (timestamp)
The time the streaming session will automatically be stopped if the user doesn’t stop the session themselves.
stoppedAt -> (timestamp)
The time the session entered STOP_IN_PROGRESS state.
stoppedBy -> (string)
The user ID of the user that stopped the streaming session.
streamingImageId -> (string)
The ID of the streaming image.
tags -> (map)
A collection of labels, in the form of key:value pairs, that apply to this resource.
key -> (string)
value -> (string)
terminateAt -> (timestamp)
The time the streaming session will automatically terminate if not terminated by the user.
updatedAt -> (timestamp)
The Unix epoch timestamp in seconds for when the resource was updated.
updatedBy -> (string)
The user ID of the user that most recently updated the resource.