Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . nimble ]

create-streaming-session

Description

Creates a streaming session in a studio.

After invoking this operation, you must poll GetStreamingSession until the streaming session is in state READY.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-streaming-session
[--client-token <value>]
[--ec2-instance-type <value>]
[--launch-profile-id <value>]
[--owned-by <value>]
[--streaming-image-id <value>]
--studio-id <value>
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--client-token (string)

To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error.

--ec2-instance-type (string)

The EC2 Instance type used for the streaming session.

Possible values:

  • g4dn.xlarge
  • g4dn.2xlarge
  • g4dn.4xlarge
  • g4dn.8xlarge
  • g4dn.12xlarge
  • g4dn.16xlarge

--launch-profile-id (string)

The launch profile ID.

--owned-by (string)

The user ID of the user that owns the streaming session.

--streaming-image-id (string)

The ID of the streaming image.

--studio-id (string)

The studio ID.

--tags (map)

A collection of labels, in the form of key:value pairs, that apply to this resource.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--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.

See 'aws help' for descriptions of global parameters.

Output

session -> (structure)

The session.

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.

sessionId -> (string)

The session ID.

state -> (string)

The current state.

statusCode -> (string)

The status code.

statusMessage -> (string)

The status message for 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.