Cloud

Manage Device Clouds.

---

Create

Create a device cloud

This call created a device cloud object in preparation for running an
AWS CloudFormation template to create the required device cloud resources
in the target AWS account.

Endpoint

POST /cloud/create

Authorized User Role

admin

Request Body

Field	Type
enable	boolean
error	string
external	string
iotPolicy	string
name	string
open	boolean
region	string
schema	object
shadows	boolean
sync	boolean
type	string

Response

A cloud object.

Field	Type
accountId	string
api	string
apiGateway	string
awsAccount	string
connected	boolean
deviceRole	string
devices	number
enable	boolean
error	string
host	string
hubs	number
id	string
iotPolicy	string
load	number
name	string
open	boolean
planId	string
provisioned	date
quota	object
region	string
schema	object
shadows	boolean
stack	string
status	string
suspended	boolean
sync	boolean
tenants	number
trailBucket	string
type	string
version	number
userPoolId	string
userPoolClient	string

---

Find

Get a list of device clouds

Endpoint

POST /cloud/find

Authorized User Role

user

Request Body

Field	Type
id	string

Query String Options

Field	Type
hidden	boolean
filter	string
limit	number
next	object
prev	object
index	string
where	string
log	boolean

Response

Paged response.

Field	Type	Notes
data	array	A list of cloud records.
next	string	Paged cursor to use for the next page of items.
prev	string	Pages cursor to use for the previous page of items.

Cloud

An array of Cloud items.

Field	Type
accountId	string
api	string
apiGateway	string
awsAccount	string
connected	boolean
deviceRole	string
devices	number
enable	boolean
error	string
host	string
hubs	number
id	string
iotPolicy	string
load	number
name	string
open	boolean
planId	string
provisioned	date
quota	object
region	string
schema	object
shadows	boolean
stack	string
status	string
suspended	boolean
sync	boolean
tenants	number
trailBucket	string
type	string
version	number
userPoolId	string
userPoolClient	string

---

Get

Get a cloud object

Endpoint

POST /cloud/get

Authorized User Role

user

Request Body

Field	Type	Required
id	string	yes

Response

A cloud object.

Field	Type
accountId	string
api	string
apiGateway	string
awsAccount	string
connected	boolean
deviceRole	string
devices	number
enable	boolean
error	string
host	string
hubs	number
id	string
iotPolicy	string
load	number
name	string
open	boolean
planId	string
provisioned	date
quota	object
region	string
schema	object
shadows	boolean
stack	string
status	string
suspended	boolean
sync	boolean
tenants	number
trailBucket	string
type	string
version	number
userPoolId	string
userPoolClient	string

---

GetBrowserKeys

Get temporary AWS IAM credentials for use in the browser

Endpoint

POST /cloud/getBrowserKeys

Authorized User Role

user

Request Body

Field	Type	Required
id	string	yes

Response

Temporary AWS cloud credentials for access to the device cloud AWS account.

Field	Type
accessKeyId	string
secretAccessKey	string
sessionToken	string
expires	date
region	string

---

Init

Endpoint

POST /cloud/init

Authorized User Role

user

Request Body

A object.

Response

Field	Type
accountId	string
api	string
apiGateway	string
awsAccount	string
connected	boolean
deviceRole	string
devices	number
enable	boolean
error	string
host	string
hubs	number
id	string
iotPolicy	string
load	number
name	string
open	boolean
planId	string
provisioned	date
quota	object
region	string
schema	object
shadows	boolean
stack	string
status	string
suspended	boolean
sync	boolean
tenants	number
trailBucket	string
type	string
version	number
userPoolId	string
userPoolClient	string

---

Provision

Endpoint

POST /cloud/provision

Authorized User Role

admin

Request Body

Field	Type	Required
id	string	yes

Query String Options

Field	Type
invoke	string

Response

Field	Type
accountId	string
api	string
apiGateway	string
awsAccount	string
connected	boolean
deviceRole	string
devices	number
enable	boolean
error	string
host	string
hubs	number
id	string
iotPolicy	string
load	number
name	string
open	boolean
planId	string
provisioned	date
quota	object
region	string
schema	object
shadows	boolean
stack	string
status	string
suspended	boolean
sync	boolean
tenants	number
trailBucket	string
type	string
version	number
userPoolId	string
userPoolClient	string

---

ProvisionAsync

Endpoint

POST /cloud/provisionAsync

Authorized User Role

service

Request Body

Field	Type	Required
id	string	yes
accountId	string	yes

Response

