aws-general-0.2.1: Bindings for Amazon Web Services (AWS) General Reference

CopyrightCopyright © 2014 AlephCloud Systems, Inc.
LicenseBSD3
MaintainerLars Kuhtz <lars@alephcloud.com>
Stabilityexperimental
Safe HaskellNone
LanguageHaskell2010

Aws.General

Contents

Description

Bindings for AWS General Reference

API Version: 1.0

http://docs.aws.amazon.com/general/latest/gr/

Synopsis

Documentation

class AwsType a where Source

Minimal complete definition

toText, parse

Methods

toText :: (IsString b, Monoid b) => a -> b Source

parse :: (Monad m, CharParsing m) => m a Source

fromText :: Text -> Either String a Source

Instances

AWS General Version

data GeneralVersion Source

Constructors

GeneralVersion_1_0 

Instances

generalVersionToText :: IsString a => GeneralVersion -> a Source

parseGeneralVersion :: CharParsing m => m GeneralVersion Source

SignatureVersion

data SignatureVersion Source

Constructors

SignatureVersion2 
SignatureVersion4 

Instances

signatureVersionToText :: IsString a => SignatureVersion -> a Source

parseSignatureVersion :: CharParsing m => m SignatureVersion Source

SignatureMethod

data SignatureMethod Source

Constructors

SignatureMethodSha1 
SignatureMethodSha256 

Instances

signatureMethodToText :: IsString a => SignatureMethod -> a Source

parseSignatureMethod :: CharParsing m => m SignatureMethod Source

AWS Region

data Region Source

Region

http://docs.aws.amazon.com/general/1.0/gr/rande.html

The relation between regions and service endpoints is not bijective for all AWS services. Not all AWS services support all regions. Some services don't use the concept of region at all.

Constructors

ApNortheast1 
ApSoutheast1 
ApSoutheast2 
EuWest1 
SaEast1 
UsEast1 
UsWest1 
UsWest2 
CustomEndpoint !Text !Int

To override the region settings with a custom service endpoint, e.g. for testing purpose

Instances

regionToText :: (Monoid a, IsString a) => Region -> a Source

parseRegion :: CharParsing m => m Region Source

Regions are parsed as follows:

ApNortheast1   ::= "ap-northeast-1"
ApSoutheast1   ::= "ap-southeast-1"
ApSoutheast2   ::= "ap-southeast-2"
EuWest1        ::= "eu-west-1"
SaEast1        ::= "sa-east-1"
UsEast1        ::= "us-east-1"
UsWest1        ::= "us-west-1"
UsWest2        ::= "us-west-2"
CustomEndpoint ::= "custom:" Text ":" Int

AWS Account ID

newtype AccountId Source

AWS Account Id

http://docs.aws.amazon.com/general/1.0/gr/acct-identifiers.html.

This is actually a 12 digit number.

Constructors

AccountId Text 

Instances

accountIdToText :: IsString a => AccountId -> a Source

parseAccountId :: CharParsing m => m AccountId Source

AWS Canonical User ID

newtype CanonicalUserId Source

AWS Canonical User ID

http://docs.aws.amazon.com/general/latest/gr/acct-identifiers.html.

This is actually a long hexadecimal number

Constructors

CanonicalUserId Text 

Instances

canonicalUserIdToText :: IsString a => CanonicalUserId -> a Source

parseCanonicalUserId :: CharParsing m => m CanonicalUserId Source

AWS Service Namespace

data ServiceNamespace Source

AWS Service Namespaces

http://docs.aws.amazon.com/general/1.0/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces

Constructors

ServiceNamespaceAwsPortal 
ServiceNamespaceAutoscaling 
ServiceNamespaceCloudformation 
ServiceNamespaceCloudfront 
ServiceNamespaceCloudwatch 
ServiceNamespaceDynamodb 
ServiceNamespaceEc2

Amazon EC2 and Amazon VPC

ServiceNamespaceElasticbeanstalk 
ServiceNamespaceElasticloadbalancing 
ServiceNamespaceElasticmapreduce 
ServiceNamespaceElasticache 
ServiceNamespaceGlacier 
ServiceNamespaceIam 
ServiceNamespaceKinesis 
ServiceNamespaceAwsMarketplaceManagement 
ServiceNamespaceOpsworks 
ServiceNamespaceRds 
ServiceNamespaceRedshift 
ServiceNamespaceRoute53 
ServiceNamespaceS3 
ServiceNamespaceSes 
ServiceNamespaceSdb 
ServiceNamespaceSqs 
ServiceNamespaceSns 
ServiceNamespaceStoragegateway 
ServiceNamespaceSts 
ServiceNamespaceSupport 
ServiceNamespaceSwf 
ServiceNamespaceHost

For testing purposes (see http://docs.aws.amazon.com/general/1.0/gr/signature-v4-test-suite.html)

Instances

serviceNamespaceToText :: IsString a => ServiceNamespace -> a Source

parseServiceNamespace :: CharParsing m => m ServiceNamespace Source

AWS ARN

data Arn Source

Amazon Resource Names

http://docs.aws.amazon.com/general/1.0/gr/aws-arns-and-namespaces.html

From the specification it is not clear if elements of arnResource can be empty. Though examples given in the specification do not inlcude such a case, our parser allows it.

Constructors

Arn 

Fields

arnService :: ServiceNamespace
 
arnRegion :: Maybe Region
 
arnAccount :: Maybe AccountId
 
arnResource :: [Text]

expected to be non-empty. Elements are separated by only :. / is not treated specially.

Instances

Eq Arn 
Ord Arn 
Read Arn 
Show Arn 
Arbitrary Arn

This instance if for general testing of the syntax of ARNs. For service specific ARNs you should use a newtype wrapper and define an Arbitrary instance the satisfies the constraints of that particular services.

ToJSON Arn 
FromJSON Arn 
AwsType Arn 
Typeable * Arn 

arnToText :: (IsString a, Monoid a) => Arn -> a Source

parseArn :: CharParsing m => m Arn Source