CreateEdgeDeploymentPlan
Creates an edge deployment plan, consisting of multiple stages. Each stage may have a different deployment configuration and devices.
Request Syntax
{
"DeviceFleetName": "string
",
"EdgeDeploymentPlanName": "string
",
"ModelConfigs": [
{
"EdgePackagingJobName": "string
",
"ModelHandle": "string
"
}
],
"Stages": [
{
"DeploymentConfig": {
"FailureHandlingPolicy": "string
"
},
"DeviceSelectionConfig": {
"DeviceNameContains": "string
",
"DeviceNames": [ "string
" ],
"DeviceSubsetType": "string
",
"Percentage": number
},
"StageName": "string
"
}
],
"Tags": [
{
"Key": "string
",
"Value": "string
"
}
]
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- DeviceFleetName
-
The device fleet used for this edge deployment plan.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$
Required: Yes
- EdgeDeploymentPlanName
-
The name of the edge deployment plan.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$
Required: Yes
- ModelConfigs
-
List of models associated with the edge deployment plan.
Type: Array of EdgeDeploymentModelConfig objects
Required: Yes
- Stages
-
List of stages of the edge deployment plan. The number of stages is limited to 10 per deployment.
Type: Array of DeploymentStage objects
Required: No
- Tags
-
List of tags with which to tag the edge deployment plan.
Type: Array of Tag objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Required: No
Response Syntax
{
"EdgeDeploymentPlanArn": "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.
- EdgeDeploymentPlanArn
-
The ARN of the edge deployment plan.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
^arn:aws[a-z\-]*:sagemaker:[a-z\-]*:\d{12}:edge-deployment/?[a-zA-Z_0-9+=,.@\-_/]+$
Errors
For information about the errors that are common to all actions, see Common Errors.
- ResourceLimitExceeded
-
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: