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 = '{{ region }}' 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 }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.sagemaker.devices (
  DeviceFleetName,
  Device,
  Tags,
  region
)
SELECT
  '{{ device_fleet_name }}',
  '{{ device }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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:
        description: '{{ description }}'
        device_name: '{{ device_name }}'
        iot_thing_name: '{{ iot_thing_name }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

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 }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.sagemaker.devices
WHERE
  Identifier = '{{ device/device_name }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

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

Create

sagemaker:RegisterDevices

Read

sagemaker:DescribeDevice

Update

sagemaker:UpdateDevices

Delete

sagemaker:DeregisterDevices