Update Portal

apigatewayv2_update_portal

R Documentation

Updates a portal

Description

Updates a portal.

Usage

apigatewayv2_update_portal(Authorization, EndpointConfiguration,
  IncludedPortalProductArns, LogoUri, PortalContent, PortalId,
  RumAppMonitorName)

Arguments

Authorization	The authorization of the portal.
EndpointConfiguration	Represents an endpoint configuration.
IncludedPortalProductArns	The ARNs of the portal products included in the portal.
LogoUri	The logo URI.
PortalContent	Contains the content that is visible to portal consumers including the themes, display names, and description.
PortalId	[required] The portal identifier.
RumAppMonitorName	The CloudWatch RUM app monitor name.

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$update_portal(
  Authorization = list(
    CognitoConfig = list(
      AppClientId = "string",
      UserPoolArn = "string",
      UserPoolDomain = "string"
    ),
    None = list()
  ),
  EndpointConfiguration = list(
    AcmManaged = list(
      CertificateArn = "string",
      DomainName = "string"
    ),
    None = list()
  ),
  IncludedPortalProductArns = list(
    "string"
  ),
  LogoUri = "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",
  RumAppMonitorName = "string"
)