ContextQMD
Back to Aws Doc Sdk Examples

Kinesis code examples for the SDK for C++

cpp/example_code/kinesis/README.md

latest3.2 KB
Original Source

Kinesis code examples for the SDK for C++

Overview

Shows how to use the AWS SDK for C++ 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

Before using the code examples, first complete the installation and setup steps for Getting started in the AWS SDK for C++ Developer Guide. This section covers how to get and build the SDK, and how to build your own code by using the SDK with a sample Hello World-style application.

Next, for information on code example structures and how to build and run the examples, see Getting started with the AWS SDK for C++ code examples.

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

Run the examples

Instructions

An executable is built for each source file in this folder. These executables are located in the build folder and have "run_" prepended to the source file name, minus the suffix. See the "main" function in the source file for further instructions.

For example, to run the action in the source file "my_action.cpp", execute the following command from within the build folder. The command will display any required arguments.

./run_my_action

If the source file is in a different folder, instructions can be found in the README in that folder.

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

Tests

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

sh
   cd <BUILD_DIR>
   cmake <path-to-root-of-this-source-code> -DBUILD_TESTS=ON
   make
   ctest
<!--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