URI HTTP methods Schemas Properties See also

Portal

Represents a portal.

URI

/v2/portals/portalId

HTTP methods

GET

Operation ID: GetPortal

Gets a portal.

Path parameters
Name	Type	Required	Description
`portalId`	String	True	The portal identifier.

Responses
Status code	Response model	Description
`200`	`GetPortalResponseContent`	Success
`400`	`BadRequestExceptionResponseContent`	One of the parameters in the request is invalid.
`403`	`AccessDeniedExceptionResponseContent`	403 response
`404`	`NotFoundExceptionResponseContent`	The resource specified in the request was not found.
`429`	`LimitExceededExceptionResponseContent`	The client is sending more than the allowed number of requests per unit of time.

DELETE

Operation ID: DeletePortal

Deletes a portal.

Path parameters
Name	Type	Required	Description
`portalId`	String	True	The portal identifier.

Responses
Status code	Response model	Description
`204`	None	The request has succeeded, and there is no additional content to send in the response payload body.
`400`	`BadRequestExceptionResponseContent`	One of the parameters in the request is invalid.
`403`	`AccessDeniedExceptionResponseContent`	403 response
`429`	`LimitExceededExceptionResponseContent`	The client is sending more than the allowed number of requests per unit of time.

PATCH

Operation ID: UpdatePortal

Updates a portal.

Path parameters
Name	Type	Required	Description
`portalId`	String	True	The portal identifier.

Responses
Status code	Response model	Description
`200`	`UpdatePortalResponseContent`	200 response
`400`	`BadRequestExceptionResponseContent`	One of the parameters in the request is invalid.
`403`	`AccessDeniedExceptionResponseContent`	403 response
`404`	`NotFoundExceptionResponseContent`	The resource specified in the request was not found.
`409`	`ConflictExceptionResponseContent`	The resource already exists.
`429`	`LimitExceededExceptionResponseContent`	The client is sending more than the allowed number of requests per unit of time.

Schemas

Request bodies


{
  "authorization": {
    "cognitoConfig": {
      "userPoolArn": "string",
      "userPoolDomain": "string",
      "appClientId": "string"
    },
    "none": {
    }
  },
  "portalContent": {
    "displayName": "string",
    "description": "string",
    "theme": {
      "logoLastUploaded": "string",
      "customColors": {
        "errorValidationColor": "string",
        "headerColor": "string",
        "backgroundColor": "string",
        "accentColor": "string",
        "navigationColor": "string",
        "textColor": "string"
      }
    }
  },
  "endpointConfiguration": {
    "acmManaged": {
      "certificateArn": "string",
      "domainName": "string"
    },
    "none": {
    }
  },
  "logoUri": "string",
  "includedPortalProductArns": [
    "string"
  ],
  "rumAppMonitorName": "string"
}

Response bodies


{
  "preview": {
    "previewUrl": "string",
    "statusException": {
      "exception": "string",
      "message": "string"
    },
    "previewStatus": enum
  },
  "statusException": {
    "exception": "string",
    "message": "string"
  },
  "portalArn": "string",
  "lastPublished": "string",
  "rumAppMonitorName": "string",
  "tags": {
  },
  "authorization": {
    "cognitoConfig": {
      "userPoolArn": "string",
      "userPoolDomain": "string",
      "appClientId": "string"
    },
    "none": {
    }
  },
  "portalId": "string",
  "endpointConfiguration": {
    "certificateArn": "string",
    "domainName": "string",
    "portalDefaultDomainName": "string",
    "portalDomainHostedZoneId": "string"
  },
  "portalContent": {
    "displayName": "string",
    "description": "string",
    "theme": {
      "logoLastUploaded": "string",
      "customColors": {
        "errorValidationColor": "string",
        "headerColor": "string",
        "backgroundColor": "string",
        "accentColor": "string",
        "navigationColor": "string",
        "textColor": "string"
      }
    }
  },
  "lastPublishedDescription": "string",
  "lastModified": "string",
  "includedPortalProductArns": [
    "string"
  ],
  "publishStatus": enum
}


{
  "preview": {
    "previewUrl": "string",
    "statusException": {
      "exception": "string",
      "message": "string"
    },
    "previewStatus": enum
  },
  "statusException": {
    "exception": "string",
    "message": "string"
  },
  "portalArn": "string",
  "lastPublished": "string",
  "rumAppMonitorName": "string",
  "tags": {
  },
  "authorization": {
    "cognitoConfig": {
      "userPoolArn": "string",
      "userPoolDomain": "string",
      "appClientId": "string"
    },
    "none": {
    }
  },
  "portalId": "string",
  "endpointConfiguration": {
    "certificateArn": "string",
    "domainName": "string",
    "portalDefaultDomainName": "string",
    "portalDomainHostedZoneId": "string"
  },
  "portalContent": {
    "displayName": "string",
    "description": "string",
    "theme": {
      "logoLastUploaded": "string",
      "customColors": {
        "errorValidationColor": "string",
        "headerColor": "string",
        "backgroundColor": "string",
        "accentColor": "string",
        "navigationColor": "string",
        "textColor": "string"
      }
    }
  },
  "lastPublishedDescription": "string",
  "lastModified": "string",
  "includedPortalProductArns": [
    "string"
  ],
  "publishStatus": enum
}


