Network.DO.Spaces

Interacting with DigitalOcean's Spaces API, a (largely) s3-compatible object storage platform. This module exports actions to create a Spaces client configuration as well as several convenience actions. Most of the transactions exposed through the Spaces REST API are supported here, including CRUD operations on buckets and objects, bucket CORS configuration, and manipulating ACLs.

See the README in this repository for more information on using this library

Documentation

runSpaces :: Spaces -> SpacesT m a -> m a

Perform a transaction using your Spaces client configuration. Note that this does not perform any exception handling; if caught at the lower level, exceptions are generally re-thrown as SpacesExceptions

To run a SpacesT action with arguments in the opposite order, you can use runSpacesT directly

newSpaces :: (MonadThrow m, MonadIO m) => Region -> CredentialSource -> m Spaces

Create a new Spaces in a given Region while specifying a method to retrieve your credentials:

FromFile expects a configuration file in the same format as AWS credentials files, with the same field names. For example:

[default]
aws_access_key_id=AKIAIOSFODNN7EXAMPLE
aws_secret_access_key=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

FromEnv will look up the following environment variables to find your keys: AWS_ACCESS_KEY_ID , SPACES_ACCESS_KEY_ID , SPACES_ACCESS_KEY for the AccessKey, and AWS_SECRET_ACCESS_KEY , SPACES_SECRET_ACCESS_KEY , and SPACES_SECRET_KEY for your SecretKey. Alternatively, you can directly specify the environment variables to consult.

You can also choose to provide both keys yourself with Explicit

Convenience actions

The following are convenience actions. In most cases, each action is the same as applying runAction to a type that implements the Action typeclass. Information about the response is retained (SpacesMetadata) in each action. For instance:

deleteBucket myBucket

is the equivalent of

runAction KeepMetadata DeleteBucket { bucket = myBucket }

All of the underlying instances of Action are exposed and can be imported from Network.DO.Spaces.Actions and its sub-modules. The convenience actions exposed in the present module attempt to choose sane defaults where applicable.

The only major exception to the above are actions which involve uploading object data to Spaces. In the case of uploadObject, the action converts its BodyBS argument to a RequestBodyLBS. Should you choose to directly construct UploadObject, you must do this manually. multipartObject is more complicated, and takes care of chunking the request body, sending each individual request, and completing the multipart request

In addition to convenience wrappers around Action instances, this module exports several actions which may be of use, including sinking remote Object data into a file, uploading the contents of a file as an Object, and recursively listing the entire contents of a Bucket

uploadObject :: MonadSpaces m => Maybe MimeType -> Bucket -> Object -> BodyBS m -> m (SpacesResponse UploadObject)

Upload an Object within a single request

multipartObject :: MonadSpaces m => Maybe MimeType -> Bucket -> Object -> Int -> BodyBS m -> m (SpacesResponse CompleteMultipart)

Initiate and complete a multipart upload, using default UploadHeaders. If a SpacesException is thrown while performing the transaction, an attempt will be made to runSpaces a CancelMultipart request, and the exception will be rethrown

uploadFile :: forall m. MonadSpaces m => Bucket -> Object -> FilePath -> m (SpacesResponse UploadObject)

Upload a file's contents as an Object. This will attempt to set the correct MimeType based on the file extension

getObject :: MonadSpaces m => Bucket -> Object -> m (SpacesResponse GetObject)

Get an Object (retrieves the actual body of the object)

getObjectSinkFile :: MonadSpaces m => Bucket -> Object -> FilePath -> m ()

Get an Object's data and write it to the provided FilePath

getObjectInfo :: MonadSpaces m => Bucket -> Object -> m (SpacesResponse GetObjectInfo)

Get information about an Object (does not retrieve the body of the object)

copyObject

Arguments

:: MonadSpaces m

=> Bucket

Source Bucket

-> Bucket

Destination Bucket

-> Object

Source Object

-> Object

Destination Object

-> m (SpacesResponse CopyObject)

Copy an Object from one Bucket to another; this chooses a number of defaults to represent the most common cases and avoid a preponderance of parameters. Objects are copied using default ACLs with the COPY metadata directive.

If you'd like to use a specfic CannedACL or MetadataDirective, use CopyObject directly with runAction

copyObjectWithin

Arguments

:: MonadSpaces m

=> Bucket

-> Object

Source Object

-> Object

Destination Object

-> m (SpacesResponse CopyObject)

Copy an Object within the same Bucket, using defaults for the MetadataDirective and CannedACL

overwriteObject :: MonadSpaces m => Bucket -> Object -> m (SpacesResponse CopyObject)

Copy an Object to itself, overwriting its associated metadata

deleteObject :: MonadSpaces m => Bucket -> Object -> m (SpacesResponse DeleteObject)

Delete a single Object

getObjectACLs :: MonadSpaces m => Bucket -> Object -> m (SpacesResponse GetObjectACLs)

Get an Object's Access Control Lists

setObjectACLs :: MonadSpaces m => Bucket -> Object -> Owner -> [Grant] -> m (SpacesResponse SetObjectACLs)

Set an Object's Access Control Lists

Bucket operations

createBucket

Arguments

:: MonadSpaces m

=> Bucket

-> Maybe Region

Overrides the Region in your Spaces configuration

-> Maybe CannedACL

-> m (SpacesResponse CreateBucket)

Create a new Bucket

deleteBucket :: MonadSpaces m => Bucket -> m (SpacesResponse DeleteBucket)

Delete a Bucket

