[ aws . sagemaker-edge ]

get-deployments

Description

Use to get the active deployments from a device.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-deployments
--device-name <value>
--device-fleet-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--device-name (string)

The unique name of the device you want to get the configuration of active deployments from.

--device-fleet-name (string)

The name of the fleet that the device belongs to.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

Deployments -> (list)

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

(structure)

Information about a deployment on an edge device that is registered with SageMaker Edge Manager.

DeploymentName -> (string)

The name and unique ID of the deployment.

Type -> (string)

The type of the deployment.

FailureHandlingPolicy -> (string)

Determines whether to rollback to previous configuration if deployment fails.

Definitions -> (list)

Returns a list of Definition objects.

(structure)

ModelHandle -> (string)

The unique model handle.

S3Url -> (string)

The absolute S3 location of the model.

Checksum -> (structure)

The checksum information of the model.

Type -> (string)

The type of the checksum.

Sum -> (string)

The checksum of the model.

State -> (string)

The desired state of the model.