Skip to main content

AWS Kinesis

Connect with Amazon's platform to have your IoT device and alert event data sent to an AWS Kinesis stream.

Connecting to AWS Kinesis​

Use the following steps to setup the AWS Kinesis Integration.

  1. Log into your Amazon AWS Console.
  2. Go to the Kinesis Service and pull up the details for the Kinesis stream that you want to utilize. You will need the Stream ARN name later when adding the integration.

alt text

  1. Within your AWS account, copy the Access Key and Secret Key pair for the user that will be used to write data to the queue.

    alt text Note: Refer to Amazon's Best Practice guide for setting up, accessing and using these keys. We strongly recommend that you secure the access key used by first creating a policy with create permission to your queue and then add the policy to a user, such as outlined in Access Policies.

alt text

  1. Log into your account on the IoT in a Box portal or using the mobile app.
  2. Select the Integrations option and then select the AWS Kinesis integration.
  3. Enter the following information to complete the integration:
    • Name: Enter a name for this integration. In case you have multiple integrations, this will help uniquely identify it in the list.
    • Access Key: Enter the Access Key used to access the queue.
    • Access Secret: Enter the Access Secret associated with the Access Key.
    • Kinesis Stream ARM: Enter the full ARN for your stream.

alt text

alt text After saving the Integration, you will see it shown in your list of integrations.

alt text

  • You can then edit the integration to make any changes needed.
  • You can also toggle the Integration on/off at any time from here as well. Disabling the integration will stop new data from being sent to the AWS Kinesis stream.

Verifying things are working​

There isn't a really easy way to verify data from the Amazon Console directly. However, if you want to verify records we have written a simple records inspector that will fetch records over the last hour. You can also fork the code and change it to suit your needs.

Kinesis Records Inspector - The inspector form will ask you for your Access Key, Secret and Stream ARN.

alt text Note: It may take a few minutes after readings are sent before they appear in Kinesis. Please keep this in mind when verifying data.

alt text Note: Data is logged in reading and alert records, one for each new event, recorded in JSON format.

alt text