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

describe-workspaces-connection-status is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: WorkspacesConnectionStatus

Synopsis

  describe-workspaces-connection-status
[--workspace-ids <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--workspace-ids (list)

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

(string)

Syntax:

"string" "string" ...

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

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

WorkspacesConnectionStatus -> (list)

Information about the connection status of the WorkSpace.

(structure)

Describes the connection status of a WorkSpace.

WorkspaceId -> (string)

The identifier 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 status check.

LastKnownUserConnectionTimestamp -> (timestamp)

The timestamp of the last known user connection.

NextToken -> (string)

The token to use to retrieve the next page of results. This value is null when there are no more results to return.