NetworkManager / Client / delete_device

delete_device#

NetworkManager.Client.delete_device(**kwargs)#

Deletes an existing device. You must first disassociate the device from any links and customer gateways.

Request Syntax

response = client.delete_device(
    GlobalNetworkId='string',
    DeviceId='string'
)

Parameters:

GlobalNetworkId (string) –
[REQUIRED]

The ID of the global network.
DeviceId (string) –
[REQUIRED]

The ID of the device.

Return type:

dict

Returns:

Response Syntax

{
    'Device': {
        'DeviceId': 'string',
        'DeviceArn': 'string',
        'GlobalNetworkId': 'string',
        'AWSLocation': {
            'Zone': 'string',
            'SubnetArn': 'string'
        },
        'Description': 'string',
        'Type': 'string',
        'Vendor': 'string',
        'Model': 'string',
        'SerialNumber': 'string',
        'Location': {
            'Address': 'string',
            'Latitude': 'string',
            'Longitude': 'string'
        },
        'SiteId': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

(dict) –
- Device (dict) –
  
  Information about the device.
  - DeviceId (string) –
    
    The ID of the device.
  - DeviceArn (string) –
    
    The Amazon Resource Name (ARN) of the device.
  - GlobalNetworkId (string) –
    
    The ID of the global network.
  - AWSLocation (dict) –
    
    The Amazon Web Services location of the device.
    - Zone (string) –
      
      The Zone that the device is located in. Specify the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost.
    - SubnetArn (string) –
      
      The Amazon Resource Name (ARN) of the subnet that the device is located in.
  - Description (string) –
    
    The description of the device.
  - Type (string) –
    
    The device type.
  - Vendor (string) –
    
    The device vendor.
  - Model (string) –
    
    The device model.
  - SerialNumber (string) –
    
    The device serial number.
  - Location (dict) –
    
    The site location.
    - Address (string) –
      
      The physical address.
    - Latitude (string) –
      
      The latitude.
    - Longitude (string) –
      
      The longitude.
  - SiteId (string) –
    
    The site ID.
  - CreatedAt (datetime) –
    
    The date and time that the site was created.
  - State (string) –
    
    The device state.
  - Tags (list) –
    
    The tags for the device.
    - (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