getBucketLocation :: MonadSpaces m => Bucket -> m (SpacesResponse GetBucketLocation)

Get the location (Region) of a Bucket

listAllBuckets :: MonadSpaces m => m (SpacesResponse ListAllBuckets)

List every Bucket associated with your Spaces account

listBucket :: MonadSpaces m => Bucket -> m (SpacesResponse ListBucket)

List the Objects of a Bucket, without grouping, delimiting, or limiting the keys (i.e. list all Objects non-hierarchically, up to the Spaces limit)

listBucketGrouped

Arguments

:: MonadSpaces m

=> Bucket

-> Char

Delimiter

-> Text

Prefix used to group object keys

-> m (SpacesResponse ListBucket)

List the Objects of a Bucket, using a delimiter and prefix to group objects. For example / can be used as a delimiter to treat objects as directories within the bucket, which can further be combined with a text prefix

listBucketRec :: MonadSpaces m => Bucket -> m (Seq ObjectInfo)

Recursively list all Objects in a Bucket, calling ListBucket until isTruncated is False. This operation may take some time, depending on the total number of objects in your bucket

getBucketCORS :: MonadSpaces m => Bucket -> m (SpacesResponse GetBucketCORS)

Get the CORSRules configured for a given Bucket

deleteBucketCORS :: MonadSpaces m => Bucket -> m (SpacesResponse DeleteBucketCORS)

Delete the existing configured CORSRules for a given Bucket

setBucketCORS :: MonadSpaces m => Bucket -> [CORSRule] -> m (SpacesResponse SetBucketCORS)

Set CORSRules for a given Bucket

getBucketACLs :: MonadSpaces m => Bucket -> m (SpacesResponse GetBucketACLs)

Get a Bucket's Access Control Lists

setBucketACLs :: MonadSpaces m => Bucket -> [Grant] -> Owner -> m (SpacesResponse SetBucketACLs)

Set a Bucket's Access Control Lists. Spaces only allows a limited subset of s3 ACLs at the moment. It may be preferable to use a CannedACL when creating new resources rather than using this action, which is provided for the sake of completeness.

Note that to allow public read-only access to your bucket, you must simultaneously set full owner control.

getBucketLifecycleRules :: MonadSpaces m => Bucket -> m (SpacesResponse GetBucketLifecycle)

Get a Bucket's LifecycleRule configuration . Note that unless you have explicitly configured lifecycle rules, this will fail with a 404 status and an error code of NoSuchLifecycleConfiguration

setBucketLifecycleRules :: MonadSpaces m => Bucket -> [LifecycleRule] -> m (SpacesResponse SetBucketLifecycle)

Set a Bucket's LifecycleRule configuration

deleteBucketLifecycleRules :: MonadSpaces m => Bucket -> m (SpacesResponse DeleteBucketLifecycle)

Delete a Bucket's LifecycleRule configuration

Re-exports

data Spaces

A client for interacting with the DO Spaces API

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.1.0-CaP5w5iMum2De5SyXd8Fq2" '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))))

data SpacesResponse a

A ConsumedResponse with optional SpacesMetadata

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.1.0-CaP5w5iMum2De5SyXd8Fq2" '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 SpacesMetadata

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

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

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

data Bucket

The name of a single storage bucket

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

type Rep Bucket

Defined in Network.DO.Spaces.Types

type Rep Bucket = D1 ('MetaData "Bucket" "Network.DO.Spaces.Types" "do-spaces-0.1.0-CaP5w5iMum2De5SyXd8Fq2" 'True) (C1 ('MetaCons "Bucket" 'PrefixI 'True) (S1 ('MetaSel ('Just "unBucket") '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 Object

The name of a "key", in AWS parlance

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

type Rep Object

Defined in Network.DO.Spaces.Types

type Rep Object = D1 ('MetaData "Object" "Network.DO.Spaces.Types" "do-spaces-0.1.0-CaP5w5iMum2De5SyXd8Fq2" 'True) (C1 ('MetaCons "Object" 'PrefixI 'True) (S1 ('MetaSel ('Just "unObject") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

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

Smart constructor for Objects; names must not be empty

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.1.0-CaP5w5iMum2De5SyXd8Fq2" '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))))

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.1.0-CaP5w5iMum2De5SyXd8Fq2" '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.1.0-CaP5w5iMum2De5SyXd8Fq2" 'True) (C1 ('MetaCons "SecretKey" 'PrefixI 'True) (S1 ('MetaSel ('Just "unSecretKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

data CredentialSource

How to discover AccessKeys and SecretKeys when creating a new Spaces client.

Constructors

FromEnv (Maybe (Text, Text))

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 AccessKey SecretKey

Provide both keys explicitly

type Profile = Text

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

data CORSRule

Cross-origin resource sharing rules

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.1.0-CaP5w5iMum2De5SyXd8Fq2" '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.1.0-CaP5w5iMum2De5SyXd8Fq2" '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 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.1.0-CaP5w5iMum2De5SyXd8Fq2" '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 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.1.0-CaP5w5iMum2De5SyXd8Fq2" 'False) (C1 ('MetaCons "ReadOnly" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "FullControl" 'PrefixI 'False) (U1 :: Type -> Type))

data LifecycleID

A unique ID for a LifecycleRule

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.1.0-CaP5w5iMum2De5SyXd8Fq2" '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

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

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.1.0-CaP5w5iMum2De5SyXd8Fq2" 'False) ((C1 ('MetaCons "InvalidRequest" '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