CreateEdgeDeploymentPlanCommand

Suggest an Edit

Creates an edge deployment plan, consisting of multiple stages. Each stage may have a different deployment configuration and devices.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { SageMakerClient, CreateEdgeDeploymentPlanCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import
// const { SageMakerClient, CreateEdgeDeploymentPlanCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import
const client = new SageMakerClient(config);
const input = { // CreateEdgeDeploymentPlanRequest
  EdgeDeploymentPlanName: "STRING_VALUE", // required
  ModelConfigs: [ // EdgeDeploymentModelConfigs // required
    { // EdgeDeploymentModelConfig
      ModelHandle: "STRING_VALUE", // required
      EdgePackagingJobName: "STRING_VALUE", // required
    },
  ],
  DeviceFleetName: "STRING_VALUE", // required
  Stages: [ // DeploymentStages
    { // DeploymentStage
      StageName: "STRING_VALUE", // required
      DeviceSelectionConfig: { // DeviceSelectionConfig
        DeviceSubsetType: "PERCENTAGE" || "SELECTION" || "NAMECONTAINS", // required
        Percentage: Number("int"),
        DeviceNames: [ // DeviceNames
          "STRING_VALUE",
        ],
        DeviceNameContains: "STRING_VALUE",
      },
      DeploymentConfig: { // EdgeDeploymentConfig
        FailureHandlingPolicy: "ROLLBACK_ON_FAILURE" || "DO_NOTHING", // required
      },
    },
  ],
  Tags: [ // TagList
    { // Tag
      Key: "STRING_VALUE", // required
      Value: "STRING_VALUE", // required
    },
  ],
};
const command = new CreateEdgeDeploymentPlanCommand(input);
const response = await client.send(command);
// { // CreateEdgeDeploymentPlanResponse
//   EdgeDeploymentPlanArn: "STRING_VALUE", // required
// };

CreateEdgeDeploymentPlanCommand Input

See CreateEdgeDeploymentPlanCommandInput for more details

Parameter
Type
Description
DeviceFleetName
Required
string | undefined

The device fleet used for this edge deployment plan.

EdgeDeploymentPlanName
Required
string | undefined

The name of the edge deployment plan.

ModelConfigs
Required
EdgeDeploymentModelConfig[] | undefined

List of models associated with the edge deployment plan.

Stages
DeploymentStage[] | undefined

List of stages of the edge deployment plan. The number of stages is limited to 10 per deployment.

Tags
Tag[] | undefined

List of tags with which to tag the edge deployment plan.

CreateEdgeDeploymentPlanCommand Output

See CreateEdgeDeploymentPlanCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
EdgeDeploymentPlanArn
Required
string | undefined

The ARN of the edge deployment plan.

Throws

Name
Fault
Details
ResourceLimitExceeded
client

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

SageMakerServiceException
Base exception class for all service exceptions from SageMaker service.