[ aws . sagemaker ]

list-edge-deployment-plans

Description

Lists all edge deployment plans.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-edge-deployment-plans is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: EdgeDeploymentPlanSummaries

Synopsis

  list-edge-deployment-plans
[--creation-time-after <value>]
[--creation-time-before <value>]
[--last-modified-time-after <value>]
[--last-modified-time-before <value>]
[--name-contains <value>]
[--device-fleet-name-contains <value>]
[--sort-by <value>]
[--sort-order <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--creation-time-after (timestamp)

Selects edge deployment plans created after this time.

--creation-time-before (timestamp)

Selects edge deployment plans created before this time.

--last-modified-time-after (timestamp)

Selects edge deployment plans that were last updated after this time.

--last-modified-time-before (timestamp)

Selects edge deployment plans that were last updated before this time.

--name-contains (string)

Selects edge deployment plans with names containing this name.

--device-fleet-name-contains (string)

Selects edge deployment plans with a device fleet name containing this name.

--sort-by (string)

The column by which to sort the edge deployment plans. Can be one of NAME , DEVICEFLEETNAME , CREATIONTIME , LASTMODIFIEDTIME .

Possible values:

• NAME

• DEVICE_FLEET_NAME

• CREATION_TIME

• LAST_MODIFIED_TIME

--sort-order (string)

The direction of the sorting (ascending or descending).

Possible values:

• Ascending

• Descending

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

EdgeDeploymentPlanSummaries -> (list)

List of summaries of edge deployment plans.

(structure)

Contains information summarizing an edge deployment plan.

EdgeDeploymentPlanArn -> (string)

The ARN of the edge deployment plan.

EdgeDeploymentPlanName -> (string)

The name of the edge deployment plan.

DeviceFleetName -> (string)

The name of the device fleet used for the deployment.

EdgeDeploymentSuccess -> (integer)

The number of edge devices with the successful deployment.

EdgeDeploymentPending -> (integer)

The number of edge devices yet to pick up the deployment, or in progress.

EdgeDeploymentFailed -> (integer)

The number of edge devices that failed the deployment.

CreationTime -> (timestamp)

The time when the edge deployment plan was created.

LastModifiedTime -> (timestamp)

The time when the edge deployment plan was last updated.

NextToken -> (string)

The token to use when calling the next page of results.