Field	Type
accountId	string
api	string
apiGateway	string
awsAccount	string
connected	boolean
deviceRole	string
devices	number
enable	boolean
error	string
host	string
hubs	number
id	string
iotPolicy	string
load	number
name	string
open	boolean
planId	string
provisioned	date
quota	object
region	string
schema	object
shadows	boolean
stack	string
status	string
suspended	boolean
sync	boolean
tenants	number
trailBucket	string
type	string
version	number
userPoolId	string
userPoolClient	string

---

Remove

Endpoint

POST /cloud/remove

Authorized User Role

admin

Request Body

Field	Type	Required
id	string	yes

Query String Options

Field	Type
invoke	string

---

RemoveAsync

Endpoint

POST /cloud/removeAsync

Authorized User Role

service

Request Body

Field	Type	Required
accountId	string	yes
id	string	yes

---

UpdateStack

Endpoint

POST /cloud/updateStack

Authorized User Role

admin

Request Body

Field	Type	Required
id	string	yes

Response

Field	Type
accountId	string
api	string
apiGateway	string
awsAccount	string
connected	boolean
deviceRole	string
devices	number
enable	boolean
error	string
host	string
hubs	number
id	string
iotPolicy	string
load	number
name	string
open	boolean
planId	string
provisioned	date
quota	object
region	string
schema	object
shadows	boolean
stack	string
status	string
suspended	boolean
sync	boolean
tenants	number
trailBucket	string
type	string
version	number
userPoolId	string
userPoolClient	string

---

WaitForTemplate

Endpoint

POST /cloud/waitForTemplate

Authorized User Role

admin

Request Body

Field	Type	Required
id	string	yes

Response

Field	Type
accountId	string
api	string
apiGateway	string
awsAccount	string
connected	boolean
deviceRole	string
devices	number
enable	boolean
error	string
host	string
hubs	number
id	string
iotPolicy	string
load	number
name	string
open	boolean
planId	string
provisioned	date
quota	object
region	string
schema	object
shadows	boolean
stack	string
status	string
suspended	boolean
sync	boolean
tenants	number
trailBucket	string
type	string
version	number
userPoolId	string
userPoolClient	string

---

GetHosts

Endpoint

POST /cloud/getHosts

Authorized User Role

admin

Request Body

Field	Type
open	boolean
region	string

Response

Paged response.

Field	Type	Notes
data	array	A list of cloud records.
next	string	Paged cursor to use for the next page of items.
prev	string	Pages cursor to use for the previous page of items.

Host

An array of Host items.

Field	Type
name	string
region	string

---

Connect

Pass IAM Role from device cloud back to the builer when the CFT completes

Endpoint

POST /cloud/connect

Authorized User Role

cloud

Request Body

Field	Type
api	string
awsAccount	string
cloud	string
deviceRole	string
connected	boolean
error	string
external	string
roleArn	string
stack	string
token	object
version	string

Response

Field	Type
accountId	string
api	string
apiGateway	string
awsAccount	string
connected	boolean
deviceRole	string
devices	number
enable	boolean
error	string
host	string
hubs	number
id	string
iotPolicy	string
load	number
name	string
open	boolean
planId	string
provisioned	date
quota	object
region	string
schema	object
shadows	boolean
stack	string
status	string
suspended	boolean
sync	boolean
tenants	number
trailBucket	string
type	string
version	number
userPoolId	string
userPoolClient	string

---

Report

Report monthly device usage from a device cloud to the builder

Endpoint

POST /cloud/report

Authorized User Role

cloud

Request Body

Field	Type
accountId	string
count	number
cloudId	string
load	number
usage	array

Usage

An array of Usage items.

Field	Type
devices	number
tenants	number
load	number

---

Update

Endpoint

POST /cloud/update

Authorized User Role

admin

Request Body

Field	Type
attachments	object
deviceRole	string
enable	boolean
erase	object
error	string
external	string
id	string
iotPolicy	string
name	string
open	boolean
region	string
schema	object
shadows	boolean
sync	boolean
type	string

Response

A cloud object.

Field	Type
accountId	string
api	string
apiGateway	string
awsAccount	string
connected	boolean
deviceRole	string
devices	number
enable	boolean
error	string
host	string
hubs	number
id	string
iotPolicy	string
load	number
name	string
open	boolean
planId	string
provisioned	date
quota	object
region	string
schema	object
shadows	boolean
stack	string
status	string
suspended	boolean
sync	boolean
tenants	number
trailBucket	string
type	string
version	number
userPoolId	string
userPoolClient	string