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

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

DescribeDevice

Provides information about a user's device.

Request Syntax

POST /describeDevice HTTP/1.1 Content-type: application/json { "DeviceId": "string", "FleetArn": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

DeviceId

A unique identifier for a registered user's device.

Type: String

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

Required: Yes

FleetArn

The ARN of the fleet.

Type: String

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

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "FirstAccessedTime": number, "LastAccessedTime": number, "Manufacturer": "string", "Model": "string", "OperatingSystem": "string", "OperatingSystemVersion": "string", "PatchLevel": "string", "Status": "string", "Username": "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.

FirstAccessedTime

The date that the device first signed in to Amazon WorkLink.

Type: Timestamp

LastAccessedTime

The date that the device last accessed Amazon WorkLink.

Type: Timestamp

Manufacturer

The manufacturer of the device.

Type: String

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

Model

The model of the device.

Type: String

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

OperatingSystem

The operating system of the device.

Type: String

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

OperatingSystemVersion

The operating system version of the device.

Type: String

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

PatchLevel

The operating system patch level of the device.

Type: String

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

Status

The current state of the device.

Type: String

Valid Values: ACTIVE | SIGNED_OUT

Username

The user name associated with the device.

Type: String

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

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: