[ aws . networkmanager ]

update-site

Description

Updates the information for an existing site. To remove information for any of the parameters, specify an empty string.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-site
--global-network-id <value>
--site-id <value>
[--description <value>]
[--location <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--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.

Length 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 | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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.

Examples

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.

Output

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.

Length Constraints: Maximum length of 128 characters.

Value -> (string)

The tag value.

Length Constraints: Maximum length of 256 characters.