Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateDevice

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

Request Syntax


PATCH /global-networks/globalNetworkId/devices/deviceId HTTP/1.1
Content-type: application/json

{
   "AWSLocation": { 
      "SubnetArn": "string",
      "Zone": "string"
   },
   "Description": "string",
   "Location": { 
      "Address": "string",
      "Latitude": "string",
      "Longitude": "string"
   },
   "Model": "string",
   "SerialNumber": "string",
   "SiteId": "string",
   "Type": "string",
   "Vendor": "string"
}

URI Request Parameters

The request uses the following URI parameters.

deviceId

The ID of the device.

Length Constraints: Minimum length of 0. Maximum length of 50.

Pattern: [\s\S]*

Required: Yes

globalNetworkId

The ID of the global network.

Length Constraints: Minimum length of 0. Maximum length of 50.

Pattern: [\s\S]*

Required: Yes

Request Body

The request accepts the following data in JSON format.

AWSLocation

The AWS location of the device, if applicable. For an on-premises device, you can omit this parameter.

Type: AWSLocation object

Required: No

Description

A description of the device.

Constraints: Maximum length of 256 characters.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: [\s\S]*

Required: No

Location

Describes a location.

Type: Location object

Required: No

Model

The model of the device.

Constraints: Maximum length of 128 characters.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: [\s\S]*

Required: No

SerialNumber

The serial number of the device.

Constraints: Maximum length of 128 characters.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: [\s\S]*

Required: No

SiteId

The ID of the site.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 50.

Pattern: [\s\S]*

Required: No

Type

The type of the device.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: [\s\S]*

Required: No

Vendor

The vendor of the device.

Constraints: Maximum length of 128 characters.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: [\s\S]*

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Device": { 
      "AWSLocation": { 
         "SubnetArn": "string",
         "Zone": "string"
      },
      "CreatedAt": number,
      "Description": "string",
      "DeviceArn": "string",
      "DeviceId": "string",
      "GlobalNetworkId": "string",
      "Location": { 
         "Address": "string",
         "Latitude": "string",
         "Longitude": "string"
      },
      "Model": "string",
      "SerialNumber": "string",
      "SiteId": "string",
      "State": "string",
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ],
      "Type": "string",
      "Vendor": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Device

Information about the device.

Type: Device object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

HTTP Status Code: 409

InternalServerException

The request has failed due to an internal error.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource could not be found.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints.

HTTP Status Code: 400