1N1nce
IoT Integrator

Create AWS Integration

Creates AWS Integration, which becomes active only after customer Cloudformation stack is rolled out.

post/v1/integrate/clouds/aws

Request

  • Base URL
    https://api.1nce.com/management-api
  • Auth
    HTTP bearer

Request body

namestring required

Name of the new AWS integration.

jsonPayloadEnabledboolean

Flag if the payloads of this integration should be bridged in JSON format.

Example request

{
  "name": "<integraton_name>",
  "eventTypes": [
    {
      "type": "TELEMETRY_DATA",
      "version": "1.0.0"
    }
  ],
  "jsonPayloadEnabled": true
}

Response

Created AWS Integration Details.

namestring required

Name of the new AWS integration.

state'ROLLOUT_STARTED' | 'ROLLOUT_DONE' | 'ROLLOUT_FAILED' | 'INTEGRATION_ACTIVE' | 'INTEGRATION_FAILED' required

State of the new AWS integration.

type'AWS' required

Type of the new integration.

idstring required

ID of the new AWS integration.

jwtstring required

JWT token with details for integration stack creation

createdTimestring date-time required

Created timestamp of the AWS integration.

updatedTimestring date-time required

Updated timestamp of the AWS integration.

jsonPayloadEnabledboolean required

Flag if the payloads of this integration should be bridged in JSON format.

Example response

{
  "name": "<integraton_name>",
  "eventTypes": [
    {
      "type": "TELEMETRY_DATA",
      "version": "1.0.0"
    }
  ],
  "state": "ROLLOUT_STARTED",
  "type": "AWS",
  "id": "<integration_id>",
  "jwt": "<jwt_token>",
  "createdTime": "2022-03-07T08:51:29.015Z",
  "updatedTime": "2022-03-07T08:51:29.015Z",
  "jsonPayloadEnabled": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.