devices

Creates, updates, deletes or gets a device resource or lists devices in a region

Overview

Name	devices
Type	Resource
Description	Resource schema for AWS::SageMaker::Device
Id	awscc.sagemaker.devices

Fields

Name	Datatype	Description
device_fleet_name	string	The name of the edge device fleet
▶device	object	The Edge Device you want to register against a device fleet
▶tags	array	Associate tags with the resource
region	string	AWS region.

For more information, see AWS::SageMaker::Device.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	DeviceFleetName, region
delete_resource	DELETE	Identifier, region
update_resource	UPDATE	Identifier, PatchDocument, region
get_resource	SELECT	Identifier, region

SELECT examples

Gets all properties from an individual device.

SELECT
  region,
  device_fleet_name,
  device,
  tags
FROM awscc.sagemaker.devices
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ device/device_name }}';

INSERT example

Use the following StackQL query and manifest file to create a new device resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.sagemaker.devices (
  DeviceFleetName,
  region
)
SELECT
  '{{ device_fleet_name }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.sagemaker.devices (
  DeviceFleetName,
  Device,
  Tags,
  region
)
SELECT
  '{{ device_fleet_name }}',
  '{{ device }}',
  '{{ tags }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: device
    props:
      - name: device_fleet_name
        value: '{{ device_fleet_name }}'
      - name: device
        value:
          device_fleet_name: '{{ device_fleet_name }}'
          device: null
          tags:
            - value: '{{ value }}'
              key: '{{ key }}'
      - name: tags
        value:
          - null

UPDATE example

Use the following StackQL query and manifest file to update a device resource, using stack-deploy.

/*+ update */
UPDATE awscc.sagemaker.devices
SET PatchDocument = string('{{ {
    "DeviceFleetName": device_fleet_name,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ device/device_name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.sagemaker.devices
WHERE
  Identifier = '{{ device/device_name }}' AND
  region = 'us-east-1';

Permissions

To operate on the devices resource, the following permissions are required:

Create

sagemaker:RegisterDevices

Read

sagemaker:DescribeDevice

Update

sagemaker:UpdateDevices

Delete

sagemaker:DeregisterDevices