The aws-kinesis package

This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.

[maintain]

Warnings:

Bindings for Amazon Kinesis

Amazon Kinesis is an AWS service for real-time processing of streaming data at massive scale.

API Version: 2013-12-02

http://docs.aws.amazon.com/kinesis/2013-12-02/APIReference


[Skip to ReadMe]

Properties

Versions0.1, 0.1.1, 0.1.2, 0.1.3, 0.1.4, 0.1.4, 0.1.5
Change logCHANGELOG.md
Dependenciesaeson (>=0.7), aws (>=0.9), aws-general (>=0.2.1), base (==4.*), base64-bytestring (>=1.0), blaze-builder (>=0.3), bytestring (>=0.10), conduit (>=1.1), conduit-extra (>=1.1), http-conduit (>=2.1), http-types (>=0.8), parsers (>=0.11), QuickCheck (>=2.7), quickcheck-instances (>=0.3), resourcet (>=1.1), text (>=1.1), time (>=1.4), transformers (>=0.3) [details]
LicenseApache-2.0
CopyrightCopyright (c) 2013-2015 PivotCloud, Inc.
AuthorLars Kuhtz <lkuhtz@pivotmail.com>
MaintainerLars Kuhtz <lkuhtz@pivotmail.com>
CategoryNetwork, Web, AWS, Cloud, Distributed Computing
Home pagehttps://github.com/alephcloud/hs-aws-kinesis
Bug trackerhttps://github.com/alephcloud/hs-aws-kinesis/issues
Source repositoryhead: git clone https://github.com/alephcloud/hs-aws-kinesis.git
this: git clone https://github.com/alephcloud/hs-aws-kinesis.git(tag 0.1.4)
UploadedFri Mar 20 16:58:01 UTC 2015 by larsk

Modules

[Index]

Downloads

Maintainers' corner

For package maintainers and hackage trustees


Readme for aws-kinesis-0.1.4

[back to package description]

Build Status

Haskell Bindings for Amazon Kinesis

API Version 2013-12-02

Amazon Kinesis API Reference

This package depends on the aws-general package and the aws package. From the latter the it borrows the machinery for managing AWS credentials and making requests. There is also some documentation, including an usage example, in the README of the aws package

Installation

Assuming that the Haskell compiler GHC and the Haskell build tool cabal is already installed run the following command from the shell:

cabal install --enable-tests

Running Tests

There are few test cases included in the package. These tests require an AWS account and AWS credentials stored in the file ~/.aws-keys in the format described in the documentation of the aws package.

When running these tests some (low) costs may incur for usage of the AWS services. Therefor the user must explicitly consent to the usage of the AWS credentials by passing the commandline options --run-with-aws-credentials to the test application.

cabal test --test-option=--run-with-aws-credentials

Example Usage

Here is a very simple example for making a single request to AWS Kinesis. For more ellaborate usage refer to the documentation of the AWS package.

import Aws
import Aws.Core
import Aws.General
import Aws.Kinesis
import Data.IORef

cfg <- Aws.baseConfiguration
creds <- Credentials "access-key-id" "secret-access-key" `fmap` newIORef []
let kinesisCfg = KinesisConfiguration UsWest2
simpleAws cfg kinesisCfg $ ListStreams Nothing Nothing

In order to run the example you must replace "access-key-id" and "secret-access-key" with the respective values for your AWS account.

You may also take a look at the test examples in tests/Main.hs.