GetDeployments - Amazon SageMaker
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

GetDeployments

Use to get the active deployments from a device.

Request Syntax

POST /GetDeployments 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 to which the device belongs.

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 from which you want to get the configuration of active deployments.

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 { "Deployments": [ { "Definitions": [ { "Checksum": { "Sum": "string", "Type": "string" }, "ModelHandle": "string", "S3Url": "string", "State": "string" } ], "DeploymentName": "string", "FailureHandlingPolicy": "string", "Type": "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.

Deployments

Returns a list of the configurations of the active deployments on the device.

Type: Array of EdgeDeployment objects

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 Amazon customer support.

HTTP Status Code: 400

See Also

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