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 ]

update-portal

Description

Updates a web portal.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-portal
[--display-name <value>]
--portal-arn <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--display-name (string)

The name of the web portal. This is not visible to users who log into the web portal.

--portal-arn (string)

The ARN of the web portal.

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

portal -> (structure)

The web portal.

browserSettingsArn -> (string)

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

browserType -> (string)

The browser that users see when using a streaming session.

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.

statusReason -> (string)

A message that explains why the web portal is in its current status.

trustStoreArn -> (string)

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

userSettingsArn -> (string)

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