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

Copyright(c) 2013-2017 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

lovBucket

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

  • lovKeyMarker - Specifies the key to start with when listing objects in a bucket.
  • lovPrefix - Limits the response to keys that begin with the specified prefix.
  • lovEncodingType - Undocumented member.
  • lovVersionIdMarker - Specifies the object version you want to start listing from.
  • lovMaxKeys - Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.
  • lovDelimiter - A delimiter is a character you use to group keys.
  • lovBucket - Undocumented member.

data ListObjectVersions Source #

See: listObjectVersions smart constructor.

Instances

Eq ListObjectVersions Source # 
Data ListObjectVersions Source # 

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 # 
Show ListObjectVersions Source # 
Generic ListObjectVersions Source # 
Hashable ListObjectVersions Source # 
NFData ListObjectVersions Source # 

Methods

rnf :: ListObjectVersions -> () #

AWSPager ListObjectVersions Source # 
AWSRequest ListObjectVersions Source # 
ToQuery ListObjectVersions Source # 
ToPath ListObjectVersions Source # 
ToHeaders ListObjectVersions Source # 
type Rep ListObjectVersions Source # 
type Rs ListObjectVersions Source # 

Request Lenses

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

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

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

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

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

Undocumented member.

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

Specifies the object version you want to start listing from.

lovMaxKeys :: 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.

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

A delimiter is a character you use to group keys.

lovBucket :: Lens' ListObjectVersions BucketName Source #

Undocumented member.

Destructuring the Response

listObjectVersionsResponse Source #

Arguments

:: Int

lovrsResponseStatus

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

data ListObjectVersionsResponse Source #

See: listObjectVersionsResponse smart constructor.

Instances

Eq ListObjectVersionsResponse Source # 
Data ListObjectVersionsResponse Source # 

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 # 
Show ListObjectVersionsResponse Source # 
Generic ListObjectVersionsResponse Source # 
NFData ListObjectVersionsResponse Source # 
type Rep ListObjectVersionsResponse Source # 
type Rep ListObjectVersionsResponse = D1 (MetaData "ListObjectVersionsResponse" "Network.AWS.S3.ListObjectVersions" "amazonka-s3-1.5.0-4i2REsRgyXL98WvgynC9is" False) (C1 (MetaCons "ListObjectVersionsResponse'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_lovrsNextVersionIdMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_lovrsKeyMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_lovrsDeleteMarkers") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [DeleteMarkerEntry]))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_lovrsPrefix") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_lovrsCommonPrefixes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [CommonPrefix])))) ((:*:) (S1 (MetaSel (Just Symbol "_lovrsEncodingType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe EncodingType))) (S1 (MetaSel (Just Symbol "_lovrsVersions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [ObjectVersion])))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_lovrsName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe BucketName))) ((:*:) (S1 (MetaSel (Just Symbol "_lovrsNextKeyMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_lovrsVersionIdMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_lovrsMaxKeys") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))) (S1 (MetaSel (Just Symbol "_lovrsIsTruncated") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)))) ((:*:) (S1 (MetaSel (Just Symbol "_lovrsDelimiter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Delimiter))) (S1 (MetaSel (Just Symbol "_lovrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))))

Response Lenses

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

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

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

Marks the last Key returned in a truncated response.

lovrsDeleteMarkers :: Lens' ListObjectVersionsResponse [DeleteMarkerEntry] Source #

Undocumented member.

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

Undocumented member.

lovrsCommonPrefixes :: Lens' ListObjectVersionsResponse [CommonPrefix] Source #

Undocumented member.

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

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

lovrsVersions :: Lens' ListObjectVersionsResponse [ObjectVersion] Source #

Undocumented member.

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

Undocumented member.

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

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

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

Undocumented member.

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

Undocumented member.

lovrsIsTruncated :: 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.

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

Undocumented member.

lovrsResponseStatus :: Lens' ListObjectVersionsResponse Int Source #

  • - | The response status code.