Amazon Web Services, Inc.

AWS Snow Device Management

Amazon Web Services Snow Device Management documentation.

IoT & devices#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Amazon Web Services Snow Device Management documentation.

Endpoints 13

Task

  • POSTCancel task/task/:taskId/cancelSends 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…
  • POSTCreate task/taskInstructs one or more devices to start a task, such as unlocking or rebooting.
  • POSTDescribe task/task/:taskIdChecks the metadata for a given task on a device.
  • GETList tasks/tasks?state=string&maxResults=0&nextToken=stringReturns a list of tasks that can be filtered by state.

Managed device

  • POSTDescribe device/managed-device/:managedDeviceId/describeChecks device-specific information, such as the device type, software version, IP addresses, and lock status.
  • POSTDescribe device ec2 instances/managed-device/:managedDeviceId/resources/ec2/describeChecks 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…
  • GETList device resources/managed-device/:managedDeviceId/resources?type=string&maxResults=0&nextToken=stringReturns a list of the Amazon Web Services resources available for a device. Currently, Amazon EC2 instances are the only supported resource type.
  • GETList devices/managed-devices?jobId=string&maxResults=0&nextToken=stringReturns 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…

Execution

  • POSTDescribe execution/task/:taskId/execution/:managedDeviceIdChecks the status of a remote task running on one or more target devices.
  • GETList executions/executions?taskId=string&state=string&maxResults=0&nextToken=stringReturns the status of tasks for one or more target devices.
  • GETList tags for resource/tags/:resourceArnReturns a list of tags for a managed device or task.
  • POSTTag resource/tags/:resourceArnAdds or replaces tags on a device or task.
  • DELETEUntag resource/tags/:resourceArn?tagKeys=Removes a tag from a device or task.

API details

Base URL
https://snow-device-management.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
13 operations on 11 pathsPOST 7GET 5DELETE 1
Main resources
Managed device 4Task 4Execution 2
Description format
AWS Smithy model, API version 2021-08-04

How to test the AWS Snow Device Management in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Snow Device Management collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Cancel task” (POST /task/:taskId/cancel), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS Snow Device Management?

Amazon Web Services Snow Device Management documentation. It is listed under IoT & devices and has 13 endpoints.

Who publishes the AWS Snow Device Management?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWS Snow Device Management?

Requests go to https://snow-device-management.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWS Snow Device Management?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWS Snow Device Management have?

13 operations on 11 paths (7 POST, 5 GET, 1 DELETE). The largest groups are Managed device, Task, Execution.

Is forking the AWS Snow Device Management free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.