edge_deployment_plans

Creates, updates, deletes, gets or lists an edge_deployment_plans resource.

Overview

Name	edge_deployment_plans
Type	Resource
Id	aws.sagemaker.edge_deployment_plans

Fields

The following fields are returned by SELECT queries:

describe_edge_deployment_plan

Name	Datatype	Description
creation_time	string (date-time)	The time when the edge deployment plan was created.
device_fleet_name	string	The device fleet used for this edge deployment plan. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}</code>)
edge_deployment_failed	integer	The number of edge devices that failed the deployment.
edge_deployment_pending	integer	The number of edge devices yet to pick up deployment, or in progress.
edge_deployment_plan_arn	string	The ARN of edge deployment plan. (pattern: <code>arn:aws[a-z-]:sagemaker:[a-z-]:\d{12}:edge-deployment/?[a-zA-Z_0-9+=,.@-_/]+</code>)
edge_deployment_plan_name	string	The name of the edge deployment plan. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}</code>)
edge_deployment_success	integer	The number of edge devices with the successful deployment.
last_modified_time	string (date-time)	The time when the edge deployment plan was last updated.
model_configs	array	List of models associated with the edge deployment plan.
next_token	string	Token to use when calling the next set of stages in the edge deployment plan. (pattern: <code>.*</code>)
stages	array	List of stages in the edge deployment plan.

list_edge_deployment_plans

Name	Datatype	Description
creation_time	string (date-time)	The time when the edge deployment plan was created.
device_fleet_name	string	The name of the device fleet used for the deployment. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}</code>)
edge_deployment_failed	integer	The number of edge devices that failed the deployment.
edge_deployment_pending	integer	The number of edge devices yet to pick up the deployment, or in progress.
edge_deployment_plan_arn	string	The ARN of the edge deployment plan. (pattern: <code>arn:aws[a-z-]:sagemaker:[a-z-]:\d{12}:edge-deployment/?[a-zA-Z_0-9+=,.@-_/]+</code>)
edge_deployment_plan_name	string	The name of the edge deployment plan. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}</code>)
edge_deployment_success	integer	The number of edge devices with the successful deployment.
last_modified_time	string (date-time)	The time when the edge deployment plan was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_edge_deployment_plan	select	region		Describes an edge deployment plan with deployment status per stage.
list_edge_deployment_plans	select	region		Lists all edge deployment plans.
create_edge_deployment_plan	insert	region, EdgeDeploymentPlanName, ModelConfigs, DeviceFleetName		Creates an edge deployment plan, consisting of multiple stages. Each stage may have a different deployment configuration and devices.
create_edge_deployment_stage	insert	region, EdgeDeploymentPlanName		Creates a new stage in an existing edge deployment plan.
delete_edge_deployment_stage	delete	region		Delete a stage in an edge deployment plan if (and only if) the stage is inactive.
delete_edge_deployment_plan	delete	region		Deletes an edge deployment plan if (and only if) all the stages in the plan are inactive or there are no stages in the plan.
start_edge_deployment_stage	exec	region, EdgeDeploymentPlanName, StageName		Starts a stage in an edge deployment plan.
stop_edge_deployment_stage	exec	region, EdgeDeploymentPlanName, StageName		Stops a stage in an edge deployment plan.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_edge_deployment_plan

Describes an edge deployment plan with deployment status per stage.

SELECT
creation_time,
device_fleet_name,
edge_deployment_failed,
edge_deployment_pending,
edge_deployment_plan_arn,
edge_deployment_plan_name,
edge_deployment_success,
last_modified_time,
model_configs,
next_token,
stages
FROM aws.sagemaker.edge_deployment_plans
WHERE region = '{{ region }}' -- required
;

list_edge_deployment_plans

Lists all edge deployment plans.

SELECT
creation_time,
device_fleet_name,
edge_deployment_failed,
edge_deployment_pending,
edge_deployment_plan_arn,
edge_deployment_plan_name,
edge_deployment_success,
last_modified_time
FROM aws.sagemaker.edge_deployment_plans
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_edge_deployment_plan

Creates an edge deployment plan, consisting of multiple stages. Each stage may have a different deployment configuration and devices.

INSERT INTO aws.sagemaker.edge_deployment_plans (
EdgeDeploymentPlanName,
ModelConfigs,
DeviceFleetName,
Stages,
Tags,
region
)
SELECT 
'{{ EdgeDeploymentPlanName }}' /* required */,
'{{ ModelConfigs }}' /* required */,
'{{ DeviceFleetName }}' /* required */,
'{{ Stages }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
edge_deployment_plan_arn
;

create_edge_deployment_stage

Creates a new stage in an existing edge deployment plan.

INSERT INTO aws.sagemaker.edge_deployment_plans (
EdgeDeploymentPlanName,
Stages,
region
)
SELECT 
'{{ EdgeDeploymentPlanName }}' /* required */,
'{{ Stages }}',
'{{ region }}'
;

Manifest

# Description fields are for documentation purposes
- name: edge_deployment_plans
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the edge_deployment_plans resource.
  - name: EdgeDeploymentPlanName
    value: "{{ EdgeDeploymentPlanName }}"
    description: |
      The name of the edge deployment plan.
  - name: ModelConfigs
    description: |
      List of models associated with the edge deployment plan.
    value:
      - ModelHandle: "{{ ModelHandle }}"
        EdgePackagingJobName: "{{ EdgePackagingJobName }}"
  - name: DeviceFleetName
    value: "{{ DeviceFleetName }}"
    description: |
      The device fleet used for this edge deployment plan.
  - name: Stages
    description: |
      List of stages to be added to the edge deployment plan.
    value:
      - StageName: "{{ StageName }}"
        DeviceSelectionConfig:
          DeviceSubsetType: "{{ DeviceSubsetType }}"
          Percentage: {{ Percentage }}
          DeviceNames:
            - "{{ DeviceNames }}"
          DeviceNameContains: "{{ DeviceNameContains }}"
        DeploymentConfig:
          FailureHandlingPolicy: "{{ FailureHandlingPolicy }}"
  - name: Tags
    description: |
      List of tags with which to tag the edge deployment plan.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

DELETE examples

delete_edge_deployment_stage

Delete a stage in an edge deployment plan if (and only if) the stage is inactive.

DELETE FROM aws.sagemaker.edge_deployment_plans
WHERE region = '{{ region }}' --required
;

delete_edge_deployment_plan

Deletes an edge deployment plan if (and only if) all the stages in the plan are inactive or there are no stages in the plan.

DELETE FROM aws.sagemaker.edge_deployment_plans
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

start_edge_deployment_stage

Starts a stage in an edge deployment plan.

EXEC aws.sagemaker.edge_deployment_plans.start_edge_deployment_stage 
@region='{{ region }}' --required 
@@json=
'{
"EdgeDeploymentPlanName": "{{ EdgeDeploymentPlanName }}", 
"StageName": "{{ StageName }}"
}'
;

stop_edge_deployment_stage

Stops a stage in an edge deployment plan.

EXEC aws.sagemaker.edge_deployment_plans.stop_edge_deployment_stage 
@region='{{ region }}' --required 
@@json=
'{
"EdgeDeploymentPlanName": "{{ EdgeDeploymentPlanName }}", 
"StageName": "{{ StageName }}"
}'
;