DescribeConnections - Amazon Direct Connect
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

DescribeConnections

Displays the specified connection or all connections in this Region.

Request Syntax

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

connectionId

The ID of the connection.

Type: String

Required: No

Response Syntax

{ "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", "partnerName": "string", "portEncryptionStatus": "string", "providerName": "string", "region": "string", "tags": [ { "key": "string", "value": "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.

connections

The connections.

Type: Array of Connection objects

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 Amazon SDKs, see the following: