Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . apigatewayv2 ]

list-portals

Description

Lists portals.

See also: AWS API Documentation

list-portals is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: Items

Synopsis

  list-portals
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <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>]
[--v2-debug]

Options

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (string)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (string)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

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

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

Items -> (list)

The elements from this collection.

(structure)

Represents a portal summary.

Authorization -> (structure)

The authorization of the portal.

CognitoConfig -> (structure)

The Amazon Cognito configuration.

AppClientId -> (string)

The app client ID.

UserPoolArn -> (string)

The user pool ARN.

UserPoolDomain -> (string)

The user pool domain.

None -> (structure)

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

EndpointConfiguration -> (structure)

The endpoint configuration of the portal.

CertificateArn -> (string)

The ARN of the ACM certificate.

DomainName -> (string)

The domain name.

PortalDefaultDomainName -> (string)

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

PortalDomainHostedZoneId -> (string)

The portal domain hosted zone identifier.

IncludedPortalProductArns -> (list)

The ARNs of the portal products included in the portal.

(string)

LastModified -> (timestamp)

The timestamp when the portal was last modified.

LastPublished -> (timestamp)

The timestamp when the portal was last published.

LastPublishedDescription -> (string)

The description of the portal the last time it was published.

PortalArn -> (string)

The ARN of the portal.

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.

DisplayName -> (string)

The display name for the portal.

Theme -> (structure)

The theme for the portal.

CustomColors -> (structure)

Defines custom color values.

AccentColor -> (string)

Represents the accent color.

BackgroundColor -> (string)

Represents the background color.

ErrorValidationColor -> (string)

The errorValidationColor.

HeaderColor -> (string)

Represents the header color.

NavigationColor -> (string)

Represents the navigation color.

TextColor -> (string)

Represents the text color.

LogoLastUploaded -> (timestamp)

The timestamp when the logo was last uploaded.

PortalId -> (string)

The portal identifier.

Preview -> (structure)

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

PreviewStatus -> (string)

The status of the preview.

PreviewUrl -> (string)

The URL of the preview.

StatusException -> (structure)

The status exception information.

Exception -> (string)

The exception.

Message -> (string)

The error message.

PublishStatus -> (string)

The publish status.

RumAppMonitorName -> (string)

The CloudWatch RUM app monitor name.

StatusException -> (structure)

The status exception information.

Exception -> (string)

The exception.

Message -> (string)

The error message.

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

NextToken -> (string)

The next page of elements from this collection. Not valid for the last element of the collection.