Cloud

Manage Device Clouds.

Find

Get a list of device clouds.

Endpoint

POST /cloud/find

Authorized User Role

user

Request Body

Field	Type	Notes
id	string	Cloud ID.

Query String Options

Field	Type	Default	Notes
index	string		Index name: primary or gs1.
limit	number		Limit number of results.
next	object		Token for next page.
prev	object		Token for previous page.

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

Field	Type	Notes
accountId	string	Owning account ID.
api	string	Hub (Device cloud) API endpoint.
apiGateway	string	Manager API Gateway ID.
awsAccount	string	AWS account ID.
connected	boolean	Cloud connected and has passed tests.
deviceRole	string	IAM role for device keys.
enable	boolean	Cloud enable flag.
error	string	Cloud error.
host	string	Cloud host for hosted clouds.
hubs	number	Number of cloud hubs for this host.
id	string	Cloud ID.
iotPolicy	string	IoT policy for device keys.
limits	object	Cloud limits.
load	number	Cloud load.
name	string	Cloud name.
open	boolean	Host cloud is open for new tennants.
planId	string	Plan ID.
provisioned	date	Provisioned date.
quota	object	Cloud quota.
region	string	Cloud region.
roles	object	Cloud roles.
schema	object	Cloud schema.
shadows	boolean	Cloud has IoT device shadows.
stack	string	CloudFormation stack.
status	string	CloudFormation stack status.
storagePlan	string	Cloud storage plan ID.
suspended	boolean	Cloud is suspended.
sync	boolean	Cloud supports device database synchronization.
tenants	number	Number of cloud hub tenants.
trailBucket	string	Cloud trail bucket.
transferPlan	string	Cloud transfer plan ID.
type	string	Cloud type.
version	number	Cloud version (for schema compatibility).
userPoolId	string	Cognito user pool ID.
userPoolClient	string	Cognito user pool Client ID.

Get

Get a cloud object.

Endpoint

POST /cloud/get

Authorized User Role

user

Request Body

Field	Type	Required	Notes
id	string	yes	Cloud ID.

Response

A cloud object.

Field	Type	Notes
accountId	string	Owning account ID.
api	string	Hub (Device cloud) API endpoint.
apiGateway	string	Manager API Gateway ID.
awsAccount	string	AWS account ID.
connected	boolean	Cloud connected and has passed tests.
deviceRole	string	IAM role for device keys.
enable	boolean	Cloud enable flag.
error	string	Cloud error.
host	string	Cloud host for hosted clouds.
hubs	number	Number of cloud hubs for this host.
id	string	Cloud ID.
iotPolicy	string	IoT policy for device keys.
limits	object	Cloud limits.
load	number	Cloud load.
name	string	Cloud name.
open	boolean	Host cloud is open for new tennants.
planId	string	Plan ID.
provisioned	date	Provisioned date.
quota	object	Cloud quota.
region	string	Cloud region.
roles	object	Cloud roles.
schema	object	Cloud schema.
shadows	boolean	Cloud has IoT device shadows.
stack	string	CloudFormation stack.
status	string	CloudFormation stack status.
storagePlan	string	Cloud storage plan ID.
suspended	boolean	Cloud is suspended.
sync	boolean	Cloud supports device database synchronization.
tenants	number	Number of cloud hub tenants.
trailBucket	string	Cloud trail bucket.
transferPlan	string	Cloud transfer plan ID.
type	string	Cloud type.
version	number	Cloud version (for schema compatibility).
userPoolId	string	Cognito user pool ID.
userPoolClient	string	Cognito user pool Client ID.

GetHosts

Get a list of matching hosts.

Endpoint

POST /cloud/getHosts

Authorized User Role

admin

Request Body

Field	Type	Notes
open	boolean	Open for tennants.
region	string	Region.

Response

Paged response.

Field	Type	Notes
data	array	An array of Host 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

Field	Type	Notes
name	string	Host name.
region	string	Region.

Remove

Remove a cloud.

Endpoint

POST /cloud/remove

Authorized User Role

admin

Request Body

Field	Type	Required	Notes
id	string	yes	Cloud ID.

Query String Options

Field	Type
invoke	string

Update

Update a cloud.

Endpoint

POST /cloud/update

Authorized User Role

admin

Request Body

Field	Type	Notes
align	boolean	Align flag.
attachments	object	Attachments.
deviceRole	string	Device role.
enable	boolean	Enable flag.
erase	object	Erase object.
error	string	Error.
id	string	Cloud ID.
iotPolicy	string	IoT policy.
name	string	Cloud name.
open	boolean	Open for tennants.
period	string	Period.
region	string	Region.
roles	object	Roles.
schema	object	Schema.
shadows	boolean	Enable AWS IoT shadows.
sync	boolean	Sync flag.
type	string	Cloud type.
units	number	Device units.
storage	number	Storage units.
transfer	number	Transfer units.

Response

A cloud object.

Field	Type	Notes
accountId	string	Owning account ID.
api	string	Hub (Device cloud) API endpoint.
apiGateway	string	Manager API Gateway ID.
awsAccount	string	AWS account ID.
connected	boolean	Cloud connected and has passed tests.
deviceRole	string	IAM role for device keys.
enable	boolean	Cloud enable flag.
error	string	Cloud error.
host	string	Cloud host for hosted clouds.
hubs	number	Number of cloud hubs for this host.
id	string	Cloud ID.
iotPolicy	string	IoT policy for device keys.
limits	object	Cloud limits.
load	number	Cloud load.
name	string	Cloud name.
open	boolean	Host cloud is open for new tennants.
planId	string	Plan ID.
provisioned	date	Provisioned date.
quota	object	Cloud quota.
region	string	Cloud region.
roles	object	Cloud roles.
schema	object	Cloud schema.
shadows	boolean	Cloud has IoT device shadows.
stack	string	CloudFormation stack.
status	string	CloudFormation stack status.
storagePlan	string	Cloud storage plan ID.
suspended	boolean	Cloud is suspended.
sync	boolean	Cloud supports device database synchronization.
tenants	number	Number of cloud hub tenants.
trailBucket	string	Cloud trail bucket.
transferPlan	string	Cloud transfer plan ID.
type	string	Cloud type.
version	number	Cloud version (for schema compatibility).
userPoolId	string	Cognito user pool ID.
userPoolClient	string	Cognito user pool Client ID.