{
  "message": "string"
}


{
  "message": "string"
}


{
  "message": "string",
  "resourceType": "string"
}


{
  "message": "string"
}


{
  "message": "string",
  "limitType": "string"
}

Properties

ACMManaged

Represents a domain name and certificate for a portal.

Property Type Required Description

Property	Type	Required	Description
`certificateArn`	string MinLength: 10 MaxLength: 2048	True	The certificate ARN.
`domainName`	string MinLength: 3 MaxLength: 256	True	The domain name.

certificateArn

string

MinLength: 10

MaxLength: 2048

True

The certificate ARN.

domainName

string

MinLength: 3

MaxLength: 256

True

The domain name.

AccessDeniedExceptionResponseContent

The error message.

Property	Type	Required	Description
`message`	string	False	The message.

Authorization

Represents an authorization configuration for a portal.

Property	Type	Required	Description
`cognitoConfig`	CognitoConfig	False	The Amazon Cognito configuration.
`none`	None	False	Provide no authorization for your portal. This makes your portal publicly accesible on the web.

BadRequestExceptionResponseContent

The response content for bad request exception.

Property	Type	Required	Description
`message`	string	False	The message of the bad request exception response content.

CognitoConfig

The configuration for using Amazon Cognito user pools to control access to your portal.

Property Type Required Description

Property	Type	Required	Description
`appClientId`	string MinLength: 1 MaxLength: 256	True	The app client ID.
`userPoolArn`	string MinLength: 20 MaxLength: 2048	True	The user pool ARN.
`userPoolDomain`	string MinLength: 20 MaxLength: 2048	True	The user pool domain.

appClientId

string

MinLength: 1

MaxLength: 256

True

The app client ID.

userPoolArn

string

MinLength: 20

MaxLength: 2048

True

The user pool ARN.

userPoolDomain

string

MinLength: 20

MaxLength: 2048

True

The user pool domain.

ConflictExceptionResponseContent

The resource identifier.

Property	Type	Required	Description
`message`	string	False	The error message.

CustomColors

Represents custom colors for a published portal.

Property	Type	Required	Description
`accentColor`	string MinLength: 1 MaxLength: 16	True	Represents the accent color.
`backgroundColor`	string MinLength: 1 MaxLength: 16	True	Represents the background color.
`errorValidationColor`	string MinLength: 1 MaxLength: 16	True	The errorValidationColor.
`headerColor`	string MinLength: 1 MaxLength: 16	True	Represents the header color.
`navigationColor`	string MinLength: 1 MaxLength: 16	True	Represents the navigation color.
`textColor`	string MinLength: 1 MaxLength: 16	True	Represents the text color.

EndpointConfigurationRequest

Represents an endpoint configuration.

Property	Type	Required	Description
`acmManaged`	ACMManaged	False	Represents a domain name and certificate for a portal.
`none`	None	False	Use the default portal domain name that is generated and managed by API Gateway.

EndpointConfigurationResponse

Represents an endpoint configuration.

Property	Type	Required	Description
`certificateArn`	string MinLength: 10 MaxLength: 2048	False	The ARN of the ACM certificate.
`domainName`	string MinLength: 3 MaxLength: 256	False	The domain name.
`portalDefaultDomainName`	string MinLength: 3 MaxLength: 256	True	The portal default domain name. This domain name is generated and managed by API Gateway.
`portalDomainHostedZoneId`	string MinLength: 1 MaxLength: 64	True	The portal domain hosted zone identifier.

GetPortalResponseContent

Gets a portal.

Property	Type	Required	Description
`authorization`	Authorization	True	The authorization for the portal.
`endpointConfiguration`	EndpointConfigurationResponse	True	The endpoint configuration.
`includedPortalProductArns`	Array of type string MinLength: 20 MaxLength: 2048	True	The ARNs of the portal products included in the portal.
`lastModified`	string Format: date-time	True	The timestamp when the portal was last modified.
`lastPublished`	string Format: date-time	False	The timestamp when the portal was last published.
`lastPublishedDescription`	string MinLength: 0 MaxLength: 1024	False	The publish description used when the portal was last published.
`portalArn`	string MinLength: 20 MaxLength: 2048	True	The ARN of the portal.
`portalContent`	PortalContent	True	Contains the content that is visible to portal consumers including the themes, display names, and description.
`portalId`	string Pattern: `^[a-z0-9]+$` MinLength: 10 MaxLength: 30	True	The portal identifier.
`preview`	Preview	False	Represents the preview endpoint and the any possible error messages during preview generation.
`publishStatus`	PublishStatus	False	The publish status of a portal.
`rumAppMonitorName`	string MinLength: 0 MaxLength: 255	False	The CloudWatch RUM app monitor name.
`statusException`	StatusException	False	The status exception information.
`tags`	Tags	False	The collection of tags. Each tag element is associated with a given resource.

LimitExceededExceptionResponseContent

