documentation_parts

Creates, updates, deletes or gets a documentation_part resource or lists documentation_parts in a region

Overview

Name	documentation_parts
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 in the API Gateway Developer Guide.
Id	awscc.apigateway.documentation_parts

Fields

get (all properties)

Name	Datatype	Description
documentation_part_id	string
▶location	object	The Location property specifies the location of the Amazon API Gateway API entity that the documentation applies to. Location is a property of the AWS::ApiGateway::DocumentationPart resource. For more information about each property, including constraints and valid values, see DocumentationPart in the Amazon API Gateway REST API Reference.
properties	string
rest_api_id	string
region	string	AWS region.

list (identifiers only)

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

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	documentation_parts	INSERT	Location, Properties, RestApiId, region
delete_resource	documentation_parts	DELETE	Identifier, region
update_resource	documentation_parts	UPDATE	Identifier, PatchDocument, region
list_resources	documentation_parts_list_only	SELECT	region
get_resource	documentation_parts	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual documentation_part.

SELECT
  region,
  documentation_part_id,
  location,
  properties,
  rest_api_id
FROM awscc.apigateway.documentation_parts
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ documentation_part_id }}|{{ rest_api_id }}';

list (identifiers only)

Lists all documentation_parts in a region.

SELECT
  region,
  documentation_part_id,
  rest_api_id
FROM awscc.apigateway.documentation_parts_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.apigateway.documentation_parts (
  Location,
  Properties,
  RestApiId,
  region
)
SELECT
  '{{ location }}',
  '{{ properties }}',
  '{{ rest_api_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.apigateway.documentation_parts (
  Location,
  Properties,
  RestApiId,
  region
)
SELECT
  '{{ location }}',
  '{{ properties }}',
  '{{ 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_part
  props:
    - name: location
      value:
        method: '{{ method }}'
        name: '{{ name }}'
        path: '{{ path }}'
        status_code: '{{ status_code }}'
        type: '{{ type }}'
    - name: properties
      value: '{{ properties }}'
    - name: rest_api_id
      value: '{{ rest_api_id }}'

UPDATE example

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

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

DELETE example

/*+ delete */
DELETE FROM awscc.apigateway.documentation_parts
WHERE
  Identifier = '{{ documentation_part_id }}|{{ 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_parts 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