SageMaker / Client / describe_edge_deployment_plan

describe_edge_deployment_plan#

SageMaker.Client.describe_edge_deployment_plan(**kwargs)#

Describes an edge deployment plan with deployment status per stage.

Request Syntax

response = client.describe_edge_deployment_plan(
    EdgeDeploymentPlanName='string',
    NextToken='string',
    MaxResults=123
)

Parameters:

EdgeDeploymentPlanName (string) –
[REQUIRED]

The name of the deployment plan to describe.
NextToken (string) – If the edge deployment plan has enough stages to require tokening, then this is the response from the last list of stages returned.
MaxResults (integer) – The maximum number of results to select (50 by default).

Return type:

dict

Returns:

Response Syntax

{
    'EdgeDeploymentPlanArn': 'string',
    'EdgeDeploymentPlanName': 'string',
    'ModelConfigs': [
        {
            'ModelHandle': 'string',
            'EdgePackagingJobName': 'string'
        },
    ],
    'DeviceFleetName': 'string',
    'EdgeDeploymentSuccess': 123,
    'EdgeDeploymentPending': 123,
    'EdgeDeploymentFailed': 123,
    'Stages': [
        {
            'StageName': 'string',
            'DeviceSelectionConfig': {
                'DeviceSubsetType': 'PERCENTAGE'|'SELECTION'|'NAMECONTAINS',
                'Percentage': 123,
                'DeviceNames': [
                    'string',
                ],
                'DeviceNameContains': 'string'
            },
            'DeploymentConfig': {
                'FailureHandlingPolicy': 'ROLLBACK_ON_FAILURE'|'DO_NOTHING'
            },
            'DeploymentStatus': {
                'StageStatus': 'CREATING'|'READYTODEPLOY'|'STARTING'|'INPROGRESS'|'DEPLOYED'|'FAILED'|'STOPPING'|'STOPPED',
                'EdgeDeploymentSuccessInStage': 123,
                'EdgeDeploymentPendingInStage': 123,
                'EdgeDeploymentFailedInStage': 123,
                'EdgeDeploymentStatusMessage': 'string',
                'EdgeDeploymentStageStartTime': datetime(2015, 1, 1)
            }
        },
    ],
    'NextToken': 'string',
    'CreationTime': datetime(2015, 1, 1),
    'LastModifiedTime': datetime(2015, 1, 1)
}

Response Structure

(dict) –
- EdgeDeploymentPlanArn (string) –
  
  The ARN of edge deployment plan.
- EdgeDeploymentPlanName (string) –
  
  The name of the edge deployment plan.
- ModelConfigs (list) –
  
  List of models associated with the edge deployment plan.
  - (dict) –
    
    Contains information about the configuration of a model in a deployment.
    - ModelHandle (string) –
      
      The name the device application uses to reference this model.
    - EdgePackagingJobName (string) –
      
      The edge packaging job associated with this deployment.
- DeviceFleetName (string) –
  
  The device fleet used for this edge deployment plan.
- EdgeDeploymentSuccess (integer) –
  
  The number of edge devices with the successful deployment.
- EdgeDeploymentPending (integer) –
  
  The number of edge devices yet to pick up deployment, or in progress.
- EdgeDeploymentFailed (integer) –
  
  The number of edge devices that failed the deployment.
- Stages (list) –
  
  List of stages in the edge deployment plan.
  - (dict) –
    
    Contains information summarizing the deployment stage results.
    - StageName (string) –
      
      The name of the stage.
    - DeviceSelectionConfig (dict) –
      
      Configuration of the devices in the stage.
      - DeviceSubsetType (string) –
        
        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) –
        
        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.
    - DeploymentStatus (dict) –
      
      General status of the current state.
      - StageStatus (string) –
        
        The general status of the current stage.
      - EdgeDeploymentSuccessInStage (integer) –
        
        The number of edge devices with the successful deployment in the current stage.
      - EdgeDeploymentPendingInStage (integer) –
        
        The number of edge devices yet to pick up the deployment in current stage, or in progress.
      - EdgeDeploymentFailedInStage (integer) –
        
        The number of edge devices that failed the deployment in current stage.
      - EdgeDeploymentStatusMessage (string) –
        
        A detailed message about deployment status in current stage.
      - EdgeDeploymentStageStartTime (datetime) –
        
        The time when the deployment API started.
- NextToken (string) –
  
  Token to use when calling the next set of stages in the edge deployment plan.
- CreationTime (datetime) –
  
  The time when the edge deployment plan was created.
- LastModifiedTime (datetime) –
  
  The time when the edge deployment plan was last updated.

Exceptions

SageMaker.Client.exceptions.ResourceNotFound