The response content for limit exceeded exception.

Property	Type	Required	Description
`limitType`	string	False	The limit type of the limit exceeded exception response content.
`message`	string	False	The message of the limit exceeded exception response content.

None

The none option.

NotFoundExceptionResponseContent

The response content for not found exception.

Property	Type	Required	Description
`message`	string	False	The message of the not found exception response content.
`resourceType`	string	False	The resource type of the not found exception response content.

PortalContent

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

Property Type Required Description

Property	Type	Required	Description
`description`	string MinLength: 0 MaxLength: 1024	False	A description of the portal.
`displayName`	string MinLength: 3 MaxLength: 255	True	The display name for the portal.
`theme`	PortalTheme	True	The theme for the portal.

description

string

MinLength: 0

MaxLength: 1024

False

A description of the portal.

displayName

string

MinLength: 3

MaxLength: 255

True

The display name for the portal.

theme

PortalTheme

True

The theme for the portal.

PortalTheme

Defines the theme for a portal.

Property Type Required Description

Property	Type	Required	Description
`customColors`	CustomColors	True	Defines custom color values.
`logoLastUploaded`	string Format: date-time	False	The timestamp when the logo was last uploaded.

customColors

CustomColors

True

Defines custom color values.

logoLastUploaded

string

Format: date-time

False

The timestamp when the logo was last uploaded.

Preview

Contains the preview status and preview URL.

Property	Type	Required	Description
`previewStatus`	PreviewStatus	True	The status of the preview.
`previewUrl`	string	False	The URL of the preview.
`statusException`	StatusException	False	The status exception information.

PreviewStatus

Represents the preview status.

PREVIEW_IN_PROGRESS
PREVIEW_FAILED
PREVIEW_READY

PublishStatus

Represents a publish status.

PUBLISHED
PUBLISH_IN_PROGRESS
PUBLISH_FAILED
DISABLED

StatusException

Represents a StatusException.

Property Type Required Description

Property	Type	Required	Description
`exception`	string MinLength: 1 MaxLength: 256	False	The exception.
`message`	string MinLength: 1 MaxLength: 2048	False	The error message.

exception

string

MinLength: 1

MaxLength: 256

False

The exception.

message

string

MinLength: 1

MaxLength: 2048

False

The error message.

Property	Type	Required	Description
`*`	string	False

UpdatePortalRequestContent

Updates a portal.

Property	Type	Required	Description
`authorization`	Authorization	False	The authorization of the portal.
`endpointConfiguration`	EndpointConfigurationRequest	False	Represents an endpoint configuration.
`includedPortalProductArns`	Array of type string MinLength: 20 MaxLength: 2048	False	The ARNs of the portal products included in the portal.
`logoUri`	string MinLength: 0 MaxLength: 1092	False	The logo URI.
`portalContent`	PortalContent	False	Contains the content that is visible to portal consumers including the themes, display names, and description.
`rumAppMonitorName`	string MinLength: 0 MaxLength: 255	False	The CloudWatch RUM app monitor name.

UpdatePortalResponseContent

Updates a portal.

Property	Type	Required	Description
`authorization`	Authorization	True	The authorization for the portal.
`endpointConfiguration`	EndpointConfigurationResponse	True	The endpoint configuration.
`includedPortalProductArns`	Array of type string MinLength: 20 MaxLength: 2048	True	The ARNs of the portal products included in the portal.
`lastModified`	string Format: date-time	True	The timestamp when the portal was last modified.
`lastPublished`	string Format: date-time	False	The timestamp when the portal was last published.
`lastPublishedDescription`	string MinLength: 0 MaxLength: 1024	False	The description associated with the last time the portal was published.
`portalArn`	string MinLength: 20 MaxLength: 2048	True	The ARN of the portal.
`portalContent`	PortalContent	True	Contains the content that is visible to portal consumers including the themes, display names, and description.
`portalId`	string Pattern: `^[a-z0-9]+$` MinLength: 10 MaxLength: 30	True	The portal identifier.
`preview`	Preview	False	Represents the preview endpoint and the any possible error messages during preview generation.
`publishStatus`	PublishStatus	False	The publishStatus.
`rumAppMonitorName`	string MinLength: 0 MaxLength: 255	False	The CloudWatch RUM app monitor name.
`statusException`	StatusException	False	The status exception information.
`tags`	Tags	False	The collection of tags. Each tag element is associated with a given resource.

Portal

URI

HTTP methods

GET

DELETE

PATCH

Schemas

Request bodies

Response bodies

Properties

ACMManaged

AccessDeniedExceptionResponseContent

Authorization

BadRequestExceptionResponseContent

CognitoConfig

ConflictExceptionResponseContent

CustomColors

EndpointConfigurationRequest

EndpointConfigurationResponse

GetPortalResponseContent

LimitExceededExceptionResponseContent

None

NotFoundExceptionResponseContent

PortalContent

PortalTheme

Preview

PreviewStatus

PublishStatus

StatusException

Tags

UpdatePortalRequestContent

UpdatePortalResponseContent

See also

GetPortal

DeletePortal

UpdatePortal