SageMaker / Client / list_edge_deployment_plans
list_edge_deployment_plans#
- SageMaker.Client.list_edge_deployment_plans(**kwargs)#
Lists all edge deployment plans.
See also: AWS API Documentation
Request Syntax
response = client.list_edge_deployment_plans( NextToken='string', MaxResults=123, CreationTimeAfter=datetime(2015, 1, 1), CreationTimeBefore=datetime(2015, 1, 1), LastModifiedTimeAfter=datetime(2015, 1, 1), LastModifiedTimeBefore=datetime(2015, 1, 1), NameContains='string', DeviceFleetNameContains='string', SortBy='NAME'|'DEVICE_FLEET_NAME'|'CREATION_TIME'|'LAST_MODIFIED_TIME', SortOrder='Ascending'|'Descending' )
- Parameters:
NextToken (string) – The response from the last list when returning a list large enough to need tokening.
MaxResults (integer) – The maximum number of results to select (50 by default).
CreationTimeAfter (datetime) – Selects edge deployment plans created after this time.
CreationTimeBefore (datetime) – Selects edge deployment plans created before this time.
LastModifiedTimeAfter (datetime) – Selects edge deployment plans that were last updated after this time.
LastModifiedTimeBefore (datetime) – Selects edge deployment plans that were last updated before this time.
NameContains (string) – Selects edge deployment plans with names containing this name.
DeviceFleetNameContains (string) – Selects edge deployment plans with a device fleet name containing this name.
SortBy (string) – The column by which to sort the edge deployment plans. Can be one of
NAME
,DEVICEFLEETNAME
,CREATIONTIME
,LASTMODIFIEDTIME
.SortOrder (string) – The direction of the sorting (ascending or descending).
- Return type:
dict
- Returns:
Response Syntax
{ 'EdgeDeploymentPlanSummaries': [ { 'EdgeDeploymentPlanArn': 'string', 'EdgeDeploymentPlanName': 'string', 'DeviceFleetName': 'string', 'EdgeDeploymentSuccess': 123, 'EdgeDeploymentPending': 123, 'EdgeDeploymentFailed': 123, 'CreationTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1) }, ], 'NextToken': 'string' }
Response Structure
(dict) –
EdgeDeploymentPlanSummaries (list) –
List of summaries of edge deployment plans.
(dict) –
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 (datetime) –
The time when the edge deployment plan was created.
LastModifiedTime (datetime) –
The time when the edge deployment plan was last updated.
NextToken (string) –
The token to use when calling the next page of results.