documentation_part

Gets an individual documentation_part resource

Overview

Name	documentation_part
Type	Resource
Description	documentation_part
Id	awscc.apigateway.documentation_part

Fields

Name	Datatype	Description
documentation_part_id	string
location	object	The location of the targeted API entity of the to-be-created documentation part.
properties	string	The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.
rest_api_id	string	The string identifier of the associated RestApi.
region	string	AWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
documentation_part_id,
location,
properties,
rest_api_id
FROM awscc.apigateway.documentation_part
WHERE data__Identifier = '<DocumentationPartId>|<RestApiId>';

Permissions

To operate on the documentation_part resource, the following permissions are required:

Read

apigateway:GET

Update

apigateway:GET,
apigateway:PATCH

Delete

apigateway:DELETE