Amazon API Gateway VPC Links API

openapi: 3.1.0
info:
  title: Amazon API Gateway REST API Keys VPC Links API
  description: The Amazon API Gateway REST API enables programmatic management of API Gateway resources. You can create, configure, and manage REST APIs, stages, deployments, authorizers, models, resources, methods, and integrations through this management interface.
  version: '2015-07-09'
  contact:
    name: AWS Support
    url: https://aws.amazon.com/premiumsupport/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  x-logo:
    url: https://a0.awsstatic.com/libra-css/images/logos/aws_logo_smile_1200x630.png
servers:
- url: https://apigateway.{region}.amazonaws.com
  description: Amazon API Gateway regional endpoint
  variables:
    region:
      default: us-east-1
      description: AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-southeast-1
      - ap-southeast-2
      - ap-south-1
      - sa-east-1
      - ca-central-1
security:
- sigv4: []
tags:
- name: VPC Links
  description: Operations for managing VPC links
paths:
  /vpclinks:
    get:
      operationId: GetVpcLinks
      summary: Amazon API Gateway List VPC Links
      description: Returns information about all VPC links.
      tags:
      - VPC Links
      parameters:
      - $ref: '#/components/parameters/Position'
      - $ref: '#/components/parameters/Limit'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VpcLinks'
        '400':
          $ref: '#/components/responses/BadRequest'
        '429':
          $ref: '#/components/responses/TooManyRequests'
    post:
      operationId: CreateVpcLink
      summary: Amazon API Gateway Create a VPC Link
      description: Creates a VPC link for private integrations.
      tags:
      - VPC Links
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateVpcLinkRequest'
      responses:
        '202':
          description: VPC link creation accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VpcLink'
        '400':
          $ref: '#/components/responses/BadRequest'
        '409':
          $ref: '#/components/responses/Conflict'
        '429':
          $ref: '#/components/responses/TooManyRequests'
  /vpclinks/{vpclink_id}:
    get:
      operationId: GetVpcLink
      summary: Amazon API Gateway Get a VPC Link
      description: Returns information about a specific VPC link.
      tags:
      - VPC Links
      parameters:
      - $ref: '#/components/parameters/VpcLinkId'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VpcLink'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
    patch:
      operationId: UpdateVpcLink
      summary: Amazon API Gateway Update a VPC Link
      description: Updates an existing VPC link.
      tags:
      - VPC Links
      parameters:
      - $ref: '#/components/parameters/VpcLinkId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchOperations'
      responses:
        '200':
          description: VPC link updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VpcLink'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '429':
          $ref: '#/components/responses/TooManyRequests'
    delete:
      operationId: DeleteVpcLink
      summary: Amazon API Gateway Delete a VPC Link
      description: Deletes the specified VPC link.
      tags:
      - VPC Links
      parameters:
      - $ref: '#/components/parameters/VpcLinkId'
      responses:
        '202':
          description: VPC link deletion accepted
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  parameters:
    Limit:
      name: limit
      in: query
      description: The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
      schema:
        type: integer
        minimum: 1
        maximum: 500
        default: 25
    VpcLinkId:
      name: vpclink_id
      in: path
      required: true
      description: The identifier of the VPC link.
      schema:
        type: string
    Position:
      name: position
      in: query
      description: The current pagination position in the paged result set. Used for cursor-based pagination.
      schema:
        type: string
  schemas:
    CreateVpcLinkRequest:
      type: object
      required:
      - name
      - targetArns
      properties:
        name:
          type: string
        description:
          type: string
        targetArns:
          type: array
          items:
            type: string
        tags:
          type: object
          additionalProperties:
            type: string
    VpcLink:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
        targetArns:
          type: array
          items:
            type: string
        status:
          type: string
          enum:
          - AVAILABLE
          - PENDING
          - DELETING
          - FAILED
        statusMessage:
          type: string
        tags:
          type: object
          additionalProperties:
            type: string
    PatchOperations:
      type: object
      properties:
        patchOperations:
          type: array
          items:
            $ref: '#/components/schemas/PatchOperation'
    PatchOperation:
      type: object
      properties:
        op:
          type: string
          enum:
          - add
          - remove
          - replace
          - move
          - copy
          - test
          description: The operation type.
        path:
          type: string
          description: The op operation's target, as identified by a JSON Pointer value.
        value:
          type: string
          description: The new target value of the update operation. It is applicable for the add or replace operation.
        from:
          type: string
          description: The copy update operation's source as identified by a JSON Pointer value.
    VpcLinks:
      type: object
      properties:
        position:
          type: string
        item:
          type: array
          items:
            $ref: '#/components/schemas/VpcLink'
    Error:
      type: object
      properties:
        message:
          type: string
          description: A human-readable error message.
        code:
          type: string
          description: The error code.
  responses:
    TooManyRequests:
      description: The request rate has exceeded the allowed limit.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: The request is invalid or malformed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: The specified resource was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Conflict:
      description: The request conflicts with the current state of the resource.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    sigv4:
      type: apiKey
      name: Authorization
      in: header
      description: AWS Signature Version 4 authentication