Amazon Direct Connect Direct Connect Operations API

openapi: 3.2.0
info:
  title: AWS Direct Connect Operations API
  version: '2012-10-25'
  description: Generated from AWS's published Smithy model for AWS Direct Connect. 15 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://directconnect.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Operations
paths:
  /#AssociateConnectionsToResiliencyGroup:
    post:
      operationId: AssociateConnectionsToResiliencyGroup
      summary: Associate Connections To Resiliency Group
      description: 'Associates one or more connections with the specified resiliency group. This operation is atomic: either all of the specified connections are associated, or the operation fails and no changes are made.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AssociateConnectionsToResiliencyGroupResult'
        '400':
          description: DirectConnectClientException; LimitExceededException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DirectConnectClientException'
        '500':
          description: DirectConnectServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DirectConnectServerException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - OvertureService.AssociateConnectionsToResiliencyGroup
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/AssociateConnectionsToResiliencyGroupRequest'
      tags:
      - Operations
  /#DisassociateConnectionsFromResiliencyGroup:
    post:
      operationId: DisassociateConnectionsFromResiliencyGroup
      summary: Disassociate Connections From Resiliency Group
      description: 'Disassociates one or more connections from the specified resiliency group. This operation is atomic: either all of the specified connections are disassociated, or the operation fails and no changes are made.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DisassociateConnectionsFromResiliencyGroupResult'
        '400':
          description: DirectConnectClientException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DirectConnectClientException'
        '500':
          description: DirectConnectServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DirectConnectServerException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - OvertureService.DisassociateConnectionsFromResiliencyGroup
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DisassociateConnectionsFromResiliencyGroupRequest'
      tags:
      - Operations
  /#ListResiliencyGroupAssociations:
    post:
      operationId: ListResiliencyGroupAssociations
      summary: List Resiliency Group Associations
      description: Lists the connection associations for the specified resiliency group.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListResiliencyGroupAssociationsResult'
        '400':
          description: DirectConnectClientException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DirectConnectClientException'
        '500':
          description: DirectConnectServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DirectConnectServerException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - OvertureService.ListResiliencyGroupAssociations
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListResiliencyGroupAssociationsRequest'
      tags:
      - Operations
  /#ListVirtualInterfaceRoutes:
    post:
      operationId: ListVirtualInterfaceRoutes
      summary: List Virtual Interface Routes
      description: 'Lists the routes for the specified virtual interface. Use the routeDirection filter to control which routes are returned: accepted: routes received from the customer network over the virtual interface. advertised: routes advertised to the customer network over the virtual interface.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListVirtualInterfaceRoutesResponse'
        '400':
          description: DirectConnectClientException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DirectConnectClientException'
        '500':
          description: DirectConnectServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DirectConnectServerException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - OvertureService.ListVirtualInterfaceRoutes
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListVirtualInterfaceRoutesRequest'
      tags:
      - Operations
  /#UpdateConnectionsBillingMode:
    post:
      operationId: UpdateConnectionsBillingMode
      summary: Update Connections Billing Mode
      description: Updates the billing mode for the specified Direct Connect connections. You can update the billing mode for up to 200 connections in a single request.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateConnectionsBillingModeResponse'
        '400':
          description: DirectConnectClientException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DirectConnectClientException'
        '500':
          description: DirectConnectServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DirectConnectServerException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - OvertureService.UpdateConnectionsBillingMode
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateConnectionsBillingModeRequest'
      tags:
      - Operations
