documentation_versions

Creates, updates, deletes or gets a documentation_version resource or lists documentation_versions in a region

Overview

Name	documentation_versions
Type	Resource
Description	The AWS::ApiGateway::DocumentationVersion resource creates a snapshot of the documentation for an API. For more information, see Representation of API Documentation in API Gateway in the API Gateway Developer Guide.
Id	awscc.apigateway.documentation_versions

Fields

get (all properties)

Name	Datatype	Description
description	string
documentation_version	string
rest_api_id	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
documentation_version	string
rest_api_id	string
region	string	AWS region.

For more information, see AWS::ApiGateway::DocumentationVersion.

Methods

Name	Resource	Accessible by	Required Params
create_resource	documentation_versions	INSERT	DocumentationVersion, RestApiId, region
delete_resource	documentation_versions	DELETE	Identifier, region
update_resource	documentation_versions	UPDATE	Identifier, PatchDocument, region
list_resources	documentation_versions_list_only	SELECT	region
get_resource	documentation_versions	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual documentation_version.

SELECT
  region,
  description,
  documentation_version,
  rest_api_id
FROM awscc.apigateway.documentation_versions
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ documentation_version }}|{{ rest_api_id }}';

list (identifiers only)

Lists all documentation_versions in a region.

SELECT
  region,
  documentation_version,
  rest_api_id
FROM awscc.apigateway.documentation_versions_list_only
WHERE
  region = '{{ region }}';

INSERT example

Use the following StackQL query and manifest file to create a new documentation_version resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.apigateway.documentation_versions (
  DocumentationVersion,
  RestApiId,
  region
)
SELECT
  '{{ documentation_version }}',
  '{{ rest_api_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.apigateway.documentation_versions (
  Description,
  DocumentationVersion,
  RestApiId,
  region
)
SELECT
  '{{ description }}',
  '{{ documentation_version }}',
  '{{ rest_api_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: documentation_version
  props:
    - name: description
      value: '{{ description }}'
    - name: documentation_version
      value: '{{ documentation_version }}'
    - name: rest_api_id
      value: '{{ rest_api_id }}'

UPDATE example

Use the following StackQL query and manifest file to update a documentation_version resource, using stack-deploy.

/*+ update */
UPDATE awscc.apigateway.documentation_versions
SET PatchDocument = string('{{ {
    "Description": description
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ documentation_version }}|{{ rest_api_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.apigateway.documentation_versions
WHERE
  Identifier = '{{ documentation_version }}|{{ rest_api_id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

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

Create

apigateway:GET,
apigateway:POST

Read

apigateway:GET

Update

apigateway:GET,
apigateway:PATCH

Delete

apigateway:DELETE

List

apigateway:GET