device_fleets

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

Overview

Name	device_fleets
Type	Resource
Id	aws.sagemaker.device_fleets

Fields

The following fields are returned by SELECT queries:

describe_device_fleet

Name	Datatype	Description
creation_time	string (date-time)	Timestamp of when the device fleet was created.
description	string	A description of the fleet. (pattern: <code>[-a-zA-Z0-9_.,;:! ]*</code>)
device_fleet_arn	string	The The Amazon Resource Name (ARN) of the fleet. (pattern: <code>arn:aws[a-z-]*:iam::\d{12}:device-fleet/?[a-zA-Z_0-9+=,.@-_/]+</code>)
device_fleet_name	string	The name of the fleet. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}</code>)
iot_role_alias	string	The Amazon Resource Name (ARN) alias created in Amazon Web Services Internet of Things (IoT). (pattern: <code>arn:aws[a-z-]*:iam::\d{12}:rolealias/?[a-zA-Z_0-9+=,.@-_/]+</code>)
last_modified_time	string (date-time)	Timestamp of when the device fleet was last updated.
output_config	object	The output configuration for storing sampled data.
role_arn	string	The Amazon Resource Name (ARN) that has access to Amazon Web Services Internet of Things (IoT). (pattern: <code>arn:aws[a-z-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@-_/]+</code>)

list_device_fleets

Name	Datatype	Description
creation_time	string (date-time)	Timestamp of when the device fleet was created.
device_fleet_arn	string	Amazon Resource Name (ARN) of the device fleet. (pattern: <code>arn:aws[a-z-]*:iam::\d{12}:device-fleet/?[a-zA-Z_0-9+=,.@-_/]+</code>)
device_fleet_name	string	Name of the device fleet. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}</code>)
last_modified_time	string (date-time)	Timestamp of when the device fleet was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_device_fleet	select	region		A description of the fleet the device belongs to.
list_device_fleets	select	region		Returns a list of devices in the fleet.
create_device_fleet	insert	region, DeviceFleetName, OutputConfig		Creates a device fleet.
update_device_fleet	update	region, DeviceFleetName, OutputConfig		Updates a fleet of devices.
delete_device_fleet	delete	region		Deletes a fleet.

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_device_fleet

A description of the fleet the device belongs to.

SELECT
creation_time,
description,
device_fleet_arn,
device_fleet_name,
iot_role_alias,
last_modified_time,
output_config,
role_arn
FROM aws.sagemaker.device_fleets
WHERE region = '{{ region }}' -- required
;

list_device_fleets

Returns a list of devices in the fleet.

SELECT
creation_time,
device_fleet_arn,
device_fleet_name,
last_modified_time
FROM aws.sagemaker.device_fleets
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_device_fleet

Creates a device fleet.

INSERT INTO aws.sagemaker.device_fleets (
DeviceFleetName,
RoleArn,
Description,
OutputConfig,
Tags,
EnableIotRoleAlias,
region
)
SELECT 
'{{ DeviceFleetName }}' /* required */,
'{{ RoleArn }}',
'{{ Description }}',
'{{ OutputConfig }}' /* required */,
'{{ Tags }}',
{{ EnableIotRoleAlias }},
'{{ region }}'
;

Manifest

# Description fields are for documentation purposes
- name: device_fleets
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the device_fleets resource.
  - name: DeviceFleetName
    value: "{{ DeviceFleetName }}"
    description: |
      The name of the fleet that the device belongs to.
  - name: RoleArn
    value: "{{ RoleArn }}"
    description: |
      The Amazon Resource Name (ARN) that has access to Amazon Web Services Internet of Things (IoT).
  - name: Description
    value: "{{ Description }}"
    description: |
      A description of the fleet.
  - name: OutputConfig
    description: |
      The output configuration for storing sample data collected by the fleet.
    value:
      S3OutputLocation: "{{ S3OutputLocation }}"
      KmsKeyId: "{{ KmsKeyId }}"
      PresetDeploymentType: "{{ PresetDeploymentType }}"
      PresetDeploymentConfig: "{{ PresetDeploymentConfig }}"
  - name: Tags
    description: |
      Creates tags for the specified fleet.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: EnableIotRoleAlias
    value: {{ EnableIotRoleAlias }}
    description: |
      Whether to create an Amazon Web Services IoT Role Alias during device fleet creation. The name of the role alias generated will match this pattern: "SageMakerEdge-{DeviceFleetName}". For example, if your device fleet is called "demo-fleet", the name of the role alias will be "SageMakerEdge-demo-fleet".

UPDATE examples

update_device_fleet

Updates a fleet of devices.

UPDATE aws.sagemaker.device_fleets
SET 
DeviceFleetName = '{{ DeviceFleetName }}',
RoleArn = '{{ RoleArn }}',
Description = '{{ Description }}',
OutputConfig = '{{ OutputConfig }}',
EnableIotRoleAlias = {{ EnableIotRoleAlias }}
WHERE 
region = '{{ region }}' --required
AND DeviceFleetName = '{{ DeviceFleetName }}' --required
AND OutputConfig = '{{ OutputConfig }}' --required;

DELETE examples

delete_device_fleet

Deletes a fleet.

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