openapi: 3.2.0 info: version: 2012-10-25 x-release: v4 title: AWS Direct Connect API description: Direct Connect links your internal network to an Direct Connect location over a standard Ethernet fiber-optic cable. 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: AWS Direct Connect paths: /#X-Amz-Target=OvertureService.AcceptDirectConnectGatewayAssociationProposal: 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: AcceptDirectConnectGatewayAssociationProposal description: Accepts a proposal request to attach a virtual private gateway or transit gateway to a Direct Connect gateway. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AcceptDirectConnectGatewayAssociationProposalResult' '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/AcceptDirectConnectGatewayAssociationProposalRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.AcceptDirectConnectGatewayAssociationProposal tags: - AWS Direct Connect summary: Accept direct connect gateway association proposal x-summary-source: derived /#X-Amz-Target=OvertureService.AllocateConnectionOnInterconnect: 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: deprecated: true operationId: AllocateConnectionOnInterconnect description: 'Deprecated. Use AllocateHostedConnection instead. Creates a hosted connection on an interconnect. Allocates a VLAN number and a specified amount of bandwidth for use by a hosted connection on the specified interconnect. Intended for use by Direct Connect Partners only.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Connection' '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/AllocateConnectionOnInterconnectRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.AllocateConnectionOnInterconnect tags: - AWS Direct Connect summary: Allocate connection on interconnect x-summary-source: derived /#X-Amz-Target=OvertureService.AllocateHostedConnection: 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: AllocateHostedConnection description: 'Creates a hosted connection on the specified interconnect or a link aggregation group (LAG) of interconnects. Allocates a VLAN number and a specified amount of capacity (bandwidth) for use by a hosted connection on the specified interconnect or LAG of interconnects. Amazon Web Services polices the hosted connection for the specified capacity and the Direct Connect Partner must also police the hosted connection for the specified capacity. Intended for use by Direct Connect Partners only.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Connection' '480': description: DuplicateTagKeysException content: application/json: schema: $ref: '#/components/schemas/DuplicateTagKeysException' '481': description: TooManyTagsException content: application/json: schema: $ref: '#/components/schemas/TooManyTagsException' '482': description: DirectConnectServerException content: application/json: schema: $ref: '#/components/schemas/DirectConnectServerException' '483': description: DirectConnectClientException content: application/json: schema: $ref: '#/components/schemas/DirectConnectClientException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AllocateHostedConnectionRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.AllocateHostedConnection tags: - AWS Direct Connect summary: Allocate hosted connection x-summary-source: derived /#X-Amz-Target=OvertureService.AllocatePrivateVirtualInterface: 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: AllocatePrivateVirtualInterface description: 'Provisions a private virtual interface to be owned by the specified Amazon Web Services account. Virtual interfaces created using this action must be confirmed by the owner using ConfirmPrivateVirtualInterface. Until then, the virtual interface is in the Confirming state and is not available to handle traffic.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/VirtualInterface' '480': description: DuplicateTagKeysException content: application/json: schema: $ref: '#/components/schemas/DuplicateTagKeysException' '481': description: TooManyTagsException content: application/json: schema: $ref: '#/components/schemas/TooManyTagsException' '482': description: DirectConnectServerException content: application/json: schema: $ref: '#/components/schemas/DirectConnectServerException' '483': description: DirectConnectClientException content: application/json: schema: $ref: '#/components/schemas/DirectConnectClientException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AllocatePrivateVirtualInterfaceRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.AllocatePrivateVirtualInterface tags: - AWS Direct Connect summary: Allocate private virtual interface x-summary-source: derived /#X-Amz-Target=OvertureService.AllocatePublicVirtualInterface: 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: AllocatePublicVirtualInterface description: 'Provisions a public virtual interface to be owned by the specified Amazon Web Services account. The owner of a connection calls this function to provision a public virtual interface to be owned by the specified Amazon Web Services account. Virtual interfaces created using this function must be confirmed by the owner using ConfirmPublicVirtualInterface. Until this step has been completed, the virtual interface is in the confirming state and is not available to handle traffic. When creating an IPv6 public virtual interface, omit the Amazon address and customer address. IPv6 addresses are automatically assigned from the Amazon pool of IPv6 addresses; you cannot specify custom IPv6 addresses.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/VirtualInterface' '480': description: DuplicateTagKeysException content: application/json: schema: $ref: '#/components/schemas/DuplicateTagKeysException' '481': description: TooManyTagsException content: application/json: schema: $ref: '#/components/schemas/TooManyTagsException' '482': description: DirectConnectServerException content: application/json: schema: $ref: '#/components/schemas/DirectConnectServerException' '483': description: DirectConnectClientException content: application/json: schema: $ref: '#/components/schemas/DirectConnectClientException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AllocatePublicVirtualInterfaceRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.AllocatePublicVirtualInterface tags: - AWS Direct Connect summary: Allocate public virtual interface x-summary-source: derived /#X-Amz-Target=OvertureService.AllocateTransitVirtualInterface: 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: AllocateTransitVirtualInterface description: 'Provisions a transit virtual interface to be owned by the specified Amazon Web Services account. Use this type of interface to connect a transit gateway to your Direct Connect gateway. The owner of a connection provisions a transit virtual interface to be owned by the specified Amazon Web Services account. After you create a transit virtual interface, it must be confirmed by the owner using ConfirmTransitVirtualInterface. Until this step has been completed, the transit virtual interface is in the requested state and is not available to handle traffic.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AllocateTransitVirtualInterfaceResult' '480': description: DuplicateTagKeysException content: application/json: schema: $ref: '#/components/schemas/DuplicateTagKeysException' '481': description: TooManyTagsException content: application/json: schema: $ref: '#/components/schemas/TooManyTagsException' '482': description: DirectConnectServerException content: application/json: schema: $ref: '#/components/schemas/DirectConnectServerException' '483': description: DirectConnectClientException content: application/json: schema: $ref: '#/components/schemas/DirectConnectClientException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AllocateTransitVirtualInterfaceRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.AllocateTransitVirtualInterface tags: - AWS Direct Connect summary: Allocate transit virtual interface x-summary-source: derived /#X-Amz-Target=OvertureService.AssociateConnectionWithLag: 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: AssociateConnectionWithLag description: 'Associates an existing connection with a link aggregation group (LAG). The connection is interrupted and re-established as a member of the LAG (connectivity to Amazon Web Services is interrupted). The connection must be hosted on the same Direct Connect endpoint as the LAG, and its bandwidth must match the bandwidth for the LAG. You can re-associate a connection that''s currently associated with a different LAG; however, if removing the connection would cause the original LAG to fall below its setting for minimum number of operational connections, the request fails. Any virtual interfaces that are directly associated with the connection are automatically re-associated with the LAG. If the connection was originally associated with a different LAG, the virtual interfaces remain associated with the original LAG. For interconnects, any hosted connections are automatically re-associated with the LAG. If the interconnect was originally associated with a different LAG, the hosted connections remain associated with the original LAG.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Connection' '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/AssociateConnectionWithLagRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.AssociateConnectionWithLag tags: - AWS Direct Connect summary: Associate connection with lag x-summary-source: derived /#X-Amz-Target=OvertureService.AssociateHostedConnection: 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: AssociateHostedConnection description: 'Associates a hosted connection and its virtual interfaces with a link aggregation group (LAG) or interconnect. If the target interconnect or LAG has an existing hosted connection with a conflicting VLAN number or IP address, the operation fails. This action temporarily interrupts the hosted connection''s connectivity to Amazon Web Services as it is being migrated. Intended for use by Direct Connect Partners only.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Connection' '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/AssociateHostedConnectionRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.AssociateHostedConnection tags: - AWS Direct Connect summary: Associate hosted connection x-summary-source: derived /#X-Amz-Target=OvertureService.AssociateMacSecKey: 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: AssociateMacSecKey description: 'Associates a MAC Security (MACsec) Connection Key Name (CKN)/ Connectivity Association Key (CAK) pair with an Direct Connect dedicated connection. You must supply either the secretARN, or the CKN/CAK (ckn and cak) pair in the request. For information about MAC Security (MACsec) key considerations, see MACsec pre-shared CKN/CAK key considerations in the Direct Connect User Guide.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AssociateMacSecKeyResponse' '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/AssociateMacSecKeyRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.AssociateMacSecKey tags: - AWS Direct Connect summary: Associate mac sec key x-summary-source: derived /#X-Amz-Target=OvertureService.AssociateVirtualInterface: 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: AssociateVirtualInterface description: 'Associates a virtual interface with a specified link aggregation group (LAG) or connection. Connectivity to Amazon Web Services is temporarily interrupted as the virtual interface is being migrated. If the target connection or LAG has an associated virtual interface with a conflicting VLAN number or a conflicting IP address, the operation fails. Virtual interfaces associated with a hosted connection cannot be associated with a LAG; hosted connections must be migrated along with their virtual interfaces using AssociateHostedConnection. To reassociate a virtual interface to a new connection or LAG, the requester must own either the virtual interface itself or the connection to which the virtual interface is currently associated. Additionally, the requester must own the connection or LAG for the association.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/VirtualInterface' '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/AssociateVirtualInterfaceRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.AssociateVirtualInterface tags: - AWS Direct Connect summary: Associate virtual interface x-summary-source: derived /#X-Amz-Target=OvertureService.ConfirmConnection: 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: ConfirmConnection description: 'Confirms the creation of the specified hosted connection on an interconnect. Upon creation, the hosted connection is initially in the Ordering state, and remains in this state until the owner confirms creation of the hosted connection.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ConfirmConnectionResponse' '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/ConfirmConnectionRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.ConfirmConnection tags: - AWS Direct Connect summary: Confirm connection x-summary-source: derived /#X-Amz-Target=OvertureService.ConfirmCustomerAgreement: 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: ConfirmCustomerAgreement description: The confirmation of the terms of agreement when creating the connection/link aggregation group (LAG). responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ConfirmCustomerAgreementResponse' '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/ConfirmCustomerAgreementRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.ConfirmCustomerAgreement tags: - AWS Direct Connect summary: Confirm customer agreement x-summary-source: derived /#X-Amz-Target=OvertureService.ConfirmPrivateVirtualInterface: 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: ConfirmPrivateVirtualInterface description: 'Accepts ownership of a private virtual interface created by another Amazon Web Services account. After the virtual interface owner makes this call, the virtual interface is created and attached to the specified virtual private gateway or Direct Connect gateway, and is made available to handle traffic.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ConfirmPrivateVirtualInterfaceResponse' '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/ConfirmPrivateVirtualInterfaceRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.ConfirmPrivateVirtualInterface tags: - AWS Direct Connect summary: Confirm private virtual interface x-summary-source: derived /#X-Amz-Target=OvertureService.ConfirmPublicVirtualInterface: 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: ConfirmPublicVirtualInterface description: 'Accepts ownership of a public virtual interface created by another Amazon Web Services account. After the virtual interface owner makes this call, the specified virtual interface is created and made available to handle traffic.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ConfirmPublicVirtualInterfaceResponse' '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/ConfirmPublicVirtualInterfaceRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.ConfirmPublicVirtualInterface tags: - AWS Direct Connect summary: Confirm public virtual interface x-summary-source: derived /#X-Amz-Target=OvertureService.ConfirmTransitVirtualInterface: 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: ConfirmTransitVirtualInterface description: 'Accepts ownership of a transit virtual interface created by another Amazon Web Services account. After the owner of the transit virtual interface makes this call, the specified transit virtual interface is created and made available to handle traffic.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ConfirmTransitVirtualInterfaceResponse' '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/ConfirmTransitVirtualInterfaceRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.ConfirmTransitVirtualInterface tags: - AWS Direct Connect summary: Confirm transit virtual interface x-summary-source: derived /#X-Amz-Target=OvertureService.CreateBGPPeer: 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: CreateBGPPeer description: 'Creates a BGP peer on the specified virtual interface. You must create a BGP peer for the corresponding address family (IPv4/IPv6) in order to access Amazon Web Services resources that also use that address family. If logical redundancy is not supported by the connection, interconnect, or LAG, the BGP peer cannot be in the same address family as an existing BGP peer on the virtual interface. When creating a IPv6 BGP peer, omit the Amazon address and customer address. IPv6 addresses are automatically assigned from the Amazon pool of IPv6 addresses; you cannot specify custom IPv6 addresses. If you let Amazon Web Services auto-assign IPv4 addresses, a /30 CIDR will be allocated from 169.254.0.0/16. Amazon Web Services does not recommend this option if you intend to use the customer router peer IP address as the source and destination for traffic. Instead you should use RFC 1918 or other addressing, and specify the address yourself. For more information about RFC 1918 see Address Allocation for Private Internets. For a public virtual interface, the Autonomous System Number (ASN) must be private or already on the allow list for the virtual interface.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateBGPPeerResponse' '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/CreateBGPPeerRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.CreateBGPPeer tags: - AWS Direct Connect summary: Create BGP peer x-summary-source: derived /#X-Amz-Target=OvertureService.CreateConnection: 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: CreateConnection description: 'Creates a connection between a customer network and a specific Direct Connect location. A connection 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. To find the locations for your Region, use DescribeLocations. You can automatically add the new connection to a link aggregation group (LAG) by specifying a LAG ID in the request. This ensures that the new connection is allocated on the same Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request fails and no connection is created.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Connection' '480': description: DuplicateTagKeysException content: application/json: schema: $ref: '#/components/schemas/DuplicateTagKeysException' '481': description: TooManyTagsException content: application/json: schema: $ref: '#/components/schemas/TooManyTagsException' '482': description: DirectConnectServerException content: application/json: schema: $ref: '#/components/schemas/DirectConnectServerException' '483': description: DirectConnectClientException content: application/json: schema: $ref: '#/components/schemas/DirectConnectClientException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateConnectionRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.CreateConnection tags: - AWS Direct Connect summary: Create connection x-summary-source: derived /#X-Amz-Target=OvertureService.CreateDirectConnectGateway: 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: CreateDirectConnectGateway description: Creates a Direct Connect gateway, which is an intermediate object that enables you to connect a set of virtual interfaces and virtual private gateways. A Direct Connect gateway is global and visible in any Amazon Web Services Region after it is created. The virtual interfaces and virtual private gateways that are connected through a Direct Connect gateway can be in different Amazon Web Services Regions. This enables you to connect to a VPC in any Region, regardless of the Region in which the virtual interfaces are located, and pass traffic between them. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateDirectConnectGatewayResult' '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/CreateDirectConnectGatewayRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.CreateDirectConnectGateway tags: - AWS Direct Connect summary: Create direct connect gateway x-summary-source: derived /#X-Amz-Target=OvertureService.CreateDirectConnectGatewayAssociation: 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: CreateDirectConnectGatewayAssociation description: Creates an association between a Direct Connect gateway and a virtual private gateway. The virtual private gateway must be attached to a VPC and must not be associated with another Direct Connect gateway. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateDirectConnectGatewayAssociationResult' '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/CreateDirectConnectGatewayAssociationRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.CreateDirectConnectGatewayAssociation tags: - AWS Direct Connect summary: Create direct connect gateway association x-summary-source: derived /#X-Amz-Target=OvertureService.CreateDirectConnectGatewayAssociationProposal: 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: CreateDirectConnectGatewayAssociationProposal description: 'Creates a proposal to associate the specified virtual private gateway or transit gateway with the specified Direct Connect gateway. You can associate a Direct Connect gateway and virtual private gateway or transit gateway that is owned by any Amazon Web Services account.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateDirectConnectGatewayAssociationProposalResult' '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/CreateDirectConnectGatewayAssociationProposalRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.CreateDirectConnectGatewayAssociationProposal tags: - AWS Direct Connect summary: Create direct connect gateway association proposal x-summary-source: derived /#X-Amz-Target=OvertureService.CreateInterconnect: 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: CreateInterconnect description: 'Creates an interconnect between an Direct Connect Partner''s network and a specific Direct Connect location. An interconnect is a connection that is capable of hosting other connections. The Direct Connect Partner can use an interconnect to provide Direct Connect hosted connections to customers through their own network services. Like a standard connection, an interconnect links the partner''s network to an Direct Connect location over a standard Ethernet fiber-optic cable. One end is connected to the partner''s router, the other to an Direct Connect router. You can automatically add the new interconnect to a link aggregation group (LAG) by specifying a LAG ID in the request. This ensures that the new interconnect is allocated on the same Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request fails and no interconnect is created. For each end customer, the Direct Connect Partner provisions a connection on their interconnect by calling AllocateHostedConnection. The end customer can then connect to Amazon Web Services resources by creating a virtual interface on their connection, using the VLAN assigned to them by the Direct Connect Partner. Intended for use by Direct Connect Partners only.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Interconnect' '480': description: DuplicateTagKeysException content: application/json: schema: $ref: '#/components/schemas/DuplicateTagKeysException' '481': description: TooManyTagsException content: application/json: schema: $ref: '#/components/schemas/TooManyTagsException' '482': description: DirectConnectServerException content: application/json: schema: $ref: '#/components/schemas/DirectConnectServerException' '483': description: DirectConnectClientException content: application/json: schema: $ref: '#/components/schemas/DirectConnectClientException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateInterconnectRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.CreateInterconnect tags: - AWS Direct Connect summary: Create interconnect x-summary-source: derived /#X-Amz-Target=OvertureService.CreateLag: 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: CreateLag description: 'Creates a link aggregation group (LAG) with the specified number of bundled physical dedicated connections between the customer network and a specific Direct Connect location. A LAG is a logical interface that uses the Link Aggregation Control Protocol (LACP) to aggregate multiple interfaces, enabling you to treat them as a single interface. All connections in a LAG must use the same bandwidth (either 1Gbps or 10Gbps) and must terminate at the same Direct Connect endpoint. You can have up to 10 dedicated connections per LAG. Regardless of this limit, if you request more connections for the LAG than Direct Connect can allocate on a single endpoint, no LAG is created. You can specify an existing physical dedicated connection or interconnect to include in the LAG (which counts towards the total number of connections). Doing so interrupts the current physical dedicated connection, and re-establishes them as a member of the LAG. The LAG will be created on the same Direct Connect endpoint to which the dedicated connection terminates. Any virtual interfaces associated with the dedicated connection are automatically disassociated and re-associated with the LAG. The connection ID does not change. If the Amazon Web Services account used to create a LAG is a registered Direct Connect Partner, the LAG is automatically enabled to host sub-connections. For a LAG owned by a partner, any associated virtual interfaces cannot be directly configured.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Lag' '480': description: DuplicateTagKeysException content: application/json: schema: $ref: '#/components/schemas/DuplicateTagKeysException' '481': description: TooManyTagsException content: application/json: schema: $ref: '#/components/schemas/TooManyTagsException' '482': description: DirectConnectServerException content: application/json: schema: $ref: '#/components/schemas/DirectConnectServerException' '483': description: DirectConnectClientException content: application/json: schema: $ref: '#/components/schemas/DirectConnectClientException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateLagRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.CreateLag tags: - AWS Direct Connect summary: Create lag x-summary-source: derived /#X-Amz-Target=OvertureService.CreatePrivateVirtualInterface: 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: CreatePrivateVirtualInterface description: 'Creates a private virtual interface. A virtual interface is the VLAN that transports Direct Connect traffic. A private virtual interface can be connected to either a Direct Connect gateway or a Virtual Private Gateway (VGW). Connecting the private virtual interface to a Direct Connect gateway enables the possibility for connecting to multiple VPCs, including VPCs in different Amazon Web Services Regions. Connecting the private virtual interface to a VGW only provides access to a single VPC within the same Region. Setting the MTU of a virtual interface to 9001 (jumbo frames) can cause an update to the underlying physical connection if it wasn''t updated to support jumbo frames. Updating the connection disrupts network connectivity for all virtual interfaces associated with the connection for up to 30 seconds. To check whether your connection supports jumbo frames, call DescribeConnections. To check whether your virtual interface supports jumbo frames, call DescribeVirtualInterfaces.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/VirtualInterface' '480': description: DuplicateTagKeysException content: application/json: schema: $ref: '#/components/schemas/DuplicateTagKeysException' '481': description: TooManyTagsException content: application/json: schema: $ref: '#/components/schemas/TooManyTagsException' '482': description: DirectConnectServerException content: application/json: schema: $ref: '#/components/schemas/DirectConnectServerException' '483': description: DirectConnectClientException content: application/json: schema: $ref: '#/components/schemas/DirectConnectClientException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreatePrivateVirtualInterfaceRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.CreatePrivateVirtualInterface tags: - AWS Direct Connect summary: Create private virtual interface x-summary-source: derived /#X-Amz-Target=OvertureService.CreatePublicVirtualInterface: 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: CreatePublicVirtualInterface description: 'Creates a public virtual interface. A virtual interface is the VLAN that transports Direct Connect traffic. A public virtual interface supports sending traffic to public services of Amazon Web Services such as Amazon S3. When creating an IPv6 public virtual interface (addressFamily is ipv6), leave the customer and amazon address fields blank to use auto-assigned IPv6 space. Custom IPv6 addresses are not supported.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/VirtualInterface' '480': description: DuplicateTagKeysException content: application/json: schema: $ref: '#/components/schemas/DuplicateTagKeysException' '481': description: TooManyTagsException content: application/json: schema: $ref: '#/components/schemas/TooManyTagsException' '482': description: DirectConnectServerException content: application/json: schema: $ref: '#/components/schemas/DirectConnectServerException' '483': description: DirectConnectClientException content: application/json: schema: $ref: '#/components/schemas/DirectConnectClientException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreatePublicVirtualInterfaceRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.CreatePublicVirtualInterface tags: - AWS Direct Connect summary: Create public virtual interface x-summary-source: derived /#X-Amz-Target=OvertureService.CreateTransitVirtualInterface: 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: CreateTransitVirtualInterface description: 'Creates a transit virtual interface. A transit virtual interface should be used to access one or more transit gateways associated with Direct Connect gateways. A transit virtual interface enables the connection of multiple VPCs attached to a transit gateway to a Direct Connect gateway. If you associate your transit gateway with one or more Direct Connect gateways, the Autonomous System Number (ASN) used by the transit gateway and the Direct Connect gateway must be different. For example, if you use the default ASN 64512 for both your the transit gateway and Direct Connect gateway, the association request fails. A jumbo MTU value must be either 1500 or 8500. No other values will be accepted. Setting the MTU of a virtual interface to 8500 (jumbo frames) can cause an update to the underlying physical connection if it wasn''t updated to support jumbo frames. Updating the connection disrupts network connectivity for all virtual interfaces associated with the connection for up to 30 seconds. To check whether your connection supports jumbo frames, call DescribeConnections. To check whether your virtual interface supports jumbo frames, call DescribeVirtualInterfaces.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateTransitVirtualInterfaceResult' '480': description: DuplicateTagKeysException content: application/json: schema: $ref: '#/components/schemas/DuplicateTagKeysException' '481': description: TooManyTagsException content: application/json: schema: $ref: '#/components/schemas/TooManyTagsException' '482': description: DirectConnectServerException content: application/json: schema: $ref: '#/components/schemas/DirectConnectServerException' '483': description: DirectConnectClientException content: application/json: schema: $ref: '#/components/schemas/DirectConnectClientException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateTransitVirtualInterfaceRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.CreateTransitVirtualInterface tags: - AWS Direct Connect summary: Create transit virtual interface x-summary-source: derived /#X-Amz-Target=OvertureService.DeleteBGPPeer: 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: DeleteBGPPeer description: 'Deletes the specified BGP peer on the specified virtual interface with the specified customer address and ASN. You cannot delete the last BGP peer from a virtual interface.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteBGPPeerResponse' '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/DeleteBGPPeerRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.DeleteBGPPeer tags: - AWS Direct Connect summary: Delete BGP peer x-summary-source: derived /#X-Amz-Target=OvertureService.DeleteConnection: 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: DeleteConnection description: 'Deletes the specified connection. Deleting a connection only stops the Direct Connect port hour and data transfer charges. If you are partnering with any third parties to connect with the Direct Connect location, you must cancel your service with them separately.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Connection' '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/DeleteConnectionRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.DeleteConnection tags: - AWS Direct Connect summary: Delete connection x-summary-source: derived /#X-Amz-Target=OvertureService.DeleteDirectConnectGateway: 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: DeleteDirectConnectGateway description: Deletes the specified Direct Connect gateway. You must first delete all virtual interfaces that are attached to the Direct Connect gateway and disassociate all virtual private gateways associated with the Direct Connect gateway. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteDirectConnectGatewayResult' '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/DeleteDirectConnectGatewayRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.DeleteDirectConnectGateway tags: - AWS Direct Connect summary: Delete direct connect gateway x-summary-source: derived /#X-Amz-Target=OvertureService.DeleteDirectConnectGatewayAssociation: 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: DeleteDirectConnectGatewayAssociation description: 'Deletes the association between the specified Direct Connect gateway and virtual private gateway. We recommend that you specify the associationID to delete the association. Alternatively, if you own virtual gateway and a Direct Connect gateway association, you can specify the virtualGatewayId and directConnectGatewayId to delete an association.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteDirectConnectGatewayAssociationResult' '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/DeleteDirectConnectGatewayAssociationRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.DeleteDirectConnectGatewayAssociation tags: - AWS Direct Connect summary: Delete direct connect gateway association x-summary-source: derived /#X-Amz-Target=OvertureService.DeleteDirectConnectGatewayAssociationProposal: 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: DeleteDirectConnectGatewayAssociationProposal description: Deletes the association proposal request between the specified Direct Connect gateway and virtual private gateway or transit gateway. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteDirectConnectGatewayAssociationProposalResult' '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/DeleteDirectConnectGatewayAssociationProposalRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.DeleteDirectConnectGatewayAssociationProposal tags: - AWS Direct Connect summary: Delete direct connect gateway association proposal x-summary-source: derived /#X-Amz-Target=OvertureService.DeleteInterconnect: 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: DeleteInterconnect description: 'Deletes the specified interconnect. Intended for use by Direct Connect Partners only.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteInterconnectResponse' '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/DeleteInterconnectRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.DeleteInterconnect tags: - AWS Direct Connect summary: Delete interconnect x-summary-source: derived /#X-Amz-Target=OvertureService.DeleteLag: 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: DeleteLag description: Deletes the specified link aggregation group (LAG). You cannot delete a LAG if it has active virtual interfaces or hosted connections. 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/DeleteLagRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.DeleteLag tags: - AWS Direct Connect summary: Delete lag x-summary-source: derived /#X-Amz-Target=OvertureService.DeleteVirtualInterface: 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: DeleteVirtualInterface description: Deletes a virtual interface. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteVirtualInterfaceResponse' '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/DeleteVirtualInterfaceRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.DeleteVirtualInterface tags: - AWS Direct Connect summary: Delete virtual interface x-summary-source: derived /#X-Amz-Target=OvertureService.DescribeConnectionLoa: 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: deprecated: true operationId: DescribeConnectionLoa description: 'Deprecated. Use DescribeLoa instead. Gets the LOA-CFA for a connection. The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that your APN partner or service provider uses when establishing your cross connect to Amazon Web Services at the colocation facility. For more information, see Requesting Cross Connects at Direct Connect Locations in the Direct Connect User Guide.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeConnectionLoaResponse' '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/DescribeConnectionLoaRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.DescribeConnectionLoa tags: - AWS Direct Connect summary: Describe connection loa x-summary-source: derived /#X-Amz-Target=OvertureService.DescribeConnections: 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: DescribeConnections description: Displays the specified connection or all connections in this Region. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Connections' '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/DescribeConnectionsRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.DescribeConnections tags: - AWS Direct Connect summary: Describe connections x-summary-source: derived /#X-Amz-Target=OvertureService.DescribeConnectionsOnInterconnect: 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: deprecated: true operationId: DescribeConnectionsOnInterconnect description: 'Deprecated. Use DescribeHostedConnections instead. Lists the connections that have been provisioned on the specified interconnect. Intended for use by Direct Connect Partners only.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Connections' '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/DescribeConnectionsOnInterconnectRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.DescribeConnectionsOnInterconnect tags: - AWS Direct Connect summary: Describe connections on interconnect x-summary-source: derived /#X-Amz-Target=OvertureService.DescribeCustomerMetadata: 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: DescribeCustomerMetadata description: Get and view a list of customer agreements, along with their signed status and whether the customer is an NNIPartner, NNIPartnerV2, or a nonPartner. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeCustomerMetadataResponse' '480': description: DirectConnectServerException content: application/json: schema: $ref: '#/components/schemas/DirectConnectServerException' '481': description: DirectConnectClientException content: application/json: schema: $ref: '#/components/schemas/DirectConnectClientException' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.DescribeCustomerMetadata tags: - AWS Direct Connect summary: Describe customer metadata x-summary-source: derived /#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: - AWS Direct Connect summary: Describe direct connect gateway association proposals x-summary-source: derived /#X-Amz-Target=OvertureService.DescribeDirectConnectGatewayAssociations: 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: DescribeDirectConnectGatewayAssociations description: 'Lists the associations between your Direct Connect gateways and virtual private gateways and transit gateways. You must specify one of the following: A Direct Connect gateway The response contains all virtual private gateways and transit gateways associated with the Direct Connect gateway. A virtual private gateway The response contains the Direct Connect gateway. A transit gateway The response contains the Direct Connect gateway. A Direct Connect gateway and a virtual private gateway The response contains the association between the Direct Connect gateway and virtual private gateway. A Direct Connect gateway and a transit gateway The response contains the association between the Direct Connect gateway and transit gateway.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeDirectConnectGatewayAssociationsResult' '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/DescribeDirectConnectGatewayAssociationsRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.DescribeDirectConnectGatewayAssociations tags: - AWS Direct Connect summary: Describe direct connect gateway associations x-summary-source: derived /#X-Amz-Target=OvertureService.DescribeDirectConnectGatewayAttachments: 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: DescribeDirectConnectGatewayAttachments description: Lists the attachments between your Direct Connect gateways and virtual interfaces. You must specify a Direct Connect gateway, a virtual interface, or both. If you specify a Direct Connect gateway, the response contains all virtual interfaces attached to the Direct Connect gateway. If you specify a virtual interface, the response contains all Direct Connect gateways attached to the virtual interface. If you specify both, the response contains the attachment between the Direct Connect gateway and the virtual interface. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeDirectConnectGatewayAttachmentsResult' '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/DescribeDirectConnectGatewayAttachmentsRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.DescribeDirectConnectGatewayAttachments tags: - AWS Direct Connect summary: Describe direct connect gateway attachments x-summary-source: derived /#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: - AWS Direct Connect summary: Describe direct connect gateways x-summary-source: derived /#X-Amz-Target=OvertureService.DescribeHostedConnections: 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: DescribeHostedConnections description: 'Lists the hosted connections that have been provisioned on the specified interconnect or link aggregation group (LAG). Intended for use by Direct Connect Partners only.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Connections' '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/DescribeHostedConnectionsRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.DescribeHostedConnections tags: - AWS Direct Connect summary: Describe hosted connections x-summary-source: derived /#X-Amz-Target=OvertureService.DescribeInterconnectLoa: 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: deprecated: true operationId: DescribeInterconnectLoa description: 'Deprecated. Use DescribeLoa instead. Gets the LOA-CFA for the specified interconnect. The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to Amazon Web Services at the colocation facility. For more information, see Requesting Cross Connects at Direct Connect Locations in the Direct Connect User Guide.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeInterconnectLoaResponse' '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/DescribeInterconnectLoaRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.DescribeInterconnectLoa tags: - AWS Direct Connect summary: Describe interconnect loa x-summary-source: derived /#X-Amz-Target=OvertureService.DescribeInterconnects: 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: DescribeInterconnects description: Lists the interconnects owned by the Amazon Web Services account or only the specified interconnect. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Interconnects' '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/DescribeInterconnectsRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.DescribeInterconnects tags: - AWS Direct Connect summary: Describe interconnects x-summary-source: derived /#X-Amz-Target=OvertureService.DescribeLags: 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: DescribeLags description: Describes all your link aggregation groups (LAG) or the specified LAG. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Lags' '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/DescribeLagsRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.DescribeLags tags: - AWS Direct Connect summary: Describe lags x-summary-source: derived /#X-Amz-Target=OvertureService.DescribeLoa: 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: DescribeLoa description: 'Gets the LOA-CFA for a connection, interconnect, or link aggregation group (LAG). The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to Amazon Web Services at the colocation facility. For more information, see Requesting Cross Connects at Direct Connect Locations in the Direct Connect User Guide.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Loa' '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/DescribeLoaRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.DescribeLoa tags: - AWS Direct Connect summary: Describe loa x-summary-source: derived /#X-Amz-Target=OvertureService.DescribeLocations: 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: DescribeLocations description: Lists the Direct Connect locations in the current Amazon Web Services Region. These are the locations that can be selected when calling CreateConnection or CreateInterconnect. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Locations' '480': description: DirectConnectServerException content: application/json: schema: $ref: '#/components/schemas/DirectConnectServerException' '481': description: DirectConnectClientException content: application/json: schema: $ref: '#/components/schemas/DirectConnectClientException' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.DescribeLocations tags: - AWS Direct Connect summary: Describe locations x-summary-source: derived /#X-Amz-Target=OvertureService.DescribeRouterConfiguration: 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: DescribeRouterConfiguration description: Details about the router. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeRouterConfigurationResponse' '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/DescribeRouterConfigurationRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.DescribeRouterConfiguration tags: - AWS Direct Connect summary: Describe router configuration x-summary-source: derived /#X-Amz-Target=OvertureService.DescribeTags: 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: DescribeTags description: Describes the tags associated with the specified Direct Connect resources. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeTagsResponse' '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/DescribeTagsRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.DescribeTags tags: - AWS Direct Connect summary: Describe tags x-summary-source: derived /#X-Amz-Target=OvertureService.DescribeVirtualGateways: 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: DescribeVirtualGateways description: 'Lists the virtual private gateways owned by the Amazon Web Services account. You can create one or more Direct Connect private virtual interfaces linked to a virtual private gateway.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/VirtualGateways' '480': description: DirectConnectServerException content: application/json: schema: $ref: '#/components/schemas/DirectConnectServerException' '481': description: DirectConnectClientException content: application/json: schema: $ref: '#/components/schemas/DirectConnectClientException' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.DescribeVirtualGateways tags: - AWS Direct Connect summary: Describe virtual gateways x-summary-source: derived /#X-Amz-Target=OvertureService.DescribeVirtualInterfaces: 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: DescribeVirtualInterfaces description: 'Displays all virtual interfaces for an Amazon Web Services account. Virtual interfaces deleted fewer than 15 minutes before you make the request are also returned. If you specify a connection ID, only the virtual interfaces associated with the connection are returned. If you specify a virtual interface ID, then only a single virtual interface is returned. A virtual interface (VLAN) transmits the traffic between the Direct Connect location and the customer network.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/VirtualInterfaces' '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/DescribeVirtualInterfacesRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.DescribeVirtualInterfaces tags: - AWS Direct Connect summary: Describe virtual interfaces x-summary-source: derived /#X-Amz-Target=OvertureService.DisassociateConnectionFromLag: 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: DisassociateConnectionFromLag description: 'Disassociates a connection from a link aggregation group (LAG). The connection is interrupted and re-established as a standalone connection (the connection is not deleted; to delete the connection, use the DeleteConnection request). If the LAG has associated virtual interfaces or hosted connections, they remain associated with the LAG. A disassociated connection owned by an Direct Connect Partner is automatically converted to an interconnect. If disassociating the connection would cause the LAG to fall below its setting for minimum number of operational connections, the request fails, except when it''s the last member of the LAG. If all connections are disassociated, the LAG continues to exist as an empty LAG with no physical connections.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Connection' '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/DisassociateConnectionFromLagRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.DisassociateConnectionFromLag tags: - AWS Direct Connect summary: Disassociate connection from lag x-summary-source: derived /#X-Amz-Target=OvertureService.DisassociateMacSecKey: 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: DisassociateMacSecKey description: Removes the association between a MAC Security (MACsec) security key and an Direct Connect dedicated connection. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DisassociateMacSecKeyResponse' '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/DisassociateMacSecKeyRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.DisassociateMacSecKey tags: - AWS Direct Connect summary: Disassociate mac sec key x-summary-source: derived /#X-Amz-Target=OvertureService.ListVirtualInterfaceTestHistory: 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: ListVirtualInterfaceTestHistory description: Lists the virtual interface failover test history. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListVirtualInterfaceTestHistoryResponse' '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/ListVirtualInterfaceTestHistoryRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.ListVirtualInterfaceTestHistory tags: - AWS Direct Connect summary: List virtual interface test history x-summary-source: derived /#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: '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. You can run the test on public, private, transit, and hosted virtual interfaces. You can use ListVirtualInterfaceTestHistory to view the virtual interface test history. If you need to stop the test before the test interval completes, use StopBgpFailoverTest.' 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: - AWS Direct Connect summary: Start bgp failover test x-summary-source: derived /#X-Amz-Target=OvertureService.StopBgpFailoverTest: 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: StopBgpFailoverTest description: Stops the virtual interface failover test. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/StopBgpFailoverTestResponse' '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/StopBgpFailoverTestRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.StopBgpFailoverTest tags: - AWS Direct Connect summary: Stop bgp failover test x-summary-source: derived /#X-Amz-Target=OvertureService.TagResource: 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: TagResource description: 'Adds the specified tags to the specified Direct Connect resource. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. If a tag with the same key is already associated with the resource, this action updates its value.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/TagResourceResponse' '480': description: DuplicateTagKeysException content: application/json: schema: $ref: '#/components/schemas/DuplicateTagKeysException' '481': description: TooManyTagsException content: application/json: schema: $ref: '#/components/schemas/TooManyTagsException' '482': description: DirectConnectServerException content: application/json: schema: $ref: '#/components/schemas/DirectConnectServerException' '483': description: DirectConnectClientException content: application/json: schema: $ref: '#/components/schemas/DirectConnectClientException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TagResourceRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.TagResource tags: - AWS Direct Connect summary: Tag resource x-summary-source: derived /#X-Amz-Target=OvertureService.UntagResource: 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: UntagResource description: Removes one or more tags from the specified Direct Connect resource. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UntagResourceResponse' '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/UntagResourceRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.UntagResource tags: - AWS Direct Connect summary: Untag resource x-summary-source: derived /#X-Amz-Target=OvertureService.UpdateConnection: 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: UpdateConnection description: 'Updates the Direct Connect dedicated connection configuration. You can update the following parameters for a connection: The connection name The connection''s MAC Security (MACsec) encryption mode.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Connection' '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/UpdateConnectionRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.UpdateConnection tags: - AWS Direct Connect summary: Update connection x-summary-source: derived /#X-Amz-Target=OvertureService.UpdateDirectConnectGateway: 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: UpdateDirectConnectGateway description: Updates the name of a current Direct Connect gateway. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateDirectConnectGatewayResponse' '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/UpdateDirectConnectGatewayRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.UpdateDirectConnectGateway tags: - AWS Direct Connect summary: Update direct connect gateway x-summary-source: derived /#X-Amz-Target=OvertureService.UpdateDirectConnectGatewayAssociation: 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: UpdateDirectConnectGatewayAssociation description: 'Updates the specified attributes of the Direct Connect gateway association. Add or remove prefixes from the association.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateDirectConnectGatewayAssociationResult' '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/UpdateDirectConnectGatewayAssociationRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.UpdateDirectConnectGatewayAssociation tags: - AWS Direct Connect summary: Update direct connect gateway association x-summary-source: derived /#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: 'Updates the attributes of the specified link aggregation group (LAG). You can update the following LAG attributes: The name of the LAG. The value for the minimum number of connections that must be operational for the LAG itself to be operational. The LAG''s MACsec encryption mode. Amazon Web Services assigns this value to each connection which is part of the LAG. The tags 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.' 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: - AWS Direct Connect summary: Update lag x-summary-source: derived /#X-Amz-Target=OvertureService.UpdateVirtualInterfaceAttributes: 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: UpdateVirtualInterfaceAttributes description: 'Updates the specified attributes of the specified virtual private interface. Setting the MTU of a virtual interface to 9001 (jumbo frames) can cause an update to the underlying physical connection if it wasn''t updated to support jumbo frames. Updating the connection disrupts network connectivity for all virtual interfaces associated with the connection for up to 30 seconds. To check whether your connection supports jumbo frames, call DescribeConnections. To check whether your virtual q interface supports jumbo frames, call DescribeVirtualInterfaces.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/VirtualInterface' '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/UpdateVirtualInterfaceAttributesRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - OvertureService.UpdateVirtualInterfaceAttributes tags: - AWS Direct Connect summary: Update virtual interface attributes x-summary-source: derived components: schemas: 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: '

