Copyright	(c) 2013-2021 Brendan Hay
License	This Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay@gmail.com>
Stability	experimental
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.S3.Internal

Contents

Bucket Location
Object Key
Website Endpoints

Description

Synopsis

newtype Region where
- Region' {
  - fromRegion :: Text
  }
- pattern Mumbai :: Region
- pattern Sydney :: Region
- pattern Singapore :: Region
- pattern Osaka :: Region
- pattern Seoul :: Region
- pattern Tokyo :: Region
- pattern HongKong :: Region
- pattern Ningxia :: Region
- pattern Beijing :: Region
- pattern CapeTown :: Region
- pattern Bahrain :: Region
- pattern Stockholm :: Region
- pattern Paris :: Region
- pattern Milan :: Region
- pattern London :: Region
- pattern Ireland :: Region
- pattern Frankfurt :: Region
- pattern SaoPaulo :: Region
- pattern Montreal :: Region
- pattern GovCloudEast :: Region
- pattern GovCloudWest :: Region
- pattern Oregon :: Region
- pattern NorthCalifornia :: Region
- pattern Ohio :: Region
- pattern NorthVirginia :: Region
newtype BucketName = BucketName Text
newtype ETag = ETag ByteString
newtype ObjectVersionId = ObjectVersionId Text
newtype LocationConstraint = LocationConstraint {
- constraintRegion :: Region
}
_LocationConstraint :: Iso' LocationConstraint Region
type Delimiter = Char
newtype ObjectKey = ObjectKey Text
_ObjectKey :: Iso' ObjectKey Text
keyPrefix :: Delimiter -> Traversal' ObjectKey Text
keyName :: Delimiter -> Traversal' ObjectKey Text
keyComponents :: Delimiter -> IndexedTraversal' Int ObjectKey Text
getWebsiteEndpoint :: Region -> Text

Documentation

newtype Region #

The available AWS regions.

Constructors

Region'
Fields fromRegion :: Text

Bundled Patterns

pattern Mumbai :: Region
pattern Sydney :: Region
pattern Singapore :: Region
pattern Osaka :: Region
pattern Seoul :: Region
pattern Tokyo :: Region
pattern HongKong :: Region
pattern Ningxia :: Region
pattern Beijing :: Region
pattern CapeTown :: Region
pattern Bahrain :: Region
pattern Stockholm :: Region
pattern Paris :: Region
pattern Milan :: Region
pattern London :: Region
pattern Ireland :: Region
pattern Frankfurt :: Region
pattern SaoPaulo :: Region
pattern Montreal :: Region
pattern GovCloudEast :: Region
pattern GovCloudWest :: Region
pattern Oregon :: Region
pattern NorthCalifornia :: Region
pattern Ohio :: Region
pattern NorthVirginia :: Region

Instances

Instances details

