Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeLags

Describes all your link aggregation groups (LAG) or the specified LAG.

Request Syntax


{
   "lagId": "string",
   "maxResults": number,
   "nextToken": "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.

Type: String

Required: No

maxResults

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

The token for the next page of results.

Type: String

Required: No

Response Syntax


{
   "lags": [ 
      { 
         "allowsHostedConnections": boolean,
         "awsDevice": "string",
         "awsDeviceV2": "string",
         "awsLogicalDeviceId": "string",
         "connections": [ 
            { 
               "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": [ 
                  { 
                     "ckn": "string",
                     "secretARN": "string",
                     "startOn": "string",
                     "state": "string"
                  }
               ],
               "ownerAccount": "string",
               "partnerInterconnectMacSecCapable": boolean,
               "partnerName": "string",
               "portEncryptionStatus": "string",
               "providerName": "string",
               "region": "string",
               "tags": [ 
                  { 
                     "key": "string",
                     "value": "string"
                  }
               ],
               "vlan": number
            }
         ],
         "connectionsBandwidth": "string",
         "encryptionMode": "string",
         "hasLogicalRedundancy": "string",
         "jumboFrameCapable": boolean,
         "lagId": "string",
         "lagName": "string",
         "lagState": "string",
         "location": "string",
         "macSecCapable": boolean,
         "macSecKeys": [ 
            { 
               "ckn": "string",
               "secretARN": "string",
               "startOn": "string",
               "state": "string"
            }
         ],
         "minimumLinks": number,
         "numberOfConnections": number,
         "ownerAccount": "string",
         "providerName": "string",
         "region": "string",
         "tags": [ 
            { 
               "key": "string",
               "value": "string"
            }
         ]
      }
   ],
   "nextToken": "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

The LAGs.

Type: Array of Lag objects

nextToken

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

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