Skip to content

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

1
POST /cloud/create

Authorized Role

1
admin

JSON Body Fields

Field Type Required Notes
deviceRole string
enable string
iotPolicy string
name string
period string
region string
type string

Response

A cloud record.


Find

Get a list of device clouds

Endpoint

1
POST /cloud/find

Authorized Role

1
user

JSON Body Fields

Field Type Required Notes
id string

Response

A list of cloud records.


Get

Get a cloud object

Endpoint

1
POST /cloud/get

Authorized Role

1
user

JSON Body Fields

Field Type Required Notes
id string yes

Response

A cloud object.


Remove

Endpoint

1
POST /cloud/remove

Authorized Role

1
admin

JSON Body Fields

Field Type Required Notes
id string yes

Update

Endpoint

1
POST /cloud/update

Authorized Role

1
admin

JSON Body Fields

Field Type Required Notes
deviceRole string
enable string
error string
id string
iotPolicy string
name string
region string

Response

A cloud object.


GetKeys

Get temporary AWS IAM credentials

Endpoint

1
POST /cloud/getKeys

Authorized Role

1
user

JSON Body Fields

Field Type Required Notes
id string yes

Response

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


SetSchema

Update the DynamoDB OneTable device database schema

Endpoint

1
POST /cloud/setSchema

Authorized Role

1
admin

JSON Body Fields

Field Type Required Notes
id string yes
schema object yes