Amazon Web Services, Inc.

AWS IoT 1-Click Projects Service

The AWS IoT 1-Click Projects API Reference

IoT & devices#openapi#cloud

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

The AWS IoT 1-Click Projects API Reference

Endpoints 16

  • PUTAssociateDeviceWithPlacement/projects/:projectName/placements/:placementName/devices/:deviceTemplateNameAssociates a physical device with a placement.
  • DELETEDisassociateDeviceFromPlacement/projects/:projectName/placements/:placementName/devices/:deviceTemplateNameRemoves a physical device from a placement.
  • GETListPlacements/projects/:projectName/placements?nextToken=string&maxResults=1Lists the placement(s) of a project.
  • POSTCreatePlacement/projects/:projectName/placementsCreates an empty placement.
  • GETListProjects/projects?nextToken=string&maxResults=1Lists the AWS IoT 1-Click project(s) associated with your AWS account and region.
  • POSTCreateProject/projectsCreates an empty project with a placement template. A project contains zero or more placements that adhere to the placement template defined in the project.
  • GETDescribePlacement/projects/:projectName/placements/:placementNameDescribes a placement in a project.
  • PUTUpdatePlacement/projects/:projectName/placements/:placementNameUpdates a placement with the given attributes. To clear an attribute, pass an empty value (i.e., "").
  • DELETEDeletePlacement/projects/:projectName/placements/:placementName<p>Deletes a placement. To delete a placement, it must not have any devices associated with it.</p> <note> <p>When you delete a placement, all associated data…
  • GETDescribeProject/projects/:projectNameReturns an object describing a project.
  • PUTUpdateProject/projects/:projectNameUpdates a project associated with your AWS account and region. With the exception of device template names, you can pass just the values that need to be…
  • DELETEDeleteProject/projects/:projectName<p>Deletes a project. To delete a project, it must not have any placements associated with it.</p> <note> <p>When you delete a project, all associated data…
  • GETGetDevicesInPlacement/projects/:projectName/placements/:placementName/devicesReturns an object enumerating the devices in a placement.
  • GETListTagsForResource/tags/:resourceArnLists the tags (metadata key/value pairs) which you have assigned to the resource.
  • POSTTagResource/tags/:resourceArnCreates or modifies tags for a resource. Tags are key/value pairs (metadata) that can be used to manage a resource. For more information, see <a…
  • DELETEUntagResource/tags/:resourceArn#tagKeys?tagKeys=stringRemoves one or more tags (metadata key/value pairs) from a resource.

API details

Base URL
http://projects.iot1click.{region}.amazonaws.com
https://projects.iot1click.{region}.amazonaws.com
http://projects.iot1click.{region}.amazonaws.com.cn
https://projects.iot1click.{region}.amazonaws.com.cn
Authentication
An API key in the Authorization header
Operations
16 operations on 8 pathsGET 6DELETE 4PUT 3POST 3
Response formats
application/json
Description format
OpenAPI 3.0.0, API version 2018-05-14
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the AWS IoT 1-Click Projects Service 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 IoT 1-Click Projects Service collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “AssociateDeviceWithPlacement” (PUT /projects/:projectName/placements/:placementName/devices/:deviceTemplateName), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS IoT 1-Click Projects Service?

The AWS IoT 1-Click Projects API Reference It is listed under IoT & devices and has 16 endpoints.

Who publishes the AWS IoT 1-Click Projects Service?

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 IoT 1-Click Projects Service?

Its description lists 4 base URLs: http://projects.iot1click.{region}.amazonaws.com, https://projects.iot1click.{region}.amazonaws.com, http://projects.iot1click.{region}.amazonaws.com.cn, https://projects.iot1click.{region}.amazonaws.com.cn. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the AWS IoT 1-Click Projects Service?

With an API key in the Authorization header.

How many endpoints does the AWS IoT 1-Click Projects Service have?

16 operations on 8 paths (6 GET, 4 DELETE, 3 PUT, 3 POST).

Is forking the AWS IoT 1-Click Projects Service 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.