Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).
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 . networkmanager ]
Deletes an existing link. You must first disassociate the link from any devices and customer gateways.
See also: AWS API Documentation
See 'aws help' for descriptions of global parameters.
delete-link
--global-network-id <value>
--link-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
--global-network-id
(string)
The ID of the global network.
--link-id
(string)
The ID of the link.
--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.
See 'aws help' for descriptions of global parameters.
To delete a link
The following delete-link
example deletes the specified link from the specified global network.
aws networkmanager delete-link \
--global-network-id global-network-01231231231231231 \
--link-id link-11112222aaaabbbb1 \
--region us-west-2
Output:
{
"Link": {
"LinkId": "link-11112222aaaabbbb1",
"LinkArn": "arn:aws:networkmanager::123456789012:link/global-network-01231231231231231/link-11112222aaaabbbb1",
"GlobalNetworkId": "global-network-01231231231231231",
"SiteId": "site-444555aaabbb11223",
"Description": "VPN Link",
"Type": "broadband",
"Bandwidth": {
"UploadSpeed": 20,
"DownloadSpeed": 20
},
"Provider": "AnyCompany",
"CreatedAt": 1575555811.0,
"State": "DELETING"
}
}
For more information, see Working with Links in the Transit Gateway Network Manager Guide.
Link -> (structure)
Information about the link.
LinkId -> (string)
The ID of the link.LinkArn -> (string)
The Amazon Resource Name (ARN) of the link.GlobalNetworkId -> (string)
The ID of the global network.SiteId -> (string)
The ID of the site.Description -> (string)
The description of the link.Type -> (string)
The type of the link.Bandwidth -> (structure)
The bandwidth for the link.
UploadSpeed -> (integer)
Upload speed in Mbps.DownloadSpeed -> (integer)
Download speed in Mbps.Provider -> (string)
The provider of the link.CreatedAt -> (timestamp)
The date and time that the link was created.State -> (string)
The state of the link.Tags -> (list)
The tags for the link.
(structure)
Describes a tag.
Key -> (string)
The tag key.
Constraints: Maximum length of 128 characters.
Value -> (string)
The tag value.
Constraints: Maximum length of 256 characters.