URI HTTP methods Schemas Properties See also

Portal product

Represents a portal product.

URI

/v2/portalproducts/portalProductId

HTTP methods

GET

Operation ID: GetPortalProduct

Gets a portal product.

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

Query parameters
Name	Type	Required	Description
`resourceOwnerAccountId`	String	False	The account ID of the resource owner of the portal product.

Responses
Status code	Response model	Description
`200`	`GetPortalProductResponseContent`	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: DeletePortalProduct

Deletes a portal product.

Path parameters
Name	Type	Required	Description
`portalProductId`	String	True	The portal product 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
`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.

PATCH

Operation ID: UpdatePortalProduct

Updates the portal product.

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

Responses
Status code	Response model	Description
`200`	`UpdatePortalProductResponseContent`	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.
`429`	`LimitExceededExceptionResponseContent`	The client is sending more than the allowed number of requests per unit of time.

Schemas

Request bodies


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

Response bodies


{
  "displayName": "string",
  "displayOrder": {
    "productPageArns": [
      "string"
    ],
    "contents": [
      {
        "sectionName": "string",
        "productRestEndpointPageArns": [
          "string"
        ]
      }
    ],
    "overviewPageArn": "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",
  "resourceType": "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.

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.

GetPortalProductResponseContent

Gets a portal product.

Property	Type	Required	Description
`description`	string MinLength: 0 MaxLength: 1024	True	The description of a portal product.
`displayName`	string MinLength: 1 MaxLength: 255	True	The display name.
`displayOrder`	DisplayOrder	True	The display order.
`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.

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.

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.

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.

Property	Type	Required	Description
`*`	string	False

UpdatePortalProductRequestContent

Updates a portal product.

Property Type Required Description

Property	Type	Required	Description
`description`	string MinLength: 0 MaxLength: 1024	False	The description.
`displayName`	string MinLength: 1 MaxLength: 255	False	The displayName.
`displayOrder`	DisplayOrder	False	The display order.

description

string

MinLength: 0

MaxLength: 1024

False

The description.

displayName

string

MinLength: 1

MaxLength: 255

False

The displayName.

displayOrder

DisplayOrder

False

The display order.

UpdatePortalProductResponseContent

Updates a portal product.

Property	Type	Required	Description
`description`	string MinLength: 0 MaxLength: 1024	False	The description of the portal product.
`displayName`	string MinLength: 1 MaxLength: 255	True	The display name of a portal product.
`displayOrder`	DisplayOrder	False	The display order that the portal products will appear in a 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.

Portal product

URI

HTTP methods

GET

DELETE

PATCH

Schemas

Request bodies

Response bodies

Properties

AccessDeniedExceptionResponseContent

BadRequestExceptionResponseContent

DisplayOrder

GetPortalProductResponseContent

LimitExceededExceptionResponseContent

NotFoundExceptionResponseContent

Section

Tags

UpdatePortalProductRequestContent

UpdatePortalProductResponseContent

See also

GetPortalProduct

DeletePortalProduct

UpdatePortalProduct