ContextQMD
Back to Aws Doc Sdk Examples

Kinesis code examples for the SDK for JavaScript (v3)

javascriptv3/example_code/kinesis/README.md

latest3.5 KB
Original Source

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.

<!--custom.overview.start--> <!--custom.overview.end-->

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.
<!--custom.important.start--> <!--custom.important.end-->

Code examples

Prerequisites

For prerequisites, see the README in the javascriptv3 folder.

<!--custom.prerequisites.start-->

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.

<!--custom.prerequisites.end-->

Single actions

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

<!--custom.examples.start--> <!--custom.examples.end-->

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

bash
node ./actions/<fileName>

Run a scenario

Most scenarios can be run with the following command:

bash
node ./scenarios/<fileName>

Run with options

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

bash
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.

<!--custom.instructions.start--> <!--custom.instructions.end-->

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.

<!--custom.tests.start--> <!--custom.tests.end-->

Additional resources

<!--custom.resources.start--> <!--custom.resources.end-->

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

SPDX-License-Identifier: Apache-2.0