stage_devices

Creates, updates, deletes, gets or lists a stage_devices resource.

Overview

Name	stage_devices
Type	Resource
Id	aws.sagemaker.stage_devices

Fields

The following fields are returned by SELECT queries:

list_stage_devices

Name	Datatype	Description
deployed_stage_name	string	The name of the deployed stage. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}</code>)
deployment_start_time	string (date-time)	The time when the deployment on the device started.
description	string	The description of the device. (pattern: <code>[-a-zA-Z0-9_.,;:! ]*</code>)
device_arn	string	The ARN of the device. (pattern: <code>arn:aws[a-z-]:[a-z-]:[a-z-]:\d{12}:[a-z-]/?[a-zA-Z_0-9+=,.@-_/]+</code>)
device_deployment_status	string	The deployment status of the device. (READYTODEPLOY, INPROGRESS, DEPLOYED, FAILED, STOPPING, STOPPED)
device_deployment_status_message	string	The detailed error message for the deployoment status result.
device_fleet_name	string	The name of the fleet to which the device belongs to. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}</code>)
device_name	string	The name of the device. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}</code>)
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>)
stage_name	string	The name of the stage in the edge deployment plan. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_stage_devices	select	region		Lists devices allocated to the stage, containing detailed device information and deployment status.

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

list_stage_devices

Lists devices allocated to the stage, containing detailed device information and deployment status.

SELECT
deployed_stage_name,
deployment_start_time,
description,
device_arn,
device_deployment_status,
device_deployment_status_message,
device_fleet_name,
device_name,
edge_deployment_plan_arn,
edge_deployment_plan_name,
stage_name
FROM aws.sagemaker.stage_devices
WHERE region = '{{ region }}' -- required
;