Amazonka.S3.Internal

BucketName

newtype BucketName

Constructors

BucketName

Fields

• fromBucketName :: Text

Instances

FromJSON BucketName

Defined in Amazonka.S3.Internal

Methods

parseJSON :: Value -> Parser BucketName

parseJSONList :: Value -> Parser [BucketName]

ToByteString BucketName

Defined in Amazonka.S3.Internal

Methods

toBS :: BucketName -> ByteString

ToLog BucketName

Defined in Amazonka.S3.Internal

Methods

build :: BucketName -> ByteStringBuilder

ToQuery BucketName

Defined in Amazonka.S3.Internal

Methods

toQuery :: BucketName -> QueryString

FromText BucketName

Defined in Amazonka.S3.Internal

Methods

fromText :: Text -> Either String BucketName

ToText BucketName

Defined in Amazonka.S3.Internal

Methods

toText :: BucketName -> Text

FromXML BucketName

Defined in Amazonka.S3.Internal

Methods

parseXML :: [Node] -> Either String BucketName

ToXML BucketName

Defined in Amazonka.S3.Internal

Methods

toXML :: BucketName -> XML

IsString BucketName

Defined in Amazonka.S3.Internal

Methods

fromString :: String -> BucketName

Generic BucketName

Defined in Amazonka.S3.Internal

Associated Types

type Rep BucketName :: Type -> Type

Methods

from :: BucketName -> Rep BucketName x

to :: Rep BucketName x -> BucketName

Read BucketName

Defined in Amazonka.S3.Internal

Methods

readsPrec :: Int -> ReadS BucketName

readList :: ReadS [BucketName]

readPrec :: ReadPrec BucketName

readListPrec :: ReadPrec [BucketName]

Show BucketName

Defined in Amazonka.S3.Internal

Methods

showsPrec :: Int -> BucketName -> ShowS

show :: BucketName -> String

showList :: [BucketName] -> ShowS

NFData BucketName

Defined in Amazonka.S3.Internal

Methods

rnf :: BucketName -> ()

Eq BucketName

Defined in Amazonka.S3.Internal

Methods

(==) :: BucketName -> BucketName -> Bool

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

Ord BucketName

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

Hashable BucketName

Defined in Amazonka.S3.Internal

Methods

hashWithSalt :: Int -> BucketName -> Int

hash :: BucketName -> Int

type Rep BucketName

Defined in Amazonka.S3.Internal

