# Direct Connect API Reference

> Direct Connect links your internal network to an Direct Connect location over a standard Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an Direct Connect router. With this connection in place, you can create virtual interfaces directly to the AWS Cloud (for example, to Amazon EC2 and Amazon S3) and to Amazon VPC, bypassing Internet service providers in your network path. A connection provides access to all AWS Regions except the China (Beijing) and (China) Ningxia Regions. AWS resources in the China Regions can only be accessed through locations associated with those Regions.

- [Welcome](https://docs.aws.amazon.com/directconnect/latest/APIReference/Welcome.md)
- [Common Parameters](https://docs.aws.amazon.com/directconnect/latest/APIReference/CommonParameters.md)
- [Common Error Types](https://docs.aws.amazon.com/directconnect/latest/APIReference/CommonErrors.md)

## [Actions](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_Operations.md)

- [AcceptDirectConnectGatewayAssociationProposal](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_AcceptDirectConnectGatewayAssociationProposal.md): Accepts a proposal request to attach a virtual private gateway or transit gateway to a Direct Connect gateway.
- [AllocateConnectionOnInterconnect](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_AllocateConnectionOnInterconnect.md)
- [AllocateHostedConnection](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_AllocateHostedConnection.md): Creates a hosted connection on the specified interconnect or a link aggregation group (LAG) of interconnects.
- [AllocatePrivateVirtualInterface](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_AllocatePrivateVirtualInterface.md): Provisions a private virtual interface to be owned by the specified AWS account.
- [AllocatePublicVirtualInterface](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_AllocatePublicVirtualInterface.md): Provisions a public virtual interface to be owned by the specified AWS account.
- [AllocateTransitVirtualInterface](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_AllocateTransitVirtualInterface.md): Provisions a transit virtual interface to be owned by the specified AWS account.
- [AssociateConnectionsToResiliencyGroup](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_AssociateConnectionsToResiliencyGroup.md): Associates one or more connections with the specified resiliency group.
- [AssociateConnectionWithLag](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_AssociateConnectionWithLag.md): Associates an existing connection with a link aggregation group (LAG).
- [AssociateHostedConnection](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_AssociateHostedConnection.md): Associates a hosted connection and its virtual interfaces with a link aggregation group (LAG) or interconnect.
- [AssociateMacSecKey](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_AssociateMacSecKey.md): Associates a MAC Security (MACsec) Connection Key Name (CKN)/ Connectivity Association Key (CAK) pair with a Direct Connect connection.
- [AssociateVirtualInterface](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_AssociateVirtualInterface.md): Associates a virtual interface with a specified link aggregation group (LAG) or connection.
- [ConfirmConnection](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_ConfirmConnection.md): Confirms the creation of the specified hosted connection on an interconnect.
- [ConfirmCustomerAgreement](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_ConfirmCustomerAgreement.md): The confirmation of the terms of agreement when creating the connection/link aggregation group (LAG).
- [ConfirmPrivateVirtualInterface](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_ConfirmPrivateVirtualInterface.md): Accepts ownership of a private virtual interface created by another AWS account.
- [ConfirmPublicVirtualInterface](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_ConfirmPublicVirtualInterface.md): Accepts ownership of a public virtual interface created by another AWS account.
- [ConfirmTransitVirtualInterface](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_ConfirmTransitVirtualInterface.md): Accepts ownership of a transit virtual interface created by another AWS account.
- [CreateBGPPeer](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_CreateBGPPeer.md): Creates a BGP peer on the specified virtual interface.
- [CreateConnection](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_CreateConnection.md): Creates a connection between a customer network and a specific Direct Connect location.
- [CreateDirectConnectGateway](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_CreateDirectConnectGateway.md): Creates a Direct Connect gateway, which is an intermediate object that enables you to connect a set of virtual interfaces and virtual private gateways.
- [CreateDirectConnectGatewayAssociation](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_CreateDirectConnectGatewayAssociation.md): Creates an association between a Direct Connect gateway and a virtual private gateway.
- [CreateDirectConnectGatewayAssociationProposal](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_CreateDirectConnectGatewayAssociationProposal.md): Creates a proposal to associate the specified virtual private gateway or transit gateway with the specified Direct Connect gateway.
- [CreateInterconnect](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_CreateInterconnect.md): Creates an interconnect between an Direct Connect Partner's network and a specific Direct Connect location.
- [CreateLag](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_CreateLag.md): 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.
- [CreatePrivateVirtualInterface](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_CreatePrivateVirtualInterface.md): Creates a private virtual interface.
- [CreatePublicVirtualInterface](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_CreatePublicVirtualInterface.md): Creates a public virtual interface.
- [CreateResiliencyGroup](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_CreateResiliencyGroup.md): Creates a resiliency group.
- [CreateTransitVirtualInterface](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_CreateTransitVirtualInterface.md): Creates a transit virtual interface.
- [DeleteBGPPeer](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_DeleteBGPPeer.md): Deletes the specified BGP peer on the specified virtual interface with the specified customer address and ASN.
- [DeleteConnection](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_DeleteConnection.md): Deletes the specified connection.
- [DeleteDirectConnectGateway](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_DeleteDirectConnectGateway.md): Deletes the specified Direct Connect gateway.
- [DeleteDirectConnectGatewayAssociation](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_DeleteDirectConnectGatewayAssociation.md): Deletes the association between the specified Direct Connect gateway and virtual private gateway.
- [DeleteDirectConnectGatewayAssociationProposal](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_DeleteDirectConnectGatewayAssociationProposal.md): Deletes the association proposal request between the specified Direct Connect gateway and virtual private gateway or transit gateway.
- [DeleteInterconnect](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_DeleteInterconnect.md): Deletes the specified interconnect.
- [DeleteLag](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_DeleteLag.md): Deletes the specified link aggregation group (LAG).
- [DeleteResiliencyGroup](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_DeleteResiliencyGroup.md): Deletes the specified resiliency group.
- [DeleteVirtualInterface](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_DeleteVirtualInterface.md): Deletes a virtual interface.
- [DescribeConnectionLoa](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_DescribeConnectionLoa.md)
- [DescribeConnections](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_DescribeConnections.md): Displays the specified connection or all connections in this Region.
- [DescribeConnectionsOnInterconnect](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_DescribeConnectionsOnInterconnect.md)
- [DescribeCustomerMetadata](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_DescribeCustomerMetadata.md): Get and view a list of customer agreements, along with their signed status and whether the customer is an NNIPartner, NNIPartnerV2, or a nonPartner.
- [DescribeDirectConnectGatewayAssociationProposals](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_DescribeDirectConnectGatewayAssociationProposals.md): Describes one or more association proposals for connection between a virtual private gateway or transit gateway and a Direct Connect gateway.
- [DescribeDirectConnectGatewayAssociations](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_DescribeDirectConnectGatewayAssociations.md): Lists the associations between your Direct Connect gateways and virtual private gateways and transit gateways.
- [DescribeDirectConnectGatewayAttachments](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_DescribeDirectConnectGatewayAttachments.md): Lists the attachments between your Direct Connect gateways and virtual interfaces.
- [DescribeDirectConnectGateways](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_DescribeDirectConnectGateways.md): Lists all your Direct Connect gateways or only the specified Direct Connect gateway.
- [DescribeHostedConnections](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_DescribeHostedConnections.md): Lists the hosted connections that have been provisioned on the specified interconnect or link aggregation group (LAG).
- [DescribeInterconnectLoa](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_DescribeInterconnectLoa.md)
- [DescribeInterconnects](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_DescribeInterconnects.md): Lists the interconnects owned by the AWS account or only the specified interconnect.
- [DescribeLags](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_DescribeLags.md): Describes all your link aggregation groups (LAG) or the specified LAG.
- [DescribeLoa](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_DescribeLoa.md): Gets the LOA-CFA for a connection, interconnect, or link aggregation group (LAG).
- [DescribeLocations](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_DescribeLocations.md): Lists the Direct Connect locations in the current AWS Region.
- [DescribeRouterConfiguration](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_DescribeRouterConfiguration.md): Details about the router.
- [DescribeTags](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_DescribeTags.md): Describes the tags associated with the specified Direct Connect resources.
- [DescribeVirtualGateways](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_DescribeVirtualGateways.md)
- [DescribeVirtualInterfaces](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_DescribeVirtualInterfaces.md): Displays all virtual interfaces for an AWS account.
- [DisassociateConnectionFromLag](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_DisassociateConnectionFromLag.md): Disassociates a connection from a link aggregation group (LAG).
- [DisassociateConnectionsFromResiliencyGroup](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_DisassociateConnectionsFromResiliencyGroup.md): Disassociates one or more connections from the specified resiliency group.
- [DisassociateMacSecKey](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_DisassociateMacSecKey.md): Removes the association between a MAC Security (MACsec) security key and a Direct Connect connection.
- [GetResiliencyGroup](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_GetResiliencyGroup.md): Gets information about the specified resiliency group.
- [ListResiliencyGroupAssociations](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_ListResiliencyGroupAssociations.md): Lists the connection associations for the specified resiliency group.
- [ListResiliencyGroups](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_ListResiliencyGroups.md): Lists the resiliency groups owned by your AWS account in the current AWS Region.
- [ListVirtualInterfaceRoutes](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_ListVirtualInterfaceRoutes.md): Lists the routes for the specified virtual interface.
- [ListVirtualInterfaceTestHistory](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_ListVirtualInterfaceTestHistory.md): Lists the virtual interface failover test history.
- [StartBgpFailoverTest](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_StartBgpFailoverTest.md): Starts the virtual interface failover test that verifies your configuration meets your resiliency requirements by placing the BGP peering session in the DOWN state.
- [StopBgpFailoverTest](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_StopBgpFailoverTest.md): Stops the virtual interface failover test.
- [TagResource](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_TagResource.md): Adds the specified tags to the specified Direct Connect resource.
- [UntagResource](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_UntagResource.md): Removes one or more tags from the specified Direct Connect resource.
- [UpdateConnection](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_UpdateConnection.md): Updates the Direct Connect connection configuration.
- [UpdateConnectionsBillingMode](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_UpdateConnectionsBillingMode.md): Updates the billing mode for the specified Direct Connect connections.
- [UpdateDirectConnectGateway](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_UpdateDirectConnectGateway.md): Updates the name of a current Direct Connect gateway.
- [UpdateDirectConnectGatewayAssociation](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_UpdateDirectConnectGatewayAssociation.md): Updates the specified attributes of the Direct Connect gateway association.
- [UpdateLag](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_UpdateLag.md): Updates the attributes of the specified link aggregation group (LAG).
- [UpdateResiliencyGroup](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_UpdateResiliencyGroup.md): Updates the name of the specified resiliency group.
- [UpdateVirtualInterfaceAttributes](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_UpdateVirtualInterfaceAttributes.md): Updates the specified attributes of the specified virtual private interface.


## [Data Types](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_Types.md)

- [AsPathSegment](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_AsPathSegment.md): A segment of an autonomous system (AS) path.
- [AssociatedCoreNetwork](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_AssociatedCoreNetwork.md): The AWS Cloud WAN core network that the Direct Connect gateway is associated to.
- [AssociatedGateway](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_AssociatedGateway.md): Information about the associated gateway.
- [AvailableBillingMode](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_AvailableBillingMode.md): Information about a billing mode available at an Direct Connect location.
- [BGPPeer](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_BGPPeer.md): Information about a BGP peer.
- [Connection](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_Connection.md): Information about an Direct Connect connection.
- [CustomerAgreement](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_CustomerAgreement.md): The name and status of a customer agreement.
- [DirectConnectGateway](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_DirectConnectGateway.md): Information about a Direct Connect gateway, which enables you to connect virtual interfaces and virtual private gateway or transit gateways.
- [DirectConnectGatewayAssociation](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_DirectConnectGatewayAssociation.md): Information about an association between a Direct Connect gateway and a virtual private gateway or transit gateway.
- [DirectConnectGatewayAssociationProposal](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_DirectConnectGatewayAssociationProposal.md): Information about the proposal request to attach a virtual private gateway to a Direct Connect gateway.
- [DirectConnectGatewayAttachment](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_DirectConnectGatewayAttachment.md): Information about an attachment between a Direct Connect gateway and a virtual interface.
- [Interconnect](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_Interconnect.md): Information about an interconnect.
- [Lag](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_Lag.md): Information about a link aggregation group (LAG).
- [Loa](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_Loa.md): Information about a Letter of Authorization - Connecting Facility Assignment (LOA-CFA) for a connection.
- [Location](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_Location.md): Information about an Direct Connect location.
- [MacSecKey](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_MacSecKey.md): Information about the MAC Security (MACsec) secret key.
- [NewBGPPeer](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_NewBGPPeer.md): Information about a new BGP peer.
- [NewPrivateVirtualInterface](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_NewPrivateVirtualInterface.md): Information about a private virtual interface.
- [NewPrivateVirtualInterfaceAllocation](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_NewPrivateVirtualInterfaceAllocation.md): Information about a private virtual interface to be provisioned on a connection.
- [NewPublicVirtualInterface](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_NewPublicVirtualInterface.md): Information about a public virtual interface.
- [NewPublicVirtualInterfaceAllocation](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_NewPublicVirtualInterfaceAllocation.md): Information about a public virtual interface to be provisioned on a connection.
- [NewTransitVirtualInterface](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_NewTransitVirtualInterface.md): Information about a transit virtual interface.
- [NewTransitVirtualInterfaceAllocation](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_NewTransitVirtualInterfaceAllocation.md): Information about a transit virtual interface to be provisioned on a connection.
- [RateLimiterStatus](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_RateLimiterStatus.md): Contains information about the rate limiter status for a connection, including the maximum number of rate limiters allowed, the number currently in use, and the remaining capacity.
- [ResiliencyGroup](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_ResiliencyGroup.md): Information about a resiliency group.
- [ResiliencyGroupAssociation](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_ResiliencyGroupAssociation.md): Information about an association between a connection and a resiliency group.
- [ResiliencyGroupSummary](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_ResiliencyGroupSummary.md): Summary information about a resiliency group.
- [ResourceTag](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_ResourceTag.md): Information about a tag associated with an Direct Connect resource.
- [Route](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_Route.md): Information about a route for a virtual interface.
- [RouteFilterPrefix](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_RouteFilterPrefix.md): Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
- [RouteFilters](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_RouteFilters.md): The filters used to limit the routes returned by ListVirtualInterfaceRoutes.
- [RouterType](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_RouterType.md): Information about the virtual router.
- [Tag](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_Tag.md): Information about a tag.
- [VirtualGateway](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_VirtualGateway.md): Information about a virtual private gateway for a private virtual interface.
- [VirtualInterface](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_VirtualInterface.md): Information about a virtual interface.
- [VirtualInterfaceTestHistory](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_VirtualInterfaceTestHistory.md): Information about the virtual interface failover test.


## Full content

The entire guide is also available as a single markdown file, useful for feeding the full guide to an LLM in one pass:

- [Complete guide (single file)](https://docs.aws.amazon.com/directconnect/latest/APIReference/full.md)