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.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 Source #

Arguments

:: BucketName

loBucket

-> 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 Source #

See: listObjects smart constructor.

Instances

Eq ListObjects Source # 
Data ListObjects Source # 

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 Source # 
Show ListObjects Source # 
Generic ListObjects Source # 

Associated Types

type Rep ListObjects :: * -> * #

Methods

from :: ListObjects -> Rep ListObjects x #

to :: Rep ListObjects x -> ListObjects #

Hashable ListObjects Source # 
NFData ListObjects Source # 

Methods

rnf :: ListObjects -> () #

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

Methods

toHeaders :: ListObjects -> [Header] #

type Rep ListObjects Source # 
type Rs ListObjects Source # 

Request Lenses

loPrefix :: Lens' ListObjects (Maybe Text) Source #

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

loEncodingType :: Lens' ListObjects (Maybe EncodingType) Source #

Undocumented member.

loRequestPayer :: Lens' ListObjects (Maybe RequestPayer) Source #

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) Source #

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

loMaxKeys :: Lens' ListObjects (Maybe Int) Source #

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) Source #

A delimiter is a character you use to group keys.

loBucket :: Lens' ListObjects BucketName Source #

Undocumented member.

Destructuring the Response

listObjectsResponse Source #

Arguments

:: Int

lorsResponseStatus

-> 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 Source #

See: listObjectsResponse smart constructor.

Instances

Eq ListObjectsResponse Source # 
Data ListObjectsResponse Source # 

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

Methods

rnf :: ListObjectsResponse -> () #

type Rep ListObjectsResponse Source # 
type Rep ListObjectsResponse = D1 (MetaData "ListObjectsResponse" "Network.AWS.S3.ListObjects" "amazonka-s3-1.5.0-4i2REsRgyXL98WvgynC9is" 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 DecidedStrict) (Rec0 Int)))))))

Response Lenses

lorsContents :: Lens' ListObjectsResponse [Object] Source #

Undocumented member.

lorsPrefix :: Lens' ListObjectsResponse (Maybe Text) Source #

Undocumented member.

lorsCommonPrefixes :: Lens' ListObjectsResponse [CommonPrefix] Source #

Undocumented member.

lorsEncodingType :: Lens' ListObjectsResponse (Maybe EncodingType) Source #

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

lorsName :: Lens' ListObjectsResponse (Maybe BucketName) Source #

Undocumented member.

lorsMarker :: Lens' ListObjectsResponse (Maybe Text) Source #

Undocumented member.

lorsNextMarker :: Lens' ListObjectsResponse (Maybe Text) Source #

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) Source #

Undocumented member.

lorsIsTruncated :: Lens' ListObjectsResponse (Maybe Bool) Source #

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

lorsDelimiter :: Lens' ListObjectsResponse (Maybe Delimiter) Source #

Undocumented member.

lorsResponseStatus :: Lens' ListObjectsResponse Int Source #

  • - | The response status code.