Scalable Infrastructure EC2 API

The EC2 API from Scalable Infrastructure — 1 operation(s) for ec2.

Documentation

Specifications

Other Resources

OpenAPI Specification

scalable-infrastructure-ec2-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon EC2 API
  description: 'The Amazon EC2 API is a query API for managing EC2 compute, EBS volumes,

    and VPC resources. It is transported over HTTPS to a regional EC2 endpoint,

    and requests are signed using AWS Signature v4. This OpenAPI captures a

    representative subset of operations as an API Evangelist research artifact

    for the scalable-infrastructure topic.

    '
  version: 1.0.0
  contact:
    name: API Evangelist
    url: https://apievangelist.com
servers:
- url: https://ec2.{region}.amazonaws.com
  description: Regional EC2 endpoint
  variables:
    region:
      default: us-east-1
      description: AWS region
security:
- SigV4: []
tags:
- name: EC2
paths:
  /:
    post:
      summary: EC2 query API action dispatcher
      description: 'All EC2 actions are issued as HTTPS GET or POST requests against the

        regional endpoint root, with the `Action` query parameter naming the

        operation. The `Action` parameter enum below lists a representative

        sample of supported operations.

        '
      operationId: invokeAction
      tags:
      - EC2
      parameters:
      - name: Action
        in: query
        required: true
        schema:
          type: string
          enum:
          - RunInstances
          - StartInstances
          - StopInstances
          - TerminateInstances
          - RebootInstances
          - DescribeInstances
          - DescribeImages
          - CreateImage
          - CreateSecurityGroup
          - AuthorizeSecurityGroupIngress
          - CreateKeyPair
          - CreateVpc
          - CreateSubnet
          - CreateVolume
          - AttachVolume
          - DescribeVolumes
      - name: Version
        in: query
        required: true
        schema:
          type: string
          default: '2016-11-15'
      responses:
        '200':
          description: XML response document for the action.
        '400':
          description: Client error (validation, throttling, or service error).
    get:
      summary: EC2 query API action dispatcher (GET variant)
      operationId: invokeActionGet
      tags:
      - EC2
      parameters:
      - name: Action
        in: query
        required: true
        schema:
          type: string
      - name: Version
        in: query
        required: true
        schema:
          type: string
          default: '2016-11-15'
      responses:
        '200':
          description: XML response.
components:
  securitySchemes:
    SigV4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4 signed request (Authorization header).