Skip to content

List Portals

apigatewayv2_list_portals R Documentation

Lists portals

Description

Lists portals.

Usage

apigatewayv2_list_portals(MaxResults, NextToken)

Arguments

MaxResults

The maximum number of elements to be returned for this resource.

NextToken

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

Value

A list with the following syntax:

list(
  Items = list(
    list(
      Authorization = list(
        CognitoConfig = list(
          AppClientId = "string",
          UserPoolArn = "string",
          UserPoolDomain = "string"
        ),
        None = list()
      ),
      EndpointConfiguration = list(
        CertificateArn = "string",
        DomainName = "string",
        PortalDefaultDomainName = "string",
        PortalDomainHostedZoneId = "string"
      ),
      IncludedPortalProductArns = list(
        "string"
      ),
      LastModified = as.POSIXct(
        "2015-01-01"
      ),
      LastPublished = as.POSIXct(
        "2015-01-01"
      ),
      LastPublishedDescription = "string",
      PortalArn = "string",
      PortalContent = list(
        Description = "string",
        DisplayName = "string",
        Theme = list(
          CustomColors = list(
            AccentColor = "string",
            BackgroundColor = "string",
            ErrorValidationColor = "string",
            HeaderColor = "string",
            NavigationColor = "string",
            TextColor = "string"
          ),
          LogoLastUploaded = as.POSIXct(
            "2015-01-01"
          )
        )
      ),
      PortalId = "string",
      Preview = list(
        PreviewStatus = "PREVIEW_IN_PROGRESS"|"PREVIEW_FAILED"|"PREVIEW_READY",
        PreviewUrl = "string",
        StatusException = list(
          Exception = "string",
          Message = "string"
        )
      ),
      PublishStatus = "PUBLISHED"|"PUBLISH_IN_PROGRESS"|"PUBLISH_FAILED"|"DISABLE_IN_PROGRESS"|"DISABLE_FAILED"|"DISABLED",
      RumAppMonitorName = "string",
      StatusException = list(
        Exception = "string",
        Message = "string"
      ),
      Tags = list(
        "string"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_portals(
  MaxResults = "string",
  NextToken = "string"
)