The state of the proposal. The following are possible values:

' 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. ' CreateTransitVirtualInterfaceResult: type: object properties: virtualInterface: $ref: '#/components/schemas/VirtualInterface' ConfirmConnectionRequest: type: object required: - connectionId title: ConfirmConnectionRequest properties: connectionId: allOf: - $ref: '#/components/schemas/ConnectionId' - description: The ID of the hosted connection. DescribeConnectionsOnInterconnectRequest: type: object required: - interconnectId title: DescribeConnectionsOnInterconnectRequest properties: interconnectId: allOf: - $ref: '#/components/schemas/InterconnectId' - description: The ID of the interconnect. ConfirmCustomerAgreementRequest: type: object title: ConfirmCustomerAgreementRequest properties: agreementName: allOf: - $ref: '#/components/schemas/AgreementName' - description: ' The name of the customer agreement. ' LagName: type: string ConfirmPublicVirtualInterfaceResponse: type: object properties: virtualInterfaceState: allOf: - $ref: '#/components/schemas/VirtualInterfaceState' - description: '

The state of the virtual interface. The following are the possible values:

' ConfirmTransitVirtualInterfaceRequest: type: object required: - virtualInterfaceId - directConnectGatewayId title: ConfirmTransitVirtualInterfaceRequest properties: virtualInterfaceId: allOf: - $ref: '#/components/schemas/VirtualInterfaceId' - description: The ID of the virtual interface. directConnectGatewayId: allOf: - $ref: '#/components/schemas/DirectConnectGatewayId' - description: The ID of the Direct Connect gateway. ConfirmPublicVirtualInterfaceRequest: type: object required: - virtualInterfaceId title: ConfirmPublicVirtualInterfaceRequest properties: virtualInterfaceId: allOf: - $ref: '#/components/schemas/VirtualInterfaceId' - description: The ID of the virtual interface. LagState: type: string enum: - requested - pending - available - down - deleting - deleted - unknown Region: type: string DeleteDirectConnectGatewayAssociationProposalResult: type: object properties: directConnectGatewayAssociationProposal: allOf: - $ref: '#/components/schemas/DirectConnectGatewayAssociationProposal' - description: The ID of the associated gateway. AssociateVirtualInterfaceRequest: type: object required: - virtualInterfaceId - connectionId title: AssociateVirtualInterfaceRequest properties: virtualInterfaceId: allOf: - $ref: '#/components/schemas/VirtualInterfaceId' - description: The ID of the virtual interface. connectionId: allOf: - $ref: '#/components/schemas/ConnectionId' - description: The ID of the LAG or connection. CustomerAgreement: type: object properties: agreementName: allOf: - $ref: '#/components/schemas/AgreementName' - description: The name of the agreement. status: allOf: - $ref: '#/components/schemas/Status' - description: 'The status of the customer agreement. This will be either signed or unsigned ' description: 'The name and status of a customer agreement. ' TagValue: type: string pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$ minLength: 0 maxLength: 256 DeleteConnectionRequest: type: object required: - connectionId title: DeleteConnectionRequest properties: connectionId: allOf: - $ref: '#/components/schemas/ConnectionId' - description: The ID of the connection. RouterType: type: object properties: vendor: allOf: - $ref: '#/components/schemas/Vendor' - description: The vendor for the virtual interface's router. platform: allOf: - $ref: '#/components/schemas/Platform' - description: The virtual interface router platform. software: allOf: - $ref: '#/components/schemas/Software' - description: 'The router software. ' xsltTemplateName: allOf: - $ref: '#/components/schemas/XsltTemplateName' - description: The template for the virtual interface's router. xsltTemplateNameForMacSec: allOf: - $ref: '#/components/schemas/XsltTemplateNameForMacSec' - description: The MAC Security (MACsec) template for the virtual interface's router. routerTypeIdentifier: allOf: - $ref: '#/components/schemas/RouterTypeIdentifier' - description: Identifies the router by a combination of vendor, platform, and software version. For example, CiscoSystemsInc-2900SeriesRouters-IOS124. description: Information about the virtual router. LocationList: type: array items: $ref: '#/components/schemas/Location' UpdateDirectConnectGatewayRequest: type: object required: - directConnectGatewayId - newDirectConnectGatewayName title: UpdateDirectConnectGatewayRequest properties: directConnectGatewayId: allOf: - $ref: '#/components/schemas/DirectConnectGatewayId' - description: The ID of the Direct Connect gateway to update. newDirectConnectGatewayName: allOf: - $ref: '#/components/schemas/DirectConnectGatewayName' - description: The new name for the Direct Connect gateway. ConfirmPrivateVirtualInterfaceRequest: type: object required: - virtualInterfaceId title: ConfirmPrivateVirtualInterfaceRequest properties: virtualInterfaceId: allOf: - $ref: '#/components/schemas/VirtualInterfaceId' - description: The ID of the virtual interface. virtualGatewayId: allOf: - $ref: '#/components/schemas/VirtualGatewayId' - description: The ID of the virtual private gateway. directConnectGatewayId: allOf: - $ref: '#/components/schemas/DirectConnectGatewayId' - description: The ID of the Direct Connect gateway. DescribeDirectConnectGatewayAttachmentsRequest: type: object title: DescribeDirectConnectGatewayAttachmentsRequest properties: directConnectGatewayId: allOf: - $ref: '#/components/schemas/DirectConnectGatewayId' - description: The ID of the Direct Connect gateway. virtualInterfaceId: allOf: - $ref: '#/components/schemas/VirtualInterfaceId' - description: The ID of the virtual interface. maxResults: allOf: - $ref: '#/components/schemas/MaxResultSetSize' - 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: allOf: - $ref: '#/components/schemas/PaginationToken' - description: The token provided in the previous call to retrieve the next page. AllocatePublicVirtualInterfaceRequest: type: object required: - connectionId - ownerAccount - newPublicVirtualInterfaceAllocation title: AllocatePublicVirtualInterfaceRequest properties: connectionId: allOf: - $ref: '#/components/schemas/ConnectionId' - description: The ID of the connection on which the public virtual interface is provisioned. ownerAccount: allOf: - $ref: '#/components/schemas/OwnerAccount' - description: The ID of the Amazon Web Services account that owns the public virtual interface. newPublicVirtualInterfaceAllocation: allOf: - $ref: '#/components/schemas/NewPublicVirtualInterfaceAllocation' - description: Information about the public virtual interface. AllocateTransitVirtualInterfaceResult: type: object properties: virtualInterface: $ref: '#/components/schemas/VirtualInterface' XsltTemplateName: type: string VirtualInterfaceName: type: string Count: type: integer VirtualInterfaceId: type: string XsltTemplateNameForMacSec: type: string ResourceArn: type: string LocationName: type: string BGPAuthKey: type: string AvailableMacSecPortSpeeds: type: array items: $ref: '#/components/schemas/PortSpeed' 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:

