Menu
AWS Direct Connect
API Reference (API Version 2012-10-25)

DescribeLags

Describes the link aggregation groups (LAGs) in your account.

If a LAG ID is provided, only information about the specified LAG is returned.

Request Syntax

{ "lagId": "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.

lagId

The ID of the LAG.

Example: dxlag-abc123

Default: None

Type: String

Required: No

Response Syntax

{ "lags": [ { "allowsHostedConnections": boolean, "awsDevice": "string", "connections": [ { "awsDevice": "string", "bandwidth": "string", "connectionId": "string", "connectionName": "string", "connectionState": "string", "lagId": "string", "loaIssueTime": number, "location": "string", "ownerAccount": "string", "partnerName": "string", "region": "string", "vlan": number } ], "connectionsBandwidth": "string", "lagId": "string", "lagName": "string", "lagState": "string", "location": "string", "minimumLinks": number, "numberOfConnections": number, "ownerAccount": "string", "region": "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.

lags

A list of LAGs.

Type: Array of Lag objects

Errors

For information about the errors that are common to all actions, see Common Errors.

DirectConnectClientException

The API was called with invalid parameters. The error message will contain additional details about the cause.

HTTP Status Code: 400

DirectConnectServerException

A server-side error occurred during the API call. The error message will contain additional details about the cause.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: