Amazon Direct Connect #X Amz Target=OvertureService.DescribeDirectConnectGateways API

openapi: 3.0.0
info:
  version: 2012-10-25
  x-release: v4
  title: 'AWS Direct Connect #X Amz Target=OvertureService.AcceptDirectConnectGatewayAssociationProposal #X Amz Target=OvertureService.AcceptDirectConnectGatewayAssociationProposal #X Amz Target=OvertureService.DescribeDirectConnectGateways API'
  description: Direct Connect links your internal network to an Direct Connect location over a standard Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an Direct Connect router. With this connection in place, you can create virtual interfaces directly to the Amazon Web Services Cloud (for example, to Amazon EC2 and Amazon S3) and to Amazon VPC, bypassing Internet service providers in your network path. A connection provides access to all Amazon Web Services Regions except the China (Beijing) and (China) Ningxia Regions. Amazon Web Services resources in the China Regions can only be accessed through locations associated with those Regions.
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: directconnect
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/directconnect-2012-10-25.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://directconnect.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The AWS Direct Connect multi-region endpoint
- url: https://directconnect.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The AWS Direct Connect multi-region endpoint
- url: http://directconnect.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS Direct Connect endpoint for China (Beijing) and China (Ningxia)
- url: https://directconnect.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS Direct Connect endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=OvertureService.DescribeDirectConnectGateways'
paths:
  /#X-Amz-Target=OvertureService.DescribeDirectConnectGateways:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: DescribeDirectConnectGateways
      description: Lists all your Direct Connect gateways or only the specified Direct Connect gateway. Deleted Direct Connect gateways are not returned.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeDirectConnectGatewaysResult'
        '480':
          description: DirectConnectServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DirectConnectServerException'
        '481':
          description: DirectConnectClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DirectConnectClientException'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeDirectConnectGatewaysRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - OvertureService.DescribeDirectConnectGateways
      tags:
      - '#X Amz Target=OvertureService.DescribeDirectConnectGateways'
components:
  schemas:
    StateChangeError:
      type: string
    DirectConnectServerException: {}
    DirectConnectGatewayName:
      type: string
    DirectConnectGateway:
      type: object
      properties:
        directConnectGatewayId:
          allOf:
          - $ref: '#/components/schemas/DirectConnectGatewayId'
          - description: The ID of the Direct Connect gateway.
        directConnectGatewayName:
          allOf:
          - $ref: '#/components/schemas/DirectConnectGatewayName'
          - description: The name of the Direct Connect gateway.
        amazonSideAsn:
          allOf:
          - $ref: '#/components/schemas/LongAsn'
          - description: The autonomous system number (ASN) for the Amazon side of the connection.
        ownerAccount:
          allOf:
          - $ref: '#/components/schemas/OwnerAccount'
          - description: The ID of the Amazon Web Services account that owns the Direct Connect gateway.
        directConnectGatewayState:
          allOf:
          - $ref: '#/components/schemas/DirectConnectGatewayState'
          - description: '<p>The state of the Direct Connect gateway. The following are the possible values:</p> <ul> <li> <p> <code>pending</code>: The initial state after calling <a>CreateDirectConnectGateway</a>.</p> </li> <li> <p> <code>available</code>: The Direct Connect gateway is ready for use.</p> </li> <li> <p> <code>deleting</code>: The initial state after calling <a>DeleteDirectConnectGateway</a>.</p> </li> <li> <p> <code>deleted</code>: The Direct Connect gateway is deleted and cannot pass traffic.</p> </li> </ul>'
        stateChangeError:
          allOf:
          - $ref: '#/components/schemas/StateChangeError'
          - description: The error message if the state of an object failed to advance.
      description: Information about a Direct Connect gateway, which enables you to connect virtual interfaces and virtual private gateway or transit gateways.
    PaginationToken:
      type: string
    DirectConnectGatewayList:
      type: array
      items:
        $ref: '#/components/schemas/DirectConnectGateway'
    DescribeDirectConnectGatewaysResult:
      type: object
      properties:
        directConnectGateways:
          allOf:
          - $ref: '#/components/schemas/DirectConnectGatewayList'
          - description: The Direct Connect gateways.
        nextToken:
          allOf:
          - $ref: '#/components/schemas/PaginationToken'
          - description: The token to retrieve the next page.
    OwnerAccount:
      type: string
    LongAsn:
      type: integer
    DescribeDirectConnectGatewaysRequest:
      type: object
      title: DescribeDirectConnectGatewaysRequest
      properties:
        directConnectGatewayId:
          allOf:
          - $ref: '#/components/schemas/DirectConnectGatewayId'
          - description: The ID of the Direct Connect gateway.
        maxResults:
          allOf:
          - $ref: '#/components/schemas/MaxResultSetSize'
          - description: <p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p> <p>If <code>MaxResults</code> is given a value larger than 100, only 100 results are returned.</p>
        nextToken:
          allOf:
          - $ref: '#/components/schemas/PaginationToken'
          - description: The token provided in the previous call to retrieve the next page.
    MaxResultSetSize:
      type: integer
    DirectConnectGatewayId:
      type: string
    DirectConnectClientException: {}
    DirectConnectGatewayState:
      type: string
      enum:
      - pending
      - available
      - deleting
      - deleted
  parameters:
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/directconnect/
x-hasEquivalentPaths: true