The LAG MAC Security (MACsec) encryption mode.

Amazon Web Services applies the value to all connections which are part of the LAG.

ConfirmCustomerAgreementResponse: type: object properties: status: allOf: - $ref: '#/components/schemas/Status' - description: ' The status of the customer agreement when the connection was created. This will be either signed or unsigned. ' CreateDirectConnectGatewayRequest: type: object required: - directConnectGatewayName title: CreateDirectConnectGatewayRequest properties: 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 Border Gateway Protocol (BGP) to be configured on the Amazon side of the connection. The ASN must be in the private range of 64,512 to 65,534 or 4,200,000,000 to 4,294,967,294. The default is 64512. GatewayIdToAssociate: type: string InterconnectState: type: string enum: - requested - pending - available - down - deleting - deleted - unknown NewTransitVirtualInterface: type: object properties: virtualInterfaceName: allOf: - $ref: '#/components/schemas/VirtualInterfaceName' - description: 'The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).' vlan: allOf: - $ref: '#/components/schemas/VLAN' - description: The ID of the VLAN. asn: allOf: - $ref: '#/components/schemas/ASN' - description:

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

The valid values are 1-2147483647.

mtu: allOf: - $ref: '#/components/schemas/MTU' - description: The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500. authKey: allOf: - $ref: '#/components/schemas/BGPAuthKey' - description: The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters. amazonAddress: allOf: - $ref: '#/components/schemas/AmazonAddress' - description: The IP address assigned to the Amazon interface. customerAddress: allOf: - $ref: '#/components/schemas/CustomerAddress' - description: The IP address assigned to the customer interface. addressFamily: allOf: - $ref: '#/components/schemas/AddressFamily' - description: The address family for the BGP peer. directConnectGatewayId: allOf: - $ref: '#/components/schemas/DirectConnectGatewayId' - description: The ID of the Direct Connect gateway. tags: allOf: - $ref: '#/components/schemas/TagList' - description: The tags associated with the transitive virtual interface. enableSiteLink: allOf: - $ref: '#/components/schemas/EnableSiteLink' - description: Indicates whether to enable or disable SiteLink. description: Information about a transit virtual interface. VirtualInterfaceRegion: type: string DescribeHostedConnectionsRequest: type: object required: - connectionId title: DescribeHostedConnectionsRequest properties: connectionId: allOf: - $ref: '#/components/schemas/ConnectionId' - description: The ID of the interconnect or LAG. BGPPeerId: type: string DeleteDirectConnectGatewayAssociationResult: type: object properties: directConnectGatewayAssociation: allOf: - $ref: '#/components/schemas/DirectConnectGatewayAssociation' - description: Information about the deleted association. TagResourceRequest: type: object required: - resourceArn - tags title: TagResourceRequest properties: resourceArn: allOf: - $ref: '#/components/schemas/ResourceArn' - description: The Amazon Resource Name (ARN) of the resource. tags: allOf: - $ref: '#/components/schemas/TagList' - description: The tags to add. GatewayType: type: string enum: - virtualPrivateGateway - transitGateway AwsLogicalDeviceId: type: string 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. DescribeConnectionLoaRequest: type: object required: - connectionId title: DescribeConnectionLoaRequest properties: connectionId: allOf: - $ref: '#/components/schemas/ConnectionId' - description: The ID of the connection. providerName: allOf: - $ref: '#/components/schemas/ProviderName' - description: The name of the APN partner or service provider who establishes connectivity on your behalf. If you specify this parameter, the LOA-CFA lists the provider name alongside your company name as the requester of the cross connect. loaContentType: allOf: - $ref: '#/components/schemas/LoaContentType' - description: The standard media type for the LOA-CFA document. The only supported value is application/pdf. VirtualGatewayList: type: array items: $ref: '#/components/schemas/VirtualGateway' 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. DirectConnectGatewayAttachmentList: type: array items: $ref: '#/components/schemas/DirectConnectGatewayAttachment' DescribeLoaRequest: type: object required: - connectionId title: DescribeLoaRequest properties: connectionId: allOf: - $ref: '#/components/schemas/ConnectionId' - description: The ID of a connection, LAG, or interconnect. providerName: allOf: - $ref: '#/components/schemas/ProviderName' - description: The name of the service provider who establishes connectivity on your behalf. If you specify this parameter, the LOA-CFA lists the provider name alongside your company name as the requester of the cross connect. loaContentType: allOf: - $ref: '#/components/schemas/LoaContentType' - description: The standard media type for the LOA-CFA document. The only supported value is application/pdf. Lags: type: object properties: lags: allOf: - $ref: '#/components/schemas/LagList' - description: The LAGs. DescribeCustomerMetadataResponse: type: object properties: agreements: allOf: - $ref: '#/components/schemas/AgreementList' - description: The list of customer agreements. nniPartnerType: allOf: - $ref: '#/components/schemas/NniPartnerType' - description: '

