[ aws . workspaces-web ]

list-portals

Description

Retrieves a list or web portals.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-portals
[--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 be included in the next page.

--next-token (string)

The pagination token used to retrieve the next page of results for this operation.

--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 pagination token used to retrieve the next page of results for this operation.

portals -> (list)

The portals in the list.

(structure)

The summary of the portal.

browserSettingsArn -> (string)

The ARN of the browser settings that is associated with the web portal.

browserType -> (string)

The browser type of the web portal.

creationDate -> (timestamp)

The creation date of the web portal.

displayName -> (string)

The name of the web portal.

networkSettingsArn -> (string)

The ARN of the network settings that is associated with the web portal.

portalArn -> (string)

The ARN of the web portal.

portalEndpoint -> (string)

The endpoint URL of the web portal that users access in order to start streaming sessions.

portalStatus -> (string)

The status of the web portal.

rendererType -> (string)

The renderer that is used in streaming sessions.

trustStoreArn -> (string)

The ARN of the trust that is associated with this web portal.

userSettingsArn -> (string)

The ARN of the user settings that is associated with the web portal.