[ aws . iottwinmaker ]

list-workspaces

Description

Retrieves information about workspaces in the current account.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-workspaces
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--max-results (integer)

The maximum number of results to display.

--next-token (string)

The string that specifies the next page of results.

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

nextToken -> (string)

The string that specifies the next page of results.

workspaceSummaries -> (list)

A list of objects that contain information about the workspaces.

(structure)

An object that contains information about a workspace.

arn -> (string)

The ARN of the workspace.

creationDateTime -> (timestamp)

The date and time when the workspace was created.

description -> (string)

The description of the workspace.

updateDateTime -> (timestamp)

The date and time when the workspace was last updated.

workspaceId -> (string)

The ID of the workspace.