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

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.

Synopsis

Creating a Request

listObjectsV Source #

Arguments

:: BucketName

lBucket

-> ListObjectsV 

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

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

  • lStartAfter - 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
  • lContinuationToken - 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
  • lFetchOwner - 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
  • lPrefix - Limits the response to keys that begin with the specified prefix.
  • lEncodingType - Encoding type used by Amazon S3 to encode object keys in the response.
  • lRequestPayer - 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.
  • 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 - Name of the bucket to list.

data ListObjectsV Source #

See: listObjectsV smart constructor.

Instances

Eq ListObjectsV Source # 
Data ListObjectsV Source # 

Methods

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

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

toConstr :: ListObjectsV -> Constr #

dataTypeOf :: ListObjectsV -> DataType #

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

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

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

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

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

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

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

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

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

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

Read ListObjectsV Source # 
Show ListObjectsV Source # 
Generic ListObjectsV Source # 

Associated Types

type Rep ListObjectsV :: * -> * #

Methods

from :: ListObjectsV -> Rep ListObjectsV x #

to :: Rep ListObjectsV x -> ListObjectsV #

Hashable ListObjectsV Source # 
NFData ListObjectsV Source # 

Methods

rnf :: ListObjectsV -> () #

AWSRequest ListObjectsV Source # 
ToQuery ListObjectsV Source # 
ToPath ListObjectsV Source # 
ToHeaders ListObjectsV Source # 
type Rep ListObjectsV Source # 
type Rs ListObjectsV Source # 

Request Lenses

lStartAfter :: Lens' ListObjectsV (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

lContinuationToken :: Lens' ListObjectsV (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

lFetchOwner :: Lens' ListObjectsV (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

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

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

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

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

lRequestPayer :: Lens' ListObjectsV (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.

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

A delimiter is a character you use to group keys.

lBucket :: Lens' ListObjectsV BucketName Source #

Name of the bucket to list.

Destructuring the Response

listObjectsVResponse Source #

Arguments

:: Int

lrsResponseStatus

-> ListObjectsVResponse 

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

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

  • lrsStartAfter - 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
  • lrsKeyCount - 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
  • lrsContents - Metadata about each object returned.
  • lrsContinuationToken - 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
  • lrsPrefix - Limits the response to keys that begin with the specified prefix.
  • lrsCommonPrefixes - CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by delimiter
  • lrsEncodingType - Encoding type used by Amazon S3 to encode object keys in the response.
  • lrsName - Name of the bucket to list.
  • lrsNextContinuationToken - 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
  • lrsMaxKeys - Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.
  • lrsIsTruncated - A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria.
  • lrsDelimiter - A delimiter is a character you use to group keys.
  • lrsResponseStatus - -- | The response status code.

data ListObjectsVResponse Source #

See: listObjectsVResponse smart constructor.

Instances

Eq ListObjectsVResponse Source # 
Data ListObjectsVResponse Source # 

Methods

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

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

toConstr :: ListObjectsVResponse -> Constr #

dataTypeOf :: ListObjectsVResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read ListObjectsVResponse Source # 
Show ListObjectsVResponse Source # 
Generic ListObjectsVResponse Source # 
NFData ListObjectsVResponse Source # 

Methods

rnf :: ListObjectsVResponse -> () #

type Rep ListObjectsVResponse Source # 
type Rep ListObjectsVResponse = D1 (MetaData "ListObjectsVResponse" "Network.AWS.S3.ListObjectsV" "amazonka-s3-1.5.0-4i2REsRgyXL98WvgynC9is" False) (C1 (MetaCons "ListObjectsVResponse'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_lrsStartAfter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_lrsKeyCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))) (S1 (MetaSel (Just Symbol "_lrsContents") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Object]))))) ((:*:) (S1 (MetaSel (Just Symbol "_lrsContinuationToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (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 "_lrsName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe BucketName))) (S1 (MetaSel (Just Symbol "_lrsNextContinuationToken") 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

lrsStartAfter :: Lens' ListObjectsVResponse (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

lrsKeyCount :: Lens' ListObjectsVResponse (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

lrsContents :: Lens' ListObjectsVResponse [Object] Source #

Metadata about each object returned.

lrsContinuationToken :: Lens' ListObjectsVResponse (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

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

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

lrsCommonPrefixes :: Lens' ListObjectsVResponse [CommonPrefix] Source #

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

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

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

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

Name of the bucket to list.

lrsNextContinuationToken :: Lens' ListObjectsVResponse (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

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

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

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

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

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

A delimiter is a character you use to group keys.

lrsResponseStatus :: Lens' ListObjectsVResponse Int Source #

  • - | The response status code.