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 ]
Updates the information for an existing site. To remove information for any of the parameters, specify an empty string.
See also: AWS API Documentation
update-site
--global-network-id <value>
--site-id <value>
[--description <value>]
[--location <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>]
--global-network-id
(string)
The ID of the global network.
--site-id
(string)
The ID of your site.
--description
(string)
A description of your site.
Constraints: Maximum length of 256 characters.
--location
(structure)
The site location:
Address
: The physical address of the site.Latitude
: The latitude of the site.Longitude
: The longitude of the site.Address -> (string)
The physical address.Latitude -> (string)
The latitude.Longitude -> (string)
The longitude.
Shorthand Syntax:
Address=string,Latitude=string,Longitude=string
JSON Syntax:
{
"Address": "string",
"Latitude": "string",
"Longitude": "string"
}
--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 update a site
The following update-site
example updates the description for site site-444555aaabbb11223
in the specified global network.
aws networkmanager update-site \
--global-network-id global-network-01231231231231231 \
--site-id site-444555aaabbb11223 \
--description "New York Office site" \
--region us-west-2
Output:
{
"Site": {
"SiteId": "site-444555aaabbb11223",
"SiteArn": "arn:aws:networkmanager::123456789012:site/global-network-01231231231231231/site-444555aaabbb11223",
"GlobalNetworkId": "global-network-01231231231231231",
"Description": "New York Office site",
"Location": {
"Latitude": "40.7128",
"Longitude": "-74.0060"
},
"CreatedAt": 1575554528.0,
"State": "UPDATING"
}
}
For more information, see Working with Sites in the Transit Gateway Network Manager Guide.
Site -> (structure)
Information about the site.
SiteId -> (string)
The ID of the site.SiteArn -> (string)
The Amazon Resource Name (ARN) of the site.GlobalNetworkId -> (string)
The ID of the global network.Description -> (string)
The description of the site.Location -> (structure)
The location of the site.
Address -> (string)
The physical address.Latitude -> (string)
The latitude.Longitude -> (string)
The longitude.CreatedAt -> (timestamp)
The date and time that the site was created.State -> (string)
The state of the site.Tags -> (list)
The tags for the site.
(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.