aws-kinesis-0.1.3: Bindings for Amazon Kinesis

CopyrightCopyright (c) 2013-2014 PivotCloud, Inc.
LicenseApache License, Version 2.0
MaintainerLars Kuhtz <>
Safe HaskellNone






Kinesis Client Configuration

Kinesis Client Metadata

Kinesis Exceptions

data KinesisErrorResponse Source

All Kinesis exceptions have HTTP status code 400 and include a JSON body with an exception type property and a short message.


Kinesis Actions

Kinesis AWS Service Endpoints

Kinesis Queries

kinesisSignQuery :: KinesisQuery -> KinesisConfiguration qt -> SignatureData -> SignedQuery Source

Creates a signed query.

Uses AWS Signature V4. All requests are POST requests with the signature placed in an HTTP header

Kinesis Responses

jsonResponseConsumer :: FromJSON a => HTTPResponseConsumer a Source

Create a complete HTTPResponseConsumer for response types with an FromJSON instance

Kinesis Errors and Common Parameters

data KinesisError a Source

TODO integrate typed errors


Eq a => Eq (KinesisError a) 
Ord a => Ord (KinesisError a) 
Read a => Read (KinesisError a) 
Show a => Show (KinesisError a) 
Typeable (* -> *) KinesisError 

data KinesisCommonParameters Source

Common Kinesis Parameters

The user of this API hardy needs to deal with the data type directly.

This API supports only signature version 4 with signature method AWS4-HMAC-SHA256.

/This is not currently used for computing the requests, but serves as documentation and reference for the implementation of yet missing features./




kinesisAction :: !KinesisAction

The action to be performed.

kinesisAuthParams :: !(Maybe ())

The parameters that are required to authenticate a Conditional request. Contains:

  • AWSAccessKeyID
  • SignatureVersion
  • Timestamp
  • Signature
kinesisAWSAccessKeyId :: !ByteString

The access key ID that corresponds to the secret access key that you used to sign the request.

kinesisExpires :: !UTCTime

The date and time when the request signature expires. Precisely one of snsExpires or snsTimestamp must be present.

format: YYYY-MM-DDThh:mm:ssZ (ISO 8601)

kinesisTimestamp :: !UTCTime

The date and time of the request. Precisely one of snsExpires or snsTimestamp must be present.

format: YYYY-MM-DDThh:mm:ssZ (ISO 8601)

kinesisSecurityToken :: ()


The temporary security token that was obtained through a call to AWS Security Token Service. For a list of services that support AWS Security Token Service, go to Using Temporary Security Credentials to Access AWS in Using Temporary Security Credentials.

kinesisSignature :: !Signature

The digital signature that you created for the request. For information about generating a signature, go to the service's developer documentation.

kinesisSignatureMethod :: !SignatureMethod

The hash algorithm that you used to create the request signature.

Valid Values: HmacSHA256 | HmacSHA1

kinesisSignatureVersion :: !SignatureVersion

The signature version you use to sign the request. Set this to the value that is recommended for your service.

kinesisVersion :: KinesisVersion

The API version that the request is written for.

data KinesisCommonError Source

Common Kinesis Errors

TODO add function to provide info about the error (content of haddock comments)



The request signature does not conform to AWS standards.

Code 400


The request processing has failed because of an unknown error, exception or failure.

Code 500


The action or operation requested is invalid. Verify that the action is typed correctly.

Code 400


The X.509 certificate or AWS access key ID provided does not exist in our records.

Code 403


Parameters that must not be used together were used together.

Code 400


An invalid or out-of-range value was supplied for the input parameter.

Code 400


The AWS query string is malformed or does not adhere to AWS standards.

Code 400


The query string contains a syntax error.

Code 404


The request is missing an action or a required parameter.

Code 400


The request must contain either a valid (registered) AWS access key ID or X.509 certificate.

Code 403


A required parameter for the specified action is not supplied.

Code 400


The AWS access key ID needs a subscription for the service.

Code 403


The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future.

Code 400


The request has failed due to a temporary failure of the server.

Code 503


The request was denied due to request throttling.

Code 400


The input fails to satisfy the constraints specified by an AWS service.

Code 400