Getting Information About Your Connections

You can get information about your connections located in the Region corresponding to your account.

If you exceed the number of identical requests allowed for a configured time period, the Throttling error message is returned.

This procedure uses AWS CLI only. Information about these resources is also available from Cockpit v1. For more information, see DirectLink User Interface.

To get information about your connections, use the describe-connections command following this syntax:

Request sample
$ aws directconnect describe-connections \
    --profile YOUR_PROFILE \
    --connection-id dxcon-12345678 \

This command contains the following attributes that you need to specify:

  • (optional) profile: The named profile you want to use, created when configuring AWS CLI. For more information, see Installing and Configuring AWS CLI.

  • (optional) connection-id: The ID of a connection.

    If you do not specify any connection ID, all your connections in the Region corresponding to your account are described.

  • endpoint: The endpoint corresponding to the Region you want to send the request to.

The describe-connections command returns the following elements:

  • connections: Information about one or more connections. This element contains the following information for each connection:

    • ownerAccount: The account ID of the owner of the requested connection.

    • connectionID: The ID of the connection.

    • connectionState: The state of the connection. For more information, see About DirectLink > DirectLink Physical Connections.

    • bandwidth: The bandwidth for the connection.

    • location: The location of the connection.

    • connectionName: The name of the connection.

    • region: The Region where the connection is.

Result sample
    "connections": [
            "ownerAccount": "123456789012",
            "connectionId": "dxcon-12345678",
            "connectionState": "requested",
            "bandwidth": "1Gbps",
            "location": "PAR1",
            "connectionName": "Connection to Outscale",
            "region": "eu-west-2"

Related Pages

Corresponding API Method

AWS™ and Amazon Web Services™ are trademarks of Amazon Technologies, Inc or its affiliates in the United States and/or other countries.