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.ListObjectsV2

Contents

Description

Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. Note: ListObjectsV2 is the revised List Objects API and we recommend you use this revised API for new application development.

This operation returns paginated results.

Synopsis

Creating a Request

listObjectsV2 Source #

Arguments

:: BucketName

lovBucket

-> ListObjectsV2 

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

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

  • lovStartAfter - StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket
  • lovContinuationToken - ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key
  • lovFetchOwner - The owner field is not present in listV2 by default, if you want to return owner field with each key in the result then set the fetch owner field to true
  • lovPrefix - Limits the response to keys that begin with the specified prefix.
  • lovEncodingType - Encoding type used by Amazon S3 to encode object keys in the response.
  • lovRequestPayer - Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests.
  • 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 - Name of the bucket to list.

data ListObjectsV2 Source #

See: listObjectsV2 smart constructor.

Instances
Eq ListObjectsV2 Source # 
Instance details

Defined in Network.AWS.S3.ListObjectsV2

Methods

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

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

Data ListObjectsV2 Source # 
Instance details

Defined in Network.AWS.S3.ListObjectsV2

Methods

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

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

toConstr :: ListObjectsV2 -> Constr #

dataTypeOf :: ListObjectsV2 -> DataType #

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

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

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

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

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

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

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

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

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

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

Read ListObjectsV2 Source # 
Instance details

Defined in Network.AWS.S3.ListObjectsV2

Methods

readsPrec :: Int -> ReadS ListObjectsV2 #

readList :: ReadS [ListObjectsV2] #

readPrec :: ReadPrec ListObjectsV2 #

readListPrec :: ReadPrec [ListObjectsV2] #

Show ListObjectsV2 Source # 
Instance details

Defined in Network.AWS.S3.ListObjectsV2

Methods

showsPrec :: Int -> ListObjectsV2 -> ShowS #

show :: ListObjectsV2 -> String #

showList :: [ListObjectsV2] -> ShowS #

Generic ListObjectsV2 Source # 
Instance details

Defined in Network.AWS.S3.ListObjectsV2

Associated Types

type Rep ListObjectsV2 :: Type -> Type #

Methods

from :: ListObjectsV2 -> Rep ListObjectsV2 x #

to :: Rep ListObjectsV2 x -> ListObjectsV2 #

Hashable ListObjectsV2 Source # 
Instance details

Defined in Network.AWS.S3.ListObjectsV2

Methods

hashWithSalt :: Int -> ListObjectsV2 -> Int #

hash :: ListObjectsV2 -> Int #

AWSPager ListObjectsV2 Source # 
Instance details

Defined in Network.AWS.S3.ListObjectsV2

Methods

page :: ListObjectsV2 -> Rs ListObjectsV2 -> Maybe ListObjectsV2 #

AWSRequest ListObjectsV2 Source # 
Instance details

Defined in Network.AWS.S3.ListObjectsV2

Associated Types

type Rs ListObjectsV2 :: Type #

Methods

request :: ListObjectsV2 -> Request ListObjectsV2 #

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

ToHeaders ListObjectsV2 Source # 
Instance details

Defined in Network.AWS.S3.ListObjectsV2

Methods

toHeaders :: ListObjectsV2 -> [Header] #

ToPath ListObjectsV2 Source # 
Instance details

Defined in Network.AWS.S3.ListObjectsV2

Methods

toPath :: ListObjectsV2 -> ByteString #

ToQuery ListObjectsV2 Source # 
Instance details

Defined in Network.AWS.S3.ListObjectsV2

Methods

toQuery :: ListObjectsV2 -> QueryString #

NFData ListObjectsV2 Source # 
Instance details

Defined in Network.AWS.S3.ListObjectsV2

Methods

rnf :: ListObjectsV2 -> () #

type Rep ListObjectsV2 Source # 
Instance details

Defined in Network.AWS.S3.ListObjectsV2

type Rep ListObjectsV2 = D1 (MetaData "ListObjectsV2" "Network.AWS.S3.ListObjectsV2" "amazonka-s3-1.6.1-I7VsiKive605KPmKsVgrUz" False) (C1 (MetaCons "ListObjectsV2'" PrefixI True) (((S1 (MetaSel (Just "_lovStartAfter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lovContinuationToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_lovFetchOwner") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_lovPrefix") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_lovEncodingType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe EncodingType)) :*: S1 (MetaSel (Just "_lovRequestPayer") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe RequestPayer))) :*: (S1 (MetaSel (Just "_lovMaxKeys") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 (MetaSel (Just "_lovDelimiter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Delimiter)) :*: S1 (MetaSel (Just "_lovBucket") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 BucketName))))))
type Rs ListObjectsV2 Source # 
Instance details

Defined in Network.AWS.S3.ListObjectsV2

type Rs ListObjectsV2 = ListObjectsV2Response

Request Lenses

lovStartAfter :: Lens' ListObjectsV2 (Maybe Text) Source #

StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket

lovContinuationToken :: Lens' ListObjectsV2 (Maybe Text) Source #

ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key

lovFetchOwner :: Lens' ListObjectsV2 (Maybe Bool) Source #

The owner field is not present in listV2 by default, if you want to return owner field with each key in the result then set the fetch owner field to true

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

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

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

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

lovRequestPayer :: Lens' ListObjectsV2 (Maybe RequestPayer) Source #

Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests.

lovMaxKeys :: Lens' ListObjectsV2 (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' ListObjectsV2 (Maybe Delimiter) Source #

A delimiter is a character you use to group keys.

lovBucket :: Lens' ListObjectsV2 BucketName Source #

