Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListDeviceInstances

Returns information about the private device instances associated with one or more AWS accounts.

Request Syntax


{
   "maxResults": number,
   "nextToken": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

maxResults

An integer that specifies the maximum number of items you want to return in the API response.

Type: Integer

Required: No

nextToken

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Type: String

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

Required: No

Response Syntax


{
   "deviceInstances": [ 
      { 
         "arn": "string",
         "deviceArn": "string",
         "instanceProfile": { 
            "arn": "string",
            "description": "string",
            "excludeAppPackagesFromCleanup": [ "string" ],
            "name": "string",
            "packageCleanup": boolean,
            "rebootAfterUse": boolean
         },
         "labels": [ "string" ],
         "status": "string",
         "udid": "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.

deviceInstances

An object that contains information about your device instances.

Type: Array of DeviceInstance objects

nextToken

An identifier that can be used in the next call to this operation to return the next set of items in the list.

Type: String

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

Errors

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

ArgumentException

An invalid argument was specified.

HTTP Status Code: 400

LimitExceededException

A limit was exceeded.

HTTP Status Code: 400

NotFoundException

The specified entity was not found.

HTTP Status Code: 400

ServiceAccountException

There was a problem with the service account.

HTTP Status Code: 400