documentation_parts_list_only
Lists documentation_parts in a region or regions, for all properties use documentation_parts
Overview
| Name | documentation_parts_list_only |
| Type | Resource |
| Description | The AWS::ApiGateway::DocumentationPart resource creates a documentation part for an API. For more information, see [Representation of API Documentation in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api-content-representation.html) in the API Gateway Developer Guide. |
| Id | aws.apigateway.documentation_parts_list_only |
Fields
| Name | Datatype | Description |
|---|---|---|
documentation_part_id | string | |
rest_api_id | string | |
region | string | AWS region. |
Methods
| Name | Accessible by | Required Params |
|---|---|---|
list_resources | SELECT | region |
SELECT examples
Lists all documentation_parts in a region.
SELECT
region,
documentation_part_id,
rest_api_id
FROM aws.apigateway.documentation_parts_list_only
WHERE region = 'us-east-1';
Permissions
For permissions required to operate on the documentation_parts_list_only resource, see documentation_parts