DescribeRouterConfiguration
Details about the router.
Request Syntax
{
"routerTypeIdentifier": "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.
routerTypeIdentifier (p. 165)
Identifies the router by a combination of vendor, platform, and software version. For example, CiscoSystemsInc-2900SeriesRouters-IOS124.
Type: String Required: No
virtualInterfaceId (p. 165) The ID of the virtual interface.
Type: String Required: Yes
Response Syntax
{ "customerRouterConfig": "string", "router": {
"platform": "string",
"routerTypeIdentifier": "string", "software": "string",
"vendor": "string",
"xsltTemplateName": "string",
"xsltTemplateNameForMacSec": "string"
},
"virtualInterfaceId": "string", "virtualInterfaceName": "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.
Errors
customerRouterConfig (p. 165) The customer router configuration.
Type: String router (p. 165)
The details about the router.
Type: RouterType (p. 258) object virtualInterfaceId (p. 165)
The ID assigned to the virtual interface.
Type: String
virtualInterfaceName (p. 165)
Provides the details about a virtual interface's router.
Type: String
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
DescribeTags
DescribeTags
Describes the tags associated with the specified AWS Direct Connect resources.
Request Syntax
{ "resourceArns": [ "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.
resourceArns (p. 167)
The Amazon Resource Names (ARNs) of the resources.
Type: Array of strings Required: Yes
Response Syntax
{
"resourceTags": [ {
"resourceArn": "string", "tags": [
{
"key": "string", "value": "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.
resourceTags (p. 167)
Information about the tags.
Type: Array of ResourceTag (p. 256) objects
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
DescribeVirtualGateways
DescribeVirtualGateways
Lists the virtual private gateways owned by the AWS account.
You can create one or more AWS Direct Connect private virtual interfaces linked to a virtual private gateway.
Response Syntax
{ "virtualGateways": [ {
"virtualGatewayId": "string", "virtualGatewayState": "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.
virtualGateways (p. 169) The virtual private gateways.
Type: Array of VirtualGateway (p. 261) objects
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
See Also
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DescribeVirtualInterfaces
DescribeVirtualInterfaces
Displays all virtual interfaces for an AWS 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 AWS Direct Connect location and the customer network.
Request Syntax
{ "connectionId": "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.
connectionId (p. 171) The ID of the connection.
Type: String Required: No
virtualInterfaceId (p. 171) The ID of the virtual interface.
Type: String Required: No
Response Syntax
{ "virtualInterfaces": [ {
"addressFamily": "string", "amazonAddress": "string", "amazonSideAsn": number, "asn": number,
"authKey": "string", "awsDeviceV2": "string", "awsLogicalDeviceId": "string", "bgpPeers": [
{
"addressFamily": "string", "amazonAddress": "string", "asn": number,
Response Elements "customerRouterConfig": "string", "directConnectGatewayId": "string", "jumboFrameCapable": boolean, "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.
virtualInterfaces (p. 171) The virtual interfaces
Type: Array of VirtualInterface (p. 262) objects
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
See Also
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
DisassociateConnectionFromLag
DisassociateConnectionFromLag
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 (p. 110) request). If the LAG has associated virtual interfaces or hosted connections, they remain associated with the LAG. A disassociated connection owned by an AWS 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.
Request Syntax
{ "connectionId": "string", "lagId": "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.
connectionId (p. 174) The ID of the connection.
Type: String Required: Yes lagId (p. 174)
The ID of the LAG.
Type: String Required: Yes
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,
Response Elements
"location": "string", "macSecCapable": boolean, "macSecKeys": [
"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. 174)
This parameter has been deprecated.
The Direct Connect endpoint on which the physical connection terminates.
Type: String awsDeviceV2 (p. 174)
The Direct Connect endpoint that terminates the physical connection.
Type: String
awsLogicalDeviceId (p. 174)
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. 174)
The bandwidth of the connection.
Type: String connectionId (p. 174)
The ID of the connection.
Type: String
connectionName (p. 174) The name of the connection.
Response Elements
Type: String
connectionState (p. 174)
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.
Type: String
Valid Values: ordering | requested | pending | available | down | deleting | deleted | rejected | unknown
encryptionMode (p. 174)
The MAC Security (MACsec) connection encryption mode.
The valid values are no_encrypt, should_encrypt, and must_encrypt.
Type: String
hasLogicalRedundancy (p. 174)
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. 174)
Indicates whether jumbo frames (9001 MTU) are supported.
Type: Boolean lagId (p. 174)
The ID of the LAG.
Type: String loaIssueTime (p. 174)
The time of the most recent call to DescribeLoa (p. 161) for this connection.
Type: Timestamp location (p. 174)
The location of the connection.
Type: String
Errors
macSecCapable (p. 174)
Indicates whether the connection supports MAC Security (MACsec).
Type: Boolean macSecKeys (p. 174)
The MAC Security (MACsec) security keys associated with the connection.
Type: Array of MacSecKey (p. 241) objects ownerAccount (p. 174)
The ID of the AWS account that owns the connection.
Type: String partnerName (p. 174)
The name of the AWS Direct Connect service provider associated with the connection.
Type: String
portEncryptionStatus (p. 174)
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. 174)
The name of the service provider associated with the connection.
Type: String region (p. 174)
The AWS Region where the connection is located.
Type: String tags (p. 174)
The tags associated with the connection.
Type: Array of Tag (p. 260) objects
Array Members: Minimum number of 1 item.
vlan (p. 174)
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.
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
DisassociateMacSecKey
DisassociateMacSecKey
Removes the association between a MAC Security (MACsec) security key and an AWS Direct Connect dedicated connection.
Request Syntax
{ "connectionId": "string", "secretARN": "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.
connectionId (p. 179)
The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).
You can use DescribeConnections (p. 133) or DescribeLags (p. 158) to retrieve connection ID.
Type: String Required: Yes secretARN (p. 179)
The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
You can use DescribeConnections (p. 133) to retrieve the ARN of the MAC Security (MACsec) secret key.
Type: String Required: Yes
Response Syntax
{
"connectionId": "string", "macSecKeys": [
{
"ckn": "string", "secretARN": "string", "startOn": "string", "state": "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.
connectionId (p. 179)
The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).
Type: String macSecKeys (p. 179)
The MAC Security (MACsec) security keys no longer associated with the dedicated connection.
Type: Array of MacSecKey (p. 241) objects
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
ListVirtualInterfaceTestHistory
ListVirtualInterfaceTestHistory
Lists the virtual interface failover test history.
Request Syntax
{ "bgpPeers": [ "string" ], "maxResults": number, "nextToken": "string", "status": "string", "testId": "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.
bgpPeers (p. 181)
The BGP peers that were placed in the DOWN state during the virtual interface failover test.
Type: Array of strings Required: No
maxResults (p. 181)
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.
Type: Integer Required: No nextToken (p. 181)
The token for the next page of results.
Type: String Required: No status (p. 181)
The status of the virtual interface failover test.
Type: String Required: No testId (p. 181)
The ID of the virtual interface failover test.
Response Syntax
Type: String Required: No
virtualInterfaceId (p. 181)
The ID of the virtual interface that was tested.
Type: String Required: No
Response Syntax
{ "nextToken": "string",
"virtualInterfaceTestHistory": [ {
"bgpPeers": [ "string" ], "endTime": number, "ownerAccount": "string", "startTime": number, "status": "string",
"testDurationInMinutes": number, "testId": "string",
"virtualInterfaceId": "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.
nextToken (p. 182)
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Type: String
virtualInterfaceTestHistory (p. 182) The ID of the tested virtual interface.
Type: Array of VirtualInterfaceTestHistory (p. 266) objects
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
See Also
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
StartBgpFailoverTest
StartBgpFailoverTest
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.
Request Syntax
{ "bgpPeers": [ "string" ], "testDurationInMinutes": number, "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.
bgpPeers (p. 184)
The BGP peers to place in the DOWN state.
Type: Array of strings Required: No
testDurationInMinutes (p. 184)
The time in minutes that the virtual interface failover test will last.
Maximum value: 1,440 minutes (24 hours).
Default: 180 minutes (3 hours).
Type: Integer Required: No
virtualInterfaceId (p. 184)
The ID of the virtual interface you want to test.
Type: String Required: Yes
Response Syntax
{
Response Elements
"virtualInterfaceTest": { "bgpPeers": [ "string" ], "endTime": number, "ownerAccount": "string", "startTime": number, "status": "string",
"testDurationInMinutes": number, "testId": "string",
"virtualInterfaceId": "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.
virtualInterfaceTest (p. 184)
Information about the virtual interface failover test.
Type: VirtualInterfaceTestHistory (p. 266) 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
StopBgpFailoverTest
StopBgpFailoverTest
Stops the virtual interface failover test.
Request Syntax
{ "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.
virtualInterfaceId (p. 186)
The ID of the virtual interface you no longer want to test.
Type: String Required: Yes
Response Syntax
{
"virtualInterfaceTest": { "bgpPeers": [ "string" ], "endTime": number, "ownerAccount": "string", "startTime": number, "status": "string",
"testDurationInMinutes": number, "testId": "string",
"virtualInterfaceId": "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.
virtualInterfaceTest (p. 186)
Information about the virtual interface failover test.
Type: VirtualInterfaceTestHistory (p. 266) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 270).
See Also
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
TagResource
TagResource
Adds the specified tags to the specified AWS 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.
Request Syntax
{ "resourceArn": "string", "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.
resourceArn (p. 188)
The Amazon Resource Name (ARN) of the resource.
Type: String Required: Yes tags (p. 188)
The tags to add.
Type: Array of Tag (p. 260) objects
Array Members: Minimum number of 1 item.
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
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.