amazonka-s3-2.0: Amazon Simple Storage Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseThis Mozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka.com>
Stabilityexperimental
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.S3.Internal

Description

 
Synopsis

BucketName

newtype BucketName Source #

Constructors

BucketName 

Fields

Instances

Instances details
FromJSON BucketName Source # 
Instance details

Defined in Amazonka.S3.Internal

ToByteString BucketName Source # 
Instance details

Defined in Amazonka.S3.Internal

ToLog BucketName Source # 
Instance details

Defined in Amazonka.S3.Internal

ToQuery BucketName Source # 
Instance details

Defined in Amazonka.S3.Internal

FromText BucketName Source # 
Instance details

Defined in Amazonka.S3.Internal

ToText BucketName Source # 
Instance details

Defined in Amazonka.S3.Internal

Methods

toText :: BucketName -> Text #

FromXML BucketName Source # 
Instance details

Defined in Amazonka.S3.Internal

ToXML BucketName Source # 
Instance details

Defined in Amazonka.S3.Internal

Methods

toXML :: BucketName -> XML #

IsString BucketName Source # 
Instance details

Defined in Amazonka.S3.Internal

Generic BucketName Source # 
Instance details

Defined in Amazonka.S3.Internal

Associated Types

type Rep BucketName :: Type -> Type #

Read BucketName Source # 
Instance details

Defined in Amazonka.S3.Internal

Show BucketName Source # 
Instance details

Defined in Amazonka.S3.Internal

NFData BucketName Source # 
Instance details

Defined in Amazonka.S3.Internal

Methods

rnf :: BucketName -> () #

Eq BucketName Source # 
Instance details

Defined in Amazonka.S3.Internal

Ord BucketName Source # 
Instance details

Defined in Amazonka.S3.Internal

Hashable BucketName Source # 
Instance details

Defined in Amazonka.S3.Internal

type Rep BucketName Source # 
Instance details

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)))

ETag

newtype ETag Source #

Constructors

ETag 

Fields

Instances

Instances details
ToByteString ETag Source # 
Instance details

Defined in Amazonka.S3.Internal

Methods

toBS :: ETag -> ByteString #

ToLog ETag Source # 
Instance details

Defined in Amazonka.S3.Internal

ToQuery ETag Source # 
Instance details

Defined in Amazonka.S3.Internal

Methods

toQuery :: ETag -> QueryString #

FromText ETag Source # 
Instance details

Defined in Amazonka.S3.Internal

ToText ETag Source # 
Instance details

Defined in Amazonka.S3.Internal

Methods

toText :: ETag -> Text #

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 #

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 #

Read ETag Source # 
Instance details

Defined in Amazonka.S3.Internal

Show ETag Source # 
Instance details

Defined in Amazonka.S3.Internal

Methods

showsPrec :: Int -> ETag -> ShowS #

show :: ETag -> String #

showList :: [ETag] -> ShowS #

NFData ETag Source # 
Instance details

Defined in Amazonka.S3.Internal

Methods

rnf :: ETag -> () #

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 #

Hashable ETag Source # 
Instance details

Defined in Amazonka.S3.Internal

Methods

hashWithSalt :: Int -> ETag -> Int #

hash :: ETag -> Int #

type Rep ETag Source # 
Instance details

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)))

Object Version ID

newtype ObjectVersionId Source #

Constructors

ObjectVersionId 

Instances

Instances details
ToByteString ObjectVersionId Source # 
Instance details

Defined in Amazonka.S3.Internal

ToLog ObjectVersionId Source # 
Instance details

Defined in Amazonka.S3.Internal

ToQuery ObjectVersionId Source # 
Instance details

Defined in Amazonka.S3.Internal

FromText ObjectVersionId Source # 
Instance details

Defined in Amazonka.S3.Internal

ToText ObjectVersionId Source # 
Instance details

Defined in Amazonka.S3.Internal

FromXML ObjectVersionId Source # 
Instance details

Defined in Amazonka.S3.Internal

ToXML ObjectVersionId Source # 
Instance details

Defined in Amazonka.S3.Internal

Methods

toXML :: ObjectVersionId -> XML #

IsString ObjectVersionId Source # 
Instance details

Defined in Amazonka.S3.Internal

Generic ObjectVersionId Source # 
Instance details

Defined in Amazonka.S3.Internal

Associated Types

type Rep ObjectVersionId :: Type -> Type #

Read ObjectVersionId Source # 
Instance details

Defined in Amazonka.S3.Internal

Show ObjectVersionId Source # 
Instance details

Defined in Amazonka.S3.Internal

NFData ObjectVersionId Source # 
Instance details

Defined in Amazonka.S3.Internal

Methods

rnf :: ObjectVersionId -> () #

Eq ObjectVersionId Source # 
Instance details

Defined in Amazonka.S3.Internal

Ord ObjectVersionId Source # 
Instance details

Defined in Amazonka.S3.Internal

Hashable ObjectVersionId Source # 
Instance details

