View Source AWS.SnowDeviceManagement (aws-elixir v1.0.4)

Amazon Web Services Snow Device Management documentation.

Link to this section Summary

Functions

cancel_task(client, task_id, input, options \\ [])

Sends a cancel request for a specified task.

create_task(client, input, options \\ [])

Instructs one or more devices to start a task, such as unlocking or rebooting.

describe_device(client, managed_device_id, input, options \\ [])

Checks device-specific information, such as the device type, software version, IP addresses, and lock status.

describe_device_ec2_instances(client, managed_device_id, input, options \\ [])

Checks the current state of the Amazon EC2 instances.

describe_execution(client, managed_device_id, task_id, input, options \\ [])

Checks the status of a remote task running on one or more target devices.

describe_task(client, task_id, input, options \\ [])

Checks the metadata for a given task on a device.

list_device_resources(client, managed_device_id, max_results \\ nil, next_token \\ nil, type \\ nil, options \\ [])

Returns a list of the Amazon Web Services resources available for a device.

list_devices(client, job_id \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of all devices on your Amazon Web Services account that have Amazon Web Services Snow Device Management enabled in the Amazon Web Services Region where the command is run.

list_executions(client, max_results \\ nil, next_token \\ nil, state \\ nil, task_id, options \\ [])

Returns the status of tasks for one or more target devices.

list_tags_for_resource(client, resource_arn, options \\ [])

Returns a list of tags for a managed device or task.

list_tasks(client, max_results \\ nil, next_token \\ nil, state \\ nil, options \\ [])

Returns a list of tasks that can be filtered by state.

metadata()

tag_resource(client, resource_arn, input, options \\ [])

Adds or replaces tags on a device or task.

untag_resource(client, resource_arn, input, options \\ [])

Removes a tag from a device or task.

Link to this section Functions

cancel_task(client, task_id, input, options \\ [])

Sends a cancel request for a specified task.

You can cancel a task only if it's still in a QUEUED state. Tasks that are already running can't be cancelled.

A task might still run if it's processed from the queue before the CancelTask operation changes the task's state.

create_task(client, input, options \\ [])

Instructs one or more devices to start a task, such as unlocking or rebooting.

describe_device(client, managed_device_id, input, options \\ [])

Checks device-specific information, such as the device type, software version, IP addresses, and lock status.

describe_device_ec2_instances(client, managed_device_id, input, options \\ [])

Checks the current state of the Amazon EC2 instances.

The output is similar to describeDevice, but the results are sourced from the device cache in the Amazon Web Services Cloud and include a subset of the available fields.

describe_execution(client, managed_device_id, task_id, input, options \\ [])

Checks the status of a remote task running on one or more target devices.

describe_task(client, task_id, input, options \\ [])

Checks the metadata for a given task on a device.

list_device_resources(client, managed_device_id, max_results \\ nil, next_token \\ nil, type \\ nil, options \\ [])

Returns a list of the Amazon Web Services resources available for a device.

Currently, Amazon EC2 instances are the only supported resource type.

list_devices(client, job_id \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of all devices on your Amazon Web Services account that have Amazon Web Services Snow Device Management enabled in the Amazon Web Services Region where the command is run.

list_executions(client, max_results \\ nil, next_token \\ nil, state \\ nil, task_id, options \\ [])

Returns the status of tasks for one or more target devices.

list_tags_for_resource(client, resource_arn, options \\ [])

Returns a list of tags for a managed device or task.

list_tasks(client, max_results \\ nil, next_token \\ nil, state \\ nil, options \\ [])

Returns a list of tasks that can be filtered by state.

metadata()

tag_resource(client, resource_arn, input, options \\ [])

Adds or replaces tags on a device or task.

untag_resource(client, resource_arn, input, options \\ [])

Removes a tag from a device or task.

Settings View Source AWS.SnowDeviceManagement (aws-elixir v1.0.4)

Link to this section Summary

Functions

Link to this section Functions

cancel_task(client, task_id, input, options \\ [])

create_task(client, input, options \\ [])

describe_device(client, managed_device_id, input, options \\ [])

describe_device_ec2_instances(client, managed_device_id, input, options \\ [])

describe_execution(client, managed_device_id, task_id, input, options \\ [])

describe_task(client, task_id, input, options \\ [])

list_device_resources(client, managed_device_id, max_results \\ nil, next_token \\ nil, type \\ nil, options \\ [])

list_devices(client, job_id \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

list_executions(client, max_results \\ nil, next_token \\ nil, state \\ nil, task_id, options \\ [])

list_tags_for_resource(client, resource_arn, options \\ [])

list_tasks(client, max_results \\ nil, next_token \\ nil, state \\ nil, options \\ [])

metadata()

tag_resource(client, resource_arn, input, options \\ [])

untag_resource(client, resource_arn, input, options \\ [])

View Source AWS.SnowDeviceManagement (aws-elixir v1.0.4)