NetworkManager / Client / update_site

update_site#

NetworkManager.Client.update_site(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.update_site(
    GlobalNetworkId='string',
    SiteId='string',
    Description='string',
    Location={
        'Address': 'string',
        'Latitude': 'string',
        'Longitude': 'string'
    }
)
Parameters:

  • GlobalNetworkId (string) –

    [REQUIRED]

    The ID of the global network.

  • SiteId (string) –

    [REQUIRED]

    The ID of your site.

  • Description (string) –

    A description of your site.

    Constraints: Maximum length of 256 characters.

  • Location (dict) –

    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.

Return type:

dict

Returns:

Response Syntax

{
    'Site': {
        'SiteId': 'string',
        'SiteArn': 'string',
        'GlobalNetworkId': 'string',
        'Description': 'string',
        'Location': {
            'Address': 'string',
            'Latitude': 'string',
            'Longitude': 'string'
        },
        'CreatedAt': datetime(2015, 1, 1),
        'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) –

    • Site (dict) –

      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 (dict) –

        The location of the site.

        • Address (string) –

          The physical address.

        • Latitude (string) –

          The latitude.

        • Longitude (string) –

          The longitude.

      • CreatedAt (datetime) –

        The date and time that the site was created.

      • State (string) –

        The state of the site.

      • Tags (list) –

        The tags for the site.

        • (dict) –

          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.

Exceptions