amazonka-s3-1.6.0: 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 #

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 # 
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 # 
ToHeaders ListObjectVersions Source # 
ToPath ListObjectVersions Source # 
ToQuery ListObjectVersions Source # 
type Rep ListObjectVersions Source # 
type Rs ListObjectVersions Source # 

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.

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.

Destructuring the Response

listObjectVersionsResponse Source #

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 # 
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.6.0-AdElsico9UIGqHgrDvALBR" False) (C1 * (MetaCons "ListObjectVersionsResponse'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_lrsNextVersionIdMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_lrsKeyMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_lrsDeleteMarkers") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [DeleteMarkerEntry]))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_lrsPrefix") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_lrsCommonPrefixes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [CommonPrefix])))) ((:*:) * (S1 * (MetaSel (Just Symbol "_lrsEncodingType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe EncodingType))) (S1 * (MetaSel (Just Symbol "_lrsVersions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [ObjectVersion])))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_lrsName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe BucketName))) ((:*:) * (S1 * (MetaSel (Just Symbol "_lrsNextKeyMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_lrsVersionIdMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_lrsMaxKeys") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) (S1 * (MetaSel (Just Symbol "_lrsIsTruncated") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_lrsDelimiter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Delimiter))) (S1 * (MetaSel (Just Symbol "_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.

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

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

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

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

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.