AWS CLI Command Reference

[ aws . nimble ]

stop-streaming-session

Description

Transitions sessions from the READY state into the STOPPED state. The STOP_IN_PROGRESS state is the intermediate state between the READY and STOPPED states.

See also: AWS API Documentation

Synopsis

  stop-streaming-session
[--client-token <value>]
--session-id <value>
--studio-id <value>
[--volume-retention-mode <value>]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

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 Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

--session-id (string)

The streaming session ID for the StopStreamingSessionRequest .

--studio-id (string)

The studioId for the StopStreamingSessionRequest.

--volume-retention-mode (string)

Adds additional instructions to a streaming session stop action to either retain the EBS volumes or delete the EBS volumes.

Possible values:

  • RETAIN
  • DELETE

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

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
  • yaml
  • yaml-stream

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

session -> (structure)

A streaming session is a virtual workstation created using a particular launch profile.

arn -> (string)

The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

automaticTerminationMode -> (string)

Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in a STOPPED state.

  • When ACTIVATED , the streaming session is scheduled for termination after being in the STOPPED state for the time specified in maxStoppedSessionLengthInMinutes .
  • When DEACTIVATED , the streaming session can remain in the STOPPED state indefinitely.

This parameter is only allowed when sessionPersistenceMode is ACTIVATED . When allowed, the default value for this parameter is DEACTIVATED .

backupMode -> (string)

Shows the current backup setting of the session.

createdAt -> (timestamp)

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

maxBackupsToRetain -> (integer)

The maximum number of backups of a streaming session that you can have. When the maximum number of backups is reached, the oldest backup is deleted.

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.

sessionPersistenceMode -> (string)

Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration and automaticTerminationMode are configured.

startedAt -> (timestamp)

The time the session entered START_IN_PROGRESS state.

startedBy -> (string)

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

startedFromBackupId -> (string)

The backup ID used to restore a 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 ISO timestamp in seconds for when the resource was updated.

updatedBy -> (string)

The user ID of the user that most recently updated the resource.

volumeConfiguration -> (structure)

Custom volume configuration for the root volumes that are attached to streaming sessions.

This parameter is only allowed when sessionPersistenceMode is ACTIVATED .

iops -> (integer)

The number of I/O operations per second for the root volume that is attached to streaming session.

size -> (integer)

The size of the root volume that is attached to the streaming session. The root volume size is measured in GiBs.

throughput -> (integer)

The throughput to provision for the root volume that is attached to the streaming session. The throughput is measured in MiB/s.

volumeRetentionMode -> (string)

Determine if an EBS volume created from this streaming session will be backed up.
© Copyright 2018, Amazon Web Services. Created using Sphinx.