device_fleets

Creates, updates, deletes or gets a device_fleet resource or lists device_fleets in a region

Overview

Name	device_fleets
Type	Resource
Description	Resource schema for AWS::SageMaker::DeviceFleet
Id	awscc.sagemaker.device_fleets

Fields

Name	Datatype	Description
description	string	Description for the edge device fleet
device_fleet_name	string	The name of the edge device fleet
▶output_config	object	S3 bucket and an ecryption key id (if available) to store outputs for the fleet
role_arn	string	Role associated with the device fleet
▶tags	array	Associate tags with the resource
region	string	AWS region.

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	DeviceFleetName, OutputConfig, RoleArn, 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_fleet.

SELECT
  region,
  description,
  device_fleet_name,
  output_config,
  role_arn,
  tags
FROM awscc.sagemaker.device_fleets
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ device_fleet_name }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.sagemaker.device_fleets (
  DeviceFleetName,
  OutputConfig,
  RoleArn,
  region
)
SELECT
  '{{ device_fleet_name }}',
  '{{ output_config }}',
  '{{ role_arn }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.sagemaker.device_fleets (
  Description,
  DeviceFleetName,
  OutputConfig,
  RoleArn,
  Tags,
  region
)
SELECT
  '{{ description }}',
  '{{ device_fleet_name }}',
  '{{ output_config }}',
  '{{ role_arn }}',
  '{{ 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_fleet
  props:
    - name: description
      value: '{{ description }}'
    - name: device_fleet_name
      value: '{{ device_fleet_name }}'
    - name: output_config
      value:
        s3_output_location: '{{ s3_output_location }}'
        kms_key_id: '{{ kms_key_id }}'
    - name: role_arn
      value: '{{ role_arn }}'
    - name: tags
      value:
        - value: '{{ value }}'
          key: '{{ key }}'

UPDATE example

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

/*+ update */
UPDATE awscc.sagemaker.device_fleets
SET PatchDocument = string('{{ {
    "Description": description,
    "OutputConfig": output_config,
    "RoleArn": role_arn,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ device_fleet_name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.sagemaker.device_fleets
WHERE
  Identifier = '{{ device_fleet_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 device_fleets resource, the following permissions are required:

Create

sagemaker:CreateDeviceFleet,
iam:PassRole

Read

sagemaker:DescribeDeviceFleet

Update

sagemaker:UpdateDeviceFleet,
iam:PassRole

Delete

sagemaker:DeleteDeviceFleet