product_pages

Creates, updates, deletes, gets or lists a product_pages resource.

Overview

Name	product_pages
Type	Resource
Id	aws.apigatewayv2.product_pages

Fields

The following fields are returned by SELECT queries:

get_product_page

Name	Datatype	Description
display_content	object	The content of the product page.
last_modified	string (date-time)	The timestamp when the product page was last modified.
product_page_arn	string	The ARN of the product page.
product_page_id	string	The product page identifier. (pattern: <code>^[a-z0-9]+$</code>)

list_product_pages

Name	Datatype	Description
last_modified	string (date-time)	The timestamp when the product page was last modified.
page_title	string	The page title.
product_page_arn	string	The ARN of the product page.
product_page_id	string	The product page identifier. (pattern: <code>^[a-z0-9]+$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_product_page	select	portal_product_id, product_page_id, region	resourceOwnerAccountId	Gets a product page of a portal product.
list_product_pages	select	portal_product_id, region	maxResults, nextToken, resourceOwnerAccountId	Lists the product pages for a portal product.
create_product_page	insert	portal_product_id, region, DisplayContent		Creates a new product page for a portal product.
update_product_page	update	portal_product_id, product_page_id, region		Updates a product page of a portal product.
delete_product_page	delete	portal_product_id, product_page_id, region		Deletes a product page of a portal product.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
portal_product_id	string	The portal product identifier.
product_page_id	string	The portal product identifier.
region	string	AWS region (default: us-east-1)
maxResults	string	The maximum number of elements to be returned for this resource.
nextToken	string	The next page of elements from this collection. Not valid for the last element of the collection.
resourceOwnerAccountId	string	The account ID of the resource owner of the portal product.

SELECT examples

get_product_page

Gets a product page of a portal product.

SELECT
display_content,
last_modified,
product_page_arn,
product_page_id
FROM aws.apigatewayv2.product_pages
WHERE portal_product_id = '{{ portal_product_id }}' -- required
AND product_page_id = '{{ product_page_id }}' -- required
AND region = '{{ region }}' -- required
AND resourceOwnerAccountId = '{{ resourceOwnerAccountId }}'
;

list_product_pages

Lists the product pages for a portal product.

SELECT
last_modified,
page_title,
product_page_arn,
product_page_id
FROM aws.apigatewayv2.product_pages
WHERE portal_product_id = '{{ portal_product_id }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND resourceOwnerAccountId = '{{ resourceOwnerAccountId }}'
;

INSERT examples

create_product_page

Creates a new product page for a portal product.

INSERT INTO aws.apigatewayv2.product_pages (
DisplayContent,
portal_product_id,
region
)
SELECT 
'{{ DisplayContent }}' /* required */,
'{{ portal_product_id }}',
'{{ region }}'
RETURNING
display_content,
last_modified,
product_page_arn,
product_page_id
;

Manifest

# Description fields are for documentation purposes
- name: product_pages
props:
  - name: portal_product_id
    value: "{{ portal_product_id }}"
    description: Required parameter for the product_pages resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the product_pages resource.
  - name: DisplayContent
    description: |
      The content of the product page.
    value:
      Body: "{{ Body }}"
      Title: "{{ Title }}"

UPDATE examples

update_product_page

Updates a product page of a portal product.

UPDATE aws.apigatewayv2.product_pages
SET 
DisplayContent = '{{ DisplayContent }}'
WHERE 
portal_product_id = '{{ portal_product_id }}' --required
AND product_page_id = '{{ product_page_id }}' --required
AND region = '{{ region }}' --required
RETURNING
display_content,
last_modified,
product_page_arn,
product_page_id;

DELETE examples

delete_product_page

Deletes a product page of a portal product.

DELETE FROM aws.apigatewayv2.product_pages
WHERE portal_product_id = '{{ portal_product_id }}' --required
AND product_page_id = '{{ product_page_id }}' --required
AND region = '{{ region }}' --required
;