The type of network-to-network interface (NNI) partner. The partner type will be one of the following:

' ConfirmConnectionResponse: type: object properties: connectionState: allOf: - $ref: '#/components/schemas/ConnectionState' - description: '

The state of the connection. The following are the possible values:

' AllocateHostedConnectionRequest: type: object required: - connectionId - ownerAccount - bandwidth - connectionName - vlan title: AllocateHostedConnectionRequest properties: connectionId: allOf: - $ref: '#/components/schemas/ConnectionId' - description: The ID of the interconnect or LAG. ownerAccount: allOf: - $ref: '#/components/schemas/OwnerAccount' - description: The ID of the Amazon Web Services account ID of the customer for the connection. bandwidth: allOf: - $ref: '#/components/schemas/Bandwidth' - description: 'The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note that only those Direct Connect Partners who have met specific requirements are allowed to create a 1Gbps, 2Gbps, 5Gbps or 10Gbps hosted connection. ' connectionName: allOf: - $ref: '#/components/schemas/ConnectionName' - description: The name of the hosted connection. vlan: allOf: - $ref: '#/components/schemas/VLAN' - description: The dedicated VLAN provisioned to the hosted connection. tags: allOf: - $ref: '#/components/schemas/TagList' - description: The tags associated with the connection. CreateDirectConnectGatewayAssociationProposalRequest: type: object required: - directConnectGatewayId - directConnectGatewayOwnerAccount - gatewayId title: CreateDirectConnectGatewayAssociationProposalRequest properties: 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. gatewayId: allOf: - $ref: '#/components/schemas/GatewayIdToAssociate' - description: The ID of the virtual private gateway or transit gateway. addAllowedPrefixesToDirectConnectGateway: allOf: - $ref: '#/components/schemas/RouteFilterPrefixList' - description: The Amazon VPC prefixes to advertise to the Direct Connect gateway. removeAllowedPrefixesToDirectConnectGateway: allOf: - $ref: '#/components/schemas/RouteFilterPrefixList' - description: The Amazon VPC prefixes to no longer advertise to the Direct Connect gateway. Bandwidth: type: string UpdateConnectionRequest: type: object required: - connectionId title: UpdateConnectionRequest properties: connectionId: allOf: - $ref: '#/components/schemas/ConnectionId' - description:

