Table Of Contents

Feedback

User Guide

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

[ aws . workspaces ]

describe-workspaces-connection-status

Description

Describes the connection status of the specified WorkSpaces.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-workspaces-connection-status
[--workspace-ids <value>]
[--next-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--workspace-ids (list)

The identifiers of the WorkSpaces. You can specify up to 25 WorkSpaces.

Syntax:

"string" "string" ...

--next-token (string)

The token for the next set of results. (You received this token from a previous call.)

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

WorkspacesConnectionStatus -> (list)

Information about the connection status of the WorkSpace.

(structure)

Describes the connection status of a WorkSpace.

WorkspaceId -> (string)

The ID of the WorkSpace.

ConnectionState -> (string)

The connection state of the WorkSpace. The connection state is unknown if the WorkSpace is stopped.

ConnectionStateCheckTimestamp -> (timestamp)

The timestamp of the connection state check.

LastKnownUserConnectionTimestamp -> (timestamp)

The timestamp of the last known user connection.

NextToken -> (string)

The token to use to retrieve the next set of results, or null if there are no more results available.