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

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

Network.AWS.S3.ListObjects

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.

This operation returns paginated results.

Synopsis

Creating a Request

listObjects #

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

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

  • loPrefix - Limits the response to keys that begin with the specified prefix.
  • loEncodingType - Undocumented member.
  • loRequestPayer - Confirms that the requester knows that she or he will be charged for the list objects request. Bucket owners need not specify this parameter in their requests.
  • loMarker - Specifies the key to start with when listing objects in a bucket.
  • loMaxKeys - Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.
  • loDelimiter - A delimiter is a character you use to group keys.
  • loBucket - Undocumented member.

data ListObjects #

See: listObjects smart constructor.

Instances

Eq ListObjects # 
Data ListObjects # 

Methods

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

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

toConstr :: ListObjects -> Constr #

dataTypeOf :: ListObjects -> DataType #

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

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

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

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

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

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

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

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

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

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

Read ListObjects # 
Show ListObjects # 
Generic ListObjects # 

Associated Types

type Rep ListObjects :: * -> * #

Hashable ListObjects # 
NFData ListObjects # 

Methods

rnf :: ListObjects -> () #

AWSPager ListObjects # 
AWSRequest ListObjects # 
ToQuery ListObjects # 
ToPath ListObjects # 
ToHeaders ListObjects # 

Methods

toHeaders :: ListObjects -> [Header] #

type Rep ListObjects # 
type Rs ListObjects # 

Request Lenses

loPrefix :: Lens' ListObjects (Maybe Text) #

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

loRequestPayer :: Lens' ListObjects (Maybe RequestPayer) #

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

loMarker :: Lens' ListObjects (Maybe Text) #

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

loMaxKeys :: Lens' ListObjects (Maybe Int) #

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

loDelimiter :: Lens' ListObjects (Maybe Delimiter) #

A delimiter is a character you use to group keys.

loBucket :: Lens' ListObjects BucketName #

Undocumented member.

Destructuring the Response

listObjectsResponse #

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

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

  • lorsContents - Undocumented member.
  • lorsPrefix - Undocumented member.
  • lorsCommonPrefixes - Undocumented member.
  • lorsEncodingType - Encoding type used by Amazon S3 to encode object keys in the response.
  • lorsName - Undocumented member.
  • lorsMarker - Undocumented member.
  • lorsNextMarker - When response is truncated (the IsTruncated element value in the response is true), you can use the key name in this field as marker in the subsequent request to get next set of objects. Amazon S3 lists objects in alphabetical order Note: This element is returned only if you have delimiter request parameter specified. If response does not include the NextMaker and it is truncated, you can use the value of the last Key in the response as the marker in the subsequent request to get the next set of object keys.
  • lorsMaxKeys - Undocumented member.
  • lorsIsTruncated - A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria.
  • lorsDelimiter - Undocumented member.
  • lorsResponseStatus - -- | The response status code.

data ListObjectsResponse #

See: listObjectsResponse smart constructor.

Instances

Eq ListObjectsResponse # 
Data ListObjectsResponse # 

Methods

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

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

toConstr :: ListObjectsResponse -> Constr #

dataTypeOf :: ListObjectsResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read ListObjectsResponse # 
Show ListObjectsResponse # 
Generic ListObjectsResponse # 
NFData ListObjectsResponse # 

Methods

rnf :: ListObjectsResponse -> () #

type Rep ListObjectsResponse # 
type Rep ListObjectsResponse = D1 (MetaData "ListObjectsResponse" "Network.AWS.S3.ListObjects" "amazonka-s3-1.4.5-2aWx4hFX4jc9aUoF72WoFH" False) (C1 (MetaCons "ListObjectsResponse'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_lorsContents") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Object]))) (S1 (MetaSel (Just Symbol "_lorsPrefix") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_lorsCommonPrefixes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [CommonPrefix]))) ((:*:) (S1 (MetaSel (Just Symbol "_lorsEncodingType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe EncodingType))) (S1 (MetaSel (Just Symbol "_lorsName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe BucketName)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_lorsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_lorsNextMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_lorsMaxKeys") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))))) ((:*:) (S1 (MetaSel (Just Symbol "_lorsIsTruncated") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) ((:*:) (S1 (MetaSel (Just Symbol "_lorsDelimiter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Delimiter))) (S1 (MetaSel (Just Symbol "_lorsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))))

Response Lenses

lorsContents :: Lens' ListObjectsResponse [Object] #

Undocumented member.

lorsPrefix :: Lens' ListObjectsResponse (Maybe Text) #

Undocumented member.

lorsEncodingType :: Lens' ListObjectsResponse (Maybe EncodingType) #

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

lorsMarker :: Lens' ListObjectsResponse (Maybe Text) #

Undocumented member.

lorsNextMarker :: Lens' ListObjectsResponse (Maybe Text) #

When response is truncated (the IsTruncated element value in the response is true), you can use the key name in this field as marker in the subsequent request to get next set of objects. Amazon S3 lists objects in alphabetical order Note: This element is returned only if you have delimiter request parameter specified. If response does not include the NextMaker and it is truncated, you can use the value of the last Key in the response as the marker in the subsequent request to get the next set of object keys.

lorsMaxKeys :: Lens' ListObjectsResponse (Maybe Int) #

Undocumented member.

lorsIsTruncated :: Lens' ListObjectsResponse (Maybe Bool) #

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

lorsResponseStatus :: Lens' ListObjectsResponse Int #

  • - | The response status code.