The ID of the dedicated connection.

You can use DescribeConnections to retrieve the connection ID.

connectionName: allOf: - $ref: '#/components/schemas/ConnectionName' - description: The name of the connection. encryptionMode: allOf: - $ref: '#/components/schemas/EncryptionMode' - description:

The connection MAC Security (MACsec) encryption mode.

The valid values are no_encrypt, should_encrypt, and must_encrypt.

StopBgpFailoverTestResponse: type: object properties: virtualInterfaceTest: allOf: - $ref: '#/components/schemas/VirtualInterfaceTestHistory' - description: Information about the virtual interface failover test. AssociatedGatewayId: type: string UntagResourceRequest: type: object required: - resourceArn - tagKeys title: UntagResourceRequest properties: resourceArn: allOf: - $ref: '#/components/schemas/ResourceArn' - description: The Amazon Resource Name (ARN) of the resource. tagKeys: allOf: - $ref: '#/components/schemas/TagKeyList' - description: The tag keys of the tags to remove. CreateBGPPeerRequest: type: object title: CreateBGPPeerRequest properties: virtualInterfaceId: allOf: - $ref: '#/components/schemas/VirtualInterfaceId' - description: The ID of the virtual interface. newBGPPeer: allOf: - $ref: '#/components/schemas/NewBGPPeer' - description: Information about the BGP peer. BGPPeerList: type: array items: $ref: '#/components/schemas/BGPPeer' VirtualInterfaceState: type: string enum: - confirming - verifying - pending - available - down - deleting - deleted - rejected - unknown UpdateVirtualInterfaceAttributesRequest: type: object required: - virtualInterfaceId title: UpdateVirtualInterfaceAttributesRequest properties: virtualInterfaceId: allOf: - $ref: '#/components/schemas/VirtualInterfaceId' - description: The ID of the virtual private interface. mtu: allOf: - $ref: '#/components/schemas/MTU' - description: The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500. enableSiteLink: allOf: - $ref: '#/components/schemas/EnableSiteLink' - description: Indicates whether to enable or disable SiteLink. virtualInterfaceName: allOf: - $ref: '#/components/schemas/VirtualInterfaceName' - description: The name of the virtual private interface. UntagResourceResponse: type: object properties: {} 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. Connections: type: object properties: connections: allOf: - $ref: '#/components/schemas/ConnectionList' - description: The connections. DescribeInterconnectsRequest: type: object title: DescribeInterconnectsRequest properties: interconnectId: allOf: - $ref: '#/components/schemas/InterconnectId' - description: The ID of the interconnect. ProviderList: type: array items: $ref: '#/components/schemas/ProviderName' AssociateMacSecKeyResponse: type: object properties: connectionId: allOf: - $ref: '#/components/schemas/ConnectionId' - description: The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx). macSecKeys: allOf: - $ref: '#/components/schemas/MacSecKeyList' - description: The MAC Security (MACsec) security keys associated with the dedicated connection. BGPPeerState: type: string enum: - verifying - pending - available - deleting - deleted TestId: type: string CreatePublicVirtualInterfaceRequest: type: object required: - connectionId - newPublicVirtualInterface title: CreatePublicVirtualInterfaceRequest properties: connectionId: allOf: - $ref: '#/components/schemas/ConnectionId' - description: The ID of the connection. newPublicVirtualInterface: allOf: - $ref: '#/components/schemas/NewPublicVirtualInterface' - description: Information about the public virtual interface. DescribeTagsResponse: type: object properties: resourceTags: allOf: - $ref: '#/components/schemas/ResourceTagList' - description: Information about the tags. VirtualInterfaceType: type: string 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:

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: allOf: - $ref: '#/components/schemas/PaginationToken' - description: The token provided in the previous call to retrieve the next page. AssociateMacSecKeyRequest: type: object required: - connectionId title: AssociateMacSecKeyRequest properties: connectionId: allOf: - $ref: '#/components/schemas/ConnectionId' - description:

The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).

You can use DescribeConnections or DescribeLags to retrieve connection ID.

secretARN: allOf: - $ref: '#/components/schemas/SecretARN' - description:

The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key to associate with the dedicated connection.

You can use DescribeConnections or DescribeLags to retrieve the MAC Security (MACsec) secret key.

If you use this request parameter, you do not use the ckn and cak request parameters.

ckn: allOf: - $ref: '#/components/schemas/Ckn' - description:

The MAC Security (MACsec) CKN to associate with the dedicated connection.

You can create the CKN/CAK pair using an industry standard tool.

The valid values are 64 hexadecimal characters (0-9, A-E).

If you use this request parameter, you must use the cak request parameter and not use the secretARN request parameter.

cak: allOf: - $ref: '#/components/schemas/Cak' - description:

The MAC Security (MACsec) CAK to associate with the dedicated connection.

You can create the CKN/CAK pair using an industry standard tool.

The valid values are 64 hexadecimal characters (0-9, A-E).

If you use this request parameter, you must use the ckn request parameter and not use the secretARN request parameter.

DuplicateTagKeysException: {} 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 null when there are no more results to return. HasLogicalRedundancy: type: string enum: - unknown - 'yes' - 'no' BGPStatus: type: string enum: - up - down - unknown InterconnectName: type: string Locations: type: object properties: locations: allOf: - $ref: '#/components/schemas/LocationList' - description: The locations. AvailablePortSpeeds: type: array items: $ref: '#/components/schemas/PortSpeed' DisassociateMacSecKeyRequest: type: object required: - connectionId - secretARN title: DisassociateMacSecKeyRequest properties: connectionId: allOf: - $ref: '#/components/schemas/ConnectionId' - description:

The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).

You can use DescribeConnections or DescribeLags to retrieve connection ID.

secretARN: allOf: - $ref: '#/components/schemas/SecretARN' - description:

The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.

You can use DescribeConnections to retrieve the ARN of the MAC Security (MACsec) secret key.

ConfirmPrivateVirtualInterfaceResponse: type: object properties: virtualInterfaceState: allOf: - $ref: '#/components/schemas/VirtualInterfaceState' - description: '

The state of the virtual interface. The following are the possible values:

' DeleteVirtualInterfaceRequest: type: object required: - virtualInterfaceId title: DeleteVirtualInterfaceRequest properties: virtualInterfaceId: allOf: - $ref: '#/components/schemas/VirtualInterfaceId' - description: The ID of the virtual interface. LoaContent: type: string RouteFilterPrefixList: type: array items: $ref: '#/components/schemas/RouteFilterPrefix' ConnectionId: type: string LagList: type: array items: $ref: '#/components/schemas/Lag' CreateDirectConnectGatewayAssociationProposalResult: type: object properties: directConnectGatewayAssociationProposal: allOf: - $ref: '#/components/schemas/DirectConnectGatewayAssociationProposal' - description: Information about the Direct Connect gateway proposal. RouterTypeIdentifier: type: string EndTime: type: string format: date-time DeleteDirectConnectGatewayAssociationRequest: type: object title: DeleteDirectConnectGatewayAssociationRequest properties: associationId: allOf: - $ref: '#/components/schemas/DirectConnectGatewayAssociationId' - description: The ID of the Direct Connect gateway association. directConnectGatewayId: allOf: - $ref: '#/components/schemas/DirectConnectGatewayId' - description: The ID of the Direct Connect gateway. virtualGatewayId: allOf: - $ref: '#/components/schemas/VirtualGatewayId' - description: The ID of the virtual private gateway. CreateInterconnectRequest: type: object required: - interconnectName - bandwidth - location title: CreateInterconnectRequest properties: interconnectName: allOf: - $ref: '#/components/schemas/InterconnectName' - description: The name of the interconnect. bandwidth: allOf: - $ref: '#/components/schemas/Bandwidth' - description: The port bandwidth, in Gbps. The possible values are 1 and 10. location: allOf: - $ref: '#/components/schemas/LocationCode' - description: The location of the interconnect. lagId: allOf: - $ref: '#/components/schemas/LagId' - description: The ID of the LAG. tags: allOf: - $ref: '#/components/schemas/TagList' - description: The tags to associate with the interconnect. providerName: allOf: - $ref: '#/components/schemas/ProviderName' - description: The name of the service provider associated with the interconnect. VirtualInterfaceTestHistoryList: type: array items: $ref: '#/components/schemas/VirtualInterfaceTestHistory' ResourceTagList: type: array items: $ref: '#/components/schemas/ResourceTag' NewBGPPeer: type: object properties: asn: allOf: - $ref: '#/components/schemas/ASN' - description: The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration. authKey: allOf: - $ref: '#/components/schemas/BGPAuthKey' - description: The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters. addressFamily: allOf: - $ref: '#/components/schemas/AddressFamily' - description: The address family for the BGP peer. amazonAddress: allOf: - $ref: '#/components/schemas/AmazonAddress' - description: The IP address assigned to the Amazon interface. customerAddress: allOf: - $ref: '#/components/schemas/CustomerAddress' - description: The IP address assigned to the customer interface. description: Information about a new BGP peer. CreateBGPPeerResponse: type: object properties: virtualInterface: allOf: - $ref: '#/components/schemas/VirtualInterface' - description: The virtual interface. CreateLagRequest: type: object required: - numberOfConnections - location - connectionsBandwidth - lagName title: CreateLagRequest properties: numberOfConnections: allOf: - $ref: '#/components/schemas/Count' - description: The number of physical dedicated connections initially provisioned and bundled by the LAG. location: allOf: - $ref: '#/components/schemas/LocationCode' - description: The location for the LAG. connectionsBandwidth: allOf: - $ref: '#/components/schemas/Bandwidth' - description: 'The bandwidth of the individual physical dedicated connections bundled by the LAG. The possible values are 1Gbps and 10Gbps. ' lagName: allOf: - $ref: '#/components/schemas/LagName' - description: The name of the LAG. connectionId: allOf: - $ref: '#/components/schemas/ConnectionId' - description: The ID of an existing dedicated connection to migrate to the LAG. tags: allOf: - $ref: '#/components/schemas/TagList' - description: The tags to associate with the LAG. childConnectionTags: allOf: - $ref: '#/components/schemas/TagList' - description: The tags to associate with the automtically created LAGs. providerName: allOf: - $ref: '#/components/schemas/ProviderName' - description: The name of the service provider associated with the LAG. requestMACSec: allOf: - $ref: '#/components/schemas/RequestMACSec' - description:

