update-portal¶

Description¶

Updates a portal.

Synopsis¶

  update-portal
[--authorization <value>]
[--endpoint-configuration <value>]
[--included-portal-product-arns <value>]
[--logo-uri <value>]
[--portal-content <value>]
--portal-id <value>
[--rum-app-monitor-name <value>]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options¶

--authorization (structure)

The authorization of the portal.

CognitoConfig -> (structure)

The Amazon Cognito configuration.

AppClientId -> (string) [required]

The app client ID.

Constraints:

min: 1

max: 256

UserPoolArn -> (string) [required]

The user pool ARN.

Constraints:

min: 20

max: 2048

UserPoolDomain -> (string) [required]

The user pool domain.

Constraints:

min: 20

max: 2048

None -> (structure)

Provide no authorization for your portal. This makes your portal publicly accesible on the web.

Shorthand Syntax:

CognitoConfig={AppClientId=string,UserPoolArn=string,UserPoolDomain=string},None={}

JSON Syntax:

{
  "CognitoConfig": {
    "AppClientId": "string",
    "UserPoolArn": "string",
    "UserPoolDomain": "string"
  },
  "None": {

  }
}

--endpoint-configuration (structure)

Represents an endpoint configuration.

AcmManaged -> (structure)

Represents a domain name and certificate for a portal.

CertificateArn -> (string) [required]

The certificate ARN.

Constraints:

min: 10

max: 2048

DomainName -> (string) [required]

The domain name.

Constraints:

min: 3

max: 256

None -> (structure)

Use the default portal domain name that is generated and managed by API Gateway.

Shorthand Syntax:

AcmManaged={CertificateArn=string,DomainName=string},None={}

JSON Syntax:

{
  "AcmManaged": {
    "CertificateArn": "string",
    "DomainName": "string"
  },
  "None": {

  }
}

--included-portal-product-arns (list)

The ARNs of the portal products included in the portal.

(string)

Constraints:

min: 20

max: 2048

Syntax:

"string" "string" ...

--logo-uri (string)

The logo URI.

Constraints:

min: 0

max: 1092

--portal-content (structure)

Contains the content that is visible to portal consumers including the themes, display names, and description.

Description -> (string)

A description of the portal.

Constraints:

min: 0

max: 1024

DisplayName -> (string) [required]

The display name for the portal.

Constraints:

min: 3

max: 255

Theme -> (structure) [required]

The theme for the portal.

CustomColors -> (structure) [required]

Defines custom color values.

AccentColor -> (string) [required]

Represents the accent color.

Constraints:

min: 1

max: 16

BackgroundColor -> (string) [required]

Represents the background color.

Constraints:

min: 1

max: 16

ErrorValidationColor -> (string) [required]

The errorValidationColor.

Constraints:

min: 1

max: 16

HeaderColor -> (string) [required]

Represents the header color.

Constraints:

min: 1

max: 16

NavigationColor -> (string) [required]

Represents the navigation color.

Constraints:

min: 1

max: 16

TextColor -> (string) [required]

Represents the text color.

Constraints:

min: 1

max: 16

LogoLastUploaded -> (timestamp)

The timestamp when the logo was last uploaded.

Shorthand Syntax:

Description=string,DisplayName=string,Theme={CustomColors={AccentColor=string,BackgroundColor=string,ErrorValidationColor=string,HeaderColor=string,NavigationColor=string,TextColor=string},LogoLastUploaded=timestamp}

JSON Syntax:

{
  "Description": "string",
  "DisplayName": "string",
  "Theme": {
    "CustomColors": {
      "AccentColor": "string",
      "BackgroundColor": "string",
      "ErrorValidationColor": "string",
      "HeaderColor": "string",
      "NavigationColor": "string",
      "TextColor": "string"
    },
    "LogoLastUploaded": timestamp
  }
}

--portal-id (string) [required]

The portal identifier.

--rum-app-monitor-name (string)

The CloudWatch RUM app monitor name.

Constraints:

min: 0

max: 255

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

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

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output¶

Authorization -> (structure)

