AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . workspaces-web ]

list-portals

Description

Retrieves a list or web portals.

See also: AWS API Documentation

Synopsis

  list-portals
[--max-results <value>]
[--next-token <value>]
[--cli-input-json <value>]
[--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>]

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

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

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

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.

authenticationType -> (string)

The type of authentication integration points used when signing into the web portal. Defaults to Standard .

Standard web portals are authenticated directly through your identity provider. You need to call CreateIdentityProvider to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.

IAM Identity Center web portals are authenticated through IAM Identity Center. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.

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.

dataProtectionSettingsArn -> (string)

The ARN of the data protection settings.

displayName -> (string)

The name of the web portal.

instanceType -> (string)

The type and resources of the underlying instance.

ipAccessSettingsArn -> (string)

The ARN of the IP access settings.

maxConcurrentSessions -> (integer)

The maximum number of concurrent sessions for the 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.

userAccessLoggingSettingsArn -> (string)

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

userSettingsArn -> (string)

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