Indicates whether the connection will support MAC Security (MACsec).

All connections in the LAG must be capable of supporting MAC Security (MACsec). For information about MAC Security (MACsec) prerequisties, see MACsec prerequisties in the Direct Connect User Guide.

DirectConnectClientException: {} AcceptDirectConnectGatewayAssociationProposalResult: type: object properties: directConnectGatewayAssociation: $ref: '#/components/schemas/DirectConnectGatewayAssociation' 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: '

The state of the Direct Connect gateway. The following are the possible values:

' 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. DescribeLagsRequest: type: object title: DescribeLagsRequest properties: lagId: allOf: - $ref: '#/components/schemas/LagId' - description: The ID of the LAG. DescribeConnectionsRequest: type: object title: DescribeConnectionsRequest properties: connectionId: allOf: - $ref: '#/components/schemas/ConnectionId' - description: The ID of the connection. NniPartnerType: type: string enum: - v1 - v2 - nonPartner PartnerName: type: string RouterConfig: type: string DisassociateMacSecKeyResponse: type: object properties: connectionId: allOf: - $ref: '#/components/schemas/ConnectionId' - description: The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx). macSecKeys: allOf: - $ref: '#/components/schemas/MacSecKeyList' - description: The MAC Security (MACsec) security keys no longer associated with the dedicated connection. JumboFrameCapable: type: boolean VLAN: type: integer DirectConnectGatewayAssociationProposalList: type: array items: $ref: '#/components/schemas/DirectConnectGatewayAssociationProposal' StartOnDate: type: string DirectConnectServerException: {} DirectConnectGatewayName: 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: '

The state of the LAG. The following are the possible values:

' 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:

The LAG MAC Security (MACsec) encryption mode.

The valid values are no_encrypt, should_encrypt, and must_encrypt.

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). AllocateTransitVirtualInterfaceRequest: type: object required: - connectionId - ownerAccount - newTransitVirtualInterfaceAllocation title: AllocateTransitVirtualInterfaceRequest properties: connectionId: allOf: - $ref: '#/components/schemas/ConnectionId' - description: The ID of the connection on which the transit virtual interface is provisioned. ownerAccount: allOf: - $ref: '#/components/schemas/OwnerAccount' - description: The ID of the Amazon Web Services account that owns the transit virtual interface. newTransitVirtualInterfaceAllocation: allOf: - $ref: '#/components/schemas/NewTransitVirtualInterfaceAllocation' - description: Information about the transit virtual interface. PortEncryptionStatus: type: string DeleteBGPPeerRequest: type: object title: DeleteBGPPeerRequest properties: virtualInterfaceId: allOf: - $ref: '#/components/schemas/VirtualInterfaceId' - description: The ID of the virtual interface. asn: allOf: - $ref: '#/components/schemas/ASN' - description: The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration. customerAddress: allOf: - $ref: '#/components/schemas/CustomerAddress' - description: The IP address assigned to the customer interface. bgpPeerId: allOf: - $ref: '#/components/schemas/BGPPeerId' - description: The ID of the BGP peer. MacSecCapable: type: boolean VirtualInterfaceList: type: array items: $ref: '#/components/schemas/VirtualInterface' AssociateConnectionWithLagRequest: type: object required: - connectionId - lagId title: AssociateConnectionWithLagRequest properties: connectionId: allOf: - $ref: '#/components/schemas/ConnectionId' - description: The ID of the connection. lagId: allOf: - $ref: '#/components/schemas/LagId' - description: The ID of the LAG with which to associate the connection. UpdateDirectConnectGatewayAssociationResult: type: object properties: directConnectGatewayAssociation: $ref: '#/components/schemas/DirectConnectGatewayAssociation' DirectConnectGatewayId: type: string DescribeDirectConnectGatewayAssociationsRequest: type: object title: DescribeDirectConnectGatewayAssociationsRequest properties: associationId: allOf: - $ref: '#/components/schemas/DirectConnectGatewayAssociationId' - description: The ID of the Direct Connect gateway association. associatedGatewayId: allOf: - $ref: '#/components/schemas/AssociatedGatewayId' - description: The ID of the associated gateway. directConnectGatewayId: allOf: - $ref: '#/components/schemas/DirectConnectGatewayId' - description: The ID of the Direct Connect gateway. maxResults: allOf: - $ref: '#/components/schemas/MaxResultSetSize' - 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: allOf: - $ref: '#/components/schemas/PaginationToken' - description: The token provided in the previous call to retrieve the next page. virtualGatewayId: allOf: - $ref: '#/components/schemas/VirtualGatewayId' - description: The ID of the virtual private gateway or transit gateway. Ckn: type: string ConnectionState: type: string enum: - ordering - requested - pending - available - down - deleting - deleted - rejected - unknown CreateDirectConnectGatewayResult: type: object properties: directConnectGateway: allOf: - $ref: '#/components/schemas/DirectConnectGateway' - description: The Direct Connect gateway. NewPrivateVirtualInterface: type: object required: - virtualInterfaceName - vlan - asn properties: virtualInterfaceName: allOf: - $ref: '#/components/schemas/VirtualInterfaceName' - description: 'The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).' vlan: allOf: - $ref: '#/components/schemas/VLAN' - description: The ID of the VLAN. asn: allOf: - $ref: '#/components/schemas/ASN' - description:

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

The valid values are 1-2147483647.

mtu: allOf: - $ref: '#/components/schemas/MTU' - description: The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500. authKey: allOf: - $ref: '#/components/schemas/BGPAuthKey' - description: The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters. amazonAddress: allOf: - $ref: '#/components/schemas/AmazonAddress' - description: The IP address assigned to the Amazon interface. customerAddress: allOf: - $ref: '#/components/schemas/CustomerAddress' - description: The IP address assigned to the customer interface. addressFamily: allOf: - $ref: '#/components/schemas/AddressFamily' - description: The address family for the BGP peer. virtualGatewayId: allOf: - $ref: '#/components/schemas/VirtualGatewayId' - description: The ID of the virtual private gateway. directConnectGatewayId: allOf: - $ref: '#/components/schemas/DirectConnectGatewayId' - description: The ID of the Direct Connect gateway. tags: allOf: - $ref: '#/components/schemas/TagList' - description: The tags associated with the private virtual interface. enableSiteLink: allOf: - $ref: '#/components/schemas/EnableSiteLink' - description: Indicates whether to enable or disable SiteLink. description: Information about a private virtual interface. 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: '

The state of the MAC Security (MACsec) secret key.

The possible values are:

' 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. VirtualInterfaces: type: object properties: virtualInterfaces: allOf: - $ref: '#/components/schemas/VirtualInterfaceList' - description: The virtual interfaces OwnerAccount: type: string ProviderName: type: string VirtualGateways: type: object properties: virtualGateways: allOf: - $ref: '#/components/schemas/VirtualGatewayList' - description: The virtual private gateways. BGPPeerIdList: type: array items: $ref: '#/components/schemas/BGPPeerId' State: type: string VirtualGatewayRegion: type: string deprecated: true VirtualInterface: type: object properties: ownerAccount: allOf: - $ref: '#/components/schemas/OwnerAccount' - description: The ID of the Amazon Web Services account that owns the virtual interface. virtualInterfaceId: allOf: - $ref: '#/components/schemas/VirtualInterfaceId' - description: The ID of the virtual interface. location: allOf: - $ref: '#/components/schemas/LocationCode' - description: The location of the connection. connectionId: allOf: - $ref: '#/components/schemas/ConnectionId' - description: The ID of the connection. virtualInterfaceType: allOf: - $ref: '#/components/schemas/VirtualInterfaceType' - description: The type of virtual interface. The possible values are private and public. virtualInterfaceName: allOf: - $ref: '#/components/schemas/VirtualInterfaceName' - description: 'The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).' vlan: allOf: - $ref: '#/components/schemas/VLAN' - description: The ID of the VLAN. asn: allOf: - $ref: '#/components/schemas/ASN' - description:

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

The valid values are 1-2147483647.

amazonSideAsn: allOf: - $ref: '#/components/schemas/LongAsn' - description: The autonomous system number (ASN) for the Amazon side of the connection. authKey: allOf: - $ref: '#/components/schemas/BGPAuthKey' - description: The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters. amazonAddress: allOf: - $ref: '#/components/schemas/AmazonAddress' - description: The IP address assigned to the Amazon interface. customerAddress: allOf: - $ref: '#/components/schemas/CustomerAddress' - description: The IP address assigned to the customer interface. addressFamily: allOf: - $ref: '#/components/schemas/AddressFamily' - description: The address family for the BGP peer. virtualInterfaceState: allOf: - $ref: '#/components/schemas/VirtualInterfaceState' - description: '

The state of the virtual interface. The following are the possible values:

' customerRouterConfig: allOf: - $ref: '#/components/schemas/RouterConfig' - description: The customer router configuration. mtu: allOf: - $ref: '#/components/schemas/MTU' - description: The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500. jumboFrameCapable: allOf: - $ref: '#/components/schemas/JumboFrameCapable' - description: Indicates whether jumbo frames (9001 MTU) are supported. virtualGatewayId: allOf: - $ref: '#/components/schemas/VirtualGatewayId' - description: The ID of the virtual private gateway. Applies only to private virtual interfaces. directConnectGatewayId: allOf: - $ref: '#/components/schemas/DirectConnectGatewayId' - description: The ID of the Direct Connect gateway. routeFilterPrefixes: allOf: - $ref: '#/components/schemas/RouteFilterPrefixList' - description: The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces. bgpPeers: allOf: - $ref: '#/components/schemas/BGPPeerList' - description: The BGP peers configured on this virtual interface. region: allOf: - $ref: '#/components/schemas/Region' - description: The Amazon Web Services Region where the virtual interface is located. 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. tags: allOf: - $ref: '#/components/schemas/TagList' - description: The tags associated with the virtual interface. siteLinkEnabled: allOf: - $ref: '#/components/schemas/SiteLinkEnabled' - description: Indicates whether SiteLink is enabled. description: Information about a virtual interface. SecretARN: type: string DescribeDirectConnectGatewayAttachmentsResult: type: object properties: directConnectGatewayAttachments: allOf: - $ref: '#/components/schemas/DirectConnectGatewayAttachmentList' - description: The attachments. nextToken: allOf: - $ref: '#/components/schemas/PaginationToken' - description: The token to retrieve the next page. TooManyTagsException: {} 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: '

The time in minutes that the virtual interface failover test will last.

Maximum value: 4,320 minutes (72 hours).

Default: 180 minutes (3 hours).

' VirtualGatewayId: type: string DeleteDirectConnectGatewayRequest: type: object required: - directConnectGatewayId title: DeleteDirectConnectGatewayRequest properties: directConnectGatewayId: allOf: - $ref: '#/components/schemas/DirectConnectGatewayId' - description: The ID of the Direct Connect gateway. PaginationToken: type: string DeleteInterconnectResponse: type: object properties: interconnectState: allOf: - $ref: '#/components/schemas/InterconnectState' - description: '

The state of the interconnect. The following are the possible values:

' 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: '

The state of the connection. The following are the possible values:

' 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 DescribeLoa 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:

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: allOf: - $ref: '#/components/schemas/EncryptionMode' - description:

The MAC Security (MACsec) connection encryption mode.

The valid values are no_encrypt, should_encrypt, and must_encrypt.

