Amazon WorkLink
API Reference (API Version 2018-09-25)

ListDevices

Retrieves a list of devices registered with the specified fleet.

Request Syntax

POST /listDevices HTTP/1.1 Content-type: application/json { "FleetArn": "string", "MaxResults": number, "NextToken": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

FleetArn

The ARN of the fleet.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Required: Yes

MaxResults

The maximum number of results to be included in the next page.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

NextToken

The pagination token used to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Type: String

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

Pattern: [\w\-]+

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Devices": [ { "DeviceId": "string", "DeviceStatus": "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

Information about the devices.

Type: Array of DeviceSummary objects

NextToken

The pagination token used to retrieve the next page of results for this operation. If there are no more pages, this value is null.

Type: String

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

Pattern: [\w\-]+

Errors

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

InternalServerErrorException

The service is temporarily unavailable.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ResourceNotFoundException

The requested resource was not found.

HTTP Status Code: 404

TooManyRequestsException

The number of requests exceeds the limit.

HTTP Status Code: 429

UnauthorizedException

You are not authorized to perform this action.

HTTP Status Code: 403

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: