AWS.SnowDeviceManagement — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Inherits:

AWS.Service

Identifier:

snowdevicemanagement

API Version:

2021-08-04

Defined in:

(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Amazon Web Services Snow Device Management documentation.

Sending a Request Using SnowDeviceManagement

var snowdevicemanagement = new AWS.SnowDeviceManagement();
snowdevicemanagement.cancelTask(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the SnowDeviceManagement object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var snowdevicemanagement = new AWS.SnowDeviceManagement({apiVersion: '2021-08-04'});

You can also set the API version globally in AWS.config.apiVersions using the snowdevicemanagement service identifier:

AWS.config.apiVersions = {
  snowdevicemanagement: '2021-08-04',
  // other service API versions
};

var snowdevicemanagement = new AWS.SnowDeviceManagement();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.SnowDeviceManagement(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

cancelTask(params = {}, callback) ⇒ AWS.Request

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.

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

createTask(params = {}, callback) ⇒ AWS.Request

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

describeDevice(params = {}, callback) ⇒ AWS.Request

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

describeDeviceEc2Instances(params = {}, callback) ⇒ AWS.Request

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.

describeExecution(params = {}, callback) ⇒ AWS.Request

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

describeTask(params = {}, callback) ⇒ AWS.Request

Checks the metadata for a given task on a device.

listDeviceResources(params = {}, callback) ⇒ AWS.Request

Returns a list of the Amazon Web Services resources available for a device. Currently, Amazon EC2 instances are the only supported resource type.

listDevices(params = {}, callback) ⇒ AWS.Request

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.

listExecutions(params = {}, callback) ⇒ AWS.Request

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

listTagsForResource(params = {}, callback) ⇒ AWS.Request

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

listTasks(params = {}, callback) ⇒ AWS.Request

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

tagResource(params = {}, callback) ⇒ AWS.Request

Adds or replaces tags on a device or task.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes a tag from a device or task.