macSecKeys: allOf: - $ref: '#/components/schemas/MacSecKeyList' - description: The MAC Security (MACsec) security keys associated with the connection. description: Information about an Direct Connect connection. ConnectionList: type: array items: $ref: '#/components/schemas/Connection' DescribeDirectConnectGatewayAssociationsResult: type: object properties: directConnectGatewayAssociations: allOf: - $ref: '#/components/schemas/DirectConnectGatewayAssociationList' - description: Information about the associations. nextToken: allOf: - $ref: '#/components/schemas/PaginationToken' - description: The token to retrieve the next page. 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. ResourceTag: type: object properties: resourceArn: allOf: - $ref: '#/components/schemas/ResourceArn' - description: The Amazon Resource Name (ARN) of the resource. tags: allOf: - $ref: '#/components/schemas/TagList' - description: The tags. description: Information about a tag associated with an Direct Connect resource. AwsDeviceV2: type: string TagList: type: array items: $ref: '#/components/schemas/Tag' minItems: 1 LocationCode: type: string ASN: type: integer Loa: type: object properties: loaContent: allOf: - $ref: '#/components/schemas/LoaContent' - description: The binary contents of the LOA-CFA document. loaContentType: allOf: - $ref: '#/components/schemas/LoaContentType' - description: The standard media type for the LOA-CFA document. The only supported value is application/pdf. description: Information about a Letter of Authorization - Connecting Facility Assignment (LOA-CFA) for a connection. ConfirmTransitVirtualInterfaceResponse: type: object properties: virtualInterfaceState: allOf: - $ref: '#/components/schemas/VirtualInterfaceState' - description: '

The state of the virtual interface. The following are the possible values:

' StateChangeError: type: string 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. DirectConnectGatewayAssociationProposalState: type: string enum: - requested - accepted - deleted CIDR: type: string DirectConnectGatewayAttachment: type: object properties: directConnectGatewayId: allOf: - $ref: '#/components/schemas/DirectConnectGatewayId' - description: The ID of the Direct Connect gateway. virtualInterfaceId: allOf: - $ref: '#/components/schemas/VirtualInterfaceId' - description: The ID of the virtual interface. virtualInterfaceRegion: allOf: - $ref: '#/components/schemas/VirtualInterfaceRegion' - description: The Amazon Web Services Region where the virtual interface is located. virtualInterfaceOwnerAccount: allOf: - $ref: '#/components/schemas/OwnerAccount' - description: The ID of the Amazon Web Services account that owns the virtual interface. attachmentState: allOf: - $ref: '#/components/schemas/DirectConnectGatewayAttachmentState' - description: '

The state of the attachment. The following are the possible values:

' attachmentType: allOf: - $ref: '#/components/schemas/DirectConnectGatewayAttachmentType' - description: The type of attachment. stateChangeError: allOf: - $ref: '#/components/schemas/StateChangeError' - description: The error message if the state of an object failed to advance. description: Information about an attachment between a Direct Connect gateway and a virtual interface. NewPublicVirtualInterfaceAllocation: type: object required: - virtualInterfaceName - vlan - asn properties: virtualInterfaceName: allOf: - $ref: '#/components/schemas/VirtualInterfaceName' - description: 'The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).' vlan: allOf: - $ref: '#/components/schemas/VLAN' - description: The ID of the VLAN. asn: allOf: - $ref: '#/components/schemas/ASN' - description:

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

The valid values are 1-2147483647.

authKey: allOf: - $ref: '#/components/schemas/BGPAuthKey' - description: The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters. amazonAddress: allOf: - $ref: '#/components/schemas/AmazonAddress' - description: The IP address assigned to the Amazon interface. customerAddress: allOf: - $ref: '#/components/schemas/CustomerAddress' - description: The IP address assigned to the customer interface. addressFamily: allOf: - $ref: '#/components/schemas/AddressFamily' - description: The address family for the BGP peer. routeFilterPrefixes: allOf: - $ref: '#/components/schemas/RouteFilterPrefixList' - description: The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces. tags: allOf: - $ref: '#/components/schemas/TagList' - description: The tags associated with the public virtual interface. description: Information about a public virtual interface to be provisioned on a connection. TagKey: type: string pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$ minLength: 1 maxLength: 128 DescribeRouterConfigurationResponse: type: object properties: customerRouterConfig: allOf: - $ref: '#/components/schemas/RouterConfig' - description: The customer router configuration. router: allOf: - $ref: '#/components/schemas/RouterType' - description: The details about the router. virtualInterfaceId: allOf: - $ref: '#/components/schemas/VirtualInterfaceId' - description: The ID assigned to the virtual interface. virtualInterfaceName: allOf: - $ref: '#/components/schemas/VirtualInterfaceName' - description: Provides the details about a virtual interface's router. DescribeConnectionLoaResponse: type: object properties: loa: allOf: - $ref: '#/components/schemas/Loa' - description: The Letter of Authorization - Connecting Facility Assignment (LOA-CFA). DirectConnectGatewayAttachmentType: type: string enum: - TransitVirtualInterface - PrivateVirtualInterface DeleteDirectConnectGatewayResult: type: object properties: directConnectGateway: allOf: - $ref: '#/components/schemas/DirectConnectGateway' - description: The Direct Connect gateway. DeleteBGPPeerResponse: type: object properties: virtualInterface: allOf: - $ref: '#/components/schemas/VirtualInterface' - description: The virtual interface. AgreementName: type: string maxLength: 100 AgreementList: type: array items: $ref: '#/components/schemas/CustomerAgreement' ListVirtualInterfaceTestHistoryRequest: type: object title: ListVirtualInterfaceTestHistoryRequest 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 virtual interface that was tested. bgpPeers: allOf: - $ref: '#/components/schemas/BGPPeerIdList' - description: The BGP peers that were placed in the DOWN state during the virtual interface failover test. status: allOf: - $ref: '#/components/schemas/FailureTestHistoryStatus' - description: The status of the virtual interface failover test. maxResults: allOf: - $ref: '#/components/schemas/MaxResultSetSize' - 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: allOf: - $ref: '#/components/schemas/PaginationToken' - description: The token for the next page of results. CreatePrivateVirtualInterfaceRequest: type: object required: - connectionId - newPrivateVirtualInterface title: CreatePrivateVirtualInterfaceRequest properties: connectionId: allOf: - $ref: '#/components/schemas/ConnectionId' - description: The ID of the connection. newPrivateVirtualInterface: allOf: - $ref: '#/components/schemas/NewPrivateVirtualInterface' - description: Information about the private virtual interface. DirectConnectGatewayState: type: string enum: - pending - available - deleting - deleted TagKeyList: type: array items: $ref: '#/components/schemas/TagKey' Status: type: string maxLength: 30 MTU: type: integer UpdateDirectConnectGatewayResponse: type: object properties: directConnectGateway: $ref: '#/components/schemas/DirectConnectGateway' AllocatePrivateVirtualInterfaceRequest: type: object required: - connectionId - ownerAccount - newPrivateVirtualInterfaceAllocation title: AllocatePrivateVirtualInterfaceRequest properties: connectionId: allOf: - $ref: '#/components/schemas/ConnectionId' - description: The ID of the connection on which the private virtual interface is provisioned. ownerAccount: allOf: - $ref: '#/components/schemas/OwnerAccount' - description: The ID of the Amazon Web Services account that owns the virtual private interface. newPrivateVirtualInterfaceAllocation: allOf: - $ref: '#/components/schemas/NewPrivateVirtualInterfaceAllocation' - description: Information about the private virtual interface. DirectConnectGatewayList: type: array items: $ref: '#/components/schemas/DirectConnectGateway' InterconnectId: type: string ConnectionName: type: string Platform: type: string DescribeRouterConfigurationRequest: type: object required: - virtualInterfaceId title: DescribeRouterConfigurationRequest properties: virtualInterfaceId: allOf: - $ref: '#/components/schemas/VirtualInterfaceId' - description: The ID of the virtual interface. routerTypeIdentifier: allOf: - $ref: '#/components/schemas/RouterTypeIdentifier' - description: Identifies the router by a combination of vendor, platform, and software version. For example, CiscoSystemsInc-2900SeriesRouters-IOS124. description: Provides the details about a virtual interface's router. CreateDirectConnectGatewayAssociationRequest: type: object required: - directConnectGatewayId title: CreateDirectConnectGatewayAssociationRequest properties: directConnectGatewayId: allOf: - $ref: '#/components/schemas/DirectConnectGatewayId' - description: The ID of the Direct Connect gateway. gatewayId: allOf: - $ref: '#/components/schemas/GatewayIdToAssociate' - description: The ID of the virtual private gateway or transit gateway. addAllowedPrefixesToDirectConnectGateway: allOf: - $ref: '#/components/schemas/RouteFilterPrefixList' - description:

The Amazon VPC prefixes to advertise to the Direct Connect gateway

This parameter is required when you create an association to a transit gateway.

For information about how to set the prefixes, see Allowed Prefixes in the Direct Connect User Guide.

virtualGatewayId: allOf: - $ref: '#/components/schemas/VirtualGatewayId' - description: The ID of the virtual private gateway. DirectConnectGatewayAssociation: type: object properties: 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 associated gateway. associationState: allOf: - $ref: '#/components/schemas/DirectConnectGatewayAssociationState' - description: '

The state of the association. The following are the possible values:

' stateChangeError: allOf: - $ref: '#/components/schemas/StateChangeError' - description: The error message if the state of an object failed to advance. associatedGateway: allOf: - $ref: '#/components/schemas/AssociatedGateway' - description: Information about the associated gateway. associationId: allOf: - $ref: '#/components/schemas/DirectConnectGatewayAssociationId' - description: The ID of the Direct Connect gateway association. allowedPrefixesToDirectConnectGateway: allOf: - $ref: '#/components/schemas/RouteFilterPrefixList' - description: The Amazon VPC prefixes to advertise to the Direct Connect gateway. virtualGatewayId: allOf: - $ref: '#/components/schemas/VirtualGatewayId' - description: The ID of the virtual private gateway. Applies only to private virtual interfaces. virtualGatewayRegion: allOf: - $ref: '#/components/schemas/VirtualGatewayRegion' - description: The Amazon Web Services Region where the virtual private gateway is located. virtualGatewayOwnerAccount: allOf: - $ref: '#/components/schemas/OwnerAccount' - description: The ID of the Amazon Web Services account that owns the virtual private gateway. description: Information about an association between a Direct Connect gateway and a virtual private gateway or transit gateway. DirectConnectGatewayAssociationState: type: string enum: - associating - associated - disassociating - disassociated - updating StartBgpFailoverTestResponse: type: object properties: virtualInterfaceTest: allOf: - $ref: '#/components/schemas/VirtualInterfaceTestHistory' - description: Information about the virtual interface failover test. ResourceArnList: type: array items: $ref: '#/components/schemas/ResourceArn' SiteLinkEnabled: type: boolean DirectConnectGatewayAssociationProposalId: type: string TestDuration: type: integer PortSpeed: type: string DisassociateConnectionFromLagRequest: type: object required: - connectionId - lagId title: DisassociateConnectionFromLagRequest properties: connectionId: allOf: - $ref: '#/components/schemas/ConnectionId' - description: The ID of the connection. lagId: allOf: - $ref: '#/components/schemas/LagId' - description: The ID of the LAG. DeleteDirectConnectGatewayAssociationProposalRequest: type: object required: - proposalId title: DeleteDirectConnectGatewayAssociationProposalRequest properties: proposalId: allOf: - $ref: '#/components/schemas/DirectConnectGatewayAssociationProposalId' - description: The ID of the proposal. AmazonAddress: type: string Cak: type: string CreateDirectConnectGatewayAssociationResult: type: object properties: directConnectGatewayAssociation: allOf: - $ref: '#/components/schemas/DirectConnectGatewayAssociation' - description: The association to be created. VirtualGatewayState: type: string CustomerAddress: type: string AllocateConnectionOnInterconnectRequest: type: object required: - bandwidth - connectionName - ownerAccount - interconnectId - vlan title: AllocateConnectionOnInterconnectRequest properties: bandwidth: allOf: - $ref: '#/components/schemas/Bandwidth' - description: The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note that only those Direct Connect Partners who have met specific requirements are allowed to create a 1Gbps, 2Gbps, 5Gbps or 10Gbps hosted connection. connectionName: allOf: - $ref: '#/components/schemas/ConnectionName' - description: The name of the provisioned connection. ownerAccount: allOf: - $ref: '#/components/schemas/OwnerAccount' - description: The ID of the Amazon Web Services account of the customer for whom the connection will be provisioned. interconnectId: allOf: - $ref: '#/components/schemas/InterconnectId' - description: The ID of the interconnect on which the connection will be provisioned. vlan: allOf: - $ref: '#/components/schemas/VLAN' - description: The dedicated VLAN provisioned to the connection. Vendor: type: string Software: type: string LoaIssueTime: type: string format: date-time DescribeInterconnectLoaRequest: type: object required: - interconnectId title: DescribeInterconnectLoaRequest properties: interconnectId: allOf: - $ref: '#/components/schemas/InterconnectId' - description: The ID of the interconnect. providerName: allOf: - $ref: '#/components/schemas/ProviderName' - description: The name of the service provider who establishes connectivity on your behalf. If you supply this parameter, the LOA-CFA lists the provider name alongside your company name as the requester of the cross connect. loaContentType: allOf: - $ref: '#/components/schemas/LoaContentType' - description: The standard media type for the LOA-CFA document. The only supported value is application/pdf. NewPublicVirtualInterface: type: object required: - virtualInterfaceName - vlan - asn properties: virtualInterfaceName: allOf: - $ref: '#/components/schemas/VirtualInterfaceName' - description: 'The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).' vlan: allOf: - $ref: '#/components/schemas/VLAN' - description: The ID of the VLAN. asn: allOf: - $ref: '#/components/schemas/ASN' - description:

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