type Rep BucketName = D1 ('MetaData "BucketName" "Amazonka.S3.Internal" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'True) (C1 ('MetaCons "BucketName" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromBucketName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

_BucketName :: Iso' BucketName Text

ETag

newtype ETag

Constructors

ETag

Fields

• fromETag :: ByteString

Instances

ToByteString ETag

Defined in Amazonka.S3.Internal

Methods

toBS :: ETag -> ByteString

ToLog ETag

Defined in Amazonka.S3.Internal

Methods

build :: ETag -> ByteStringBuilder

ToQuery ETag

Defined in Amazonka.S3.Internal

Methods

toQuery :: ETag -> QueryString

FromText ETag

Defined in Amazonka.S3.Internal

Methods

fromText :: Text -> Either String ETag

ToText ETag

Defined in Amazonka.S3.Internal

Methods

toText :: ETag -> Text

FromXML ETag

Defined in Amazonka.S3.Internal

Methods

parseXML :: [Node] -> Either String ETag

ToXML ETag

Defined in Amazonka.S3.Internal

Methods

toXML :: ETag -> XML

IsString ETag

Defined in Amazonka.S3.Internal

Methods

fromString :: String -> ETag

Generic ETag

Defined in Amazonka.S3.Internal

Associated Types

type Rep ETag :: Type -> Type

Methods

from :: ETag -> Rep ETag x

to :: Rep ETag x -> ETag

Read ETag

Defined in Amazonka.S3.Internal

Methods

readsPrec :: Int -> ReadS ETag

readList :: ReadS [ETag]

readPrec :: ReadPrec ETag

readListPrec :: ReadPrec [ETag]

Show ETag

Defined in Amazonka.S3.Internal

Methods

showsPrec :: Int -> ETag -> ShowS

show :: ETag -> String

showList :: [ETag] -> ShowS

NFData ETag

Defined in Amazonka.S3.Internal

Methods

rnf :: ETag -> ()

Eq ETag

Defined in Amazonka.S3.Internal

Methods

(==) :: ETag -> ETag -> Bool

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

Ord ETag

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

Hashable ETag

Defined in Amazonka.S3.Internal

Methods

hashWithSalt :: Int -> ETag -> Int

hash :: ETag -> Int

type Rep ETag

Defined in Amazonka.S3.Internal

type Rep ETag = D1 ('MetaData "ETag" "Amazonka.S3.Internal" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'True) (C1 ('MetaCons "ETag" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromETag") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

_ETag :: Iso' ETag ByteString

Object Version ID

newtype ObjectVersionId

Constructors

ObjectVersionId

Fields

• fromObjectVersionId :: Text

Instances

ToByteString ObjectVersionId

Defined in Amazonka.S3.Internal

Methods

toBS :: ObjectVersionId -> ByteString

ToLog ObjectVersionId

Defined in Amazonka.S3.Internal

Methods

build :: ObjectVersionId -> ByteStringBuilder

ToQuery ObjectVersionId

Defined in Amazonka.S3.Internal

Methods

toQuery :: ObjectVersionId -> QueryString

FromText ObjectVersionId

Defined in Amazonka.S3.Internal

Methods

fromText :: Text -> Either String ObjectVersionId

ToText ObjectVersionId

Defined in Amazonka.S3.Internal

Methods

toText :: ObjectVersionId -> Text

FromXML ObjectVersionId

Defined in Amazonka.S3.Internal

Methods

parseXML :: [Node] -> Either String ObjectVersionId

ToXML ObjectVersionId

Defined in Amazonka.S3.Internal

Methods

toXML :: ObjectVersionId -> XML

IsString ObjectVersionId

Defined in Amazonka.S3.Internal

Methods

fromString :: String -> ObjectVersionId

Generic ObjectVersionId

Defined in Amazonka.S3.Internal

Associated Types

type Rep ObjectVersionId :: Type -> Type

Methods

from :: ObjectVersionId -> Rep ObjectVersionId x

to :: Rep ObjectVersionId x -> ObjectVersionId

Read ObjectVersionId

Defined in Amazonka.S3.Internal

Methods

readsPrec :: Int -> ReadS ObjectVersionId

readList :: ReadS [ObjectVersionId]

readPrec :: ReadPrec ObjectVersionId

readListPrec :: ReadPrec [ObjectVersionId]

Show ObjectVersionId

Defined in Amazonka.S3.Internal

Methods

showsPrec :: Int -> ObjectVersionId -> ShowS

show :: ObjectVersionId -> String

showList :: [ObjectVersionId] -> ShowS

NFData ObjectVersionId

Defined in Amazonka.S3.Internal

Methods

rnf :: ObjectVersionId -> ()

Eq ObjectVersionId

Defined in Amazonka.S3.Internal

Methods

(==) :: ObjectVersionId -> ObjectVersionId -> Bool

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

Ord ObjectVersionId

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

Hashable ObjectVersionId

Defined in Amazonka.S3.Internal

Methods

hashWithSalt :: Int -> ObjectVersionId -> Int

hash :: ObjectVersionId -> Int

type Rep ObjectVersionId

Defined in Amazonka.S3.Internal

type Rep ObjectVersionId = D1 ('MetaData "ObjectVersionId" "Amazonka.S3.Internal" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'True) (C1 ('MetaCons "ObjectVersionId" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromObjectVersionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

_ObjectVersionId :: Iso' ObjectVersionId Text

Bucket Location

newtype LocationConstraint

Constructors

LocationConstraint

Fields

• constraintRegion :: Region

Instances

ToByteString LocationConstraint

Defined in Amazonka.S3.Internal

Methods

toBS :: LocationConstraint -> ByteString

ToLog LocationConstraint

Defined in Amazonka.S3.Internal

Methods

build :: LocationConstraint -> ByteStringBuilder

FromText LocationConstraint

Defined in Amazonka.S3.Internal

Methods

fromText :: Text -> Either String LocationConstraint

ToText LocationConstraint

Defined in Amazonka.S3.Internal

Methods

toText :: LocationConstraint -> Text

FromXML LocationConstraint

Defined in Amazonka.S3.Internal

Methods

parseXML :: [Node] -> Either String LocationConstraint

ToXML LocationConstraint

Defined in Amazonka.S3.Internal

Methods

toXML :: LocationConstraint -> XML

Generic LocationConstraint

Defined in Amazonka.S3.Internal

Associated Types

type Rep LocationConstraint :: Type -> Type

Methods

from :: LocationConstraint -> Rep LocationConstraint x

to :: Rep LocationConstraint x -> LocationConstraint

Read LocationConstraint

Defined in Amazonka.S3.Internal

Methods

readsPrec :: Int -> ReadS LocationConstraint

readList :: ReadS [LocationConstraint]

readPrec :: ReadPrec LocationConstraint

readListPrec :: ReadPrec [LocationConstraint]

Show LocationConstraint

Defined in Amazonka.S3.Internal

Methods

showsPrec :: Int -> LocationConstraint -> ShowS

show :: LocationConstraint -> String

showList :: [LocationConstraint] -> ShowS

NFData LocationConstraint

Defined in Amazonka.S3.Internal

Methods

rnf :: LocationConstraint -> ()

Eq LocationConstraint

Defined in Amazonka.S3.Internal

Methods

(==) :: LocationConstraint -> LocationConstraint -> Bool

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

Ord LocationConstraint

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

Hashable LocationConstraint

Defined in Amazonka.S3.Internal

Methods

hashWithSalt :: Int -> LocationConstraint -> Int

hash :: LocationConstraint -> Int

type Rep LocationConstraint

Defined in Amazonka.S3.Internal

type Rep LocationConstraint = D1 ('MetaData "LocationConstraint" "Amazonka.S3.Internal" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'True) (C1 ('MetaCons "LocationConstraint" 'PrefixI 'True) (S1 ('MetaSel ('Just "constraintRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Region)))

_LocationConstraint :: Iso' LocationConstraint Region

newtype Region

The available AWS regions.

Constructors

Region'

Fields

• fromRegion :: Text

Bundled Patterns

pattern Ningxia :: Region

pattern Beijing :: Region

pattern GovCloudWest :: Region

pattern GovCloudEast :: Region

pattern SaoPaulo :: Region

pattern UAE :: Region

pattern Bahrain :: Region

pattern Zurich :: Region

pattern Stockholm :: Region

pattern Spain :: Region

pattern Paris :: Region

pattern Milan :: Region

pattern London :: Region

pattern Ireland :: Region

pattern Frankfurt :: Region

pattern Montreal :: Region

pattern Tokyo :: Region

pattern Sydney :: Region

pattern Singapore :: Region

pattern Seoul :: Region

pattern Osaka :: Region

pattern Mumbai :: Region

pattern Melbourne :: Region

pattern Jakarta :: Region

pattern Hyderabad :: Region

pattern HongKong :: Region

pattern CapeTown :: Region

pattern Oregon :: Region

pattern NorthCalifornia :: Region

pattern NorthVirginia :: Region

pattern Ohio :: Region

Instances

FromJSON Region

Defined in Amazonka.Types

Methods

parseJSON :: Value -> Parser Region

parseJSONList :: Value -> Parser [Region]

ToJSON Region

Defined in Amazonka.Types

Methods

toJSON :: Region -> Value

toEncoding :: Region -> Encoding

toJSONList :: [Region] -> Value

toEncodingList :: [Region] -> Encoding

ToByteString Region

Defined in Amazonka.Types

Methods

toBS :: Region -> ByteString

ToLog Region

Defined in Amazonka.Types

Methods

build :: Region -> ByteStringBuilder

ToQuery Region

Defined in Amazonka.Types

Methods

toQuery :: Region -> QueryString

FromText Region

Defined in Amazonka.Types

Methods

fromText :: Text -> Either String Region

ToText Region

Defined in Amazonka.Types

Methods

toText :: Region -> Text

FromXML Region

Defined in Amazonka.Types

Methods

parseXML :: [Node] -> Either String Region

ToXML Region

Defined in Amazonka.Types

Methods

toXML :: Region -> XML

IsString Region

Defined in Amazonka.Types

Methods

fromString :: String -> Region

Generic Region

Defined in Amazonka.Types

Associated Types

type Rep Region :: Type -> Type

Methods

from :: Region -> Rep Region x

to :: Rep Region x -> Region

Read Region

Defined in Amazonka.Types

Methods

readsPrec :: Int -> ReadS Region

readList :: ReadS [Region]

readPrec :: ReadPrec Region

readListPrec :: ReadPrec [Region]

Show Region

Defined in Amazonka.Types

Methods

showsPrec :: Int -> Region -> ShowS

show :: Region -> String

showList :: [Region] -> ShowS

NFData Region

Defined in Amazonka.Types

Methods

rnf :: Region -> ()

Eq Region

Defined in Amazonka.Types

Methods

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

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

Ord Region

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

Hashable Region

Defined in Amazonka.Types

Methods

hashWithSalt :: Int -> Region -> Int

hash :: Region -> Int

type Rep Region

Defined in Amazonka.Types

type Rep Region = D1 ('MetaData "Region" "Amazonka.Types" "amazonka-core-2.0-BFuA7FRvuklLoYhn4b6A6p" 'True) (C1 ('MetaCons "Region'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Object Key

type Delimiter = Char

newtype ObjectKey

Constructors

ObjectKey Text

Instances

ToByteString ObjectKey

Defined in Amazonka.S3.Internal

Methods

toBS :: ObjectKey -> ByteString

ToLog ObjectKey

Defined in Amazonka.S3.Internal

Methods

build :: ObjectKey -> ByteStringBuilder

ToPath ObjectKey

Defined in Amazonka.S3.Internal

Methods

toPath :: ObjectKey -> ByteString

ToQuery ObjectKey

Defined in Amazonka.S3.Internal

Methods

toQuery :: ObjectKey -> QueryString

FromText ObjectKey

Defined in Amazonka.S3.Internal

Methods

fromText :: Text -> Either String ObjectKey

ToText ObjectKey

Defined in Amazonka.S3.Internal

Methods

toText :: ObjectKey -> Text

FromXML ObjectKey

Defined in Amazonka.S3.Internal

Methods

parseXML :: [Node] -> Either String ObjectKey

ToXML ObjectKey

Defined in Amazonka.S3.Internal

Methods

toXML :: ObjectKey -> XML

IsString ObjectKey

Defined in Amazonka.S3.Internal

Methods

fromString :: String -> ObjectKey

Generic ObjectKey

Defined in Amazonka.S3.Internal

Associated Types

type Rep ObjectKey :: Type -> Type

Methods

from :: ObjectKey -> Rep ObjectKey x

to :: Rep ObjectKey x -> ObjectKey

Read ObjectKey

Defined in Amazonka.S3.Internal

Methods

readsPrec :: Int -> ReadS ObjectKey

readList :: ReadS [ObjectKey]

readPrec :: ReadPrec ObjectKey

readListPrec :: ReadPrec [ObjectKey]

Show ObjectKey

Defined in Amazonka.S3.Internal

Methods

showsPrec :: Int -> ObjectKey -> ShowS

show :: ObjectKey -> String

showList :: [ObjectKey] -> ShowS

NFData ObjectKey

Defined in Amazonka.S3.Internal

Methods

rnf :: ObjectKey -> ()

Eq ObjectKey

Defined in Amazonka.S3.Internal

Methods

(==) :: ObjectKey -> ObjectKey -> Bool

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

Ord ObjectKey

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

Hashable ObjectKey

Defined in Amazonka.S3.Internal

Methods

hashWithSalt :: Int -> ObjectKey -> Int

hash :: ObjectKey -> Int

type Rep ObjectKey

Defined in Amazonka.S3.Internal

type Rep ObjectKey = D1 ('MetaData "ObjectKey" "Amazonka.S3.Internal" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'True) (C1 ('MetaCons "ObjectKey" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

_ObjectKey :: Iso' ObjectKey Text

objectKey_keyPrefix :: Delimiter -> Traversal' ObjectKey Text

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" ^? objectKey_keyPrefix '/'
Just "/home/jsmith"

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

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

>>> "/" ^? objectKey_keyPrefix '/'
Nothing

objectKey_keyName :: Delimiter -> Traversal' ObjectKey Text

Traverse the name of an object key.

The name is classified as last path component based on the given delimiter. A trailing delimiter is interpreted as a blank name.

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

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

>>> "/home" ^? objectKey_keyName '/'
Just "home"

>>> "/" ^? objectKey_keyName '/'
Just ""

objectKey_keyComponents :: Delimiter -> IndexedTraversal' Int ObjectKey Text

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

Website Endpoints

getWebsiteEndpoint :: Region -> Maybe Text

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.