AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . sagemaker ]

describe-edge-deployment-plan

Description

Describes an edge deployment plan with deployment status per stage.

See also: AWS API Documentation

Synopsis

  describe-edge-deployment-plan
--edge-deployment-plan-name <value>
[--next-token <value>]
[--max-results <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--edge-deployment-plan-name (string)

The name of the deployment plan to describe.

--next-token (string)

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

--max-results (integer)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

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.

(structure)

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.

(structure)

Contains information summarizing the deployment stage results.

StageName -> (string)

The name of the stage.

DeviceSelectionConfig -> (structure)

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 -> (structure)

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 -> (structure)

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 -> (timestamp)

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 -> (timestamp)

The time when the edge deployment plan was created.

LastModifiedTime -> (timestamp)

The time when the edge deployment plan was last updated.