amazonka-s3-1.6.1: Amazon Simple Storage Service SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.S3.ListObjectVersions

Contents

Description

Returns metadata about all of the versions of objects in a bucket.

This operation returns paginated results.

Synopsis

Creating a Request

listObjectVersions Source #

Arguments

:: BucketName

lBucket

-> ListObjectVersions 

Creates a value of ListObjectVersions with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • lKeyMarker - Specifies the key to start with when listing objects in a bucket.
  • lPrefix - Limits the response to keys that begin with the specified prefix.
  • lEncodingType - Undocumented member.
  • lVersionIdMarker - Specifies the object version you want to start listing from.
  • lMaxKeys - Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.
  • lDelimiter - A delimiter is a character you use to group keys.
  • lBucket - Undocumented member.

data ListObjectVersions Source #

See: listObjectVersions smart constructor.

Instances
Eq ListObjectVersions Source # 
Instance details

Defined in Network.AWS.S3.ListObjectVersions

Methods

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

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

Data ListObjectVersions Source # 
Instance details

Defined in Network.AWS.S3.ListObjectVersions

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListObjectVersions -> c ListObjectVersions #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListObjectVersions #

toConstr :: ListObjectVersions -> Constr #

dataTypeOf :: ListObjectVersions -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListObjectVersions) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListObjectVersions) #

gmapT :: (forall b. Data b => b -> b) -> ListObjectVersions -> ListObjectVersions #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListObjectVersions -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListObjectVersions -> r #

gmapQ :: (forall d. Data d => d -> u) -> ListObjectVersions -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListObjectVersions -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListObjectVersions -> m ListObjectVersions #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListObjectVersions -> m ListObjectVersions #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListObjectVersions -> m ListObjectVersions #

Read ListObjectVersions Source # 
Instance details

Defined in Network.AWS.S3.ListObjectVersions

Methods

readsPrec :: Int -> ReadS ListObjectVersions #

readList :: ReadS [ListObjectVersions] #

readPrec :: ReadPrec ListObjectVersions #

readListPrec :: ReadPrec [ListObjectVersions] #

Show ListObjectVersions Source # 
Instance details

Defined in Network.AWS.S3.ListObjectVersions

Methods

showsPrec :: Int -> ListObjectVersions -> ShowS #

show :: ListObjectVersions -> String #

showList :: [ListObjectVersions] -> ShowS #

Generic ListObjectVersions Source # 
Instance details

Defined in Network.AWS.S3.ListObjectVersions

Associated Types

type Rep ListObjectVersions :: Type -> Type #

Methods

from :: ListObjectVersions -> Rep ListObjectVersions x #

to :: Rep ListObjectVersions x -> ListObjectVersions #

Hashable ListObjectVersions Source # 
Instance details

Defined in Network.AWS.S3.ListObjectVersions

Methods

hashWithSalt :: Int -> ListObjectVersions -> Int #

hash :: ListObjectVersions -> Int #

AWSPager ListObjectVersions Source # 
Instance details

Defined in Network.AWS.S3.ListObjectVersions

Methods

page :: ListObjectVersions -> Rs ListObjectVersions -> Maybe ListObjectVersions #

AWSRequest ListObjectVersions Source # 
Instance details

Defined in Network.AWS.S3.ListObjectVersions

Associated Types

type Rs ListObjectVersions :: Type #

Methods

request :: ListObjectVersions -> Request ListObjectVersions #

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy ListObjectVersions -> ClientResponse -> m (Response ListObjectVersions) #

ToHeaders ListObjectVersions Source # 
Instance details

Defined in Network.AWS.S3.ListObjectVersions

Methods

toHeaders :: ListObjectVersions -> [Header] #

ToPath ListObjectVersions Source # 
Instance details

Defined in Network.AWS.S3.ListObjectVersions

Methods

toPath :: ListObjectVersions -> ByteString #

ToQuery ListObjectVersions Source # 
Instance details

Defined in Network.AWS.S3.ListObjectVersions

Methods

toQuery :: ListObjectVersions -> QueryString #

NFData ListObjectVersions Source # 
Instance details

Defined in Network.AWS.S3.ListObjectVersions

Methods

rnf :: ListObjectVersions -> () #

type Rep ListObjectVersions Source # 
Instance details

