URI HTTP methods Schemas Properties See also

Portal products

Represents the collection of portal products.

URI

/v2/portalproducts

HTTP methods

GET

Operation ID: ListPortalProducts

Lists portal products.

Query parameters
Name	Type	Required	Description
`resourceOwner`	String	False	The resource owner of the portal product.
`nextToken`	String	False	The next page of elements from this collection. Not valid for the last element of the collection.
`maxResults`	String	False	The maximum number of elements to be returned for this resource.

Responses
Status code	Response model	Description
`200`	`ListPortalProductsResponseContent`	Success
`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.

POST

Operation ID: CreatePortalProduct

Creates a new portal product.

Responses
Status code	Response model	Description
`201`	`CreatePortalProductResponseContent`	The request has succeeded and has resulted in the creation of a resource.
`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.

Schemas

Request bodies


{
  "displayName": "string",
  "description": "string",
  "tags": {
  }
}

Response bodies


{
  "nextToken": "string",
  "items": [
    {
      "displayName": "string",
      "description": "string",
      "portalProductId": "string",
      "portalProductArn": "string",
      "lastModified": "string",
      "tags": {
      }
    }
  ]
}


{
  "displayName": "string",
  "displayOrder": {
    "productPageArns": [
      "string"
    ],
    "contents": [
      {
        "sectionName": "string",
        "productRestEndpointPageArns": [
          "string"
        ]
      }
    ],
    "overviewPageArn": "string"
  },
  "description": "string",
  "portalProductId": "string",
  "portalProductArn": "string",
  "lastModified": "string",
  "tags": {
  }
}


{
  "message": "string"
}


{
  "message": "string"
}


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

Properties

AccessDeniedExceptionResponseContent

The error message.

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

BadRequestExceptionResponseContent

The response content for bad request exception.

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

CreatePortalProductRequestContent

Creates a portal product.

Property Type Required Description

description

string

MinLength: 0

MaxLength: 1024

False

A description of the portal product.

displayName

string

MinLength: 1

MaxLength: 255

True

The name of the portal product as it appears in a published portal.

tags

CreatePortalProductResponseContent

Creates a portal product.

Property	Type	Required	Description
`description`	string MinLength: 0 MaxLength: 1024	False	A description of the portal product.
`displayName`	string MinLength: 1 MaxLength: 255	True	The display name for the portal product.
`displayOrder`	DisplayOrder	False	The visual ordering of the product pages and product REST endpoint pages in a published portal.
`lastModified`	string Format: date-time	True	The timestamp when the portal product was last modified.
`portalProductArn`	string MinLength: 20 MaxLength: 2048	True	The ARN of the portal product.
`portalProductId`	string Pattern: `^[a-z0-9]+$` MinLength: 10 MaxLength: 30	True	The portal product identifier.
`tags`	Tags	False	The collection of tags. Each tag element is associated with a given resource.

DisplayOrder

The display order.

Property Type Required Description

Property	Type	Required	Description
`contents`	Array of type Section	False	Represents a list of sections which include section name and list of product REST endpoints for a product.
`overviewPageArn`	string MinLength: 20 MaxLength: 2048	False	The ARN of the overview page.
`productPageArns`	Array of type string MinLength: 20 MaxLength: 2048	False	The product page ARNs.

contents

Array of type Section

False

Represents a list of sections which include section name and list of product REST endpoints for a product.

overviewPageArn

string

MinLength: 20

MaxLength: 2048

False

The ARN of the overview page.

productPageArns

Array of type string

MinLength: 20

MaxLength: 2048

False

The product page ARNs.

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.

ListPortalProductsResponseContent

Lists portal products.

Property Type Required Description

Property	Type	Required	Description
`items`	Array of type PortalProductSummary	False	The elements from this collection.
`nextToken`	string MinLength: 1 MaxLength: 2048	False	The next page of elements from this collection. Not valid for the last element of the collection.

items

Array of type PortalProductSummary

False

The elements from this collection.

nextToken

string

MinLength: 1

MaxLength: 2048

False

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

PortalProductSummary

Represents a portal product.

Property	Type	Required	Description
`description`	string MinLength: 0 MaxLength: 1024	True	The description.
`displayName`	string MinLength: 1 MaxLength: 255	True	The display name of a portal product.
`lastModified`	string Format: date-time	True	The timestamp when the portal product was last modified.
`portalProductArn`	string MinLength: 20 MaxLength: 2048	True	The ARN of a portal product.
`portalProductId`	string Pattern: `^[a-z0-9]+$` MinLength: 10 MaxLength: 30	True	The portal product identifier.
`tags`	Tags	False	The collection of tags. Each tag element is associated with a given resource.

Section

Contains the section name and list of product REST endpoints for a product.

Property Type Required Description

Property	Type	Required	Description
`productRestEndpointPageArns`	Array of type string MinLength: 20 MaxLength: 2048	True	The ARNs of the product REST endpoint pages in a portal product.
`sectionName`	string	True	The section name.

productRestEndpointPageArns

Array of type string

MinLength: 20

MaxLength: 2048

True

The ARNs of the product REST endpoint pages in a portal product.

sectionName

string

True

The section name.

Portal products

URI

HTTP methods

GET

POST

Schemas

Request bodies

Response bodies

Properties

AccessDeniedExceptionResponseContent

BadRequestExceptionResponseContent

CreatePortalProductRequestContent

CreatePortalProductResponseContent

DisplayOrder

LimitExceededExceptionResponseContent

ListPortalProductsResponseContent

PortalProductSummary

Section

Tags

See also

ListPortalProducts

CreatePortalProduct