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

openapi: 3.2.0
info:
  version: 1.0.0
  x-release: v4
  title: 'AWS Direct Connect #X Amz Target=OvertureService.AcceptDirectConnectGatewayAssociationProposal #X Amz Target=OvertureService.AcceptDirectConnectGatewayAssociationProposal #X Amz Target=OvertureService.UpdateLag #X Amz Target=OvertureService.UpdateLag #X Amz Target=OvertureService.UpdateLag 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
    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.UpdateLag'
paths:
  /#X-Amz-Target=OvertureService.UpdateLag:
    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: UpdateLag
      description: <p>Updates the attributes of the specified link aggregation group (LAG).</p> <p>You can update the following LAG attributes:</p> <ul> <li> <p>The name of the LAG.</p> </li> <li> <p>The value for the minimum number of connections that must be operational for the LAG itself to be operational. </p> </li> <li> <p>The LAG's MACsec encryption mode.</p> <p>Amazon Web Services assigns this value to each connection which is part of the LAG.</p> </li> <li> <p>The tags</p> </li> </ul> <note> <p>If you adjust the threshold value for the minimum number of operational connections, ensure that the new value does not cause the LAG to fall below the threshold and become non-operational.</p> </note>
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Lag'
        '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/UpdateLagRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - OvertureService.UpdateLag
      tags:
      - '#X Amz Target=OvertureService.UpdateLag'
