product_rest_endpoint_pages

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

Overview

Name	product_rest_endpoint_pages
Type	Resource
Id	aws.apigatewayv2.product_rest_endpoint_pages

Fields

The following fields are returned by SELECT queries:

get_product_rest_endpoint_page

Name	Datatype	Description
display_content	object	The content of the product REST endpoint page.
last_modified	string (date-time)	The timestamp when the product REST endpoint page was last modified.
product_rest_endpoint_page_arn	string	The ARN of the product REST endpoint page.
product_rest_endpoint_page_id	string	The product REST endpoint page identifier. (pattern: <code>^[a-z0-9]+$</code>)
raw_display_content	string	The raw display content of the product REST endpoint page.
rest_endpoint_identifier	object	The REST API endpoint identifier.
status	string	The status of the product REST endpoint page. (AVAILABLE, IN_PROGRESS, FAILED)
status_exception	object	The status exception information.
try_it_state	string	Represents the try it state for a product REST endpoint page. (ENABLED, DISABLED)

list_product_rest_endpoint_pages

Name	Datatype	Description
endpoint	string	The endpoint of the product REST endpoint page.
last_modified	string (date-time)	The timestamp when the product REST endpoint page was last modified.
operation_name	string	The operation name of the product REST endpoint.
product_rest_endpoint_page_arn	string	The ARN of the product REST endpoint page.
product_rest_endpoint_page_id	string	The product REST endpoint page identifier. (pattern: <code>^[a-z0-9]+$</code>)
rest_endpoint_identifier	object	The REST API endpoint identifier.
status	string	The status. (AVAILABLE, IN_PROGRESS, FAILED)
status_exception	object	The status exception information.
try_it_state	string	Represents the try it state for a product REST endpoint page. (ENABLED, DISABLED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_product_rest_endpoint_page	select	portal_product_id, product_rest_endpoint_page_id, region	includeRawDisplayContent, resourceOwnerAccountId	Gets a product REST endpoint page.
list_product_rest_endpoint_pages	select	portal_product_id, region	maxResults, nextToken, resourceOwnerAccountId	Lists the product REST endpoint pages of a portal product.
create_product_rest_endpoint_page	insert	portal_product_id, region, RestEndpointIdentifier		Creates a product REST endpoint page for a portal product.
update_product_rest_endpoint_page	update	portal_product_id, product_rest_endpoint_page_id, region		Updates a product REST endpoint page.
delete_product_rest_endpoint_page	delete	portal_product_id, product_rest_endpoint_page_id, region		Deletes a product REST endpoint page.

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_rest_endpoint_page_id	string	The product REST endpoint identifier.
region	string	AWS region (default: us-east-1)
includeRawDisplayContent	string	The query parameter to include raw display content.
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_rest_endpoint_page

Gets a product REST endpoint page.

SELECT
display_content,
last_modified,
product_rest_endpoint_page_arn,
product_rest_endpoint_page_id,
raw_display_content,
rest_endpoint_identifier,
status,
status_exception,
try_it_state
FROM aws.apigatewayv2.product_rest_endpoint_pages
WHERE portal_product_id = '{{ portal_product_id }}' -- required
AND product_rest_endpoint_page_id = '{{ product_rest_endpoint_page_id }}' -- required
AND region = '{{ region }}' -- required
AND includeRawDisplayContent = '{{ includeRawDisplayContent }}'
AND resourceOwnerAccountId = '{{ resourceOwnerAccountId }}'
;

list_product_rest_endpoint_pages

Lists the product REST endpoint pages of a portal product.

SELECT
endpoint,
last_modified,
operation_name,
product_rest_endpoint_page_arn,
product_rest_endpoint_page_id,
rest_endpoint_identifier,
status,
status_exception,
try_it_state
FROM aws.apigatewayv2.product_rest_endpoint_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_rest_endpoint_page

Creates a product REST endpoint page for a portal product.

INSERT INTO aws.apigatewayv2.product_rest_endpoint_pages (
DisplayContent,
RestEndpointIdentifier,
TryItState,
portal_product_id,
region
)
SELECT 
'{{ DisplayContent }}',
'{{ RestEndpointIdentifier }}' /* required */,
'{{ TryItState }}',
'{{ portal_product_id }}',
'{{ region }}'
RETURNING
display_content,
last_modified,
product_rest_endpoint_page_arn,
product_rest_endpoint_page_id,
rest_endpoint_identifier,
status,
status_exception,
try_it_state
;

Manifest

# Description fields are for documentation purposes
- name: product_rest_endpoint_pages
props:
  - name: portal_product_id
    value: "{{ portal_product_id }}"
    description: Required parameter for the product_rest_endpoint_pages resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the product_rest_endpoint_pages resource.
  - name: DisplayContent
    description: |
      Represents the endpoint display content.
    value:
      None: "{{ None }}"
      Overrides:
        Body: "{{ Body }}"
        Endpoint: "{{ Endpoint }}"
        OperationName: "{{ OperationName }}"
  - name: RestEndpointIdentifier
    description: |
      The REST API endpoint identifier.
    value:
      IdentifierParts:
        Method: "{{ Method }}"
        Path: "{{ Path }}"
        RestApiId: "{{ RestApiId }}"
        Stage: "{{ Stage }}"
  - name: TryItState
    value: "{{ TryItState }}"
    description: |
      Represents the try it state for a product REST endpoint page.
    valid_values: ['ENABLED', 'DISABLED']

UPDATE examples

update_product_rest_endpoint_page

Updates a product REST endpoint page.

UPDATE aws.apigatewayv2.product_rest_endpoint_pages
SET 
DisplayContent = '{{ DisplayContent }}',
TryItState = '{{ TryItState }}'
WHERE 
portal_product_id = '{{ portal_product_id }}' --required
AND product_rest_endpoint_page_id = '{{ product_rest_endpoint_page_id }}' --required
AND region = '{{ region }}' --required
RETURNING
display_content,
last_modified,
product_rest_endpoint_page_arn,
product_rest_endpoint_page_id,
rest_endpoint_identifier,
status,
status_exception,
try_it_state;

DELETE examples

delete_product_rest_endpoint_page

Deletes a product REST endpoint page.

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