Get Portal

apigatewayv2_get_portal

R Documentation

Gets a portal

Description

Gets a portal.

Usage

apigatewayv2_get_portal(PortalId)

Arguments

PortalId

[required] The portal identifier.

Value

A list with the following syntax:

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

Request syntax

svc$get_portal(
  PortalId = "string"
)