SageMaker / Client / create_edge_deployment_plan

create_edge_deployment_plan#

SageMaker.Client.create_edge_deployment_plan(**kwargs)#

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

Request Syntax

response = client.create_edge_deployment_plan(
    EdgeDeploymentPlanName='string',
    ModelConfigs=[
        {
            'ModelHandle': 'string',
            'EdgePackagingJobName': 'string'
        },
    ],
    DeviceFleetName='string',
    Stages=[
        {
            'StageName': 'string',
            'DeviceSelectionConfig': {
                'DeviceSubsetType': 'PERCENTAGE'|'SELECTION'|'NAMECONTAINS',
                'Percentage': 123,
                'DeviceNames': [
                    'string',
                ],
                'DeviceNameContains': 'string'
            },
            'DeploymentConfig': {
                'FailureHandlingPolicy': 'ROLLBACK_ON_FAILURE'|'DO_NOTHING'
            }
        },
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

EdgeDeploymentPlanName (string) –
[REQUIRED]

The name of the edge deployment plan.
ModelConfigs (list) –
[REQUIRED]

List of models associated with the edge deployment plan.
- (dict) –
  
  Contains information about the configuration of a model in a deployment.
  - ModelHandle (string) – [REQUIRED]
    
    The name the device application uses to reference this model.
  - EdgePackagingJobName (string) – [REQUIRED]
    
    The edge packaging job associated with this deployment.
DeviceFleetName (string) –
[REQUIRED]

The device fleet used for this edge deployment plan.
Stages (list) –
List of stages of the edge deployment plan. The number of stages is limited to 10 per deployment.
- (dict) –
  
  Contains information about a stage in an edge deployment plan.
  - StageName (string) – [REQUIRED]
    
    The name of the stage.
  - DeviceSelectionConfig (dict) – [REQUIRED]
    
    Configuration of the devices in the stage.
    - DeviceSubsetType (string) – [REQUIRED]
      
      Type of device subsets to deploy to the current stage.
    - Percentage (integer) –
      
      Percentage of devices in the fleet to deploy to the current stage.
    - DeviceNames (list) –
      
      List of devices chosen to deploy.
      - (string) –
    - DeviceNameContains (string) –
      
      A filter to select devices with names containing this name.
  - DeploymentConfig (dict) –
    
    Configuration of the deployment details.
    - FailureHandlingPolicy (string) – [REQUIRED]
      
      Toggle that determines whether to rollback to previous configuration if the current deployment fails. By default this is turned on. You may turn this off if you want to investigate the errors yourself.
Tags (list) –
List of tags with which to tag the edge deployment plan.
- (dict) –
  
  A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.
  
  You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags.
  
  For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources. For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy.
  - Key (string) – [REQUIRED]
    
    The tag key. Tag keys must be unique per resource.
  - Value (string) – [REQUIRED]
    
    The tag value.

Return type:

dict

Returns:

Response Syntax

{
    'EdgeDeploymentPlanArn': 'string'
}

Response Structure

(dict) –
- EdgeDeploymentPlanArn (string) –
  
  The ARN of the edge deployment plan.

Exceptions

SageMaker.Client.exceptions.ResourceLimitExceeded