DescribeRouterConfiguration - AWS Direct Connect

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.

The request accepts the following data in JSON format.

routerTypeIdentifier

Identifies the router by a combination of vendor, platform, and software version. For example, CiscoSystemsInc-2900SeriesRouters-IOS124.

Type: String

Required: No

virtualInterfaceId

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.

customerRouterConfig

The customer router configuration.

Type: String

router

The details about the router.

Type: RouterType object

virtualInterfaceId

The ID assigned to the virtual interface.

Type: String

virtualInterfaceName

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.

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: