Skip to content

Latest commit

 

History

History
108 lines (65 loc) · 3.53 KB

README.md

File metadata and controls

108 lines (65 loc) · 3.53 KB
Raw

Kinesis code examples for the SDK for JavaScript (v3)

Overview

Shows how to use the AWS SDK for JavaScript (v3) to work with Amazon Kinesis.

Kinesis makes it easy to collect, process, and analyze video and data streams in real time.

⚠ Important

  • Running this code might result in charges to your AWS account. For more details, see AWS Pricing and Free Tier.
  • Running the tests might result in charges to your AWS account.
  • We recommend that you grant your code least privilege. At most, grant only the minimum permissions required to perform the task. For more information, see Grant least privilege.
  • This code is not tested in every AWS Region. For more information, see AWS Regional Services.

Code examples

Prerequisites

For prerequisites, see the README in the javascriptv3 folder.

This service folder contains AWS Cloud Development Kit (CDK) code that will set up the necessary resources required to run the examples. It also contains a stack.yaml with the AWS CloudFormation (CFN) template generated from the CDK.

Create resources with the CDK using cdk deploy or with CFN using aws cloudformation create-stack.

Single actions

Code excerpts that show you how to call individual service functions.

Run the examples

Instructions

Note: All code examples are written in ECMAscript 6 (ES6). For guidelines on converting to CommonJS, see JavaScript ES6/CommonJS syntax.

Run a single action

node ./actions/<fileName>

Run a scenario

Most scenarios can be run with the following command:

node ./scenarios/<fileName>

Run with options

Some actions and scenarios can be run with options from the command line:

node ./scenarios/<fileName> --option1 --option2

util.parseArgs is used to configure these options. For the specific options available to each script, see the parseArgs usage for that file.

Tests

⚠ Running tests might result in charges to your AWS account.

To find instructions for running these tests, see the README in the javascriptv3 folder.

Additional resources

Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

SPDX-License-Identifier: Apache-2.0