Safe Haskell | Safe-Inferred |
---|---|
Language | Haskell2010 |
Aws.S3.Core
Synopsis
- data S3Authorization
- data RequestStyle
- data S3SignPayloadMode
- data S3SignVersion
- data S3Configuration qt = S3Configuration {}
- s3EndpointUsClassic :: ByteString
- s3EndpointUsWest :: ByteString
- s3EndpointUsWest2 :: ByteString
- s3EndpointEu :: ByteString
- s3EndpointEuWest2 :: ByteString
- s3EndpointApSouthEast :: ByteString
- s3EndpointApSouthEast2 :: ByteString
- s3EndpointApNorthEast :: ByteString
- s3 :: Protocol -> ByteString -> Bool -> S3Configuration qt
- s3v4 :: Protocol -> ByteString -> Bool -> S3SignPayloadMode -> S3Configuration qt
- type ErrorCode = Text
- data S3Error = S3Error {
- s3StatusCode :: Status
- s3ErrorCode :: ErrorCode
- s3ErrorMessage :: Text
- s3ErrorResource :: Maybe Text
- s3ErrorHostId :: Maybe Text
- s3ErrorAccessKeyId :: Maybe Text
- s3ErrorStringToSign :: Maybe ByteString
- s3ErrorBucket :: Maybe Text
- s3ErrorEndpointRaw :: Maybe Text
- s3ErrorEndpoint :: Maybe ByteString
- data S3Metadata = S3Metadata {
- s3MAmzId2 :: Maybe Text
- s3MRequestId :: Maybe Text
- data S3Query = S3Query {}
- hAmzDate :: HeaderName
- hAmzContentSha256 :: HeaderName
- hAmzAlgorithm :: HeaderName
- hAmzCredential :: HeaderName
- hAmzExpires :: HeaderName
- hAmzSignedHeaders :: HeaderName
- hAmzSignature :: HeaderName
- hAmzSecurityToken :: HeaderName
- s3SignQuery :: S3Query -> S3Configuration qt -> SignatureData -> SignedQuery
- s3UriEncode :: Bool -> ByteString -> ByteString
- s3RenderQuery :: Bool -> Query -> ByteString
- s3ExtractRegion :: ByteString -> ByteString
- s3ResponseConsumer :: HTTPResponseConsumer a -> IORef S3Metadata -> HTTPResponseConsumer a
- s3BinaryResponseConsumer :: HTTPResponseConsumer a -> IORef S3Metadata -> HTTPResponseConsumer a
- s3XmlResponseConsumer :: (Cursor -> Response S3Metadata a) -> IORef S3Metadata -> HTTPResponseConsumer a
- s3ErrorResponseConsumer :: HTTPResponseConsumer a
- type CanonicalUserId = Text
- data UserInfo = UserInfo {
- userId :: CanonicalUserId
- userDisplayName :: Maybe Text
- parseUserInfo :: MonadThrow m => Cursor -> m UserInfo
- data CannedAcl
- writeCannedAcl :: CannedAcl -> Text
- data StorageClass
- parseStorageClass :: Text -> StorageClass
- writeStorageClass :: StorageClass -> Text
- data ServerSideEncryption = AES256
- parseServerSideEncryption :: MonadThrow m => Text -> m ServerSideEncryption
- writeServerSideEncryption :: ServerSideEncryption -> Text
- type Bucket = Text
- data BucketInfo = BucketInfo {}
- type Object = Text
- data ObjectId = ObjectId {}
- data ObjectVersionInfo
- = ObjectVersion {
- oviKey :: Text
- oviVersionId :: Text
- oviIsLatest :: Bool
- oviLastModified :: UTCTime
- oviETag :: Text
- oviSize :: Integer
- oviStorageClass :: StorageClass
- oviOwner :: Maybe UserInfo
- | DeleteMarker {
- oviKey :: Text
- oviVersionId :: Text
- oviIsLatest :: Bool
- oviLastModified :: UTCTime
- oviOwner :: Maybe UserInfo
- = ObjectVersion {
- parseObjectVersionInfo :: MonadThrow m => Cursor -> m ObjectVersionInfo
- data ObjectInfo = ObjectInfo {
- objectKey :: Text
- objectLastModified :: UTCTime
- objectETag :: Text
- objectSize :: Integer
- objectStorageClass :: StorageClass
- objectOwner :: Maybe UserInfo
- parseObjectInfo :: MonadThrow m => Cursor -> m ObjectInfo
- data ObjectMetadata = ObjectMetadata {
- omDeleteMarker :: Bool
- omETag :: Text
- omLastModified :: UTCTime
- omVersionId :: Maybe Text
- omUserMetadata :: [(Text, Text)]
- omMissingUserMetadata :: Maybe Text
- omServerSideEncryption :: Maybe ServerSideEncryption
- parseObjectMetadata :: MonadThrow m => ResponseHeaders -> m ObjectMetadata
- type LocationConstraint = Text
- locationUsClassic :: LocationConstraint
- locationUsWest :: LocationConstraint
- locationUsWest2 :: LocationConstraint
- locationEu :: LocationConstraint
- locationEuWest2 :: LocationConstraint
- locationEuFrankfurt :: LocationConstraint
- locationApSouthEast :: LocationConstraint
- locationApSouthEast2 :: LocationConstraint
- locationApNorthEast :: LocationConstraint
- locationSA :: LocationConstraint
- normaliseLocation :: LocationConstraint -> LocationConstraint
Documentation
data S3Authorization #
Constructors
S3AuthorizationHeader | |
S3AuthorizationQuery |
Instances
Show S3Authorization # | |
Defined in Aws.S3.Core Methods showsPrec :: Int -> S3Authorization -> ShowS # show :: S3Authorization -> String # showList :: [S3Authorization] -> ShowS # |
data RequestStyle #
Constructors
PathStyle | Requires correctly setting region endpoint, but allows non-DNS compliant bucket names in the US standard region. |
BucketStyle | Bucket name must be DNS compliant. |
VHostStyle |
Instances
Show RequestStyle # | |
Defined in Aws.S3.Core Methods showsPrec :: Int -> RequestStyle -> ShowS # show :: RequestStyle -> String # showList :: [RequestStyle] -> ShowS # |
data S3SignPayloadMode #
Constructors
AlwaysUnsigned | Always use the "UNSIGNED-PAYLOAD" option. |
SignWithEffort | Sign the payload when |
AlwaysSigned | Always sign the payload. Note: |
Instances
Read S3SignPayloadMode # | |
Defined in Aws.S3.Core Methods readsPrec :: Int -> ReadS S3SignPayloadMode readList :: ReadS [S3SignPayloadMode] readPrec :: ReadPrec S3SignPayloadMode readListPrec :: ReadPrec [S3SignPayloadMode] | |
Show S3SignPayloadMode # | |
Defined in Aws.S3.Core Methods showsPrec :: Int -> S3SignPayloadMode -> ShowS # show :: S3SignPayloadMode -> String # showList :: [S3SignPayloadMode] -> ShowS # | |
Eq S3SignPayloadMode # | |
Defined in Aws.S3.Core Methods (==) :: S3SignPayloadMode -> S3SignPayloadMode -> Bool # (/=) :: S3SignPayloadMode -> S3SignPayloadMode -> Bool # |
data S3SignVersion #
Instances
Read S3SignVersion # | |
Defined in Aws.S3.Core Methods readsPrec :: Int -> ReadS S3SignVersion readList :: ReadS [S3SignVersion] readPrec :: ReadPrec S3SignVersion readListPrec :: ReadPrec [S3SignVersion] | |
Show S3SignVersion # | |
Defined in Aws.S3.Core Methods showsPrec :: Int -> S3SignVersion -> ShowS # show :: S3SignVersion -> String # showList :: [S3SignVersion] -> ShowS # | |
Eq S3SignVersion # | |
Defined in Aws.S3.Core Methods (==) :: S3SignVersion -> S3SignVersion -> Bool # (/=) :: S3SignVersion -> S3SignVersion -> Bool # |
data S3Configuration qt #
Constructors
S3Configuration | |
Instances
DefaultServiceConfiguration (S3Configuration NormalQuery) # | |
Defined in Aws.S3.Core | |
DefaultServiceConfiguration (S3Configuration UriOnlyQuery) # | |
Defined in Aws.S3.Core | |
Show (S3Configuration qt) # | |
Defined in Aws.S3.Core Methods showsPrec :: Int -> S3Configuration qt -> ShowS # show :: S3Configuration qt -> String # showList :: [S3Configuration qt] -> ShowS # |
s3 :: Protocol -> ByteString -> Bool -> S3Configuration qt #
s3v4 :: Protocol -> ByteString -> Bool -> S3SignPayloadMode -> S3Configuration qt #
Constructors
S3Error | |
Fields
|
Instances
Exception S3Error # | |
Defined in Aws.S3.Core Methods toException :: S3Error -> SomeException # fromException :: SomeException -> Maybe S3Error # displayException :: S3Error -> String # | |
Show S3Error # | |
data S3Metadata #
Constructors
S3Metadata | |
Fields
|
Instances
Loggable S3Metadata # | |
Defined in Aws.S3.Core Methods toLogText :: S3Metadata -> Text # | |
Monoid S3Metadata # | |
Defined in Aws.S3.Core Methods mempty :: S3Metadata # mappend :: S3Metadata -> S3Metadata -> S3Metadata # mconcat :: [S3Metadata] -> S3Metadata # | |
Semigroup S3Metadata # | |
Defined in Aws.S3.Core Methods (<>) :: S3Metadata -> S3Metadata -> S3Metadata # sconcat :: NonEmpty S3Metadata -> S3Metadata # stimes :: Integral b => b -> S3Metadata -> S3Metadata # | |
Show S3Metadata # | |
Defined in Aws.S3.Core Methods showsPrec :: Int -> S3Metadata -> ShowS # show :: S3Metadata -> String # showList :: [S3Metadata] -> ShowS # |
Constructors
S3Query | |
Fields |
hAmzDate :: HeaderName #
s3SignQuery :: S3Query -> S3Configuration qt -> SignatureData -> SignedQuery #
Arguments
:: Bool | Whether encode slash characters |
-> ByteString | |
-> ByteString |
Custom UriEncode function see http://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-header-based-auth.html
Arguments
:: Bool | Whether prepend a question mark |
-> Query | |
-> ByteString |
s3ExtractRegion :: ByteString -> ByteString #
Extract a S3 region from the S3 endpoint. AWS encodes the region names in the hostnames of endpoints in a way that makes this possible, see: http://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region For other S3 implementations, may instead need to specify s3Region.
s3XmlResponseConsumer :: (Cursor -> Response S3Metadata a) -> IORef S3Metadata -> HTTPResponseConsumer a #
type CanonicalUserId = Text #
Constructors
UserInfo | |
Fields
|
parseUserInfo :: MonadThrow m => Cursor -> m UserInfo #
writeCannedAcl :: CannedAcl -> Text #
data StorageClass #
Constructors
Standard | |
StandardInfrequentAccess | |
ReducedRedundancy | |
Glacier | |
OtherStorageClass Text |
Instances
Show StorageClass # | |
Defined in Aws.S3.Core Methods showsPrec :: Int -> StorageClass -> ShowS # show :: StorageClass -> String # showList :: [StorageClass] -> ShowS # |
parseStorageClass :: Text -> StorageClass #
writeStorageClass :: StorageClass -> Text #
data ServerSideEncryption #
Constructors
AES256 |
Instances
Show ServerSideEncryption # | |
Defined in Aws.S3.Core Methods showsPrec :: Int -> ServerSideEncryption -> ShowS # show :: ServerSideEncryption -> String # showList :: [ServerSideEncryption] -> ShowS # |
parseServerSideEncryption :: MonadThrow m => Text -> m ServerSideEncryption #
writeServerSideEncryption :: ServerSideEncryption -> Text #
data BucketInfo #
Constructors
BucketInfo | |
Fields |
Instances
Show BucketInfo # | |
Defined in Aws.S3.Core Methods showsPrec :: Int -> BucketInfo -> ShowS # show :: BucketInfo -> String # showList :: [BucketInfo] -> ShowS # |
data ObjectVersionInfo #
Constructors
ObjectVersion | |
Fields
| |
DeleteMarker | |
Fields
|
Instances
Show ObjectVersionInfo # | |
Defined in Aws.S3.Core Methods showsPrec :: Int -> ObjectVersionInfo -> ShowS # show :: ObjectVersionInfo -> String # showList :: [ObjectVersionInfo] -> ShowS # | |
ListResponse GetBucketObjectVersionsResponse ObjectVersionInfo # | |
Defined in Aws.S3.Commands.GetBucketObjectVersions Methods listResponse :: GetBucketObjectVersionsResponse -> [ObjectVersionInfo] # |
parseObjectVersionInfo :: MonadThrow m => Cursor -> m ObjectVersionInfo #
data ObjectInfo #
Constructors
ObjectInfo | |
Fields
|
Instances
Show ObjectInfo # | |
Defined in Aws.S3.Core Methods showsPrec :: Int -> ObjectInfo -> ShowS # show :: ObjectInfo -> String # showList :: [ObjectInfo] -> ShowS # | |
ListResponse GetBucketResponse ObjectInfo # | |
Defined in Aws.S3.Commands.GetBucket Methods listResponse :: GetBucketResponse -> [ObjectInfo] # |
parseObjectInfo :: MonadThrow m => Cursor -> m ObjectInfo #
data ObjectMetadata #
Constructors
ObjectMetadata | |
Fields
|
Instances
Show ObjectMetadata # | |
Defined in Aws.S3.Core Methods showsPrec :: Int -> ObjectMetadata -> ShowS # show :: ObjectMetadata -> String # showList :: [ObjectMetadata] -> ShowS # |
parseObjectMetadata :: MonadThrow m => ResponseHeaders -> m ObjectMetadata #
type LocationConstraint = Text #