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.
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.
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.
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 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" /#X-Amz-Target=OvertureService.AllocateTransitVirtualInterface: 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.
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 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" /#X-Amz-Target=OvertureService.AssociateHostedConnection: 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.
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 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" /#X-Amz-Target=OvertureService.AssociateVirtualInterface: 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 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" /#X-Amz-Target=OvertureService.ConfirmConnection: 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.
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 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" /#X-Amz-Target=OvertureService.ConfirmPublicVirtualInterface: 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 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" /#X-Amz-Target=OvertureService.ConfirmTransitVirtualInterface: 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 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" /#X-Amz-Target=OvertureService.CreateBGPPeer: 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 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" /#X-Amz-Target=OvertureService.CreateConnection: 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 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" /#X-Amz-Target=OvertureService.CreateDirectConnectGateway: 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 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" /#X-Amz-Target=OvertureService.CreateDirectConnectGatewayAssociation: 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 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" /#X-Amz-Target=OvertureService.CreateDirectConnectGatewayAssociationProposal: 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 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" /#X-Amz-Target=OvertureService.CreateInterconnect: 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.
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 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" /#X-Amz-Target=OvertureService.CreatePrivateVirtualInterface: 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 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" /#X-Amz-Target=OvertureService.CreatePublicVirtualInterface: 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.
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 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" /#X-Amz-Target=OvertureService.DeleteBGPPeer: 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 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" /#X-Amz-Target=OvertureService.DeleteConnection: 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 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" /#X-Amz-Target=OvertureService.DeleteDirectConnectGateway: 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 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" /#X-Amz-Target=OvertureService.DeleteDirectConnectGatewayAssociation: 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.
Deletes the specified interconnect.
Intended for use by Direct Connect Partners only.
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 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" /#X-Amz-Target=OvertureService.DescribeConnections: 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 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" /#X-Amz-Target=OvertureService.DescribeConnectionsOnInterconnect: 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.
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.
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.
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 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" /#X-Amz-Target=OvertureService.DescribeInterconnects: 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 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" /#X-Amz-Target=OvertureService.DescribeLags: 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 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" /#X-Amz-Target=OvertureService.DescribeLoa: 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 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" /#X-Amz-Target=OvertureService.DescribeLocations: 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 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" /#X-Amz-Target=OvertureService.DescribeRouterConfiguration: 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 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" /#X-Amz-Target=OvertureService.DescribeTags: 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 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" /#X-Amz-Target=OvertureService.DescribeVirtualGateways: 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 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" /#X-Amz-Target=OvertureService.DescribeVirtualInterfaces: 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 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" /#X-Amz-Target=OvertureService.DisassociateConnectionFromLag: 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 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" /#X-Amz-Target=OvertureService.DisassociateMacSecKey: 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 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" /#X-Amz-Target=OvertureService.ListVirtualInterfaceTestHistory: 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 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" /#X-Amz-Target=OvertureService.StartBgpFailoverTest: 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 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" /#X-Amz-Target=OvertureService.StopBgpFailoverTest: 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 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" /#X-Amz-Target=OvertureService.TagResource: 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 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" /#X-Amz-Target=OvertureService.UntagResource: 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 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" /#X-Amz-Target=OvertureService.UpdateConnection: 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.
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 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" /#X-Amz-Target=OvertureService.UpdateLag: 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.
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 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" components: parameters: X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential 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-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 schemas: AcceptDirectConnectGatewayAssociationProposalResult: type: object properties: directConnectGatewayAssociation: $ref: "#/components/schemas/DirectConnectGatewayAssociation" 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.
DirectConnectServerException: {} DirectConnectClientException: {} 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:
ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
pending: The connection has been approved and is being initialized.
available: The network link is up and the connection is ready for use.
down: The network link is down.
deleting: The connection is being deleted.
deleted: The connection has been deleted.
rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
unknown: The state of the connection is not available.
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.
The MAC Security (MACsec) connection encryption mode.
The valid values are no_encrypt, should_encrypt, and must_encrypt.
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:
confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.
verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.
pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.
available: A virtual interface that is able to forward traffic.
down: A virtual interface that is BGP down.
deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.
deleted: A virtual interface that cannot forward traffic.
rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.
unknown: The state of the virtual interface is not available.
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.
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.
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.
The state of the connection. The following are the possible values:
ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
pending: The connection has been approved and is being initialized.
available: The network link is up and the connection is ready for use.
down: The network link is down.
deleting: The connection is being deleted.
deleted: The connection has been deleted.
rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
unknown: The state of the connection is not available.
signed or unsigned. "
ConfirmCustomerAgreementRequest:
type: object
title: ConfirmCustomerAgreementRequest
properties:
agreementName:
allOf:
- $ref: "#/components/schemas/AgreementName"
- description: " The name of the customer agreement. "
ConfirmPrivateVirtualInterfaceResponse:
type: object
properties:
virtualInterfaceState:
allOf:
- $ref: "#/components/schemas/VirtualInterfaceState"
- description: "The state of the virtual interface. The following are the possible values:
confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.
verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.
pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.
available: A virtual interface that is able to forward traffic.
down: A virtual interface that is BGP down.
deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.
deleted: A virtual interface that cannot forward traffic.
rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.
unknown: The state of the virtual interface is not available.
The state of the virtual interface. The following are the possible values:
confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.
verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.
pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.
available: A virtual interface that is able to forward traffic.
down: A virtual interface that is BGP down.
deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.
deleted: A virtual interface that cannot forward traffic.
rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.
unknown: The state of the virtual interface is not available.
The state of the virtual interface. The following are the possible values:
confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.
verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.
pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.
available: A virtual interface that is able to forward traffic.
down: A virtual interface that is BGP down.
deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.
deleted: A virtual interface that cannot forward traffic.
rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.
unknown: The state of the virtual interface is not available.
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.
CreateDirectConnectGatewayResult: type: object properties: directConnectGateway: allOf: - $ref: "#/components/schemas/DirectConnectGateway" - description: The Direct Connect gateway. 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. CreateDirectConnectGatewayAssociationResult: type: object properties: directConnectGatewayAssociation: allOf: - $ref: "#/components/schemas/DirectConnectGatewayAssociation" - description: The association to be created. 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. CreateDirectConnectGatewayAssociationProposalResult: type: object properties: directConnectGatewayAssociationProposal: allOf: - $ref: "#/components/schemas/DirectConnectGatewayAssociationProposal" - description: Information about the Direct Connect gateway proposal. 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. 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:
requested: The initial state of an interconnect. The interconnect stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
pending: The interconnect is approved, and is being initialized.
available: The network link is up, and the interconnect is ready for use.
down: The network link is down.
deleting: The interconnect is being deleted.
deleted: The interconnect is deleted.
unknown: The state of the interconnect is not available.
The state of the LAG. The following are the possible values:
requested: The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.
pending: The LAG has been approved and is being initialized.
available: The network link is established and the LAG is ready for use.
down: The network link is down.
deleting: The LAG is being deleted.
deleted: The LAG is deleted.
unknown: The state of the LAG is not available.
The LAG MAC Security (MACsec) encryption mode.
The valid values are no_encrypt, should_encrypt, and must_encrypt.
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.
The state of the interconnect. The following are the possible values:
requested: The initial state of an interconnect. The interconnect stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
pending: The interconnect is approved, and is being initialized.
available: The network link is up, and the interconnect is ready for use.
down: The network link is down.
deleting: The interconnect is being deleted.
deleted: The interconnect is deleted.
unknown: The state of the interconnect is not available.
The state of the virtual interface. The following are the possible values:
confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.
verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.
pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.
available: A virtual interface that is able to forward traffic.
down: A virtual interface that is BGP down.
deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.
deleted: A virtual interface that cannot forward traffic.
rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.
unknown: The state of the virtual interface is not available.
The type of network-to-network interface (NNI) partner. The partner type will be one of the following:
V1: This partner can only allocate 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, or 500Mbps subgigabit connections.
V2: This partner can only allocate 1GB, 2GB, 5GB, or 10GB hosted connections.
nonPartner: The customer is not a partner.
null when there are no more results to return.
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.
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.
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.
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.
CiscoSystemsInc-2900SeriesRouters-IOS124.
description: Provides the details about a virtual interface's router.
DescribeTagsResponse:
type: object
properties:
resourceTags:
allOf:
- $ref: "#/components/schemas/ResourceTagList"
- description: Information about the tags.
DescribeTagsRequest:
type: object
required:
- resourceArns
title: DescribeTagsRequest
properties:
resourceArns:
allOf:
- $ref: "#/components/schemas/ResourceArnList"
- description: The Amazon Resource Names (ARNs) of the resources.
VirtualGateways:
type: object
properties:
virtualGateways:
allOf:
- $ref: "#/components/schemas/VirtualGatewayList"
- description: The virtual private gateways.
VirtualInterfaces:
type: object
properties:
virtualInterfaces:
allOf:
- $ref: "#/components/schemas/VirtualInterfaceList"
- description: The virtual interfaces
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.
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.
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.
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.
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 isnull when there are no more results to return.
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.
The time in minutes that the virtual interface failover test will last.
Maximum value: 4,320 minutes (72 hours).
Default: 180 minutes (3 hours).
" StopBgpFailoverTestResponse: type: object properties: virtualInterfaceTest: allOf: - $ref: "#/components/schemas/VirtualInterfaceTestHistory" - description: Information about the virtual interface failover test. 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. TagResourceResponse: type: object properties: {} 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. UntagResourceResponse: type: object properties: {} 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. 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.
The LAG MAC Security (MACsec) encryption mode.
Amazon Web Services applies the value to all connections which are part of the LAG.
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. ASN: type: integer DirectConnectGatewayId: type: string DirectConnectGatewayAssociationProposalId: type: string OwnerAccount: type: string RouteFilterPrefixList: type: array items: $ref: "#/components/schemas/RouteFilterPrefix" 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:
associating: The initial state after calling CreateDirectConnectGatewayAssociation.
associated: The Direct Connect gateway and virtual private gateway or transit gateway are successfully associated and ready to pass traffic.
disassociating: The initial state after calling DeleteDirectConnectGatewayAssociation.
disassociated: The virtual private gateway or transit gateway is disassociated from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual private gateway or transit gateway is stopped.
updating: The CIDR blocks for the virtual private gateway or transit gateway are currently being updated. This could be new CIDR blocks added or current CIDR blocks removed.
signed or unsigned "
description: "The name and status of a customer agreement. "
AgreementList:
type: array
items:
$ref: "#/components/schemas/CustomerAgreement"
AgreementName:
type: string
maxLength: 100
Bandwidth:
type: string
ConnectionName:
type: string
InterconnectId:
type: string
VLAN:
type: integer
ConnectionId:
type: string
TagList:
type: array
items:
$ref: "#/components/schemas/Tag"
minItems: 1
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. 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. 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. AmazonAddress: type: string LagId: type: string SecretARN: type: string Ckn: type: string Cak: type: string MacSecKeyList: type: array items: $ref: "#/components/schemas/MacSecKey" VirtualInterfaceId: type: string GatewayIdentifier: type: string GatewayType: type: string enum: - virtualPrivateGateway - transitGateway Region: type: string 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. AssociatedGatewayId: type: string PortSpeed: type: string AvailableMacSecPortSpeeds: type: array items: $ref: "#/components/schemas/PortSpeed" AvailablePortSpeeds: type: array items: $ref: "#/components/schemas/PortSpeed" AwsDevice: type: string deprecated: true AwsDeviceV2: type: string AwsLogicalDeviceId: type: string BGPAuthKey: type: string BGPPeerId: type: string CustomerAddress: type: string BGPPeerState: type: string enum: - verifying - pending - available - deleting - deleted BGPStatus: type: string enum: - up - down - unknown 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:
verifying: The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces.
pending: The BGP peer is created, and remains in this state until it is ready to be established.
available: The BGP peer is ready to be established.
deleting: The BGP peer is being deleted.
deleted: The BGP peer is deleted and cannot be established.
The status of the BGP peer. The following are the possible values:
up: The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.
down: The BGP peer is down.
unknown: The BGP peer status is not available.
The state of the proposal. The following are possible values:
accepted: The proposal has been accepted. The Direct Connect gateway association is available to use in this state.
deleted: The proposal has been deleted by the owner that made the proposal. The Direct Connect gateway association cannot be used in this state.
requested: The proposal has been requested. The Direct Connect gateway association cannot be used in this state.
The state of the Direct Connect gateway. The following are the possible values:
pending: The initial state after calling CreateDirectConnectGateway.
available: The Direct Connect gateway is ready for use.
deleting: The initial state after calling DeleteDirectConnectGateway.
deleted: The Direct Connect gateway is deleted and cannot pass traffic.
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. 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. 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. DirectConnectGatewayAssociationId: type: string InterconnectState: type: string enum: - requested - pending - available - down - deleting - deleted - unknown LoaContentType: type: string enum: - application/pdf NniPartnerType: type: string enum: - v1 - v2 - nonPartner MaxResultSetSize: type: integer PaginationToken: type: string DirectConnectGatewayAssociationProposalList: type: array items: $ref: "#/components/schemas/DirectConnectGatewayAssociationProposal" DirectConnectGatewayAssociationList: type: array items: $ref: "#/components/schemas/DirectConnectGatewayAssociation" DirectConnectGatewayAttachmentList: type: array items: $ref: "#/components/schemas/DirectConnectGatewayAttachment" DirectConnectGatewayList: type: array items: $ref: "#/components/schemas/DirectConnectGateway" RouterTypeIdentifier: type: string RouterConfig: type: string 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.
VirtualInterfaceName:
type: string
ResourceArnList:
type: array
items:
$ref: "#/components/schemas/ResourceArn"
ResourceTagList:
type: array
items:
$ref: "#/components/schemas/ResourceTag"
DirectConnectGatewayState:
type: string
enum:
- pending
- available
- deleting
- deleted
StateChangeError:
type: string
DirectConnectGatewayAssociationState:
type: string
enum:
- associating
- associated
- disassociating
- disassociated
- updating
VirtualGatewayRegion:
type: string
deprecated: true
DirectConnectGatewayAssociationProposalState:
type: string
enum:
- requested
- accepted
- deleted
VirtualInterfaceRegion:
type: string
DirectConnectGatewayAttachmentState:
type: string
enum:
- attaching
- attached
- detaching
- detached
DirectConnectGatewayAttachmentType:
type: string
enum:
- TransitVirtualInterface
- PrivateVirtualInterface
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:
attaching: The initial state after a virtual interface is created using the Direct Connect gateway.
attached: The Direct Connect gateway and virtual interface are attached and ready to pass traffic.
detaching: The initial state after calling DeleteVirtualInterface.
detached: The virtual interface is detached from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual interface is stopped.
The state of the MAC Security (MACsec) secret key.
The possible values are:
associating: The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.
associated: The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.
disassociating: The MAC Security (MACsec) secret key is being disassociated from the connection or LAG
disassociated: The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.
The state of the virtual private gateway. The following are the possible values:
pending: Initial state after creating the virtual private gateway.
available: Ready for use by a private virtual interface.
deleting: Initial state after deleting the virtual private gateway.
deleted: The virtual private gateway is deleted. The private virtual interface is unable to send traffic over this gateway.