Network.DO.Spaces.Types

Spaces

newtype SpacesT m a

Constructors

SpacesT (ReaderT Spaces m a)

Instances

Monad m => MonadReader Spaces (SpacesT m)

Defined in Network.DO.Spaces.Types

Methods

ask :: SpacesT m Spaces

local :: (Spaces -> Spaces) -> SpacesT m a -> SpacesT m a

reader :: (Spaces -> a) -> SpacesT m a

Monad m => Monad (SpacesT m)

Defined in Network.DO.Spaces.Types

Methods

(>>=) :: SpacesT m a -> (a -> SpacesT m b) -> SpacesT m b

(>>) :: SpacesT m a -> SpacesT m b -> SpacesT m b

return :: a -> SpacesT m a

Functor m => Functor (SpacesT m)

Defined in Network.DO.Spaces.Types

Methods

fmap :: (a -> b) -> SpacesT m a -> SpacesT m b

(<$) :: a -> SpacesT m b -> SpacesT m a

Applicative m => Applicative (SpacesT m)

Defined in Network.DO.Spaces.Types

Methods

pure :: a -> SpacesT m a

(<*>) :: SpacesT m (a -> b) -> SpacesT m a -> SpacesT m b

liftA2 :: (a -> b -> c) -> SpacesT m a -> SpacesT m b -> SpacesT m c

(*>) :: SpacesT m a -> SpacesT m b -> SpacesT m b

(<*) :: SpacesT m a -> SpacesT m b -> SpacesT m a

MonadIO m => MonadIO (SpacesT m)

Defined in Network.DO.Spaces.Types

Methods

liftIO :: IO a -> SpacesT m a

MonadUnliftIO m => MonadUnliftIO (SpacesT m)

Defined in Network.DO.Spaces.Types

Methods

withRunInIO :: ((forall a. SpacesT m a -> IO a) -> IO b) -> SpacesT m b

MonadThrow m => MonadThrow (SpacesT m)

Defined in Network.DO.Spaces.Types

Methods

throwM :: Exception e => e -> SpacesT m a

MonadCatch m => MonadCatch (SpacesT m)

Defined in Network.DO.Spaces.Types

Methods

catch :: Exception e => SpacesT m a -> (e -> SpacesT m a) -> SpacesT m a

Generic (SpacesT m a)

Defined in Network.DO.Spaces.Types

Associated Types

type Rep (SpacesT m a) :: Type -> Type

Methods

from :: SpacesT m a -> Rep (SpacesT m a) x

to :: Rep (SpacesT m a) x -> SpacesT m a

type Rep (SpacesT m a)

Defined in Network.DO.Spaces.Types

