Class: AWS.SnowDeviceManagement

var params = {
  command: { /* required */
    reboot: {
    },
    unlock: {
    }
  },
  targets: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  tags: {
    '<String>': 'STRING_VALUE',
    /* '<String>': ... */
  }
};
snowdevicemanagement.createTask(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • clientToken — (String)

    A token ensuring that the action is called only once with the specified details.

    If a token is not provided, the SDK will use a version 4 UUID.
  • command — (map)

    The task to be performed. Only one task is executed on a device at a time.

    • reboot — (map)

      Reboots the device.

    • unlock — (map)

      Unlocks the device.

  • description — (String)

    A description of the task and its targets.

  • tags — (map<String>)

    Optional metadata that you assign to a resource. You can use tags to categorize a resource in different ways, such as by purpose, owner, or environment.

  • targets — (Array<String>)

    A list of managed device IDs.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • taskArn — (String)

      The Amazon Resource Name (ARN) of the task that you created.

    • taskId — (String)

      The ID of the task that you created.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  managedDeviceId: 'STRING_VALUE' /* required */
};
snowdevicemanagement.describeDevice(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • managedDeviceId — (String)

    The ID of the device that you are checking the information of.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • associatedWithJob — (String)

      The ID of the job used when ordering the device.

    • deviceCapacities — (Array<map>)

      The hardware specifications of the device.

      • available — (Integer)

        The amount of capacity available for use on the device.

      • name — (String)

        The name of the type of capacity, such as memory.

      • total — (Integer)

        The total capacity on the device.

      • unit — (String)

        The unit of measure for the type of capacity.

      • used — (Integer)

        The amount of capacity used on the device.

    • deviceState — (String)

      The current state of the device.

      Possible values include:
      • "UNLOCKED"
      • "LOCKED"
      • "UNLOCKING"
    • deviceType — (String)

      The type of Amazon Web Services Snow Family device.

    • lastReachedOutAt — (Date)

      When the device last contacted the Amazon Web Services Cloud. Indicates that the device is online.

    • lastUpdatedAt — (Date)

      When the device last pushed an update to the Amazon Web Services Cloud. Indicates when the device cache was refreshed.

    • managedDeviceArn — (String)

      The Amazon Resource Name (ARN) of the device.

    • managedDeviceId — (String)

      The ID of the device that you checked the information for.

    • physicalNetworkInterfaces — (Array<map>)

      The network interfaces available on the device.

      • defaultGateway — (String)

        The default gateway of the device.

      • ipAddress — (String)

        The IP address of the device.

      • ipAddressAssignment — (String)

        A value that describes whether the IP address is dynamic or persistent.

        Possible values include:
        • "DHCP"
        • "STATIC"
      • macAddress — (String)

        The MAC address of the device.

      • netmask — (String)

        The netmask used to divide the IP address into subnets.

      • physicalConnectorType — (String)

        The physical connector type.

        Possible values include:
        • "RJ45"
        • "SFP_PLUS"
        • "QSFP"
        • "RJ45_2"
        • "WIFI"
      • physicalNetworkInterfaceId — (String)

        The physical network interface ID.

    • software — (map)

      The software installed on the device.

      • installState — (String)

        The state of the software that is installed or that is being installed on the device.

      • installedVersion — (String)

        The version of the software currently installed on the device.

      • installingVersion — (String)

        The version of the software being installed on the device.

    • tags — (map<String>)

      Optional metadata that you assign to a resource. You can use tags to categorize a resource in different ways, such as by purpose, owner, or environment.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  instanceIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  managedDeviceId: 'STRING_VALUE' /* required */
};
snowdevicemanagement.describeDeviceEc2Instances(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • instanceIds — (Array<String>)

    A list of instance IDs associated with the managed device.

  • managedDeviceId — (String)

    The ID of the managed device.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • instances — (Array<map>)

      A list of structures containing information about each instance.

      • instance — (map)

        A structure containing details about the instance.

        • amiLaunchIndex — (Integer)

          The Amazon Machine Image (AMI) launch index, which you can use to find this instance in the launch group.

        • blockDeviceMappings — (Array<map>)

          Any block device mapping entries for the instance.

          • deviceName — (String)

            The block device name.

          • ebs — (map)

            The parameters used to automatically set up Amazon Elastic Block Store (Amazon EBS) volumes when the instance is launched.

            • attachTime — (Date)

              When the attachment was initiated.

            • deleteOnTermination — (Boolean)

              A value that indicates whether the volume is deleted on instance termination.

            • status — (String)

              The attachment state.

              Possible values include:
              • "ATTACHING"
              • "ATTACHED"
              • "DETACHING"
              • "DETACHED"
            • volumeId — (String)

              The ID of the Amazon EBS volume.

        • cpuOptions — (map)

          The CPU options for the instance.

          • coreCount — (Integer)

            The number of cores that the CPU can use.

          • threadsPerCore — (Integer)

            The number of threads per core in the CPU.

        • createdAt — (Date)

          When the instance was created.

        • imageId — (String)

          The ID of the AMI used to launch the instance.

        • instanceId — (String)

          The ID of the instance.

        • instanceType — (String)

          The instance type.

        • privateIpAddress — (String)

          The private IPv4 address assigned to the instance.

        • publicIpAddress — (String)

          The public IPv4 address assigned to the instance.

        • rootDeviceName — (String)

          The device name of the root device volume (for example, /dev/sda1).

        • securityGroups — (Array<map>)

          The security groups for the instance.

          • groupId — (String)

            The security group ID.

          • groupName — (String)

            The security group name.

        • state — (map)

          The description of the current state of an instance.

          • code — (Integer)

            The state of the instance as a 16-bit unsigned integer.

            The high byte is all of the bits between 2⁸ and (2¹⁶)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.

            The low byte is all of the bits between 2⁰ and (2⁸)-1, which equals decimal values between 0 and 255.

            The valid values for the instance state code are all in the range of the low byte. These values are:

            • 0 : pending

            • 16 : running

            • 32 : shutting-down

            • 48 : terminated

            • 64 : stopping

            • 80 : stopped

            You can ignore the high byte value by zeroing out all of the bits above 2⁸ or 256 in decimal.

          • name — (String)

            The current state of the instance.

            Possible values include:
            • "PENDING"
            • "RUNNING"
            • "SHUTTING_DOWN"
            • "TERMINATED"
            • "STOPPING"
            • "STOPPED"
        • updatedAt — (Date)

          When the instance was last updated.

      • lastUpdatedAt — (Date)

        When the instance summary was last updated.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  managedDeviceId: 'STRING_VALUE', /* required */
  taskId: 'STRING_VALUE' /* required */
};
snowdevicemanagement.describeExecution(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • managedDeviceId — (String)

    The ID of the managed device.

  • taskId — (String)

    The ID of the task that the action is describing.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • executionId — (String)

      The ID of the execution.

    • lastUpdatedAt — (Date)

      When the status of the execution was last updated.

    • managedDeviceId — (String)

      The ID of the managed device that the task is being executed on.

    • startedAt — (Date)

      When the execution began.

    • state — (String)

      The current state of the execution.

      Possible values include:
      • "QUEUED"
      • "IN_PROGRESS"
      • "CANCELED"
      • "FAILED"
      • "SUCCEEDED"
      • "REJECTED"
      • "TIMED_OUT"
    • taskId — (String)

      The ID of the task being executed on the device.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  taskId: 'STRING_VALUE' /* required */
};
snowdevicemanagement.describeTask(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • taskId — (String)

    The ID of the task to be described.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • completedAt — (Date)

      When the task was completed.

    • createdAt — (Date)

      When the CreateTask operation was called.

    • description — (String)

      The description provided of the task and managed devices.

    • lastUpdatedAt — (Date)

      When the state of the task was last updated.

    • state — (String)

      The current state of the task.

      Possible values include:
      • "IN_PROGRESS"
      • "CANCELED"
      • "COMPLETED"
    • tags — (map<String>)

      Optional metadata that you assign to a resource. You can use tags to categorize a resource in different ways, such as by purpose, owner, or environment.

    • targets — (Array<String>)

      The managed devices that the task was sent to.

    • taskArn — (String)

      The Amazon Resource Name (ARN) of the task.

    • taskId — (String)

      The ID of the task.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  managedDeviceId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  type: 'STRING_VALUE'
};
snowdevicemanagement.listDeviceResources(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • managedDeviceId — (String)

    The ID of the managed device that you are listing the resources of.

  • maxResults — (Integer)

    The maximum number of resources per page.

  • nextToken — (String)

    A pagination token to continue to the next page of results.

  • type — (String)

    A structure used to filter the results by type of resource.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • nextToken — (String)

      A pagination token to continue to the next page of results.

    • resources — (Array<map>)

      A structure defining the resource's type, Amazon Resource Name (ARN), and ID.

      • arn — (String)

        The Amazon Resource Name (ARN) of the resource.

      • id — (String)

        The ID of the resource.

      • resourceType — required — (String)

        The resource type.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  jobId: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
snowdevicemanagement.listDevices(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • jobId — (String)

    The ID of the job used to order the device.

  • maxResults — (Integer)

    The maximum number of devices to list per page.

  • nextToken — (String)

    A pagination token to continue to the next page of results.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • devices — (Array<map>)

      A list of device structures that contain information about the device.

      • associatedWithJob — (String)

        The ID of the job used to order the device.

      • managedDeviceArn — (String)

        The Amazon Resource Name (ARN) of the device.

      • managedDeviceId — (String)

        The ID of the device.

      • tags — (map<String>)

        Optional metadata that you assign to a resource. You can use tags to categorize a resource in different ways, such as by purpose, owner, or environment.

    • nextToken — (String)

      A pagination token to continue to the next page of devices.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  taskId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  state: QUEUED | IN_PROGRESS | CANCELED | FAILED | SUCCEEDED | REJECTED | TIMED_OUT
};
snowdevicemanagement.listExecutions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • maxResults — (Integer)

    The maximum number of tasks to list per page.

  • nextToken — (String)

    A pagination token to continue to the next page of tasks.

  • state — (String)

    A structure used to filter the tasks by their current state.

    Possible values include:
    • "QUEUED"
    • "IN_PROGRESS"
    • "CANCELED"
    • "FAILED"
    • "SUCCEEDED"
    • "REJECTED"
    • "TIMED_OUT"
  • taskId — (String)

    The ID of the task.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • executions — (Array<map>)

      A list of executions. Each execution contains the task ID, the device that the task is executing on, the execution ID, and the status of the execution.

      • executionId — (String)

        The ID of the execution.

      • managedDeviceId — (String)

        The ID of the managed device that the task is being executed on.

      • state — (String)

        The state of the execution.

        Possible values include:
        • "QUEUED"
        • "IN_PROGRESS"
        • "CANCELED"
        • "FAILED"
        • "SUCCEEDED"
        • "REJECTED"
        • "TIMED_OUT"
      • taskId — (String)

        The ID of the task.

    • nextToken — (String)

      A pagination token to continue to the next page of executions.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
snowdevicemanagement.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    The Amazon Resource Name (ARN) of the device or task.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • tags — (map<String>)

      The list of tags for the device or task.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  state: IN_PROGRESS | CANCELED | COMPLETED
};
snowdevicemanagement.listTasks(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • maxResults — (Integer)

    The maximum number of tasks per page.

  • nextToken — (String)

    A pagination token to continue to the next page of tasks.

  • state — (String)

    A structure used to filter the list of tasks.

    Possible values include:
    • "IN_PROGRESS"
    • "CANCELED"
    • "COMPLETED"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • nextToken — (String)

      A pagination token to continue to the next page of tasks.

    • tasks — (Array<map>)

      A list of task structures containing details about each task.

      • state — (String)

        The state of the task assigned to one or many devices.

        Possible values include:
        • "IN_PROGRESS"
        • "CANCELED"
        • "COMPLETED"
      • tags — (map<String>)

        Optional metadata that you assign to a resource. You can use tags to categorize a resource in different ways, such as by purpose, owner, or environment.

      • taskArn — (String)

        The Amazon Resource Name (ARN) of the task.

      • taskId — required — (String)

        The task ID.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<String>': 'STRING_VALUE',
    /* '<String>': ... */
  }
};
snowdevicemanagement.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    The Amazon Resource Name (ARN) of the device or task.

  • tags — (map<String>)

    Optional metadata that you assign to a resource. You can use tags to categorize a resource in different ways, such as by purpose, owner, or environment.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
snowdevicemanagement.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    The Amazon Resource Name (ARN) of the device or task.

  • tagKeys — (Array<String>)

    Optional metadata that you assign to a resource. You can use tags to categorize a resource in different ways, such as by purpose, owner, or environment.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.