Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListEdgeDeploymentPlans

Lists all edge deployment plans.

Request Syntax


{
   "CreationTimeAfter": number,
   "CreationTimeBefore": number,
   "DeviceFleetNameContains": "string",
   "LastModifiedTimeAfter": number,
   "LastModifiedTimeBefore": number,
   "MaxResults": number,
   "NameContains": "string",
   "NextToken": "string",
   "SortBy": "string",
   "SortOrder": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

CreationTimeAfter

Selects edge deployment plans created after this time.

Type: Timestamp

Required: No

CreationTimeBefore

Selects edge deployment plans created before this time.

Type: Timestamp

Required: No

DeviceFleetNameContains

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 63.

Pattern: [a-zA-Z0-9\-]+

Required: No

LastModifiedTimeAfter

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

Type: Timestamp

Required: No

LastModifiedTimeBefore

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

Type: Timestamp

Required: No

MaxResults

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

Type: Integer

Valid Range: Maximum value of 100.

Required: No

NameContains

Selects edge deployment plans with names containing this name.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 63.

Pattern: [a-zA-Z0-9\-]+

Required: No

NextToken

The response from the last list when returning a list large enough to need tokening.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 8192.

Pattern: .*

Required: No

SortBy

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

Type: String

Valid Values: NAME | DEVICE_FLEET_NAME | CREATION_TIME | LAST_MODIFIED_TIME

Required: No

SortOrder

The direction of the sorting (ascending or descending).

Type: String

Valid Values: Ascending | Descending

Required: No

Response Syntax


{
   "EdgeDeploymentPlanSummaries": [ 
      { 
         "CreationTime": number,
         "DeviceFleetName": "string",
         "EdgeDeploymentFailed": number,
         "EdgeDeploymentPending": number,
         "EdgeDeploymentPlanArn": "string",
         "EdgeDeploymentPlanName": "string",
         "EdgeDeploymentSuccess": number,
         "LastModifiedTime": number
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

EdgeDeploymentPlanSummaries

List of summaries of edge deployment plans.

Type: Array of EdgeDeploymentPlanSummary objects

NextToken

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 8192.

Pattern: .*

Errors

For information about the errors that are common to all actions, see Common Errors.