Amazon Direct Connect #X Amz Target=OvertureService.StartBgpFailoverTest 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.StartBgpFailoverTest 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.StartBgpFailoverTest'
paths:
  /#X-Amz-Target=OvertureService.StartBgpFailoverTest:
    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: StartBgpFailoverTest
      description: <p>Starts the virtual interface failover test that verifies your configuration meets your resiliency requirements by placing the BGP peering session in the DOWN state. You can then send traffic to verify that there are no outages.</p> <p>You can run the test on public, private, transit, and hosted virtual interfaces.</p> <p>You can use <a href="https://docs.aws.amazon.com/directconnect/latest/APIReference/API_ListVirtualInterfaceTestHistory.html">ListVirtualInterfaceTestHistory</a> to view the virtual interface test history.</p> <p>If you need to stop the test before the test interval completes, use <a href="https://docs.aws.amazon.com/directconnect/latest/APIReference/API_StopBgpFailoverTest.html">StopBgpFailoverTest</a>.</p>
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartBgpFailoverTestResponse'
        '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/StartBgpFailoverTestRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - OvertureService.StartBgpFailoverTest
      tags:
      - '#X Amz Target=OvertureService.StartBgpFailoverTest'
components:
  schemas:
    DirectConnectServerException: {}
    VirtualInterfaceTestHistory:
      type: object
      properties:
        testId:
          allOf:
          - $ref: '#/components/schemas/TestId'
          - description: The ID of the virtual interface failover test.
        virtualInterfaceId:
          allOf:
          - $ref: '#/components/schemas/VirtualInterfaceId'
          - description: The ID of the tested virtual interface.
        bgpPeers:
          allOf:
          - $ref: '#/components/schemas/BGPPeerIdList'
          - description: The BGP peers that were put in the DOWN state as part of the virtual interface failover test.
        status:
          allOf:
          - $ref: '#/components/schemas/FailureTestHistoryStatus'
          - description: The status of the virtual interface failover test.
        ownerAccount:
          allOf:
          - $ref: '#/components/schemas/OwnerAccount'
          - description: The owner ID of the tested virtual interface.
        testDurationInMinutes:
          allOf:
          - $ref: '#/components/schemas/TestDuration'
          - description: The time that the virtual interface failover test ran in minutes.
        startTime:
          allOf:
          - $ref: '#/components/schemas/StartTime'
          - description: The time that the virtual interface moves to the DOWN state.
        endTime:
          allOf:
          - $ref: '#/components/schemas/EndTime'
          - description: The time that the virtual interface moves out of the DOWN state.
      description: Information about the virtual interface failover test.
    BGPPeerId:
      type: string
    StartBgpFailoverTestResponse:
      type: object
      properties:
        virtualInterfaceTest:
          allOf:
          - $ref: '#/components/schemas/VirtualInterfaceTestHistory'
          - description: Information about the virtual interface failover test.
    VirtualInterfaceId:
      type: string
    EndTime:
      type: string
      format: date-time
    FailureTestHistoryStatus:
      type: string
    StartBgpFailoverTestRequest:
      type: object
      required:
      - virtualInterfaceId
      title: StartBgpFailoverTestRequest
      properties:
        virtualInterfaceId:
          allOf:
          - $ref: '#/components/schemas/VirtualInterfaceId'
          - description: The ID of the virtual interface you want to test.
        bgpPeers:
          allOf:
          - $ref: '#/components/schemas/BGPPeerIdList'
          - description: The BGP peers to place in the DOWN state.
        testDurationInMinutes:
          allOf:
          - $ref: '#/components/schemas/TestDuration'
          - description: '<p>The time in minutes that the virtual interface failover test will last.</p> <p>Maximum value: 4,320 minutes (72 hours).</p> <p>Default: 180 minutes (3 hours).</p>'
    OwnerAccount:
      type: string
    TestId:
      type: string
    TestDuration:
      type: integer
    DirectConnectClientException: {}
    StartTime:
      type: string
      format: date-time
    BGPPeerIdList:
      type: array
      items:
        $ref: '#/components/schemas/BGPPeerId'
  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