Defined in Network.AWS.S3.ListObjectVersions

type Rep ListObjectVersions = D1 (MetaData "ListObjectVersions" "Network.AWS.S3.ListObjectVersions" "amazonka-s3-1.6.1-I7VsiKive605KPmKsVgrUz" False) (C1 (MetaCons "ListObjectVersions'" PrefixI True) ((S1 (MetaSel (Just "_lKeyMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_lPrefix") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lEncodingType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe EncodingType)))) :*: ((S1 (MetaSel (Just "_lVersionIdMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lMaxKeys") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 (MetaSel (Just "_lDelimiter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Delimiter)) :*: S1 (MetaSel (Just "_lBucket") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 BucketName)))))
type Rs ListObjectVersions Source # 
Instance details

Defined in Network.AWS.S3.ListObjectVersions

type Rs ListObjectVersions = ListObjectVersionsResponse

Request Lenses

lKeyMarker :: Lens' ListObjectVersions (Maybe Text) Source #

Specifies the key to start with when listing objects in a bucket.

lPrefix :: Lens' ListObjectVersions (Maybe Text) Source #

Limits the response to keys that begin with the specified prefix.

lEncodingType :: Lens' ListObjectVersions (Maybe EncodingType) Source #

Undocumented member.

lVersionIdMarker :: Lens' ListObjectVersions (Maybe Text) Source #

Specifies the object version you want to start listing from.

lMaxKeys :: Lens' ListObjectVersions (Maybe Int) Source #

Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.

lDelimiter :: Lens' ListObjectVersions (Maybe Delimiter) Source #

A delimiter is a character you use to group keys.

lBucket :: Lens' ListObjectVersions BucketName Source #

Undocumented member.

Destructuring the Response

listObjectVersionsResponse Source #

Arguments

:: Int

lrsResponseStatus

-> ListObjectVersionsResponse 

Creates a value of ListObjectVersionsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • lrsNextVersionIdMarker - Use this value for the next version id marker parameter in a subsequent request.
  • lrsKeyMarker - Marks the last Key returned in a truncated response.
  • lrsDeleteMarkers - Undocumented member.
  • lrsPrefix - Undocumented member.
  • lrsCommonPrefixes - Undocumented member.
  • lrsEncodingType - Encoding type used by Amazon S3 to encode object keys in the response.
  • lrsVersions - Undocumented member.
  • lrsName - Undocumented member.
  • lrsNextKeyMarker - Use this value for the key marker request parameter in a subsequent request.
  • lrsVersionIdMarker - Undocumented member.
  • lrsMaxKeys - Undocumented member.
  • lrsIsTruncated - A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria. If your results were truncated, you can make a follow-up paginated request using the NextKeyMarker and NextVersionIdMarker response parameters as a starting place in another request to return the rest of the results.
  • lrsDelimiter - Undocumented member.
  • lrsResponseStatus - -- | The response status code.

data ListObjectVersionsResponse Source #

See: listObjectVersionsResponse smart constructor.

Instances
Eq ListObjectVersionsResponse Source # 
Instance details

Defined in Network.AWS.S3.ListObjectVersions

Methods

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

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

Data ListObjectVersionsResponse Source # 
Instance details

Defined in Network.AWS.S3.ListObjectVersions

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListObjectVersionsResponse -> c ListObjectVersionsResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListObjectVersionsResponse #

toConstr :: ListObjectVersionsResponse -> Constr #

dataTypeOf :: ListObjectVersionsResponse -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListObjectVersionsResponse) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListObjectVersionsResponse) #

gmapT :: (forall b. Data b => b -> b) -> ListObjectVersionsResponse -> ListObjectVersionsResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListObjectVersionsResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListObjectVersionsResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> ListObjectVersionsResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListObjectVersionsResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListObjectVersionsResponse -> m ListObjectVersionsResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListObjectVersionsResponse -> m ListObjectVersionsResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListObjectVersionsResponse -> m ListObjectVersionsResponse #

Read ListObjectVersionsResponse Source # 
Instance details

Defined in Network.AWS.S3.ListObjectVersions

Methods

readsPrec :: Int -> ReadS ListObjectVersionsResponse #

readList :: ReadS [ListObjectVersionsResponse] #

readPrec :: ReadPrec ListObjectVersionsResponse #

readListPrec :: ReadPrec [ListObjectVersionsResponse] #

Show ListObjectVersionsResponse Source # 
Instance details

Defined in Network.AWS.S3.ListObjectVersions

Methods

showsPrec :: Int -> ListObjectVersionsResponse -> ShowS #

show :: ListObjectVersionsResponse -> String #

showList :: [ListObjectVersionsResponse] -> ShowS #

Generic ListObjectVersionsResponse Source # 
Instance details

Defined in Network.AWS.S3.ListObjectVersions

Associated Types

type Rep ListObjectVersionsResponse :: Type -> Type #

Methods

from :: ListObjectVersionsResponse -> Rep ListObjectVersionsResponse x #

to :: Rep ListObjectVersionsResponse x -> ListObjectVersionsResponse #

NFData ListObjectVersionsResponse Source # 
Instance details

Defined in Network.AWS.S3.ListObjectVersions

Methods

rnf :: ListObjectVersionsResponse -> () #

type Rep ListObjectVersionsResponse Source # 
Instance details

Defined in Network.AWS.S3.ListObjectVersions

type Rep ListObjectVersionsResponse = D1 (MetaData "ListObjectVersionsResponse" "Network.AWS.S3.ListObjectVersions" "amazonka-s3-1.6.1-I7VsiKive605KPmKsVgrUz" False) (C1 (MetaCons "ListObjectVersionsResponse'" PrefixI True) (((S1 (MetaSel (Just "_lrsNextVersionIdMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_lrsKeyMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lrsDeleteMarkers") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [DeleteMarkerEntry])))) :*: ((S1 (MetaSel (Just "_lrsPrefix") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lrsCommonPrefixes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [CommonPrefix]))) :*: (S1 (MetaSel (Just "_lrsEncodingType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe EncodingType)) :*: S1 (MetaSel (Just "_lrsVersions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [ObjectVersion]))))) :*: ((S1 (MetaSel (Just "_lrsName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe BucketName)) :*: (S1 (MetaSel (Just "_lrsNextKeyMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lrsVersionIdMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_lrsMaxKeys") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int)) :*: S1 (MetaSel (Just "_lrsIsTruncated") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 (MetaSel (Just "_lrsDelimiter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Delimiter)) :*: S1 (MetaSel (Just "_lrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))))

Response Lenses

lrsNextVersionIdMarker :: Lens' ListObjectVersionsResponse (Maybe Text) Source #

Use this value for the next version id marker parameter in a subsequent request.

lrsKeyMarker :: Lens' ListObjectVersionsResponse (Maybe Text) Source #

Marks the last Key returned in a truncated response.

lrsDeleteMarkers :: Lens' ListObjectVersionsResponse [DeleteMarkerEntry] Source #

Undocumented member.

lrsPrefix :: Lens' ListObjectVersionsResponse (Maybe Text) Source #

Undocumented member.

lrsCommonPrefixes :: Lens' ListObjectVersionsResponse [CommonPrefix] Source #

Undocumented member.

lrsEncodingType :: Lens' ListObjectVersionsResponse (Maybe EncodingType) Source #

Encoding type used by Amazon S3 to encode object keys in the response.

lrsVersions :: Lens' ListObjectVersionsResponse [ObjectVersion] Source #

Undocumented member.

lrsName :: Lens' ListObjectVersionsResponse (Maybe BucketName) Source #

Undocumented member.

lrsNextKeyMarker :: Lens' ListObjectVersionsResponse (Maybe Text) Source #

Use this value for the key marker request parameter in a subsequent request.

lrsVersionIdMarker :: Lens' ListObjectVersionsResponse (Maybe Text) Source #

Undocumented member.

lrsMaxKeys :: Lens' ListObjectVersionsResponse (Maybe Int) Source #

Undocumented member.

lrsIsTruncated :: Lens' ListObjectVersionsResponse (Maybe Bool) Source #

A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria. If your results were truncated, you can make a follow-up paginated request using the NextKeyMarker and NextVersionIdMarker response parameters as a starting place in another request to return the rest of the results.

lrsDelimiter :: Lens' ListObjectVersionsResponse (Maybe Delimiter) Source #

Undocumented member.

lrsResponseStatus :: Lens' ListObjectVersionsResponse Int Source #

  • - | The response status code.