type Rep (SpacesT m a) = D1 ('MetaData "SpacesT" "Network.DO.Spaces.Types" "do-spaces-0.2-6plBREpGHjL7zr5f6tFOCc" 'True) (C1 ('MetaCons "SpacesT" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ReaderT Spaces m a))))

runSpacesT :: SpacesT m a -> Spaces -> m a

data Spaces

A client for interacting with the DO Spaces API

Constructors

Spaces

Fields

• accessKey :: AccessKey

  Your DO Spaces access key

• secretKey :: SecretKey

  Your DO Spaces secret key

• region :: Region

  The DO region

• manager :: Manager

  HTTP Manager

Instances

Generic Spaces

Defined in Network.DO.Spaces.Types

Associated Types

type Rep Spaces :: Type -> Type

Methods

from :: Spaces -> Rep Spaces x

to :: Rep Spaces x -> Spaces

HasHttpManager Spaces

Defined in Network.DO.Spaces.Types

Methods

getHttpManager :: Spaces -> Manager

Monad m => MonadReader Spaces (SpacesT m)

Defined in Network.DO.Spaces.Types

Methods

ask :: SpacesT m Spaces

local :: (Spaces -> Spaces) -> SpacesT m a -> SpacesT m a

reader :: (Spaces -> a) -> SpacesT m a

type Rep Spaces

Defined in Network.DO.Spaces.Types

type Rep Spaces = D1 ('MetaData "Spaces" "Network.DO.Spaces.Types" "do-spaces-0.2-6plBREpGHjL7zr5f6tFOCc" 'False) (C1 ('MetaCons "Spaces" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accessKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AccessKey) :*: S1 ('MetaSel ('Just "secretKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SecretKey)) :*: (S1 ('MetaSel ('Just "region") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Region) :*: S1 ('MetaSel ('Just "manager") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Manager))))

type MonadSpaces m = (MonadReader Spaces m, MonadIO m, MonadUnliftIO m, MonadCatch m)

A synonym for the constraints necessary to run SpacesT actions

class Monad m => Action m a where

Associated Types

type ConsumedResponse a :: Type

Methods

buildRequest :: a -> m SpacesRequestBuilder

consumeResponse :: RawResponse m -> m (ConsumedResponse a)

Instances

MonadSpaces m => Action m DeleteObject

Defined in Network.DO.Spaces.Actions.DeleteObject

Associated Types

type ConsumedResponse DeleteObject

Methods

buildRequest :: DeleteObject -> m SpacesRequestBuilder

consumeResponse :: RawResponse m -> m (ConsumedResponse DeleteObject)

MonadSpaces m => Action m DeleteBucketLifecycle

Defined in Network.DO.Spaces.Actions.DeleteBucketLifecycle

Associated Types

type ConsumedResponse DeleteBucketLifecycle

Methods

buildRequest :: DeleteBucketLifecycle -> m SpacesRequestBuilder

consumeResponse :: RawResponse m -> m (ConsumedResponse DeleteBucketLifecycle)

MonadSpaces m => Action m DeleteBucketCORS

Defined in Network.DO.Spaces.Actions.DeleteBucketCORS

Associated Types

type ConsumedResponse DeleteBucketCORS

Methods

buildRequest :: DeleteBucketCORS -> m SpacesRequestBuilder

consumeResponse :: RawResponse m -> m (ConsumedResponse DeleteBucketCORS)

MonadSpaces m => Action m DeleteBucket

Defined in Network.DO.Spaces.Actions.DeleteBucket

Associated Types

type ConsumedResponse DeleteBucket

Methods

buildRequest :: DeleteBucket -> m SpacesRequestBuilder

consumeResponse :: RawResponse m -> m (ConsumedResponse DeleteBucket)

MonadSpaces m => Action m UploadObject

Defined in Network.DO.Spaces.Actions.UploadObject

Associated Types

type ConsumedResponse UploadObject

Methods

buildRequest :: UploadObject -> m SpacesRequestBuilder

consumeResponse :: RawResponse m -> m (ConsumedResponse UploadObject)

MonadSpaces m => Action m ListParts

Defined in Network.DO.Spaces.Actions.UploadMultipart

Associated Types

type ConsumedResponse ListParts

Methods

buildRequest :: ListParts -> m SpacesRequestBuilder

consumeResponse :: RawResponse m -> m (ConsumedResponse ListParts)

MonadSpaces m => Action m CancelMultipart

Defined in Network.DO.Spaces.Actions.UploadMultipart

Associated Types

type ConsumedResponse CancelMultipart

Methods

buildRequest :: CancelMultipart -> m SpacesRequestBuilder

consumeResponse :: RawResponse m -> m (ConsumedResponse CancelMultipart)

MonadSpaces m => Action m CompleteMultipart

Defined in Network.DO.Spaces.Actions.UploadMultipart

Associated Types

type ConsumedResponse CompleteMultipart

Methods

buildRequest :: CompleteMultipart -> m SpacesRequestBuilder

consumeResponse :: RawResponse m -> m (ConsumedResponse CompleteMultipart)

MonadSpaces m => Action m UploadPart

Defined in Network.DO.Spaces.Actions.UploadMultipart

Associated Types

type ConsumedResponse UploadPart

Methods

buildRequest :: UploadPart -> m SpacesRequestBuilder

consumeResponse :: RawResponse m -> m (ConsumedResponse UploadPart)

MonadSpaces m => Action m BeginMultipart

Defined in Network.DO.Spaces.Actions.UploadMultipart

Associated Types

type ConsumedResponse BeginMultipart

Methods

buildRequest :: BeginMultipart -> m SpacesRequestBuilder

consumeResponse :: RawResponse m -> m (ConsumedResponse BeginMultipart)

MonadSpaces m => Action m SetObjectACLs

Defined in Network.DO.Spaces.Actions.SetObjectACLs

Associated Types

type ConsumedResponse SetObjectACLs

Methods

buildRequest :: SetObjectACLs -> m SpacesRequestBuilder

consumeResponse :: RawResponse m -> m (ConsumedResponse SetObjectACLs)

MonadSpaces m => Action m SetBucketLifecycle

Defined in Network.DO.Spaces.Actions.SetBucketLifecycle

Associated Types

type ConsumedResponse SetBucketLifecycle

Methods

buildRequest :: SetBucketLifecycle -> m SpacesRequestBuilder

consumeResponse :: RawResponse m -> m (ConsumedResponse SetBucketLifecycle)

MonadSpaces m => Action m SetBucketCORS

Defined in Network.DO.Spaces.Actions.SetBucketCORS

Associated Types

type ConsumedResponse SetBucketCORS

Methods

buildRequest :: SetBucketCORS -> m SpacesRequestBuilder

consumeResponse :: RawResponse m -> m (ConsumedResponse SetBucketCORS)

MonadSpaces m => Action m SetBucketACLs

Defined in Network.DO.Spaces.Actions.SetBucketACLs

Associated Types

type ConsumedResponse SetBucketACLs

Methods

buildRequest :: SetBucketACLs -> m SpacesRequestBuilder

consumeResponse :: RawResponse m -> m (ConsumedResponse SetBucketACLs)

MonadSpaces m => Action m ListBucket

Defined in Network.DO.Spaces.Actions.ListBucket

Associated Types

type ConsumedResponse ListBucket

Methods

buildRequest :: ListBucket -> m SpacesRequestBuilder

consumeResponse :: RawResponse m -> m (ConsumedResponse ListBucket)

MonadSpaces m => Action m ListAllBuckets

Defined in Network.DO.Spaces.Actions.ListAllBuckets

Associated Types

type ConsumedResponse ListAllBuckets

Methods

buildRequest :: ListAllBuckets -> m SpacesRequestBuilder

consumeResponse :: RawResponse m -> m (ConsumedResponse ListAllBuckets)

MonadSpaces m => Action m GetObjectInfo

Defined in Network.DO.Spaces.Actions.GetObjectInfo

Associated Types

type ConsumedResponse GetObjectInfo

Methods

buildRequest :: GetObjectInfo -> m SpacesRequestBuilder

consumeResponse :: RawResponse m -> m (ConsumedResponse GetObjectInfo)

MonadSpaces m => Action m GetObjectACLs

Defined in Network.DO.Spaces.Actions.GetObjectACLs

Associated Types

type ConsumedResponse GetObjectACLs

Methods

buildRequest :: GetObjectACLs -> m SpacesRequestBuilder

consumeResponse :: RawResponse m -> m (ConsumedResponse GetObjectACLs)

MonadSpaces m => Action m GetObject

Defined in Network.DO.Spaces.Actions.GetObject

Associated Types

type ConsumedResponse GetObject

Methods

buildRequest :: GetObject -> m SpacesRequestBuilder

consumeResponse :: RawResponse m -> m (ConsumedResponse GetObject)

MonadSpaces m => Action m GetBucketLocation

Defined in Network.DO.Spaces.Actions.GetBucketLocation

Associated Types

type ConsumedResponse GetBucketLocation

Methods

buildRequest :: GetBucketLocation -> m SpacesRequestBuilder

consumeResponse :: RawResponse m -> m (ConsumedResponse GetBucketLocation)

MonadSpaces m => Action m GetBucketLifecycle

Defined in Network.DO.Spaces.Actions.GetBucketLifecycle

Associated Types

type ConsumedResponse GetBucketLifecycle

Methods

buildRequest :: GetBucketLifecycle -> m SpacesRequestBuilder

consumeResponse :: RawResponse m -> m (ConsumedResponse GetBucketLifecycle)

MonadSpaces m => Action m GetBucketCORS

Defined in Network.DO.Spaces.Actions.GetBucketCORS

Associated Types

type ConsumedResponse GetBucketCORS

Methods

buildRequest :: GetBucketCORS -> m SpacesRequestBuilder

consumeResponse :: RawResponse m -> m (ConsumedResponse GetBucketCORS)

MonadSpaces m => Action m GetBucketACLs

Defined in Network.DO.Spaces.Actions.GetBucketACLs

Associated Types

type ConsumedResponse GetBucketACLs

Methods

buildRequest :: GetBucketACLs -> m SpacesRequestBuilder

consumeResponse :: RawResponse m -> m (ConsumedResponse GetBucketACLs)

MonadSpaces m => Action m CreateBucket

Defined in Network.DO.Spaces.Actions.CreateBucket

Associated Types

type ConsumedResponse CreateBucket

Methods

buildRequest :: CreateBucket -> m SpacesRequestBuilder

consumeResponse :: RawResponse m -> m (ConsumedResponse CreateBucket)

MonadSpaces m => Action m CopyObject

Defined in Network.DO.Spaces.Actions.CopyObject

Associated Types

type ConsumedResponse CopyObject

Methods

buildRequest :: CopyObject -> m SpacesRequestBuilder

consumeResponse :: RawResponse m -> m (ConsumedResponse CopyObject)

data CredentialSource

How to discover the Region, AccessKey, and SecretKey when creating a new Spaces client.

Constructors

Discover

Try a sequence of different sources until one succeeds

FromEnv (Maybe (Text, Text, Text))

Region, AccessKey and SecretKey env vars

FromFile FilePath (Maybe Profile)

Load your credentials from a file, optionally providing the profile to use (or default as the... default).

Explicit Region AccessKey SecretKey

Provide all values explicitly

type Profile = Text

The name of a per-project configuration profile to select when loading credentials from a file

newtype AccessKey

Spaces access key

Constructors

AccessKey

Fields

• unAccessKey :: ByteString

Instances

Eq AccessKey

Defined in Network.DO.Spaces.Types

Methods

(==) :: AccessKey -> AccessKey -> Bool

(/=) :: AccessKey -> AccessKey -> Bool

Show AccessKey

Defined in Network.DO.Spaces.Types

Methods

showsPrec :: Int -> AccessKey -> ShowS

show :: AccessKey -> String

showList :: [AccessKey] -> ShowS

Generic AccessKey

Defined in Network.DO.Spaces.Types

Associated Types

type Rep AccessKey :: Type -> Type

Methods

from :: AccessKey -> Rep AccessKey x

to :: Rep AccessKey x -> AccessKey

type Rep AccessKey

Defined in Network.DO.Spaces.Types

type Rep AccessKey = D1 ('MetaData "AccessKey" "Network.DO.Spaces.Types" "do-spaces-0.2-6plBREpGHjL7zr5f6tFOCc" 'True) (C1 ('MetaCons "AccessKey" 'PrefixI 'True) (S1 ('MetaSel ('Just "unAccessKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

newtype SecretKey

Spaces secret key

Constructors

SecretKey

Fields

• unSecretKey :: ByteString

Instances

Eq SecretKey

Defined in Network.DO.Spaces.Types

Methods

(==) :: SecretKey -> SecretKey -> Bool

(/=) :: SecretKey -> SecretKey -> Bool

Show SecretKey

Defined in Network.DO.Spaces.Types

Methods

showsPrec :: Int -> SecretKey -> ShowS

show :: SecretKey -> String

showList :: [SecretKey] -> ShowS

Generic SecretKey

Defined in Network.DO.Spaces.Types

Associated Types

type Rep SecretKey :: Type -> Type

Methods

from :: SecretKey -> Rep SecretKey x

to :: Rep SecretKey x -> SecretKey

type Rep SecretKey

Defined in Network.DO.Spaces.Types

type Rep SecretKey = D1 ('MetaData "SecretKey" "Network.DO.Spaces.Types" "do-spaces-0.2-6plBREpGHjL7zr5f6tFOCc" 'True) (C1 ('MetaCons "SecretKey" 'PrefixI 'True) (S1 ('MetaSel ('Just "unSecretKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

Buckets and Objects

newtype Object

The name of a "key", in AWS parlance

Constructors

Object Text

Instances

Eq Object

Defined in Network.DO.Spaces.Types

Methods

(==) :: Object -> Object -> Bool

(/=) :: Object -> Object -> Bool

Show Object

Defined in Network.DO.Spaces.Types

Methods

showsPrec :: Int -> Object -> ShowS

show :: Object -> String

showList :: [Object] -> ShowS

Generic Object

Defined in Network.DO.Spaces.Types

Associated Types

type Rep Object :: Type -> Type

Methods

from :: Object -> Rep Object x

to :: Rep Object x -> Object

ToHttpApiData Object

Defined in Network.DO.Spaces.Types

Methods

toUrlPiece :: Object -> Text

toEncodedUrlPiece :: Object -> Builder

toHeader :: Object -> ByteString

toQueryParam :: Object -> Text

type Rep Object

Defined in Network.DO.Spaces.Types

type Rep Object = D1 ('MetaData "Object" "Network.DO.Spaces.Types" "do-spaces-0.2-6plBREpGHjL7zr5f6tFOCc" 'True) (C1 ('MetaCons "Object" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

mkObject :: MonadThrow m => Text -> m Object

Smart constructor for Objects; names must not be empty

newtype Bucket

The name of a single storage bucket

Constructors

Bucket Text

Instances

Eq Bucket

Defined in Network.DO.Spaces.Types

Methods

(==) :: Bucket -> Bucket -> Bool

(/=) :: Bucket -> Bucket -> Bool

Show Bucket

Defined in Network.DO.Spaces.Types

Methods

showsPrec :: Int -> Bucket -> ShowS

show :: Bucket -> String

showList :: [Bucket] -> ShowS

Generic Bucket

Defined in Network.DO.Spaces.Types

Associated Types

type Rep Bucket :: Type -> Type

Methods

from :: Bucket -> Rep Bucket x

to :: Rep Bucket x -> Bucket

ToHttpApiData Bucket

Defined in Network.DO.Spaces.Types

Methods

toUrlPiece :: Bucket -> Text

toEncodedUrlPiece :: Bucket -> Builder

toHeader :: Bucket -> ByteString

toQueryParam :: Bucket -> Text

type Rep Bucket

Defined in Network.DO.Spaces.Types

type Rep Bucket = D1 ('MetaData "Bucket" "Network.DO.Spaces.Types" "do-spaces-0.2-6plBREpGHjL7zr5f6tFOCc" 'True) (C1 ('MetaCons "Bucket" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

mkBucket :: MonadThrow m => Text -> m Bucket

Smart constructor for Buckets; names must conform to the following rules:

• They must be between 3 and 63 characters in length
• They may only contain lowercase letters, digits, dots, and hyphens
• They must begin and end in a number or letter See more at: https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html.

This function ensures that names are valid and will also convert the Text to lowercase

data BucketInfo

Information about a single Bucket

Constructors

BucketInfo

Fields

• name :: Bucket
• creationDate :: UTCTime

Instances

Eq BucketInfo

Defined in Network.DO.Spaces.Types

Methods

(==) :: BucketInfo -> BucketInfo -> Bool

(/=) :: BucketInfo -> BucketInfo -> Bool

Show BucketInfo

Defined in Network.DO.Spaces.Types

Methods

showsPrec :: Int -> BucketInfo -> ShowS

show :: BucketInfo -> String

showList :: [BucketInfo] -> ShowS

Generic BucketInfo

Defined in Network.DO.Spaces.Types

Associated Types

type Rep BucketInfo :: Type -> Type

Methods

from :: BucketInfo -> Rep BucketInfo x

to :: Rep BucketInfo x -> BucketInfo

type Rep BucketInfo

Defined in Network.DO.Spaces.Types

type Rep BucketInfo = D1 ('MetaData "BucketInfo" "Network.DO.Spaces.Types" "do-spaces-0.2-6plBREpGHjL7zr5f6tFOCc" 'False) (C1 ('MetaCons "BucketInfo" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bucket) :*: S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UTCTime)))

newtype OwnerID

The ID of an Owner; also serves as a display name in Spaces

Constructors

OwnerID Int

Instances

Eq OwnerID

Defined in Network.DO.Spaces.Types

Methods

(==) :: OwnerID -> OwnerID -> Bool

(/=) :: OwnerID -> OwnerID -> Bool

Num OwnerID

Defined in Network.DO.Spaces.Types

Methods

(+) :: OwnerID -> OwnerID -> OwnerID

(-) :: OwnerID -> OwnerID -> OwnerID

(*) :: OwnerID -> OwnerID -> OwnerID

negate :: OwnerID -> OwnerID

abs :: OwnerID -> OwnerID

signum :: OwnerID -> OwnerID

fromInteger :: Integer -> OwnerID

Show OwnerID

Defined in Network.DO.Spaces.Types

Methods

showsPrec :: Int -> OwnerID -> ShowS

show :: OwnerID -> String

showList :: [OwnerID] -> ShowS

Generic OwnerID

Defined in Network.DO.Spaces.Types

Associated Types

type Rep OwnerID :: Type -> Type

Methods

from :: OwnerID -> Rep OwnerID x

to :: Rep OwnerID x -> OwnerID

ToHttpApiData OwnerID

Defined in Network.DO.Spaces.Types

Methods

toUrlPiece :: OwnerID -> Text

toEncodedUrlPiece :: OwnerID -> Builder

toHeader :: OwnerID -> ByteString

toQueryParam :: OwnerID -> Text

type Rep OwnerID

Defined in Network.DO.Spaces.Types

type Rep OwnerID = D1 ('MetaData "OwnerID" "Network.DO.Spaces.Types" "do-spaces-0.2-6plBREpGHjL7zr5f6tFOCc" 'True) (C1 ('MetaCons "OwnerID" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))

type DisplayName = OwnerID

The display name is always equivalent to the owner's ID; Spaces includes it for AWS compatibility

data Owner

The resource owner

Constructors

Owner

Fields

• ownerID :: OwnerID
• displayName :: DisplayName

Instances

Eq Owner

Defined in Network.DO.Spaces.Types

Methods

(==) :: Owner -> Owner -> Bool

(/=) :: Owner -> Owner -> Bool

Show Owner

Defined in Network.DO.Spaces.Types

Methods

showsPrec :: Int -> Owner -> ShowS

show :: Owner -> String

showList :: [Owner] -> ShowS

Generic Owner

Defined in Network.DO.Spaces.Types

Associated Types

type Rep Owner :: Type -> Type

Methods

from :: Owner -> Rep Owner x

to :: Rep Owner x -> Owner

type Rep Owner

Defined in Network.DO.Spaces.Types

type Rep Owner = D1 ('MetaData "Owner" "Network.DO.Spaces.Types" "do-spaces-0.2-6plBREpGHjL7zr5f6tFOCc" 'False) (C1 ('MetaCons "Owner" 'PrefixI 'True) (S1 ('MetaSel ('Just "ownerID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 OwnerID) :*: S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DisplayName)))

data ObjectInfo

Information about a single Object, returned when listing a Bucket's contents

Constructors

ObjectInfo

Fields

• object :: Object
• lastModified :: UTCTime
• etag :: ETag
• size :: Int

  Size in bytes

• owner :: Owner

Instances

Eq ObjectInfo

Defined in Network.DO.Spaces.Types

Methods

(==) :: ObjectInfo -> ObjectInfo -> Bool

(/=) :: ObjectInfo -> ObjectInfo -> Bool

Show ObjectInfo

Defined in Network.DO.Spaces.Types

Methods

showsPrec :: Int -> ObjectInfo -> ShowS

show :: ObjectInfo -> String

showList :: [ObjectInfo] -> ShowS

Generic ObjectInfo

Defined in Network.DO.Spaces.Types

Associated Types

type Rep ObjectInfo :: Type -> Type

Methods

from :: ObjectInfo -> Rep ObjectInfo x

to :: Rep ObjectInfo x -> ObjectInfo

type Rep ObjectInfo

Defined in Network.DO.Spaces.Types

type Rep ObjectInfo = D1 ('MetaData "ObjectInfo" "Network.DO.Spaces.Types" "do-spaces-0.2-6plBREpGHjL7zr5f6tFOCc" 'False) (C1 ('MetaCons "ObjectInfo" 'PrefixI 'True) ((S1 ('MetaSel ('Just "object") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Object) :*: S1 ('MetaSel ('Just "lastModified") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UTCTime)) :*: (S1 ('MetaSel ('Just "etag") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ETag) :*: (S1 ('MetaSel ('Just "size") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "owner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Owner)))))

data ObjectMetadata

Metadata returned when querying information about an Object

Constructors

ObjectMetadata

Fields

• contentLength :: Int

  length in bytes

• contentType :: MimeType
• etag :: ETag
• lastModified :: UTCTime

Instances

Eq ObjectMetadata

Defined in Network.DO.Spaces.Types

Methods

(==) :: ObjectMetadata -> ObjectMetadata -> Bool

(/=) :: ObjectMetadata -> ObjectMetadata -> Bool

Show ObjectMetadata

Defined in Network.DO.Spaces.Types

Methods

showsPrec :: Int -> ObjectMetadata -> ShowS

show :: ObjectMetadata -> String

showList :: [ObjectMetadata] -> ShowS

Generic ObjectMetadata

Defined in Network.DO.Spaces.Types

Associated Types

type Rep ObjectMetadata :: Type -> Type

Methods

from :: ObjectMetadata -> Rep ObjectMetadata x

to :: Rep ObjectMetadata x -> ObjectMetadata

type Rep ObjectMetadata

Defined in Network.DO.Spaces.Types

type Rep ObjectMetadata = D1 ('MetaData "ObjectMetadata" "Network.DO.Spaces.Types" "do-spaces-0.2-6plBREpGHjL7zr5f6tFOCc" 'False) (C1 ('MetaCons "ObjectMetadata" 'PrefixI 'True) ((S1 ('MetaSel ('Just "contentLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "contentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MimeType)) :*: (S1 ('MetaSel ('Just "etag") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ETag) :*: S1 ('MetaSel ('Just "lastModified") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UTCTime))))

type ETag = Text

MD5 hash of an Object

Requests and responses

data SpacesRequest

Constructors

SpacesRequest

Fields

• request :: Request

  The actual HTTP Request

• spaces :: Spaces

  Your Spaces configuration

• headers :: [Header]

  Obligatory Headers that will be added to the request

• method :: Method

  The HTTP Method

• payloadHash :: Hashed

  The SHA256 hash of the RequestBody contents

• canonicalRequest :: Canonicalized Request

  The canonicalized HTTP Request

• time :: UTCTime

Instances

Generic SpacesRequest

Defined in Network.DO.Spaces.Types

Associated Types

type Rep SpacesRequest :: Type -> Type

Methods

from :: SpacesRequest -> Rep SpacesRequest x

to :: Rep SpacesRequest x -> SpacesRequest

type Rep SpacesRequest

Defined in Network.DO.Spaces.Types

type Rep SpacesRequest = D1 ('MetaData "SpacesRequest" "Network.DO.Spaces.Types" "do-spaces-0.2-6plBREpGHjL7zr5f6tFOCc" 'False) (C1 ('MetaCons "SpacesRequest" 'PrefixI 'True) ((S1 ('MetaSel ('Just "request") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Request) :*: (S1 ('MetaSel ('Just "spaces") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Spaces) :*: S1 ('MetaSel ('Just "headers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Header]))) :*: ((S1 ('MetaSel ('Just "method") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Method) :*: S1 ('MetaSel ('Just "payloadHash") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Hashed)) :*: (S1 ('MetaSel ('Just "canonicalRequest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Canonicalized Request)) :*: S1 ('MetaSel ('Just "time") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UTCTime)))))

data SpacesResponse a

A ConsumedResponse with optional SpacesMetadata

Constructors

SpacesResponse

Fields

• result :: ConsumedResponse a

  A Response consumed by an Action instance

• metadata :: Maybe SpacesMetadata

  SpacesMetadata, the retention of which can be controlled using WithMetadata

Instances

(HasField' name (SpacesResponse a) s, s ~ t, a ~ b) => HasField name (SpacesResponse a) (SpacesResponse b) s t

Defined in Network.DO.Spaces.Types

Methods

field :: Lens (SpacesResponse a) (SpacesResponse b) s t

Show (ConsumedResponse a) => Show (SpacesResponse a)

Defined in Network.DO.Spaces.Types

Methods

showsPrec :: Int -> SpacesResponse a -> ShowS

show :: SpacesResponse a -> String

showList :: [SpacesResponse a] -> ShowS

Generic (SpacesResponse a)

Defined in Network.DO.Spaces.Types

Associated Types

type Rep (SpacesResponse a) :: Type -> Type

Methods

from :: SpacesResponse a -> Rep (SpacesResponse a) x

to :: Rep (SpacesResponse a) x -> SpacesResponse a

type Rep (SpacesResponse a)

Defined in Network.DO.Spaces.Types

type Rep (SpacesResponse a) = D1 ('MetaData "SpacesResponse" "Network.DO.Spaces.Types" "do-spaces-0.2-6plBREpGHjL7zr5f6tFOCc" 'False) (C1 ('MetaCons "SpacesResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "result") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (ConsumedResponse a)) :*: S1 ('MetaSel ('Just "metadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SpacesMetadata))))

data SpacesRequestBuilder

Constructors

SpacesRequestBuilder

Fields

• spaces :: Spaces
• body :: Maybe RequestBody
• method :: Maybe Method
• headers :: [Header]
• bucket :: Maybe Bucket
• object :: Maybe Object
• queryString :: Maybe Query
• subresources :: Maybe Query
• overrideRegion :: Maybe Region

  Certain operations, currently only CreateBucket, should be able to override the region configured in the Spaces client

Instances

Generic SpacesRequestBuilder

Defined in Network.DO.Spaces.Types

Associated Types

type Rep SpacesRequestBuilder :: Type -> Type

Methods

from :: SpacesRequestBuilder -> Rep SpacesRequestBuilder x

to :: Rep SpacesRequestBuilder x -> SpacesRequestBuilder

type Rep SpacesRequestBuilder

Defined in Network.DO.Spaces.Types

type Rep SpacesRequestBuilder = D1 ('MetaData "SpacesRequestBuilder" "Network.DO.Spaces.Types" "do-spaces-0.2-6plBREpGHjL7zr5f6tFOCc" 'False) (C1 ('MetaCons "SpacesRequestBuilder" 'PrefixI 'True) (((S1 ('MetaSel ('Just "spaces") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Spaces) :*: S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RequestBody))) :*: (S1 ('MetaSel ('Just "method") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Method)) :*: S1 ('MetaSel ('Just "headers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Header]))) :*: ((S1 ('MetaSel ('Just "bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bucket)) :*: S1 ('MetaSel ('Just "object") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Object))) :*: (S1 ('MetaSel ('Just "queryString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Query)) :*: (S1 ('MetaSel ('Just "subresources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Query)) :*: S1 ('MetaSel ('Just "overrideRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Region)))))))

data SpacesMetadata

Metadata and other response information returned from each Spaces API transaction; it can be helpful to retain this at times

Constructors

SpacesMetadata

Fields

• requestID :: Maybe RequestID

  Unique ID assigned to your request. This is not included in all responses

• date :: Maybe UTCTime
• status :: Status

  HTTP status

Instances

Eq SpacesMetadata

Defined in Network.DO.Spaces.Types

Methods

(==) :: SpacesMetadata -> SpacesMetadata -> Bool

(/=) :: SpacesMetadata -> SpacesMetadata -> Bool

Show SpacesMetadata

Defined in Network.DO.Spaces.Types

Methods

showsPrec :: Int -> SpacesMetadata -> ShowS

show :: SpacesMetadata -> String

showList :: [SpacesMetadata] -> ShowS

Generic SpacesMetadata

Defined in Network.DO.Spaces.Types

Associated Types

type Rep SpacesMetadata :: Type -> Type

Methods

from :: SpacesMetadata -> Rep SpacesMetadata x

to :: Rep SpacesMetadata x -> SpacesMetadata

type Rep SpacesMetadata

Defined in Network.DO.Spaces.Types

type Rep SpacesMetadata = D1 ('MetaData "SpacesMetadata" "Network.DO.Spaces.Types" "do-spaces-0.2-6plBREpGHjL7zr5f6tFOCc" 'False) (C1 ('MetaCons "SpacesMetadata" 'PrefixI 'True) (S1 ('MetaSel ('Just "requestID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RequestID)) :*: (S1 ('MetaSel ('Just "date") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UTCTime)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Status))))

data WithMetadata

Whether or not to retain SpacesMetadata when consuming responses

Constructors

KeepMetadata

NoMetadata

Instances

Eq WithMetadata

Defined in Network.DO.Spaces.Types

Methods

(==) :: WithMetadata -> WithMetadata -> Bool

(/=) :: WithMetadata -> WithMetadata -> Bool

Show WithMetadata

Defined in Network.DO.Spaces.Types

Methods

showsPrec :: Int -> WithMetadata -> ShowS

show :: WithMetadata -> String

showList :: [WithMetadata] -> ShowS

Generic WithMetadata

Defined in Network.DO.Spaces.Types

Associated Types

type Rep WithMetadata :: Type -> Type

Methods

from :: WithMetadata -> Rep WithMetadata x

to :: Rep WithMetadata x -> WithMetadata

type Rep WithMetadata

Defined in Network.DO.Spaces.Types

type Rep WithMetadata = D1 ('MetaData "WithMetadata" "Network.DO.Spaces.Types" "do-spaces-0.2-6plBREpGHjL7zr5f6tFOCc" 'False) (C1 ('MetaCons "KeepMetadata" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NoMetadata" 'PrefixI 'False) (U1 :: Type -> Type))

data RawResponse m

Constructors

RawResponse

Fields

• headers :: [Header]
• body :: BodyBS m

Instances

Generic (RawResponse m)

Defined in Network.DO.Spaces.Types

Associated Types

type Rep (RawResponse m) :: Type -> Type

Methods

from :: RawResponse m -> Rep (RawResponse m) x

to :: Rep (RawResponse m) x -> RawResponse m

type Rep (RawResponse m)

Defined in Network.DO.Spaces.Types

type Rep (RawResponse m) = D1 ('MetaData "RawResponse" "Network.DO.Spaces.Types" "do-spaces-0.2-6plBREpGHjL7zr5f6tFOCc" 'False) (C1 ('MetaCons "RawResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "headers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Header]) :*: S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (BodyBS m))))

type BodyBS m = ConduitT () ByteString m ()

A request or response body

data Method

HTTP request methods, to avoid using http-client's stringly-typed Method synonym

Constructors

GET

POST

PUT

DELETE

HEAD

Instances

Eq Method

Defined in Network.DO.Spaces.Types

Methods

(==) :: Method -> Method -> Bool

(/=) :: Method -> Method -> Bool

Ord Method

Defined in Network.DO.Spaces.Types

Methods

compare :: Method -> Method -> Ordering

(<) :: Method -> Method -> Bool

(<=) :: Method -> Method -> Bool

(>) :: Method -> Method -> Bool

(>=) :: Method -> Method -> Bool

max :: Method -> Method -> Method

min :: Method -> Method -> Method

Read Method

Defined in Network.DO.Spaces.Types

Methods

readsPrec :: Int -> ReadS Method

readList :: ReadS [Method]

readPrec :: ReadPrec Method

readListPrec :: ReadPrec [Method]

Show Method

Defined in Network.DO.Spaces.Types

Methods

showsPrec :: Int -> Method -> ShowS

show :: Method -> String

showList :: [Method] -> ShowS

Generic Method

Defined in Network.DO.Spaces.Types

Associated Types

type Rep Method :: Type -> Type

Methods

from :: Method -> Rep Method x

to :: Rep Method x -> Method

type Rep Method

Defined in Network.DO.Spaces.Types

type Rep Method = D1 ('MetaData "Method" "Network.DO.Spaces.Types" "do-spaces-0.2-6plBREpGHjL7zr5f6tFOCc" 'False) ((C1 ('MetaCons "GET" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "POST" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "PUT" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "DELETE" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "HEAD" 'PrefixI 'False) (U1 :: Type -> Type))))

data Region

DO regions where Spaces is available (only a subset of all regions)

Constructors

NewYork

NYC3

Amsterdam

AMS3

SanFrancisco

SFO3

Singapore

SGP1

Frankfurt

FRA1

Instances

Eq Region

Defined in Network.DO.Spaces.Types

Methods

(==) :: Region -> Region -> Bool

(/=) :: Region -> Region -> Bool

Show Region

Defined in Network.DO.Spaces.Types

Methods

showsPrec :: Int -> Region -> ShowS

show :: Region -> String

showList :: [Region] -> ShowS

Generic Region

Defined in Network.DO.Spaces.Types

Associated Types

type Rep Region :: Type -> Type

Methods

from :: Region -> Rep Region x

to :: Rep Region x -> Region

type Rep Region

Defined in Network.DO.Spaces.Types

type Rep Region = D1 ('MetaData "Region" "Network.DO.Spaces.Types" "do-spaces-0.2-6plBREpGHjL7zr5f6tFOCc" 'False) ((C1 ('MetaCons "NewYork" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Amsterdam" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "SanFrancisco" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Singapore" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Frankfurt" 'PrefixI 'False) (U1 :: Type -> Type))))

type RequestID = Text

A unique ID that is assigned to each request

type CacheControl = Text

Cache-Control request header value

type ContentDisposition = Text

Content-Disposition request header value

type ContentEncoding = Text

Content-Encoding request header value

type UserMetadata = [(Text, Text)]

Arbitrary key-value pairs supplied by the user, for use in PUT or POST requests. Each pair expands into x-amz-meta-*, e.g. x-amz-meta-s3cmd-attrs: uid:1000/gname:asb...

data UploadHeaders

Optional headers when uploading objects

Constructors

UploadHeaders

Fields

• acl :: Maybe CannedACL
• cacheControl :: Maybe CacheControl
• contentDisposition :: Maybe ContentDisposition
• contentEncoding :: Maybe ContentEncoding
• metadata :: UserMetadata

Instances

Eq UploadHeaders

Defined in Network.DO.Spaces.Types

Methods

(==) :: UploadHeaders -> UploadHeaders -> Bool

(/=) :: UploadHeaders -> UploadHeaders -> Bool

Show UploadHeaders

Defined in Network.DO.Spaces.Types

Methods

showsPrec :: Int -> UploadHeaders -> ShowS

show :: UploadHeaders -> String

showList :: [UploadHeaders] -> ShowS

Generic UploadHeaders

Defined in Network.DO.Spaces.Types

Associated Types

type Rep UploadHeaders :: Type -> Type

Methods

from :: UploadHeaders -> Rep UploadHeaders x

to :: Rep UploadHeaders x -> UploadHeaders

type Rep UploadHeaders

Defined in Network.DO.Spaces.Types

type Rep UploadHeaders = D1 ('MetaData "UploadHeaders" "Network.DO.Spaces.Types" "do-spaces-0.2-6plBREpGHjL7zr5f6tFOCc" 'False) (C1 ('MetaCons "UploadHeaders" 'PrefixI 'True) ((S1 ('MetaSel ('Just "acl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CannedACL)) :*: S1 ('MetaSel ('Just "cacheControl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CacheControl))) :*: (S1 ('MetaSel ('Just "contentDisposition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContentDisposition)) :*: (S1 ('MetaSel ('Just "contentEncoding") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContentEncoding)) :*: S1 ('MetaSel ('Just "metadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UserMetadata)))))

data CannedACL

"Canned" access controls; Spaces doesn't support the full range offered by s3

Constructors

Private

No unauthenticated public access

PublicRead

Unauthenticated public read access permitted

Instances

Eq CannedACL

Defined in Network.DO.Spaces.Types

Methods

(==) :: CannedACL -> CannedACL -> Bool

(/=) :: CannedACL -> CannedACL -> Bool

Show CannedACL

Defined in Network.DO.Spaces.Types

Methods

showsPrec :: Int -> CannedACL -> ShowS

show :: CannedACL -> String

showList :: [CannedACL] -> ShowS

data CORSRule

Cross-origin resource sharing rules

Constructors

CORSRule

Fields

• allowedOrigin :: Text
• allowedMethods :: [Method]
• allowedHeaders :: [HeaderName]

Instances

Eq CORSRule

Defined in Network.DO.Spaces.Types

Methods

(==) :: CORSRule -> CORSRule -> Bool

(/=) :: CORSRule -> CORSRule -> Bool

Show CORSRule

Defined in Network.DO.Spaces.Types

Methods

showsPrec :: Int -> CORSRule -> ShowS

show :: CORSRule -> String

showList :: [CORSRule] -> ShowS

Generic CORSRule

Defined in Network.DO.Spaces.Types

Associated Types

type Rep CORSRule :: Type -> Type

Methods

from :: CORSRule -> Rep CORSRule x

to :: Rep CORSRule x -> CORSRule

type Rep CORSRule

Defined in Network.DO.Spaces.Types

type Rep CORSRule = D1 ('MetaData "CORSRule" "Network.DO.Spaces.Types" "do-spaces-0.2-6plBREpGHjL7zr5f6tFOCc" 'False) (C1 ('MetaCons "CORSRule" 'PrefixI 'True) (S1 ('MetaSel ('Just "allowedOrigin") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "allowedMethods") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Method]) :*: S1 ('MetaSel ('Just "allowedHeaders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [HeaderName]))))

mkCORSRule :: MonadThrow m => Text -> [Method] -> [HeaderName] -> m CORSRule

Smart constructor for CORSRule. Ensures that both origins and header names contain a maximum of one wildcard and removes duplicates from both headers and methods

data Grant

An individual access grant

Constructors

Grant

Fields

• permission :: Permission
• grantee :: Grantee

Instances

Eq Grant

Defined in Network.DO.Spaces.Types

Methods

(==) :: Grant -> Grant -> Bool

(/=) :: Grant -> Grant -> Bool

Show Grant

Defined in Network.DO.Spaces.Types

Methods

showsPrec :: Int -> Grant -> ShowS

show :: Grant -> String

showList :: [Grant] -> ShowS

Generic Grant

Defined in Network.DO.Spaces.Types

Associated Types

type Rep Grant :: Type -> Type

Methods

from :: Grant -> Rep Grant x

to :: Rep Grant x -> Grant

type Rep Grant

Defined in Network.DO.Spaces.Types

type Rep Grant = D1 ('MetaData "Grant" "Network.DO.Spaces.Types" "do-spaces-0.2-6plBREpGHjL7zr5f6tFOCc" 'False) (C1 ('MetaCons "Grant" 'PrefixI 'True) (S1 ('MetaSel ('Just "permission") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Permission) :*: S1 ('MetaSel ('Just "grantee") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Grantee)))

data Permission

Access grant level; Spaces currently only supports these two levels

Constructors

ReadOnly

FullControl

Instances

Eq Permission

Defined in Network.DO.Spaces.Types

Methods

(==) :: Permission -> Permission -> Bool

(/=) :: Permission -> Permission -> Bool

Ord Permission

Defined in Network.DO.Spaces.Types

Methods

compare :: Permission -> Permission -> Ordering

(<) :: Permission -> Permission -> Bool

(<=) :: Permission -> Permission -> Bool

(>) :: Permission -> Permission -> Bool

(>=) :: Permission -> Permission -> Bool

max :: Permission -> Permission -> Permission

min :: Permission -> Permission -> Permission

Show Permission

Defined in Network.DO.Spaces.Types

Methods

showsPrec :: Int -> Permission -> ShowS

show :: Permission -> String

showList :: [Permission] -> ShowS

Generic Permission

Defined in Network.DO.Spaces.Types

Associated Types

type Rep Permission :: Type -> Type

Methods

from :: Permission -> Rep Permission x

to :: Rep Permission x -> Permission

type Rep Permission

Defined in Network.DO.Spaces.Types

type Rep Permission = D1 ('MetaData "Permission" "Network.DO.Spaces.Types" "do-spaces-0.2-6plBREpGHjL7zr5f6tFOCc" 'False) (C1 ('MetaCons "ReadOnly" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "FullControl" 'PrefixI 'False) (U1 :: Type -> Type))

data Grantee

Information about who an access grant applies to

Constructors

Group

Nominally contains a URI value, but Spaces only supports a single value for group access grants

CanonicalUser Owner

Instances

Eq Grantee

Defined in Network.DO.Spaces.Types

Methods

(==) :: Grantee -> Grantee -> Bool

(/=) :: Grantee -> Grantee -> Bool

Show Grantee

Defined in Network.DO.Spaces.Types

Methods

showsPrec :: Int -> Grantee -> ShowS

show :: Grantee -> String

showList :: [Grantee] -> ShowS

Generic Grantee

Defined in Network.DO.Spaces.Types

Associated Types

type Rep Grantee :: Type -> Type

Methods

from :: Grantee -> Rep Grantee x

to :: Rep Grantee x -> Grantee

type Rep Grantee

Defined in Network.DO.Spaces.Types

type Rep Grantee = D1 ('MetaData "Grantee" "Network.DO.Spaces.Types" "do-spaces-0.2-6plBREpGHjL7zr5f6tFOCc" 'False) (C1 ('MetaCons "Group" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "CanonicalUser" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Owner)))

data ACLResponse

A generic type for describing ACL configuration, can be applied to both Bucket and Object ACLs

Constructors

ACLResponse

Fields

• owner :: Owner
• accessControlList :: [Grant]

Instances

Eq ACLResponse

Defined in Network.DO.Spaces.Types

Methods

(==) :: ACLResponse -> ACLResponse -> Bool

(/=) :: ACLResponse -> ACLResponse -> Bool

Show ACLResponse

Defined in Network.DO.Spaces.Types

Methods

showsPrec :: Int -> ACLResponse -> ShowS

show :: ACLResponse -> String

showList :: [ACLResponse] -> ShowS

Generic ACLResponse

Defined in Network.DO.Spaces.Types

Associated Types

type Rep ACLResponse :: Type -> Type

Methods

from :: ACLResponse -> Rep ACLResponse x

to :: Rep ACLResponse x -> ACLResponse

type Rep ACLResponse

Defined in Network.DO.Spaces.Types

type Rep ACLResponse = D1 ('MetaData "ACLResponse" "Network.DO.Spaces.Types" "do-spaces-0.2-6plBREpGHjL7zr5f6tFOCc" 'False) (C1 ('MetaCons "ACLResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "owner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Owner) :*: S1 ('MetaSel ('Just "accessControlList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Grant])))

data LifecycleRule

Lifecycle configuration for a Bucket

Constructors

LifecycleRule

Fields

• lifecycleID :: LifecycleID
• enabled :: Bool

  The status of the LifecycleRule

• prefix :: Maybe Text

  When specified, only Objects which share the prefix will be affected by the lifecycle rules

• expiration :: Maybe LifecycleExpiration
• abortIncomplete :: Maybe Days

  When specified, configures the deletion of incomplete multipart uploads

Instances

Eq LifecycleRule

Defined in Network.DO.Spaces.Types

Methods

(==) :: LifecycleRule -> LifecycleRule -> Bool

(/=) :: LifecycleRule -> LifecycleRule -> Bool

Show LifecycleRule

Defined in Network.DO.Spaces.Types

Methods

showsPrec :: Int -> LifecycleRule -> ShowS

show :: LifecycleRule -> String

showList :: [LifecycleRule] -> ShowS

Generic LifecycleRule

Defined in Network.DO.Spaces.Types

Associated Types

type Rep LifecycleRule :: Type -> Type

Methods

from :: LifecycleRule -> Rep LifecycleRule x

to :: Rep LifecycleRule x -> LifecycleRule

type Rep LifecycleRule

Defined in Network.DO.Spaces.Types

type Rep LifecycleRule = D1 ('MetaData "LifecycleRule" "Network.DO.Spaces.Types" "do-spaces-0.2-6plBREpGHjL7zr5f6tFOCc" 'False) (C1 ('MetaCons "LifecycleRule" 'PrefixI 'True) ((S1 ('MetaSel ('Just "lifecycleID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LifecycleID) :*: S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "prefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "expiration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LifecycleExpiration)) :*: S1 ('MetaSel ('Just "abortIncomplete") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Days))))))

data LifecycleExpiration

Configuration for automatically deleting expire Objects

Constructors

AfterDays Days

OnDate UTCTime

Instances

Eq LifecycleExpiration

Defined in Network.DO.Spaces.Types

Methods

(==) :: LifecycleExpiration -> LifecycleExpiration -> Bool

(/=) :: LifecycleExpiration -> LifecycleExpiration -> Bool

Show LifecycleExpiration

Defined in Network.DO.Spaces.Types

Methods

showsPrec :: Int -> LifecycleExpiration -> ShowS

show :: LifecycleExpiration -> String

showList :: [LifecycleExpiration] -> ShowS

Generic LifecycleExpiration

Defined in Network.DO.Spaces.Types

Associated Types

type Rep LifecycleExpiration :: Type -> Type

Methods

from :: LifecycleExpiration -> Rep LifecycleExpiration x

to :: Rep LifecycleExpiration x -> LifecycleExpiration

type Rep LifecycleExpiration

Defined in Network.DO.Spaces.Types

type Rep LifecycleExpiration = D1 ('MetaData "LifecycleExpiration" "Network.DO.Spaces.Types" "do-spaces-0.2-6plBREpGHjL7zr5f6tFOCc" 'False) (C1 ('MetaCons "AfterDays" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Days)) :+: C1 ('MetaCons "OnDate" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UTCTime)))

newtype LifecycleID

A unique ID for a LifecycleRule

Constructors

LifecycleID Text

Instances

Eq LifecycleID

Defined in Network.DO.Spaces.Types

Methods

(==) :: LifecycleID -> LifecycleID -> Bool

(/=) :: LifecycleID -> LifecycleID -> Bool

Show LifecycleID

Defined in Network.DO.Spaces.Types

Methods

showsPrec :: Int -> LifecycleID -> ShowS

show :: LifecycleID -> String

showList :: [LifecycleID] -> ShowS

Generic LifecycleID

Defined in Network.DO.Spaces.Types

Associated Types

type Rep LifecycleID :: Type -> Type

Methods

from :: LifecycleID -> Rep LifecycleID x

to :: Rep LifecycleID x -> LifecycleID

type Rep LifecycleID

Defined in Network.DO.Spaces.Types

type Rep LifecycleID = D1 ('MetaData "LifecycleID" "Network.DO.Spaces.Types" "do-spaces-0.2-6plBREpGHjL7zr5f6tFOCc" 'True) (C1 ('MetaCons "LifecycleID" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

mkLifecycleID :: MonadThrow m => Text -> m LifecycleID

Smart constructor for LifecycleID, which may contain a maximum of 255 characters, including spaces

Signature calculation

newtype Canonicalized a

Represents some resource that has been canonicalized according to the Spaces/AWS v4 spec

Constructors

Canonicalized ByteString

Instances

Eq (Canonicalized a)

Defined in Network.DO.Spaces.Types

Methods

(==) :: Canonicalized a -> Canonicalized a -> Bool

(/=) :: Canonicalized a -> Canonicalized a -> Bool

Show (Canonicalized a)

Defined in Network.DO.Spaces.Types

Methods

showsPrec :: Int -> Canonicalized a -> ShowS

show :: Canonicalized a -> String

showList :: [Canonicalized a] -> ShowS

Generic (Canonicalized a)

Defined in Network.DO.Spaces.Types

Associated Types

type Rep (Canonicalized a) :: Type -> Type

Methods

from :: Canonicalized a -> Rep (Canonicalized a) x

to :: Rep (Canonicalized a) x -> Canonicalized a

type Rep (Canonicalized a)

Defined in Network.DO.Spaces.Types

type Rep (Canonicalized a) = D1 ('MetaData "Canonicalized" "Network.DO.Spaces.Types" "do-spaces-0.2-6plBREpGHjL7zr5f6tFOCc" 'True) (C1 ('MetaCons "Canonicalized" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

data Computed (a :: ComputedTag) where

A strict ByteString that has been computed according to some part of the AWS v4 spec. The AWS v4 signature is calculated from a series of interdependent computations. It would be possible to represent these all as ByteStrings; this approach, however, would make it easy to confuse two sequences that are not semantically equivalent, leading to the generation of malformed singatures. The promiscuous use of ByteStrings also makes for unclear type signatures. Using a GADT with type synonyms is simpler than creating a newtype for each type of computation

Constructors

Hashed :: ByteString -> Computed Hash

StringToSign :: ByteString -> Computed StrToSign

Represents a "string to sign" that has been computed according to the Spaces/AWS v4 spec

Signature :: ByteString -> Computed Sig

Signed hash of a Request body, a SecretKey, and request information

Credentials :: ByteString -> Computed Cred

Authorization :: ByteString -> Computed Auth

Authorization string containing information about your AccessKey and your request

Instances

Eq (Computed a)

Defined in Network.DO.Spaces.Types

Methods

(==) :: Computed a -> Computed a -> Bool

(/=) :: Computed a -> Computed a -> Bool

Show (Computed a)

Defined in Network.DO.Spaces.Types

Methods

showsPrec :: Int -> Computed a -> ShowS

show :: Computed a -> String

showList :: [Computed a] -> ShowS

type StringToSign = Computed 'StrToSign

type Hashed = Computed 'Hash

type Signature = Computed 'Sig

type Credentials = Computed 'Cred

type Authorization = Computed 'Auth

uncompute :: Computed a -> ByteString

Extract the ByteString from something Computed

Exceptions

data SpacesException

The base Exception type for both ClientExceptions and APIExceptions

Instances

Show SpacesException

Defined in Network.DO.Spaces.Types

Methods

showsPrec :: Int -> SpacesException -> ShowS

show :: SpacesException -> String

showList :: [SpacesException] -> ShowS

Exception SpacesException

Defined in Network.DO.Spaces.Types

Methods

toException :: SpacesException -> SomeException

fromException :: SomeException -> Maybe SpacesException

displayException :: SpacesException -> String

data ClientException

An exception generated within the Spaces client

Constructors

InvalidRequest Text

InvalidResponse Text

InvalidXML Text

ConfigurationError Text

HTTPStatus Status ByteString

This includes the raw Response body, read into a lazy ByteString

OtherError Text

Instances

Eq ClientException

Defined in Network.DO.Spaces.Types

Methods

(==) :: ClientException -> ClientException -> Bool

(/=) :: ClientException -> ClientException -> Bool

Show ClientException

Defined in Network.DO.Spaces.Types

Methods

showsPrec :: Int -> ClientException -> ShowS

show :: ClientException -> String

showList :: [ClientException] -> ShowS

Generic ClientException

Defined in Network.DO.Spaces.Types

Associated Types

type Rep ClientException :: Type -> Type

Methods

from :: ClientException -> Rep ClientException x

to :: Rep ClientException x -> ClientException

Exception ClientException

Defined in Network.DO.Spaces.Types

Methods

toException :: ClientException -> SomeException

fromException :: SomeException -> Maybe ClientException

displayException :: ClientException -> String

type Rep ClientException

Defined in Network.DO.Spaces.Types

type Rep ClientException = D1 ('MetaData "ClientException" "Network.DO.Spaces.Types" "do-spaces-0.2-6plBREpGHjL7zr5f6tFOCc" 'False) ((C1 ('MetaCons "InvalidRequest" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :+: (C1 ('MetaCons "InvalidResponse" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :+: C1 ('MetaCons "InvalidXML" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) :+: (C1 ('MetaCons "ConfigurationError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :+: (C1 ('MetaCons "HTTPStatus" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Status) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ByteString)) :+: C1 ('MetaCons "OtherError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

data APIException

An s3-compatible API error response, sent as XML

Constructors

APIException

Fields

• status :: Status

  HTTP Status

• code :: Text

  The s3 error code type

• requestID :: RequestID

  The unique ID of the request

• hostID :: Text

Instances

Eq APIException

Defined in Network.DO.Spaces.Types

Methods

(==) :: APIException -> APIException -> Bool

(/=) :: APIException -> APIException -> Bool

Show APIException

Defined in Network.DO.Spaces.Types

Methods

showsPrec :: Int -> APIException -> ShowS

show :: APIException -> String

showList :: [APIException] -> ShowS

Generic APIException

Defined in Network.DO.Spaces.Types

Associated Types

type Rep APIException :: Type -> Type

Methods

from :: APIException -> Rep APIException x

to :: Rep APIException x -> APIException

Exception APIException

Defined in Network.DO.Spaces.Types

Methods

toException :: APIException -> SomeException

fromException :: SomeException -> Maybe APIException

displayException :: APIException -> String

type Rep APIException

Defined in Network.DO.Spaces.Types

type Rep APIException = D1 ('MetaData "APIException" "Network.DO.Spaces.Types" "do-spaces-0.2-6plBREpGHjL7zr5f6tFOCc" 'False) (C1 ('MetaCons "APIException" 'PrefixI 'True) ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Status) :*: S1 ('MetaSel ('Just "code") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "requestID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RequestID) :*: S1 ('MetaSel ('Just "hostID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

type Days = Word16