Defined in Amazonka.S3.Internal

type Rep ObjectVersionId Source # 
Instance details

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)))

Bucket Location

newtype LocationConstraint Source #

Instances

Instances details
ToByteString LocationConstraint Source # 
Instance details

Defined in Amazonka.S3.Internal

ToLog LocationConstraint Source # 
Instance details

Defined in Amazonka.S3.Internal

FromText LocationConstraint Source # 
Instance details

Defined in Amazonka.S3.Internal

ToText LocationConstraint Source # 
Instance details

Defined in Amazonka.S3.Internal

FromXML LocationConstraint Source # 
Instance details

Defined in Amazonka.S3.Internal

ToXML LocationConstraint Source # 
Instance details

Defined in Amazonka.S3.Internal

Generic LocationConstraint Source # 
Instance details

Defined in Amazonka.S3.Internal

Associated Types

type Rep LocationConstraint :: Type -> Type #

Read LocationConstraint Source # 
Instance details

Defined in Amazonka.S3.Internal

Show LocationConstraint Source # 
Instance details

Defined in Amazonka.S3.Internal

NFData LocationConstraint Source # 
Instance details

Defined in Amazonka.S3.Internal

Methods

rnf :: LocationConstraint -> () #

Eq LocationConstraint Source # 
Instance details

Defined in Amazonka.S3.Internal

Ord LocationConstraint Source # 
Instance details

Defined in Amazonka.S3.Internal

Hashable LocationConstraint Source # 
Instance details

Defined in Amazonka.S3.Internal

type Rep LocationConstraint Source # 
Instance details

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)))

newtype Region #

The available AWS regions.

Constructors

Region' 

Fields

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

Instances details
FromJSON Region 
Instance details

Defined in Amazonka.Types

ToJSON Region 
Instance details

Defined in Amazonka.Types

ToByteString Region 
Instance details

Defined in Amazonka.Types

Methods

toBS :: Region -> ByteString #

ToLog Region 
Instance details

Defined in Amazonka.Types

ToQuery Region 
Instance details

Defined in Amazonka.Types

FromText Region 
Instance details

Defined in Amazonka.Types

ToText Region 
Instance details

Defined in Amazonka.Types

Methods

toText :: Region -> Text #

FromXML Region 
Instance details

Defined in Amazonka.Types

ToXML Region 
Instance details

Defined in Amazonka.Types

Methods

toXML :: Region -> XML #

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 #

Read Region 
Instance details

Defined in Amazonka.Types

Show Region 
Instance details

Defined in Amazonka.Types

NFData Region 
Instance details

Defined in Amazonka.Types

Methods

rnf :: Region -> () #

Eq Region 
Instance details

Defined in Amazonka.Types

Methods

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

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

Ord Region 
Instance details

Defined in Amazonka.Types

Hashable Region 
Instance details

Defined in Amazonka.Types

Methods

hashWithSalt :: Int -> Region -> Int #

hash :: Region -> Int #

type Rep Region 
Instance details

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

newtype ObjectKey Source #

Constructors

ObjectKey Text 

Instances

Instances details
ToByteString ObjectKey Source # 
Instance details

Defined in Amazonka.S3.Internal

Methods

toBS :: ObjectKey -> ByteString #

ToLog ObjectKey Source # 
Instance details

Defined in Amazonka.S3.Internal

ToPath ObjectKey Source # 
Instance details

Defined in Amazonka.S3.Internal

ToQuery ObjectKey Source # 
Instance details

Defined in Amazonka.S3.Internal

FromText ObjectKey Source # 
Instance details

Defined in Amazonka.S3.Internal

ToText ObjectKey Source # 
Instance details

Defined in Amazonka.S3.Internal

Methods

toText :: ObjectKey -> Text #

FromXML ObjectKey Source # 
Instance details

Defined in Amazonka.S3.Internal

ToXML ObjectKey Source # 
Instance details

Defined in Amazonka.S3.Internal

Methods

toXML :: ObjectKey -> XML #

IsString ObjectKey Source # 
Instance details

Defined in Amazonka.S3.Internal

Generic ObjectKey Source # 
Instance details

Defined in Amazonka.S3.Internal

Associated Types

type Rep ObjectKey :: Type -> Type #

Read ObjectKey Source # 
Instance details

Defined in Amazonka.S3.Internal

Show ObjectKey Source # 
Instance details

Defined in Amazonka.S3.Internal

NFData ObjectKey Source # 
Instance details

Defined in Amazonka.S3.Internal

Methods

rnf :: ObjectKey -> () #

Eq ObjectKey Source # 
Instance details

Defined in Amazonka.S3.Internal

Ord ObjectKey Source # 
Instance details

Defined in Amazonka.S3.Internal

Hashable ObjectKey Source # 
Instance details

Defined in Amazonka.S3.Internal

type Rep ObjectKey Source # 
Instance details

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_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" ^? 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 Source #

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 Source #

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

Website Endpoints

getWebsiteEndpoint :: Region -> Maybe 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.