components:
  schemas:
    RouteFilters:
      type: object
      properties:
        routeDirection:
          type: string
          enum:
          - accepted
          - advertised
          description: The direction of the routes to return. The valid values are accepted (routes received from the customer network) and advertised (routes advertised to the customer network).
        addressFamily:
          type: string
          enum:
          - ipv4
          - ipv6
          description: The address family of the routes to return. The valid values are ipv4 and ipv6.
        cidrs:
          type: array
          items:
            type: string
          description: The CIDRs (prefixes) used to filter the routes. You can specify up to 10 CIDRs.
        asPath:
          type: array
          items:
            type: integer
          description: The autonomous system (AS) numbers used to filter the routes by their AS path.
        communities:
          type: array
          items:
            type: string
          description: The BGP communities used to filter the routes.
    ListVirtualInterfaceRoutesResponse:
      type: object
      properties:
        virtualInterfaceId:
          type: string
          description: The ID of the virtual interface.
        routes:
          type: array
          items:
            $ref: '#/components/schemas/Route'
          description: The routes for the virtual interface.
        nextToken:
          type: string
          description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
    DirectConnectClientException:
      type: object
      properties:
        message:
          type: string
    UpdateConnectionsBillingModeResponse:
      type: object
      properties:
        billingMode:
          type: string
          enum:
          - PayAsYouGo
          - FlatRateTier1
          - FlatRateTier2
          - FlatRateTier3
          - FlatRateTier4
          - FlatRateTier5
          - PortPairFlatRateTier1
          - PortPairFlatRateTier2
          - PortPairFlatRateTier3
          - PortPairFlatRateTier4
          - PortPairFlatRateTier5
          description: The billing mode applied to the connections.
        connections:
          type: array
          items:
            $ref: '#/components/schemas/Connection'
          description: The connections with the updated billing mode.
    DirectConnectServerException:
      type: object
      properties:
        message:
          type: string
    AssociateConnectionsToResiliencyGroupRequest:
      type: object
      properties:
        connectionIdentifiers:
          type: array
          items:
            type: string
          description: The IDs or ARNs of the connections to associate with the resiliency group.
        resiliencyGroupId:
          type: string
          description: The ID of the resiliency group.
        clientToken:
          type: string
          description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
      required:
      - connectionIdentifiers
      - resiliencyGroupId
    AssociateConnectionsToResiliencyGroupResult:
      type: object
      properties:
        resiliencyGroupAssociations:
          type: array
          items:
            $ref: '#/components/schemas/ResiliencyGroupAssociation'
          description: The connection associations for the resiliency group.
    DisassociateConnectionsFromResiliencyGroupRequest:
      type: object
      properties:
        connectionIdentifiers:
          type: array
          items:
            type: string
          description: The IDs or ARNs of the connections to disassociate from the resiliency group.
        resiliencyGroupId:
          type: string
          description: The ID of the resiliency group.
        clientToken:
          type: string
          description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
      required:
      - connectionIdentifiers
      - resiliencyGroupId
    Tag:
      type: object
      properties:
        key:
          type: string
          description: The key.
        value:
          type: string
          description: The value.
      required:
      - key
    Connection:
      type: object
      properties:
        ownerAccount:
          type: string
          description: The ID of the Amazon Web Services account that owns the connection.
        connectionId:
          type: string
          description: The ID of the connection.
        connectionName:
          type: string
          description: The name of the connection.
        connectionState:
          type: string
          enum:
          - ordering
          - requested
          - pending
          - available
          - down
          - deleting
          - deleted
          - rejected
          - unknown
          description: 'The state of the connection. The following are the possible values: ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order. requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer. pending: The connection has been approved and is being initialized. available: The network link is up and the connection is ready for use. down: The network l'
        region:
          type: string
          description: The Amazon Web Services Region where the connection is located.
        location:
          type: string
          description: The location of the connection.
        bandwidth:
          type: string
          description: The bandwidth of the connection.
        vlan:
          type: integer
          description: The ID of the VLAN.
        partnerName:
          type: string
          description: The name of the Direct Connect service provider associated with the connection.
        loaIssueTime:
          type: string
          format: date-time
          description: The time of the most recent call to DescribeLoa for this connection.
        lagId:
          type: string
          description: The ID of the LAG.
        awsDevice:
          type: string
          description: The Direct Connect endpoint on which the physical connection terminates.
        jumboFrameCapable:
          type: boolean
          description: Indicates whether jumbo frames are supported.
        awsDeviceV2:
          type: string
          description: The Direct Connect endpoint that terminates the physical connection.
        awsLogicalDeviceId:
          type: string
          description: The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
        hasLogicalRedundancy:
          type: string
          enum:
          - unknown
          - 'yes'
          - 'no'
          description: Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags associated with the connection.
        providerName:
          type: string
          description: The name of the service provider associated with the connection.
        macSecCapable:
          type: boolean
          description: Indicates whether the connection supports MAC Security (MACsec).
        portEncryptionStatus:
          type: string
          description: The MAC Security (MACsec) port link status of the connection. The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.
        encryptionMode:
          type: string
          description: The MAC Security (MACsec) connection encryption mode. The valid values are no_encrypt, should_encrypt, and must_encrypt.
        macSecKeys:
          type: array
          items:
            $ref: '#/components/schemas/MacSecKey'
          description: The MAC Security (MACsec) security keys associated with the connection.
        rateLimiterStatus:
          $ref: '#/components/schemas/RateLimiterStatus'
        partnerInterconnectMacSecCapable:
          type: boolean
          description: Indicates whether the interconnect hosting this connection supports MAC Security (MACsec).
        prefixPoolSizeIpv4:
          type: integer
          description: The total number of inbound IPv4 route prefixes you can allocate across the virtual interfaces on the connection. Not applicable to hosted connections or interconnects.
        prefixPoolSizeIpv6:
          type: integer
          description: The total number of inbound IPv6 route prefixes you can allocate across the virtual interfaces on the connection. Not applicable to hosted connections or interconnects.
        prefixPoolUnallocatedCountIpv4:
          type: integer
          description: The number of inbound IPv4 route prefixes in the connection prefix pool not yet allocated to a virtual interface. Not applicable to hosted connections or interconnects.
        prefixPoolUnallocatedCountIpv6:
          type: integer
          description: The number of inbound IPv6 route prefixes in the connection prefix pool not yet allocated to a virtual interface. Not applicable to hosted connections or interconnects.
        billingMode:
          type: string
          enum:
          - PayAsYouGo
          - FlatRateTier1
          - FlatRateTier2
          - FlatRateTier3
          - FlatRateTier4
          - FlatRateTier5
          - PortPairFlatRateTier1
          - PortPairFlatRateTier2
          - PortPairFlatRateTier3
          - PortPairFlatRateTier4
          - PortPairFlatRateTier5
          description: The billing mode of the connection.
    ListResiliencyGroupAssociationsResult:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/ResiliencyGroupAssociation'
          description: The connection associations for the resiliency group.
        nextToken:
          type: string
          description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
    Route:
      type: object
      properties:
        cidr:
          type: string
          description: The CIDR (prefix) of the route.
        routeDirection:
          type: string
          enum:
          - accepted
          - advertised
          description: The direction of the route. The valid values are accepted (received from the customer network) and advertised (advertised to the customer network).
        addressFamily:
          type: string
          enum:
          - ipv4
          - ipv6
          description: The address family of the route. The valid values are ipv4 and ipv6.
        asPath:
          type: array
          items:
            $ref: '#/components/schemas/AsPathSegment'
          description: The autonomous system (AS) path of the route.
        communities:
          type: array
          items:
            type: string
          description: The BGP communities associated with the route.
        awsLogicalDeviceId:
          type: string
          description: The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
        routeInstalledAt:
          type: string
          format: date-time
          description: The time when the route was installed. The value is displayed in UTC format.
    UpdateConnectionsBillingModeRequest:
      type: object
      properties:
        connectionIds:
          type: array
          items:
            type: string
          description: The IDs of the connections to update. You can specify from 1 to 200 connections.
        billingMode:
          type: string
          enum:
          - PayAsYouGo
          - FlatRateTier1
          - FlatRateTier2
          - FlatRateTier3
          - FlatRateTier4
          - FlatRateTier5
          description: The billing mode to apply to the specified connections. The valid values are PayAsYouGo, FlatRateTier1, FlatRateTier2, FlatRateTier3, FlatRateTier4, and FlatRateTier5.
      required:
      - connectionIds
      - billingMode
    ResiliencyGroupAssociation:
      type: object
      properties:
        resiliencyGroupId:
          type: string
          description: The ID of the resiliency group.
        connectionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the associated connection.
        state:
          type: string
          enum:
          - associating
          - associated
          - disassociating
          - disassociated
          description: The state of the association. The valid values are associating, associated, disassociating, and disassociated.
    RateLimiterStatus:
      type: object
      properties:
        maxAllowed:
          type: integer
          description: The maximum number of rate limiters allowed on the connection.
        inUse:
          type: integer
          description: The number of rate limiters currently in use on the connection.
        remaining:
          type: integer
          description: The number of rate limiters remaining (available) on the connection.
        totalBandwidth:
          type: string
          description: The total bandwidth allocated across all rate limiters on the connection.
    ListResiliencyGroupAssociationsRequest:
      type: object
      properties:
        resiliencyGroupId:
          type: string
          description: The ID of the resiliency group.
        maxResults:
          type: integer
          description: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. If MaxResults is given a value larger than 100, only 100 results are returned.
        nextToken:
          type: string
          description: The token for the next page of results.
      required:
      - resiliencyGroupId
    MacSecKey:
      type: object
      properties:
        secretARN:
          type: string
          description: The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
        ckn:
          type: string
          description: The Connection Key Name (CKN) for the MAC Security secret key.
        state:
          type: string
          description: 'The state of the MAC Security (MACsec) secret key. The possible values are: associating: The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG. associated: The MAC Security (MACsec) secret key is validated and associated with the connection or LAG. disassociating: The MAC Security (MACsec) secret key is being disassociated from the connection or LAG disassociated: The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.'
        startOn:
          type: string
          description: The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.
    ListVirtualInterfaceRoutesRequest:
      type: object
      properties:
        virtualInterfaceId:
          type: string
          description: The ID of the virtual interface.
        filters:
          $ref: '#/components/schemas/RouteFilters'
        maxResults:
          type: integer
          description: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. If MaxResults is given a value larger than 100, only 100 results are returned.
        nextToken:
          type: string
          description: The token for the next page of results.
    AsPathSegment:
      type: object
      properties:
        pathType:
          type: string
          enum:
          - seq
          - set
          description: The type of the AS path segment. The valid values are seq (an ordered AS_SEQUENCE) and set (an unordered AS_SET).
        path:
          type: array
          items:
            type: integer
          description: The autonomous system (AS) numbers in the segment.
    DisassociateConnectionsFromResiliencyGroupResult:
      type: object
      properties:
        resiliencyGroupAssociations:
          type: array
          items:
            $ref: '#/components/schemas/ResiliencyGroupAssociation'
          description: The connection associations for the resiliency group.
  securitySchemes:
    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: directconnect
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/direct-connect/service/2012-10-25/direct-connect-2012-10-25.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)