Aws.General

Bindings for AWS General Reference

API Version: 1.0

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

Documentation

class AwsType a where

Minimal complete definition

toText, parse

Methods

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

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

fromText :: Text -> Either String a

Instances

AwsType Arn

AwsType ServiceNamespace

AwsType CanonicalUserId

AwsType AccountId

AwsType Region

AwsType SignatureMethod

AwsType SignatureVersion

AwsType GeneralVersion

AwsType CredentialScope

AWS General Version

data GeneralVersion

Constructors

GeneralVersion_1_0

Instances

Bounded GeneralVersion

Enum GeneralVersion

Eq GeneralVersion

Ord GeneralVersion

Read GeneralVersion

Show GeneralVersion

Arbitrary GeneralVersion

AwsType GeneralVersion

Typeable * GeneralVersion

generalVersionToText :: IsString a => GeneralVersion -> a

parseGeneralVersion :: CharParsing m => m GeneralVersion

SignatureVersion

data SignatureVersion

Constructors

SignatureVersion2

SignatureVersion4

Instances

Bounded SignatureVersion

Enum SignatureVersion

Eq SignatureVersion

Ord SignatureVersion

Read SignatureVersion

Show SignatureVersion

Arbitrary SignatureVersion

AwsType SignatureVersion

Typeable * SignatureVersion

signatureVersionToText :: IsString a => SignatureVersion -> a

parseSignatureVersion :: CharParsing m => m SignatureVersion

SignatureMethod

data SignatureMethod

Constructors

SignatureMethodSha1

SignatureMethodSha256

Instances

Bounded SignatureMethod

Enum SignatureMethod

Eq SignatureMethod

Ord SignatureMethod

Read SignatureMethod

Show SignatureMethod

Arbitrary SignatureMethod

AwsType SignatureMethod

Typeable * SignatureMethod

signatureMethodToText :: IsString a => SignatureMethod -> a

parseSignatureMethod :: CharParsing m => m SignatureMethod

AWS Region

data Region

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

Instances

Bounded Region

Enum Region

Eq Region

Ord Region

Read Region

Show Region

Arbitrary Region

Hashable Region

AwsType Region

Typeable * Region

regionToText :: IsString a => Region -> a

parseRegion :: CharParsing m => m Region

AWS Account ID

newtype AccountId

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

Eq AccountId

Ord AccountId

Read AccountId

Show AccountId

IsString AccountId

Arbitrary AccountId

AwsType AccountId

Typeable * AccountId

accountIdToText :: IsString a => AccountId -> a

parseAccountId :: CharParsing m => m AccountId

AWS Canonical User ID

newtype CanonicalUserId

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

Eq CanonicalUserId

Ord CanonicalUserId

Read CanonicalUserId

Show CanonicalUserId

IsString CanonicalUserId

Arbitrary CanonicalUserId

AwsType CanonicalUserId

Typeable * CanonicalUserId

canonicalUserIdToText :: IsString a => CanonicalUserId -> a

parseCanonicalUserId :: CharParsing m => m CanonicalUserId

AWS Service Namespace

data ServiceNamespace

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

Bounded ServiceNamespace

Enum ServiceNamespace

Eq ServiceNamespace

Ord ServiceNamespace

Read ServiceNamespace

Show ServiceNamespace

Arbitrary ServiceNamespace

Hashable ServiceNamespace

AwsType ServiceNamespace

Typeable * ServiceNamespace

serviceNamespaceToText :: IsString a => ServiceNamespace -> a

parseServiceNamespace :: CharParsing m => m ServiceNamespace

AWS ARN

data Arn

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

parseArn :: CharParsing m => m Arn