The valid values are 1-2147483647.

authKey: allOf: - $ref: '#/components/schemas/BGPAuthKey' - description: The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters. amazonAddress: allOf: - $ref: '#/components/schemas/AmazonAddress' - description: The IP address assigned to the Amazon interface. customerAddress: allOf: - $ref: '#/components/schemas/CustomerAddress' - description: The IP address assigned to the customer interface. addressFamily: allOf: - $ref: '#/components/schemas/AddressFamily' - description: The address family for the BGP peer. routeFilterPrefixes: allOf: - $ref: '#/components/schemas/RouteFilterPrefixList' - description: The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces. tags: allOf: - $ref: '#/components/schemas/TagList' - description: The tags associated with the public virtual interface. description: Information about a public virtual interface. StartTime: type: string format: date-time Interconnect: type: object properties: interconnectId: allOf: - $ref: '#/components/schemas/InterconnectId' - description: The ID of the interconnect. interconnectName: allOf: - $ref: '#/components/schemas/InterconnectName' - description: The name of the interconnect. interconnectState: allOf: - $ref: '#/components/schemas/InterconnectState' - description: '

The state of the interconnect. The following are the possible values:

' 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. loaIssueTime: allOf: - $ref: '#/components/schemas/LoaIssueTime' - description: The time of the most recent call to DescribeLoa 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 interconnect supports a secondary BGP in the same address family (IPv4/IPv6). tags: allOf: - $ref: '#/components/schemas/TagList' - description: The tags associated with the interconnect. providerName: allOf: - $ref: '#/components/schemas/ProviderName' - description: The name of the service provider associated with the interconnect. description: Information about an interconnect. AddressFamily: type: string enum: - ipv4 - ipv6 DirectConnectGatewayAssociationId: type: string DescribeInterconnectLoaResponse: type: object properties: loa: allOf: - $ref: '#/components/schemas/Loa' - description: The Letter of Authorization - Connecting Facility Assignment (LOA-CFA). TagResourceResponse: type: object properties: {} DirectConnectGatewayAttachmentState: type: string enum: - attaching - attached - detaching - detached DeleteInterconnectRequest: type: object required: - interconnectId title: DeleteInterconnectRequest properties: interconnectId: allOf: - $ref: '#/components/schemas/InterconnectId' - description: The ID of the interconnect. AwsDevice: type: string deprecated: true MacSecKeyList: type: array items: $ref: '#/components/schemas/MacSecKey' NewPrivateVirtualInterfaceAllocation: type: object required: - virtualInterfaceName - vlan - asn properties: virtualInterfaceName: allOf: - $ref: '#/components/schemas/VirtualInterfaceName' - description: 'The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).' vlan: allOf: - $ref: '#/components/schemas/VLAN' - description: The ID of the VLAN. asn: allOf: - $ref: '#/components/schemas/ASN' - description:

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

The valid values are 1-2147483647.

mtu: allOf: - $ref: '#/components/schemas/MTU' - description: The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500. authKey: allOf: - $ref: '#/components/schemas/BGPAuthKey' - description: The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters. amazonAddress: allOf: - $ref: '#/components/schemas/AmazonAddress' - description: The IP address assigned to the Amazon interface. addressFamily: allOf: - $ref: '#/components/schemas/AddressFamily' - description: The address family for the BGP peer. customerAddress: allOf: - $ref: '#/components/schemas/CustomerAddress' - description: The IP address assigned to the customer interface. tags: allOf: - $ref: '#/components/schemas/TagList' - description: The tags associated with the private virtual interface. description: Information about a private virtual interface to be provisioned on a connection. LoaContentType: type: string enum: - application/pdf MaxResultSetSize: type: integer EnableSiteLink: type: boolean RequestMACSec: type: boolean CreateConnectionRequest: type: object required: - location - bandwidth - connectionName title: CreateConnectionRequest properties: location: allOf: - $ref: '#/components/schemas/LocationCode' - description: The location of the connection. bandwidth: allOf: - $ref: '#/components/schemas/Bandwidth' - description: The bandwidth of the connection. connectionName: allOf: - $ref: '#/components/schemas/ConnectionName' - description: The name of the connection. lagId: allOf: - $ref: '#/components/schemas/LagId' - description: The ID of the LAG. tags: allOf: - $ref: '#/components/schemas/TagList' - description: The tags to associate with the lag. providerName: allOf: - $ref: '#/components/schemas/ProviderName' - description: The name of the service provider associated with the requested connection. requestMACSec: allOf: - $ref: '#/components/schemas/RequestMACSec' - description:

Indicates whether you want the connection to support MAC Security (MACsec).

MAC Security (MACsec) is only available on dedicated connections. For information about MAC Security (MACsec) prerequisties, see MACsec prerequisties in the Direct Connect User Guide.

DescribeVirtualInterfacesRequest: type: object title: DescribeVirtualInterfacesRequest properties: connectionId: allOf: - $ref: '#/components/schemas/ConnectionId' - description: The ID of the connection. virtualInterfaceId: allOf: - $ref: '#/components/schemas/VirtualInterfaceId' - description: The ID of the virtual interface. LongAsn: type: integer DescribeTagsRequest: type: object required: - resourceArns title: DescribeTagsRequest properties: resourceArns: allOf: - $ref: '#/components/schemas/ResourceArnList' - description: The Amazon Resource Names (ARNs) of the resources. UpdateDirectConnectGatewayAssociationRequest: type: object title: UpdateDirectConnectGatewayAssociationRequest properties: associationId: allOf: - $ref: '#/components/schemas/DirectConnectGatewayAssociationId' - description: The ID of the Direct Connect gateway association. addAllowedPrefixesToDirectConnectGateway: allOf: - $ref: '#/components/schemas/RouteFilterPrefixList' - description: The Amazon VPC prefixes to advertise to the Direct Connect gateway. removeAllowedPrefixesToDirectConnectGateway: allOf: - $ref: '#/components/schemas/RouteFilterPrefixList' - description: The Amazon VPC prefixes to no longer advertise to the Direct Connect gateway. AssociateHostedConnectionRequest: type: object required: - connectionId - parentConnectionId title: AssociateHostedConnectionRequest properties: connectionId: allOf: - $ref: '#/components/schemas/ConnectionId' - description: The ID of the hosted connection. parentConnectionId: allOf: - $ref: '#/components/schemas/ConnectionId' - description: The ID of the interconnect or the LAG. ListVirtualInterfaceTestHistoryResponse: type: object properties: virtualInterfaceTestHistory: allOf: - $ref: '#/components/schemas/VirtualInterfaceTestHistoryList' - description: The ID of the tested virtual interface. nextToken: allOf: - $ref: '#/components/schemas/PaginationToken' - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. NewTransitVirtualInterfaceAllocation: type: object properties: virtualInterfaceName: allOf: - $ref: '#/components/schemas/VirtualInterfaceName' - description: 'The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).' vlan: allOf: - $ref: '#/components/schemas/VLAN' - description: The ID of the VLAN. asn: allOf: - $ref: '#/components/schemas/ASN' - description:

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

The valid values are 1-2147483647.

mtu: allOf: - $ref: '#/components/schemas/MTU' - description: 'The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500. ' authKey: allOf: - $ref: '#/components/schemas/BGPAuthKey' - description: The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters. amazonAddress: allOf: - $ref: '#/components/schemas/AmazonAddress' - description: The IP address assigned to the Amazon interface. customerAddress: allOf: - $ref: '#/components/schemas/CustomerAddress' - description: The IP address assigned to the customer interface. addressFamily: allOf: - $ref: '#/components/schemas/AddressFamily' - description: The address family for the BGP peer. tags: allOf: - $ref: '#/components/schemas/TagList' - description: The tags associated with the transitive virtual interface. description: Information about a transit virtual interface to be provisioned on a connection. DirectConnectGatewayAssociationList: type: array items: $ref: '#/components/schemas/DirectConnectGatewayAssociation' BooleanFlag: type: boolean InterconnectList: type: array items: $ref: '#/components/schemas/Interconnect' StopBgpFailoverTestRequest: type: object required: - virtualInterfaceId title: StopBgpFailoverTestRequest properties: virtualInterfaceId: allOf: - $ref: '#/components/schemas/VirtualInterfaceId' - description: The ID of the virtual interface you no longer want to test. VirtualGateway: type: object properties: virtualGatewayId: allOf: - $ref: '#/components/schemas/VirtualGatewayId' - description: The ID of the virtual private gateway. virtualGatewayState: allOf: - $ref: '#/components/schemas/VirtualGatewayState' - description: '

The state of the virtual private gateway. The following are the possible values:

' description: Information about a virtual private gateway for a private virtual interface. FailureTestHistoryStatus: type: string CreateTransitVirtualInterfaceRequest: type: object required: - connectionId - newTransitVirtualInterface title: CreateTransitVirtualInterfaceRequest properties: connectionId: allOf: - $ref: '#/components/schemas/ConnectionId' - description: The ID of the connection. newTransitVirtualInterface: allOf: - $ref: '#/components/schemas/NewTransitVirtualInterface' - description: Information about the transit virtual interface. DeleteLagRequest: type: object required: - lagId title: DeleteLagRequest properties: lagId: allOf: - $ref: '#/components/schemas/LagId' - description: The ID of the LAG. LagId: type: string AcceptDirectConnectGatewayAssociationProposalRequest: type: object required: - directConnectGatewayId - proposalId - associatedGatewayOwnerAccount title: AcceptDirectConnectGatewayAssociationProposalRequest 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 request proposal. associatedGatewayOwnerAccount: allOf: - $ref: '#/components/schemas/OwnerAccount' - description: The ID of the Amazon Web Services account that owns the virtual private gateway or transit gateway. overrideAllowedPrefixesToDirectConnectGateway: allOf: - $ref: '#/components/schemas/RouteFilterPrefixList' - description:

Overrides the Amazon VPC prefixes advertised to the Direct Connect gateway.

For information about how to set the prefixes, see Allowed Prefixes in the Direct Connect User Guide.

Location: type: object properties: locationCode: allOf: - $ref: '#/components/schemas/LocationCode' - description: The code for the location. locationName: allOf: - $ref: '#/components/schemas/LocationName' - description: The name of the location. This includes the name of the colocation partner and the physical site of the building. region: allOf: - $ref: '#/components/schemas/Region' - description: The Amazon Web Services Region for the location. availablePortSpeeds: allOf: - $ref: '#/components/schemas/AvailablePortSpeeds' - description: The available port speeds for the location. availableProviders: allOf: - $ref: '#/components/schemas/ProviderList' - description: The name of the service provider for the location. availableMacSecPortSpeeds: allOf: - $ref: '#/components/schemas/AvailableMacSecPortSpeeds' - description: The available MAC Security (MACsec) port speeds for the location. description: Information about an Direct Connect location. GatewayIdentifier: type: string EncryptionMode: type: string Interconnects: type: object properties: interconnects: allOf: - $ref: '#/components/schemas/InterconnectList' - description: The interconnects. DeleteVirtualInterfaceResponse: type: object properties: virtualInterfaceState: allOf: - $ref: '#/components/schemas/VirtualInterfaceState' - description: '

The state of the virtual interface. The following are the possible values:

' BGPPeer: type: object properties: bgpPeerId: allOf: - $ref: '#/components/schemas/BGPPeerId' - description: The ID of the BGP peer. asn: allOf: - $ref: '#/components/schemas/ASN' - description: The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration. authKey: allOf: - $ref: '#/components/schemas/BGPAuthKey' - description: The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters. addressFamily: allOf: - $ref: '#/components/schemas/AddressFamily' - description: The address family for the BGP peer. amazonAddress: allOf: - $ref: '#/components/schemas/AmazonAddress' - description: The IP address assigned to the Amazon interface. customerAddress: allOf: - $ref: '#/components/schemas/CustomerAddress' - description: The IP address assigned to the customer interface. bgpPeerState: allOf: - $ref: '#/components/schemas/BGPPeerState' - description: '

The state of the BGP peer. The following are the possible values:

' bgpStatus: allOf: - $ref: '#/components/schemas/BGPStatus' - description: '

The status of the BGP peer. The following are the possible values:

' awsDeviceV2: allOf: - $ref: '#/components/schemas/AwsDeviceV2' - description: The Direct Connect endpoint that terminates the BGP peer. 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. description: Information about a BGP peer. 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:

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: allOf: - $ref: '#/components/schemas/PaginationToken' - description: The token for the next page of results. parameters: X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature 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 X-Amz-SignedHeaders: name: X-Amz-SignedHeaders 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 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