components:
  schemas:
    MacSecKeyList:
      type: array
      items:
        $ref: '#/components/schemas/MacSecKey'
    AwsDeviceV2:
      type: string
    OwnerAccount:
      type: string
    Count:
      type: integer
    EncryptionMode:
      type: string
    JumboFrameCapable:
      type: boolean
    DirectConnectClientException: {}
    LagState:
      type: string
      enum:
      - requested
      - pending
      - available
      - down
      - deleting
      - deleted
      - unknown
    LoaIssueTime:
      type: string
      format: date-time
    BooleanFlag:
      type: boolean
    Tag:
      type: object
      required:
      - key
      properties:
        key:
          allOf:
          - $ref: '#/components/schemas/TagKey'
          - description: The key.
        value:
          allOf:
          - $ref: '#/components/schemas/TagValue'
          - description: The value.
      description: Information about a tag.
    Bandwidth:
      type: string
    Lag:
      type: object
      properties:
        connectionsBandwidth:
          allOf:
          - $ref: '#/components/schemas/Bandwidth'
          - description: 'The individual bandwidth of the physical connections bundled by the LAG. The possible values are 1Gbps and 10Gbps. '
        numberOfConnections:
          allOf:
          - $ref: '#/components/schemas/Count'
          - description: The number of physical dedicated connections bundled by the LAG, up to a maximum of 10.
        lagId:
          allOf:
          - $ref: '#/components/schemas/LagId'
          - description: The ID of the LAG.
        ownerAccount:
          allOf:
          - $ref: '#/components/schemas/OwnerAccount'
          - description: The ID of the Amazon Web Services account that owns the LAG.
        lagName:
          allOf:
          - $ref: '#/components/schemas/LagName'
          - description: The name of the LAG.
        lagState:
          allOf:
          - $ref: '#/components/schemas/LagState'
          - description: '<p>The state of the LAG. The following are the possible values:</p> <ul> <li> <p> <code>requested</code>: The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.</p> </li> <li> <p> <code>pending</code>: The LAG has been approved and is being initialized.</p> </li> <li> <p> <code>available</code>: The network link is established and the LAG is ready for use.</p> </li> <li> <p> <code>down</code>: The network link is down.</p> </li> <li> <p> <code>deleting</code>: The LAG is being deleted.</p> </li> <li> <p> <code>deleted</code>: The LAG is deleted.</p> </li> <li> <p> <code>unknown</code>: The state of the LAG is not available.</p> </li> </ul>'
        location:
          allOf:
          - $ref: '#/components/schemas/LocationCode'
          - description: The location of the LAG.
        region:
          allOf:
          - $ref: '#/components/schemas/Region'
          - description: The Amazon Web Services Region where the connection is located.
        minimumLinks:
          allOf:
          - $ref: '#/components/schemas/Count'
          - description: The minimum number of physical dedicated connections that must be operational for the LAG itself to be operational.
        awsDevice:
          allOf:
          - $ref: '#/components/schemas/AwsDevice'
          - description: The Direct Connect endpoint that hosts the LAG.
        awsDeviceV2:
          allOf:
          - $ref: '#/components/schemas/AwsDeviceV2'
          - description: The Direct Connect endpoint that hosts the LAG.
        awsLogicalDeviceId:
          allOf:
          - $ref: '#/components/schemas/AwsLogicalDeviceId'
          - description: The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
        connections:
          allOf:
          - $ref: '#/components/schemas/ConnectionList'
          - description: The connections bundled by the LAG.
        allowsHostedConnections:
          allOf:
          - $ref: '#/components/schemas/BooleanFlag'
          - description: Indicates whether the LAG can host other connections.
        jumboFrameCapable:
          allOf:
          - $ref: '#/components/schemas/JumboFrameCapable'
          - description: Indicates whether jumbo frames (9001 MTU) are supported.
        hasLogicalRedundancy:
          allOf:
          - $ref: '#/components/schemas/HasLogicalRedundancy'
          - description: Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).
        tags:
          allOf:
          - $ref: '#/components/schemas/TagList'
          - description: The tags associated with the LAG.
        providerName:
          allOf:
          - $ref: '#/components/schemas/ProviderName'
          - description: The name of the service provider associated with the LAG.
        macSecCapable:
          allOf:
          - $ref: '#/components/schemas/MacSecCapable'
          - description: Indicates whether the LAG supports MAC Security (MACsec).
        encryptionMode:
          allOf:
          - $ref: '#/components/schemas/EncryptionMode'
          - description: <p>The LAG MAC Security (MACsec) encryption mode.</p> <p>The valid values are <code>no_encrypt</code>, <code>should_encrypt</code>, and <code>must_encrypt</code>.</p>
        macSecKeys:
          allOf:
          - $ref: '#/components/schemas/MacSecKeyList'
          - description: The MAC Security (MACsec) security keys associated with the LAG.
      description: Information about a link aggregation group (LAG).
    LagName:
      type: string
    MacSecCapable:
      type: boolean
    AwsDevice:
      type: string
      deprecated: true
    DirectConnectServerException: {}
    AwsLogicalDeviceId:
      type: string
    TagKey:
      type: string
      pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$
      minLength: 1
      maxLength: 128
    ConnectionName:
      type: string
    LocationCode:
      type: string
    LagId:
      type: string
    HasLogicalRedundancy:
      type: string
      enum:
      - unknown
      - true
      - false
    UpdateLagRequest:
      type: object
      required:
      - lagId
      title: UpdateLagRequest
      properties:
        lagId:
          allOf:
          - $ref: '#/components/schemas/LagId'
          - description: The ID of the LAG.
        lagName:
          allOf:
          - $ref: '#/components/schemas/LagName'
          - description: The name of the LAG.
        minimumLinks:
          allOf:
          - $ref: '#/components/schemas/Count'
          - description: The minimum number of physical connections that must be operational for the LAG itself to be operational.
        encryptionMode:
          allOf:
          - $ref: '#/components/schemas/EncryptionMode'
          - description: <p>The LAG MAC Security (MACsec) encryption mode.</p> <p>Amazon Web Services applies the value to all connections which are part of the LAG.</p>
    Connection:
      type: object
      properties:
        ownerAccount:
          allOf:
          - $ref: '#/components/schemas/OwnerAccount'
          - description: The ID of the Amazon Web Services account that owns the connection.
        connectionId:
          allOf:
          - $ref: '#/components/schemas/ConnectionId'
          - description: The ID of the connection.
        connectionName:
          allOf:
          - $ref: '#/components/schemas/ConnectionName'
          - description: The name of the connection.
        connectionState:
          allOf:
          - $ref: '#/components/schemas/ConnectionState'
          - description: '<p>The state of the connection. The following are the possible values:</p> <ul> <li> <p> <code>ordering</code>: 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.</p> </li> <li> <p> <code>requested</code>: 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.</p> </li> <li> <p> <code>pending</code>: The connection has been approved and is being initialized.</p> </li> <li> <p> <code>available</code>: The network link is up and the connection is ready for use.</p> </li> <li> <p> <code>down</code>: The network link is down.</p> </li> <li> <p> <code>deleting</code>: The connection is being deleted.</p> </li> <li> <p> <code>deleted</code>: The connection has been deleted.</p> </li> <li> <p> <code>rejected</code>: A hosted connection in the <code>ordering</code> state enters the <code>rejected</code> state if it is deleted by the customer.</p> </li> <li> <p> <code>unknown</code>: The state of the connection is not available.</p> </li> </ul>'
        region:
          allOf:
          - $ref: '#/components/schemas/Region'
          - description: The Amazon Web Services Region where the connection is located.
        location:
          allOf:
          - $ref: '#/components/schemas/LocationCode'
          - description: The location of the connection.
        bandwidth:
          allOf:
          - $ref: '#/components/schemas/Bandwidth'
          - description: The bandwidth of the connection.
        vlan:
          allOf:
          - $ref: '#/components/schemas/VLAN'
          - description: The ID of the VLAN.
        partnerName:
          allOf:
          - $ref: '#/components/schemas/PartnerName'
          - description: The name of the Direct Connect service provider associated with the connection.
        loaIssueTime:
          allOf:
          - $ref: '#/components/schemas/LoaIssueTime'
          - description: The time of the most recent call to <a>DescribeLoa</a> for this connection.
        lagId:
          allOf:
          - $ref: '#/components/schemas/LagId'
          - description: The ID of the LAG.
        awsDevice:
          allOf:
          - $ref: '#/components/schemas/AwsDevice'
          - description: The Direct Connect endpoint on which the physical connection terminates.
        jumboFrameCapable:
          allOf:
          - $ref: '#/components/schemas/JumboFrameCapable'
          - description: Indicates whether jumbo frames (9001 MTU) are supported.
        awsDeviceV2:
          allOf:
          - $ref: '#/components/schemas/AwsDeviceV2'
          - description: The Direct Connect endpoint that terminates the physical connection.
        awsLogicalDeviceId:
          allOf:
          - $ref: '#/components/schemas/AwsLogicalDeviceId'
          - description: The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
        hasLogicalRedundancy:
          allOf:
          - $ref: '#/components/schemas/HasLogicalRedundancy'
          - description: Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
        tags:
          allOf:
          - $ref: '#/components/schemas/TagList'
          - description: The tags associated with the connection.
        providerName:
          allOf:
          - $ref: '#/components/schemas/ProviderName'
          - description: The name of the service provider associated with the connection.
        macSecCapable:
          allOf:
          - $ref: '#/components/schemas/MacSecCapable'
          - description: Indicates whether the connection supports MAC Security (MACsec).
        portEncryptionStatus:
          allOf:
          - $ref: '#/components/schemas/PortEncryptionStatus'
          - description: <p>The MAC Security (MACsec) port link status of the connection.</p> <p>The valid values are <code>Encryption Up</code>, which means that there is an active Connection Key Name, or <code>Encryption Down</code>.</p>
        encryptionMode:
          allOf:
          - $ref: '#/components/schemas/EncryptionMode'
          - description: <p>The MAC Security (MACsec) connection encryption mode.</p> <p>The valid values are <code>no_encrypt</code>, <code>should_encrypt</code>, and <code>must_encrypt</code>.</p>
        macSecKeys:
          allOf:
          - $ref: '#/components/schemas/MacSecKeyList'
          - description: The MAC Security (MACsec) security keys associated with the connection.
      description: Information about an Direct Connect connection.
    State:
      type: string
    ConnectionId:
      type: string
    SecretARN:
      type: string
    ProviderName:
      type: string
    VLAN:
      type: integer
    TagList:
      type: array
      items:
        $ref: '#/components/schemas/Tag'
      minItems: 1
    Ckn:
      type: string
    ConnectionState:
      type: string
      enum:
      - ordering
      - requested
      - pending
      - available
      - down
      - deleting
      - deleted
      - rejected
      - unknown
    StartOnDate:
      type: string
    Region:
      type: string
    MacSecKey:
      type: object
      properties:
        secretARN:
          allOf:
          - $ref: '#/components/schemas/SecretARN'
          - description: The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
        ckn:
          allOf:
          - $ref: '#/components/schemas/Ckn'
          - description: The Connection Key Name (CKN) for the MAC Security secret key.
        state:
          allOf:
          - $ref: '#/components/schemas/State'
          - description: '<p>The state of the MAC Security (MACsec) secret key.</p> <p>The possible values are:</p> <ul> <li> <p> <code>associating</code>: The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.</p> </li> <li> <p> <code>associated</code>: The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.</p> </li> <li> <p> <code>disassociating</code>: The MAC Security (MACsec) secret key is being disassociated from the connection or LAG</p> </li> <li> <p> <code>disassociated</code>: The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.</p> </li> </ul>'
        startOn:
          allOf:
          - $ref: '#/components/schemas/StartOnDate'
          - description: The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.
      description: Information about the MAC Security (MACsec) secret key.
    PortEncryptionStatus:
      type: string
    PartnerName:
      type: string
    TagValue:
      type: string
      pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$
      minLength: 0
      maxLength: 256
    ConnectionList:
      type: array
      items:
        $ref: '#/components/schemas/Connection'
  parameters:
    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-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      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-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