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

ListDevices

Returns a list of all devices on your AWS account that have AWS Snow Device Management enabled in the AWS Region where the command is run.

Request Syntax


GET /managed-devices?jobId=jobId&maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

jobId

The ID of the job used to order the device.

Length Constraints: Minimum length of 1. Maximum length of 64.

maxResults

The maximum number of devices to list per page.

Valid Range: Minimum value of 1. Maximum value of 100.

nextToken

A pagination token to continue to the next page of results.

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [a-zA-Z0-9+/=]*

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "devices": [ 
      { 
         "associatedWithJob": "string",
         "managedDeviceArn": "string",
         "managedDeviceId": "string",
         "tags": { 
            "string" : "string" 
         }
      }
   ],
   "nextToken": "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.

devices

A list of device structures that contain information about the device.

Type: Array of DeviceSummary objects

nextToken

A pagination token to continue to the next page of devices.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [a-zA-Z0-9+/=]*

Errors

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

AccessDeniedException

You don't have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400