The authorization for the portal.

CognitoConfig -> (structure)

The Amazon Cognito configuration.

AppClientId -> (string) [required]

The app client ID.

Constraints:

min: 1

max: 256

UserPoolArn -> (string) [required]

The user pool ARN.

Constraints:

min: 20

max: 2048

UserPoolDomain -> (string) [required]

The user pool domain.

Constraints:

min: 20

max: 2048

None -> (structure)

Provide no authorization for your portal. This makes your portal publicly accesible on the web.

EndpointConfiguration -> (structure)

The endpoint configuration.

CertificateArn -> (string)

The ARN of the ACM certificate.

Constraints:

min: 10

max: 2048

DomainName -> (string)

The domain name.

Constraints:

min: 3

max: 256

PortalDefaultDomainName -> (string) [required]

The portal default domain name. This domain name is generated and managed by API Gateway.

Constraints:

min: 3

max: 256

PortalDomainHostedZoneId -> (string) [required]

The portal domain hosted zone identifier.

Constraints:

min: 1

max: 64

IncludedPortalProductArns -> (list)

The ARNs of the portal products included in the portal.

(string)

Constraints:

min: 20

max: 2048

LastModified -> (timestamp)

The timestamp when the portal was last modified.

LastPublished -> (timestamp)

The timestamp when the portal was last published.

LastPublishedDescription -> (string)

The description associated with the last time the portal was published.

Constraints:

min: 0

max: 1024

PortalArn -> (string)

The ARN of the portal.

Constraints:

min: 20

max: 2048

PortalContent -> (structure)

Contains the content that is visible to portal consumers including the themes, display names, and description.

Description -> (string)

A description of the portal.

Constraints:

min: 0

max: 1024

DisplayName -> (string) [required]

The display name for the portal.

Constraints:

min: 3

max: 255

Theme -> (structure) [required]

The theme for the portal.

CustomColors -> (structure) [required]

Defines custom color values.

AccentColor -> (string) [required]

Represents the accent color.

Constraints:

min: 1

max: 16

BackgroundColor -> (string) [required]

Represents the background color.

Constraints:

min: 1

max: 16

ErrorValidationColor -> (string) [required]

The errorValidationColor.

Constraints:

min: 1

max: 16

HeaderColor -> (string) [required]

Represents the header color.

Constraints:

min: 1

max: 16

NavigationColor -> (string) [required]

Represents the navigation color.

Constraints:

min: 1

max: 16

TextColor -> (string) [required]

Represents the text color.

Constraints:

min: 1

max: 16

LogoLastUploaded -> (timestamp)

The timestamp when the logo was last uploaded.

PortalId -> (string)

The portal identifier.

Constraints:

min: 10

max: 30

pattern: ^[a-z0-9]+$

Preview -> (structure)

Represents the preview endpoint and the any possible error messages during preview generation.

PreviewStatus -> (string) [required]

The status of the preview.

Possible values:

PREVIEW_IN_PROGRESS

PREVIEW_FAILED

PREVIEW_READY

PreviewUrl -> (string)

The URL of the preview.

StatusException -> (structure)

The status exception information.

Exception -> (string)

The exception.

Constraints:

min: 1

max: 256

Message -> (string)

The error message.

Constraints:

min: 1

max: 2048

PublishStatus -> (string)

The publishStatus.

Possible values:

PUBLISHED

PUBLISH_IN_PROGRESS

PUBLISH_FAILED

DISABLED

RumAppMonitorName -> (string)

The CloudWatch RUM app monitor name.

Constraints:

min: 0

max: 255

StatusException -> (structure)

The status exception information.

Exception -> (string)

The exception.

Constraints:

min: 1

max: 256

Message -> (string)

The error message.

Constraints:

min: 1

max: 2048

Tags -> (map)

The collection of tags. Each tag element is associated with a given resource.

key -> (string)

value -> (string)

A string with a length between [0-1600].

Table of Contents

Feedback

User Guide

update-portal¶

Description¶

Synopsis¶

Options¶

Global Options¶

Output¶