Skip to main content

documentation_versions_list_only

Lists documentation_versions in a region or regions, for all properties use documentation_versions

Overview

Namedocumentation_versions_list_only
TypeResource
DescriptionThe AWS::ApiGateway::DocumentationVersion resource creates a snapshot of the documentation 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*.
Idaws.apigateway.documentation_versions_list_only

Fields

NameDatatypeDescription
descriptionstringA description about the new documentation snapshot.
documentation_versionstringThe version identifier of the to-be-updated documentation version.
rest_api_idstringThe string identifier of the associated RestApi.
regionstringAWS region.

Methods

NameAccessible byRequired Params
list_resourcesSELECTregion

SELECT examples

Lists all documentation_versions in a region.

SELECT
region,
documentation_version,
rest_api_id
FROM aws.apigateway.documentation_versions_list_only
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the documentation_versions_list_only resource, see documentation_versions