Amazon Direct Connect #X Amz Target=OvertureService.DescribeDirectConnectGatewayAssociationProposals 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.DescribeDirectConnectGatewayAssociationProposals 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.DescribeDirectConnectGatewayAssociationProposals'
paths:
  /#X-Amz-Target=OvertureService.DescribeDirectConnectGatewayAssociationProposals:
    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: DescribeDirectConnectGatewayAssociationProposals
      description: 'Describes one or more association proposals for connection between a virtual private gateway or transit gateway and a Direct Connect gateway. '
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeDirectConnectGatewayAssociationProposalsResult'
        '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/DescribeDirectConnectGatewayAssociationProposalsRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - OvertureService.DescribeDirectConnectGatewayAssociationProposals
      tags:
      - '#X Amz Target=OvertureService.DescribeDirectConnectGatewayAssociationProposals'
components:
  schemas:
    DirectConnectServerException: {}
    PaginationToken:
      type: string
    DescribeDirectConnectGatewayAssociationProposalsResult:
      type: object
      properties:
        directConnectGatewayAssociationProposals:
          allOf:
          - $ref: '#/components/schemas/DirectConnectGatewayAssociationProposalList'
          - description: Describes the Direct Connect gateway association proposals.
        nextToken:
          allOf:
          - $ref: '#/components/schemas/PaginationToken'
          - description: The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.
    DirectConnectGatewayAssociationProposalId:
      type: string
    CIDR:
      type: string
    RouteFilterPrefix:
      type: object
      properties:
        cidr:
          allOf:
          - $ref: '#/components/schemas/CIDR'
          - description: The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
      description: Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
    RouteFilterPrefixList:
      type: array
      items:
        $ref: '#/components/schemas/RouteFilterPrefix'
    GatewayIdentifier:
      type: string
    GatewayType:
      type: string
      enum:
      - virtualPrivateGateway
      - transitGateway
    DirectConnectGatewayAssociationProposalList:
      type: array
      items:
        $ref: '#/components/schemas/DirectConnectGatewayAssociationProposal'
    OwnerAccount:
      type: string
    MaxResultSetSize:
      type: integer
    AssociatedGateway:
      type: object
      properties:
        id:
          allOf:
          - $ref: '#/components/schemas/GatewayIdentifier'
          - description: The ID of the associated gateway.
        type:
          allOf:
          - $ref: '#/components/schemas/GatewayType'
          - description: The type of associated gateway.
        ownerAccount:
          allOf:
          - $ref: '#/components/schemas/OwnerAccount'
          - description: The ID of the Amazon Web Services account that owns the associated virtual private gateway or transit gateway.
        region:
          allOf:
          - $ref: '#/components/schemas/Region'
          - description: The Region where the associated gateway is located.
      description: Information about the associated gateway.
    Region:
      type: string
    DirectConnectGatewayAssociationProposalState:
      type: string
      enum:
      - requested
      - accepted
      - deleted
    DirectConnectGatewayAssociationProposal:
      type: object
      properties:
        proposalId:
          allOf:
          - $ref: '#/components/schemas/DirectConnectGatewayAssociationProposalId'
          - description: The ID of the association proposal.
        directConnectGatewayId:
          allOf:
          - $ref: '#/components/schemas/DirectConnectGatewayId'
          - description: The ID of the Direct Connect gateway.
        directConnectGatewayOwnerAccount:
          allOf:
          - $ref: '#/components/schemas/OwnerAccount'
          - description: The ID of the Amazon Web Services account that owns the Direct Connect gateway.
        proposalState:
          allOf:
          - $ref: '#/components/schemas/DirectConnectGatewayAssociationProposalState'
          - description: '<p>The state of the proposal. The following are possible values:</p> <ul> <li> <p> <code>accepted</code>: The proposal has been accepted. The Direct Connect gateway association is available to use in this state.</p> </li> <li> <p> <code>deleted</code>: The proposal has been deleted by the owner that made the proposal. The Direct Connect gateway association cannot be used in this state.</p> </li> <li> <p> <code>requested</code>: The proposal has been requested. The Direct Connect gateway association cannot be used in this state.</p> </li> </ul>'
        associatedGateway:
          allOf:
          - $ref: '#/components/schemas/AssociatedGateway'
          - description: Information about the associated gateway.
        existingAllowedPrefixesToDirectConnectGateway:
          allOf:
          - $ref: '#/components/schemas/RouteFilterPrefixList'
          - description: The existing Amazon VPC prefixes advertised to the Direct Connect gateway.
        requestedAllowedPrefixesToDirectConnectGateway:
          allOf:
          - $ref: '#/components/schemas/RouteFilterPrefixList'
          - description: The Amazon VPC prefixes to advertise to the Direct Connect gateway.
      description: 'Information about the proposal request to attach a virtual private gateway to a Direct Connect gateway. '
    DirectConnectGatewayId:
      type: string
    AssociatedGatewayId:
      type: string
    DirectConnectClientException: {}
    DescribeDirectConnectGatewayAssociationProposalsRequest:
      type: object
      title: DescribeDirectConnectGatewayAssociationProposalsRequest
      properties:
        directConnectGatewayId:
          allOf:
          - $ref: '#/components/schemas/DirectConnectGatewayId'
          - description: The ID of the Direct Connect gateway.
        proposalId:
          allOf:
          - $ref: '#/components/schemas/DirectConnectGatewayAssociationProposalId'
          - description: The ID of the proposal.
        associatedGatewayId:
          allOf:
          - $ref: '#/components/schemas/AssociatedGatewayId'
          - description: The ID of the associated 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 for the next page of results.
  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-Security-Token:
      name: X-Amz-Security-Token
      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-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