Describe Edge Deployment Plan

sagemaker_describe_edge_deployment_plan

R Documentation

Describes an edge deployment plan with deployment status per stage¶

Description¶

Describes an edge deployment plan with deployment status per stage.

Usage¶

sagemaker_describe_edge_deployment_plan(EdgeDeploymentPlanName,
  NextToken, MaxResults)

Arguments¶

EdgeDeploymentPlanName

[required] The name of the deployment plan to describe.

NextToken

If the edge deployment plan has enough stages to require tokening, then this is the response from the last list of stages returned.

MaxResults

The maximum number of results to select (50 by default).

Value¶

A list with the following syntax:

list(
  EdgeDeploymentPlanArn = "string",
  EdgeDeploymentPlanName = "string",
  ModelConfigs = list(
    list(
      ModelHandle = "string",
      EdgePackagingJobName = "string"
    )
  ),
  DeviceFleetName = "string",
  EdgeDeploymentSuccess = 123,
  EdgeDeploymentPending = 123,
  EdgeDeploymentFailed = 123,
  Stages = list(
    list(
      StageName = "string",
      DeviceSelectionConfig = list(
        DeviceSubsetType = "PERCENTAGE"|"SELECTION"|"NAMECONTAINS",
        Percentage = 123,
        DeviceNames = list(
          "string"
        ),
        DeviceNameContains = "string"
      ),
      DeploymentConfig = list(
        FailureHandlingPolicy = "ROLLBACK_ON_FAILURE"|"DO_NOTHING"
      ),
      DeploymentStatus = list(
        StageStatus = "CREATING"|"READYTODEPLOY"|"STARTING"|"INPROGRESS"|"DEPLOYED"|"FAILED"|"STOPPING"|"STOPPED",
        EdgeDeploymentSuccessInStage = 123,
        EdgeDeploymentPendingInStage = 123,
        EdgeDeploymentFailedInStage = 123,
        EdgeDeploymentStatusMessage = "string",
        EdgeDeploymentStageStartTime = as.POSIXct(
          "2015-01-01"
        )
      )
    )
  ),
  NextToken = "string",
  CreationTime = as.POSIXct(
    "2015-01-01"
  ),
  LastModifiedTime = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax¶

svc$describe_edge_deployment_plan(
  EdgeDeploymentPlanName = "string",
  NextToken = "string",
  MaxResults = 123
)