ConfirmTransitVirtualInterface
Accepts ownership of a transit virtual interface created by another AWS 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.
Request Syntax
{ "directConnectGatewayId": "string", "virtualInterfaceId": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 268).
The request accepts the following data in JSON format.
directConnectGatewayId (p. 61)
The ID of the Direct Connect gateway.
Type: String Required: Yes virtualInterfaceId (p. 61)
The ID of the virtual interface.
Type: String Required: Yes
Response Syntax
{ "virtualInterfaceState": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
virtualInterfaceState (p. 61)
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
Errors
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 (p. 129) 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.
Type: String
Valid Values: confirming | verifying | pending | available | down | deleting | deleted | rejected | unknown
Errors
For information about the errors that are common to all actions, see Common Errors (p. 270).
DirectConnectClientException
One or more parameters are not valid.
HTTP Status Code: 400 DirectConnectServerException
A server-side error occurred.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateBGPPeer
CreateBGPPeer
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 AWS 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.
For a public virtual interface, the Autonomous System Number (ASN) must be private or already on the allow list for the virtual interface.
Request Syntax
{ "newBGPPeer": {
"addressFamily": "string", "amazonAddress": "string", "asn": number,
"authKey": "string", "customerAddress": "string"
},
"virtualInterfaceId": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 268).
The request accepts the following data in JSON format.
newBGPPeer (p. 63)
Information about the BGP peer.
Type: NewBGPPeer (p. 243) object Required: No
virtualInterfaceId (p. 63)
The ID of the virtual interface.
Type: String Required: No
Response Syntax
{
Response Elements
"virtualInterface": { "addressFamily": "string", "amazonAddress": "string", "amazonSideAsn": number, "asn": number,
"authKey": "string", "awsDeviceV2": "string",
"awsLogicalDeviceId": "string", "bgpPeers": [
"connectionId": "string", "customerAddress": "string", "customerRouterConfig": "string", "directConnectGatewayId": "string", "jumboFrameCapable": boolean, "location": "string",
"mtu": number,
"ownerAccount": "string", "region": "string",
"siteLinkEnabled": boolean, "tags": [
"virtualGatewayId": "string", "virtualInterfaceId": "string", "virtualInterfaceName": "string", "virtualInterfaceState": "string", "virtualInterfaceType": "string", "vlan": number
}}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
virtualInterface (p. 63) The virtual interface.
Type: VirtualInterface (p. 262) object
Errors
Errors
For information about the errors that are common to all actions, see Common Errors (p. 270).
DirectConnectClientException
One or more parameters are not valid.
HTTP Status Code: 400 DirectConnectServerException
A server-side error occurred.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateConnection
CreateConnection
Creates a connection between a customer network and a specific AWS Direct Connect location.
A connection links your internal network to an AWS Direct Connect location over a standard Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an AWS Direct Connect router.
To find the locations for your Region, use DescribeLocations (p. 163).
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 AWS 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.
Request Syntax
{ "bandwidth": "string", "connectionName": "string", "lagId": "string",
"location": "string", "providerName": "string", "requestMACSec": boolean, "tags": [
{
"key": "string", "value": "string"
} ]}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 268).
The request accepts the following data in JSON format.
bandwidth (p. 66)
The bandwidth of the connection.
Type: String Required: Yes connectionName (p. 66)
The name of the connection.
Type: String Required: Yes lagId (p. 66)
The ID of the LAG.
Type: String
Response Syntax
Required: No location (p. 66)
The location of the connection.
Type: String Required: Yes providerName (p. 66)
The name of the service provider associated with the requested connection.
Type: String Required: No requestMACSec (p. 66)
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 AWS Direct Connect User Guide.
Type: Boolean Required: No tags (p. 66)
The tags to associate with the lag.
Type: Array of Tag (p. 260) objects
Array Members: Minimum number of 1 item.
Required: No
Response Syntax
{
"awsDevice": "string", "awsDeviceV2": "string", "awsLogicalDeviceId": "string", "bandwidth": "string",
"connectionId": "string", "connectionName": "string", "connectionState": "string", "encryptionMode": "string", "hasLogicalRedundancy": "string", "jumboFrameCapable": boolean, "lagId": "string",
"loaIssueTime": number, "location": "string", "macSecCapable": boolean, "macSecKeys": [
Response Elements
"ownerAccount": "string", "partnerName": "string",
"portEncryptionStatus": "string", "providerName": "string",
"region": "string", "tags": [
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
awsDevice (p. 67)
This parameter has been deprecated.
The Direct Connect endpoint on which the physical connection terminates.
Type: String awsDeviceV2 (p. 67)
The Direct Connect endpoint that terminates the physical connection.
Type: String
awsLogicalDeviceId (p. 67)
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
Type: String bandwidth (p. 67)
The bandwidth of the connection.
Type: String connectionId (p. 67)
The ID of the connection.
Type: String
connectionName (p. 67)
The name of the connection.
Type: String connectionState (p. 67)
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.
Response Elements
• 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.
Type: String
Valid Values: ordering | requested | pending | available | down | deleting | deleted | rejected | unknown
encryptionMode (p. 67)
The MAC Security (MACsec) connection encryption mode.
The valid values are no_encrypt, should_encrypt, and must_encrypt.
Type: String
hasLogicalRedundancy (p. 67)
Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/
IPv6).
Type: String
Valid Values: unknown | yes | no jumboFrameCapable (p. 67)
Indicates whether jumbo frames (9001 MTU) are supported.
Type: Boolean lagId (p. 67)
The ID of the LAG.
Type: String loaIssueTime (p. 67)
The time of the most recent call to DescribeLoa (p. 161) for this connection.
Type: Timestamp location (p. 67)
The location of the connection.
Type: String macSecCapable (p. 67)
Indicates whether the connection supports MAC Security (MACsec).
Type: Boolean
Errors
macSecKeys (p. 67)
The MAC Security (MACsec) security keys associated with the connection.
Type: Array of MacSecKey (p. 241) objects ownerAccount (p. 67)
The ID of the AWS account that owns the connection.
Type: String partnerName (p. 67)
The name of the AWS Direct Connect service provider associated with the connection.
Type: String
portEncryptionStatus (p. 67)
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.
Type: String providerName (p. 67)
The name of the service provider associated with the connection.
Type: String region (p. 67)
The AWS Region where the connection is located.
Type: String tags (p. 67)
The tags associated with the connection.
Type: Array of Tag (p. 260) objects
Array Members: Minimum number of 1 item.
vlan (p. 67)
The ID of the VLAN.
Type: Integer
Errors
For information about the errors that are common to all actions, see Common Errors (p. 270).
DirectConnectClientException
One or more parameters are not valid.
HTTP Status Code: 400 DirectConnectServerException
A server-side error occurred.
See Also
HTTP Status Code: 400 DuplicateTagKeysException
A tag key was specified more than once.
HTTP Status Code: 400 TooManyTagsException
You have reached the limit on the number of tags that can be assigned.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateDirectConnectGateway
CreateDirectConnectGateway
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 AWS Region after it is created. The virtual interfaces and virtual private gateways that are connected through a Direct Connect gateway can be in different AWS 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.
Request Syntax
{ "amazonSideAsn": number,
"directConnectGatewayName": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 268).
The request accepts the following data in JSON format.
amazonSideAsn (p. 72)
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.
Type: Long Required: No
directConnectGatewayName (p. 72)
The name of the Direct Connect gateway.
Type: String Required: Yes
Response Syntax
{
"directConnectGateway": { "amazonSideAsn": number,
"directConnectGatewayId": "string", "directConnectGatewayName": "string", "directConnectGatewayState": "string", "ownerAccount": "string",
"stateChangeError": "string"
}}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
Errors
The following data is returned in JSON format by the service.
directConnectGateway (p. 72) The Direct Connect gateway.
Type: DirectConnectGateway (p. 223) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 270).
DirectConnectClientException
One or more parameters are not valid.
HTTP Status Code: 400 DirectConnectServerException
A server-side error occurred.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateDirectConnectGatewayAssociation
CreateDirectConnectGatewayAssociation
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.
Request Syntax
{ "addAllowedPrefixesToDirectConnectGateway": [ {
"cidr": "string"
} ],
"directConnectGatewayId": "string", "gatewayId": "string",
"virtualGatewayId": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 268).
The request accepts the following data in JSON format.
addAllowedPrefixesToDirectConnectGateway (p. 74)
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 AWS Direct Connect User Guide.
Type: Array of RouteFilterPrefix (p. 257) objects Required: No
directConnectGatewayId (p. 74)
The ID of the Direct Connect gateway.
Type: String Required: Yes gatewayId (p. 74)
The ID of the virtual private gateway or transit gateway.
Type: String Required: No virtualGatewayId (p. 74)
The ID of the virtual private gateway.
Type: String Required: No
Response Syntax
Response Syntax
{ "directConnectGatewayAssociation": {
"allowedPrefixesToDirectConnectGateway": [ {
"cidr": "string"
} ],
"associatedGateway": { "id": "string",
"ownerAccount": "string", "region": "string", "type": "string"
},
"associationId": "string", "associationState": "string", "directConnectGatewayId": "string",
"directConnectGatewayOwnerAccount": "string", "stateChangeError": "string",
"virtualGatewayId": "string",
"virtualGatewayOwnerAccount": "string", "virtualGatewayRegion": "string"
}}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
directConnectGatewayAssociation (p. 75) The association to be created.
Type: DirectConnectGatewayAssociation (p. 225) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 270).
DirectConnectClientException
One or more parameters are not valid.
HTTP Status Code: 400 DirectConnectServerException
A server-side error occurred.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
See Also
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateDirectConnectGatewayAssociationProposal
CreateDirectConnectGatewayAssociationProposal
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 AWS account.
Request Syntax
{ "addAllowedPrefixesToDirectConnectGateway": [ {
"cidr": "string"
} ],
"directConnectGatewayId": "string",
"directConnectGatewayOwnerAccount": "string", "gatewayId": "string",
"removeAllowedPrefixesToDirectConnectGateway": [ {
"cidr": "string"
} ]}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 268).
The request accepts the following data in JSON format.
addAllowedPrefixesToDirectConnectGateway (p. 77)
The Amazon VPC prefixes to advertise to the Direct Connect gateway.
Type: Array of RouteFilterPrefix (p. 257) objects Required: No
directConnectGatewayId (p. 77)
The ID of the Direct Connect gateway.
Type: String Required: Yes
directConnectGatewayOwnerAccount (p. 77)
The ID of the AWS account that owns the Direct Connect gateway.
Type: String Required: Yes gatewayId (p. 77)
The ID of the virtual private gateway or transit gateway.
Response Syntax
Type: String Required: Yes
removeAllowedPrefixesToDirectConnectGateway (p. 77)
The Amazon VPC prefixes to no longer advertise to the Direct Connect gateway.
Type: Array of RouteFilterPrefix (p. 257) objects Required: No
Response Syntax
{
"directConnectGatewayAssociationProposal": { "associatedGateway": {
"id": "string",
"ownerAccount": "string", "region": "string", "type": "string"
},
"directConnectGatewayId": "string",
"directConnectGatewayOwnerAccount": "string", "existingAllowedPrefixesToDirectConnectGateway": [ {
"cidr": "string"
} ],
"proposalId": "string", "proposalState": "string",
"requestedAllowedPrefixesToDirectConnectGateway": [ {
"cidr": "string"
} ] }}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
directConnectGatewayAssociationProposal (p. 78)
Information about the Direct Connect gateway proposal.
Type: DirectConnectGatewayAssociationProposal (p. 227) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 270).
DirectConnectClientException
One or more parameters are not valid.
See Also
HTTP Status Code: 400 DirectConnectServerException
A server-side error occurred.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateInterconnect
CreateInterconnect
Creates an interconnect between an AWS Direct Connect Partner's network and a specific AWS Direct Connect location.
An interconnect is a connection that is capable of hosting other connections. The AWS Direct Connect Partner can use an interconnect to provide AWS Direct Connect hosted connections to customers through their own network services. Like a standard connection, an interconnect links the partner's network to an AWS Direct Connect location over a standard Ethernet fiber-optic cable. One end is connected to the partner's router, the other to an AWS 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 AWS 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 AWS Direct Connect Partner provisions a connection on their interconnect by calling AllocateHostedConnection (p. 12). The end customer can then connect to AWS resources by creating a virtual interface on their connection, using the VLAN assigned to them by the AWS Direct Connect Partner.
Note
Intended for use by AWS Direct Connect Partners only.
Request Syntax
{ "bandwidth": "string",
"interconnectName": "string", "lagId": "string",
"location": "string", "providerName": "string", "tags": [
For information about the parameters that are common to all actions, see Common Parameters (p. 268).
The request accepts the following data in JSON format.
bandwidth (p. 80)
The port bandwidth, in Gbps. The possible values are 1 and 10.
Type: String Required: Yes
interconnectName (p. 80)
The name of the interconnect.
Response Syntax
Type: String Required: Yes lagId (p. 80)
The ID of the LAG.
Type: String Required: No location (p. 80)
The location of the interconnect.
Type: String Required: Yes providerName (p. 80)
The name of the service provider associated with the interconnect.
Type: String Required: No tags (p. 80)
The tags to associate with the interconnect.
Type: Array of Tag (p. 260) objects
Array Members: Minimum number of 1 item.
Required: No
Response Syntax
{ "awsDevice": "string", "awsDeviceV2": "string", "awsLogicalDeviceId": "string", "bandwidth": "string",
"hasLogicalRedundancy": "string", "interconnectId": "string", "interconnectName": "string", "interconnectState": "string", "jumboFrameCapable": boolean, "lagId": "string",
"loaIssueTime": number, "location": "string", "providerName": "string", "region": "string", "tags": [
{
"key": "string", "value": "string"
} ]}
Response Elements
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
awsDevice (p. 81)
This parameter has been deprecated.
The Direct Connect endpoint on which the physical connection terminates.
Type: String awsDeviceV2 (p. 81)
The Direct Connect endpoint that terminates the physical connection.
Type: String
awsLogicalDeviceId (p. 81)
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
Type: String bandwidth (p. 81)
The bandwidth of the connection.
Type: String
hasLogicalRedundancy (p. 81)
Indicates whether the interconnect supports a secondary BGP in the same address family (IPv4/
Indicates whether the interconnect supports a secondary BGP in the same address family (IPv4/