| Copyright | Copyright (c) 2013-2015 PivotCloud, Inc. |
|---|---|
| License | Apache License, Version 2.0 |
| Maintainer | Lars Kuhtz <lars@alephcloud.com> |
| Stability | experimental |
| Safe Haskell | None |
| Language | Haskell2010 |
Aws.Kinesis.Core
Contents
Description
API Version: 2013-12-02
- data KinesisVersion = KinesisVersion_2013_12_02
- data KinesisConfiguration qt = KinesisConfiguration {}
- defaultKinesisConfiguration :: Region -> KinesisConfiguration qt
- data KinesisMetadata = KinesisMetadata {}
- data KinesisErrorResponse
- data KinesisAction
- kinesisActionToText :: IsString a => KinesisAction -> a
- parseKinesisAction :: CharParsing m => m KinesisAction
- kinesisServiceEndpoint :: Region -> ByteString
- data KinesisQuery = KinesisQuery {}
- kinesisSignQuery :: KinesisQuery -> KinesisConfiguration qt -> SignatureData -> SignedQuery
- kinesisResponseConsumer :: FromJSON a => IORef KinesisMetadata -> HTTPResponseConsumer a
- jsonResponseConsumer :: FromJSON a => HTTPResponseConsumer a
- data KinesisError a
- data KinesisCommonParameters = KinesisCommonParameters {
- kinesisAction :: !KinesisAction
- kinesisAuthParams :: !(Maybe ())
- kinesisAWSAccessKeyId :: !ByteString
- kinesisExpires :: !UTCTime
- kinesisTimestamp :: !UTCTime
- kinesisSecurityToken :: ()
- kinesisSignature :: !Signature
- kinesisSignatureMethod :: !SignatureMethod
- kinesisSignatureVersion :: !SignatureVersion
- kinesisVersion :: KinesisVersion
- data KinesisCommonError
- = ErrorIncompleteSignature
- | ErrorInternalFailure
- | ErrorInvalidAction
- | ErrorInvalidClientTokenId
- | ErrorInvalidParameterCombination
- | ErrorInvalidParameterValue
- | ErrorInvalidQueryParamter
- | ErrorMalformedQueryString
- | ErrorMissingAction
- | ErrorMissingAuthenticationToken
- | ErrorMissingParameter
- | ErrorOptInRequired
- | ErrorRequestExpired
- | ErrorServiceUnavailable
- | ErrorThrottling
- | ErrorValidationError
Documentation
data KinesisVersion Source
Constructors
| KinesisVersion_2013_12_02 |
Kinesis Client Configuration
data KinesisConfiguration qt Source
Constructors
| KinesisConfiguration | |
Fields | |
Instances
| Show (KinesisConfiguration qt) | |
| Typeable (* -> *) KinesisConfiguration |
Kinesis Client Metadata
data KinesisMetadata Source
Constructors
| KinesisMetadata | |
Fields | |
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.
Constructors
| KinesisErrorResponse | |
Fields
| |
| KinesisResponseJsonError Text | |
| KinesisOtherError | |
Fields | |
Instances
| Eq KinesisErrorResponse | |
| Ord KinesisErrorResponse | |
| Show KinesisErrorResponse | |
| Generic KinesisErrorResponse | |
| FromJSON KinesisErrorResponse | This instance captures only the |
| Exception KinesisErrorResponse | |
| NFData KinesisErrorResponse | |
| Typeable * KinesisErrorResponse | |
| type Rep KinesisErrorResponse |
Internal
Kinesis Actions
data KinesisAction Source
kinesisActionToText :: IsString a => KinesisAction -> a Source
parseKinesisAction :: CharParsing m => m KinesisAction Source
Kinesis AWS Service Endpoints
kinesisServiceEndpoint :: Region -> ByteString Source
Kinesis Endpoints as specified in AWS General API version 0.1
http://docs.aws.amazon.com/general/1.0/gr/rande.html#ak_region
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
Constructors
| KinesisErrorCommon KinesisCommonError | |
| KinesisErrorCommand a |
Instances
| Eq a => Eq (KinesisError a) | |
| Ord a => Ord (KinesisError a) | |
| Read a => Read (KinesisError a) | |
| Show a => Show (KinesisError a) | |
| Generic (KinesisError a) | |
| NFData a => NFData (KinesisError a) | |
| Typeable (* -> *) KinesisError | |
| type Rep (KinesisError a) |
data KinesisCommonParameters Source
Common Kinesis Parameters
http://docs.aws.amazon.com/kinesis/2013-12-02/APIReference/CommonParameters.html
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./
Constructors
| KinesisCommonParameters | |
Fields
| |
data KinesisCommonError Source
Common Kinesis Errors
http://docs.aws.amazon.com/sns/2010-03-31/APIReference/CommonErrors.html
TODO add function to provide info about the error (content of haddock comments)
Constructors
| ErrorIncompleteSignature | The request signature does not conform to AWS standards. Code 400 |
| ErrorInternalFailure | The request processing has failed because of an unknown error, exception or failure. Code 500 |
| ErrorInvalidAction | The action or operation requested is invalid. Verify that the action is typed correctly. Code 400 |
| ErrorInvalidClientTokenId | The X.509 certificate or AWS access key ID provided does not exist in our records. Code 403 |
| ErrorInvalidParameterCombination | Parameters that must not be used together were used together. Code 400 |
| ErrorInvalidParameterValue | An invalid or out-of-range value was supplied for the input parameter. Code 400 |
| ErrorInvalidQueryParamter | The AWS query string is malformed or does not adhere to AWS standards. Code 400 |
| ErrorMalformedQueryString | The query string contains a syntax error. Code 404 |
| ErrorMissingAction | The request is missing an action or a required parameter. Code 400 |
| ErrorMissingAuthenticationToken | The request must contain either a valid (registered) AWS access key ID or X.509 certificate. Code 403 |
| ErrorMissingParameter | A required parameter for the specified action is not supplied. Code 400 |
| ErrorOptInRequired | The AWS access key ID needs a subscription for the service. Code 403 |
| ErrorRequestExpired | 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 |
| ErrorServiceUnavailable | The request has failed due to a temporary failure of the server. Code 503 |
| ErrorThrottling | The request was denied due to request throttling. Code 400 |
| ErrorValidationError | The input fails to satisfy the constraints specified by an AWS service. Code 400 |