delete_site

delete_site(**kwargs)

Deletes an existing site. The site cannot be associated with any device or link.

See also: AWS API Documentation

Request Syntax

response = client.delete_site(
    GlobalNetworkId='string',
    SiteId='string'
)

Parameters

• GlobalNetworkId (string) --

  [REQUIRED]

  The ID of the global network.

• SiteId (string) --

  [REQUIRED]

  The ID of the site.

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

• NetworkManager.Client.exceptions.ValidationException
• NetworkManager.Client.exceptions.AccessDeniedException
• NetworkManager.Client.exceptions.ResourceNotFoundException
• NetworkManager.Client.exceptions.ConflictException
• NetworkManager.Client.exceptions.ThrottlingException
• NetworkManager.Client.exceptions.InternalServerException