Name of the bucket to list.

Destructuring the Response

listObjectsV2Response Source #

Arguments

:: Int

lovrsResponseStatus

-> ListObjectsV2Response 

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

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

  • lovrsStartAfter - StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket
  • lovrsKeyCount - KeyCount is the number of keys returned with this request. KeyCount will always be less than equals to MaxKeys field. Say you ask for 50 keys, your result will include less than equals 50 keys
  • lovrsContents - Metadata about each object returned.
  • lovrsContinuationToken - ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key
  • lovrsPrefix - Limits the response to keys that begin with the specified prefix.
  • lovrsCommonPrefixes - CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by delimiter
  • lovrsEncodingType - Encoding type used by Amazon S3 to encode object keys in the response.
  • lovrsName - Name of the bucket to list.
  • lovrsNextContinuationToken - NextContinuationToken is sent when isTruncated is true which means there are more keys in the bucket that can be listed. The next list requests to Amazon S3 can be continued with this NextContinuationToken. NextContinuationToken is obfuscated and is not a real key
  • lovrsMaxKeys - Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.
  • lovrsIsTruncated - A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria.
  • lovrsDelimiter - A delimiter is a character you use to group keys.
  • lovrsResponseStatus - -- | The response status code.

data ListObjectsV2Response Source #

See: listObjectsV2Response smart constructor.

Instances
Eq ListObjectsV2Response Source # 
Instance details

Defined in Network.AWS.S3.ListObjectsV2

Methods

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

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

Data ListObjectsV2Response Source # 
Instance details

Defined in Network.AWS.S3.ListObjectsV2

Methods

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

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

toConstr :: ListObjectsV2Response -> Constr #

dataTypeOf :: ListObjectsV2Response -> DataType #

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

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

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

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

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

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

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

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

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

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

Read ListObjectsV2Response Source # 
Instance details

Defined in Network.AWS.S3.ListObjectsV2

Methods

readsPrec :: Int -> ReadS ListObjectsV2Response #

readList :: ReadS [ListObjectsV2Response] #

readPrec :: ReadPrec ListObjectsV2Response #

readListPrec :: ReadPrec [ListObjectsV2Response] #

Show ListObjectsV2Response Source # 
Instance details

Defined in Network.AWS.S3.ListObjectsV2

Methods

showsPrec :: Int -> ListObjectsV2Response -> ShowS #

show :: ListObjectsV2Response -> String #

showList :: [ListObjectsV2Response] -> ShowS #

Generic ListObjectsV2Response Source # 
Instance details

Defined in Network.AWS.S3.ListObjectsV2

Associated Types

type Rep ListObjectsV2Response :: Type -> Type #

Methods

from :: ListObjectsV2Response -> Rep ListObjectsV2Response x #

to :: Rep ListObjectsV2Response x -> ListObjectsV2Response #

NFData ListObjectsV2Response Source # 
Instance details

Defined in Network.AWS.S3.ListObjectsV2

Methods

rnf :: ListObjectsV2Response -> () #

type Rep ListObjectsV2Response Source # 
Instance details

Defined in Network.AWS.S3.ListObjectsV2

type Rep ListObjectsV2Response = D1 (MetaData "ListObjectsV2Response" "Network.AWS.S3.ListObjectsV2" "amazonka-s3-1.6.1-I7VsiKive605KPmKsVgrUz" False) (C1 (MetaCons "ListObjectsV2Response'" PrefixI True) (((S1 (MetaSel (Just "_lovrsStartAfter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_lovrsKeyCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int)) :*: S1 (MetaSel (Just "_lovrsContents") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Object])))) :*: (S1 (MetaSel (Just "_lovrsContinuationToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_lovrsPrefix") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lovrsCommonPrefixes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [CommonPrefix]))))) :*: ((S1 (MetaSel (Just "_lovrsEncodingType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe EncodingType)) :*: (S1 (MetaSel (Just "_lovrsName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe BucketName)) :*: S1 (MetaSel (Just "_lovrsNextContinuationToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_lovrsMaxKeys") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int)) :*: S1 (MetaSel (Just "_lovrsIsTruncated") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 (MetaSel (Just "_lovrsDelimiter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Delimiter)) :*: S1 (MetaSel (Just "_lovrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))))

Response Lenses

lovrsStartAfter :: Lens' ListObjectsV2Response (Maybe Text) Source #

StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket

lovrsKeyCount :: Lens' ListObjectsV2Response (Maybe Int) Source #

KeyCount is the number of keys returned with this request. KeyCount will always be less than equals to MaxKeys field. Say you ask for 50 keys, your result will include less than equals 50 keys

lovrsContents :: Lens' ListObjectsV2Response [Object] Source #

Metadata about each object returned.

lovrsContinuationToken :: Lens' ListObjectsV2Response (Maybe Text) Source #

ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key

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

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

lovrsCommonPrefixes :: Lens' ListObjectsV2Response [CommonPrefix] Source #

CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by delimiter

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

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

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

Name of the bucket to list.

lovrsNextContinuationToken :: Lens' ListObjectsV2Response (Maybe Text) Source #

NextContinuationToken is sent when isTruncated is true which means there are more keys in the bucket that can be listed. The next list requests to Amazon S3 can be continued with this NextContinuationToken. NextContinuationToken is obfuscated and is not a real key

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

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

lovrsIsTruncated :: Lens' ListObjectsV2Response (Maybe Bool) Source #

A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria.

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

A delimiter is a character you use to group keys.

lovrsResponseStatus :: Lens' ListObjectsV2Response Int Source #

  • - | The response status code.