GetDeviceRegistration - Amazon SageMaker Service

GetDeviceRegistration

Use to check if a device is registered with SageMaker Edge Manager.

Request Syntax

POST /GetDeviceRegistration HTTP/1.1 Content-type: application/json { "DeviceFleetName": "string", "DeviceName": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

DeviceFleetName

The name of the fleet that the device belongs to.

Type: String

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

Pattern: ^[a-zA-Z0-9](-*_*[a-zA-Z0-9])*$

Required: Yes

DeviceName

The unique name of the device you want to get the registration status from.

Type: String

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

Pattern: ^[a-zA-Z0-9](-*_*[a-zA-Z0-9])*$

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "CacheTTL": "string", "DeviceRegistration": "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.

CacheTTL

The amount of time, in seconds, that the registration status is stored on the device’s cache before it is refreshed.

Type: String

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

DeviceRegistration

Describes if the device is currently registered with SageMaker Edge Manager.

Type: String

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

Errors

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

InternalServiceException

An internal failure occurred. Try your request again. If the problem persists, contact AWS customer support.

HTTP Status Code: 400

See Also

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