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

Amazon Web Services Snow Device Management documentation.

Summary

Functions

Sends a cancel request for a specified task.

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

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

Checks the current state of the Amazon EC2 instances.

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

Checks the metadata for a given task on a device.

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

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.

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

Adds or replaces tags on a device or task.

Removes a tag from a device or task.

Functions

Link to this function

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

View Source

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.

Link to this function

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

View Source

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

Link to this function

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

View Source

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

Link to this function

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

View Source

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.

Link to this function

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

View Source

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

Link to this function

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

View Source

Checks the metadata for a given task on a device.

Link to this function

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

View Source

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

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

Link to this function

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

View Source

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.

Link to this function

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

View Source

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

Link to this function

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

View Source

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

Link to this function

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

View Source

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

Link to this function

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

View Source

Adds or replaces tags on a device or task.

Link to this function

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

View Source

Removes a tag from a device or task.