AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
[ aws . directconnect ]
Describes all your link aggregation groups (LAG) or the specified LAG.
See also: AWS API Documentation
describe-lags
[--lag-id <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--lag-id
(string)
The ID of the LAG.
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To describe your LAGs
The following command describes all of your LAGs for the current region.
Command:
aws directconnect describe-lags
Output:
{
"lags": [
{
"awsDevice": "EqDC2-19y7z3m17xpuz",
"numberOfConnections": 2,
"lagState": "down",
"ownerAccount": "123456789012",
"lagName": "DA-LAG",
"connections": [
{
"ownerAccount": "123456789012",
"connectionId": "dxcon-ffnikghc",
"lagId": "dxlag-fgsu9erb",
"connectionState": "requested",
"bandwidth": "10Gbps",
"location": "EqDC2",
"connectionName": "Requested Connection 1 for Lag dxlag-fgsu9erb",
"region": "us-east-1"
},
{
"ownerAccount": "123456789012",
"connectionId": "dxcon-fglgbdea",
"lagId": "dxlag-fgsu9erb",
"connectionState": "requested",
"bandwidth": "10Gbps",
"location": "EqDC2",
"connectionName": "Requested Connection 2 for Lag dxlag-fgsu9erb",
"region": "us-east-1"
}
],
"lagId": "dxlag-fgsu9erb",
"minimumLinks": 0,
"connectionsBandwidth": "10Gbps",
"region": "us-east-1",
"location": "EqDC2"
}
]
}
lags -> (list)
The LAGs.
(structure)
Information about a link aggregation group (LAG).
connectionsBandwidth -> (string)
The individual bandwidth of the physical connections bundled by the LAG. The possible values are 1Gbps, 10Gbps, 100Gbps, or 400 Gbps..numberOfConnections -> (integer)
The number of physical dedicated connections initially provisioned and bundled by the LAG. You can have a maximum of four connections when the port speed is 1 Gbps or 10 Gbps, or two when the port speed is 100 Gbps or 400 Gbps.lagId -> (string)
The ID of the LAG.ownerAccount -> (string)
The ID of the Amazon Web Services account that owns the LAG.lagName -> (string)
The name of the LAG.lagState -> (string)
The state of the LAG. The following are the possible values:
requested
: The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.pending
: The LAG has been approved and is being initialized.available
: The network link is established and the LAG is ready for use.down
: The network link is down.deleting
: The LAG is being deleted.deleted
: The LAG is deleted.unknown
: The state of the LAG is not available.location -> (string)
The location of the LAG.region -> (string)
The Amazon Web Services Region where the connection is located.minimumLinks -> (integer)
The minimum number of physical dedicated connections that must be operational for the LAG itself to be operational.awsDevice -> (string)
The Direct Connect endpoint that hosts the LAG.awsDeviceV2 -> (string)
The Direct Connect endpoint that hosts the LAG.awsLogicalDeviceId -> (string)
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.connections -> (list)
The connections bundled by the LAG.
(structure)
Information about an Direct Connect connection.
ownerAccount -> (string)
The ID of the Amazon Web Services account that owns the connection.connectionId -> (string)
The ID of the connection.connectionName -> (string)
The name of the connection.connectionState -> (string)
The state of the connection. The following are the possible values:
ordering
: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.requested
: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.pending
: The connection has been approved and is being initialized.available
: The network link is up and the connection is ready for use.down
: The network link is down.deleting
: The connection is being deleted.deleted
: The connection has been deleted.rejected
: A hosted connection in theordering
state enters therejected
state if it is deleted by the customer.unknown
: The state of the connection is not available.region -> (string)
The Amazon Web Services Region where the connection is located.location -> (string)
The location of the connection.bandwidth -> (string)
The bandwidth of the connection.vlan -> (integer)
The ID of the VLAN.partnerName -> (string)
The name of the Direct Connect service provider associated with the connection.loaIssueTime -> (timestamp)
The time of the most recent call to DescribeLoa for this connection.lagId -> (string)
The ID of the LAG.awsDevice -> (string)
The Direct Connect endpoint on which the physical connection terminates.jumboFrameCapable -> (boolean)
Indicates whether jumbo frames are supported.awsDeviceV2 -> (string)
The Direct Connect endpoint that terminates the physical connection.awsLogicalDeviceId -> (string)
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.hasLogicalRedundancy -> (string)
Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).tags -> (list)
The tags associated with the connection.
(structure)
Information about a tag.
key -> (string)
The key.value -> (string)
The value.providerName -> (string)
The name of the service provider associated with the connection.macSecCapable -> (boolean)
Indicates whether the connection supports MAC Security (MACsec).portEncryptionStatus -> (string)
The MAC Security (MACsec) port link status of the connection.
The valid values are
Encryption Up
, which means that there is an active Connection Key Name, orEncryption Down
.encryptionMode -> (string)
The MAC Security (MACsec) connection encryption mode.
The valid values are
no_encrypt
,should_encrypt
, andmust_encrypt
.macSecKeys -> (list)
The MAC Security (MACsec) security keys associated with the connection.
(structure)
Information about the MAC Security (MACsec) secret key.
secretARN -> (string)
The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.ckn -> (string)
The Connection Key Name (CKN) for the MAC Security secret key.state -> (string)
The state of the MAC Security (MACsec) secret key.
The possible values are:
associating
: The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.associated
: The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.disassociating
: The MAC Security (MACsec) secret key is being disassociated from the connection or LAGdisassociated
: The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.startOn -> (string)
The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.allowsHostedConnections -> (boolean)
Indicates whether the LAG can host other connections.jumboFrameCapable -> (boolean)
Indicates whether jumbo frames are supported.hasLogicalRedundancy -> (string)
Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).tags -> (list)
The tags associated with the LAG.
(structure)
Information about a tag.
key -> (string)
The key.value -> (string)
The value.providerName -> (string)
The name of the service provider associated with the LAG.macSecCapable -> (boolean)
Indicates whether the LAG supports MAC Security (MACsec).encryptionMode -> (string)
The LAG MAC Security (MACsec) encryption mode.
The valid values are
no_encrypt
,should_encrypt
, andmust_encrypt
.macSecKeys -> (list)
The MAC Security (MACsec) security keys associated with the LAG.
(structure)
Information about the MAC Security (MACsec) secret key.
secretARN -> (string)
The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.ckn -> (string)
The Connection Key Name (CKN) for the MAC Security secret key.state -> (string)
The state of the MAC Security (MACsec) secret key.
The possible values are:
associating
: The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.associated
: The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.disassociating
: The MAC Security (MACsec) secret key is being disassociated from the connection or LAGdisassociated
: The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.startOn -> (string)
The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.