Eq Region
Instance details Defined in Amazonka.Types Methods (==) :: Region -> Region -> Bool # (/=) :: Region -> Region -> Bool #
Ord Region
Instance details Defined in Amazonka.Types Methods compare :: Region -> Region -> Ordering # (<) :: Region -> Region -> Bool # (<=) :: Region -> Region -> Bool # (>) :: Region -> Region -> Bool # (>=) :: Region -> Region -> Bool # max :: Region -> Region -> Region # min :: Region -> Region -> Region #
Read Region
Instance details Defined in Amazonka.Types Methods readsPrec :: Int -> ReadS Region # readList :: ReadS [Region] # readPrec :: ReadPrec Region # readListPrec :: ReadPrec [Region] #
Show Region
Instance details Defined in Amazonka.Types Methods showsPrec :: Int -> Region -> ShowS # show :: Region -> String # showList :: [Region] -> ShowS #
IsString Region
Instance details Defined in Amazonka.Types Methods fromString :: String -> Region #
Generic Region
Instance details Defined in Amazonka.Types Associated Types type Rep Region :: Type -> Type # Methods from :: Region -> Rep Region x # to :: Rep Region x -> Region #
NFData Region
Instance details Defined in Amazonka.Types Methods rnf :: Region -> () #
Hashable Region
Instance details Defined in Amazonka.Types Methods hashWithSalt :: Int -> Region -> Int # hash :: Region -> Int #
ToJSON Region
Instance details Defined in Amazonka.Types Methods toJSON :: Region -> Value # toEncoding :: Region -> Encoding # toJSONList :: [Region] -> Value # toEncodingList :: [Region] -> Encoding #
FromJSON Region
Instance details Defined in Amazonka.Types Methods parseJSON :: Value -> Parser Region # parseJSONList :: Value -> Parser [Region] #
ToLog Region
Instance details Defined in Amazonka.Types Methods build :: Region -> ByteStringBuilder #
ToQuery Region
Instance details Defined in Amazonka.Types Methods toQuery :: Region -> QueryString #
FromXML Region
Instance details Defined in Amazonka.Types Methods parseXML :: [Node] -> Either String Region #
ToXML Region
Instance details Defined in Amazonka.Types Methods toXML :: Region -> XML #
ToByteString Region
Instance details Defined in Amazonka.Types Methods toBS :: Region -> ByteString #
FromText Region
Instance details Defined in Amazonka.Types Methods fromText :: Text -> Either String Region #
ToText Region
Instance details Defined in Amazonka.Types Methods toText :: Region -> Text #
type Rep Region
Instance details Defined in Amazonka.Types type Rep Region = D1 ('MetaData "Region" "Amazonka.Types" "libZSamazonka-coreZSamazonka-core" 'True) (C1 ('MetaCons "Region'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

newtype BucketName Source #

Constructors

BucketName Text

Instances

Instances details

Eq BucketName Source #
Instance details Defined in Amazonka.S3.Internal Methods (==) :: BucketName -> BucketName -> Bool # (/=) :: BucketName -> BucketName -> Bool #
Ord BucketName Source #
Instance details Defined in Amazonka.S3.Internal Methods compare :: BucketName -> BucketName -> Ordering # (<) :: BucketName -> BucketName -> Bool # (<=) :: BucketName -> BucketName -> Bool # (>) :: BucketName -> BucketName -> Bool # (>=) :: BucketName -> BucketName -> Bool # max :: BucketName -> BucketName -> BucketName # min :: BucketName -> BucketName -> BucketName #
Read BucketName Source #
Instance details Defined in Amazonka.S3.Internal Methods readsPrec :: Int -> ReadS BucketName # readList :: ReadS [BucketName] # readPrec :: ReadPrec BucketName # readListPrec :: ReadPrec [BucketName] #
Show BucketName Source #
Instance details Defined in Amazonka.S3.Internal Methods showsPrec :: Int -> BucketName -> ShowS # show :: BucketName -> String # showList :: [BucketName] -> ShowS #
IsString BucketName Source #
Instance details Defined in Amazonka.S3.Internal Methods fromString :: String -> BucketName #
Generic BucketName Source #
Instance details Defined in Amazonka.S3.Internal Associated Types type Rep BucketName :: Type -> Type # Methods from :: BucketName -> Rep BucketName x # to :: Rep BucketName x -> BucketName #
NFData BucketName Source #
Instance details Defined in Amazonka.S3.Internal Methods rnf :: BucketName -> () #
Hashable BucketName Source #
Instance details Defined in Amazonka.S3.Internal Methods hashWithSalt :: Int -> BucketName -> Int # hash :: BucketName -> Int #
FromJSON BucketName Source #
Instance details Defined in Amazonka.S3.Internal Methods parseJSON :: Value -> Parser BucketName # parseJSONList :: Value -> Parser [BucketName] #
ToLog BucketName Source #
Instance details Defined in Amazonka.S3.Internal Methods build :: BucketName -> ByteStringBuilder #
ToQuery BucketName Source #
Instance details Defined in Amazonka.S3.Internal Methods toQuery :: BucketName -> QueryString #
FromXML BucketName Source #
Instance details Defined in Amazonka.S3.Internal Methods parseXML :: [Node] -> Either String BucketName #
ToXML BucketName Source #
Instance details Defined in Amazonka.S3.Internal Methods toXML :: BucketName -> XML #
ToByteString BucketName Source #
Instance details Defined in Amazonka.S3.Internal Methods toBS :: BucketName -> ByteString #
FromText BucketName Source #
Instance details Defined in Amazonka.S3.Internal Methods fromText :: Text -> Either String BucketName #
ToText BucketName Source #
Instance details Defined in Amazonka.S3.Internal Methods toText :: BucketName -> Text #
type Rep BucketName Source #
Instance details Defined in Amazonka.S3.Internal type Rep BucketName = D1 ('MetaData "BucketName" "Amazonka.S3.Internal" "libZSservicesZSamazonka-s3ZSamazonka-s3" 'True) (C1 ('MetaCons "BucketName" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

newtype ETag Source #

Constructors

ETag ByteString

Instances

Instances details

Eq ETag Source #
Instance details Defined in Amazonka.S3.Internal Methods (==) :: ETag -> ETag -> Bool # (/=) :: ETag -> ETag -> Bool #
Ord ETag Source #
Instance details Defined in Amazonka.S3.Internal Methods compare :: ETag -> ETag -> Ordering # (<) :: ETag -> ETag -> Bool # (<=) :: ETag -> ETag -> Bool # (>) :: ETag -> ETag -> Bool # (>=) :: ETag -> ETag -> Bool # max :: ETag -> ETag -> ETag # min :: ETag -> ETag -> ETag #
Read ETag Source #
Instance details Defined in Amazonka.S3.Internal Methods readsPrec :: Int -> ReadS ETag # readList :: ReadS [ETag] # readPrec :: ReadPrec ETag # readListPrec :: ReadPrec [ETag] #
Show ETag Source #
Instance details Defined in Amazonka.S3.Internal Methods showsPrec :: Int -> ETag -> ShowS # show :: ETag -> String # showList :: [ETag] -> ShowS #
IsString ETag Source #
Instance details Defined in Amazonka.S3.Internal Methods fromString :: String -> ETag #
Generic ETag Source #
Instance details Defined in Amazonka.S3.Internal Associated Types type Rep ETag :: Type -> Type # Methods from :: ETag -> Rep ETag x # to :: Rep ETag x -> ETag #
NFData ETag Source #
Instance details Defined in Amazonka.S3.Internal Methods rnf :: ETag -> () #
Hashable ETag Source #
Instance details Defined in Amazonka.S3.Internal Methods hashWithSalt :: Int -> ETag -> Int # hash :: ETag -> Int #
ToLog ETag Source #
Instance details Defined in Amazonka.S3.Internal Methods build :: ETag -> ByteStringBuilder #
ToQuery ETag Source #
Instance details Defined in Amazonka.S3.Internal Methods toQuery :: ETag -> QueryString #
FromXML ETag Source #
Instance details Defined in Amazonka.S3.Internal Methods parseXML :: [Node] -> Either String ETag #
ToXML ETag Source #
Instance details Defined in Amazonka.S3.Internal Methods toXML :: ETag -> XML #
ToByteString ETag Source #
Instance details Defined in Amazonka.S3.Internal Methods toBS :: ETag -> ByteString #
FromText ETag Source #
Instance details Defined in Amazonka.S3.Internal Methods fromText :: Text -> Either String ETag #
ToText ETag Source #
Instance details Defined in Amazonka.S3.Internal Methods toText :: ETag -> Text #
type Rep ETag Source #
Instance details Defined in Amazonka.S3.Internal type Rep ETag = D1 ('MetaData "ETag" "Amazonka.S3.Internal" "libZSservicesZSamazonka-s3ZSamazonka-s3" 'True) (C1 ('MetaCons "ETag" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

newtype ObjectVersionId Source #

Constructors

ObjectVersionId Text

Instances

Instances details

Eq ObjectVersionId Source #
Instance details Defined in Amazonka.S3.Internal Methods (==) :: ObjectVersionId -> ObjectVersionId -> Bool # (/=) :: ObjectVersionId -> ObjectVersionId -> Bool #
Ord ObjectVersionId Source #
Instance details Defined in Amazonka.S3.Internal Methods compare :: ObjectVersionId -> ObjectVersionId -> Ordering # (<) :: ObjectVersionId -> ObjectVersionId -> Bool # (<=) :: ObjectVersionId -> ObjectVersionId -> Bool # (>) :: ObjectVersionId -> ObjectVersionId -> Bool # (>=) :: ObjectVersionId -> ObjectVersionId -> Bool # max :: ObjectVersionId -> ObjectVersionId -> ObjectVersionId # min :: ObjectVersionId -> ObjectVersionId -> ObjectVersionId #
Read ObjectVersionId Source #
Instance details Defined in Amazonka.S3.Internal Methods readsPrec :: Int -> ReadS ObjectVersionId # readList :: ReadS [ObjectVersionId] # readPrec :: ReadPrec ObjectVersionId # readListPrec :: ReadPrec [ObjectVersionId] #
Show ObjectVersionId Source #
Instance details Defined in Amazonka.S3.Internal Methods showsPrec :: Int -> ObjectVersionId -> ShowS # show :: ObjectVersionId -> String # showList :: [ObjectVersionId] -> ShowS #
IsString ObjectVersionId Source #
Instance details Defined in Amazonka.S3.Internal Methods fromString :: String -> ObjectVersionId #
Generic ObjectVersionId Source #
Instance details Defined in Amazonka.S3.Internal Associated Types type Rep ObjectVersionId :: Type -> Type # Methods from :: ObjectVersionId -> Rep ObjectVersionId x # to :: Rep ObjectVersionId x -> ObjectVersionId #
NFData ObjectVersionId Source #
Instance details Defined in Amazonka.S3.Internal Methods rnf :: ObjectVersionId -> () #
Hashable ObjectVersionId Source #
Instance details Defined in Amazonka.S3.Internal Methods hashWithSalt :: Int -> ObjectVersionId -> Int # hash :: ObjectVersionId -> Int #
ToLog ObjectVersionId Source #
Instance details Defined in Amazonka.S3.Internal Methods build :: ObjectVersionId -> ByteStringBuilder #
ToQuery ObjectVersionId Source #
Instance details Defined in Amazonka.S3.Internal Methods toQuery :: ObjectVersionId -> QueryString #
FromXML ObjectVersionId Source #
Instance details Defined in Amazonka.S3.Internal Methods parseXML :: [Node] -> Either String ObjectVersionId #
ToXML ObjectVersionId Source #
Instance details Defined in Amazonka.S3.Internal Methods toXML :: ObjectVersionId -> XML #
ToByteString ObjectVersionId Source #
Instance details Defined in Amazonka.S3.Internal Methods toBS :: ObjectVersionId -> ByteString #
FromText ObjectVersionId Source #
Instance details Defined in Amazonka.S3.Internal Methods fromText :: Text -> Either String ObjectVersionId #
ToText ObjectVersionId Source #
Instance details Defined in Amazonka.S3.Internal Methods toText :: ObjectVersionId -> Text #
type Rep ObjectVersionId Source #
Instance details Defined in Amazonka.S3.Internal type Rep ObjectVersionId = D1 ('MetaData "ObjectVersionId" "Amazonka.S3.Internal" "libZSservicesZSamazonka-s3ZSamazonka-s3" 'True) (C1 ('MetaCons "ObjectVersionId" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Bucket Location

newtype LocationConstraint Source #

Constructors

LocationConstraint
Fields constraintRegion :: Region

Instances

Instances details

Eq LocationConstraint Source #
Instance details Defined in Amazonka.S3.Internal Methods (==) :: LocationConstraint -> LocationConstraint -> Bool # (/=) :: LocationConstraint -> LocationConstraint -> Bool #
Ord LocationConstraint Source #
Instance details Defined in Amazonka.S3.Internal Methods compare :: LocationConstraint -> LocationConstraint -> Ordering # (<) :: LocationConstraint -> LocationConstraint -> Bool # (<=) :: LocationConstraint -> LocationConstraint -> Bool # (>) :: LocationConstraint -> LocationConstraint -> Bool # (>=) :: LocationConstraint -> LocationConstraint -> Bool # max :: LocationConstraint -> LocationConstraint -> LocationConstraint # min :: LocationConstraint -> LocationConstraint -> LocationConstraint #
Read LocationConstraint Source #
Instance details Defined in Amazonka.S3.Internal Methods readsPrec :: Int -> ReadS LocationConstraint # readList :: ReadS [LocationConstraint] # readPrec :: ReadPrec LocationConstraint # readListPrec :: ReadPrec [LocationConstraint] #
Show LocationConstraint Source #
Instance details Defined in Amazonka.S3.Internal Methods showsPrec :: Int -> LocationConstraint -> ShowS # show :: LocationConstraint -> String # showList :: [LocationConstraint] -> ShowS #
Generic LocationConstraint Source #
Instance details Defined in Amazonka.S3.Internal Associated Types type Rep LocationConstraint :: Type -> Type # Methods from :: LocationConstraint -> Rep LocationConstraint x # to :: Rep LocationConstraint x -> LocationConstraint #
NFData LocationConstraint Source #
Instance details Defined in Amazonka.S3.Internal Methods rnf :: LocationConstraint -> () #
Hashable LocationConstraint Source #
Instance details Defined in Amazonka.S3.Internal Methods hashWithSalt :: Int -> LocationConstraint -> Int # hash :: LocationConstraint -> Int #
ToLog LocationConstraint Source #
Instance details Defined in Amazonka.S3.Internal Methods build :: LocationConstraint -> ByteStringBuilder #
FromXML LocationConstraint Source #
Instance details Defined in Amazonka.S3.Internal Methods parseXML :: [Node] -> Either String LocationConstraint #
ToXML LocationConstraint Source #
Instance details Defined in Amazonka.S3.Internal Methods toXML :: LocationConstraint -> XML #
ToByteString LocationConstraint Source #
Instance details Defined in Amazonka.S3.Internal Methods toBS :: LocationConstraint -> ByteString #
FromText LocationConstraint Source #
Instance details Defined in Amazonka.S3.Internal Methods fromText :: Text -> Either String LocationConstraint #
ToText LocationConstraint Source #
Instance details Defined in Amazonka.S3.Internal Methods toText :: LocationConstraint -> Text #
type Rep LocationConstraint Source #
Instance details Defined in Amazonka.S3.Internal type Rep LocationConstraint = D1 ('MetaData "LocationConstraint" "Amazonka.S3.Internal" "libZSservicesZSamazonka-s3ZSamazonka-s3" 'True) (C1 ('MetaCons "LocationConstraint" 'PrefixI 'True) (S1 ('MetaSel ('Just "constraintRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Region)))

_LocationConstraint :: Iso' LocationConstraint Region Source #

Object Key

type Delimiter = Char Source #

newtype ObjectKey Source #

Constructors

ObjectKey Text

Instances

Instances details

Eq ObjectKey Source #
Instance details Defined in Amazonka.S3.Internal Methods (==) :: ObjectKey -> ObjectKey -> Bool # (/=) :: ObjectKey -> ObjectKey -> Bool #
Ord ObjectKey Source #
Instance details Defined in Amazonka.S3.Internal Methods compare :: ObjectKey -> ObjectKey -> Ordering # (<) :: ObjectKey -> ObjectKey -> Bool # (<=) :: ObjectKey -> ObjectKey -> Bool # (>) :: ObjectKey -> ObjectKey -> Bool # (>=) :: ObjectKey -> ObjectKey -> Bool # max :: ObjectKey -> ObjectKey -> ObjectKey # min :: ObjectKey -> ObjectKey -> ObjectKey #
Read ObjectKey Source #
Instance details Defined in Amazonka.S3.Internal Methods readsPrec :: Int -> ReadS ObjectKey # readList :: ReadS [ObjectKey] # readPrec :: ReadPrec ObjectKey # readListPrec :: ReadPrec [ObjectKey] #
Show ObjectKey Source #
Instance details Defined in Amazonka.S3.Internal Methods showsPrec :: Int -> ObjectKey -> ShowS # show :: ObjectKey -> String # showList :: [ObjectKey] -> ShowS #
IsString ObjectKey Source #
Instance details Defined in Amazonka.S3.Internal Methods fromString :: String -> ObjectKey #
Generic ObjectKey Source #
Instance details Defined in Amazonka.S3.Internal Associated Types type Rep ObjectKey :: Type -> Type # Methods from :: ObjectKey -> Rep ObjectKey x # to :: Rep ObjectKey x -> ObjectKey #
NFData ObjectKey Source #
Instance details Defined in Amazonka.S3.Internal Methods rnf :: ObjectKey -> () #
Hashable ObjectKey Source #
Instance details Defined in Amazonka.S3.Internal Methods hashWithSalt :: Int -> ObjectKey -> Int # hash :: ObjectKey -> Int #
ToLog ObjectKey Source #
Instance details Defined in Amazonka.S3.Internal Methods build :: ObjectKey -> ByteStringBuilder #
ToPath ObjectKey Source #
Instance details Defined in Amazonka.S3.Internal Methods toPath :: ObjectKey -> ByteString #
ToQuery ObjectKey Source #
Instance details Defined in Amazonka.S3.Internal Methods toQuery :: ObjectKey -> QueryString #
FromXML ObjectKey Source #
Instance details Defined in Amazonka.S3.Internal Methods parseXML :: [Node] -> Either String ObjectKey #
ToXML ObjectKey Source #
Instance details Defined in Amazonka.S3.Internal Methods toXML :: ObjectKey -> XML #
ToByteString ObjectKey Source #
Instance details Defined in Amazonka.S3.Internal Methods toBS :: ObjectKey -> ByteString #
FromText ObjectKey Source #
Instance details Defined in Amazonka.S3.Internal Methods fromText :: Text -> Either String ObjectKey #
ToText ObjectKey Source #
Instance details Defined in Amazonka.S3.Internal Methods toText :: ObjectKey -> Text #
type Rep ObjectKey Source #
Instance details Defined in Amazonka.S3.Internal type Rep ObjectKey = D1 ('MetaData "ObjectKey" "Amazonka.S3.Internal" "libZSservicesZSamazonka-s3ZSamazonka-s3" 'True) (C1 ('MetaCons "ObjectKey" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

_ObjectKey :: Iso' ObjectKey Text Source #

keyPrefix :: Delimiter -> Traversal' ObjectKey Text Source #

Traverse the prefix of an object key.

The prefix is classified as the entirety of the object key minus the name. A leading prefix in the presence of a name, and no other delimiters is interpreted as a blank prefix.

>>> "/home/jsmith/base.wiki" ^? keyPrefix '/'
Just "/home/jsmith"

>>> "/home/jsmith/" ^? keyPrefix '/'
Just "/home/jsmith"

>>> "/home" ^? keyPrefix '/'
Nothing

>>> "/" ^? keyPrefix '/'
Nothing

keyName :: Delimiter -> Traversal' ObjectKey Text Source #

Traverse the name of an object key.

keyComponents :: Delimiter -> IndexedTraversal' Int ObjectKey Text Source #

Traverse the path components of an object key using the specified delimiter.

Website Endpoints

getWebsiteEndpoint :: Region -> Text Source #

Get the S3 website endpoint for a specific region.

When you configure your bucket as a website, the website is available using this region-specific website endpoint.

See: Amazon Simple Storage Service Website Endpoints.