Amazon EC2 Regions API

openapi: 3.2.0
info:
  title: Amazon Ec2 Regions API
  version: '2016-11-15'
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  description: 'Operations tagged Regions across 2 of this provider''s published API definitions: amazon-ec2-openapi.yml, amazon-ec2-regions-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://ec2.{region}.amazonaws.com
  description: Amazon EC2 Regional Endpoint
  variables:
    region:
      default: us-east-1
      description: AWS Region
tags:
- name: Regions
  description: Operations for describing AWS regions and availability zones
paths:
  /?Action=DescribeRegions:
    get:
      operationId: describeRegions
      summary: Amazon EC2 Describe AWS Regions
      description: Describes the Regions that are enabled for your account, or all Regions. For a list of the Regions supported by Amazon EC2, see the Amazon EC2 Regions and Endpoints.
      tags:
      - Regions
      parameters:
      - name: RegionName
        in: query
        description: The names of the Regions
        schema:
          type: array
          items:
            type: string
        example:
        - example-resource-name
      - name: AllRegions
        in: query
        description: Indicates whether to display all Regions including disabled
        schema:
          type: boolean
        example: true
      responses:
        '200':
          description: Successfully described regions
        '400':
          description: Invalid request parameters
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - sigv4Auth: []
    post:
      operationId: DescribeRegions
      summary: Describe Regions
      description: Describes the Regions that are enabled for your account, or all Regions. For a list of the Regions supported by Amazon EC2, see Amazon EC2 service endpoints. For information about enabling and disabling Regions for your account, see Specify which Amazon Web Services Regions your account can use in the Amazon Web Services Account Management Reference Guide. The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeRegionsResult'
              example:
                Regions:
                - Endpoint: ec2.ap-south-1.amazonaws.com
                  RegionName: ap-south-1
                - Endpoint: ec2.eu-west-1.amazonaws.com
                  RegionName: eu-west-1
                - Endpoint: ec2.ap-southeast-1.amazonaws.com
                  RegionName: ap-southeast-1
                - Endpoint: ec2.ap-southeast-2.amazonaws.com
                  RegionName: ap-southeast-2
                - Endpoint: ec2.eu-central-1.amazonaws.com
                  RegionName: eu-central-1
                - Endpoint: ec2.ap-northeast-2.amazonaws.com
                  RegionName: ap-northeast-2
                - Endpoint: ec2.ap-northeast-1.amazonaws.com
                  RegionName: ap-northeast-1
                - Endpoint: ec2.us-east-1.amazonaws.com
                  RegionName: us-east-1
                - Endpoint: ec2.sa-east-1.amazonaws.com
                  RegionName: sa-east-1
                - Endpoint: ec2.us-west-1.amazonaws.com
                  RegionName: us-west-1
                - Endpoint: ec2.us-west-2.amazonaws.com
                  RegionName: us-west-2
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeRegions
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DescribeRegionsRequest'
      tags:
      - Regions
      security:
      - sigv4Auth: []
    servers:
    - url: https://ec2.{region}.amazonaws.com
      description: Amazon EC2 Regional Endpoint
      variables:
        region:
          default: us-east-1
          description: AWS Region
  /?Action=DescribeAvailabilityZones:
    get:
      operationId: describeAvailabilityZones
      summary: Amazon EC2 Describe Availability Zones
      description: Describes the Availability Zones, Local Zones, and Wavelength Zones that are available to you. The results include zones only for the Region you are currently using.
      tags:
      - Regions
      parameters:
      - name: ZoneName
        in: query
        description: The names of the Availability Zones
        schema:
          type: array
          items:
            type: string
        example:
        - example-resource-name
      - name: ZoneId
        in: query
        description: The IDs of the Availability Zones
        schema:
          type: array
          items:
            type: string
        example:
        - example-id-1234
      responses:
        '200':
          description: Successfully described availability zones
        '400':
          description: Invalid request parameters
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - sigv4Auth: []
    servers:
    - url: https://ec2.{region}.amazonaws.com
      description: Amazon EC2 Regional Endpoint
      variables:
        region:
          default: us-east-1
          description: AWS Region
components:
  schemas:
    DescribeRegionsRequest:
      type: object
      properties:
        RegionNames:
          type: array
          items:
            type: string
          description: The names of the Regions. You can specify any Regions, whether they are enabled and disabled for your account.
        AllRegions:
          type: boolean
          description: Indicates whether to display all Regions, including Regions that are disabled for your account.
        DryRun:
          type: boolean
          description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: The filters. endpoint - The endpoint of the Region (for example, ec2.us-east-1.amazonaws.com). opt-in-status - The opt-in status of the Region (opt-in-not-required | opted-in | not-opted-in). region-name - The name of the Region (for example, us-east-1).
    RegionGeography:
      type: object
      properties:
        Name:
          type: string
          description: The name of the geography, for example, United States of America.
    DescribeRegionsResult:
      type: object
      properties:
        Regions:
          type: array
          items:
            $ref: '#/components/schemas/Region'
          description: Information about the Regions.
    Filter:
      type: object
      properties:
        Name:
          type: string
          description: The name of the filter. Filter names are case-sensitive.
        Values:
          type: array
          items:
            type: string
          description: The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
    Region:
      type: object
      properties:
        OptInStatus:
          type: string
          description: The Region opt-in status. The possible values are opt-in-not-required, opted-in, and not-opted-in.
        Geography:
          type: array
          items:
            $ref: '#/components/schemas/RegionGeography'
          description: The geography information for the Region. The geography is returned as a list.
        RegionName:
          type: string
          description: The name of the Region.
        Endpoint:
          type: string
          description: The Region service endpoint.
  securitySchemes:
    sigv4Auth:
      type: apiKey
      name: Authorization
      in: header
      description: AWS Signature Version 4 authentication
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: ec2
externalDocs:
  description: Amazon EC2 API Reference
  url: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/
x-refined-from:
- amazon-ec2-openapi.yml
- amazon-ec2-regions-api-openapi.yml